Annotation of src/usr.bin/openssl/openssl.1, Revision 1.106
1.106 ! inoguchi 1: .\" $OpenBSD: openssl.1,v 1.105 2019/07/05 11:50:46 inoguchi Exp $
1.1 jsing 2: .\" ====================================================================
3: .\" Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\"
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\"
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in
14: .\" the documentation and/or other materials provided with the
15: .\" distribution.
16: .\"
17: .\" 3. All advertising materials mentioning features or use of this
18: .\" software must display the following acknowledgment:
19: .\" "This product includes software developed by the OpenSSL Project
20: .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21: .\"
22: .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23: .\" endorse or promote products derived from this software without
24: .\" prior written permission. For written permission, please contact
25: .\" openssl-core@openssl.org.
26: .\"
27: .\" 5. Products derived from this software may not be called "OpenSSL"
28: .\" nor may "OpenSSL" appear in their names without prior written
29: .\" permission of the OpenSSL Project.
30: .\"
31: .\" 6. Redistributions of any form whatsoever must retain the following
32: .\" acknowledgment:
33: .\" "This product includes software developed by the OpenSSL Project
34: .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35: .\"
36: .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37: .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40: .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41: .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43: .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45: .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47: .\" OF THE POSSIBILITY OF SUCH DAMAGE.
48: .\" ====================================================================
49: .\"
50: .\" This product includes cryptographic software written by Eric Young
51: .\" (eay@cryptsoft.com). This product includes software written by Tim
52: .\" Hudson (tjh@cryptsoft.com).
53: .\"
54: .\"
55: .\" Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56: .\" All rights reserved.
57: .\"
58: .\" This package is an SSL implementation written
59: .\" by Eric Young (eay@cryptsoft.com).
60: .\" The implementation was written so as to conform with Netscapes SSL.
61: .\"
62: .\" This library is free for commercial and non-commercial use as long as
63: .\" the following conditions are aheared to. The following conditions
64: .\" apply to all code found in this distribution, be it the RC4, RSA,
65: .\" lhash, DES, etc., code; not just the SSL code. The SSL documentation
66: .\" included with this distribution is covered by the same copyright terms
67: .\" except that the holder is Tim Hudson (tjh@cryptsoft.com).
68: .\"
69: .\" Copyright remains Eric Young's, and as such any Copyright notices in
70: .\" the code are not to be removed.
71: .\" If this package is used in a product, Eric Young should be given attribution
72: .\" as the author of the parts of the library used.
73: .\" This can be in the form of a textual message at program startup or
74: .\" in documentation (online or textual) provided with the package.
75: .\"
76: .\" Redistribution and use in source and binary forms, with or without
77: .\" modification, are permitted provided that the following conditions
78: .\" are met:
79: .\" 1. Redistributions of source code must retain the copyright
80: .\" notice, this list of conditions and the following disclaimer.
81: .\" 2. Redistributions in binary form must reproduce the above copyright
82: .\" notice, this list of conditions and the following disclaimer in the
83: .\" documentation and/or other materials provided with the distribution.
84: .\" 3. All advertising materials mentioning features or use of this software
85: .\" must display the following acknowledgement:
86: .\" "This product includes cryptographic software written by
87: .\" Eric Young (eay@cryptsoft.com)"
88: .\" The word 'cryptographic' can be left out if the rouines from the library
89: .\" being used are not cryptographic related :-).
90: .\" 4. If you include any Windows specific code (or a derivative thereof) from
91: .\" the apps directory (application code) you must include an
92: .\" acknowledgement:
93: .\" "This product includes software written by Tim Hudson
94: .\" (tjh@cryptsoft.com)"
95: .\"
96: .\" THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
97: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
98: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
99: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
100: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
101: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
102: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
103: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
104: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
105: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
106: .\" SUCH DAMAGE.
107: .\"
108: .\" The licence and distribution terms for any publically available version or
109: .\" derivative of this code cannot be changed. i.e. this code cannot simply be
110: .\" copied and put under another distribution licence
111: .\" [including the GNU Public Licence.]
112: .\"
1.106 ! inoguchi 113: .Dd $Mdocdate: July 5 2019 $
1.1 jsing 114: .Dt OPENSSL 1
115: .Os
116: .Sh NAME
117: .Nm openssl
118: .Nd OpenSSL command line tool
119: .Sh SYNOPSIS
120: .Nm
1.90 schwarze 121: .Ar command
1.1 jsing 122: .Op Ar command_opts
123: .Op Ar command_args
124: .Pp
125: .Nm
1.13 bentley 126: .Cm list-standard-commands |
127: .Cm list-message-digest-commands |
128: .Cm list-cipher-commands |
129: .Cm list-cipher-algorithms |
130: .Cm list-message-digest-algorithms |
1.1 jsing 131: .Cm list-public-key-algorithms
132: .Pp
133: .Nm
1.39 jmc 134: .Cm no- Ns Ar command
1.1 jsing 135: .Sh DESCRIPTION
136: .Nm OpenSSL
1.31 jmc 137: is a cryptography toolkit implementing the
138: Transport Layer Security
1.1 jsing 139: .Pq TLS v1
1.31 jmc 140: network protocol,
141: as well as related cryptography standards.
1.1 jsing 142: .Pp
143: The
144: .Nm
145: program is a command line tool for using the various
146: cryptography functions of
1.39 jmc 147: .Nm openssl Ns 's
1.33 jmc 148: crypto library from the shell.
1.1 jsing 149: .Pp
150: The pseudo-commands
151: .Cm list-standard-commands , list-message-digest-commands ,
152: and
153: .Cm list-cipher-commands
154: output a list
155: .Pq one entry per line
156: of the names of all standard commands, message digest commands,
157: or cipher commands, respectively, that are available in the present
158: .Nm
159: utility.
160: .Pp
161: The pseudo-commands
162: .Cm list-cipher-algorithms
163: and
164: .Cm list-message-digest-algorithms
165: list all cipher and message digest names,
166: one entry per line.
167: Aliases are listed as:
168: .Pp
1.33 jmc 169: .D1 from => to
1.1 jsing 170: .Pp
171: The pseudo-command
172: .Cm list-public-key-algorithms
173: lists all supported public key algorithms.
174: .Pp
175: The pseudo-command
1.39 jmc 176: .Cm no- Ns Ar command
1.1 jsing 177: tests whether a command of the
178: specified name is available.
1.39 jmc 179: If
180: .Ar command
181: does not exist,
1.1 jsing 182: it returns 0
183: and prints
1.39 jmc 184: .Cm no- Ns Ar command ;
1.1 jsing 185: otherwise it returns 1 and prints
1.39 jmc 186: .Ar command .
187: In both cases, the output goes to stdout and nothing is printed to stderr.
1.1 jsing 188: Additional command line arguments are always ignored.
189: Since for each cipher there is a command of the same name,
190: this provides an easy way for shell scripts to test for the
191: availability of ciphers in the
192: .Nm
193: program.
194: .Pp
195: .Sy Note :
1.39 jmc 196: .Cm no- Ns Ar command
1.1 jsing 197: is not able to detect pseudo-commands such as
198: .Cm quit ,
199: .Cm list- Ns Ar ... Ns Cm -commands ,
200: or
1.39 jmc 201: .Cm no- Ns Ar command
1.1 jsing 202: itself.
203: .Sh ASN1PARSE
204: .nr nS 1
205: .Nm "openssl asn1parse"
206: .Op Fl i
207: .Op Fl dlimit Ar number
208: .Op Fl dump
209: .Op Fl genconf Ar file
210: .Op Fl genstr Ar str
211: .Op Fl in Ar file
1.34 jmc 212: .Op Fl inform Cm der | pem | txt
1.1 jsing 213: .Op Fl length Ar number
214: .Op Fl noout
215: .Op Fl offset Ar number
216: .Op Fl oid Ar file
217: .Op Fl out Ar file
218: .Op Fl strparse Ar offset
219: .nr nS 0
220: .Pp
221: The
222: .Nm asn1parse
223: command is a diagnostic utility that can parse ASN.1 structures.
224: It can also be used to extract data from ASN.1 formatted data.
225: .Pp
226: The options are as follows:
227: .Bl -tag -width Ds
228: .It Fl dlimit Ar number
229: Dump the first
230: .Ar number
231: bytes of unknown data in hex form.
232: .It Fl dump
233: Dump unknown data in hex form.
234: .It Fl genconf Ar file , Fl genstr Ar str
235: Generate encoded data based on string
236: .Ar str ,
237: file
238: .Ar file ,
1.34 jmc 239: or both, using the format described in
240: .Xr ASN1_generate_nconf 3 .
1.1 jsing 241: If only
242: .Ar file
243: is present then the string is obtained from the default section
244: using the name
245: .Dq asn1 .
1.84 jmc 246: The encoded data is passed through the ASN.1 parser and printed out as
1.1 jsing 247: though it came from a file;
248: the contents can thus be examined and written to a file using the
249: .Fl out
250: option.
251: .It Fl i
1.34 jmc 252: Indent the output according to the
1.1 jsing 253: .Qq depth
254: of the structures.
255: .It Fl in Ar file
1.41 jmc 256: The input file to read from, or standard input if not specified.
1.34 jmc 257: .It Fl inform Cm der | pem | txt
1.1 jsing 258: The input format.
259: .It Fl length Ar number
1.34 jmc 260: Number of bytes to parse; the default is until end of file.
1.1 jsing 261: .It Fl noout
1.46 jmc 262: Do not output the parsed version of the input file.
1.1 jsing 263: .It Fl offset Ar number
1.34 jmc 264: Starting offset to begin parsing; the default is start of file.
1.1 jsing 265: .It Fl oid Ar file
266: A file containing additional object identifiers
267: .Pq OIDs .
268: If an OID
269: .Pq object identifier
270: is not part of
1.34 jmc 271: .Nm openssl Ns 's
1.1 jsing 272: internal table it will be represented in
273: numerical form
274: .Pq for example 1.2.3.4 .
1.34 jmc 275: .Pp
1.1 jsing 276: Each line consists of three columns:
277: the first column is the OID in numerical format and should be followed by
278: whitespace.
279: The second column is the
1.34 jmc 280: .Qq short name ,
1.1 jsing 281: which is a single word followed by whitespace.
282: The final column is the rest of the line and is the
283: .Qq long name .
284: .Nm asn1parse
285: displays the long name.
1.34 jmc 286: .It Fl out Ar file
287: The DER-encoded output file; the default is no encoded output
288: (useful when combined with
289: .Fl strparse ) .
290: .It Fl strparse Ar offset
291: Parse the content octets of the ASN.1 object starting at
292: .Ar offset .
293: This option can be used multiple times to
294: .Qq drill down
295: into a nested structure.
296: .El
1.1 jsing 297: .Sh CA
298: .nr nS 1
299: .Nm "openssl ca"
300: .Op Fl batch
301: .Op Fl cert Ar file
302: .Op Fl config Ar file
1.91 schwarze 303: .Op Fl create_serial
1.1 jsing 304: .Op Fl crl_CA_compromise Ar time
305: .Op Fl crl_compromise Ar time
306: .Op Fl crl_hold Ar instruction
307: .Op Fl crl_reason Ar reason
308: .Op Fl crldays Ar days
309: .Op Fl crlexts Ar section
310: .Op Fl crlhours Ar hours
1.103 inoguchi 311: .Op Fl crlsec Ar seconds
1.1 jsing 312: .Op Fl days Ar arg
313: .Op Fl enddate Ar date
314: .Op Fl extensions Ar section
1.103 inoguchi 315: .Op Fl extfile Ar file
1.1 jsing 316: .Op Fl gencrl
317: .Op Fl in Ar file
318: .Op Fl infiles
1.91 schwarze 319: .Op Fl key Ar password
1.103 inoguchi 320: .Op Fl keyfile Ar file
1.91 schwarze 321: .Op Fl keyform Cm pem | der
1.103 inoguchi 322: .Op Fl md Ar alg
1.1 jsing 323: .Op Fl msie_hack
1.91 schwarze 324: .Op Fl multivalue\-rdn
1.1 jsing 325: .Op Fl name Ar section
326: .Op Fl noemailDN
327: .Op Fl notext
328: .Op Fl out Ar file
1.103 inoguchi 329: .Op Fl outdir Ar directory
1.1 jsing 330: .Op Fl passin Ar arg
331: .Op Fl policy Ar arg
332: .Op Fl preserveDN
333: .Op Fl revoke Ar file
1.91 schwarze 334: .Op Fl selfsign
1.103 inoguchi 335: .Op Fl sigopt Ar nm:v
1.1 jsing 336: .Op Fl spkac Ar file
337: .Op Fl ss_cert Ar file
338: .Op Fl startdate Ar date
339: .Op Fl status Ar serial
340: .Op Fl subj Ar arg
341: .Op Fl updatedb
1.91 schwarze 342: .Op Fl utf8
1.1 jsing 343: .Op Fl verbose
344: .nr nS 0
345: .Pp
346: The
347: .Nm ca
1.35 jmc 348: command is a minimal certificate authority (CA) application.
1.1 jsing 349: It can be used to sign certificate requests in a variety of forms
1.35 jmc 350: and generate certificate revocation lists (CRLs).
1.1 jsing 351: It also maintains a text database of issued certificates and their status.
352: .Pp
1.35 jmc 353: The options relevant to CAs are as follows:
1.1 jsing 354: .Bl -tag -width "XXXX"
355: .It Fl batch
1.41 jmc 356: Batch mode.
1.1 jsing 357: In this mode no questions will be asked
358: and all certificates will be certified automatically.
359: .It Fl cert Ar file
360: The CA certificate file.
361: .It Fl config Ar file
1.72 jmc 362: Specify an alternative configuration file.
1.91 schwarze 363: .It Fl create_serial
364: If reading the serial from the text file as specified in the
365: configuration fails, create a new random serial to be used as the
366: next serial number.
1.1 jsing 367: .It Fl days Ar arg
368: The number of days to certify the certificate for.
369: .It Fl enddate Ar date
1.41 jmc 370: Set the expiry date.
1.88 jmc 371: The format of the date is [YY]YYMMDDHHMMSSZ,
372: with all four year digits required for dates from 2050 onwards.
1.1 jsing 373: .It Fl extensions Ar section
374: The section of the configuration file containing certificate extensions
375: to be added when a certificate is issued (defaults to
1.35 jmc 376: .Cm x509_extensions
1.1 jsing 377: unless the
378: .Fl extfile
379: option is used).
380: If no extension section is present, a V1 certificate is created.
381: If the extension section is present
382: .Pq even if it is empty ,
383: then a V3 certificate is created.
1.91 schwarze 384: See the
385: .Xr x509v3.cnf 5
386: manual page for details of the extension section format.
1.1 jsing 387: .It Fl extfile Ar file
388: An additional configuration
389: .Ar file
390: to read certificate extensions from
391: (using the default section unless the
392: .Fl extensions
393: option is also used).
394: .It Fl in Ar file
395: An input
396: .Ar file
397: containing a single certificate request to be signed by the CA.
398: .It Fl infiles
399: If present, this should be the last option; all subsequent arguments
400: are assumed to be the names of files containing certificate requests.
1.91 schwarze 401: .It Fl key Ar password
402: The
403: .Fa password
404: used to encrypt the private key.
1.35 jmc 405: Since on some systems the command line arguments are visible,
406: this option should be used with caution.
1.1 jsing 407: .It Fl keyfile Ar file
408: The private key to sign requests with.
1.91 schwarze 409: .It Fl keyform Cm pem | der
1.1 jsing 410: Private key file format.
1.91 schwarze 411: The default is
412: .Cm pem .
1.1 jsing 413: .It Fl md Ar alg
414: The message digest to use.
415: Possible values include
416: .Ar md5
417: and
418: .Ar sha1 .
419: This option also applies to CRLs.
420: .It Fl msie_hack
421: This is a legacy option to make
422: .Nm ca
423: work with very old versions of the IE certificate enrollment control
424: .Qq certenr3 .
425: It used UniversalStrings for almost everything.
426: Since the old control has various security bugs,
427: its use is strongly discouraged.
428: The newer control
429: .Qq Xenroll
430: does not need this option.
1.91 schwarze 431: .It Fl multivalue\-rdn
432: This option causes the
433: .Fl subj
434: argument to be interpreted with full support for multivalued RDNs,
435: for example
436: .Qq "/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe" .
437: If
438: .Fl multivalue\-rdn
439: is not used, the UID value is set to
440: .Qq "123456+CN=John Doe" .
1.1 jsing 441: .It Fl name Ar section
442: Specifies the configuration file
443: .Ar section
444: to use (overrides
445: .Cm default_ca
446: in the
447: .Cm ca
448: section).
449: .It Fl noemailDN
450: The DN of a certificate can contain the EMAIL field if present in the
1.30 mmcc 451: request DN, however it is good policy just having the email set into
1.1 jsing 452: the
1.35 jmc 453: .Cm altName
1.1 jsing 454: extension of the certificate.
455: When this option is set, the EMAIL field is removed from the certificate's
456: subject and set only in the, eventually present, extensions.
457: The
458: .Ar email_in_dn
459: keyword can be used in the configuration file to enable this behaviour.
460: .It Fl notext
461: Don't output the text form of a certificate to the output file.
462: .It Fl out Ar file
463: The output file to output certificates to.
464: The default is standard output.
1.91 schwarze 465: The certificate details will also be printed out to this file in
466: PEM format, except that
467: .Fl spkac
468: outputs DER format.
1.1 jsing 469: .It Fl outdir Ar directory
470: The
471: .Ar directory
472: to output certificates to.
473: The certificate will be written to a file consisting of the
474: serial number in hex with
475: .Qq .pem
476: appended.
477: .It Fl passin Ar arg
478: The key password source.
479: .It Fl policy Ar arg
1.41 jmc 480: Define the CA
1.1 jsing 481: .Qq policy
482: to use.
1.35 jmc 483: The policy section in the configuration file
484: consists of a set of variables corresponding to certificate DN fields.
485: The values may be one of
486: .Qq match
487: (the value must match the same field in the CA certificate),
488: .Qq supplied
489: (the value must be present), or
490: .Qq optional
491: (the value may be present).
492: Any fields not mentioned in the policy section
493: are silently deleted, unless the
494: .Fl preserveDN
495: option is set,
496: but this can be regarded more of a quirk than intended behaviour.
1.1 jsing 497: .It Fl preserveDN
498: Normally, the DN order of a certificate is the same as the order of the
499: fields in the relevant policy section.
500: When this option is set, the order is the same as the request.
501: This is largely for compatibility with the older IE enrollment control
502: which would only accept certificates if their DNs matched the order of the
503: request.
504: This is not needed for Xenroll.
1.91 schwarze 505: .It Fl selfsign
506: Indicates the issued certificates are to be signed with the key the
507: certificate requests were signed with, given with
508: .Fl keyfile .
509: Certificate requests signed with a different key are ignored.
510: If
511: .Fl gencrl ,
512: .Fl spkac ,
513: or
514: .Fl ss_cert
515: are given,
516: .Fl selfsign
517: is ignored.
518: .Pp
519: A consequence of using
520: .Fl selfsign
521: is that the self-signed certificate appears among the entries in
522: the certificate database (see the configuration option
523: .Cm database )
524: and uses the same serial number counter as all other certificates
525: signed with the self-signed certificate.
1.103 inoguchi 526: .It Fl sigopt Ar nm:v
527: Pass options to the signature algorithm during sign or certify operations.
528: The names and values of these options are algorithm-specific.
1.1 jsing 529: .It Fl spkac Ar file
530: A file containing a single Netscape signed public key and challenge,
531: and additional field values to be signed by the CA.
1.35 jmc 532: This will usually come from the
533: KEYGEN tag in an HTML form to create a new private key.
534: It is, however, possible to create SPKACs using the
535: .Nm spkac
536: utility.
537: .Pp
538: The file should contain the variable SPKAC set to the value of
539: the SPKAC and also the required DN components as name value pairs.
540: If it's necessary to include the same component twice,
541: then it can be preceded by a number and a
542: .Sq \&. .
1.1 jsing 543: .It Fl ss_cert Ar file
544: A single self-signed certificate to be signed by the CA.
545: .It Fl startdate Ar date
1.41 jmc 546: Set the start date.
1.88 jmc 547: The format of the date is [YY]YYMMDDHHMMSSZ,
548: with all four year digits required for dates from 2050 onwards.
1.91 schwarze 549: .It Fl subj Ar arg
550: Supersedes the subject name given in the request.
551: The
552: .Ar arg
553: must be formatted as
554: .Sm off
555: .Pf / Ar type0 Ns = Ar value0 Ns / Ar type 1 Ns = Ar value 1 Ns /
556: .Ar type2 Ns = Ar ... ;
557: .Sm on
558: characters may be escaped by
559: .Sq \e
560: .Pq backslash ,
561: no spaces are skipped.
562: .It Fl utf8
563: Interpret field values read from a terminal or obtained from a
564: configuration file as UTF-8 strings.
565: By default, they are interpreted as ASCII.
1.1 jsing 566: .It Fl verbose
1.41 jmc 567: Print extra details about the operations being performed.
1.1 jsing 568: .El
1.35 jmc 569: .Pp
570: The options relevant to CRLs are as follows:
1.1 jsing 571: .Bl -tag -width "XXXX"
572: .It Fl crl_CA_compromise Ar time
573: This is the same as
574: .Fl crl_compromise ,
575: except the revocation reason is set to CACompromise.
576: .It Fl crl_compromise Ar time
1.41 jmc 577: Set the revocation reason to keyCompromise and the compromise time to
1.1 jsing 578: .Ar time .
579: .Ar time
580: should be in GeneralizedTime format, i.e. YYYYMMDDHHMMSSZ.
581: .It Fl crl_hold Ar instruction
1.41 jmc 582: Set the CRL revocation reason code to certificateHold and the hold
1.1 jsing 583: instruction to
584: .Ar instruction
585: which must be an OID.
586: Although any OID can be used, only holdInstructionNone
587: (the use of which is discouraged by RFC 2459), holdInstructionCallIssuer or
588: holdInstructionReject will normally be used.
589: .It Fl crl_reason Ar reason
590: Revocation reason, where
591: .Ar reason
592: is one of:
593: unspecified, keyCompromise, CACompromise, affiliationChanged, superseded,
594: cessationOfOperation, certificateHold or removeFromCRL.
595: The matching of
596: .Ar reason
597: is case insensitive.
598: Setting any revocation reason will make the CRL v2.
599: In practice, removeFromCRL is not particularly useful because it is only used
600: in delta CRLs which are not currently implemented.
1.103 inoguchi 601: .It Fl crldays Ar days
1.1 jsing 602: The number of days before the next CRL is due.
603: This is the days from now to place in the CRL
1.35 jmc 604: .Cm nextUpdate
1.1 jsing 605: field.
606: .It Fl crlexts Ar section
607: The
608: .Ar section
609: of the configuration file containing CRL extensions to include.
610: If no CRL extension section is present then a V1 CRL is created;
611: if the CRL extension section is present
1.81 jmc 612: (even if it is empty)
1.1 jsing 613: then a V2 CRL is created.
1.81 jmc 614: The CRL extensions specified are CRL extensions and not CRL entry extensions.
615: It should be noted that some software can't handle V2 CRLs.
1.91 schwarze 616: See the
617: .Xr x509v3.cnf 5
618: manual page for details of the extension section format.
1.103 inoguchi 619: .It Fl crlhours Ar hours
1.1 jsing 620: The number of hours before the next CRL is due.
1.103 inoguchi 621: .It Fl crlsec Ar seconds
622: The number of seconds before the next CRL is due.
1.1 jsing 623: .It Fl gencrl
1.41 jmc 624: Generate a CRL based on information in the index file.
1.1 jsing 625: .It Fl revoke Ar file
626: A
627: .Ar file
628: containing a certificate to revoke.
1.91 schwarze 629: .It Fl status Ar serial
630: Show the status of the certificate with serial number
631: .Ar serial .
632: .It Fl updatedb
633: Update the database index to purge expired certificates.
1.1 jsing 634: .El
635: .Pp
1.35 jmc 636: Many of the options can be set in the
637: .Cm ca
638: section of the configuration file
639: (or in the default section of the configuration file),
640: specified using
641: .Cm default_ca
642: or
643: .Fl name .
644: The options
645: .Cm preserve
646: and
647: .Cm msie_hack
648: are read directly from the
649: .Cm ca
650: section.
1.1 jsing 651: .Pp
652: Many of the configuration file options are identical to command line
653: options.
654: Where the option is present in the configuration file and the command line,
655: the command line value is used.
656: Where an option is described as mandatory, then it must be present in
657: the configuration file or the command line equivalent
658: .Pq if any
659: used.
660: .Bl -tag -width "XXXX"
1.35 jmc 661: .It Cm certificate
1.1 jsing 662: The same as
663: .Fl cert .
664: It gives the file containing the CA certificate.
665: Mandatory.
1.35 jmc 666: .It Cm copy_extensions
1.1 jsing 667: Determines how extensions in certificate requests should be handled.
668: If set to
1.35 jmc 669: .Cm none
1.1 jsing 670: or this option is not present, then extensions are
671: ignored and not copied to the certificate.
672: If set to
1.35 jmc 673: .Cm copy ,
1.1 jsing 674: then any extensions present in the request that are not already present
675: are copied to the certificate.
676: If set to
1.35 jmc 677: .Cm copyall ,
1.1 jsing 678: then all extensions in the request are copied to the certificate:
679: if the extension is already present in the certificate it is deleted first.
1.35 jmc 680: .Pp
681: The
682: .Cm copy_extensions
683: option should be used with caution.
684: If care is not taken, it can be a security risk.
685: For example, if a certificate request contains a
686: .Cm basicConstraints
687: extension with CA:TRUE and the
688: .Cm copy_extensions
689: value is set to
690: .Cm copyall
691: and the user does not spot
1.91 schwarze 692: this when the certificate is displayed, then this will hand the requester
1.35 jmc 693: a valid CA certificate.
694: .Pp
695: This situation can be avoided by setting
696: .Cm copy_extensions
697: to
698: .Cm copy
699: and including
700: .Cm basicConstraints
701: with CA:FALSE in the configuration file.
702: Then if the request contains a
703: .Cm basicConstraints
704: extension, it will be ignored.
1.1 jsing 705: .Pp
706: The main use of this option is to allow a certificate request to supply
707: values for certain extensions such as
1.35 jmc 708: .Cm subjectAltName .
709: .It Cm crl_extensions
1.1 jsing 710: The same as
711: .Fl crlexts .
1.35 jmc 712: .It Cm crlnumber
1.1 jsing 713: A text file containing the next CRL number to use in hex.
714: The CRL number will be inserted in the CRLs only if this file exists.
715: If this file is present, it must contain a valid CRL number.
1.35 jmc 716: .It Cm database
1.1 jsing 717: The text database file to use.
718: Mandatory.
719: This file must be present, though initially it will be empty.
1.35 jmc 720: .It Cm default_crl_hours , default_crl_days
1.1 jsing 721: The same as the
722: .Fl crlhours
723: and
724: .Fl crldays
725: options.
726: These will only be used if neither command line option is present.
727: At least one of these must be present to generate a CRL.
1.35 jmc 728: .It Cm default_days
1.1 jsing 729: The same as the
730: .Fl days
731: option.
732: The number of days to certify a certificate for.
1.35 jmc 733: .It Cm default_enddate
1.1 jsing 734: The same as the
735: .Fl enddate
736: option.
737: Either this option or
1.35 jmc 738: .Cm default_days
1.1 jsing 739: .Pq or the command line equivalents
740: must be present.
1.35 jmc 741: .It Cm default_md
1.1 jsing 742: The same as the
743: .Fl md
744: option.
745: The message digest to use.
746: Mandatory.
1.35 jmc 747: .It Cm default_startdate
1.1 jsing 748: The same as the
749: .Fl startdate
750: option.
751: The start date to certify a certificate for.
752: If not set, the current time is used.
1.35 jmc 753: .It Cm email_in_dn
1.1 jsing 754: The same as
755: .Fl noemailDN .
756: If the EMAIL field is to be removed from the DN of the certificate,
757: simply set this to
758: .Qq no .
759: If not present, the default is to allow for the EMAIL field in the
760: certificate's DN.
1.35 jmc 761: .It Cm msie_hack
1.1 jsing 762: The same as
763: .Fl msie_hack .
1.35 jmc 764: .It Cm name_opt , cert_opt
1.1 jsing 765: These options allow the format used to display the certificate details
766: when asking the user to confirm signing.
767: All the options supported by the
768: .Nm x509
769: utilities'
770: .Fl nameopt
771: and
772: .Fl certopt
773: switches can be used here, except that
1.35 jmc 774: .Cm no_signame
1.1 jsing 775: and
1.35 jmc 776: .Cm no_sigdump
1.1 jsing 777: are permanently set and cannot be disabled
778: (this is because the certificate signature cannot be displayed because
779: the certificate has not been signed at this point).
780: .Pp
781: For convenience, the value
1.35 jmc 782: .Cm ca_default
1.1 jsing 783: is accepted by both to produce a reasonable output.
784: .Pp
785: If neither option is present, the format used in earlier versions of
1.35 jmc 786: .Nm openssl
1.1 jsing 787: is used.
1.81 jmc 788: Use of the old format is strongly discouraged
789: because it only displays fields mentioned in the
1.35 jmc 790: .Cm policy
1.1 jsing 791: section,
792: mishandles multicharacter string types and does not display extensions.
1.35 jmc 793: .It Cm new_certs_dir
1.1 jsing 794: The same as the
795: .Fl outdir
796: command line option.
797: It specifies the directory where new certificates will be placed.
798: Mandatory.
1.35 jmc 799: .It Cm oid_file
1.1 jsing 800: This specifies a file containing additional object identifiers.
801: Each line of the file should consist of the numerical form of the
802: object identifier followed by whitespace, then the short name followed
803: by whitespace and finally the long name.
1.35 jmc 804: .It Cm oid_section
1.1 jsing 805: This specifies a section in the configuration file containing extra
806: object identifiers.
807: Each line should consist of the short name of the object identifier
808: followed by
809: .Sq =
810: and the numerical form.
811: The short and long names are the same when this option is used.
1.35 jmc 812: .It Cm policy
1.1 jsing 813: The same as
814: .Fl policy .
815: Mandatory.
1.35 jmc 816: .It Cm preserve
1.1 jsing 817: The same as
818: .Fl preserveDN .
1.35 jmc 819: .It Cm private_key
1.1 jsing 820: Same as the
821: .Fl keyfile
822: option.
823: The file containing the CA private key.
824: Mandatory.
1.35 jmc 825: .It Cm serial
1.1 jsing 826: A text file containing the next serial number to use in hex.
827: Mandatory.
828: This file must be present and contain a valid serial number.
1.35 jmc 829: .It Cm unique_subject
1.1 jsing 830: If the value
1.35 jmc 831: .Cm yes
1.1 jsing 832: is given, the valid certificate entries in the
833: database must have unique subjects.
834: If the value
1.35 jmc 835: .Cm no
1.1 jsing 836: is given,
837: several valid certificate entries may have the exact same subject.
838: The default value is
1.35 jmc 839: .Cm yes .
840: .It Cm x509_extensions
1.1 jsing 841: The same as
842: .Fl extensions .
843: .El
844: .Sh CIPHERS
845: .Nm openssl ciphers
846: .Op Fl hVv
1.93 schwarze 847: .Op Ar control
1.1 jsing 848: .Pp
849: The
850: .Nm ciphers
1.93 schwarze 851: command converts the
852: .Ar control
853: string from the format documented in
854: .Xr SSL_CTX_set_cipher_list 3
855: into an ordered SSL cipher suite preference list.
856: If no
857: .Ar control
858: string is specified, the
859: .Cm DEFAULT
860: list is printed.
1.1 jsing 861: .Pp
862: The options are as follows:
863: .Bl -tag -width Ds
864: .It Fl h , \&?
865: Print a brief usage message.
866: .It Fl V
1.36 jmc 867: Verbose.
1.92 schwarze 868: List ciphers with cipher suite code in hex format,
869: cipher name, and a complete description of protocol version,
870: key exchange, authentication, encryption, and mac algorithms.
1.36 jmc 871: .It Fl v
1.1 jsing 872: Like
1.36 jmc 873: .Fl V ,
874: but without cipher suite codes.
1.1 jsing 875: .El
876: .Sh CRL
877: .nr nS 1
878: .Nm "openssl crl"
879: .Op Fl CAfile Ar file
880: .Op Fl CApath Ar dir
1.104 inoguchi 881: .Op Fl crlnumber
1.1 jsing 882: .Op Fl fingerprint
883: .Op Fl hash
1.104 inoguchi 884: .Op Fl hash_old
1.1 jsing 885: .Op Fl in Ar file
1.38 jmc 886: .Op Fl inform Cm der | pem
1.1 jsing 887: .Op Fl issuer
888: .Op Fl lastupdate
1.104 inoguchi 889: .Op Fl nameopt Ar option
1.1 jsing 890: .Op Fl nextupdate
891: .Op Fl noout
892: .Op Fl out Ar file
1.38 jmc 893: .Op Fl outform Cm der | pem
1.1 jsing 894: .Op Fl text
1.104 inoguchi 895: .Op Fl verify
1.1 jsing 896: .nr nS 0
897: .Pp
898: The
899: .Nm crl
900: command processes CRL files in DER or PEM format.
1.37 jmc 901: .Pp
1.1 jsing 902: The options are as follows:
903: .Bl -tag -width Ds
904: .It Fl CAfile Ar file
905: Verify the signature on a CRL by looking up the issuing certificate in
906: .Ar file .
907: .It Fl CApath Ar directory
908: Verify the signature on a CRL by looking up the issuing certificate in
909: .Ar dir .
910: This directory must be a standard certificate directory,
911: i.e. a hash of each subject name (using
912: .Cm x509 Fl hash )
913: should be linked to each certificate.
1.104 inoguchi 914: .It Fl crlnumber
915: Print the CRL number.
1.1 jsing 916: .It Fl fingerprint
917: Print the CRL fingerprint.
918: .It Fl hash
919: Output a hash of the issuer name.
920: This can be used to look up CRLs in a directory by issuer name.
1.104 inoguchi 921: .It Fl hash_old
922: Output an old-style (MD5) hash of the issuer name.
1.1 jsing 923: .It Fl in Ar file
1.37 jmc 924: The input file to read from, or standard input if not specified.
1.38 jmc 925: .It Fl inform Cm der | pem
1.37 jmc 926: The input format.
1.1 jsing 927: .It Fl issuer
928: Output the issuer name.
929: .It Fl lastupdate
930: Output the
1.37 jmc 931: .Cm lastUpdate
1.1 jsing 932: field.
1.104 inoguchi 933: .It Fl nameopt Ar option
934: Specify certificate name options.
1.1 jsing 935: .It Fl nextupdate
936: Output the
1.37 jmc 937: .Cm nextUpdate
1.1 jsing 938: field.
939: .It Fl noout
1.46 jmc 940: Do not output the encoded version of the CRL.
1.1 jsing 941: .It Fl out Ar file
1.37 jmc 942: The output file to write to, or standard output if not specified.
1.38 jmc 943: .It Fl outform Cm der | pem
1.37 jmc 944: The output format.
1.1 jsing 945: .It Fl text
1.64 jmc 946: Print the CRL in plain text.
1.104 inoguchi 947: .It Fl verify
948: Verify the signature on the CRL.
1.1 jsing 949: .El
950: .Sh CRL2PKCS7
951: .nr nS 1
952: .Nm "openssl crl2pkcs7"
953: .Op Fl certfile Ar file
954: .Op Fl in Ar file
1.40 jmc 955: .Op Fl inform Cm der | pem
1.1 jsing 956: .Op Fl nocrl
957: .Op Fl out Ar file
1.40 jmc 958: .Op Fl outform Cm der | pem
1.1 jsing 959: .nr nS 0
960: .Pp
961: The
962: .Nm crl2pkcs7
963: command takes an optional CRL and one or more
964: certificates and converts them into a PKCS#7 degenerate
965: .Qq certificates only
966: structure.
967: .Pp
968: The options are as follows:
969: .Bl -tag -width Ds
970: .It Fl certfile Ar file
1.40 jmc 971: Add the certificates in PEM
1.1 jsing 972: .Ar file
1.40 jmc 973: to the PKCS#7 structure.
974: This option can be used more than once
975: to read certificates from multiple files.
1.1 jsing 976: .It Fl in Ar file
1.40 jmc 977: Read the CRL from
978: .Ar file ,
979: or standard input if not specified.
980: .It Fl inform Cm der | pem
1.64 jmc 981: The input format.
1.1 jsing 982: .It Fl nocrl
983: Normally, a CRL is included in the output file.
984: With this option, no CRL is
985: included in the output file and a CRL is not read from the input file.
986: .It Fl out Ar file
1.40 jmc 987: Write the PKCS#7 structure to
988: .Ar file ,
989: or standard output if not specified.
990: .It Fl outform Cm der | pem
1.64 jmc 991: The output format.
1.1 jsing 992: .El
993: .Sh DGST
994: .nr nS 1
995: .Nm "openssl dgst"
1.105 inoguchi 996: .Op Fl cdr
1.1 jsing 997: .Op Fl binary
1.43 jmc 998: .Op Fl Ar digest
1.1 jsing 999: .Op Fl hex
1000: .Op Fl hmac Ar key
1.43 jmc 1001: .Op Fl keyform Cm pem
1.1 jsing 1002: .Op Fl mac Ar algorithm
1003: .Op Fl macopt Ar nm : Ns Ar v
1004: .Op Fl out Ar file
1005: .Op Fl passin Ar arg
1006: .Op Fl prverify Ar file
1007: .Op Fl sign Ar file
1008: .Op Fl signature Ar file
1009: .Op Fl sigopt Ar nm : Ns Ar v
1010: .Op Fl verify Ar file
1011: .Op Ar
1012: .nr nS 0
1013: .Pp
1014: The digest functions output the message digest of a supplied
1015: .Ar file
1016: or
1017: .Ar files
1018: in hexadecimal form.
1019: They can also be used for digital signing and verification.
1020: .Pp
1021: The options are as follows:
1022: .Bl -tag -width Ds
1023: .It Fl binary
1024: Output the digest or signature in binary form.
1025: .It Fl c
1.48 jmc 1026: Print the digest in two-digit groups separated by colons.
1.1 jsing 1027: .It Fl d
1.48 jmc 1028: Print BIO debugging information.
1.43 jmc 1029: .It Fl Ar digest
1030: Use the specified message
1031: .Ar digest .
1.98 naddy 1032: The default is SHA256.
1.43 jmc 1033: The available digests can be displayed using
1034: .Nm openssl
1035: .Cm list-message-digest-commands .
1036: The following are equivalent:
1037: .Nm openssl dgst
1.98 naddy 1038: .Fl sha256
1.43 jmc 1039: and
1040: .Nm openssl
1.98 naddy 1041: .Cm sha256 .
1.1 jsing 1042: .It Fl hex
1043: Digest is to be output as a hex dump.
1044: This is the default case for a
1045: .Qq normal
1046: digest as opposed to a digital signature.
1047: .It Fl hmac Ar key
1048: Create a hashed MAC using
1049: .Ar key .
1.43 jmc 1050: .It Fl keyform Cm pem
1.1 jsing 1051: Specifies the key format to sign the digest with.
1052: .It Fl mac Ar algorithm
1053: Create a keyed Message Authentication Code (MAC).
1054: The most popular MAC algorithm is HMAC (hash-based MAC),
1055: but there are other MAC algorithms which are not based on hash.
1056: MAC keys and other options should be set via the
1057: .Fl macopt
1058: parameter.
1059: .It Fl macopt Ar nm : Ns Ar v
1060: Passes options to the MAC algorithm, specified by
1061: .Fl mac .
1062: The following options are supported by HMAC:
1063: .Bl -tag -width Ds
1.43 jmc 1064: .It Cm key : Ns Ar string
1.1 jsing 1065: Specifies the MAC key as an alphanumeric string
1066: (use if the key contain printable characters only).
1067: String length must conform to any restrictions of the MAC algorithm.
1.43 jmc 1068: .It Cm hexkey : Ns Ar string
1.1 jsing 1069: Specifies the MAC key in hexadecimal form (two hex digits per byte).
1070: Key length must conform to any restrictions of the MAC algorithm.
1071: .El
1072: .It Fl out Ar file
1.43 jmc 1073: The output file to write to,
1074: or standard output if not specified.
1.1 jsing 1075: .It Fl passin Ar arg
1076: The key password source.
1077: .It Fl prverify Ar file
1078: Verify the signature using the private key in
1079: .Ar file .
1080: The output is either
1081: .Qq Verification OK
1082: or
1083: .Qq Verification Failure .
1.105 inoguchi 1084: .It Fl r
1085: Print the digest in coreutils format.
1.1 jsing 1086: .It Fl sign Ar file
1087: Digitally sign the digest using the private key in
1088: .Ar file .
1089: .It Fl signature Ar file
1090: The actual signature to verify.
1091: .It Fl sigopt Ar nm : Ns Ar v
1092: Pass options to the signature algorithm during sign or verify operations.
1093: The names and values of these options are algorithm-specific.
1094: .It Fl verify Ar file
1095: Verify the signature using the public key in
1096: .Ar file .
1097: The output is either
1098: .Qq Verification OK
1099: or
1100: .Qq Verification Failure .
1101: .It Ar
1102: File or files to digest.
1103: If no files are specified then standard input is used.
1104: .El
1105: .Sh DHPARAM
1106: .nr nS 1
1107: .Nm "openssl dhparam"
1108: .Op Fl 2 | 5
1109: .Op Fl C
1110: .Op Fl check
1111: .Op Fl dsaparam
1112: .Op Fl in Ar file
1.44 jmc 1113: .Op Fl inform Cm der | pem
1.1 jsing 1114: .Op Fl noout
1115: .Op Fl out Ar file
1.44 jmc 1116: .Op Fl outform Cm der | pem
1.1 jsing 1117: .Op Fl text
1118: .Op Ar numbits
1119: .nr nS 0
1120: .Pp
1121: The
1122: .Nm dhparam
1123: command is used to manipulate DH parameter files.
1.44 jmc 1124: Only the older PKCS#3 DH is supported,
1125: not the newer X9.42 DH.
1.1 jsing 1126: .Pp
1127: The options are as follows:
1128: .Bl -tag -width Ds
1129: .It Fl 2 , 5
1.44 jmc 1130: The generator to use;
1.1 jsing 1131: 2 is the default.
1132: If present, the input file is ignored and parameters are generated instead.
1133: .It Fl C
1.44 jmc 1134: Convert the parameters into C code.
1.1 jsing 1135: The parameters can then be loaded by calling the
1.44 jmc 1136: .No get_dh Ns Ar numbits
1.1 jsing 1137: function.
1138: .It Fl check
1139: Check the DH parameters.
1140: .It Fl dsaparam
1.44 jmc 1141: Read or create DSA parameters,
1142: converted to DH format on output.
1.1 jsing 1143: Otherwise,
1144: .Qq strong
1145: primes
1146: .Pq such that (p-1)/2 is also prime
1147: will be used for DH parameter generation.
1148: .Pp
1149: DH parameter generation with the
1150: .Fl dsaparam
1151: option is much faster,
1152: and the recommended exponent length is shorter,
1153: which makes DH key exchange more efficient.
1154: Beware that with such DSA-style DH parameters,
1155: a fresh DH key should be created for each use to
1156: avoid small-subgroup attacks that may be possible otherwise.
1157: .It Fl in Ar file
1.44 jmc 1158: The input file to read from,
1159: or standard input if not specified.
1160: .It Fl inform Cm der | pem
1161: The input format.
1.1 jsing 1162: .It Fl noout
1.46 jmc 1163: Do not output the encoded version of the parameters.
1.44 jmc 1164: .It Fl out Ar file
1165: The output file to write to,
1166: or standard output if not specified.
1167: .It Fl outform Cm der | pem
1168: The output format.
1169: .It Fl text
1.64 jmc 1170: Print the DH parameters in plain text.
1.1 jsing 1171: .It Ar numbits
1.44 jmc 1172: Generate a parameter set of size
1.1 jsing 1173: .Ar numbits .
1174: It must be the last option.
1.16 sthen 1175: If not present, a value of 2048 is used.
1.1 jsing 1176: If this value is present, the input file is ignored and
1177: parameters are generated instead.
1178: .El
1179: .Sh DSA
1180: .nr nS 1
1181: .Nm "openssl dsa"
1182: .Oo
1183: .Fl aes128 | aes192 | aes256 |
1184: .Fl des | des3
1185: .Oc
1186: .Op Fl in Ar file
1.45 jmc 1187: .Op Fl inform Cm der | pem
1.1 jsing 1188: .Op Fl modulus
1189: .Op Fl noout
1190: .Op Fl out Ar file
1.45 jmc 1191: .Op Fl outform Cm der | pem
1.1 jsing 1192: .Op Fl passin Ar arg
1193: .Op Fl passout Ar arg
1194: .Op Fl pubin
1195: .Op Fl pubout
1196: .Op Fl text
1197: .nr nS 0
1198: .Pp
1199: The
1200: .Nm dsa
1201: command processes DSA keys.
1202: They can be converted between various forms and their components printed out.
1203: .Pp
1204: .Sy Note :
1205: This command uses the traditional
1206: .Nm SSLeay
1207: compatible format for private key encryption:
1208: newer applications should use the more secure PKCS#8 format using the
1209: .Nm pkcs8
1210: command.
1211: .Pp
1212: The options are as follows:
1213: .Bl -tag -width Ds
1214: .It Xo
1215: .Fl aes128 | aes192 | aes256 |
1216: .Fl des | des3
1217: .Xc
1.45 jmc 1218: Encrypt the private key with the AES, DES, or the triple DES
1.1 jsing 1219: ciphers, respectively, before outputting it.
1220: A pass phrase is prompted for.
1.45 jmc 1221: If none of these options are specified, the key is written in plain text.
1.1 jsing 1222: This means that using the
1223: .Nm dsa
1.45 jmc 1224: utility to read an encrypted key with no encryption option can be used to
1.1 jsing 1225: remove the pass phrase from a key,
1.45 jmc 1226: or by setting the encryption options it can be used to add or change
1.1 jsing 1227: the pass phrase.
1228: These options can only be used with PEM format output files.
1229: .It Fl in Ar file
1.45 jmc 1230: The input file to read from,
1231: or standard input if not specified.
1.1 jsing 1232: If the key is encrypted, a pass phrase will be prompted for.
1.45 jmc 1233: .It Fl inform Cm der | pem
1234: The input format.
1.1 jsing 1235: .It Fl modulus
1.45 jmc 1236: Print the value of the public key component of the key.
1.1 jsing 1237: .It Fl noout
1.46 jmc 1238: Do not output the encoded version of the key.
1.1 jsing 1239: .It Fl out Ar file
1.45 jmc 1240: The output file to write to,
1241: or standard output if not specified.
1.1 jsing 1242: If any encryption options are set then a pass phrase will be
1243: prompted for.
1.45 jmc 1244: .It Fl outform Cm der | pem
1245: The output format.
1.1 jsing 1246: .It Fl passin Ar arg
1247: The key password source.
1248: .It Fl passout Ar arg
1249: The output file password source.
1250: .It Fl pubin
1.60 jmc 1251: Read in a public key, not a private key.
1.1 jsing 1252: .It Fl pubout
1.60 jmc 1253: Output a public key, not a private key.
1254: Automatically set if the input is a public key.
1.1 jsing 1255: .It Fl text
1.64 jmc 1256: Print the public/private key in plain text.
1.1 jsing 1257: .El
1258: .Sh DSAPARAM
1259: .nr nS 1
1260: .Nm "openssl dsaparam"
1261: .Op Fl C
1262: .Op Fl genkey
1263: .Op Fl in Ar file
1.46 jmc 1264: .Op Fl inform Cm der | pem
1.1 jsing 1265: .Op Fl noout
1266: .Op Fl out Ar file
1.46 jmc 1267: .Op Fl outform Cm der | pem
1.1 jsing 1268: .Op Fl text
1269: .Op Ar numbits
1270: .nr nS 0
1271: .Pp
1272: The
1273: .Nm dsaparam
1274: command is used to manipulate or generate DSA parameter files.
1275: .Pp
1276: The options are as follows:
1277: .Bl -tag -width Ds
1278: .It Fl C
1.46 jmc 1279: Convert the parameters into C code.
1.1 jsing 1280: The parameters can then be loaded by calling the
1.46 jmc 1281: .No get_dsa Ns Ar XXX
1.1 jsing 1282: function.
1283: .It Fl genkey
1.46 jmc 1284: Generate a DSA key either using the specified or generated
1.1 jsing 1285: parameters.
1286: .It Fl in Ar file
1.46 jmc 1287: The input file to read from,
1288: or standard input if not specified.
1.1 jsing 1289: If the
1290: .Ar numbits
1.46 jmc 1291: parameter is included, then this option is ignored.
1292: .It Fl inform Cm der | pem
1293: The input format.
1.1 jsing 1294: .It Fl noout
1.46 jmc 1295: Do not output the encoded version of the parameters.
1296: .It Fl out Ar file
1297: The output file to write to,
1298: or standard output if not specified.
1299: .It Fl outform Cm der | pem
1300: The output format.
1301: .It Fl text
1.64 jmc 1302: Print the DSA parameters in plain text.
1.1 jsing 1303: .It Ar numbits
1.46 jmc 1304: Generate a parameter set of size
1.1 jsing 1305: .Ar numbits .
1.46 jmc 1306: If this option is included, the input file is ignored.
1.1 jsing 1307: .El
1308: .Sh EC
1309: .nr nS 1
1310: .Nm "openssl ec"
1311: .Op Fl conv_form Ar arg
1312: .Op Fl des
1313: .Op Fl des3
1314: .Op Fl in Ar file
1.47 jmc 1315: .Op Fl inform Cm der | pem
1.1 jsing 1316: .Op Fl noout
1317: .Op Fl out Ar file
1.47 jmc 1318: .Op Fl outform Cm der | pem
1.1 jsing 1319: .Op Fl param_enc Ar arg
1320: .Op Fl param_out
1321: .Op Fl passin Ar arg
1322: .Op Fl passout Ar arg
1323: .Op Fl pubin
1324: .Op Fl pubout
1325: .Op Fl text
1326: .nr nS 0
1327: .Pp
1328: The
1329: .Nm ec
1330: command processes EC keys.
1331: They can be converted between various
1332: forms and their components printed out.
1.47 jmc 1333: .Nm openssl
1.1 jsing 1334: uses the private key format specified in
1335: .Dq SEC 1: Elliptic Curve Cryptography
1336: .Pq Lk http://www.secg.org/ .
1337: To convert an
1338: EC private key into the PKCS#8 private key format use the
1339: .Nm pkcs8
1340: command.
1341: .Pp
1342: The options are as follows:
1343: .Bl -tag -width Ds
1344: .It Fl conv_form Ar arg
1.47 jmc 1345: Specify how the points on the elliptic curve are converted
1.1 jsing 1346: into octet strings.
1347: Possible values are:
1.95 tb 1348: .Cm compressed ,
1349: .Cm uncompressed
1.47 jmc 1350: (the default),
1.1 jsing 1351: and
1352: .Cm hybrid .
1353: For more information regarding
1.47 jmc 1354: the point conversion forms see the X9.62 standard.
1.1 jsing 1355: Note:
1356: Due to patent issues the
1357: .Cm compressed
1358: option is disabled by default for binary curves
1359: and can be enabled by defining the preprocessor macro
1.47 jmc 1360: .Dv OPENSSL_EC_BIN_PT_COMP
1.1 jsing 1361: at compile time.
1362: .It Fl des | des3
1.47 jmc 1363: Encrypt the private key with DES, triple DES, or
1.1 jsing 1364: any other cipher supported by
1.47 jmc 1365: .Nm openssl .
1.1 jsing 1366: A pass phrase is prompted for.
1367: If none of these options is specified the key is written in plain text.
1368: This means that using the
1369: .Nm ec
1370: utility to read in an encrypted key with no
1371: encryption option can be used to remove the pass phrase from a key,
1372: or by setting the encryption options
1.83 naddy 1373: it can be used to add or change the pass phrase.
1.1 jsing 1374: These options can only be used with PEM format output files.
1375: .It Fl in Ar file
1.47 jmc 1376: The input file to read a key from,
1377: or standard input if not specified.
1.1 jsing 1378: If the key is encrypted a pass phrase will be prompted for.
1.47 jmc 1379: .It Fl inform Cm der | pem
1380: The input format.
1.1 jsing 1381: .It Fl noout
1.47 jmc 1382: Do not output the encoded version of the key.
1.1 jsing 1383: .It Fl out Ar file
1.47 jmc 1384: The output filename to write to,
1385: or standard output if not specified.
1.1 jsing 1386: If any encryption options are set then a pass phrase will be prompted for.
1.47 jmc 1387: .It Fl outform Cm der | pem
1388: The output format.
1.1 jsing 1389: .It Fl param_enc Ar arg
1.47 jmc 1390: Specify how the elliptic curve parameters are encoded.
1.1 jsing 1391: Possible value are:
1392: .Cm named_curve ,
1393: i.e. the EC parameters are specified by an OID; or
1394: .Cm explicit ,
1395: where the EC parameters are explicitly given
1396: (see RFC 3279 for the definition of the EC parameter structures).
1397: The default value is
1398: .Cm named_curve .
1399: Note: the
1400: .Cm implicitlyCA
1401: alternative,
1402: as specified in RFC 3279,
1.47 jmc 1403: is currently not implemented.
1.106 ! inoguchi 1404: .It Fl param_out
! 1405: Print the elliptic curve parameters.
1.1 jsing 1406: .It Fl passin Ar arg
1407: The key password source.
1408: .It Fl passout Ar arg
1409: The output file password source.
1410: .It Fl pubin
1.60 jmc 1411: Read in a public key, not a private key.
1.1 jsing 1412: .It Fl pubout
1.60 jmc 1413: Output a public key, not a private key.
1414: Automatically set if the input is a public key.
1.1 jsing 1415: .It Fl text
1.64 jmc 1416: Print the public/private key in plain text.
1.1 jsing 1417: .El
1418: .Sh ECPARAM
1419: .nr nS 1
1420: .Nm "openssl ecparam"
1421: .Op Fl C
1422: .Op Fl check
1423: .Op Fl conv_form Ar arg
1424: .Op Fl genkey
1425: .Op Fl in Ar file
1.48 jmc 1426: .Op Fl inform Cm der | pem
1.1 jsing 1427: .Op Fl list_curves
1428: .Op Fl name Ar arg
1429: .Op Fl no_seed
1430: .Op Fl noout
1431: .Op Fl out Ar file
1.48 jmc 1432: .Op Fl outform Cm der | pem
1.1 jsing 1433: .Op Fl param_enc Ar arg
1434: .Op Fl text
1435: .nr nS 0
1436: .Pp
1.48 jmc 1437: The
1438: .Nm ecparam
1439: command is used to manipulate or generate EC parameter files.
1440: .Nm openssl
1441: is not able to generate new groups so
1442: .Nm ecparam
1443: can only create EC parameters from known (named) curves.
1444: .Pp
1.1 jsing 1445: The options are as follows:
1446: .Bl -tag -width Ds
1447: .It Fl C
1448: Convert the EC parameters into C code.
1449: The parameters can then be loaded by calling the
1.48 jmc 1450: .No get_ec_group_ Ns Ar XXX
1.1 jsing 1451: function.
1452: .It Fl check
1453: Validate the elliptic curve parameters.
1454: .It Fl conv_form Ar arg
1455: Specify how the points on the elliptic curve are converted
1456: into octet strings.
1457: Possible values are:
1.95 tb 1458: .Cm compressed ,
1459: .Cm uncompressed
1.48 jmc 1460: (the default),
1.1 jsing 1461: and
1462: .Cm hybrid .
1463: For more information regarding
1.48 jmc 1464: the point conversion forms see the X9.62 standard.
1.1 jsing 1465: Note:
1466: Due to patent issues the
1467: .Cm compressed
1468: option is disabled by default for binary curves
1469: and can be enabled by defining the preprocessor macro
1.48 jmc 1470: .Dv OPENSSL_EC_BIN_PT_COMP
1.1 jsing 1471: at compile time.
1472: .It Fl genkey
1473: Generate an EC private key using the specified parameters.
1474: .It Fl in Ar file
1.48 jmc 1475: The input file to read from,
1476: or standard input if not specified.
1477: .It Fl inform Cm der | pem
1478: The input format.
1.1 jsing 1479: .It Fl list_curves
1.48 jmc 1480: Print a list of all
1.1 jsing 1481: currently implemented EC parameter names and exit.
1482: .It Fl name Ar arg
1.48 jmc 1483: Use the EC parameters with the specified "short" name.
1.1 jsing 1484: .It Fl no_seed
1.48 jmc 1485: Do not include the seed for the parameter generation
1486: in the ECParameters structure (see RFC 3279).
1.1 jsing 1487: .It Fl noout
1.48 jmc 1488: Do not output the encoded version of the parameters.
1.1 jsing 1489: .It Fl out Ar file
1.48 jmc 1490: The output file to write to,
1491: or standard output if not specified.
1492: .It Fl outform Cm der | pem
1493: The output format.
1.1 jsing 1494: .It Fl param_enc Ar arg
1.48 jmc 1495: Specify how the elliptic curve parameters are encoded.
1.1 jsing 1496: Possible value are:
1497: .Cm named_curve ,
1498: i.e. the EC parameters are specified by an OID, or
1499: .Cm explicit ,
1500: where the EC parameters are explicitly given
1501: (see RFC 3279 for the definition of the EC parameter structures).
1502: The default value is
1503: .Cm named_curve .
1504: Note: the
1505: .Cm implicitlyCA
1506: alternative, as specified in RFC 3279,
1.48 jmc 1507: is currently not implemented.
1.1 jsing 1508: .It Fl text
1.64 jmc 1509: Print the EC parameters in plain text.
1.1 jsing 1510: .El
1511: .Sh ENC
1512: .nr nS 1
1513: .Nm "openssl enc"
1514: .Fl ciphername
1.106 ! inoguchi 1515: .Op Fl AadePpv
1.1 jsing 1516: .Op Fl base64
1517: .Op Fl bufsize Ar number
1518: .Op Fl debug
1519: .Op Fl in Ar file
1.97 jmc 1520: .Op Fl iter Ar iterations
1.1 jsing 1521: .Op Fl iv Ar IV
1522: .Op Fl K Ar key
1523: .Op Fl k Ar password
1524: .Op Fl kfile Ar file
1525: .Op Fl md Ar digest
1526: .Op Fl none
1527: .Op Fl nopad
1528: .Op Fl nosalt
1529: .Op Fl out Ar file
1530: .Op Fl pass Ar arg
1.96 beck 1531: .Op Fl pbkdf2
1.1 jsing 1532: .Op Fl S Ar salt
1533: .Op Fl salt
1534: .nr nS 0
1535: .Pp
1536: The symmetric cipher commands allow data to be encrypted or decrypted
1537: using various block and stream ciphers using keys based on passwords
1538: or explicitly provided.
1539: Base64 encoding or decoding can also be performed either by itself
1540: or in addition to the encryption or decryption.
1.49 jmc 1541: The program can be called either as
1542: .Nm openssl Ar ciphername
1543: or
1544: .Nm openssl enc - Ns Ar ciphername .
1545: .Pp
1546: Some of the ciphers do not have large keys and others have security
1547: implications if not used correctly.
1548: All the block ciphers normally use PKCS#5 padding,
1549: also known as standard block padding.
1550: If padding is disabled, the input data must be a multiple of the cipher
1551: block length.
1.1 jsing 1552: .Pp
1553: The options are as follows:
1554: .Bl -tag -width Ds
1555: .It Fl A
1556: If the
1557: .Fl a
1558: option is set, then base64 process the data on one line.
1559: .It Fl a , base64
1560: Base64 process the data.
1561: This means that if encryption is taking place, the data is base64-encoded
1562: after encryption.
1.49 jmc 1563: If decryption is set, the input data is base64-decoded before
1.1 jsing 1564: being decrypted.
1565: .It Fl bufsize Ar number
1566: Set the buffer size for I/O.
1567: .It Fl d
1568: Decrypt the input data.
1569: .It Fl debug
1570: Debug the BIOs used for I/O.
1571: .It Fl e
1.49 jmc 1572: Encrypt the input data.
1573: This is the default.
1.1 jsing 1574: .It Fl in Ar file
1.49 jmc 1575: The input file to read from,
1.57 jmc 1576: or standard input if not specified.
1.97 jmc 1577: .It Fl iter Ar iterations
1578: Use the pbkdf2 key derivation function, with
1579: .Ar iterations
1580: as the number of iterations.
1.1 jsing 1581: .It Fl iv Ar IV
1582: The actual
1583: .Ar IV
1584: .Pq initialisation vector
1585: to use:
1586: this must be represented as a string comprised only of hex digits.
1587: When only the
1588: .Ar key
1589: is specified using the
1590: .Fl K
1.49 jmc 1591: option,
1592: the IV must explicitly be defined.
1.1 jsing 1593: When a password is being specified using one of the other options,
1.49 jmc 1594: the IV is generated from this password.
1.1 jsing 1595: .It Fl K Ar key
1596: The actual
1597: .Ar key
1598: to use:
1599: this must be represented as a string comprised only of hex digits.
1.49 jmc 1600: If only the key is specified,
1601: the IV must also be specified using the
1.1 jsing 1602: .Fl iv
1603: option.
1604: When both a
1605: .Ar key
1606: and a
1607: .Ar password
1608: are specified, the
1609: .Ar key
1610: given with the
1611: .Fl K
1.49 jmc 1612: option will be used and the IV generated from the password will be taken.
1.1 jsing 1613: It probably does not make much sense to specify both
1614: .Ar key
1615: and
1616: .Ar password .
1617: .It Fl k Ar password
1618: The
1619: .Ar password
1620: to derive the key from.
1621: Superseded by the
1622: .Fl pass
1623: option.
1624: .It Fl kfile Ar file
1625: Read the password to derive the key from the first line of
1626: .Ar file .
1627: Superseded by the
1628: .Fl pass
1629: option.
1630: .It Fl md Ar digest
1631: Use
1632: .Ar digest
1633: to create a key from a pass phrase.
1634: .Ar digest
1635: may be one of
1.49 jmc 1636: .Cm md5
1.1 jsing 1637: or
1.49 jmc 1638: .Cm sha1 .
1.1 jsing 1639: .It Fl none
1640: Use NULL cipher (no encryption or decryption of input).
1641: .It Fl nopad
1642: Disable standard block padding.
1643: .It Fl nosalt
1.49 jmc 1644: Don't use a salt in the key derivation routines.
1.81 jmc 1645: This option should never be used
1.49 jmc 1646: since it makes it possible to perform efficient dictionary
1647: attacks on the password and to attack stream cipher encrypted data.
1.1 jsing 1648: .It Fl out Ar file
1.51 jmc 1649: The output file to write to,
1.57 jmc 1650: or standard output if not specified.
1.1 jsing 1651: .It Fl P
1.49 jmc 1652: Print out the salt, key, and IV used, then immediately exit;
1.1 jsing 1653: don't do any encryption or decryption.
1654: .It Fl p
1.49 jmc 1655: Print out the salt, key, and IV used.
1.1 jsing 1656: .It Fl pass Ar arg
1657: The password source.
1.96 beck 1658: .It Fl pbkdf2
1.97 jmc 1659: Use the pbkdf2 key derivation function, with
1.96 beck 1660: the default of 10000 iterations.
1.1 jsing 1661: .It Fl S Ar salt
1662: The actual
1663: .Ar salt
1664: to use:
1665: this must be represented as a string comprised only of hex digits.
1666: .It Fl salt
1.49 jmc 1667: Use a salt in the key derivation routines (the default).
1668: When the salt is being used
1669: the first eight bytes of the encrypted data are reserved for the salt:
1670: it is randomly generated when encrypting a file and read from the
1671: encrypted file when it is decrypted.
1.106 ! inoguchi 1672: .It Fl v
! 1673: Print extra details about the processing.
1.1 jsing 1674: .El
1675: .Sh ERRSTR
1676: .Nm openssl errstr
1677: .Op Fl stats
1678: .Ar errno ...
1679: .Pp
1680: The
1681: .Nm errstr
1682: command performs error number to error string conversion,
1683: generating a human-readable string representing the error code
1684: .Ar errno .
1685: The string is obtained through the
1686: .Xr ERR_error_string_n 3
1687: function and has the following format:
1688: .Pp
1689: .Dl error:[error code]:[library name]:[function name]:[reason string]
1690: .Pp
1691: .Bq error code
1692: is an 8-digit hexadecimal number.
1693: The remaining fields
1694: .Bq library name ,
1695: .Bq function name ,
1696: and
1697: .Bq reason string
1698: are all ASCII text.
1699: .Pp
1700: The options are as follows:
1701: .Bl -tag -width Ds
1702: .It Fl stats
1703: Print debugging statistics about various aspects of the hash table.
1704: .El
1705: .Sh GENDSA
1706: .nr nS 1
1707: .Nm "openssl gendsa"
1708: .Oo
1.102 jmc 1709: .Fl aes128 | aes192 | aes256 | camellia128 |
1710: .Fl camellia192 | camellia256 | des | des3 | idea
1.1 jsing 1711: .Oc
1712: .Op Fl out Ar file
1.101 inoguchi 1713: .Op Fl passout Ar arg
1714: .Ar paramfile
1.1 jsing 1715: .nr nS 0
1716: .Pp
1717: The
1718: .Nm gendsa
1719: command generates a DSA private key from a DSA parameter file
1.51 jmc 1720: (typically generated by the
1.1 jsing 1721: .Nm openssl dsaparam
1722: command).
1.51 jmc 1723: DSA key generation is little more than random number generation so it is
1724: much quicker than,
1725: for example,
1726: RSA key generation.
1.1 jsing 1727: .Pp
1728: The options are as follows:
1729: .Bl -tag -width Ds
1730: .It Xo
1731: .Fl aes128 | aes192 | aes256 |
1.101 inoguchi 1732: .Fl camellia128 | camellia192 | camellia256 |
1733: .Fl des | des3 |
1734: .Fl idea
1.1 jsing 1735: .Xc
1.101 inoguchi 1736: Encrypt the private key with the AES, CAMELLIA, DES, triple DES
1737: or the IDEA ciphers, respectively, before outputting it.
1.1 jsing 1738: A pass phrase is prompted for.
1739: If none of these options are specified, no encryption is used.
1740: .It Fl out Ar file
1.51 jmc 1741: The output file to write to,
1.57 jmc 1742: or standard output if not specified.
1.101 inoguchi 1743: .It Fl passout Ar arg
1744: The output file password source.
1.1 jsing 1745: .It Ar paramfile
1.51 jmc 1746: Specify the DSA parameter file to use.
1.1 jsing 1747: The parameters in this file determine the size of the private key.
1748: .El
1749: .Sh GENPKEY
1750: .nr nS 1
1751: .Nm "openssl genpkey"
1752: .Op Fl algorithm Ar alg
1753: .Op Ar cipher
1754: .Op Fl genparam
1755: .Op Fl out Ar file
1.52 jmc 1756: .Op Fl outform Cm der | pem
1.1 jsing 1757: .Op Fl paramfile Ar file
1758: .Op Fl pass Ar arg
1759: .Op Fl pkeyopt Ar opt : Ns Ar value
1760: .Op Fl text
1761: .nr nS 0
1762: .Pp
1763: The
1764: .Nm genpkey
1765: command generates private keys.
1766: The use of this
1767: program is encouraged over the algorithm specific utilities
1.22 bcook 1768: because additional algorithm options can be used.
1.1 jsing 1769: .Pp
1770: The options are as follows:
1771: .Bl -tag -width Ds
1772: .It Fl algorithm Ar alg
1773: The public key algorithm to use,
1774: such as RSA, DSA, or DH.
1.52 jmc 1775: This option must precede any
1.1 jsing 1776: .Fl pkeyopt
1777: options.
1778: The options
1779: .Fl paramfile
1780: and
1781: .Fl algorithm
1782: are mutually exclusive.
1783: .It Ar cipher
1784: Encrypt the private key with the supplied cipher.
1785: Any algorithm name accepted by
1.52 jmc 1786: .Xr EVP_get_cipherbyname 3
1787: is acceptable.
1.1 jsing 1788: .It Fl genparam
1789: Generate a set of parameters instead of a private key.
1.52 jmc 1790: This option must precede any
1.1 jsing 1791: .Fl algorithm ,
1792: .Fl paramfile ,
1793: or
1794: .Fl pkeyopt
1795: options.
1796: .It Fl out Ar file
1.52 jmc 1797: The output file to write to,
1.57 jmc 1798: or standard output if not specified.
1.52 jmc 1799: .It Fl outform Cm der | pem
1800: The output format.
1.1 jsing 1801: .It Fl paramfile Ar file
1.52 jmc 1802: Some public key algorithms generate a private key based on a set of parameters,
1803: which can be supplied using this option.
1.1 jsing 1804: If this option is used the public key
1805: algorithm used is determined by the parameters.
1.52 jmc 1806: This option must precede any
1.1 jsing 1807: .Fl pkeyopt
1808: options.
1809: The options
1810: .Fl paramfile
1811: and
1812: .Fl algorithm
1813: are mutually exclusive.
1814: .It Fl pass Ar arg
1815: The output file password source.
1816: .It Fl pkeyopt Ar opt : Ns Ar value
1817: Set the public key algorithm option
1818: .Ar opt
1819: to
1.52 jmc 1820: .Ar value ,
1821: as follows:
1.1 jsing 1822: .Bl -tag -width Ds -offset indent
1823: .It rsa_keygen_bits : Ns Ar numbits
1824: (RSA)
1825: The number of bits in the generated key.
1.52 jmc 1826: The default is 2048.
1.1 jsing 1827: .It rsa_keygen_pubexp : Ns Ar value
1828: (RSA)
1829: The RSA public exponent value.
1830: This can be a large decimal or hexadecimal value if preceded by 0x.
1.52 jmc 1831: The default is 65537.
1.1 jsing 1832: .It dsa_paramgen_bits : Ns Ar numbits
1833: (DSA)
1834: The number of bits in the generated parameters.
1.52 jmc 1835: The default is 1024.
1.1 jsing 1836: .It dh_paramgen_prime_len : Ns Ar numbits
1837: (DH)
1838: The number of bits in the prime parameter
1839: .Ar p .
1840: .It dh_paramgen_generator : Ns Ar value
1841: (DH)
1842: The value to use for the generator
1843: .Ar g .
1844: .It ec_paramgen_curve : Ns Ar curve
1845: (EC)
1846: The EC curve to use.
1847: .El
1.52 jmc 1848: .It Fl text
1.64 jmc 1849: Print the private/public key in plain text.
1.52 jmc 1850: .El
1.1 jsing 1851: .Sh GENRSA
1852: .nr nS 1
1853: .Nm "openssl genrsa"
1854: .Op Fl 3 | f4
1.53 jmc 1855: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 1856: .Op Fl out Ar file
1857: .Op Fl passout Ar arg
1858: .Op Ar numbits
1859: .nr nS 0
1860: .Pp
1861: The
1862: .Nm genrsa
1.53 jmc 1863: command generates an RSA private key,
1864: which essentially involves the generation of two prime numbers.
1865: When generating the key,
1866: various symbols will be output to indicate the progress of the generation.
1867: A
1868: .Sq \&.
1869: represents each number which has passed an initial sieve test;
1870: .Sq +
1871: means a number has passed a single round of the Miller-Rabin primality test.
1872: A newline means that the number has passed all the prime tests
1873: (the actual number depends on the key size).
1.1 jsing 1874: .Pp
1875: The options are as follows:
1876: .Bl -tag -width Ds
1877: .It Fl 3 | f4
1878: The public exponent to use, either 3 or 65537.
1879: The default is 65537.
1.53 jmc 1880: .It Fl aes128 | aes192 | aes256 | des | des3
1881: Encrypt the private key with the AES, DES,
1.1 jsing 1882: or the triple DES ciphers, respectively, before outputting it.
1883: If none of these options are specified, no encryption is used.
1884: If encryption is used, a pass phrase is prompted for,
1885: if it is not supplied via the
1886: .Fl passout
1887: option.
1888: .It Fl out Ar file
1.53 jmc 1889: The output file to write to,
1.57 jmc 1890: or standard output if not specified.
1.1 jsing 1891: .It Fl passout Ar arg
1892: The output file password source.
1893: .It Ar numbits
1894: The size of the private key to generate in bits.
1895: This must be the last option specified.
1896: The default is 2048.
1897: .El
1898: .Sh NSEQ
1899: .Nm openssl nseq
1900: .Op Fl in Ar file
1901: .Op Fl out Ar file
1902: .Op Fl toseq
1903: .Pp
1904: The
1905: .Nm nseq
1.54 jmc 1906: command takes a file containing a Netscape certificate sequence
1907: (an alternative to the standard PKCS#7 format)
1908: and prints out the certificates contained in it,
1909: or takes a file of certificates
1910: and converts it into a Netscape certificate sequence.
1911: .Pp
1.1 jsing 1912: The options are as follows:
1913: .Bl -tag -width Ds
1914: .It Fl in Ar file
1.54 jmc 1915: The input file to read from,
1916: or standard input if not specified.
1.1 jsing 1917: .It Fl out Ar file
1.54 jmc 1918: The output file to write to,
1919: or standard output if not specified.
1.1 jsing 1920: .It Fl toseq
1921: Normally, a Netscape certificate sequence will be input and the output
1922: is the certificates contained in it.
1923: With the
1924: .Fl toseq
1925: option the situation is reversed:
1926: a Netscape certificate sequence is created from a file of certificates.
1927: .El
1928: .Sh OCSP
1929: .nr nS 1
1930: .Nm "openssl ocsp"
1931: .Op Fl CA Ar file
1932: .Op Fl CAfile Ar file
1933: .Op Fl CApath Ar directory
1934: .Op Fl cert Ar file
1935: .Op Fl dgst Ar alg
1.55 jmc 1936: .Op Fl host Ar hostname : Ns Ar port
1.1 jsing 1937: .Op Fl index Ar indexfile
1938: .Op Fl issuer Ar file
1939: .Op Fl ndays Ar days
1940: .Op Fl nmin Ar minutes
1941: .Op Fl no_cert_checks
1942: .Op Fl no_cert_verify
1943: .Op Fl no_certs
1944: .Op Fl no_chain
1945: .Op Fl no_intern
1946: .Op Fl no_nonce
1947: .Op Fl no_signature_verify
1948: .Op Fl nonce
1949: .Op Fl noverify
1950: .Op Fl nrequest Ar number
1951: .Op Fl out Ar file
1952: .Op Fl path Ar path
1953: .Op Fl port Ar portnum
1954: .Op Fl req_text
1955: .Op Fl reqin Ar file
1956: .Op Fl reqout Ar file
1957: .Op Fl resp_key_id
1958: .Op Fl resp_no_certs
1959: .Op Fl resp_text
1960: .Op Fl respin Ar file
1961: .Op Fl respout Ar file
1962: .Op Fl rkey Ar file
1963: .Op Fl rother Ar file
1964: .Op Fl rsigner Ar file
1965: .Op Fl serial Ar number
1966: .Op Fl sign_other Ar file
1967: .Op Fl signer Ar file
1968: .Op Fl signkey Ar file
1969: .Op Fl status_age Ar age
1970: .Op Fl text
1971: .Op Fl trust_other
1972: .Op Fl url Ar responder_url
1973: .Op Fl VAfile Ar file
1974: .Op Fl validity_period Ar nsec
1975: .Op Fl verify_other Ar file
1976: .nr nS 0
1977: .Pp
1.55 jmc 1978: The Online Certificate Status Protocol (OCSP)
1979: enables applications to determine the (revocation) state
1980: of an identified certificate (RFC 2560).
1.1 jsing 1981: .Pp
1982: The
1983: .Nm ocsp
1984: command performs many common OCSP tasks.
1985: It can be used to print out requests and responses,
1986: create requests and send queries to an OCSP responder,
1987: and behave like a mini OCSP server itself.
1988: .Pp
1989: The options are as follows:
1990: .Bl -tag -width Ds
1991: .It Fl CAfile Ar file , Fl CApath Ar directory
1.55 jmc 1992: A file or path containing trusted CA certificates,
1993: used to verify the signature on the OCSP response.
1.1 jsing 1994: .It Fl cert Ar file
1995: Add the certificate
1996: .Ar file
1997: to the request.
1998: The issuer certificate is taken from the previous
1999: .Fl issuer
2000: option, or an error occurs if no issuer certificate is specified.
2001: .It Fl dgst Ar alg
1.55 jmc 2002: Use the digest algorithm
2003: .Ar alg
2004: for certificate identification in the OCSP request.
1.1 jsing 2005: By default SHA-1 is used.
2006: .It Xo
2007: .Fl host Ar hostname : Ns Ar port ,
2008: .Fl path Ar path
2009: .Xc
1.55 jmc 2010: Send
2011: the OCSP request to
1.1 jsing 2012: .Ar hostname
1.55 jmc 2013: on
1.1 jsing 2014: .Ar port .
2015: .Fl path
2016: specifies the HTTP path name to use, or
1.55 jmc 2017: .Pa /
1.1 jsing 2018: by default.
2019: .It Fl issuer Ar file
1.81 jmc 2020: The current issuer certificate, in PEM format.
2021: Can be used multiple times and must come before any
1.1 jsing 2022: .Fl cert
2023: options.
2024: .It Fl no_cert_checks
2025: Don't perform any additional checks on the OCSP response signer's certificate.
2026: That is, do not make any checks to see if the signer's certificate is
2027: authorised to provide the necessary status information:
2028: as a result this option should only be used for testing purposes.
2029: .It Fl no_cert_verify
2030: Don't verify the OCSP response signer's certificate at all.
2031: Since this option allows the OCSP response to be signed by any certificate,
2032: it should only be used for testing purposes.
2033: .It Fl no_certs
1.55 jmc 2034: Don't include any certificates in the signed request.
1.1 jsing 2035: .It Fl no_chain
2036: Do not use certificates in the response as additional untrusted CA
2037: certificates.
2038: .It Fl no_intern
2039: Ignore certificates contained in the OCSP response
2040: when searching for the signer's certificate.
1.55 jmc 2041: The signer's certificate must be specified with either the
1.1 jsing 2042: .Fl verify_other
2043: or
2044: .Fl VAfile
2045: options.
2046: .It Fl no_signature_verify
2047: Don't check the signature on the OCSP response.
2048: Since this option tolerates invalid signatures on OCSP responses,
2049: it will normally only be used for testing purposes.
2050: .It Fl nonce , no_nonce
1.55 jmc 2051: Add an OCSP nonce extension to a request,
2052: or disable an OCSP nonce addition.
1.1 jsing 2053: Normally, if an OCSP request is input using the
2054: .Fl respin
1.55 jmc 2055: option no nonce is added:
1.1 jsing 2056: using the
2057: .Fl nonce
1.55 jmc 2058: option will force the addition of a nonce.
1.1 jsing 2059: If an OCSP request is being created (using the
2060: .Fl cert
2061: and
2062: .Fl serial
2063: options)
1.55 jmc 2064: a nonce is automatically added; specifying
1.1 jsing 2065: .Fl no_nonce
2066: overrides this.
2067: .It Fl noverify
1.55 jmc 2068: Don't attempt to verify the OCSP response signature or the nonce values.
2069: This is normally only be used for debugging
1.1 jsing 2070: since it disables all verification of the responder's certificate.
2071: .It Fl out Ar file
1.55 jmc 2072: Specify the output file to write to,
1.57 jmc 2073: or standard output if not specified.
1.1 jsing 2074: .It Fl req_text , resp_text , text
2075: Print out the text form of the OCSP request, response, or both, respectively.
2076: .It Fl reqin Ar file , Fl respin Ar file
2077: Read an OCSP request or response file from
2078: .Ar file .
2079: These options are ignored
2080: if an OCSP request or response creation is implied by other options
2081: (for example with the
2082: .Fl serial , cert ,
2083: and
2084: .Fl host
2085: options).
2086: .It Fl reqout Ar file , Fl respout Ar file
2087: Write out the DER-encoded certificate request or response to
2088: .Ar file .
2089: .It Fl serial Ar num
2090: Same as the
2091: .Fl cert
2092: option except the certificate with serial number
2093: .Ar num
2094: is added to the request.
2095: The serial number is interpreted as a decimal integer unless preceded by
2096: .Sq 0x .
1.55 jmc 2097: Negative integers can also be specified
2098: by preceding the value with a minus sign.
1.1 jsing 2099: .It Fl sign_other Ar file
2100: Additional certificates to include in the signed request.
2101: .It Fl signer Ar file , Fl signkey Ar file
2102: Sign the OCSP request using the certificate specified in the
2103: .Fl signer
2104: option and the private key specified by the
2105: .Fl signkey
2106: option.
2107: If the
2108: .Fl signkey
2109: option is not present, then the private key is read from the same file
2110: as the certificate.
2111: If neither option is specified, the OCSP request is not signed.
2112: .It Fl trust_other
2113: The certificates specified by the
2114: .Fl verify_other
2115: option should be explicitly trusted and no additional checks will be
2116: performed on them.
2117: This is useful when the complete responder certificate chain is not available
2118: or trusting a root CA is not appropriate.
2119: .It Fl url Ar responder_url
2120: Specify the responder URL.
2121: Both HTTP and HTTPS
2122: .Pq SSL/TLS
2123: URLs can be specified.
2124: .It Fl VAfile Ar file
1.55 jmc 2125: A file containing explicitly trusted responder certificates.
1.1 jsing 2126: Equivalent to the
2127: .Fl verify_other
2128: and
2129: .Fl trust_other
2130: options.
2131: .It Fl validity_period Ar nsec , Fl status_age Ar age
1.55 jmc 2132: The range of times, in seconds, which will be tolerated in an OCSP response.
2133: Each certificate status response includes a notBefore time
2134: and an optional notAfter time.
1.1 jsing 2135: The current time should fall between these two values,
2136: but the interval between the two times may be only a few seconds.
2137: In practice the OCSP responder and clients' clocks may not be precisely
2138: synchronised and so such a check may fail.
2139: To avoid this the
2140: .Fl validity_period
2141: option can be used to specify an acceptable error range in seconds,
1.55 jmc 2142: the default value being 5 minutes.
1.1 jsing 2143: .Pp
1.55 jmc 2144: If the notAfter time is omitted from a response,
2145: it means that new status information is immediately available.
2146: In this case the age of the notBefore field is checked
2147: to see it is not older than
1.1 jsing 2148: .Ar age
2149: seconds old.
2150: By default, this additional check is not performed.
2151: .It Fl verify_other Ar file
1.55 jmc 2152: A file containing additional certificates to search
2153: when attempting to locate the OCSP response signing certificate.
2154: Some responders omit the actual signer's certificate from the response,
2155: so this can be used to supply the necessary certificate.
1.1 jsing 2156: .El
1.55 jmc 2157: .Pp
2158: The options for the OCSP server are as follows:
1.1 jsing 2159: .Bl -tag -width "XXXX"
2160: .It Fl CA Ar file
2161: CA certificate corresponding to the revocation information in
2162: .Ar indexfile .
2163: .It Fl index Ar indexfile
2164: .Ar indexfile
1.55 jmc 2165: is a text index file in ca format
2166: containing certificate revocation information.
1.1 jsing 2167: .Pp
1.55 jmc 2168: If this option is specified,
1.1 jsing 2169: .Nm ocsp
1.55 jmc 2170: is in responder mode, otherwise it is in client mode.
2171: The requests the responder processes can be either specified on
1.1 jsing 2172: the command line (using the
2173: .Fl issuer
2174: and
2175: .Fl serial
2176: options), supplied in a file (using the
2177: .Fl respin
1.55 jmc 2178: option), or via external OCSP clients (if
1.1 jsing 2179: .Ar port
2180: or
2181: .Ar url
2182: is specified).
2183: .Pp
1.55 jmc 2184: If this option is present, then the
1.1 jsing 2185: .Fl CA
2186: and
2187: .Fl rsigner
2188: options must also be present.
2189: .It Fl nmin Ar minutes , Fl ndays Ar days
2190: Number of
2191: .Ar minutes
2192: or
2193: .Ar days
1.55 jmc 2194: when fresh revocation information is available:
2195: used in the nextUpdate field.
2196: If neither option is present,
2197: the nextUpdate field is omitted,
2198: meaning fresh revocation information is immediately available.
1.1 jsing 2199: .It Fl nrequest Ar number
1.55 jmc 2200: Exit after receiving
1.1 jsing 2201: .Ar number
1.55 jmc 2202: requests (the default is unlimited).
1.1 jsing 2203: .It Fl port Ar portnum
2204: Port to listen for OCSP requests on.
1.55 jmc 2205: May also be specified using the
1.1 jsing 2206: .Fl url
2207: option.
2208: .It Fl resp_key_id
2209: Identify the signer certificate using the key ID;
1.55 jmc 2210: the default is to use the subject name.
1.1 jsing 2211: .It Fl resp_no_certs
2212: Don't include any certificates in the OCSP response.
2213: .It Fl rkey Ar file
2214: The private key to sign OCSP responses with;
2215: if not present, the file specified in the
2216: .Fl rsigner
2217: option is used.
2218: .It Fl rother Ar file
2219: Additional certificates to include in the OCSP response.
2220: .It Fl rsigner Ar file
2221: The certificate to sign OCSP responses with.
2222: .El
2223: .Pp
2224: Initially the OCSP responder certificate is located and the signature on
2225: the OCSP request checked using the responder certificate's public key.
2226: Then a normal certificate verify is performed on the OCSP responder certificate
2227: building up a certificate chain in the process.
2228: The locations of the trusted certificates used to build the chain can be
2229: specified by the
2230: .Fl CAfile
2231: and
2232: .Fl CApath
2233: options or they will be looked for in the standard
1.55 jmc 2234: .Nm openssl
2235: certificates directory.
1.1 jsing 2236: .Pp
1.55 jmc 2237: If the initial verify fails, the OCSP verify process halts with an error.
1.1 jsing 2238: Otherwise the issuing CA certificate in the request is compared to the OCSP
2239: responder certificate: if there is a match then the OCSP verify succeeds.
2240: .Pp
2241: Otherwise the OCSP responder certificate's CA is checked against the issuing
2242: CA certificate in the request.
2243: If there is a match and the OCSPSigning extended key usage is present
2244: in the OCSP responder certificate, then the OCSP verify succeeds.
2245: .Pp
2246: Otherwise the root CA of the OCSP responder's CA is checked to see if it
2247: is trusted for OCSP signing.
2248: If it is, the OCSP verify succeeds.
2249: .Pp
2250: If none of these checks is successful, the OCSP verify fails.
2251: What this effectively means is that if the OCSP responder certificate is
2252: authorised directly by the CA it is issuing revocation information about
1.55 jmc 2253: (and it is correctly configured),
1.1 jsing 2254: then verification will succeed.
2255: .Pp
1.55 jmc 2256: If the OCSP responder is a global responder,
2257: which can give details about multiple CAs
2258: and has its own separate certificate chain,
2259: then its root CA can be trusted for OCSP signing.
1.1 jsing 2260: Alternatively, the responder certificate itself can be explicitly trusted
2261: with the
2262: .Fl VAfile
2263: option.
2264: .Sh PASSWD
2265: .nr nS 1
2266: .Nm "openssl passwd"
2267: .Op Fl 1 | apr1 | crypt
2268: .Op Fl in Ar file
2269: .Op Fl noverify
2270: .Op Fl quiet
2271: .Op Fl reverse
2272: .Op Fl salt Ar string
2273: .Op Fl stdin
2274: .Op Fl table
2275: .Op Ar password
2276: .nr nS 0
2277: .Pp
2278: The
2279: .Nm passwd
1.56 jmc 2280: command computes the hash of a password.
1.1 jsing 2281: .Pp
2282: The options are as follows:
2283: .Bl -tag -width Ds
2284: .It Fl 1
2285: Use the MD5 based
2286: .Bx
2287: password algorithm
1.56 jmc 2288: .Qq 1 .
1.1 jsing 2289: .It Fl apr1
2290: Use the
1.56 jmc 2291: .Qq apr1
1.1 jsing 2292: algorithm
1.56 jmc 2293: .Po
2294: Apache variant of the
1.1 jsing 2295: .Bx
1.56 jmc 2296: algorithm
2297: .Pc .
1.1 jsing 2298: .It Fl crypt
2299: Use the
1.56 jmc 2300: .Qq crypt
2301: algorithm (the default).
1.1 jsing 2302: .It Fl in Ar file
2303: Read passwords from
2304: .Ar file .
2305: .It Fl noverify
2306: Don't verify when reading a password from the terminal.
2307: .It Fl quiet
2308: Don't output warnings when passwords given on the command line are truncated.
2309: .It Fl reverse
2310: Switch table columns.
2311: This only makes sense in conjunction with the
2312: .Fl table
2313: option.
2314: .It Fl salt Ar string
1.56 jmc 2315: Use the salt specified by
2316: .Ar string .
1.1 jsing 2317: When reading a password from the terminal, this implies
2318: .Fl noverify .
2319: .It Fl stdin
1.56 jmc 2320: Read passwords from standard input.
1.1 jsing 2321: .It Fl table
2322: In the output list, prepend the cleartext password and a TAB character
2323: to each password hash.
2324: .El
2325: .Sh PKCS7
2326: .nr nS 1
2327: .Nm "openssl pkcs7"
2328: .Op Fl in Ar file
1.57 jmc 2329: .Op Fl inform Cm der | pem
1.1 jsing 2330: .Op Fl noout
2331: .Op Fl out Ar file
1.57 jmc 2332: .Op Fl outform Cm der | pem
1.106 ! inoguchi 2333: .Op Fl print
1.1 jsing 2334: .Op Fl print_certs
2335: .Op Fl text
2336: .nr nS 0
2337: .Pp
2338: The
2339: .Nm pkcs7
2340: command processes PKCS#7 files in DER or PEM format.
1.57 jmc 2341: The PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC 2315.
2342: .Pp
1.1 jsing 2343: The options are as follows:
2344: .Bl -tag -width Ds
2345: .It Fl in Ar file
1.57 jmc 2346: The input file to read from,
2347: or standard input if not specified.
2348: .It Fl inform Cm der | pem
2349: The input format.
1.1 jsing 2350: .It Fl noout
2351: Don't output the encoded version of the PKCS#7 structure
2352: (or certificates if
2353: .Fl print_certs
2354: is set).
2355: .It Fl out Ar file
1.57 jmc 2356: The output to write to,
2357: or standard output if not specified.
2358: .It Fl outform Cm der | pem
2359: The output format.
1.106 ! inoguchi 2360: .It Fl print
! 2361: Print the ASN.1 representation of PKCS#7 structure.
1.1 jsing 2362: .It Fl print_certs
1.57 jmc 2363: Print any certificates or CRLs contained in the file,
2364: preceded by their subject and issuer names in a one-line format.
1.1 jsing 2365: .It Fl text
1.57 jmc 2366: Print certificate details in full rather than just subject and issuer names.
1.1 jsing 2367: .El
2368: .Sh PKCS8
2369: .nr nS 1
2370: .Nm "openssl pkcs8"
2371: .Op Fl in Ar file
1.58 jmc 2372: .Op Fl inform Cm der | pem
1.1 jsing 2373: .Op Fl nocrypt
2374: .Op Fl noiter
2375: .Op Fl out Ar file
1.58 jmc 2376: .Op Fl outform Cm der | pem
1.1 jsing 2377: .Op Fl passin Ar arg
2378: .Op Fl passout Ar arg
2379: .Op Fl topk8
2380: .Op Fl v1 Ar alg
2381: .Op Fl v2 Ar alg
2382: .nr nS 0
2383: .Pp
2384: The
2385: .Nm pkcs8
1.58 jmc 2386: command processes private keys
2387: (both encrypted and unencrypted)
2388: in PKCS#8 format
2389: with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
2390: The default encryption is only 56 bits;
2391: keys encrypted using PKCS#5 v2.0 algorithms and high iteration counts
2392: are more secure.
2393: .Pp
1.1 jsing 2394: The options are as follows:
2395: .Bl -tag -width Ds
2396: .It Fl in Ar file
1.58 jmc 2397: The input file to read from,
2398: or standard input if not specified.
1.1 jsing 2399: If the key is encrypted, a pass phrase will be prompted for.
1.58 jmc 2400: .It Fl inform Cm der | pem
2401: The input format.
1.1 jsing 2402: .It Fl nocrypt
1.58 jmc 2403: Generate an unencrypted PrivateKeyInfo structure.
2404: This option does not encrypt private keys at all
2405: and should only be used when absolutely necessary.
1.1 jsing 2406: .It Fl noiter
2407: Use an iteration count of 1.
2408: See the
2409: .Sx PKCS12
2410: section below for a detailed explanation of this option.
2411: .It Fl out Ar file
1.58 jmc 2412: The output file to write to,
2413: or standard output if none is specified.
1.1 jsing 2414: If any encryption options are set, a pass phrase will be prompted for.
1.58 jmc 2415: .It Fl outform Cm der | pem
2416: The output format.
1.1 jsing 2417: .It Fl passin Ar arg
2418: The key password source.
2419: .It Fl passout Ar arg
2420: The output file password source.
2421: .It Fl topk8
1.58 jmc 2422: Read a traditional format private key and write a PKCS#8 format key.
1.1 jsing 2423: .It Fl v1 Ar alg
1.58 jmc 2424: Specify a PKCS#5 v1.5 or PKCS#12 algorithm to use.
2425: .Pp
2426: .Bl -tag -width "XXXX" -compact
2427: .It PBE-MD5-DES
2428: 56-bit DES.
2429: .It PBE-SHA1-RC2-64 | PBE-MD5-RC2-64 | PBE-SHA1-DES
2430: 64-bit RC2 or 56-bit DES.
2431: .It PBE-SHA1-RC4-128 | PBE-SHA1-RC4-40 | PBE-SHA1-3DES
2432: .It PBE-SHA1-2DES | PBE-SHA1-RC2-128 | PBE-SHA1-RC2-40
2433: PKCS#12 password-based encryption algorithm,
2434: which allow strong encryption algorithms like triple DES or 128-bit RC2.
2435: .El
1.1 jsing 2436: .It Fl v2 Ar alg
1.58 jmc 2437: Use PKCS#5 v2.0 algorithms.
2438: Supports algorithms such as 168-bit triple DES or 128-bit RC2,
2439: however not many implementations support PKCS#5 v2.0 yet
2440: (if using private keys with
2441: .Nm openssl
2442: this doesn't matter).
1.1 jsing 2443: .Pp
2444: .Ar alg
1.58 jmc 2445: is the encryption algorithm to use;
2446: valid values include des, des3, and rc2.
2447: It is recommended that des3 is used.
1.1 jsing 2448: .El
2449: .Sh PKCS12
2450: .nr nS 1
2451: .Nm "openssl pkcs12"
1.59 jmc 2452: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 2453: .Op Fl cacerts
2454: .Op Fl CAfile Ar file
2455: .Op Fl caname Ar name
2456: .Op Fl CApath Ar directory
2457: .Op Fl certfile Ar file
2458: .Op Fl certpbe Ar alg
2459: .Op Fl chain
2460: .Op Fl clcerts
2461: .Op Fl CSP Ar name
2462: .Op Fl descert
2463: .Op Fl export
2464: .Op Fl in Ar file
2465: .Op Fl info
2466: .Op Fl inkey Ar file
2467: .Op Fl keyex
2468: .Op Fl keypbe Ar alg
2469: .Op Fl keysig
2470: .Op Fl macalg Ar alg
2471: .Op Fl maciter
2472: .Op Fl name Ar name
2473: .Op Fl nocerts
2474: .Op Fl nodes
2475: .Op Fl noiter
2476: .Op Fl nokeys
2477: .Op Fl nomac
2478: .Op Fl nomaciter
2479: .Op Fl nomacver
2480: .Op Fl noout
2481: .Op Fl out Ar file
2482: .Op Fl passin Ar arg
2483: .Op Fl passout Ar arg
2484: .Op Fl twopass
2485: .nr nS 0
2486: .Pp
2487: The
2488: .Nm pkcs12
2489: command allows PKCS#12 files
2490: .Pq sometimes referred to as PFX files
2491: to be created and parsed.
2492: By default, a PKCS#12 file is parsed;
2493: a PKCS#12 file can be created by using the
2494: .Fl export
1.59 jmc 2495: option.
2496: .Pp
2497: The options for parsing a PKCS12 file are as follows:
1.1 jsing 2498: .Bl -tag -width "XXXX"
1.59 jmc 2499: .It Fl aes128 | aes192 | aes256 | des | des3
2500: Encrypt private keys
2501: using AES, DES, or triple DES, respectively.
1.1 jsing 2502: The default is triple DES.
2503: .It Fl cacerts
2504: Only output CA certificates
2505: .Pq not client certificates .
2506: .It Fl clcerts
2507: Only output client certificates
2508: .Pq not CA certificates .
2509: .It Fl in Ar file
1.59 jmc 2510: The input file to read from,
2511: or standard input if not specified.
1.1 jsing 2512: .It Fl info
2513: Output additional information about the PKCS#12 file structure,
2514: algorithms used, and iteration counts.
2515: .It Fl nocerts
1.59 jmc 2516: Do not output certificates.
1.1 jsing 2517: .It Fl nodes
1.59 jmc 2518: Do not encrypt private keys.
1.1 jsing 2519: .It Fl nokeys
1.59 jmc 2520: Do not output private keys.
1.1 jsing 2521: .It Fl nomacver
1.59 jmc 2522: Do not attempt to verify the integrity MAC before reading the file.
1.1 jsing 2523: .It Fl noout
1.59 jmc 2524: Do not output the keys and certificates to the output file
1.1 jsing 2525: version of the PKCS#12 file.
2526: .It Fl out Ar file
1.59 jmc 2527: The output file to write to,
2528: or standard output if not specified.
1.1 jsing 2529: .It Fl passin Ar arg
2530: The key password source.
2531: .It Fl passout Ar arg
2532: The output file password source.
2533: .It Fl twopass
2534: Prompt for separate integrity and encryption passwords: most software
2535: always assumes these are the same so this option will render such
2536: PKCS#12 files unreadable.
2537: .El
1.59 jmc 2538: .Pp
2539: The options for PKCS12 file creation are as follows:
1.1 jsing 2540: .Bl -tag -width "XXXX"
2541: .It Fl CAfile Ar file
2542: CA storage as a file.
2543: .It Fl CApath Ar directory
2544: CA storage as a directory.
1.59 jmc 2545: The directory must be a standard certificate directory:
1.1 jsing 2546: that is, a hash of each subject name (using
1.59 jmc 2547: .Nm x509 Fl hash )
1.1 jsing 2548: should be linked to each certificate.
2549: .It Fl caname Ar name
1.59 jmc 2550: Specify the
1.1 jsing 2551: .Qq friendly name
2552: for other certificates.
1.59 jmc 2553: May be used multiple times to specify names for all certificates
1.1 jsing 2554: in the order they appear.
2555: .It Fl certfile Ar file
2556: A file to read additional certificates from.
2557: .It Fl certpbe Ar alg , Fl keypbe Ar alg
1.59 jmc 2558: Specify the algorithm used to encrypt the private key and
1.1 jsing 2559: certificates to be selected.
1.59 jmc 2560: Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name can be used.
1.1 jsing 2561: If a cipher name
2562: (as output by the
2563: .Cm list-cipher-algorithms
2564: command) is specified then it
2565: is used with PKCS#5 v2.0.
2566: For interoperability reasons it is advisable to only use PKCS#12 algorithms.
2567: .It Fl chain
1.59 jmc 2568: Include the entire certificate chain of the user certificate.
1.1 jsing 2569: The standard CA store is used for this search.
2570: If the search fails, it is considered a fatal error.
2571: .It Fl CSP Ar name
2572: Write
2573: .Ar name
2574: as a Microsoft CSP name.
2575: .It Fl descert
2576: Encrypt the certificate using triple DES; this may render the PKCS#12
2577: file unreadable by some
2578: .Qq export grade
2579: software.
2580: By default, the private key is encrypted using triple DES and the
2581: certificate using 40-bit RC2.
2582: .It Fl export
1.59 jmc 2583: Create a PKCS#12 file (rather than parsing one).
1.1 jsing 2584: .It Fl in Ar file
1.59 jmc 2585: The input file to read from,
1.81 jmc 2586: or standard input if not specified.
1.1 jsing 2587: The order doesn't matter but one private key and its corresponding
2588: certificate should be present.
2589: If additional certificates are present, they will also be included
2590: in the PKCS#12 file.
2591: .It Fl inkey Ar file
1.59 jmc 2592: File to read a private key from.
1.1 jsing 2593: If not present, a private key must be present in the input file.
2594: .It Fl keyex | keysig
1.59 jmc 2595: Specify whether the private key is to be used for key exchange or just signing.
1.1 jsing 2596: Normally,
2597: .Qq export grade
2598: software will only allow 512-bit RSA keys to be
2599: used for encryption purposes, but arbitrary length keys for signing.
2600: The
2601: .Fl keysig
2602: option marks the key for signing only.
2603: Signing only keys can be used for S/MIME signing, authenticode
1.66 jmc 2604: (ActiveX control signing)
1.59 jmc 2605: and SSL client authentication.
1.1 jsing 2606: .It Fl macalg Ar alg
2607: Specify the MAC digest algorithm.
1.59 jmc 2608: The default is SHA1.
1.1 jsing 2609: .It Fl maciter
1.66 jmc 2610: Included for compatibility only:
1.59 jmc 2611: it used to be needed to use MAC iterations counts
2612: but they are now used by default.
1.1 jsing 2613: .It Fl name Ar name
1.59 jmc 2614: Specify the
1.1 jsing 2615: .Qq friendly name
2616: for the certificate and private key.
2617: This name is typically displayed in list boxes by software importing the file.
2618: .It Fl nomac
2619: Don't attempt to provide the MAC integrity.
2620: .It Fl nomaciter , noiter
1.59 jmc 2621: Affect the iteration counts on the MAC and key algorithms.
1.1 jsing 2622: .Pp
2623: To discourage attacks by using large dictionaries of common passwords,
2624: the algorithm that derives keys from passwords can have an iteration count
2625: applied to it: this causes a certain part of the algorithm to be repeated
2626: and slows it down.
2627: The MAC is used to check the file integrity but since it will normally
2628: have the same password as the keys and certificates it could also be attacked.
2629: By default, both MAC and encryption iteration counts are set to 2048;
2630: using these options the MAC and encryption iteration counts can be set to 1.
2631: Since this reduces the file security you should not use these options
2632: unless you really have to.
2633: Most software supports both MAC and key iteration counts.
2634: .It Fl out Ar file
1.59 jmc 2635: The output file to write to,
2636: or standard output if not specified.
1.1 jsing 2637: .It Fl passin Ar arg
2638: The key password source.
2639: .It Fl passout Ar arg
2640: The output file password source.
2641: .El
2642: .Sh PKEY
2643: .nr nS 1
2644: .Nm "openssl pkey"
2645: .Op Ar cipher
2646: .Op Fl in Ar file
1.60 jmc 2647: .Op Fl inform Cm der | pem
1.1 jsing 2648: .Op Fl noout
2649: .Op Fl out Ar file
1.60 jmc 2650: .Op Fl outform Cm der | pem
1.1 jsing 2651: .Op Fl passin Ar arg
2652: .Op Fl passout Ar arg
2653: .Op Fl pubin
2654: .Op Fl pubout
2655: .Op Fl text
2656: .Op Fl text_pub
2657: .nr nS 0
2658: .Pp
2659: The
2660: .Nm pkey
2661: command processes public or private keys.
2662: They can be converted between various forms
2663: and their components printed out.
2664: .Pp
2665: The options are as follows:
2666: .Bl -tag -width Ds
2667: .It Ar cipher
1.60 jmc 2668: Encrypt the private key with the specified cipher.
1.1 jsing 2669: Any algorithm name accepted by
1.60 jmc 2670: .Xr EVP_get_cipherbyname 3
1.1 jsing 2671: is acceptable, such as
2672: .Cm des3 .
2673: .It Fl in Ar file
1.60 jmc 2674: The input file to read from,
2675: or standard input if not specified.
1.1 jsing 2676: If the key is encrypted a pass phrase will be prompted for.
1.60 jmc 2677: .It Fl inform Cm der | pem
2678: The input format.
1.1 jsing 2679: .It Fl noout
2680: Do not output the encoded version of the key.
2681: .It Fl out Ar file
1.60 jmc 2682: The output file to write to,
2683: or standard output if not specified.
1.1 jsing 2684: If any encryption options are set then a pass phrase
2685: will be prompted for.
1.60 jmc 2686: .It Fl outform Cm der | pem
2687: The output format.
1.1 jsing 2688: .It Fl passin Ar arg
2689: The key password source.
2690: .It Fl passout Ar arg
2691: The output file password source.
2692: .It Fl pubin
1.60 jmc 2693: Read in a public key, not a private key.
1.1 jsing 2694: .It Fl pubout
1.60 jmc 2695: Output a public key, not a private key.
2696: Automatically set if the input is a public key.
1.1 jsing 2697: .It Fl text
1.64 jmc 2698: Print the public/private key in plain text.
1.1 jsing 2699: .It Fl text_pub
2700: Print out only public key components
2701: even if a private key is being processed.
2702: .El
2703: .Sh PKEYPARAM
2704: .Cm openssl pkeyparam
2705: .Op Fl in Ar file
2706: .Op Fl noout
2707: .Op Fl out Ar file
2708: .Op Fl text
2709: .Pp
2710: The
1.61 jmc 2711: .Nm pkeyparam
1.1 jsing 2712: command processes public or private keys.
1.61 jmc 2713: The key type is determined by the PEM headers.
1.1 jsing 2714: .Pp
2715: The options are as follows:
2716: .Bl -tag -width Ds
2717: .It Fl in Ar file
1.61 jmc 2718: The input file to read from,
2719: or standard input if not specified.
1.1 jsing 2720: .It Fl noout
2721: Do not output the encoded version of the parameters.
2722: .It Fl out Ar file
1.61 jmc 2723: The output file to write to,
2724: or standard output if not specified.
1.1 jsing 2725: .It Fl text
1.64 jmc 2726: Print the parameters in plain text.
1.1 jsing 2727: .El
2728: .Sh PKEYUTL
2729: .nr nS 1
2730: .Nm "openssl pkeyutl"
2731: .Op Fl asn1parse
2732: .Op Fl certin
2733: .Op Fl decrypt
2734: .Op Fl derive
2735: .Op Fl encrypt
2736: .Op Fl hexdump
2737: .Op Fl in Ar file
2738: .Op Fl inkey Ar file
1.62 jmc 2739: .Op Fl keyform Cm der | pem
1.1 jsing 2740: .Op Fl out Ar file
2741: .Op Fl passin Ar arg
1.62 jmc 2742: .Op Fl peerform Cm der | pem
1.1 jsing 2743: .Op Fl peerkey Ar file
2744: .Op Fl pkeyopt Ar opt : Ns Ar value
2745: .Op Fl pubin
2746: .Op Fl rev
2747: .Op Fl sigfile Ar file
2748: .Op Fl sign
2749: .Op Fl verify
2750: .Op Fl verifyrecover
2751: .nr nS 0
2752: .Pp
2753: The
2754: .Nm pkeyutl
2755: command can be used to perform public key operations using
2756: any supported algorithm.
2757: .Pp
2758: The options are as follows:
2759: .Bl -tag -width Ds
2760: .It Fl asn1parse
1.84 jmc 2761: ASN.1 parse the output data.
1.1 jsing 2762: This is useful when combined with the
2763: .Fl verifyrecover
1.84 jmc 2764: option when an ASN.1 structure is signed.
1.1 jsing 2765: .It Fl certin
2766: The input is a certificate containing a public key.
2767: .It Fl decrypt
2768: Decrypt the input data using a private key.
2769: .It Fl derive
2770: Derive a shared secret using the peer key.
2771: .It Fl encrypt
2772: Encrypt the input data using a public key.
2773: .It Fl hexdump
2774: Hex dump the output data.
2775: .It Fl in Ar file
1.62 jmc 2776: The input file to read from,
2777: or standard input if not specified.
1.1 jsing 2778: .It Fl inkey Ar file
2779: The input key file.
2780: By default it should be a private key.
1.62 jmc 2781: .It Fl keyform Cm der | pem
2782: The key format.
1.1 jsing 2783: .It Fl out Ar file
1.62 jmc 2784: The output file to write to,
2785: or standard output if not specified.
1.1 jsing 2786: .It Fl passin Ar arg
2787: The key password source.
1.62 jmc 2788: .It Fl peerform Cm der | pem
2789: The peer key format.
1.1 jsing 2790: .It Fl peerkey Ar file
2791: The peer key file, used by key derivation (agreement) operations.
2792: .It Fl pkeyopt Ar opt : Ns Ar value
1.62 jmc 2793: Set the public key algorithm option
2794: .Ar opt
2795: to
2796: .Ar value .
2797: Unless otherwise mentioned, all algorithms support the format
2798: .Ar digest : Ns Ar alg ,
2799: which specifies the digest to use
1.1 jsing 2800: for sign, verify, and verifyrecover operations.
2801: The value
2802: .Ar alg
2803: should represent a digest name as used in the
1.62 jmc 2804: .Xr EVP_get_digestbyname 3
2805: function.
2806: .Pp
1.1 jsing 2807: The RSA algorithm supports the
2808: encrypt, decrypt, sign, verify, and verifyrecover operations in general.
2809: Some padding modes only support some of these
2810: operations however.
2811: .Bl -tag -width Ds
2812: .It rsa_padding_mode : Ns Ar mode
2813: This sets the RSA padding mode.
2814: Acceptable values for
2815: .Ar mode
2816: are
2817: .Cm pkcs1
2818: for PKCS#1 padding;
2819: .Cm none
2820: for no padding;
2821: .Cm oaep
2822: for OAEP mode;
2823: .Cm x931
2824: for X9.31 mode;
2825: and
2826: .Cm pss
2827: for PSS.
2828: .Pp
2829: In PKCS#1 padding if the message digest is not set then the supplied data is
2830: signed or verified directly instead of using a DigestInfo structure.
2831: If a digest is set then a DigestInfo
2832: structure is used and its length
2833: must correspond to the digest type.
2834: For oeap mode only encryption and decryption is supported.
2835: For x931 if the digest type is set it is used to format the block data;
2836: otherwise the first byte is used to specify the X9.31 digest ID.
2837: Sign, verify, and verifyrecover can be performed in this mode.
2838: For pss mode only sign and verify are supported and the digest type must be
2839: specified.
2840: .It rsa_pss_saltlen : Ns Ar len
2841: For pss
2842: mode only this option specifies the salt length.
2843: Two special values are supported:
2844: -1 sets the salt length to the digest length.
2845: When signing -2 sets the salt length to the maximum permissible value.
2846: When verifying -2 causes the salt length to be automatically determined
2847: based on the PSS block structure.
2848: .El
1.62 jmc 2849: .Pp
1.1 jsing 2850: The DSA algorithm supports the sign and verify operations.
2851: Currently there are no additional options other than
2852: .Ar digest .
2853: Only the SHA1 digest can be used and this digest is assumed by default.
1.62 jmc 2854: .Pp
1.1 jsing 2855: The DH algorithm supports the derive operation
2856: and no additional options.
1.62 jmc 2857: .Pp
1.1 jsing 2858: The EC algorithm supports the sign, verify, and derive operations.
2859: The sign and verify operations use ECDSA and derive uses ECDH.
2860: Currently there are no additional options other than
2861: .Ar digest .
2862: Only the SHA1 digest can be used and this digest is assumed by default.
1.62 jmc 2863: .It Fl pubin
2864: The input file is a public key.
2865: .It Fl rev
2866: Reverse the order of the input buffer.
2867: .It Fl sigfile Ar file
2868: Signature file (verify operation only).
2869: .It Fl sign
2870: Sign the input data and output the signed result.
2871: This requires a private key.
2872: .It Fl verify
2873: Verify the input data against the signature file and indicate if the
2874: verification succeeded or failed.
2875: .It Fl verifyrecover
2876: Verify the input data and output the recovered data.
2877: .El
1.1 jsing 2878: .Sh PRIME
2879: .Cm openssl prime
2880: .Op Fl bits Ar n
2881: .Op Fl checks Ar n
2882: .Op Fl generate
2883: .Op Fl hex
2884: .Op Fl safe
2885: .Ar p
2886: .Pp
2887: The
2888: .Nm prime
2889: command is used to generate prime numbers,
2890: or to check numbers for primality.
2891: Results are probabilistic:
2892: they have an exceedingly high likelihood of being correct,
2893: but are not guaranteed.
2894: .Pp
2895: The options are as follows:
2896: .Bl -tag -width Ds
2897: .It Fl bits Ar n
2898: Specify the number of bits in the generated prime number.
2899: Must be used in conjunction with
2900: .Fl generate .
2901: .It Fl checks Ar n
2902: Perform a Miller-Rabin probabilistic primality test with
2903: .Ar n
2904: iterations.
2905: The default is 20.
2906: .It Fl generate
2907: Generate a pseudo-random prime number.
2908: Must be used in conjunction with
2909: .Fl bits .
2910: .It Fl hex
2911: Output in hex format.
2912: .It Fl safe
2913: Generate only
2914: .Qq safe
2915: prime numbers
2916: (i.e. a prime p so that (p-1)/2 is also prime).
2917: .It Ar p
2918: Test if number
2919: .Ar p
2920: is prime.
2921: .El
2922: .Sh RAND
2923: .nr nS 1
2924: .Nm "openssl rand"
2925: .Op Fl base64
2926: .Op Fl hex
2927: .Op Fl out Ar file
2928: .Ar num
2929: .nr nS 0
2930: .Pp
2931: The
2932: .Nm rand
2933: command outputs
2934: .Ar num
2935: pseudo-random bytes.
2936: .Pp
2937: The options are as follows:
2938: .Bl -tag -width Ds
2939: .It Fl base64
1.81 jmc 2940: Perform base64 encoding on the output.
1.1 jsing 2941: .It Fl hex
2942: Specify hexadecimal output.
2943: .It Fl out Ar file
1.63 jmc 2944: The output file to write to,
2945: or standard output if not specified.
1.1 jsing 2946: .El
2947: .Sh REQ
2948: .nr nS 1
2949: .Nm "openssl req"
2950: .Op Fl asn1-kludge
2951: .Op Fl batch
2952: .Op Fl config Ar file
2953: .Op Fl days Ar n
2954: .Op Fl extensions Ar section
2955: .Op Fl in Ar file
1.63 jmc 2956: .Op Fl inform Cm der | pem
1.1 jsing 2957: .Op Fl key Ar keyfile
1.63 jmc 2958: .Op Fl keyform Cm der | pem
1.1 jsing 2959: .Op Fl keyout Ar file
1.28 doug 2960: .Op Fl md4 | md5 | sha1
1.1 jsing 2961: .Op Fl modulus
2962: .Op Fl nameopt Ar option
2963: .Op Fl new
2964: .Op Fl newhdr
2965: .Op Fl newkey Ar arg
2966: .Op Fl no-asn1-kludge
2967: .Op Fl nodes
2968: .Op Fl noout
2969: .Op Fl out Ar file
1.63 jmc 2970: .Op Fl outform Cm der | pem
1.1 jsing 2971: .Op Fl passin Ar arg
2972: .Op Fl passout Ar arg
2973: .Op Fl pubkey
2974: .Op Fl reqexts Ar section
2975: .Op Fl reqopt Ar option
2976: .Op Fl set_serial Ar n
2977: .Op Fl subj Ar arg
2978: .Op Fl subject
2979: .Op Fl text
2980: .Op Fl utf8
2981: .Op Fl verbose
2982: .Op Fl verify
2983: .Op Fl x509
2984: .nr nS 0
2985: .Pp
2986: The
2987: .Nm req
2988: command primarily creates and processes certificate requests
2989: in PKCS#10 format.
2990: It can additionally create self-signed certificates,
2991: for use as root CAs, for example.
2992: .Pp
2993: The options are as follows:
2994: .Bl -tag -width Ds
2995: .It Fl asn1-kludge
1.63 jmc 2996: Produce requests in an invalid format for certain picky CAs.
2997: Very few CAs still require the use of this option.
1.1 jsing 2998: .It Fl batch
2999: Non-interactive mode.
3000: .It Fl config Ar file
1.63 jmc 3001: Specify an alternative configuration file.
1.1 jsing 3002: .It Fl days Ar n
1.63 jmc 3003: Specify the number of days to certify the certificate for.
3004: The default is 30 days.
3005: Used with the
1.1 jsing 3006: .Fl x509
1.63 jmc 3007: option.
1.1 jsing 3008: .It Fl extensions Ar section , Fl reqexts Ar section
1.63 jmc 3009: Specify alternative sections to include certificate
3010: extensions (with
3011: .Fl x509 )
3012: or certificate request extensions,
3013: allowing several different sections to be used in the same configuration file.
1.1 jsing 3014: .It Fl in Ar file
1.63 jmc 3015: The input file to read a request from,
3016: or standard input if not specified.
1.1 jsing 3017: A request is only read if the creation options
3018: .Fl new
3019: and
3020: .Fl newkey
3021: are not specified.
1.63 jmc 3022: .It Fl inform Cm der | pem
3023: The input format.
1.1 jsing 3024: .It Fl key Ar keyfile
1.63 jmc 3025: The file to read the private key from.
1.1 jsing 3026: It also accepts PKCS#8 format private keys for PEM format files.
1.63 jmc 3027: .It Fl keyform Cm der | pem
1.1 jsing 3028: The format of the private key file specified in the
3029: .Fl key
3030: argument.
1.81 jmc 3031: The default is
3032: .Cm pem .
1.1 jsing 3033: .It Fl keyout Ar file
1.63 jmc 3034: The file to write the newly created private key to.
3035: If this option is not specified,
3036: the filename present in the configuration file is used.
1.4 sthen 3037: .It Fl md5 | sha1 | sha256
1.63 jmc 3038: The message digest to sign the request with.
1.1 jsing 3039: This overrides the digest algorithm specified in the configuration file.
3040: .Pp
3041: Some public key algorithms may override this choice.
3042: For instance, DSA signatures always use SHA1.
3043: .It Fl modulus
1.63 jmc 3044: Print the value of the modulus of the public key contained in the request.
1.1 jsing 3045: .It Fl nameopt Ar option , Fl reqopt Ar option
1.63 jmc 3046: Determine how the subject or issuer names are displayed.
1.1 jsing 3047: .Ar option
1.63 jmc 3048: can be a single option or multiple options separated by commas.
1.1 jsing 3049: Alternatively, these options may be used more than once to set multiple options.
3050: See the
3051: .Sx X509
3052: section below for details.
3053: .It Fl new
1.63 jmc 3054: Generate a new certificate request.
3055: The user is prompted for the relevant field values.
1.1 jsing 3056: The actual fields prompted for and their maximum and minimum sizes
3057: are specified in the configuration file and any requested extensions.
3058: .Pp
3059: If the
3060: .Fl key
3061: option is not used, it will generate a new RSA private
3062: key using information specified in the configuration file.
3063: .It Fl newhdr
1.63 jmc 3064: Add the word NEW to the PEM file header and footer lines
1.1 jsing 3065: on the outputed request.
1.63 jmc 3066: Some software and CAs need this.
1.1 jsing 3067: .It Fl newkey Ar arg
1.63 jmc 3068: Create a new certificate request and a new private key.
1.1 jsing 3069: The argument takes one of several forms.
1.63 jmc 3070: .Pp
3071: .No rsa : Ns Ar nbits
3072: generates an RSA key
1.1 jsing 3073: .Ar nbits
3074: in size.
3075: If
3076: .Ar nbits
1.63 jmc 3077: is omitted
3078: the default key size is used.
3079: .Pp
3080: .No dsa : Ns Ar file
3081: generates a DSA key using the parameters in
3082: .Ar file .
3083: .Pp
3084: .No param : Ns Ar file
3085: generates a key using the parameters or certificate in
3086: .Ar file .
3087: .Pp
3088: All other algorithms support the form
3089: .Ar algorithm : Ns Ar file ,
1.1 jsing 3090: where file may be an algorithm parameter file,
3091: created by the
3092: .Cm genpkey -genparam
1.14 jmc 3093: command or an X.509 certificate for a key with appropriate algorithm.
1.63 jmc 3094: .Ar file
3095: can be omitted,
3096: in which case any parameters can be specified via the
1.1 jsing 3097: .Fl pkeyopt
3098: option.
3099: .It Fl no-asn1-kludge
1.63 jmc 3100: Reverse the effect of
1.1 jsing 3101: .Fl asn1-kludge .
3102: .It Fl nodes
1.63 jmc 3103: Do not encrypt the private key.
1.1 jsing 3104: .It Fl noout
1.63 jmc 3105: Do not output the encoded version of the request.
1.1 jsing 3106: .It Fl out Ar file
1.63 jmc 3107: The output file to write to,
1.99 jmc 3108: or standard output if not specified.
1.63 jmc 3109: .It Fl outform Cm der | pem
3110: The output format.
1.1 jsing 3111: .It Fl passin Ar arg
3112: The key password source.
3113: .It Fl passout Ar arg
3114: The output file password source.
3115: .It Fl pubkey
1.63 jmc 3116: Output the public key.
1.1 jsing 3117: .It Fl reqopt Ar option
3118: Customise the output format used with
3119: .Fl text .
3120: The
3121: .Ar option
3122: argument can be a single option or multiple options separated by commas.
1.63 jmc 3123: See also the discussion of
1.1 jsing 3124: .Fl certopt
1.63 jmc 3125: in the
1.1 jsing 3126: .Nm x509
3127: command.
3128: .It Fl set_serial Ar n
3129: Serial number to use when outputting a self-signed certificate.
3130: This may be specified as a decimal value or a hex value if preceded by
3131: .Sq 0x .
3132: It is possible to use negative serial numbers but this is not recommended.
3133: .It Fl subj Ar arg
1.63 jmc 3134: Replaces the subject field of an input request
3135: with the specified data and output the modified request.
3136: .Ar arg
3137: must be formatted as /type0=value0/type1=value1/type2=...;
1.1 jsing 3138: characters may be escaped by
3139: .Sq \e
1.63 jmc 3140: (backslash);
1.1 jsing 3141: no spaces are skipped.
3142: .It Fl subject
1.63 jmc 3143: Print the request subject (or certificate subject if
1.1 jsing 3144: .Fl x509
1.63 jmc 3145: is specified).
1.1 jsing 3146: .It Fl text
1.64 jmc 3147: Print the certificate request in plain text.
1.1 jsing 3148: .It Fl utf8
1.63 jmc 3149: Interpret field values as UTF8 strings, not ASCII.
1.1 jsing 3150: .It Fl verbose
3151: Print extra details about the operations being performed.
3152: .It Fl verify
1.63 jmc 3153: Verify the signature on the request.
1.1 jsing 3154: .It Fl x509
1.63 jmc 3155: Output a self-signed certificate instead of a certificate request.
3156: This is typically used to generate a test certificate or a self-signed root CA.
3157: The extensions added to the certificate (if any)
1.1 jsing 3158: are specified in the configuration file.
3159: Unless specified using the
3160: .Fl set_serial
1.63 jmc 3161: option, 0 is used for the serial number.
1.1 jsing 3162: .El
1.63 jmc 3163: .Pp
1.1 jsing 3164: The configuration options are specified in the
1.63 jmc 3165: .Qq req
1.1 jsing 3166: section of the configuration file.
1.63 jmc 3167: The options available are as follows:
1.1 jsing 3168: .Bl -tag -width "XXXX"
1.63 jmc 3169: .It Cm attributes
3170: The section containing any request attributes: its format
1.1 jsing 3171: is the same as
1.63 jmc 3172: .Cm distinguished_name .
3173: Typically these may contain the challengePassword or unstructuredName types.
3174: They are currently ignored by the
3175: .Nm openssl
1.1 jsing 3176: request signing utilities, but some CAs might want them.
1.63 jmc 3177: .It Cm default_bits
3178: The default key size, in bits.
3179: The default is 2048.
1.1 jsing 3180: It is used if the
3181: .Fl new
1.63 jmc 3182: option is used and can be overridden by using the
1.1 jsing 3183: .Fl newkey
3184: option.
1.63 jmc 3185: .It Cm default_keyfile
3186: The default file to write a private key to,
3187: or standard output if not specified.
3188: It can be overridden by the
1.1 jsing 3189: .Fl keyout
3190: option.
1.63 jmc 3191: .It Cm default_md
3192: The digest algorithm to use.
1.1 jsing 3193: Possible values include
1.63 jmc 3194: .Cm md5 ,
3195: .Cm sha1
1.1 jsing 3196: and
1.63 jmc 3197: .Cm sha256
3198: (the default).
3199: It can be overridden on the command line.
3200: .It Cm distinguished_name
3201: The section containing the distinguished name fields to
1.1 jsing 3202: prompt for when generating a certificate or certificate request.
1.63 jmc 3203: The format is described below.
3204: .It Cm encrypt_key
3205: If set to
3206: .Qq no
3207: and a private key is generated, it is not encrypted.
3208: It is equivalent to the
1.1 jsing 3209: .Fl nodes
1.63 jmc 3210: option.
1.1 jsing 3211: For compatibility,
1.63 jmc 3212: .Cm encrypt_rsa_key
1.1 jsing 3213: is an equivalent option.
1.63 jmc 3214: .It Cm input_password | output_password
3215: The passwords for the input private key file (if present)
3216: and the output private key file (if one will be created).
1.1 jsing 3217: The command line options
3218: .Fl passin
3219: and
3220: .Fl passout
3221: override the configuration file values.
1.63 jmc 3222: .It Cm oid_file
3223: A file containing additional OBJECT IDENTIFIERS.
1.1 jsing 3224: Each line of the file should consist of the numerical form of the
3225: object identifier, followed by whitespace, then the short name followed
3226: by whitespace and finally the long name.
1.63 jmc 3227: .It Cm oid_section
3228: Specify a section in the configuration file containing extra
1.1 jsing 3229: object identifiers.
3230: Each line should consist of the short name of the
3231: object identifier followed by
3232: .Sq =
3233: and the numerical form.
3234: The short and long names are the same when this option is used.
1.63 jmc 3235: .It Cm prompt
3236: If set to
3237: .Qq no ,
3238: it disables prompting of certificate fields
1.1 jsing 3239: and just takes values from the config file directly.
3240: It also changes the expected format of the
1.63 jmc 3241: .Cm distinguished_name
1.1 jsing 3242: and
1.63 jmc 3243: .Cm attributes
1.1 jsing 3244: sections.
1.63 jmc 3245: .It Cm req_extensions
3246: The configuration file section containing a list of
1.1 jsing 3247: extensions to add to the certificate request.
3248: It can be overridden by the
3249: .Fl reqexts
1.63 jmc 3250: option.
3251: .It Cm string_mask
3252: Limit the string types for encoding certain fields.
1.1 jsing 3253: The following values may be used, limiting strings to the indicated types:
3254: .Bl -tag -width "MASK:number"
1.63 jmc 3255: .It Cm utf8only
3256: UTF8String.
1.1 jsing 3257: This is the default, as recommended by PKIX in RFC 2459.
1.63 jmc 3258: .It Cm default
3259: PrintableString, IA5String, T61String, BMPString, UTF8String.
3260: .It Cm pkix
3261: PrintableString, IA5String, BMPString, UTF8String.
3262: Inspired by the PKIX recommendation in RFC 2459 for certificates
3263: generated before 2004, but differs by also permitting IA5String.
3264: .It Cm nombstr
3265: PrintableString, IA5String, T61String, UniversalString.
3266: A workaround for some ancient software that had problems
3267: with the variable-sized BMPString and UTF8String types.
1.1 jsing 3268: .It Cm MASK : Ns Ar number
1.63 jmc 3269: An explicit bitmask of permitted types, where
1.1 jsing 3270: .Ar number
3271: is a C-style hex, decimal, or octal number that's a bit-wise OR of
3272: .Dv B_ASN1_*
3273: values from
3274: .In openssl/asn1.h .
3275: .El
1.63 jmc 3276: .It Cm utf8
3277: If set to
3278: .Qq yes ,
1.72 jmc 3279: field values are interpreted as UTF8 strings.
1.63 jmc 3280: .It Cm x509_extensions
3281: The configuration file section containing a list of
1.1 jsing 3282: extensions to add to a certificate generated when the
3283: .Fl x509
3284: switch is used.
3285: It can be overridden by the
3286: .Fl extensions
1.72 jmc 3287: command line switch.
1.1 jsing 3288: .El
1.63 jmc 3289: .Pp
1.1 jsing 3290: There are two separate formats for the distinguished name and attribute
3291: sections.
3292: If the
3293: .Fl prompt
3294: option is set to
1.63 jmc 3295: .Qq no ,
1.72 jmc 3296: then these sections just consist of field names and values.
3297: If the
1.1 jsing 3298: .Fl prompt
3299: option is absent or not set to
1.63 jmc 3300: .Qq no ,
1.72 jmc 3301: then the file contains field prompting information of the form:
1.1 jsing 3302: .Bd -unfilled -offset indent
3303: fieldName="prompt"
3304: fieldName_default="default field value"
3305: fieldName_min= 2
3306: fieldName_max= 4
3307: .Ed
3308: .Pp
3309: .Qq fieldName
3310: is the field name being used, for example
1.63 jmc 3311: .Cm commonName
3312: (or CN).
1.1 jsing 3313: The
3314: .Qq prompt
3315: string is used to ask the user to enter the relevant details.
3316: If the user enters nothing, the default value is used;
3317: if no default value is present, the field is omitted.
3318: A field can still be omitted if a default value is present,
3319: if the user just enters the
3320: .Sq \&.
3321: character.
3322: .Pp
3323: The number of characters entered must be between the
1.63 jmc 3324: fieldName_min and fieldName_max limits:
1.1 jsing 3325: there may be additional restrictions based on the field being used
3326: (for example
1.63 jmc 3327: .Cm countryName
1.1 jsing 3328: can only ever be two characters long and must fit in a
1.63 jmc 3329: .Cm PrintableString ) .
1.1 jsing 3330: .Pp
3331: Some fields (such as
1.63 jmc 3332: .Cm organizationName )
1.1 jsing 3333: can be used more than once in a DN.
3334: This presents a problem because configuration files will
3335: not recognize the same name occurring twice.
3336: To avoid this problem, if the
1.63 jmc 3337: .Cm fieldName
1.1 jsing 3338: contains some characters followed by a full stop, they will be ignored.
3339: So, for example, a second
1.63 jmc 3340: .Cm organizationName
1.1 jsing 3341: can be input by calling it
3342: .Qq 1.organizationName .
3343: .Pp
3344: The actual permitted field names are any object identifier short or
3345: long names.
3346: These are compiled into
1.63 jmc 3347: .Nm openssl
1.1 jsing 3348: and include the usual values such as
1.63 jmc 3349: .Cm commonName , countryName , localityName , organizationName ,
1.89 jmc 3350: .Cm organizationalUnitName , stateOrProvinceName .
1.1 jsing 3351: Additionally,
1.63 jmc 3352: .Cm emailAddress
1.1 jsing 3353: is included as well as
1.63 jmc 3354: .Cm name , surname , givenName , initials
1.1 jsing 3355: and
1.63 jmc 3356: .Cm dnQualifier .
1.1 jsing 3357: .Pp
3358: Additional object identifiers can be defined with the
1.63 jmc 3359: .Cm oid_file
1.1 jsing 3360: or
1.63 jmc 3361: .Cm oid_section
1.1 jsing 3362: options in the configuration file.
3363: Any additional fields will be treated as though they were a
1.63 jmc 3364: .Cm DirectoryString .
1.1 jsing 3365: .Sh RSA
3366: .nr nS 1
3367: .Nm "openssl rsa"
1.64 jmc 3368: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 3369: .Op Fl check
3370: .Op Fl in Ar file
1.64 jmc 3371: .Op Fl inform Cm der | net | pem
1.1 jsing 3372: .Op Fl modulus
3373: .Op Fl noout
3374: .Op Fl out Ar file
1.64 jmc 3375: .Op Fl outform Cm der | net | pem
1.1 jsing 3376: .Op Fl passin Ar arg
3377: .Op Fl passout Ar arg
3378: .Op Fl pubin
3379: .Op Fl pubout
3380: .Op Fl sgckey
3381: .Op Fl text
3382: .nr nS 0
3383: .Pp
3384: The
3385: .Nm rsa
3386: command processes RSA keys.
3387: They can be converted between various forms and their components printed out.
1.64 jmc 3388: .Nm rsa
3389: uses the traditional
1.1 jsing 3390: .Nm SSLeay
3391: compatible format for private key encryption:
3392: newer applications should use the more secure PKCS#8 format using the
3393: .Nm pkcs8
3394: utility.
3395: .Pp
3396: The options are as follows:
3397: .Bl -tag -width Ds
1.64 jmc 3398: .It Fl aes128 | aes192 | aes256 | des | des3
3399: Encrypt the private key with the AES, DES,
1.1 jsing 3400: or the triple DES ciphers, respectively, before outputting it.
3401: A pass phrase is prompted for.
3402: If none of these options are specified, the key is written in plain text.
3403: This means that using the
3404: .Nm rsa
3405: utility to read in an encrypted key with no encryption option can be used
3406: to remove the pass phrase from a key, or by setting the encryption options
3407: it can be used to add or change the pass phrase.
3408: These options can only be used with PEM format output files.
3409: .It Fl check
1.64 jmc 3410: Check the consistency of an RSA private key.
1.1 jsing 3411: .It Fl in Ar file
1.64 jmc 3412: The input file to read from,
3413: or standard input if not specified.
1.1 jsing 3414: If the key is encrypted, a pass phrase will be prompted for.
1.64 jmc 3415: .It Fl inform Cm der | net | pem
3416: The input format.
1.1 jsing 3417: .It Fl noout
1.64 jmc 3418: Do not output the encoded version of the key.
1.1 jsing 3419: .It Fl modulus
1.64 jmc 3420: Print the value of the modulus of the key.
1.1 jsing 3421: .It Fl out Ar file
1.64 jmc 3422: The output file to write to,
3423: or standard output if not specified.
3424: .It Fl outform Cm der | net | pem
3425: The output format.
1.1 jsing 3426: .It Fl passin Ar arg
3427: The key password source.
3428: .It Fl passout Ar arg
3429: The output file password source.
3430: .It Fl pubin
1.64 jmc 3431: Read in a public key,
3432: not a private key.
1.1 jsing 3433: .It Fl pubout
1.64 jmc 3434: Output a public key,
3435: not a private key.
3436: Automatically set if the input is a public key.
1.1 jsing 3437: .It Fl sgckey
1.64 jmc 3438: Use the modified NET algorithm used with some versions of Microsoft IIS
3439: and SGC keys.
1.1 jsing 3440: .It Fl text
1.64 jmc 3441: Print the public/private key components in plain text.
1.1 jsing 3442: .El
3443: .Sh RSAUTL
3444: .nr nS 1
3445: .Nm "openssl rsautl"
3446: .Op Fl asn1parse
3447: .Op Fl certin
3448: .Op Fl decrypt
3449: .Op Fl encrypt
3450: .Op Fl hexdump
3451: .Op Fl in Ar file
3452: .Op Fl inkey Ar file
1.65 jmc 3453: .Op Fl keyform Cm der | pem
1.100 tb 3454: .Op Fl oaep | pkcs | raw | x931
1.1 jsing 3455: .Op Fl out Ar file
1.100 tb 3456: .Op Fl passin Ar arg
1.1 jsing 3457: .Op Fl pubin
1.100 tb 3458: .Op Fl rev
1.1 jsing 3459: .Op Fl sign
3460: .Op Fl verify
3461: .nr nS 0
3462: .Pp
3463: The
3464: .Nm rsautl
3465: command can be used to sign, verify, encrypt and decrypt
3466: data using the RSA algorithm.
3467: .Pp
3468: The options are as follows:
3469: .Bl -tag -width Ds
3470: .It Fl asn1parse
3471: Asn1parse the output data; this is useful when combined with the
3472: .Fl verify
3473: option.
3474: .It Fl certin
3475: The input is a certificate containing an RSA public key.
3476: .It Fl decrypt
3477: Decrypt the input data using an RSA private key.
3478: .It Fl encrypt
3479: Encrypt the input data using an RSA public key.
3480: .It Fl hexdump
3481: Hex dump the output data.
3482: .It Fl in Ar file
1.65 jmc 3483: The input to read from,
3484: or standard input if not specified.
1.1 jsing 3485: .It Fl inkey Ar file
1.65 jmc 3486: The input key file; by default an RSA private key.
3487: .It Fl keyform Cm der | pem
1.85 tb 3488: The private key format.
1.65 jmc 3489: The default is
3490: .Cm pem .
1.100 tb 3491: .It Fl oaep | pkcs | raw | x931
1.1 jsing 3492: The padding to use:
1.100 tb 3493: PKCS#1 OAEP, PKCS#1 v1.5 (the default), no padding, or ANSI X9.31,
3494: respectively.
1.1 jsing 3495: For signatures, only
3496: .Fl pkcs
3497: and
3498: .Fl raw
3499: can be used.
3500: .It Fl out Ar file
1.65 jmc 3501: The output file to write to,
3502: or standard output if not specified.
1.100 tb 3503: .It Fl passin Ar arg
3504: The key password source.
1.1 jsing 3505: .It Fl pubin
3506: The input file is an RSA public key.
1.100 tb 3507: .It Fl rev
3508: Reverse the order of the input buffer.
1.1 jsing 3509: .It Fl sign
3510: Sign the input data and output the signed result.
3511: This requires an RSA private key.
3512: .It Fl verify
3513: Verify the input data and output the recovered data.
3514: .El
3515: .Sh S_CLIENT
3516: .nr nS 1
3517: .Nm "openssl s_client"
3518: .Op Fl 4 | 6
3519: .Op Fl bugs
3520: .Op Fl CAfile Ar file
3521: .Op Fl CApath Ar directory
3522: .Op Fl cert Ar file
3523: .Op Fl check_ss_sig
3524: .Op Fl cipher Ar cipherlist
1.66 jmc 3525: .Op Fl connect Ar host Ns Op : Ns Ar port
1.1 jsing 3526: .Op Fl crl_check
3527: .Op Fl crl_check_all
3528: .Op Fl crlf
3529: .Op Fl debug
3530: .Op Fl extended_crl
1.87 jmc 3531: .Op Fl groups
1.1 jsing 3532: .Op Fl ign_eof
3533: .Op Fl ignore_critical
3534: .Op Fl issuer_checks
3535: .Op Fl key Ar keyfile
3536: .Op Fl msg
3537: .Op Fl nbio
3538: .Op Fl nbio_test
3539: .Op Fl no_ticket
3540: .Op Fl no_tls1
1.6 guenther 3541: .Op Fl no_tls1_1
3542: .Op Fl no_tls1_2
1.1 jsing 3543: .Op Fl pause
3544: .Op Fl policy_check
3545: .Op Fl prexit
1.11 bluhm 3546: .Op Fl proxy Ar host : Ns Ar port
1.1 jsing 3547: .Op Fl psk Ar key
3548: .Op Fl psk_identity Ar identity
3549: .Op Fl quiet
3550: .Op Fl reconnect
1.5 jsing 3551: .Op Fl servername Ar name
1.1 jsing 3552: .Op Fl showcerts
3553: .Op Fl starttls Ar protocol
3554: .Op Fl state
3555: .Op Fl tls1
1.31 jmc 3556: .Op Fl tls1_1
3557: .Op Fl tls1_2
1.1 jsing 3558: .Op Fl tlsextdebug
3559: .Op Fl verify Ar depth
3560: .Op Fl x509_strict
1.19 landry 3561: .Op Fl xmpphost Ar host
1.1 jsing 3562: .nr nS 0
3563: .Pp
3564: The
3565: .Nm s_client
3566: command implements a generic SSL/TLS client which connects
3567: to a remote host using SSL/TLS.
1.66 jmc 3568: .Pp
3569: If a connection is established with an SSL server, any data received
3570: from the server is displayed and any key presses will be sent to the
3571: server.
3572: When used interactively (which means neither
3573: .Fl quiet
3574: nor
3575: .Fl ign_eof
3576: have been given), the session will be renegotiated if the line begins with an
3577: .Cm R ;
3578: if the line begins with a
3579: .Cm Q
3580: or if end of file is reached, the connection will be closed down.
1.1 jsing 3581: .Pp
3582: The options are as follows:
3583: .Bl -tag -width Ds
3584: .It Fl 4
1.66 jmc 3585: Attempt connections using IPv4 only.
1.1 jsing 3586: .It Fl 6
1.66 jmc 3587: Attempt connections using IPv6 only.
1.1 jsing 3588: .It Fl bugs
1.66 jmc 3589: Enable various workarounds for buggy implementations.
1.1 jsing 3590: .It Fl CAfile Ar file
3591: A
3592: .Ar file
3593: containing trusted certificates to use during server authentication
3594: and to use when attempting to build the client certificate chain.
3595: .It Fl CApath Ar directory
3596: The
3597: .Ar directory
3598: to use for server certificate verification.
3599: This directory must be in
3600: .Qq hash format ;
3601: see
3602: .Fl verify
3603: for more information.
3604: These are also used when building the client certificate chain.
3605: .It Fl cert Ar file
3606: The certificate to use, if one is requested by the server.
3607: The default is not to use a certificate.
3608: .It Xo
3609: .Fl check_ss_sig ,
3610: .Fl crl_check ,
3611: .Fl crl_check_all ,
3612: .Fl extended_crl ,
3613: .Fl ignore_critical ,
3614: .Fl issuer_checks ,
3615: .Fl policy_check ,
3616: .Fl x509_strict
3617: .Xc
3618: Set various certificate chain validation options.
3619: See the
1.66 jmc 3620: .Nm verify
1.1 jsing 3621: command for details.
3622: .It Fl cipher Ar cipherlist
1.66 jmc 3623: Modify the cipher list sent by the client.
1.1 jsing 3624: Although the server determines which cipher suite is used, it should take
3625: the first supported cipher in the list sent by the client.
3626: See the
1.66 jmc 3627: .Nm ciphers
3628: command for more information.
3629: .It Fl connect Ar host Ns Op : Ns Ar port
3630: The
1.1 jsing 3631: .Ar host
1.66 jmc 3632: and
1.1 jsing 3633: .Ar port
3634: to connect to.
3635: If not specified, an attempt is made to connect to the local host
3636: on port 4433.
3637: Alternatively, the host and port pair may be separated using a forward-slash
1.66 jmc 3638: character,
3639: which is useful for numeric IPv6 addresses.
1.1 jsing 3640: .It Fl crlf
1.66 jmc 3641: Translate a line feed from the terminal into CR+LF,
3642: as required by some servers.
1.1 jsing 3643: .It Fl debug
1.66 jmc 3644: Print extensive debugging information, including a hex dump of all traffic.
1.87 jmc 3645: .It Fl groups Ar ecgroups
3646: Specify a colon-separated list of permitted EC curve groups.
1.1 jsing 3647: .It Fl ign_eof
1.66 jmc 3648: Inhibit shutting down the connection when end of file is reached in the input.
1.1 jsing 3649: .It Fl key Ar keyfile
3650: The private key to use.
3651: If not specified, the certificate file will be used.
3652: .It Fl msg
3653: Show all protocol messages with hex dump.
3654: .It Fl nbio
1.66 jmc 3655: Turn on non-blocking I/O.
1.1 jsing 3656: .It Fl nbio_test
1.66 jmc 3657: Test non-blocking I/O.
1.31 jmc 3658: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.66 jmc 3659: Disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 3660: .It Fl no_ticket
3661: Disable RFC 4507 session ticket support.
3662: .It Fl pause
1.66 jmc 3663: Pause 1 second between each read and write call.
1.1 jsing 3664: .It Fl prexit
3665: Print session information when the program exits.
3666: This will always attempt
3667: to print out information even if the connection fails.
3668: Normally, information will only be printed out once if the connection succeeds.
3669: This option is useful because the cipher in use may be renegotiated
3670: or the connection may fail because a client certificate is required or is
3671: requested only after an attempt is made to access a certain URL.
1.66 jmc 3672: Note that the output produced by this option is not always accurate
3673: because a connection might never have been established.
1.11 bluhm 3674: .It Fl proxy Ar host : Ns Ar port
3675: Use the HTTP proxy at
3676: .Ar host
3677: and
3678: .Ar port .
3679: The connection to the proxy is done in cleartext and the
3680: .Fl connect
3681: argument is given to the proxy.
3682: If not specified, localhost is used as final destination.
3683: After that, switch the connection through the proxy to the destination
3684: to TLS.
1.1 jsing 3685: .It Fl psk Ar key
3686: Use the PSK key
3687: .Ar key
3688: when using a PSK cipher suite.
3689: The key is given as a hexadecimal number without the leading 0x,
3690: for example -psk 1a2b3c4d.
3691: .It Fl psk_identity Ar identity
1.66 jmc 3692: Use the PSK
1.1 jsing 3693: .Ar identity
3694: when using a PSK cipher suite.
3695: .It Fl quiet
3696: Inhibit printing of session and certificate information.
3697: This implicitly turns on
3698: .Fl ign_eof
3699: as well.
3700: .It Fl reconnect
1.66 jmc 3701: Reconnect to the same server 5 times using the same session ID; this can
1.1 jsing 3702: be used as a test that session caching is working.
1.5 jsing 3703: .It Fl servername Ar name
3704: Include the TLS Server Name Indication (SNI) extension in the ClientHello
3705: message, using the specified server
3706: .Ar name .
1.1 jsing 3707: .It Fl showcerts
3708: Display the whole server certificate chain: normally only the server
3709: certificate itself is displayed.
3710: .It Fl starttls Ar protocol
1.66 jmc 3711: Send the protocol-specific messages to switch to TLS for communication.
1.1 jsing 3712: .Ar protocol
3713: is a keyword for the intended protocol.
3714: Currently, the supported keywords are
3715: .Qq ftp ,
3716: .Qq imap ,
3717: .Qq smtp ,
3718: .Qq pop3 ,
3719: and
3720: .Qq xmpp .
3721: .It Fl state
1.66 jmc 3722: Print the SSL session states.
1.31 jmc 3723: .It Fl tls1 | tls1_1 | tls1_2
3724: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 3725: .It Fl tlsextdebug
1.66 jmc 3726: Print a hex dump of any TLS extensions received from the server.
1.1 jsing 3727: .It Fl verify Ar depth
1.66 jmc 3728: Turn on server certificate verification,
3729: with a maximum length of
3730: .Ar depth .
1.1 jsing 3731: Currently the verify operation continues after errors so all the problems
3732: with a certificate chain can be seen.
3733: As a side effect the connection will never fail due to a server
3734: certificate verify failure.
1.19 landry 3735: .It Fl xmpphost Ar hostname
1.66 jmc 3736: When used with
1.19 landry 3737: .Fl starttls Ar xmpp ,
1.66 jmc 3738: specify the host for the "to" attribute of the stream element.
1.19 landry 3739: If this option is not specified then the host specified with
3740: .Fl connect
3741: will be used.
1.1 jsing 3742: .El
3743: .Sh S_SERVER
3744: .nr nS 1
3745: .Nm "openssl s_server"
3746: .Op Fl accept Ar port
3747: .Op Fl bugs
3748: .Op Fl CAfile Ar file
3749: .Op Fl CApath Ar directory
3750: .Op Fl cert Ar file
3751: .Op Fl cipher Ar cipherlist
3752: .Op Fl context Ar id
3753: .Op Fl crl_check
3754: .Op Fl crl_check_all
3755: .Op Fl crlf
3756: .Op Fl dcert Ar file
3757: .Op Fl debug
3758: .Op Fl dhparam Ar file
3759: .Op Fl dkey Ar file
3760: .Op Fl hack
3761: .Op Fl HTTP
3762: .Op Fl id_prefix Ar arg
3763: .Op Fl key Ar keyfile
3764: .Op Fl msg
3765: .Op Fl nbio
3766: .Op Fl nbio_test
3767: .Op Fl no_dhe
3768: .Op Fl no_tls1
1.6 guenther 3769: .Op Fl no_tls1_1
3770: .Op Fl no_tls1_2
1.1 jsing 3771: .Op Fl no_tmp_rsa
3772: .Op Fl nocert
3773: .Op Fl psk Ar key
3774: .Op Fl psk_hint Ar hint
3775: .Op Fl quiet
3776: .Op Fl serverpref
3777: .Op Fl state
3778: .Op Fl tls1
1.31 jmc 3779: .Op Fl tls1_1
3780: .Op Fl tls1_2
1.1 jsing 3781: .Op Fl Verify Ar depth
3782: .Op Fl verify Ar depth
3783: .Op Fl WWW
3784: .Op Fl www
3785: .nr nS 0
3786: .Pp
3787: The
3788: .Nm s_server
3789: command implements a generic SSL/TLS server which listens
3790: for connections on a given port using SSL/TLS.
3791: .Pp
1.67 jmc 3792: If a connection request is established with a client and neither the
3793: .Fl www
3794: nor the
3795: .Fl WWW
3796: option has been used, then any data received
3797: from the client is displayed and any key presses are sent to the client.
3798: Certain single letter commands perform special operations:
3799: .Pp
3800: .Bl -tag -width "XXXX" -compact
3801: .It Ic P
3802: Send plain text, which should cause the client to disconnect.
3803: .It Ic Q
3804: End the current SSL connection and exit.
3805: .It Ic q
3806: End the current SSL connection, but still accept new connections.
3807: .It Ic R
3808: Renegotiate the SSL session and request a client certificate.
3809: .It Ic r
3810: Renegotiate the SSL session.
3811: .It Ic S
3812: Print out some session cache status information.
3813: .El
3814: .Pp
1.1 jsing 3815: The options are as follows:
3816: .Bl -tag -width Ds
3817: .It Fl accept Ar port
1.67 jmc 3818: Listen on TCP
1.1 jsing 3819: .Ar port
1.67 jmc 3820: for connections.
3821: The default is port 4433.
1.1 jsing 3822: .It Fl bugs
1.67 jmc 3823: Enable various workarounds for buggy implementations.
1.1 jsing 3824: .It Fl CAfile Ar file
1.67 jmc 3825: A
3826: .Ar file
3827: containing trusted certificates to use during client authentication
1.1 jsing 3828: and to use when attempting to build the server certificate chain.
3829: The list is also used in the list of acceptable client CAs passed to the
3830: client when a certificate is requested.
3831: .It Fl CApath Ar directory
3832: The
3833: .Ar directory
3834: to use for client certificate verification.
3835: This directory must be in
3836: .Qq hash format ;
3837: see
3838: .Fl verify
3839: for more information.
3840: These are also used when building the server certificate chain.
3841: .It Fl cert Ar file
1.67 jmc 3842: The certificate to use: most server's cipher suites require the use of a
3843: certificate and some require a certificate with a certain public key type.
3844: For example, the DSS cipher suites require a certificate containing a DSS
3845: (DSA) key.
1.1 jsing 3846: If not specified, the file
3847: .Pa server.pem
3848: will be used.
3849: .It Fl cipher Ar cipherlist
1.67 jmc 3850: Modify the cipher list used by the server.
1.1 jsing 3851: This allows the cipher list used by the server to be modified.
3852: When the client sends a list of supported ciphers, the first client cipher
3853: also included in the server list is used.
3854: Because the client specifies the preference order, the order of the server
3855: cipherlist is irrelevant.
3856: See the
1.67 jmc 3857: .Nm ciphers
3858: command for more information.
1.1 jsing 3859: .It Fl context Ar id
1.67 jmc 3860: Set the SSL context ID.
1.1 jsing 3861: It can be given any string value.
3862: .It Fl crl_check , crl_check_all
3863: Check the peer certificate has not been revoked by its CA.
3864: The CRLs are appended to the certificate file.
3865: .Fl crl_check_all
1.67 jmc 3866: checks all CRLs of all CAs in the chain.
1.1 jsing 3867: .It Fl crlf
1.67 jmc 3868: Translate a line feed from the terminal into CR+LF.
1.1 jsing 3869: .It Fl dcert Ar file , Fl dkey Ar file
3870: Specify an additional certificate and private key; these behave in the
3871: same manner as the
3872: .Fl cert
3873: and
3874: .Fl key
3875: options except there is no default if they are not specified
1.67 jmc 3876: (no additional certificate or key is used).
1.1 jsing 3877: By using RSA and DSS certificates and keys,
3878: a server can support clients which only support RSA or DSS cipher suites
3879: by using an appropriate certificate.
3880: .It Fl debug
1.67 jmc 3881: Print extensive debugging information, including a hex dump of all traffic.
1.1 jsing 3882: .It Fl dhparam Ar file
3883: The DH parameter file to use.
3884: The ephemeral DH cipher suites generate keys
3885: using a set of DH parameters.
3886: If not specified, an attempt is made to
3887: load the parameters from the server certificate file.
3888: If this fails, a static set of parameters hard coded into the
3889: .Nm s_server
3890: program will be used.
3891: .It Fl hack
1.67 jmc 3892: Enables a further workaround for some early Netscape SSL code.
1.1 jsing 3893: .It Fl HTTP
1.67 jmc 3894: Emulate a simple web server.
3895: Pages are resolved relative to the current directory.
3896: For example if the URL
1.1 jsing 3897: .Pa https://myhost/page.html
3898: is requested, the file
3899: .Pa ./page.html
3900: will be loaded.
3901: The files loaded are assumed to contain a complete and correct HTTP
3902: response (lines that are part of the HTTP response line and headers
3903: must end with CRLF).
3904: .It Fl id_prefix Ar arg
3905: Generate SSL/TLS session IDs prefixed by
3906: .Ar arg .
3907: This is mostly useful for testing any SSL/TLS code
1.81 jmc 3908: that wish to deal with multiple servers,
3909: when each of which might be generating a unique range of session IDs.
1.1 jsing 3910: .It Fl key Ar keyfile
3911: The private key to use.
3912: If not specified, the certificate file will be used.
3913: .It Fl msg
3914: Show all protocol messages with hex dump.
3915: .It Fl nbio
1.67 jmc 3916: Turn on non-blocking I/O.
1.1 jsing 3917: .It Fl nbio_test
1.67 jmc 3918: Test non-blocking I/O.
1.1 jsing 3919: .It Fl no_dhe
1.67 jmc 3920: Disable ephemeral DH cipher suites.
1.31 jmc 3921: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.67 jmc 3922: Disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 3923: .It Fl no_tmp_rsa
1.67 jmc 3924: Disable temporary RSA key generation.
1.1 jsing 3925: .It Fl nocert
1.67 jmc 3926: Do not use a certificate.
1.1 jsing 3927: This restricts the cipher suites available to the anonymous ones
1.67 jmc 3928: (currently just anonymous DH).
1.1 jsing 3929: .It Fl psk Ar key
3930: Use the PSK key
3931: .Ar key
3932: when using a PSK cipher suite.
3933: The key is given as a hexadecimal number without the leading 0x,
3934: for example -psk 1a2b3c4d.
3935: .It Fl psk_hint Ar hint
3936: Use the PSK identity hint
3937: .Ar hint
3938: when using a PSK cipher suite.
3939: .It Fl quiet
3940: Inhibit printing of session and certificate information.
3941: .It Fl serverpref
3942: Use server's cipher preferences.
3943: .It Fl state
1.67 jmc 3944: Print the SSL session states.
1.31 jmc 3945: .It Fl tls1 | tls1_1 | tls1_2
3946: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 3947: .It Fl WWW
1.67 jmc 3948: Emulate a simple web server.
3949: Pages are resolved relative to the current directory.
3950: For example if the URL
1.1 jsing 3951: .Pa https://myhost/page.html
3952: is requested, the file
3953: .Pa ./page.html
3954: will be loaded.
3955: .It Fl www
1.67 jmc 3956: Send a status message to the client when it connects,
3957: including information about the ciphers used and various session parameters.
1.1 jsing 3958: The output is in HTML format so this option will normally be used with a
3959: web browser.
3960: .It Fl Verify Ar depth , Fl verify Ar depth
1.67 jmc 3961: Request a certificate chain from the client,
3962: with a maximum length of
3963: .Ar depth .
3964: With
3965: .Fl Verify ,
3966: the client must supply a certificate or an error occurs;
3967: with
3968: .Fl verify ,
3969: a certificate is requested but the client does not have to send one.
1.1 jsing 3970: .El
3971: .Sh S_TIME
3972: .nr nS 1
3973: .Nm "openssl s_time"
3974: .Op Fl bugs
3975: .Op Fl CAfile Ar file
3976: .Op Fl CApath Ar directory
3977: .Op Fl cert Ar file
3978: .Op Fl cipher Ar cipherlist
1.68 jmc 3979: .Op Fl connect Ar host Ns Op : Ns Ar port
1.1 jsing 3980: .Op Fl key Ar keyfile
3981: .Op Fl nbio
3982: .Op Fl new
1.20 lteo 3983: .Op Fl no_shutdown
1.1 jsing 3984: .Op Fl reuse
3985: .Op Fl time Ar seconds
3986: .Op Fl verify Ar depth
3987: .Op Fl www Ar page
3988: .nr nS 0
3989: .Pp
3990: The
1.68 jmc 3991: .Nm s_time
1.1 jsing 3992: command implements a generic SSL/TLS client which connects to a
3993: remote host using SSL/TLS.
3994: It can request a page from the server and includes
3995: the time to transfer the payload data in its timing measurements.
3996: It measures the number of connections within a given timeframe,
3997: the amount of data transferred
3998: .Pq if any ,
3999: and calculates the average time spent for one connection.
4000: .Pp
4001: The options are as follows:
4002: .Bl -tag -width Ds
4003: .It Fl bugs
1.68 jmc 4004: Enable various workarounds for buggy implementations.
1.1 jsing 4005: .It Fl CAfile Ar file
1.68 jmc 4006: A
4007: .Ar file
4008: containing trusted certificates to use during server authentication
1.1 jsing 4009: and to use when attempting to build the client certificate chain.
4010: .It Fl CApath Ar directory
4011: The directory to use for server certificate verification.
4012: This directory must be in
4013: .Qq hash format ;
4014: see
4015: .Nm verify
4016: for more information.
4017: These are also used when building the client certificate chain.
4018: .It Fl cert Ar file
4019: The certificate to use, if one is requested by the server.
4020: The default is not to use a certificate.
4021: .It Fl cipher Ar cipherlist
1.68 jmc 4022: Modify the cipher list sent by the client.
1.1 jsing 4023: Although the server determines which cipher suite is used,
4024: it should take the first supported cipher in the list sent by the client.
4025: See the
4026: .Nm ciphers
4027: command for more information.
1.68 jmc 4028: .It Fl connect Ar host Ns Op : Ns Ar port
4029: The host and port to connect to.
1.1 jsing 4030: .It Fl key Ar keyfile
4031: The private key to use.
4032: If not specified, the certificate file will be used.
4033: .It Fl nbio
1.68 jmc 4034: Turn on non-blocking I/O.
1.1 jsing 4035: .It Fl new
1.68 jmc 4036: Perform the timing test using a new session ID for each connection.
1.1 jsing 4037: If neither
4038: .Fl new
4039: nor
4040: .Fl reuse
4041: are specified,
4042: they are both on by default and executed in sequence.
1.20 lteo 4043: .It Fl no_shutdown
1.21 jmc 4044: Shut down the connection without sending a
1.68 jmc 4045: .Qq close notify
1.20 lteo 4046: shutdown alert to the server.
1.1 jsing 4047: .It Fl reuse
1.68 jmc 4048: Perform the timing test using the same session ID for each connection.
1.1 jsing 4049: If neither
4050: .Fl new
4051: nor
4052: .Fl reuse
4053: are specified,
4054: they are both on by default and executed in sequence.
4055: .It Fl time Ar seconds
1.68 jmc 4056: Limit
1.1 jsing 4057: .Nm s_time
1.68 jmc 4058: benchmarks to the number of
4059: .Ar seconds .
1.1 jsing 4060: The default is 30 seconds.
4061: .It Fl verify Ar depth
1.68 jmc 4062: Turn on server certificate verification,
4063: with a maximum length of
4064: .Ar depth .
1.1 jsing 4065: Currently the verify operation continues after errors, so all the problems
4066: with a certificate chain can be seen.
4067: As a side effect,
4068: the connection will never fail due to a server certificate verify failure.
4069: .It Fl www Ar page
1.68 jmc 4070: The page to GET from the server.
1.1 jsing 4071: A value of
4072: .Sq /
4073: gets the index.htm[l] page.
4074: If this parameter is not specified,
4075: .Nm s_time
4076: will only perform the handshake to establish SSL connections
4077: but not transfer any payload data.
4078: .El
4079: .Sh SESS_ID
4080: .nr nS 1
4081: .Nm "openssl sess_id"
4082: .Op Fl cert
4083: .Op Fl context Ar ID
4084: .Op Fl in Ar file
1.69 jmc 4085: .Op Fl inform Cm der | pem
1.1 jsing 4086: .Op Fl noout
4087: .Op Fl out Ar file
1.69 jmc 4088: .Op Fl outform Cm der | pem
1.1 jsing 4089: .Op Fl text
4090: .nr nS 0
4091: .Pp
4092: The
4093: .Nm sess_id
4094: program processes the encoded version of the SSL session structure and
4095: optionally prints out SSL session details
1.69 jmc 4096: (for example the SSL session master key)
1.72 jmc 4097: in human-readable format.
1.1 jsing 4098: .Pp
4099: The options are as follows:
4100: .Bl -tag -width Ds
4101: .It Fl cert
4102: If a certificate is present in the session,
4103: it will be output using this option;
4104: if the
4105: .Fl text
4106: option is also present, then it will be printed out in text form.
4107: .It Fl context Ar ID
1.69 jmc 4108: Set the session
1.1 jsing 4109: .Ar ID .
1.69 jmc 4110: The ID can be any string of characters.
1.1 jsing 4111: .It Fl in Ar file
1.69 jmc 4112: The input file to read from,
4113: or standard input if not specified.
4114: .It Fl inform Cm der | pem
4115: The input format.
4116: .Cm der
1.84 jmc 4117: uses an ASN.1 DER-encoded format containing session details.
1.1 jsing 4118: The precise format can vary from one version to the next.
1.69 jmc 4119: .Cm pem
4120: is the default format: it consists of the DER
1.1 jsing 4121: format base64-encoded with additional header and footer lines.
4122: .It Fl noout
1.69 jmc 4123: Do not output the encoded version of the session.
1.1 jsing 4124: .It Fl out Ar file
1.69 jmc 4125: The output file to write to,
4126: or standard output if not specified.
4127: .It Fl outform Cm der | pem
4128: The output format.
1.1 jsing 4129: .It Fl text
1.69 jmc 4130: Print the various public or private key components in plain text,
4131: in addition to the encoded version.
1.1 jsing 4132: .El
4133: .Pp
1.69 jmc 4134: The output of
4135: .Nm sess_id
4136: is composed as follows:
1.1 jsing 4137: .Pp
1.69 jmc 4138: .Bl -tag -width "Verify return code " -offset 3n -compact
4139: .It Protocol
4140: The protocol in use.
4141: .It Cipher
4142: The actual raw SSL or TLS cipher code.
4143: .It Session-ID
4144: The SSL session ID, in hex format.
4145: .It Session-ID-ctx
4146: The session ID context, in hex format.
4147: .It Master-Key
4148: The SSL session master key.
4149: .It Key-Arg
1.1 jsing 4150: The key argument; this is only used in SSL v2.
1.69 jmc 4151: .It Start Time
4152: The session start time.
1.1 jsing 4153: .Ux
4154: format.
1.69 jmc 4155: .It Timeout
4156: The timeout, in seconds.
4157: .It Verify return code
4158: The return code when a certificate is verified.
1.1 jsing 4159: .El
4160: .Pp
4161: Since the SSL session output contains the master key, it is possible to read
4162: the contents of an encrypted session using this information.
4163: Therefore appropriate security precautions
4164: should be taken if the information is being output by a
4165: .Qq real
4166: application.
4167: This is, however, strongly discouraged and should only be used for
4168: debugging purposes.
4169: .Sh SMIME
4170: .nr nS 1
4171: .Nm "openssl smime"
4172: .Oo
4173: .Fl aes128 | aes192 | aes256 | des |
4174: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4175: .Oc
4176: .Op Fl binary
4177: .Op Fl CAfile Ar file
4178: .Op Fl CApath Ar directory
4179: .Op Fl certfile Ar file
4180: .Op Fl check_ss_sig
4181: .Op Fl content Ar file
4182: .Op Fl crl_check
4183: .Op Fl crl_check_all
4184: .Op Fl decrypt
4185: .Op Fl encrypt
4186: .Op Fl extended_crl
4187: .Op Fl from Ar addr
4188: .Op Fl ignore_critical
4189: .Op Fl in Ar file
4190: .Op Fl indef
1.70 jmc 4191: .Op Fl inform Cm der | pem | smime
1.1 jsing 4192: .Op Fl inkey Ar file
4193: .Op Fl issuer_checks
1.70 jmc 4194: .Op Fl keyform Cm pem
1.1 jsing 4195: .Op Fl md Ar digest
4196: .Op Fl noattr
4197: .Op Fl nocerts
4198: .Op Fl nochain
4199: .Op Fl nodetach
4200: .Op Fl noindef
4201: .Op Fl nointern
4202: .Op Fl nosigs
4203: .Op Fl noverify
4204: .Op Fl out Ar file
1.70 jmc 4205: .Op Fl outform Cm der | pem | smime
1.1 jsing 4206: .Op Fl passin Ar arg
4207: .Op Fl pk7out
4208: .Op Fl policy_check
4209: .Op Fl recip Ar file
4210: .Op Fl resign
4211: .Op Fl sign
4212: .Op Fl signer Ar file
4213: .Op Fl stream
4214: .Op Fl subject Ar s
4215: .Op Fl text
4216: .Op Fl to Ar addr
4217: .Op Fl verify
4218: .Op Fl x509_strict
4219: .Op Ar cert.pem ...
4220: .nr nS 0
4221: .Pp
4222: The
4223: .Nm smime
1.70 jmc 4224: command handles S/MIME mail.
4225: It can encrypt, decrypt, sign, and verify S/MIME messages.
4226: .Pp
4227: The MIME message must be sent without any blank lines between the
4228: headers and the output.
4229: Some mail programs will automatically add a blank line.
4230: Piping the mail directly to an MTA is one way to
4231: achieve the correct format.
4232: .Pp
4233: The supplied message to be signed or encrypted must include the necessary
4234: MIME headers or many S/MIME clients won't display it properly (if at all).
4235: Use the
4236: .Fl text
4237: option to automatically add plain text headers.
1.1 jsing 4238: .Pp
1.70 jmc 4239: A
4240: .Qq signed and encrypted
4241: message is one where a signed message is then encrypted.
4242: This can be produced by encrypting an already signed message.
1.1 jsing 4243: .Pp
1.70 jmc 4244: There are a number of operations that can be performed, as follows:
1.1 jsing 4245: .Bl -tag -width "XXXX"
4246: .It Fl decrypt
4247: Decrypt mail using the supplied certificate and private key.
1.70 jmc 4248: The input file is an encrypted mail message in MIME format.
1.1 jsing 4249: The decrypted mail is written to the output file.
4250: .It Fl encrypt
4251: Encrypt mail for the given recipient certificates.
1.70 jmc 4252: The input is the message to be encrypted.
4253: The output file is the encrypted mail, in MIME format.
1.1 jsing 4254: .It Fl pk7out
1.70 jmc 4255: Take an input message and write out a PEM-encoded PKCS#7 structure.
1.1 jsing 4256: .It Fl resign
4257: Resign a message: take an existing message and one or more new signers.
4258: .It Fl sign
4259: Sign mail using the supplied certificate and private key.
1.70 jmc 4260: The input file is the message to be signed.
4261: The signed message, in MIME format, is written to the output file.
1.1 jsing 4262: .It Fl verify
4263: Verify signed mail.
1.70 jmc 4264: The input is a signed mail message and the output is the signed data.
1.1 jsing 4265: Both clear text and opaque signing is supported.
4266: .El
4267: .Pp
1.14 jmc 4268: The remaining options are as follows:
1.1 jsing 4269: .Bl -tag -width "XXXX"
4270: .It Xo
4271: .Fl aes128 | aes192 | aes256 | des |
4272: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4273: .Xc
4274: The encryption algorithm to use.
1.70 jmc 4275: 128-, 192-, or 256-bit AES, DES (56 bits), triple DES (168 bits),
1.1 jsing 4276: or 40-, 64-, or 128-bit RC2, respectively;
4277: if not specified, 40-bit RC2 is
4278: used.
4279: Only used with
4280: .Fl encrypt .
4281: .It Fl binary
4282: Normally, the input message is converted to
4283: .Qq canonical
1.70 jmc 4284: format which uses CR/LF as end of line,
4285: as required by the S/MIME specification.
1.1 jsing 4286: When this option is present no translation occurs.
1.70 jmc 4287: This is useful when handling binary data which may not be in MIME format.
1.1 jsing 4288: .It Fl CAfile Ar file
4289: A
4290: .Ar file
4291: containing trusted CA certificates; only used with
4292: .Fl verify .
4293: .It Fl CApath Ar directory
4294: A
4295: .Ar directory
4296: containing trusted CA certificates; only used with
4297: .Fl verify .
4298: This directory must be a standard certificate directory:
4299: that is, a hash of each subject name (using
4300: .Nm x509 -hash )
4301: should be linked to each certificate.
4302: .It Ar cert.pem ...
4303: One or more certificates of message recipients: used when encrypting
4304: a message.
4305: .It Fl certfile Ar file
4306: Allows additional certificates to be specified.
4307: When signing, these will be included with the message.
4308: When verifying, these will be searched for the signers' certificates.
4309: The certificates should be in PEM format.
4310: .It Xo
4311: .Fl check_ss_sig ,
4312: .Fl crl_check ,
4313: .Fl crl_check_all ,
4314: .Fl extended_crl ,
4315: .Fl ignore_critical ,
4316: .Fl issuer_checks ,
4317: .Fl policy_check ,
4318: .Fl x509_strict
4319: .Xc
4320: Set various certificate chain validation options.
4321: See the
1.70 jmc 4322: .Nm verify
1.1 jsing 4323: command for details.
4324: .It Fl content Ar file
1.70 jmc 4325: A file containing the detached content.
1.1 jsing 4326: This is only useful with the
4327: .Fl verify
1.70 jmc 4328: option,
4329: and only usable if the PKCS#7 structure is using the detached
1.1 jsing 4330: signature form where the content is not included.
1.70 jmc 4331: This option will override any content if the input format is S/MIME
4332: and it uses the multipart/signed MIME content type.
1.1 jsing 4333: .It Xo
4334: .Fl from Ar addr ,
4335: .Fl subject Ar s ,
4336: .Fl to Ar addr
4337: .Xc
4338: The relevant mail headers.
4339: These are included outside the signed
4340: portion of a message so they may be included manually.
1.70 jmc 4341: When signing, many S/MIME
1.1 jsing 4342: mail clients check that the signer's certificate email
4343: address matches the From: address.
4344: .It Fl in Ar file
1.70 jmc 4345: The input file to read from.
1.1 jsing 4346: .It Fl indef
4347: Enable streaming I/O for encoding operations.
4348: This permits single pass processing of data without
4349: the need to hold the entire contents in memory,
4350: potentially supporting very large files.
4351: Streaming is automatically set for S/MIME signing with detached
4352: data if the output format is SMIME;
4353: it is currently off by default for all other operations.
1.70 jmc 4354: .It Fl inform Cm der | pem | smime
4355: The input format.
1.1 jsing 4356: .It Fl inkey Ar file
1.70 jmc 4357: The private key to use when signing or decrypting,
4358: which must match the corresponding certificate.
1.1 jsing 4359: If this option is not specified, the private key must be included
4360: in the certificate file specified with
4361: the
4362: .Fl recip
4363: or
4364: .Fl signer
4365: file.
4366: When signing,
4367: this option can be used multiple times to specify successive keys.
1.70 jmc 4368: .It Fl keyform Cm pem
1.1 jsing 4369: Input private key format.
4370: .It Fl md Ar digest
4371: The digest algorithm to use when signing or resigning.
4372: If not present then the default digest algorithm for the signing key is used
4373: (usually SHA1).
4374: .It Fl noattr
1.70 jmc 4375: Do not include attributes.
1.1 jsing 4376: .It Fl nocerts
1.70 jmc 4377: Do not include the signer's certificate.
1.1 jsing 4378: This will reduce the size of the signed message but the verifier must
4379: have a copy of the signer's certificate available locally (passed using the
4380: .Fl certfile
4381: option, for example).
4382: .It Fl nochain
4383: Do not do chain verification of signers' certificates: that is,
4384: don't use the certificates in the signed message as untrusted CAs.
4385: .It Fl nodetach
4386: When signing a message use opaque signing: this form is more resistant
4387: to translation by mail relays but it cannot be read by mail agents that
1.70 jmc 4388: do not support S/MIME.
4389: Without this option cleartext signing with the MIME type
4390: multipart/signed is used.
1.1 jsing 4391: .It Fl noindef
1.70 jmc 4392: Disable streaming I/O where it would produce an encoding of indefinite length
4393: (currently has no effect).
1.1 jsing 4394: .It Fl nointern
1.70 jmc 4395: Only use certificates specified in the
4396: .Fl certfile .
4397: The supplied certificates can still be used as untrusted CAs.
1.1 jsing 4398: .It Fl nosigs
1.70 jmc 4399: Do not try to verify the signatures on the message.
1.1 jsing 4400: .It Fl noverify
4401: Do not verify the signer's certificate of a signed message.
4402: .It Fl out Ar file
1.70 jmc 4403: The output file to write to.
4404: .It Fl outform Cm der | pem | smime
4405: The output format.
4406: The default is smime, which writes an S/MIME format message.
4407: .Cm pem
1.1 jsing 4408: and
1.70 jmc 4409: .Cm der
4410: change this to write PEM and DER format PKCS#7 structures instead.
1.1 jsing 4411: This currently only affects the output format of the PKCS#7
4412: structure; if no PKCS#7 structure is being output (for example with
4413: .Fl verify
4414: or
4415: .Fl decrypt )
4416: this option has no effect.
4417: .It Fl passin Ar arg
4418: The key password source.
4419: .It Fl recip Ar file
4420: The recipients certificate when decrypting a message.
4421: This certificate
4422: must match one of the recipients of the message or an error occurs.
4423: .It Fl signer Ar file
4424: A signing certificate when signing or resigning a message;
4425: this option can be used multiple times if more than one signer is required.
4426: If a message is being verified, the signer's certificates will be
4427: written to this file if the verification was successful.
4428: .It Fl stream
4429: The same as
4430: .Fl indef .
4431: .It Fl text
1.70 jmc 4432: Add plain text (text/plain) MIME
1.1 jsing 4433: headers to the supplied message if encrypting or signing.
4434: If decrypting or verifying, it strips off text headers:
1.70 jmc 4435: if the decrypted or verified message is not of MIME type text/plain
4436: then an error occurs.
1.1 jsing 4437: .El
4438: .Pp
1.70 jmc 4439: The exit codes for
4440: .Nm smime
4441: are as follows:
1.1 jsing 4442: .Pp
1.70 jmc 4443: .Bl -tag -width "XXXX" -offset 3n -compact
4444: .It 0
1.1 jsing 4445: The operation was completely successful.
1.70 jmc 4446: .It 1
1.1 jsing 4447: An error occurred parsing the command options.
1.70 jmc 4448: .It 2
1.1 jsing 4449: One of the input files could not be read.
1.70 jmc 4450: .It 3
4451: An error occurred creating the file or when reading the message.
4452: .It 4
1.1 jsing 4453: An error occurred decrypting or verifying the message.
1.70 jmc 4454: .It 5
4455: An error occurred writing certificates.
1.1 jsing 4456: .El
4457: .Sh SPEED
4458: .nr nS 1
4459: .Nm "openssl speed"
1.71 jmc 4460: .Op Ar algorithm
1.1 jsing 4461: .Op Fl decrypt
4462: .Op Fl elapsed
1.71 jmc 4463: .Op Fl evp Ar algorithm
1.1 jsing 4464: .Op Fl mr
4465: .Op Fl multi Ar number
4466: .nr nS 0
4467: .Pp
4468: The
4469: .Nm speed
4470: command is used to test the performance of cryptographic algorithms.
4471: .Bl -tag -width "XXXX"
1.71 jmc 4472: .It Ar algorithm
4473: Perform the test using
4474: .Ar algorithm .
4475: The default is to test all algorithms.
1.1 jsing 4476: .It Fl decrypt
1.71 jmc 4477: Time decryption instead of encryption;
4478: must be used with
4479: .Fl evp .
1.1 jsing 4480: .It Fl elapsed
4481: Measure time in real time instead of CPU user time.
1.71 jmc 4482: .It Fl evp Ar algorithm
4483: Perform the test using one of the algorithms accepted by
4484: .Xr EVP_get_cipherbyname 3 .
1.1 jsing 4485: .It Fl mr
4486: Produce machine readable output.
4487: .It Fl multi Ar number
4488: Run
4489: .Ar number
4490: benchmarks in parallel.
4491: .El
1.77 jmc 4492: .Sh SPKAC
4493: .nr nS 1
4494: .Nm "openssl spkac"
4495: .Op Fl challenge Ar string
4496: .Op Fl in Ar file
4497: .Op Fl key Ar keyfile
4498: .Op Fl noout
4499: .Op Fl out Ar file
4500: .Op Fl passin Ar arg
4501: .Op Fl pubkey
4502: .Op Fl spkac Ar spkacname
4503: .Op Fl spksect Ar section
4504: .Op Fl verify
4505: .nr nS 0
4506: .Pp
4507: The
4508: .Nm spkac
4509: command processes signed public key and challenge (SPKAC) files.
4510: It can print out their contents, verify the signature,
4511: and produce its own SPKACs from a supplied private key.
4512: .Pp
4513: The options are as follows:
4514: .Bl -tag -width Ds
4515: .It Fl challenge Ar string
4516: The challenge string, if an SPKAC is being created.
4517: .It Fl in Ar file
4518: The input file to read from,
4519: or standard input if not specified.
4520: Ignored if the
4521: .Fl key
4522: option is used.
4523: .It Fl key Ar keyfile
4524: Create an SPKAC file using the private key in
4525: .Ar keyfile .
4526: The
4527: .Fl in , noout , spksect ,
4528: and
4529: .Fl verify
4530: options are ignored, if present.
4531: .It Fl noout
4532: Do not output the text version of the SPKAC.
4533: .It Fl out Ar file
4534: The output file to write to,
4535: or standard output if not specified.
4536: .It Fl passin Ar arg
4537: The key password source.
4538: .It Fl pubkey
4539: Output the public key of an SPKAC.
4540: .It Fl spkac Ar spkacname
4541: An alternative name for the variable containing the SPKAC.
4542: The default is "SPKAC".
4543: This option affects both generated and input SPKAC files.
4544: .It Fl spksect Ar section
4545: An alternative name for the
4546: .Ar section
4547: containing the SPKAC.
4548: .It Fl verify
4549: Verify the digital signature on the supplied SPKAC.
4550: .El
1.1 jsing 4551: .Sh TS
4552: .nr nS 1
4553: .Nm "openssl ts"
4554: .Fl query
1.29 bcook 4555: .Op Fl md4 | md5 | ripemd160 | sha1
1.1 jsing 4556: .Op Fl cert
4557: .Op Fl config Ar configfile
4558: .Op Fl data Ar file_to_hash
4559: .Op Fl digest Ar digest_bytes
4560: .Op Fl in Ar request.tsq
4561: .Op Fl no_nonce
4562: .Op Fl out Ar request.tsq
4563: .Op Fl policy Ar object_id
4564: .Op Fl text
4565: .nr nS 0
4566: .Pp
4567: .nr nS 1
4568: .Nm "openssl ts"
4569: .Fl reply
4570: .Op Fl chain Ar certs_file.pem
4571: .Op Fl config Ar configfile
4572: .Op Fl in Ar response.tsr
4573: .Op Fl inkey Ar private.pem
4574: .Op Fl out Ar response.tsr
4575: .Op Fl passin Ar arg
4576: .Op Fl policy Ar object_id
4577: .Op Fl queryfile Ar request.tsq
4578: .Op Fl section Ar tsa_section
4579: .Op Fl signer Ar tsa_cert.pem
4580: .Op Fl text
4581: .Op Fl token_in
4582: .Op Fl token_out
4583: .nr nS 0
4584: .Pp
4585: .nr nS 1
4586: .Nm "openssl ts"
4587: .Fl verify
4588: .Op Fl CAfile Ar trusted_certs.pem
4589: .Op Fl CApath Ar trusted_cert_path
4590: .Op Fl data Ar file_to_hash
4591: .Op Fl digest Ar digest_bytes
4592: .Op Fl in Ar response.tsr
4593: .Op Fl queryfile Ar request.tsq
4594: .Op Fl token_in
4595: .Op Fl untrusted Ar cert_file.pem
4596: .nr nS 0
4597: .Pp
4598: The
4599: .Nm ts
4600: command is a basic Time Stamping Authority (TSA) client and server
4601: application as specified in RFC 3161 (Time-Stamp Protocol, TSP).
4602: A TSA can be part of a PKI deployment and its role is to provide long
1.72 jmc 4603: term proof of the existence of specific data.
1.1 jsing 4604: Here is a brief description of the protocol:
4605: .Bl -enum
4606: .It
4607: The TSA client computes a one-way hash value for a data file and sends
4608: the hash to the TSA.
4609: .It
4610: The TSA attaches the current date and time to the received hash value,
4611: signs them and sends the time stamp token back to the client.
4612: By creating this token the TSA certifies the existence of the original
4613: data file at the time of response generation.
4614: .It
4615: The TSA client receives the time stamp token and verifies the
4616: signature on it.
4617: It also checks if the token contains the same hash
4618: value that it had sent to the TSA.
4619: .El
4620: .Pp
4621: There is one DER-encoded protocol data unit defined for transporting a time
4622: stamp request to the TSA and one for sending the time stamp response
4623: back to the client.
4624: The
4625: .Nm ts
4626: command has three main functions:
4627: creating a time stamp request based on a data file;
4628: creating a time stamp response based on a request;
4629: and verifying if a response corresponds
4630: to a particular request or a data file.
4631: .Pp
4632: There is no support for sending the requests/responses automatically
4633: over HTTP or TCP yet as suggested in RFC 3161.
4634: Users must send the requests either by FTP or email.
4635: .Pp
4636: The
4637: .Fl query
4638: switch can be used for creating and printing a time stamp
4639: request with the following options:
4640: .Bl -tag -width Ds
4641: .It Fl cert
1.72 jmc 4642: Expect the TSA to include its signing certificate in the response.
1.1 jsing 4643: .It Fl config Ar configfile
1.72 jmc 4644: Specify an alternative configuration file.
4645: Only the OID section is used.
1.1 jsing 4646: .It Fl data Ar file_to_hash
4647: The data file for which the time stamp request needs to be created.
1.72 jmc 4648: The default is standard input.
1.1 jsing 4649: .It Fl digest Ar digest_bytes
1.72 jmc 4650: Specify the message imprint explicitly without the data file.
1.1 jsing 4651: The imprint must be specified in a hexadecimal format,
4652: two characters per byte,
1.72 jmc 4653: the bytes optionally separated by colons.
1.1 jsing 4654: The number of bytes must match the message digest algorithm in use.
4655: .It Fl in Ar request.tsq
1.72 jmc 4656: A previously created time stamp request in DER
1.1 jsing 4657: format that will be printed into the output file.
1.72 jmc 4658: Useful for examining the content of a request in human-readable format.
1.76 jmc 4659: .It Fl md4 | md5 | ripemd160 | sha | sha1
1.1 jsing 4660: The message digest to apply to the data file.
4661: It supports all the message digest algorithms that are supported by the
4662: .Nm dgst
4663: command.
4664: The default is SHA-1.
4665: .It Fl no_nonce
1.72 jmc 4666: Specify no nonce in the request.
4667: The default, to include a 64-bit long pseudo-random nonce,
4668: is recommended to protect against replay attacks.
1.1 jsing 4669: .It Fl out Ar request.tsq
1.72 jmc 4670: The output file to write to,
4671: or standard output if not specified.
1.1 jsing 4672: .It Fl policy Ar object_id
4673: The policy that the client expects the TSA to use for creating the
4674: time stamp token.
1.72 jmc 4675: Either dotted OID notation or OID names defined
1.1 jsing 4676: in the config file can be used.
1.72 jmc 4677: If no policy is requested the TSA uses its own default policy.
1.1 jsing 4678: .It Fl text
1.72 jmc 4679: Output in human-readable text format instead of DER.
1.1 jsing 4680: .El
4681: .Pp
4682: A time stamp response (TimeStampResp) consists of a response status
4683: and the time stamp token itself (ContentInfo),
4684: if the token generation was successful.
4685: The
4686: .Fl reply
4687: command is for creating a time stamp
4688: response or time stamp token based on a request and printing the
4689: response/token in human-readable format.
4690: If
4691: .Fl token_out
4692: is not specified the output is always a time stamp response (TimeStampResp),
4693: otherwise it is a time stamp token (ContentInfo).
4694: .Bl -tag -width Ds
4695: .It Fl chain Ar certs_file.pem
1.72 jmc 4696: The collection of PEM certificates
1.1 jsing 4697: that will be included in the response
4698: in addition to the signer certificate if the
4699: .Fl cert
4700: option was used for the request.
4701: This file is supposed to contain the certificate chain
4702: for the signer certificate from its issuer upwards.
4703: The
4704: .Fl reply
4705: command does not build a certificate chain automatically.
4706: .It Fl config Ar configfile
1.72 jmc 4707: Specify an alternative configuration file.
1.1 jsing 4708: .It Fl in Ar response.tsr
1.72 jmc 4709: Specify a previously created time stamp response (or time stamp token, if
1.1 jsing 4710: .Fl token_in
1.72 jmc 4711: is also specified)
1.1 jsing 4712: in DER format that will be written to the output file.
4713: This option does not require a request;
4714: it is useful, for example,
1.72 jmc 4715: to examine the content of a response or token
4716: or to extract the time stamp token from a response.
1.1 jsing 4717: If the input is a token and the output is a time stamp response a default
1.72 jmc 4718: .Qq granted
1.1 jsing 4719: status info is added to the token.
4720: .It Fl inkey Ar private.pem
4721: The signer private key of the TSA in PEM format.
4722: Overrides the
4723: .Cm signer_key
4724: config file option.
4725: .It Fl out Ar response.tsr
4726: The response is written to this file.
4727: The format and content of the file depends on other options (see
4728: .Fl text
4729: and
4730: .Fl token_out ) .
4731: The default is stdout.
4732: .It Fl passin Ar arg
4733: The key password source.
4734: .It Fl policy Ar object_id
1.72 jmc 4735: The default policy to use for the response.
4736: Either dotted OID notation or OID names defined
4737: in the config file can be used.
4738: If no policy is requested the TSA uses its own default policy.
1.1 jsing 4739: .It Fl queryfile Ar request.tsq
1.72 jmc 4740: The file containing a DER-encoded time stamp request.
1.1 jsing 4741: .It Fl section Ar tsa_section
1.72 jmc 4742: The config file section containing the settings for response generation.
1.1 jsing 4743: .It Fl signer Ar tsa_cert.pem
1.72 jmc 4744: The PEM signer certificate of the TSA.
1.1 jsing 4745: The TSA signing certificate must have exactly one extended key usage
4746: assigned to it: timeStamping.
4747: The extended key usage must also be critical,
4748: otherwise the certificate is going to be refused.
4749: Overrides the
4750: .Cm signer_cert
4751: variable of the config file.
4752: .It Fl text
1.72 jmc 4753: Output in human-readable text format instead of DER.
1.1 jsing 4754: .It Fl token_in
1.72 jmc 4755: The input is a DER-encoded time stamp token (ContentInfo)
4756: instead of a time stamp response (TimeStampResp).
1.1 jsing 4757: .It Fl token_out
1.72 jmc 4758: The output is a time stamp token (ContentInfo)
4759: instead of a time stamp response (TimeStampResp).
1.1 jsing 4760: .El
4761: .Pp
4762: The
4763: .Fl verify
4764: command is for verifying if a time stamp response or time stamp token
4765: is valid and matches a particular time stamp request or data file.
4766: The
4767: .Fl verify
4768: command does not use the configuration file.
4769: .Bl -tag -width Ds
4770: .It Fl CAfile Ar trusted_certs.pem
1.72 jmc 4771: The file containing a set of trusted self-signed PEM CA certificates.
4772: See
1.1 jsing 4773: .Nm verify
4774: for additional details.
4775: Either this option or
4776: .Fl CApath
4777: must be specified.
4778: .It Fl CApath Ar trusted_cert_path
1.72 jmc 4779: The directory containing the trused CA certificates of the client.
4780: See
1.1 jsing 4781: .Nm verify
4782: for additional details.
4783: Either this option or
4784: .Fl CAfile
4785: must be specified.
4786: .It Fl data Ar file_to_hash
4787: The response or token must be verified against
4788: .Ar file_to_hash .
4789: The file is hashed with the message digest algorithm specified in the token.
4790: The
4791: .Fl digest
4792: and
4793: .Fl queryfile
4794: options must not be specified with this one.
4795: .It Fl digest Ar digest_bytes
4796: The response or token must be verified against the message digest specified
4797: with this option.
4798: The number of bytes must match the message digest algorithm
4799: specified in the token.
4800: The
4801: .Fl data
4802: and
4803: .Fl queryfile
4804: options must not be specified with this one.
4805: .It Fl in Ar response.tsr
4806: The time stamp response that needs to be verified, in DER format.
4807: This option in mandatory.
4808: .It Fl queryfile Ar request.tsq
4809: The original time stamp request, in DER format.
4810: The
4811: .Fl data
4812: and
4813: .Fl digest
4814: options must not be specified with this one.
4815: .It Fl token_in
1.72 jmc 4816: The input is a DER-encoded time stamp token (ContentInfo)
4817: instead of a time stamp response (TimeStampResp).
1.1 jsing 4818: .It Fl untrusted Ar cert_file.pem
1.72 jmc 4819: Additional untrusted PEM certificates which may be needed
4820: when building the certificate chain for the TSA's signing certificate.
1.1 jsing 4821: This file must contain the TSA signing certificate and
4822: all intermediate CA certificates unless the response includes them.
4823: .El
4824: .Pp
1.72 jmc 4825: Options specified on the command line always override
4826: the settings in the config file:
1.1 jsing 4827: .Bl -tag -width Ds
4828: .It Cm tsa Ar section , Cm default_tsa
4829: This is the main section and it specifies the name of another section
4830: that contains all the options for the
4831: .Fl reply
4832: option.
1.72 jmc 4833: This section can be overridden with the
1.1 jsing 4834: .Fl section
4835: command line switch.
4836: .It Cm oid_file
4837: See
4838: .Nm ca
4839: for a description.
4840: .It Cm oid_section
4841: See
4842: .Nm ca
4843: for a description.
4844: .It Cm serial
1.72 jmc 4845: The file containing the hexadecimal serial number of the
1.1 jsing 4846: last time stamp response created.
4847: This number is incremented by 1 for each response.
1.72 jmc 4848: If the file does not exist at the time of response generation
4849: a new file is created with serial number 1.
1.1 jsing 4850: This parameter is mandatory.
4851: .It Cm signer_cert
4852: TSA signing certificate, in PEM format.
4853: The same as the
4854: .Fl signer
4855: command line option.
4856: .It Cm certs
1.72 jmc 4857: A set of PEM-encoded certificates that need to be
1.1 jsing 4858: included in the response.
4859: The same as the
4860: .Fl chain
4861: command line option.
4862: .It Cm signer_key
4863: The private key of the TSA, in PEM format.
4864: The same as the
4865: .Fl inkey
4866: command line option.
4867: .It Cm default_policy
4868: The default policy to use when the request does not mandate any policy.
4869: The same as the
4870: .Fl policy
4871: command line option.
4872: .It Cm other_policies
4873: Comma separated list of policies that are also acceptable by the TSA
4874: and used only if the request explicitly specifies one of them.
4875: .It Cm digests
4876: The list of message digest algorithms that the TSA accepts.
4877: At least one algorithm must be specified.
4878: This parameter is mandatory.
4879: .It Cm accuracy
4880: The accuracy of the time source of the TSA in seconds, milliseconds
4881: and microseconds.
4882: For example, secs:1, millisecs:500, microsecs:100.
4883: If any of the components is missing,
4884: zero is assumed for that field.
4885: .It Cm clock_precision_digits
1.72 jmc 4886: The maximum number of digits, which represent the fraction of seconds,
4887: that need to be included in the time field.
1.1 jsing 4888: The trailing zeroes must be removed from the time,
1.72 jmc 4889: so there might actually be fewer digits
1.1 jsing 4890: or no fraction of seconds at all.
4891: The maximum value is 6;
4892: the default is 0.
4893: .It Cm ordering
4894: If this option is yes,
4895: the responses generated by this TSA can always be ordered,
4896: even if the time difference between two responses is less
4897: than the sum of their accuracies.
4898: The default is no.
4899: .It Cm tsa_name
4900: Set this option to yes if the subject name of the TSA must be included in
4901: the TSA name field of the response.
4902: The default is no.
4903: .It Cm ess_cert_id_chain
4904: The SignedData objects created by the TSA always contain the
4905: certificate identifier of the signing certificate in a signed
4906: attribute (see RFC 2634, Enhanced Security Services).
4907: If this option is set to yes and either the
4908: .Cm certs
4909: variable or the
4910: .Fl chain
4911: option is specified then the certificate identifiers of the chain will also
4912: be included in the SigningCertificate signed attribute.
4913: If this variable is set to no,
4914: only the signing certificate identifier is included.
4915: The default is no.
4916: .El
4917: .Sh VERIFY
4918: .nr nS 1
4919: .Nm "openssl verify"
4920: .Op Fl CAfile Ar file
4921: .Op Fl CApath Ar directory
4922: .Op Fl check_ss_sig
4923: .Op Fl crl_check
4924: .Op Fl crl_check_all
4925: .Op Fl explicit_policy
4926: .Op Fl extended_crl
4927: .Op Fl help
4928: .Op Fl ignore_critical
4929: .Op Fl inhibit_any
4930: .Op Fl inhibit_map
4931: .Op Fl issuer_checks
4932: .Op Fl policy_check
4933: .Op Fl purpose Ar purpose
4934: .Op Fl untrusted Ar file
4935: .Op Fl verbose
4936: .Op Fl x509_strict
4937: .Op Ar certificates
4938: .nr nS 0
4939: .Pp
4940: The
4941: .Nm verify
4942: command verifies certificate chains.
4943: .Pp
4944: The options are as follows:
4945: .Bl -tag -width Ds
4946: .It Fl check_ss_sig
4947: Verify the signature on the self-signed root CA.
4948: This is disabled by default
4949: because it doesn't add any security.
4950: .It Fl CAfile Ar file
4951: A
4952: .Ar file
4953: of trusted certificates.
4954: The
4955: .Ar file
4956: should contain multiple certificates in PEM format, concatenated together.
4957: .It Fl CApath Ar directory
4958: A
4959: .Ar directory
4960: of trusted certificates.
1.76 jmc 4961: The certificates, or symbolic links to them,
4962: should have names of the form
4963: .Ar hash Ns .0 ,
4964: where
4965: .Ar hash
4966: is the hashed certificate subject name
4967: (see the
1.1 jsing 4968: .Fl hash
4969: option of the
4970: .Nm x509
4971: utility).
4972: .It Fl crl_check
1.76 jmc 4973: Check end entity certificate validity by attempting to look up a valid CRL.
1.1 jsing 4974: If a valid CRL cannot be found an error occurs.
4975: .It Fl crl_check_all
1.76 jmc 4976: Check the validity of all certificates in the chain by attempting
1.1 jsing 4977: to look up valid CRLs.
4978: .It Fl explicit_policy
1.76 jmc 4979: Set policy variable require-explicit-policy (RFC 3280).
1.1 jsing 4980: .It Fl extended_crl
4981: Enable extended CRL features such as indirect CRLs and alternate CRL
4982: signing keys.
4983: .It Fl help
1.76 jmc 4984: Print a usage message.
1.1 jsing 4985: .It Fl ignore_critical
1.76 jmc 4986: Ignore critical extensions instead of rejecting the certificate.
1.1 jsing 4987: .It Fl inhibit_any
1.76 jmc 4988: Set policy variable inhibit-any-policy (RFC 3280).
1.1 jsing 4989: .It Fl inhibit_map
1.76 jmc 4990: Set policy variable inhibit-policy-mapping (RFC 3280).
1.1 jsing 4991: .It Fl issuer_checks
1.76 jmc 4992: Print diagnostics relating to searches for the issuer certificate
4993: of the current certificate
4994: showing why each candidate issuer certificate was rejected.
4995: The presence of rejection messages
4996: does not itself imply that anything is wrong:
4997: during the normal verify process several rejections may take place.
1.1 jsing 4998: .It Fl policy_check
1.76 jmc 4999: Enable certificate policy processing.
1.1 jsing 5000: .It Fl purpose Ar purpose
5001: The intended use for the certificate.
5002: Without this option no chain verification will be done.
5003: Currently accepted uses are
1.76 jmc 5004: .Cm sslclient , sslserver ,
5005: .Cm nssslserver , smimesign ,
5006: .Cm smimeencrypt , crlsign ,
5007: .Cm any ,
1.1 jsing 5008: and
1.76 jmc 5009: .Cm ocsphelper .
1.1 jsing 5010: .It Fl untrusted Ar file
5011: A
5012: .Ar file
5013: of untrusted certificates.
5014: The
5015: .Ar file
5016: should contain multiple certificates.
5017: .It Fl verbose
5018: Print extra information about the operations being performed.
5019: .It Fl x509_strict
5020: Disable workarounds for broken certificates which have to be disabled
5021: for strict X.509 compliance.
5022: .It Ar certificates
1.76 jmc 5023: One or more PEM
1.1 jsing 5024: .Ar certificates
5025: to verify.
5026: If no certificate files are included, an attempt is made to read
5027: a certificate from standard input.
1.76 jmc 5028: If the first certificate filename begins with a dash,
5029: use a lone dash to mark the last option.
1.1 jsing 5030: .El
1.76 jmc 5031: .Pp
1.1 jsing 5032: The
5033: .Nm verify
5034: program uses the same functions as the internal SSL and S/MIME verification,
1.76 jmc 5035: with one crucial difference:
5036: wherever possible an attempt is made to continue after an error,
5037: whereas normally the verify operation would halt on the first error.
1.1 jsing 5038: This allows all the problems with a certificate chain to be determined.
5039: .Pp
1.76 jmc 5040: The verify operation consists of a number of separate steps.
1.1 jsing 5041: Firstly a certificate chain is built up starting from the supplied certificate
5042: and ending in the root CA.
5043: It is an error if the whole chain cannot be built up.
5044: The chain is built up by looking up the issuer's certificate of the current
5045: certificate.
5046: If a certificate is found which is its own issuer, it is assumed
5047: to be the root CA.
5048: .Pp
1.76 jmc 5049: All certificates whose subject name matches the issuer name
1.1 jsing 5050: of the current certificate are subject to further tests.
5051: The relevant authority key identifier components of the current certificate
1.76 jmc 5052: (if present) must match the subject key identifier (if present)
5053: and issuer and serial number of the candidate issuer;
5054: in addition the
5055: .Cm keyUsage
5056: extension of the candidate issuer (if present) must permit certificate signing.
1.1 jsing 5057: .Pp
5058: The lookup first looks in the list of untrusted certificates and if no match
5059: is found the remaining lookups are from the trusted certificates.
1.76 jmc 5060: The root CA is always looked up in the trusted certificate list:
5061: if the certificate to verify is a root certificate,
5062: then an exact match must be found in the trusted list.
1.1 jsing 5063: .Pp
5064: The second operation is to check every untrusted certificate's extensions for
5065: consistency with the supplied purpose.
5066: If the
5067: .Fl purpose
5068: option is not included, then no checks are done.
5069: The supplied or
5070: .Qq leaf
5071: certificate must have extensions compatible with the supplied purpose
5072: and all other certificates must also be valid CA certificates.
5073: The precise extensions required are described in more detail in
5074: the
1.76 jmc 5075: .Nm X509
1.1 jsing 5076: section below.
5077: .Pp
5078: The third operation is to check the trust settings on the root CA.
5079: The root CA should be trusted for the supplied purpose.
1.76 jmc 5080: A certificate with no trust settings is considered to be valid for
1.1 jsing 5081: all purposes.
5082: .Pp
5083: The final operation is to check the validity of the certificate chain.
5084: The validity period is checked against the current system time and the
1.76 jmc 5085: .Cm notBefore
1.1 jsing 5086: and
1.76 jmc 5087: .Cm notAfter
1.1 jsing 5088: dates in the certificate.
5089: The certificate signatures are also checked at this point.
5090: .Pp
5091: If all operations complete successfully, the certificate is considered
5092: valid.
5093: If any operation fails then the certificate is not valid.
5094: When a verify operation fails, the output messages can be somewhat cryptic.
5095: The general form of the error message is:
1.76 jmc 5096: .Bd -literal
5097: server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024-bit)
5098: error 24 at 1 depth lookup:invalid CA certificate
1.1 jsing 5099: .Ed
5100: .Pp
5101: The first line contains the name of the certificate being verified, followed by
5102: the subject name of the certificate.
5103: The second line contains the error number and the depth.
5104: The depth is the number of the certificate being verified when a
5105: problem was detected starting with zero for the certificate being verified
5106: itself, then 1 for the CA that signed the certificate and so on.
5107: Finally a text version of the error number is presented.
5108: .Pp
5109: An exhaustive list of the error codes and messages is shown below; this also
5110: includes the name of the error code as defined in the header file
1.12 bentley 5111: .In openssl/x509_vfy.h .
1.76 jmc 5112: Some of the error codes are defined but never returned: these are described as
1.1 jsing 5113: .Qq unused .
5114: .Bl -tag -width "XXXX"
1.78 jmc 5115: .It 0 X509_V_OK
1.1 jsing 5116: The operation was successful.
1.78 jmc 5117: .It 2 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
5118: The issuer certificate of an untrusted certificate could not be found.
5119: .It 3 X509_V_ERR_UNABLE_TO_GET_CRL
1.1 jsing 5120: The CRL of a certificate could not be found.
1.78 jmc 5121: .It 4 X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE
1.1 jsing 5122: The certificate signature could not be decrypted.
1.78 jmc 5123: This means that the actual signature value could not be determined
5124: rather than it not matching the expected value.
1.1 jsing 5125: This is only meaningful for RSA keys.
1.78 jmc 5126: .It 5 X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE
5127: The CRL signature could not be decrypted.
5128: This means that the actual signature value could not be determined
5129: rather than it not matching the expected value.
1.1 jsing 5130: Unused.
1.78 jmc 5131: .It 6 X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY
1.1 jsing 5132: The public key in the certificate
1.76 jmc 5133: .Cm SubjectPublicKeyInfo
1.1 jsing 5134: could not be read.
1.78 jmc 5135: .It 7 X509_V_ERR_CERT_SIGNATURE_FAILURE
1.1 jsing 5136: The signature of the certificate is invalid.
1.78 jmc 5137: .It 8 X509_V_ERR_CRL_SIGNATURE_FAILURE
1.1 jsing 5138: The signature of the certificate is invalid.
1.78 jmc 5139: .It 9 X509_V_ERR_CERT_NOT_YET_VALID
1.1 jsing 5140: The certificate is not yet valid: the
1.76 jmc 5141: .Cm notBefore
1.1 jsing 5142: date is after the current time.
1.78 jmc 5143: .It 10 X509_V_ERR_CERT_HAS_EXPIRED
1.1 jsing 5144: The certificate has expired; that is, the
1.76 jmc 5145: .Cm notAfter
1.1 jsing 5146: date is before the current time.
1.78 jmc 5147: .It 11 X509_V_ERR_CRL_NOT_YET_VALID
1.1 jsing 5148: The CRL is not yet valid.
1.78 jmc 5149: .It 12 X509_V_ERR_CRL_HAS_EXPIRED
1.1 jsing 5150: The CRL has expired.
1.78 jmc 5151: .It 13 X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
1.1 jsing 5152: The certificate
1.76 jmc 5153: .Cm notBefore
1.1 jsing 5154: field contains an invalid time.
1.78 jmc 5155: .It 14 X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
1.1 jsing 5156: The certificate
1.76 jmc 5157: .Cm notAfter
1.1 jsing 5158: field contains an invalid time.
1.78 jmc 5159: .It 15 X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD
1.1 jsing 5160: The CRL
1.76 jmc 5161: .Cm lastUpdate
1.1 jsing 5162: field contains an invalid time.
1.78 jmc 5163: .It 16 X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD
1.1 jsing 5164: The CRL
1.76 jmc 5165: .Cm nextUpdate
1.1 jsing 5166: field contains an invalid time.
1.78 jmc 5167: .It 17 X509_V_ERR_OUT_OF_MEM
1.1 jsing 5168: An error occurred trying to allocate memory.
5169: This should never happen.
1.78 jmc 5170: .It 18 X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
1.1 jsing 5171: The passed certificate is self-signed and the same certificate cannot be
5172: found in the list of trusted certificates.
1.78 jmc 5173: .It 19 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
1.1 jsing 5174: The certificate chain could be built up using the untrusted certificates but
5175: the root could not be found locally.
1.78 jmc 5176: .It 20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
1.1 jsing 5177: The issuer certificate of a locally looked up certificate could not be found.
5178: This normally means the list of trusted certificates is not complete.
1.78 jmc 5179: .It 21 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
1.1 jsing 5180: No signatures could be verified because the chain contains only one
5181: certificate and it is not self-signed.
1.78 jmc 5182: .It 22 X509_V_ERR_CERT_CHAIN_TOO_LONG
1.1 jsing 5183: The certificate chain length is greater than the supplied maximum depth.
5184: Unused.
1.78 jmc 5185: .It 23 X509_V_ERR_CERT_REVOKED
1.1 jsing 5186: The certificate has been revoked.
1.78 jmc 5187: .It 24 X509_V_ERR_INVALID_CA
1.1 jsing 5188: A CA certificate is invalid.
5189: Either it is not a CA or its extensions are not consistent
5190: with the supplied purpose.
1.78 jmc 5191: .It 25 X509_V_ERR_PATH_LENGTH_EXCEEDED
1.1 jsing 5192: The
1.76 jmc 5193: .Cm basicConstraints
1.1 jsing 5194: pathlength parameter has been exceeded.
1.78 jmc 5195: .It 26 X509_V_ERR_INVALID_PURPOSE
1.1 jsing 5196: The supplied certificate cannot be used for the specified purpose.
1.78 jmc 5197: .It 27 X509_V_ERR_CERT_UNTRUSTED
1.1 jsing 5198: The root CA is not marked as trusted for the specified purpose.
1.78 jmc 5199: .It 28 X509_V_ERR_CERT_REJECTED
1.1 jsing 5200: The root CA is marked to reject the specified purpose.
1.78 jmc 5201: .It 29 X509_V_ERR_SUBJECT_ISSUER_MISMATCH
1.1 jsing 5202: The current candidate issuer certificate was rejected because its subject name
5203: did not match the issuer name of the current certificate.
5204: Only displayed when the
5205: .Fl issuer_checks
5206: option is set.
1.78 jmc 5207: .It 30 X509_V_ERR_AKID_SKID_MISMATCH
1.1 jsing 5208: The current candidate issuer certificate was rejected because its subject key
5209: identifier was present and did not match the authority key identifier current
5210: certificate.
5211: Only displayed when the
5212: .Fl issuer_checks
5213: option is set.
1.78 jmc 5214: .It 31 X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH
1.1 jsing 5215: The current candidate issuer certificate was rejected because its issuer name
5216: and serial number were present and did not match the authority key identifier
5217: of the current certificate.
5218: Only displayed when the
5219: .Fl issuer_checks
5220: option is set.
1.78 jmc 5221: .It 32 X509_V_ERR_KEYUSAGE_NO_CERTSIGN
1.1 jsing 5222: The current candidate issuer certificate was rejected because its
1.76 jmc 5223: .Cm keyUsage
1.1 jsing 5224: extension does not permit certificate signing.
1.78 jmc 5225: .It 50 X509_V_ERR_APPLICATION_VERIFICATION
1.1 jsing 5226: An application specific error.
5227: Unused.
5228: .El
5229: .Sh VERSION
5230: .Nm openssl version
5231: .Op Fl abdfopv
5232: .Pp
5233: The
5234: .Nm version
5235: command is used to print out version information about
1.79 jmc 5236: .Nm openssl .
1.1 jsing 5237: .Pp
5238: The options are as follows:
5239: .Bl -tag -width Ds
5240: .It Fl a
5241: All information: this is the same as setting all the other flags.
5242: .It Fl b
5243: The date the current version of
1.79 jmc 5244: .Nm openssl
1.1 jsing 5245: was built.
5246: .It Fl d
5247: .Ev OPENSSLDIR
5248: setting.
5249: .It Fl f
5250: Compilation flags.
5251: .It Fl o
5252: Option information: various options set when the library was built.
5253: .It Fl p
5254: Platform setting.
5255: .It Fl v
5256: The current
1.79 jmc 5257: .Nm openssl
1.1 jsing 5258: version.
5259: .El
5260: .Sh X509
5261: .nr nS 1
5262: .Nm "openssl x509"
5263: .Op Fl C
5264: .Op Fl addreject Ar arg
5265: .Op Fl addtrust Ar arg
5266: .Op Fl alias
5267: .Op Fl CA Ar file
5268: .Op Fl CAcreateserial
1.80 jmc 5269: .Op Fl CAform Cm der | pem
1.1 jsing 5270: .Op Fl CAkey Ar file
1.80 jmc 5271: .Op Fl CAkeyform Cm der | pem
1.1 jsing 5272: .Op Fl CAserial Ar file
5273: .Op Fl certopt Ar option
5274: .Op Fl checkend Ar arg
5275: .Op Fl clrext
5276: .Op Fl clrreject
5277: .Op Fl clrtrust
5278: .Op Fl dates
5279: .Op Fl days Ar arg
5280: .Op Fl email
5281: .Op Fl enddate
5282: .Op Fl extensions Ar section
5283: .Op Fl extfile Ar file
5284: .Op Fl fingerprint
5285: .Op Fl hash
5286: .Op Fl in Ar file
1.80 jmc 5287: .Op Fl inform Cm der | net | pem
1.1 jsing 5288: .Op Fl issuer
5289: .Op Fl issuer_hash
5290: .Op Fl issuer_hash_old
1.80 jmc 5291: .Op Fl keyform Cm der | pem
1.29 bcook 5292: .Op Fl md5 | sha1
1.1 jsing 5293: .Op Fl modulus
5294: .Op Fl nameopt Ar option
5295: .Op Fl noout
5296: .Op Fl ocsp_uri
5297: .Op Fl ocspid
5298: .Op Fl out Ar file
1.80 jmc 5299: .Op Fl outform Cm der | net | pem
1.1 jsing 5300: .Op Fl passin Ar arg
5301: .Op Fl pubkey
5302: .Op Fl purpose
5303: .Op Fl req
5304: .Op Fl serial
5305: .Op Fl set_serial Ar n
5306: .Op Fl setalias Ar arg
5307: .Op Fl signkey Ar file
5308: .Op Fl startdate
5309: .Op Fl subject
5310: .Op Fl subject_hash
5311: .Op Fl subject_hash_old
5312: .Op Fl text
5313: .Op Fl trustout
5314: .Op Fl x509toreq
5315: .nr nS 0
5316: .Pp
5317: The
5318: .Nm x509
5319: command is a multi-purpose certificate utility.
5320: It can be used to display certificate information, convert certificates to
5321: various forms, sign certificate requests like a
5322: .Qq mini CA ,
5323: or edit certificate trust settings.
5324: .Pp
1.80 jmc 5325: The following are x509 input, output, and general purpose options:
1.1 jsing 5326: .Bl -tag -width "XXXX"
5327: .It Fl in Ar file
1.80 jmc 5328: The input file to read from,
5329: or standard input if not specified.
5330: .It Fl inform Cm der | net | pem
5331: The input format.
1.1 jsing 5332: Normally, the command will expect an X.509 certificate,
5333: but this can change if other options such as
5334: .Fl req
5335: are present.
1.29 bcook 5336: .It Fl md5 | sha1
1.1 jsing 5337: The digest to use.
5338: This affects any signing or display option that uses a message digest,
5339: such as the
5340: .Fl fingerprint , signkey ,
5341: and
5342: .Fl CA
5343: options.
5344: If not specified, MD5 is used.
1.80 jmc 5345: SHA1 is always used with DSA keys.
1.1 jsing 5346: .It Fl out Ar file
1.80 jmc 5347: The output file to write to,
5348: or standard output if none is specified.
5349: .It Fl outform Cm der | net | pem
5350: The output format.
1.1 jsing 5351: .It Fl passin Ar arg
5352: The key password source.
5353: .El
1.80 jmc 5354: .Pp
5355: The following are x509 display options:
1.1 jsing 5356: .Bl -tag -width "XXXX"
5357: .It Fl C
1.80 jmc 5358: Output the certificate in the form of a C source file.
1.1 jsing 5359: .It Fl certopt Ar option
5360: Customise the output format used with
1.80 jmc 5361: .Fl text ,
5362: either using a list of comma-separated options or by specifying
1.1 jsing 5363: .Fl certopt
1.80 jmc 5364: multiple times.
5365: The default behaviour is to print all fields.
5366: The options are as follows:
5367: .Pp
5368: .Bl -tag -width "no_extensions" -offset indent -compact
5369: .It Cm ca_default
5370: Equivalent to
5371: .Cm no_issuer , no_pubkey , no_header ,
5372: .Cm no_version , no_sigdump ,
5373: and
5374: .Cm no_signame .
5375: .It Cm compatible
5376: Equivalent to no output options at all.
5377: .It Cm ext_default
5378: Print unsupported certificate extensions.
5379: .It Cm ext_dump
5380: Hex dump unsupported extensions.
5381: .It Cm ext_error
5382: Print an error message for unsupported certificate extensions.
5383: .It Cm ext_parse
1.84 jmc 5384: ASN.1 parse unsupported extensions.
1.80 jmc 5385: .It Cm no_aux
5386: Do not print certificate trust information.
5387: .It Cm no_extensions
5388: Do not print X509V3 extensions.
5389: .It Cm no_header
5390: Do not print header (Certificate and Data) information.
5391: .It Cm no_issuer
5392: Do not print the issuer name.
5393: .It Cm no_pubkey
5394: Do not print the public key.
5395: .It Cm no_serial
5396: Do not print the serial number.
5397: .It Cm no_sigdump
5398: Do not give a hexadecimal dump of the certificate signature.
5399: .It Cm no_signame
5400: Do not print the signature algorithm used.
5401: .It Cm no_subject
5402: Do not print the subject name.
5403: .It Cm no_validity
5404: Do not print the
5405: .Cm notBefore
5406: and
5407: .Cm notAfter
5408: (validity) fields.
5409: .It Cm no_version
5410: Do not print the version number.
5411: .El
1.1 jsing 5412: .It Fl dates
1.80 jmc 5413: Print the start and expiry date of a certificate.
1.1 jsing 5414: .It Fl email
1.80 jmc 5415: Output the email addresses, if any.
1.1 jsing 5416: .It Fl enddate
1.80 jmc 5417: Print the expiry date of the certificate; that is, the
5418: .Cm notAfter
1.1 jsing 5419: date.
5420: .It Fl fingerprint
1.80 jmc 5421: Print the digest of the DER-encoded version of the whole certificate.
1.1 jsing 5422: .It Fl hash
5423: A synonym for
1.80 jmc 5424: .Fl subject_hash .
1.1 jsing 5425: .It Fl issuer
1.80 jmc 5426: Print the issuer name.
1.1 jsing 5427: .It Fl issuer_hash
1.80 jmc 5428: Print the hash of the certificate issuer name.
1.1 jsing 5429: .It Fl issuer_hash_old
1.80 jmc 5430: Print the hash of the certificate issuer name
5431: using the older algorithm as used by
5432: .Nm openssl
1.1 jsing 5433: versions before 1.0.0.
5434: .It Fl modulus
1.80 jmc 5435: Print the value of the modulus of the public key contained in the certificate.
1.1 jsing 5436: .It Fl nameopt Ar option
1.80 jmc 5437: Customise how the subject or issuer names are displayed,
5438: either using a list of comma-separated options or by specifying
1.1 jsing 5439: .Fl nameopt
1.80 jmc 5440: multiple times.
5441: The default behaviour is to use the
5442: .Cm oneline
5443: format.
5444: The options,
5445: which can be preceded by a dash to turn them off,
5446: are as follows:
5447: .Bl -tag -width "XXXX"
5448: .It Cm align
5449: Align field values for a more readable output.
5450: Only usable with
5451: .Ar sep_multiline .
5452: .It Cm compat
5453: Use the old format,
5454: equivalent to specifying no options at all.
5455: .It Cm dn_rev
5456: Reverse the fields of the DN, as required by RFC 2253.
5457: As a side effect, this also reverses the order of multiple AVAs.
5458: .It Cm dump_all
5459: Dump all fields.
5460: When used with
5461: .Ar dump_der ,
5462: it allows the DER encoding of the structure to be unambiguously determined.
5463: .It Cm dump_der
5464: Any fields that need to be hexdumped are
5465: dumped using the DER encoding of the field.
5466: Otherwise just the content octets will be displayed.
5467: Both options use the RFC 2253 #XXXX... format.
5468: .It Cm dump_nostr
5469: Dump non-character string types
5470: (for example OCTET STRING);
5471: usually, non-character string types are displayed
5472: as though each content octet represents a single character.
5473: .It Cm dump_unknown
5474: Dump any field whose OID is not recognised by
5475: .Nm openssl .
5476: .It Cm esc_2253
5477: Escape the
5478: .Qq special
5479: characters required by RFC 2253 in a field that is
5480: .Dq \& ,+"<>; .
5481: Additionally,
5482: .Sq #
5483: is escaped at the beginning of a string
5484: and a space character at the beginning or end of a string.
5485: .It Cm esc_ctrl
5486: Escape control characters.
5487: That is, those with ASCII values less than 0x20 (space)
5488: and the delete (0x7f) character.
5489: They are escaped using the RFC 2253 \eXX notation (where XX are two hex
5490: digits representing the character value).
5491: .It Cm esc_msb
5492: Escape characters with the MSB set; that is, with ASCII values larger than
5493: 127.
5494: .It Cm multiline
5495: A multiline format.
5496: Equivalent to
5497: .Cm esc_ctrl , esc_msb , sep_multiline ,
5498: .Cm space_eq , lname ,
5499: and
5500: .Cm align .
5501: .It Cm no_type
5502: Do not attempt to interpret multibyte characters.
5503: That is, content octets are merely dumped as though one octet
5504: represents each character.
5505: This is useful for diagnostic purposes
5506: but results in rather odd looking output.
5507: .It Cm nofname , sname , lname , oid
5508: Alter how the field name is displayed:
5509: .Cm nofname
5510: does not display the field at all;
5511: .Cm sname
5512: uses the short name form (CN for
5513: .Cm commonName ,
5514: for example);
5515: .Cm lname
5516: uses the long form.
5517: .Cm oid
5518: represents the OID in numerical form and is useful for diagnostic purpose.
5519: .It Cm oneline
5520: A one line format which is more readable than
5521: .Cm RFC2253 .
5522: Equivalent to
5523: .Cm esc_2253 , esc_ctrl , esc_msb , utf8 ,
5524: .Cm dump_nostr , dump_der , use_quote , sep_comma_plus_spc ,
5525: .Cm space_eq ,
5526: and
5527: .Cm sname .
5528: .It Cm RFC2253
5529: Displays names compatible with RFC 2253.
5530: Equivalent to
5531: .Cm esc_2253 , esc_ctrl ,
5532: .Cm esc_msb , utf8 , dump_nostr , dump_unknown ,
5533: .Cm dump_der , sep_comma_plus , dn_rev ,
5534: and
5535: .Cm sname .
5536: .It Cm sep_comma_plus , sep_comma_plus_space , sep_semi_plus_space , sep_multiline
5537: Determine the field separators:
5538: the first character is between RDNs and the second between multiple AVAs
5539: (multiple AVAs are very rare and their use is discouraged).
5540: The options ending in
5541: .Qq space
5542: additionally place a space after the separator to make it more readable.
5543: .Cm sep_multiline
5544: uses a linefeed character for the RDN separator and a spaced
5545: .Sq +
5546: for the AVA separator,
5547: as well as indenting the fields by four characters.
5548: .It Cm show_type
1.84 jmc 5549: Show the type of the ASN.1 character string.
1.80 jmc 5550: The type precedes the field contents.
5551: For example
5552: .Qq BMPSTRING: Hello World .
5553: .It Cm space_eq
5554: Place spaces round the
5555: .Sq =
5556: character which follows the field name.
5557: .It Cm use_quote
5558: Escape some characters by surrounding the whole string with
5559: .Sq \&"
5560: characters.
5561: Without the option, all escaping is done with the
5562: .Sq \e
5563: character.
5564: .It Cm utf8
5565: Convert all strings to UTF8 format first, as required by RFC 2253.
5566: On a UTF8 compatible terminal,
5567: the use of this option (and not setting
5568: .Cm esc_msb )
5569: may result in the correct display of multibyte characters.
5570: Usually, multibyte characters larger than 0xff
5571: are represented using the format \eUXXXX for 16 bits and \eWXXXXXXXX
5572: for 32 bits,
5573: and any UTF8Strings are converted to their character form first.
5574: .El
1.1 jsing 5575: .It Fl noout
1.80 jmc 5576: Do not output the encoded version of the request.
1.1 jsing 5577: .It Fl ocsp_uri
1.80 jmc 5578: Print the OCSP responder addresses, if any.
1.1 jsing 5579: .It Fl ocspid
5580: Print OCSP hash values for the subject name and public key.
5581: .It Fl pubkey
1.80 jmc 5582: Print the public key.
1.1 jsing 5583: .It Fl serial
1.80 jmc 5584: Print the certificate serial number.
1.1 jsing 5585: .It Fl startdate
1.80 jmc 5586: Print the start date of the certificate; that is, the
5587: .Cm notBefore
1.1 jsing 5588: date.
5589: .It Fl subject
1.80 jmc 5590: Print the subject name.
1.1 jsing 5591: .It Fl subject_hash
1.80 jmc 5592: Print the hash of the certificate subject name.
1.1 jsing 5593: This is used in
1.80 jmc 5594: .Nm openssl
1.1 jsing 5595: to form an index to allow certificates in a directory to be looked up
5596: by subject name.
5597: .It Fl subject_hash_old
1.80 jmc 5598: Print the hash of the certificate subject name
5599: using the older algorithm as used by
5600: .Nm openssl
1.1 jsing 5601: versions before 1.0.0.
5602: .It Fl text
1.80 jmc 5603: Print the full certificate in text form.
1.1 jsing 5604: .El
5605: .Pp
1.80 jmc 5606: A trusted certificate is a certificate which has several
1.1 jsing 5607: additional pieces of information attached to it such as the permitted
1.80 jmc 5608: and prohibited uses of the certificate and an alias.
5609: When a certificate is being verified at least one certificate must be trusted.
5610: By default, a trusted certificate must be stored locally and be a root CA.
5611: The following are x509 trust settings options:
1.1 jsing 5612: .Bl -tag -width "XXXX"
5613: .It Fl addreject Ar arg
1.80 jmc 5614: Add a prohibited use.
5615: Accepts the same values as the
1.1 jsing 5616: .Fl addtrust
5617: option.
5618: .It Fl addtrust Ar arg
1.80 jmc 5619: Add a trusted certificate use.
1.1 jsing 5620: Any object name can be used here, but currently only
1.80 jmc 5621: .Cm clientAuth
5622: (SSL client use),
5623: .Cm serverAuth
5624: (SSL server use),
5625: and
5626: .Cm emailProtection
5627: (S/MIME email) are used.
1.1 jsing 5628: .It Fl alias
1.80 jmc 5629: Output the certificate alias.
1.1 jsing 5630: .It Fl clrreject
1.80 jmc 5631: Clear all the prohibited or rejected uses of the certificate.
1.1 jsing 5632: .It Fl clrtrust
1.80 jmc 5633: Clear all the permitted or trusted uses of the certificate.
1.1 jsing 5634: .It Fl purpose
1.80 jmc 5635: Perform tests on the certificate extensions.
5636: The same code is used when verifying untrusted certificates in chains,
5637: so this section is useful if a chain is rejected by the verify code.
5638: .Pp
5639: The
5640: .Cm basicConstraints
5641: extension CA flag is used to determine whether the
5642: certificate can be used as a CA.
5643: If the CA flag is true, it is a CA;
5644: if the CA flag is false, it is not a CA.
5645: All CAs should have the CA flag set to true.
5646: .Pp
5647: If the
5648: .Cm basicConstraints
5649: extension is absent, then the certificate is
5650: considered to be a possible CA;
5651: other extensions are checked according to the intended use of the certificate.
5652: A warning is given in this case because the certificate should really not
5653: be regarded as a CA.
5654: However it is allowed to be a CA to work around some broken software.
5655: .Pp
5656: If the certificate is a V1 certificate
5657: (and thus has no extensions) and it is self-signed,
5658: it is also assumed to be a CA but a warning is again given.
5659: This is to work around the problem of Verisign roots
5660: which are V1 self-signed certificates.
5661: .Pp
5662: If the
5663: .Cm keyUsage
5664: extension is present, then additional restraints are
5665: made on the uses of the certificate.
5666: A CA certificate must have the
5667: .Cm keyCertSign
5668: bit set if the
5669: .Cm keyUsage
5670: extension is present.
5671: .Pp
5672: The extended key usage extension places additional restrictions on the
5673: certificate uses.
5674: If this extension is present, whether critical or not,
5675: the key can only be used for the purposes specified.
5676: .Pp
5677: A complete description of each test is given below.
5678: The comments about
5679: .Cm basicConstraints
5680: and
5681: .Cm keyUsage
5682: and V1 certificates above apply to all CA certificates.
5683: .Bl -tag -width "XXXX"
5684: .It SSL Client
5685: The extended key usage extension must be absent or include the
5686: web client authentication OID.
5687: .Cm keyUsage
5688: must be absent or it must have the
5689: .Cm digitalSignature
5690: bit set.
5691: The Netscape certificate type must be absent
5692: or it must have the SSL client bit set.
5693: .It SSL Client CA
5694: The extended key usage extension must be absent or include the
5695: web client authentication OID.
5696: The Netscape certificate type must be absent
5697: or it must have the SSL CA bit set:
5698: this is used as a workaround if the
5699: .Cm basicConstraints
5700: extension is absent.
5701: .It SSL Server
5702: The extended key usage extension must be absent or include the
5703: web server authentication and/or one of the SGC OIDs.
5704: .Cm keyUsage
5705: must be absent or it must have the
5706: .Cm digitalSignature
5707: set, the
5708: .Cm keyEncipherment
5709: set, or both bits set.
5710: The Netscape certificate type must be absent or have the SSL server bit set.
5711: .It SSL Server CA
5712: The extended key usage extension must be absent or include the
5713: web server authentication and/or one of the SGC OIDs.
5714: The Netscape certificate type must be absent or the SSL CA bit must be set:
5715: this is used as a workaround if the
5716: .Cm basicConstraints
5717: extension is absent.
5718: .It Netscape SSL Server
5719: For Netscape SSL clients to connect to an SSL server; it must have the
5720: .Cm keyEncipherment
5721: bit set if the
5722: .Cm keyUsage
5723: extension is present.
5724: This isn't always valid because some cipher suites use the key for
5725: digital signing.
5726: Otherwise it is the same as a normal SSL server.
5727: .It Common S/MIME Client Tests
5728: The extended key usage extension must be absent or include the
5729: email protection OID.
5730: The Netscape certificate type must be absent or should have the S/MIME bit set.
5731: If the S/MIME bit is not set in Netscape certificate type, then the SSL
5732: client bit is tolerated as an alternative but a warning is shown:
5733: this is because some Verisign certificates don't set the S/MIME bit.
5734: .It S/MIME Signing
5735: In addition to the common S/MIME client tests, the
5736: .Cm digitalSignature
5737: bit must be set if the
5738: .Cm keyUsage
5739: extension is present.
5740: .It S/MIME Encryption
5741: In addition to the common S/MIME tests, the
5742: .Cm keyEncipherment
5743: bit must be set if the
5744: .Cm keyUsage
5745: extension is present.
5746: .It S/MIME CA
5747: The extended key usage extension must be absent or include the
5748: email protection OID.
5749: The Netscape certificate type must be absent
5750: or must have the S/MIME CA bit set:
5751: this is used as a workaround if the
5752: .Cm basicConstraints
5753: extension is absent.
5754: .It CRL Signing
5755: The
5756: .Cm keyUsage
5757: extension must be absent or it must have the CRL signing bit set.
5758: .It CRL Signing CA
5759: The normal CA tests apply, except the
5760: .Cm basicConstraints
5761: extension must be present.
5762: .El
1.1 jsing 5763: .It Fl setalias Ar arg
1.80 jmc 5764: Set the alias of the certificate,
5765: allowing the certificate to be referred to using a nickname,
5766: such as
1.1 jsing 5767: .Qq Steve's Certificate .
5768: .It Fl trustout
1.80 jmc 5769: Output a trusted certificate
5770: (the default if any trust settings are modified).
1.1 jsing 5771: An ordinary or trusted certificate can be input, but by default an ordinary
5772: certificate is output and any trust settings are discarded.
5773: .El
1.80 jmc 5774: .Pp
1.1 jsing 5775: The
5776: .Nm x509
1.80 jmc 5777: utility can be used to sign certificates and requests:
5778: it can thus behave like a mini CA.
5779: The following are x509 signing options:
1.1 jsing 5780: .Bl -tag -width "XXXX"
5781: .It Fl CA Ar file
1.80 jmc 5782: The CA certificate to be used for signing.
1.1 jsing 5783: When this option is present,
5784: .Nm x509
1.80 jmc 5785: behaves like a mini CA.
1.1 jsing 5786: The input file is signed by the CA using this option;
5787: that is, its issuer name is set to the subject name of the CA and it is
5788: digitally signed using the CA's private key.
5789: .Pp
5790: This option is normally combined with the
5791: .Fl req
5792: option.
5793: Without the
5794: .Fl req
5795: option, the input is a certificate which must be self-signed.
5796: .It Fl CAcreateserial
1.80 jmc 5797: Create the CA serial number file if it does not exist
5798: instead of generating an error.
5799: The file will contain the serial number
1.1 jsing 5800: .Sq 02
5801: and the certificate being signed will have
5802: .Sq 1
5803: as its serial number.
1.80 jmc 5804: .It Fl CAform Cm der | pem
1.1 jsing 5805: The format of the CA certificate file.
5806: The default is
1.80 jmc 5807: .Cm pem .
1.1 jsing 5808: .It Fl CAkey Ar file
1.80 jmc 5809: Set the CA private key to sign a certificate with.
5810: Otherwise it is assumed that the CA private key is present
5811: in the CA certificate file.
5812: .It Fl CAkeyform Cm der | pem
1.1 jsing 5813: The format of the CA private key.
5814: The default is
1.80 jmc 5815: .Cm pem .
1.1 jsing 5816: .It Fl CAserial Ar file
1.80 jmc 5817: Use the serial number in
5818: .Ar file
5819: to sign a certificate.
5820: The file should consist of one line containing an even number of hex digits
1.1 jsing 5821: with the serial number to use.
5822: After each use the serial number is incremented and written out
5823: to the file again.
5824: .Pp
5825: The default filename consists of the CA certificate file base name with
5826: .Pa .srl
5827: appended.
5828: For example, if the CA certificate file is called
5829: .Pa mycacert.pem ,
5830: it expects to find a serial number file called
5831: .Pa mycacert.srl .
5832: .It Fl checkend Ar arg
5833: Check whether the certificate expires in the next
5834: .Ar arg
5835: seconds.
5836: If so, exit with return value 1;
5837: otherwise exit with return value 0.
5838: .It Fl clrext
5839: Delete any extensions from a certificate.
5840: This option is used when a certificate is being created from another
5841: certificate (for example with the
5842: .Fl signkey
5843: or the
5844: .Fl CA
5845: options).
5846: Normally, all extensions are retained.
5847: .It Fl days Ar arg
1.80 jmc 5848: The number of days to make a certificate valid for.
1.1 jsing 5849: The default is 30 days.
5850: .It Fl extensions Ar section
5851: The section to add certificate extensions from.
5852: If this option is not specified, the extensions should either be
1.80 jmc 5853: contained in the unnamed (default) section
5854: or the default section should contain a variable called
1.1 jsing 5855: .Qq extensions
5856: which contains the section to use.
5857: .It Fl extfile Ar file
5858: File containing certificate extensions to use.
5859: If not specified, no extensions are added to the certificate.
1.80 jmc 5860: .It Fl keyform Cm der | pem
5861: The format of the private key file used in the
1.1 jsing 5862: .Fl signkey
5863: option.
5864: .It Fl req
1.80 jmc 5865: Expect a certificate request on input instead of a certificate.
1.1 jsing 5866: .It Fl set_serial Ar n
1.80 jmc 5867: The serial number to use.
1.1 jsing 5868: This option can be used with either the
5869: .Fl signkey
5870: or
5871: .Fl CA
5872: options.
5873: If used in conjunction with the
5874: .Fl CA
5875: option, the serial number file (as specified by the
5876: .Fl CAserial
5877: or
5878: .Fl CAcreateserial
5879: options) is not used.
5880: .Pp
5881: The serial number can be decimal or hex (if preceded by
5882: .Sq 0x ) .
5883: Negative serial numbers can also be specified but their use is not recommended.
5884: .It Fl signkey Ar file
1.80 jmc 5885: Self-sign
5886: .Ar file
5887: using the supplied private key.
1.1 jsing 5888: .Pp
5889: If the input file is a certificate, it sets the issuer name to the
1.80 jmc 5890: subject name (i.e. makes it self-signed),
1.1 jsing 5891: changes the public key to the supplied value,
5892: and changes the start and end dates.
5893: The start date is set to the current time and the end date is set to
5894: a value determined by the
5895: .Fl days
5896: option.
5897: Any certificate extensions are retained unless the
5898: .Fl clrext
5899: option is supplied.
5900: .Pp
5901: If the input is a certificate request, a self-signed certificate
5902: is created using the supplied private key using the subject name in
5903: the request.
5904: .It Fl x509toreq
1.80 jmc 5905: Convert a certificate into a certificate request.
1.1 jsing 5906: The
5907: .Fl signkey
5908: option is used to pass the required private key.
5909: .El
1.38 jmc 5910: .Sh COMMON NOTATION
5911: Several commands share a common syntax,
5912: as detailed below.
5913: .Pp
5914: Password arguments, typically specified using
1.33 jmc 5915: .Fl passin
5916: and
5917: .Fl passout
1.38 jmc 5918: for input and output passwords,
5919: allow passwords to be obtained from a variety of sources.
5920: Both of these options take a single argument, described below.
1.33 jmc 5921: If no password argument is given and a password is required,
5922: then the user is prompted to enter one:
5923: this will typically be read from the current terminal with echoing turned off.
1.38 jmc 5924: .Bl -tag -width "pass:password" -offset indent
5925: .It Cm pass : Ns Ar password
1.33 jmc 5926: The actual password is
5927: .Ar password .
1.38 jmc 5928: Since the password is visible to utilities,
1.33 jmc 5929: this form should only be used where security is not important.
1.38 jmc 5930: .It Cm env : Ns Ar var
1.33 jmc 5931: Obtain the password from the environment variable
5932: .Ar var .
1.38 jmc 5933: Since the environment of other processes is visible,
5934: this option should be used with caution.
5935: .It Cm file : Ns Ar path
1.33 jmc 5936: The first line of
5937: .Ar path
5938: is the password.
5939: If the same
5940: .Ar path
5941: argument is supplied to
5942: .Fl passin
5943: and
5944: .Fl passout ,
5945: then the first line will be used for the input password and the next line
5946: for the output password.
5947: .Ar path
5948: need not refer to a regular file:
5949: it could, for example, refer to a device or named pipe.
1.38 jmc 5950: .It Cm fd : Ns Ar number
1.33 jmc 5951: Read the password from the file descriptor
5952: .Ar number .
1.38 jmc 5953: This can be used to send the data via a pipe, for example.
5954: .It Cm stdin
1.33 jmc 5955: Read the password from standard input.
1.35 jmc 5956: .El
1.38 jmc 5957: .Pp
1.64 jmc 5958: Input/output formats,
1.38 jmc 5959: typically specified using
5960: .Fl inform
5961: and
5962: .Fl outform ,
1.64 jmc 5963: indicate the format being read from or written to.
1.38 jmc 5964: The argument is case insensitive.
5965: .Pp
5966: .Bl -tag -width Ds -offset indent -compact
5967: .It Cm der
5968: Distinguished Encoding Rules (DER)
5969: is a binary format.
1.64 jmc 5970: .It Cm net
5971: Insecure legacy format.
1.38 jmc 5972: .It Cm pem
5973: Privacy Enhanced Mail (PEM)
5974: is base64-encoded.
1.70 jmc 5975: .It Cm smime
5976: An SMIME format message.
1.38 jmc 5977: .It Cm txt
5978: Plain ASCII text.
5979: .El
1.35 jmc 5980: .Sh ENVIRONMENT
5981: The following environment variables affect the execution of
5982: .Nm openssl :
1.38 jmc 5983: .Bl -tag -width "/etc/ssl/openssl.cnf"
1.35 jmc 5984: .It Ev OPENSSL_CONF
5985: The location of the master configuration file.
1.33 jmc 5986: .El
1.1 jsing 5987: .Sh FILES
5988: .Bl -tag -width "/etc/ssl/openssl.cnf" -compact
1.17 sobrado 5989: .It Pa /etc/ssl/
1.1 jsing 5990: Default config directory for
5991: .Nm openssl .
1.17 sobrado 5992: .It Pa /etc/ssl/lib/
1.1 jsing 5993: Unused.
1.17 sobrado 5994: .It Pa /etc/ssl/private/
1.1 jsing 5995: Default private key directory.
1.17 sobrado 5996: .It Pa /etc/ssl/openssl.cnf
1.1 jsing 5997: Default configuration file for
5998: .Nm openssl .
1.17 sobrado 5999: .It Pa /etc/ssl/x509v3.cnf
1.1 jsing 6000: Default configuration file for
6001: .Nm x509
6002: certificates.
6003: .El
6004: .Sh SEE ALSO
1.74 jmc 6005: .Xr acme-client 1 ,
1.26 jmc 6006: .Xr nc 1 ,
1.90 schwarze 6007: .Xr openssl.cnf 5 ,
6008: .Xr x509v3.cnf 5 ,
1.1 jsing 6009: .Xr ssl 8 ,
6010: .Xr starttls 8
6011: .Sh STANDARDS
6012: .Rs
6013: .%A T. Dierks
6014: .%A C. Allen
6015: .%D January 1999
6016: .%R RFC 2246
6017: .%T The TLS Protocol Version 1.0
6018: .Re
6019: .Pp
6020: .Rs
6021: .%A M. Wahl
6022: .%A S. Killie
6023: .%A T. Howes
6024: .%D December 1997
6025: .%R RFC 2253
6026: .%T Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names
6027: .Re
6028: .Pp
6029: .Rs
6030: .%A B. Kaliski
6031: .%D March 1998
6032: .%R RFC 2315
6033: .%T PKCS #7: Cryptographic Message Syntax Version 1.5
6034: .Re
6035: .Pp
6036: .Rs
6037: .%A R. Housley
6038: .%A W. Ford
6039: .%A W. Polk
6040: .%A D. Solo
6041: .%D January 1999
6042: .%R RFC 2459
6043: .%T Internet X.509 Public Key Infrastructure Certificate and CRL Profile
6044: .Re
6045: .Pp
6046: .Rs
6047: .%A M. Myers
6048: .%A R. Ankney
6049: .%A A. Malpani
6050: .%A S. Galperin
6051: .%A C. Adams
6052: .%D June 1999
6053: .%R RFC 2560
6054: .%T X.509 Internet Public Key Infrastructure Online Certificate Status Protocol \(en OCSP
6055: .Re
6056: .Pp
6057: .Rs
6058: .%A R. Housley
6059: .%D June 1999
6060: .%R RFC 2630
6061: .%T Cryptographic Message Syntax
6062: .Re
6063: .Pp
6064: .Rs
6065: .%A P. Chown
6066: .%D June 2002
6067: .%R RFC 3268
1.24 jmc 6068: .%T Advanced Encryption Standard (AES) Ciphersuites for Transport Layer Security (TLS)
1.1 jsing 6069: .Re