x509.pod 29 KB

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