x509.pod 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942
  1. =pod
  2. =head1 NAME
  3. openssl-x509,
  4. x509 - Certificate display and signing utility
  5. =head1 SYNOPSIS
  6. B<openssl> B<x509>
  7. [B<-help>]
  8. [B<-inform DER|PEM>]
  9. [B<-outform DER|PEM>]
  10. [B<-keyform DER|PEM|ENGINE>]
  11. [B<-CAform DER|PEM>]
  12. [B<-CAkeyform DER|PEM>]
  13. [B<-in filename>]
  14. [B<-out filename>]
  15. [B<-serial>]
  16. [B<-hash>]
  17. [B<-subject_hash>]
  18. [B<-issuer_hash>]
  19. [B<-ocspid>]
  20. [B<-subject>]
  21. [B<-issuer>]
  22. [B<-nameopt option>]
  23. [B<-email>]
  24. [B<-ocsp_uri>]
  25. [B<-startdate>]
  26. [B<-enddate>]
  27. [B<-purpose>]
  28. [B<-dates>]
  29. [B<-checkend num>]
  30. [B<-modulus>]
  31. [B<-pubkey>]
  32. [B<-fingerprint>]
  33. [B<-alias>]
  34. [B<-noout>]
  35. [B<-trustout>]
  36. [B<-clrtrust>]
  37. [B<-clrreject>]
  38. [B<-addtrust arg>]
  39. [B<-addreject arg>]
  40. [B<-setalias arg>]
  41. [B<-days arg>]
  42. [B<-set_serial n>]
  43. [B<-signkey arg>]
  44. [B<-passin arg>]
  45. [B<-x509toreq>]
  46. [B<-req>]
  47. [B<-CA filename>]
  48. [B<-CAkey filename>]
  49. [B<-CAcreateserial>]
  50. [B<-CAserial filename>]
  51. [B<-force_pubkey key>]
  52. [B<-text>]
  53. [B<-ext extensions>]
  54. [B<-certopt option>]
  55. [B<-C>]
  56. [B<-I<digest>>]
  57. [B<-clrext>]
  58. [B<-extfile filename>]
  59. [B<-extensions section>]
  60. [B<-sigopt nm:v>]
  61. [B<-rand file...>]
  62. [B<-writerand file>]
  63. [B<-engine id>]
  64. [B<-preserve_dates>]
  65. =head1 DESCRIPTION
  66. The B<x509> command is a multi purpose certificate utility. It can be
  67. used to display certificate information, convert certificates to
  68. various forms, sign certificate requests like a "mini CA" or edit
  69. certificate trust settings.
  70. Since there are a large number of options they will split up into
  71. various sections.
  72. =head1 OPTIONS
  73. =head2 Input, Output, and General Purpose Options
  74. =over 4
  75. =item B<-help>
  76. Print out a usage message.
  77. =item B<-inform DER|PEM>
  78. This specifies the input format normally the command will expect an X509
  79. certificate but this can change if other options such as B<-req> are
  80. present. The DER format is the DER encoding of the certificate and PEM
  81. is the base64 encoding of the DER encoding with header and footer lines
  82. added. The default format is PEM.
  83. =item B<-outform DER|PEM>
  84. This specifies the output format, the options have the same meaning and default
  85. as the B<-inform> option.
  86. =item B<-in filename>
  87. This specifies the input filename to read a certificate from or standard input
  88. if this option is not specified.
  89. =item B<-out filename>
  90. This specifies the output filename to write to or standard output by
  91. default.
  92. =item B<-I<digest>>
  93. The digest to use.
  94. This affects any signing or display option that uses a message
  95. digest, such as the B<-fingerprint>, B<-signkey> and B<-CA> options.
  96. Any digest supported by the OpenSSL B<dgst> command can be used.
  97. If not specified then SHA1 is used with B<-fingerprint> or
  98. the default digest for the signing algorithm is used, typically SHA256.
  99. =item B<-rand file...>
  100. A file or files containing random data used to seed the random number
  101. generator.
  102. Multiple files can be specified separated by an OS-dependent character.
  103. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  104. all others.
  105. =item [B<-writerand file>]
  106. Writes random data to the specified I<file> upon exit.
  107. This can be used with a subsequent B<-rand> flag.
  108. =item B<-engine id>
  109. Specifying an engine (by its unique B<id> string) will cause B<x509>
  110. to attempt to obtain a functional reference to the specified engine,
  111. thus initialising it if needed. The engine will then be set as the default
  112. for all available algorithms.
  113. =item B<-preserve_dates>
  114. When signing a certificate, preserve the "notBefore" and "notAfter" dates instead
  115. of adjusting them to current time and duration. Cannot be used with the B<-days> option.
  116. =back
  117. =head2 Display Options
  118. Note: the B<-alias> and B<-purpose> options are also display options
  119. but are described in the B<TRUST SETTINGS> section.
  120. =over 4
  121. =item B<-text>
  122. Prints out the certificate in text form. Full details are output including the
  123. public key, signature algorithms, issuer and subject names, serial number
  124. any extensions present and any trust settings.
  125. =item B<-ext extensions>
  126. Prints out the certificate extensions in text form. Extensions are specified
  127. with a comma separated string, e.g., "subjectAltName,subjectKeyIdentifier".
  128. See the L<x509v3_config(5)> manual page for the extension names.
  129. =item B<-certopt option>
  130. Customise the output format used with B<-text>. The B<option> argument
  131. can be a single option or multiple options separated by commas. The
  132. B<-certopt> switch may be also be used more than once to set multiple
  133. options. See the B<TEXT OPTIONS> section for more information.
  134. =item B<-noout>
  135. This option prevents output of the encoded version of the certificate.
  136. =item B<-pubkey>
  137. Outputs the certificate's SubjectPublicKeyInfo block in PEM format.
  138. =item B<-modulus>
  139. This option prints out the value of the modulus of the public key
  140. contained in the certificate.
  141. =item B<-serial>
  142. Outputs the certificate serial number.
  143. =item B<-subject_hash>
  144. Outputs the "hash" of the certificate subject name. This is used in OpenSSL to
  145. form an index to allow certificates in a directory to be looked up by subject
  146. name.
  147. =item B<-issuer_hash>
  148. Outputs the "hash" of the certificate issuer name.
  149. =item B<-ocspid>
  150. Outputs the OCSP hash values for the subject name and public key.
  151. =item B<-hash>
  152. Synonym for "-subject_hash" for backward compatibility reasons.
  153. =item B<-subject_hash_old>
  154. Outputs the "hash" of the certificate subject name using the older algorithm
  155. as used by OpenSSL before version 1.0.0.
  156. =item B<-issuer_hash_old>
  157. Outputs the "hash" of the certificate issuer name using the older algorithm
  158. as used by OpenSSL before version 1.0.0.
  159. =item B<-subject>
  160. Outputs the subject name.
  161. =item B<-issuer>
  162. Outputs the issuer name.
  163. =item B<-nameopt option>
  164. Option which determines how the subject or issuer names are displayed. The
  165. B<option> argument can be a single option or multiple options separated by
  166. commas. Alternatively the B<-nameopt> switch may be used more than once to
  167. set multiple options. See the B<NAME OPTIONS> section for more information.
  168. =item B<-email>
  169. Outputs the email address(es) if any.
  170. =item B<-ocsp_uri>
  171. Outputs the OCSP responder address(es) if any.
  172. =item B<-startdate>
  173. Prints out the start date of the certificate, that is the notBefore date.
  174. =item B<-enddate>
  175. Prints out the expiry date of the certificate, that is the notAfter date.
  176. =item B<-dates>
  177. Prints out the start and expiry dates of a certificate.
  178. =item B<-checkend arg>
  179. Checks if the certificate expires within the next B<arg> seconds and exits
  180. nonzero if yes it will expire or zero if not.
  181. =item B<-fingerprint>
  182. Calculates and outputs the digest of the DER encoded version of the entire
  183. certificate (see digest options).
  184. This is commonly called a "fingerprint". Because of the nature of message
  185. digests, the fingerprint of a certificate is unique to that certificate and
  186. two certificates with the same fingerprint can be considered to be the same.
  187. =item B<-C>
  188. This outputs the certificate in the form of a C source file.
  189. =back
  190. =head2 Trust Settings
  191. A B<trusted certificate> is an ordinary certificate which has several
  192. additional pieces of information attached to it such as the permitted
  193. and prohibited uses of the certificate and an "alias".
  194. Normally when a certificate is being verified at least one certificate
  195. must be "trusted". By default a trusted certificate must be stored
  196. locally and must be a root CA: any certificate chain ending in this CA
  197. is then usable for any purpose.
  198. Trust settings currently are only used with a root CA. They allow a finer
  199. control over the purposes the root CA can be used for. For example a CA
  200. may be trusted for SSL client but not SSL server use.
  201. See the description of the B<verify> utility for more information on the
  202. meaning of trust settings.
  203. Future versions of OpenSSL will recognize trust settings on any
  204. certificate: not just root CAs.
  205. =over 4
  206. =item B<-trustout>
  207. This causes B<x509> to output a B<trusted> certificate. An ordinary
  208. or trusted certificate can be input but by default an ordinary
  209. certificate is output and any trust settings are discarded. With the
  210. B<-trustout> option a trusted certificate is output. A trusted
  211. certificate is automatically output if any trust settings are modified.
  212. =item B<-setalias arg>
  213. Sets the alias of the certificate. This will allow the certificate
  214. to be referred to using a nickname for example "Steve's Certificate".
  215. =item B<-alias>
  216. Outputs the certificate alias, if any.
  217. =item B<-clrtrust>
  218. Clears all the permitted or trusted uses of the certificate.
  219. =item B<-clrreject>
  220. Clears all the prohibited or rejected uses of the certificate.
  221. =item B<-addtrust arg>
  222. Adds a trusted certificate use.
  223. Any object name can be used here but currently only B<clientAuth> (SSL client
  224. use), B<serverAuth> (SSL server use), B<emailProtection> (S/MIME email) and
  225. B<anyExtendedKeyUsage> are used.
  226. As of OpenSSL 1.1.0, the last of these blocks all purposes when rejected or
  227. enables all purposes when trusted.
  228. Other OpenSSL applications may define additional uses.
  229. =item B<-addreject arg>
  230. Adds a prohibited use. It accepts the same values as the B<-addtrust>
  231. option.
  232. =item B<-purpose>
  233. This option performs tests on the certificate extensions and outputs
  234. the results. For a more complete description see the B<CERTIFICATE
  235. EXTENSIONS> section.
  236. =back
  237. =head2 Signing Options
  238. The B<x509> utility can be used to sign certificates and requests: it
  239. can thus behave like a "mini CA".
  240. =over 4
  241. =item B<-signkey arg>
  242. This option causes the input file to be self signed using the supplied
  243. private key or engine. The private key's format is specified with the
  244. B<-keyform> option.
  245. If the input file is a certificate it sets the issuer name to the
  246. subject name (i.e. makes it self signed) changes the public key to the
  247. supplied value and changes the start and end dates. The start date is
  248. set to the current time and the end date is set to a value determined
  249. by the B<-days> option. Any certificate extensions are retained unless
  250. the B<-clrext> option is supplied; this includes, for example, any existing
  251. key identifier extensions.
  252. If the input is a certificate request then a self signed certificate
  253. is created using the supplied private key using the subject name in
  254. the request.
  255. =item B<-sigopt nm:v>
  256. Pass options to the signature algorithm during sign or verify operations.
  257. Names and values of these options are algorithm-specific.
  258. =item B<-passin arg>
  259. The key password source. For more information about the format of B<arg>
  260. see L<openssl(1)/Pass Phrase Options>.
  261. =item B<-clrext>
  262. Delete any extensions from a certificate. This option is used when a
  263. certificate is being created from another certificate (for example with
  264. the B<-signkey> or the B<-CA> options). Normally all extensions are
  265. retained.
  266. =item B<-keyform PEM|DER|ENGINE>
  267. Specifies the format (DER or PEM) of the private key file used in the
  268. B<-signkey> option.
  269. =item B<-days arg>
  270. Specifies the number of days to make a certificate valid for. The default
  271. is 30 days. Cannot be used with the B<-preserve_dates> option.
  272. =item B<-x509toreq>
  273. Converts a certificate into a certificate request. The B<-signkey> option
  274. is used to pass the required private key.
  275. =item B<-req>
  276. By default a certificate is expected on input. With this option a
  277. certificate request is expected instead.
  278. =item B<-set_serial n>
  279. Specifies the serial number to use. This option can be used with either
  280. the B<-signkey> or B<-CA> options. If used in conjunction with the B<-CA>
  281. option the serial number file (as specified by the B<-CAserial> or
  282. B<-CAcreateserial> options) is not used.
  283. The serial number can be decimal or hex (if preceded by B<0x>).
  284. =item B<-CA filename>
  285. Specifies the CA certificate to be used for signing. When this option is
  286. present B<x509> behaves like a "mini CA". The input file is signed by this
  287. CA using this option: that is its issuer name is set to the subject name
  288. of the CA and it is digitally signed using the CAs private key.
  289. This option is normally combined with the B<-req> option. Without the
  290. B<-req> option the input is a certificate which must be self signed.
  291. =item B<-CAkey filename>
  292. Sets the CA private key to sign a certificate with. If this option is
  293. not specified then it is assumed that the CA private key is present in
  294. the CA certificate file.
  295. =item B<-CAserial filename>
  296. Sets the CA serial number file to use.
  297. When the B<-CA> option is used to sign a certificate it uses a serial
  298. number specified in a file. This file consists of one line containing
  299. an even number of hex digits with the serial number to use. After each
  300. use the serial number is incremented and written out to the file again.
  301. The default filename consists of the CA certificate file base name with
  302. ".srl" appended. For example if the CA certificate file is called
  303. "mycacert.pem" it expects to find a serial number file called "mycacert.srl".
  304. =item B<-CAcreateserial>
  305. With this option the CA serial number file is created if it does not exist:
  306. it will contain the serial number "02" and the certificate being signed will
  307. have the 1 as its serial number. If the B<-CA> option is specified
  308. and the serial number file does not exist a random number is generated;
  309. this is the recommended practice.
  310. =item B<-extfile filename>
  311. File containing certificate extensions to use. If not specified then
  312. no extensions are added to the certificate.
  313. =item B<-extensions section>
  314. The section to add certificate extensions from. If this option is not
  315. specified then the extensions should either be contained in the unnamed
  316. (default) section or the default section should contain a variable called
  317. "extensions" which contains the section to use. See the
  318. L<x509v3_config(5)> manual page for details of the
  319. extension section format.
  320. =item B<-force_pubkey key>
  321. When a certificate is created set its public key to B<key> instead of the
  322. key in the certificate or certificate request. This option is useful for
  323. creating certificates where the algorithm can't normally sign requests, for
  324. example DH.
  325. The format or B<key> can be specified using the B<-keyform> option.
  326. =back
  327. =head2 Name Options
  328. The B<nameopt> command line switch determines how the subject and issuer
  329. names are displayed. If no B<nameopt> switch is present the default "oneline"
  330. format is used which is compatible with previous versions of OpenSSL.
  331. Each option is described in detail below, all options can be preceded by
  332. a B<-> to turn the option off. Only the first four will normally be used.
  333. =over 4
  334. =item B<compat>
  335. Use the old format.
  336. =item B<RFC2253>
  337. Displays names compatible with RFC2253 equivalent to B<esc_2253>, B<esc_ctrl>,
  338. B<esc_msb>, B<utf8>, B<dump_nostr>, B<dump_unknown>, B<dump_der>,
  339. B<sep_comma_plus>, B<dn_rev> and B<sname>.
  340. =item B<oneline>
  341. A oneline format which is more readable than RFC2253. It is equivalent to
  342. specifying the B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>, B<dump_nostr>,
  343. B<dump_der>, B<use_quote>, B<sep_comma_plus_space>, B<space_eq> and B<sname>
  344. options. This is the I<default> of no name options are given explicitly.
  345. =item B<multiline>
  346. A multiline format. It is equivalent B<esc_ctrl>, B<esc_msb>, B<sep_multiline>,
  347. B<space_eq>, B<lname> and B<align>.
  348. =item B<esc_2253>
  349. Escape the "special" characters required by RFC2253 in a field. That is
  350. B<,+"E<lt>E<gt>;>. Additionally B<#> is escaped at the beginning of a string
  351. and a space character at the beginning or end of a string.
  352. =item B<esc_2254>
  353. Escape the "special" characters required by RFC2254 in a field. That is
  354. the B<NUL> character as well as and B<()*>.
  355. =item B<esc_ctrl>
  356. Escape control characters. That is those with ASCII values less than
  357. 0x20 (space) and the delete (0x7f) character. They are escaped using the
  358. RFC2253 \XX notation (where XX are two hex digits representing the
  359. character value).
  360. =item B<esc_msb>
  361. Escape characters with the MSB set, that is with ASCII values larger than
  362. 127.
  363. =item B<use_quote>
  364. Escapes some characters by surrounding the whole string with B<"> characters,
  365. without the option all escaping is done with the B<\> character.
  366. =item B<utf8>
  367. Convert all strings to UTF8 format first. This is required by RFC2253. If
  368. you are lucky enough to have a UTF8 compatible terminal then the use
  369. of this option (and B<not> setting B<esc_msb>) may result in the correct
  370. display of multibyte (international) characters. Is this option is not
  371. present then multibyte characters larger than 0xff will be represented
  372. using the format \UXXXX for 16 bits and \WXXXXXXXX for 32 bits.
  373. Also if this option is off any UTF8Strings will be converted to their
  374. character form first.
  375. =item B<ignore_type>
  376. This option does not attempt to interpret multibyte characters in any
  377. way. That is their content octets are merely dumped as though one octet
  378. represents each character. This is useful for diagnostic purposes but
  379. will result in rather odd looking output.
  380. =item B<show_type>
  381. Show the type of the ASN1 character string. The type precedes the
  382. field contents. For example "BMPSTRING: Hello World".
  383. =item B<dump_der>
  384. When this option is set any fields that need to be hexdumped will
  385. be dumped using the DER encoding of the field. Otherwise just the
  386. content octets will be displayed. Both options use the RFC2253
  387. B<#XXXX...> format.
  388. =item B<dump_nostr>
  389. Dump non character string types (for example OCTET STRING) if this
  390. option is not set then non character string types will be displayed
  391. as though each content octet represents a single character.
  392. =item B<dump_all>
  393. Dump all fields. This option when used with B<dump_der> allows the
  394. DER encoding of the structure to be unambiguously determined.
  395. =item B<dump_unknown>
  396. Dump any field whose OID is not recognised by OpenSSL.
  397. =item B<sep_comma_plus>, B<sep_comma_plus_space>, B<sep_semi_plus_space>,
  398. B<sep_multiline>
  399. These options determine the field separators. The first character is
  400. between RDNs and the second between multiple AVAs (multiple AVAs are
  401. very rare and their use is discouraged). The options ending in
  402. "space" additionally place a space after the separator to make it
  403. more readable. The B<sep_multiline> uses a linefeed character for
  404. the RDN separator and a spaced B<+> for the AVA separator. It also
  405. indents the fields by four characters. If no field separator is specified
  406. then B<sep_comma_plus_space> is used by default.
  407. =item B<dn_rev>
  408. Reverse the fields of the DN. This is required by RFC2253. As a side
  409. effect this also reverses the order of multiple AVAs but this is
  410. permissible.
  411. =item B<nofname>, B<sname>, B<lname>, B<oid>
  412. These options alter how the field name is displayed. B<nofname> does
  413. not display the field at all. B<sname> uses the "short name" form
  414. (CN for commonName for example). B<lname> uses the long form.
  415. B<oid> represents the OID in numerical form and is useful for
  416. diagnostic purpose.
  417. =item B<align>
  418. Align field values for a more readable output. Only usable with
  419. B<sep_multiline>.
  420. =item B<space_eq>
  421. Places spaces round the B<=> character which follows the field
  422. name.
  423. =back
  424. =head2 Text Options
  425. As well as customising the name output format, it is also possible to
  426. customise the actual fields printed using the B<certopt> options when
  427. the B<text> option is present. The default behaviour is to print all fields.
  428. =over 4
  429. =item B<compatible>
  430. Use the old format. This is equivalent to specifying no output options at all.
  431. =item B<no_header>
  432. Don't print header information: that is the lines saying "Certificate"
  433. and "Data".
  434. =item B<no_version>
  435. Don't print out the version number.
  436. =item B<no_serial>
  437. Don't print out the serial number.
  438. =item B<no_signame>
  439. Don't print out the signature algorithm used.
  440. =item B<no_validity>
  441. Don't print the validity, that is the B<notBefore> and B<notAfter> fields.
  442. =item B<no_subject>
  443. Don't print out the subject name.
  444. =item B<no_issuer>
  445. Don't print out the issuer name.
  446. =item B<no_pubkey>
  447. Don't print out the public key.
  448. =item B<no_sigdump>
  449. Don't give a hexadecimal dump of the certificate signature.
  450. =item B<no_aux>
  451. Don't print out certificate trust information.
  452. =item B<no_extensions>
  453. Don't print out any X509V3 extensions.
  454. =item B<ext_default>
  455. Retain default extension behaviour: attempt to print out unsupported
  456. certificate extensions.
  457. =item B<ext_error>
  458. Print an error message for unsupported certificate extensions.
  459. =item B<ext_parse>
  460. ASN1 parse unsupported extensions.
  461. =item B<ext_dump>
  462. Hex dump unsupported extensions.
  463. =item B<ca_default>
  464. The value used by the B<ca> utility, equivalent to B<no_issuer>, B<no_pubkey>,
  465. B<no_header>, and B<no_version>.
  466. =back
  467. =head1 EXAMPLES
  468. Note: in these examples the '\' means the example should be all on one
  469. line.
  470. Display the contents of a certificate:
  471. openssl x509 -in cert.pem -noout -text
  472. Display the "Subject Alternative Name" extension of a certificate:
  473. openssl x509 -in cert.pem -noout -ext subjectAltName
  474. Display more extensions of a certificate:
  475. openssl x509 -in cert.pem -noout -ext subjectAltName,nsCertType
  476. Display the certificate serial number:
  477. openssl x509 -in cert.pem -noout -serial
  478. Display the certificate subject name:
  479. openssl x509 -in cert.pem -noout -subject
  480. Display the certificate subject name in RFC2253 form:
  481. openssl x509 -in cert.pem -noout -subject -nameopt RFC2253
  482. Display the certificate subject name in oneline form on a terminal
  483. supporting UTF8:
  484. openssl x509 -in cert.pem -noout -subject -nameopt oneline,-esc_msb
  485. Display the certificate SHA1 fingerprint:
  486. openssl x509 -sha1 -in cert.pem -noout -fingerprint
  487. Convert a certificate from PEM to DER format:
  488. openssl x509 -in cert.pem -inform PEM -out cert.der -outform DER
  489. Convert a certificate to a certificate request:
  490. openssl x509 -x509toreq -in cert.pem -out req.pem -signkey key.pem
  491. Convert a certificate request into a self signed certificate using
  492. extensions for a CA:
  493. openssl x509 -req -in careq.pem -extfile openssl.cnf -extensions v3_ca \
  494. -signkey key.pem -out cacert.pem
  495. Sign a certificate request using the CA certificate above and add user
  496. certificate extensions:
  497. openssl x509 -req -in req.pem -extfile openssl.cnf -extensions v3_usr \
  498. -CA cacert.pem -CAkey key.pem -CAcreateserial
  499. Set a certificate to be trusted for SSL client use and change set its alias to
  500. "Steve's Class 1 CA"
  501. openssl x509 -in cert.pem -addtrust clientAuth \
  502. -setalias "Steve's Class 1 CA" -out trust.pem
  503. =head1 NOTES
  504. The PEM format uses the header and footer lines:
  505. -----BEGIN CERTIFICATE-----
  506. -----END CERTIFICATE-----
  507. it will also handle files containing:
  508. -----BEGIN X509 CERTIFICATE-----
  509. -----END X509 CERTIFICATE-----
  510. Trusted certificates have the lines
  511. -----BEGIN TRUSTED CERTIFICATE-----
  512. -----END TRUSTED CERTIFICATE-----
  513. The conversion to UTF8 format used with the name options assumes that
  514. T61Strings use the ISO8859-1 character set. This is wrong but Netscape
  515. and MSIE do this as do many certificates. So although this is incorrect
  516. it is more likely to display the majority of certificates correctly.
  517. The B<-email> option searches the subject name and the subject alternative
  518. name extension. Only unique email addresses will be printed out: it will
  519. not print the same address more than once.
  520. =head1 CERTIFICATE EXTENSIONS
  521. The B<-purpose> option checks the certificate extensions and determines
  522. what the certificate can be used for. The actual checks done are rather
  523. complex and include various hacks and workarounds to handle broken
  524. certificates and software.
  525. The same code is used when verifying untrusted certificates in chains
  526. so this section is useful if a chain is rejected by the verify code.
  527. The basicConstraints extension CA flag is used to determine whether the
  528. certificate can be used as a CA. If the CA flag is true then it is a CA,
  529. if the CA flag is false then it is not a CA. B<All> CAs should have the
  530. CA flag set to true.
  531. If the basicConstraints extension is absent then the certificate is
  532. considered to be a "possible CA" other extensions are checked according
  533. to the intended use of the certificate. A warning is given in this case
  534. because the certificate should really not be regarded as a CA: however
  535. it is allowed to be a CA to work around some broken software.
  536. If the certificate is a V1 certificate (and thus has no extensions) and
  537. it is self signed it is also assumed to be a CA but a warning is again
  538. given: this is to work around the problem of Verisign roots which are V1
  539. self signed certificates.
  540. If the keyUsage extension is present then additional restraints are
  541. made on the uses of the certificate. A CA certificate B<must> have the
  542. keyCertSign bit set if the keyUsage extension is present.
  543. The extended key usage extension places additional restrictions on the
  544. certificate uses. If this extension is present (whether critical or not)
  545. the key can only be used for the purposes specified.
  546. A complete description of each test is given below. The comments about
  547. basicConstraints and keyUsage and V1 certificates above apply to B<all>
  548. CA certificates.
  549. =over 4
  550. =item B<SSL Client>
  551. The extended key usage extension must be absent or include the "web client
  552. authentication" OID. keyUsage must be absent or it must have the
  553. digitalSignature bit set. Netscape certificate type must be absent or it must
  554. have the SSL client bit set.
  555. =item B<SSL Client CA>
  556. The extended key usage extension must be absent or include the "web client
  557. authentication" OID. Netscape certificate type must be absent or it must have
  558. the SSL CA bit set: this is used as a work around if the basicConstraints
  559. extension is absent.
  560. =item B<SSL Server>
  561. The extended key usage extension must be absent or include the "web server
  562. authentication" and/or one of the SGC OIDs. keyUsage must be absent or it
  563. must have the digitalSignature, the keyEncipherment set or both bits set.
  564. Netscape certificate type must be absent or have the SSL server bit set.
  565. =item B<SSL Server CA>
  566. The extended key usage extension must be absent or include the "web server
  567. authentication" and/or one of the SGC OIDs. Netscape certificate type must
  568. be absent or the SSL CA bit must be set: this is used as a work around if the
  569. basicConstraints extension is absent.
  570. =item B<Netscape SSL Server>
  571. For Netscape SSL clients to connect to an SSL server it must have the
  572. keyEncipherment bit set if the keyUsage extension is present. This isn't
  573. always valid because some cipher suites use the key for digital signing.
  574. Otherwise it is the same as a normal SSL server.
  575. =item B<Common S/MIME Client Tests>
  576. The extended key usage extension must be absent or include the "email
  577. protection" OID. Netscape certificate type must be absent or should have the
  578. S/MIME bit set. If the S/MIME bit is not set in Netscape certificate type
  579. then the SSL client bit is tolerated as an alternative but a warning is shown:
  580. this is because some Verisign certificates don't set the S/MIME bit.
  581. =item B<S/MIME Signing>
  582. In addition to the common S/MIME client tests the digitalSignature bit or
  583. the nonRepudiation bit must be set if the keyUsage extension is present.
  584. =item B<S/MIME Encryption>
  585. In addition to the common S/MIME tests the keyEncipherment bit must be set
  586. if the keyUsage extension is present.
  587. =item B<S/MIME CA>
  588. The extended key usage extension must be absent or include the "email
  589. protection" OID. Netscape certificate type must be absent or must have the
  590. S/MIME CA bit set: this is used as a work around if the basicConstraints
  591. extension is absent.
  592. =item B<CRL Signing>
  593. The keyUsage extension must be absent or it must have the CRL signing bit
  594. set.
  595. =item B<CRL Signing CA>
  596. The normal CA tests apply. Except in this case the basicConstraints extension
  597. must be present.
  598. =back
  599. =head1 BUGS
  600. Extensions in certificates are not transferred to certificate requests and
  601. vice versa.
  602. It is possible to produce invalid certificates or requests by specifying the
  603. wrong private key or using inconsistent options in some cases: these should
  604. be checked.
  605. There should be options to explicitly set such things as start and end
  606. dates rather than an offset from the current time.
  607. =head1 SEE ALSO
  608. L<req(1)>, L<ca(1)>, L<genrsa(1)>,
  609. L<gendsa(1)>, L<verify(1)>,
  610. L<x509v3_config(5)>
  611. =head1 HISTORY
  612. The hash algorithm used in the B<-subject_hash> and B<-issuer_hash> options
  613. before OpenSSL 1.0.0 was based on the deprecated MD5 algorithm and the encoding
  614. of the distinguished name. In OpenSSL 1.0.0 and later it is based on a
  615. canonical version of the DN using SHA1. This means that any directories using
  616. the old form must have their links rebuilt using B<c_rehash> or similar.
  617. =head1 COPYRIGHT
  618. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  619. Licensed under the OpenSSL license (the "License"). You may not use
  620. this file except in compliance with the License. You can obtain a copy
  621. in the file LICENSE in the source distribution or at
  622. L<https://www.openssl.org/source/license.html>.
  623. =cut