Annotation of src/usr.bin/openssl/openssl.1, Revision 1.105
1.105 ! inoguchi 1: .\" $OpenBSD: openssl.1,v 1.104 2019/07/04 13:55:20 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.104 inoguchi 113: .Dd $Mdocdate: July 4 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.1 jsing 1404: .It Fl passin Ar arg
1405: The key password source.
1406: .It Fl passout Ar arg
1407: The output file password source.
1408: .It Fl pubin
1.60 jmc 1409: Read in a public key, not a private key.
1.1 jsing 1410: .It Fl pubout
1.60 jmc 1411: Output a public key, not a private key.
1412: Automatically set if the input is a public key.
1.1 jsing 1413: .It Fl text
1.64 jmc 1414: Print the public/private key in plain text.
1.1 jsing 1415: .El
1416: .Sh ECPARAM
1417: .nr nS 1
1418: .Nm "openssl ecparam"
1419: .Op Fl C
1420: .Op Fl check
1421: .Op Fl conv_form Ar arg
1422: .Op Fl genkey
1423: .Op Fl in Ar file
1.48 jmc 1424: .Op Fl inform Cm der | pem
1.1 jsing 1425: .Op Fl list_curves
1426: .Op Fl name Ar arg
1427: .Op Fl no_seed
1428: .Op Fl noout
1429: .Op Fl out Ar file
1.48 jmc 1430: .Op Fl outform Cm der | pem
1.1 jsing 1431: .Op Fl param_enc Ar arg
1432: .Op Fl text
1433: .nr nS 0
1434: .Pp
1.48 jmc 1435: The
1436: .Nm ecparam
1437: command is used to manipulate or generate EC parameter files.
1438: .Nm openssl
1439: is not able to generate new groups so
1440: .Nm ecparam
1441: can only create EC parameters from known (named) curves.
1442: .Pp
1.1 jsing 1443: The options are as follows:
1444: .Bl -tag -width Ds
1445: .It Fl C
1446: Convert the EC parameters into C code.
1447: The parameters can then be loaded by calling the
1.48 jmc 1448: .No get_ec_group_ Ns Ar XXX
1.1 jsing 1449: function.
1450: .It Fl check
1451: Validate the elliptic curve parameters.
1452: .It Fl conv_form Ar arg
1453: Specify how the points on the elliptic curve are converted
1454: into octet strings.
1455: Possible values are:
1.95 tb 1456: .Cm compressed ,
1457: .Cm uncompressed
1.48 jmc 1458: (the default),
1.1 jsing 1459: and
1460: .Cm hybrid .
1461: For more information regarding
1.48 jmc 1462: the point conversion forms see the X9.62 standard.
1.1 jsing 1463: Note:
1464: Due to patent issues the
1465: .Cm compressed
1466: option is disabled by default for binary curves
1467: and can be enabled by defining the preprocessor macro
1.48 jmc 1468: .Dv OPENSSL_EC_BIN_PT_COMP
1.1 jsing 1469: at compile time.
1470: .It Fl genkey
1471: Generate an EC private key using the specified parameters.
1472: .It Fl in Ar file
1.48 jmc 1473: The input file to read from,
1474: or standard input if not specified.
1475: .It Fl inform Cm der | pem
1476: The input format.
1.1 jsing 1477: .It Fl list_curves
1.48 jmc 1478: Print a list of all
1.1 jsing 1479: currently implemented EC parameter names and exit.
1480: .It Fl name Ar arg
1.48 jmc 1481: Use the EC parameters with the specified "short" name.
1.1 jsing 1482: .It Fl no_seed
1.48 jmc 1483: Do not include the seed for the parameter generation
1484: in the ECParameters structure (see RFC 3279).
1.1 jsing 1485: .It Fl noout
1.48 jmc 1486: Do not output the encoded version of the parameters.
1.1 jsing 1487: .It Fl out Ar file
1.48 jmc 1488: The output file to write to,
1489: or standard output if not specified.
1490: .It Fl outform Cm der | pem
1491: The output format.
1.1 jsing 1492: .It Fl param_enc Ar arg
1.48 jmc 1493: Specify how the elliptic curve parameters are encoded.
1.1 jsing 1494: Possible value are:
1495: .Cm named_curve ,
1496: i.e. the EC parameters are specified by an OID, or
1497: .Cm explicit ,
1498: where the EC parameters are explicitly given
1499: (see RFC 3279 for the definition of the EC parameter structures).
1500: The default value is
1501: .Cm named_curve .
1502: Note: the
1503: .Cm implicitlyCA
1504: alternative, as specified in RFC 3279,
1.48 jmc 1505: is currently not implemented.
1.1 jsing 1506: .It Fl text
1.64 jmc 1507: Print the EC parameters in plain text.
1.1 jsing 1508: .El
1509: .Sh ENC
1510: .nr nS 1
1511: .Nm "openssl enc"
1512: .Fl ciphername
1513: .Op Fl AadePp
1514: .Op Fl base64
1515: .Op Fl bufsize Ar number
1516: .Op Fl debug
1517: .Op Fl in Ar file
1.97 jmc 1518: .Op Fl iter Ar iterations
1.1 jsing 1519: .Op Fl iv Ar IV
1520: .Op Fl K Ar key
1521: .Op Fl k Ar password
1522: .Op Fl kfile Ar file
1523: .Op Fl md Ar digest
1524: .Op Fl none
1525: .Op Fl nopad
1526: .Op Fl nosalt
1527: .Op Fl out Ar file
1528: .Op Fl pass Ar arg
1.96 beck 1529: .Op Fl pbkdf2
1.1 jsing 1530: .Op Fl S Ar salt
1531: .Op Fl salt
1532: .nr nS 0
1533: .Pp
1534: The symmetric cipher commands allow data to be encrypted or decrypted
1535: using various block and stream ciphers using keys based on passwords
1536: or explicitly provided.
1537: Base64 encoding or decoding can also be performed either by itself
1538: or in addition to the encryption or decryption.
1.49 jmc 1539: The program can be called either as
1540: .Nm openssl Ar ciphername
1541: or
1542: .Nm openssl enc - Ns Ar ciphername .
1543: .Pp
1544: Some of the ciphers do not have large keys and others have security
1545: implications if not used correctly.
1546: All the block ciphers normally use PKCS#5 padding,
1547: also known as standard block padding.
1548: If padding is disabled, the input data must be a multiple of the cipher
1549: block length.
1.1 jsing 1550: .Pp
1551: The options are as follows:
1552: .Bl -tag -width Ds
1553: .It Fl A
1554: If the
1555: .Fl a
1556: option is set, then base64 process the data on one line.
1557: .It Fl a , base64
1558: Base64 process the data.
1559: This means that if encryption is taking place, the data is base64-encoded
1560: after encryption.
1.49 jmc 1561: If decryption is set, the input data is base64-decoded before
1.1 jsing 1562: being decrypted.
1563: .It Fl bufsize Ar number
1564: Set the buffer size for I/O.
1565: .It Fl d
1566: Decrypt the input data.
1567: .It Fl debug
1568: Debug the BIOs used for I/O.
1569: .It Fl e
1.49 jmc 1570: Encrypt the input data.
1571: This is the default.
1.1 jsing 1572: .It Fl in Ar file
1.49 jmc 1573: The input file to read from,
1.57 jmc 1574: or standard input if not specified.
1.97 jmc 1575: .It Fl iter Ar iterations
1576: Use the pbkdf2 key derivation function, with
1577: .Ar iterations
1578: as the number of iterations.
1.1 jsing 1579: .It Fl iv Ar IV
1580: The actual
1581: .Ar IV
1582: .Pq initialisation vector
1583: to use:
1584: this must be represented as a string comprised only of hex digits.
1585: When only the
1586: .Ar key
1587: is specified using the
1588: .Fl K
1.49 jmc 1589: option,
1590: the IV must explicitly be defined.
1.1 jsing 1591: When a password is being specified using one of the other options,
1.49 jmc 1592: the IV is generated from this password.
1.1 jsing 1593: .It Fl K Ar key
1594: The actual
1595: .Ar key
1596: to use:
1597: this must be represented as a string comprised only of hex digits.
1.49 jmc 1598: If only the key is specified,
1599: the IV must also be specified using the
1.1 jsing 1600: .Fl iv
1601: option.
1602: When both a
1603: .Ar key
1604: and a
1605: .Ar password
1606: are specified, the
1607: .Ar key
1608: given with the
1609: .Fl K
1.49 jmc 1610: option will be used and the IV generated from the password will be taken.
1.1 jsing 1611: It probably does not make much sense to specify both
1612: .Ar key
1613: and
1614: .Ar password .
1615: .It Fl k Ar password
1616: The
1617: .Ar password
1618: to derive the key from.
1619: Superseded by the
1620: .Fl pass
1621: option.
1622: .It Fl kfile Ar file
1623: Read the password to derive the key from the first line of
1624: .Ar file .
1625: Superseded by the
1626: .Fl pass
1627: option.
1628: .It Fl md Ar digest
1629: Use
1630: .Ar digest
1631: to create a key from a pass phrase.
1632: .Ar digest
1633: may be one of
1.49 jmc 1634: .Cm md5
1.1 jsing 1635: or
1.49 jmc 1636: .Cm sha1 .
1.1 jsing 1637: .It Fl none
1638: Use NULL cipher (no encryption or decryption of input).
1639: .It Fl nopad
1640: Disable standard block padding.
1641: .It Fl nosalt
1.49 jmc 1642: Don't use a salt in the key derivation routines.
1.81 jmc 1643: This option should never be used
1.49 jmc 1644: since it makes it possible to perform efficient dictionary
1645: attacks on the password and to attack stream cipher encrypted data.
1.1 jsing 1646: .It Fl out Ar file
1.51 jmc 1647: The output file to write to,
1.57 jmc 1648: or standard output if not specified.
1.1 jsing 1649: .It Fl P
1.49 jmc 1650: Print out the salt, key, and IV used, then immediately exit;
1.1 jsing 1651: don't do any encryption or decryption.
1652: .It Fl p
1.49 jmc 1653: Print out the salt, key, and IV used.
1.1 jsing 1654: .It Fl pass Ar arg
1655: The password source.
1.96 beck 1656: .It Fl pbkdf2
1.97 jmc 1657: Use the pbkdf2 key derivation function, with
1.96 beck 1658: the default of 10000 iterations.
1.1 jsing 1659: .It Fl S Ar salt
1660: The actual
1661: .Ar salt
1662: to use:
1663: this must be represented as a string comprised only of hex digits.
1664: .It Fl salt
1.49 jmc 1665: Use a salt in the key derivation routines (the default).
1666: When the salt is being used
1667: the first eight bytes of the encrypted data are reserved for the salt:
1668: it is randomly generated when encrypting a file and read from the
1669: encrypted file when it is decrypted.
1.1 jsing 1670: .El
1671: .Sh ERRSTR
1672: .Nm openssl errstr
1673: .Op Fl stats
1674: .Ar errno ...
1675: .Pp
1676: The
1677: .Nm errstr
1678: command performs error number to error string conversion,
1679: generating a human-readable string representing the error code
1680: .Ar errno .
1681: The string is obtained through the
1682: .Xr ERR_error_string_n 3
1683: function and has the following format:
1684: .Pp
1685: .Dl error:[error code]:[library name]:[function name]:[reason string]
1686: .Pp
1687: .Bq error code
1688: is an 8-digit hexadecimal number.
1689: The remaining fields
1690: .Bq library name ,
1691: .Bq function name ,
1692: and
1693: .Bq reason string
1694: are all ASCII text.
1695: .Pp
1696: The options are as follows:
1697: .Bl -tag -width Ds
1698: .It Fl stats
1699: Print debugging statistics about various aspects of the hash table.
1700: .El
1701: .Sh GENDSA
1702: .nr nS 1
1703: .Nm "openssl gendsa"
1704: .Oo
1.102 jmc 1705: .Fl aes128 | aes192 | aes256 | camellia128 |
1706: .Fl camellia192 | camellia256 | des | des3 | idea
1.1 jsing 1707: .Oc
1708: .Op Fl out Ar file
1.101 inoguchi 1709: .Op Fl passout Ar arg
1710: .Ar paramfile
1.1 jsing 1711: .nr nS 0
1712: .Pp
1713: The
1714: .Nm gendsa
1715: command generates a DSA private key from a DSA parameter file
1.51 jmc 1716: (typically generated by the
1.1 jsing 1717: .Nm openssl dsaparam
1718: command).
1.51 jmc 1719: DSA key generation is little more than random number generation so it is
1720: much quicker than,
1721: for example,
1722: RSA key generation.
1.1 jsing 1723: .Pp
1724: The options are as follows:
1725: .Bl -tag -width Ds
1726: .It Xo
1727: .Fl aes128 | aes192 | aes256 |
1.101 inoguchi 1728: .Fl camellia128 | camellia192 | camellia256 |
1729: .Fl des | des3 |
1730: .Fl idea
1.1 jsing 1731: .Xc
1.101 inoguchi 1732: Encrypt the private key with the AES, CAMELLIA, DES, triple DES
1733: or the IDEA ciphers, respectively, before outputting it.
1.1 jsing 1734: A pass phrase is prompted for.
1735: If none of these options are specified, no encryption is used.
1736: .It Fl out Ar file
1.51 jmc 1737: The output file to write to,
1.57 jmc 1738: or standard output if not specified.
1.101 inoguchi 1739: .It Fl passout Ar arg
1740: The output file password source.
1.1 jsing 1741: .It Ar paramfile
1.51 jmc 1742: Specify the DSA parameter file to use.
1.1 jsing 1743: The parameters in this file determine the size of the private key.
1744: .El
1745: .Sh GENPKEY
1746: .nr nS 1
1747: .Nm "openssl genpkey"
1748: .Op Fl algorithm Ar alg
1749: .Op Ar cipher
1750: .Op Fl genparam
1751: .Op Fl out Ar file
1.52 jmc 1752: .Op Fl outform Cm der | pem
1.1 jsing 1753: .Op Fl paramfile Ar file
1754: .Op Fl pass Ar arg
1755: .Op Fl pkeyopt Ar opt : Ns Ar value
1756: .Op Fl text
1757: .nr nS 0
1758: .Pp
1759: The
1760: .Nm genpkey
1761: command generates private keys.
1762: The use of this
1763: program is encouraged over the algorithm specific utilities
1.22 bcook 1764: because additional algorithm options can be used.
1.1 jsing 1765: .Pp
1766: The options are as follows:
1767: .Bl -tag -width Ds
1768: .It Fl algorithm Ar alg
1769: The public key algorithm to use,
1770: such as RSA, DSA, or DH.
1.52 jmc 1771: This option must precede any
1.1 jsing 1772: .Fl pkeyopt
1773: options.
1774: The options
1775: .Fl paramfile
1776: and
1777: .Fl algorithm
1778: are mutually exclusive.
1779: .It Ar cipher
1780: Encrypt the private key with the supplied cipher.
1781: Any algorithm name accepted by
1.52 jmc 1782: .Xr EVP_get_cipherbyname 3
1783: is acceptable.
1.1 jsing 1784: .It Fl genparam
1785: Generate a set of parameters instead of a private key.
1.52 jmc 1786: This option must precede any
1.1 jsing 1787: .Fl algorithm ,
1788: .Fl paramfile ,
1789: or
1790: .Fl pkeyopt
1791: options.
1792: .It Fl out Ar file
1.52 jmc 1793: The output file to write to,
1.57 jmc 1794: or standard output if not specified.
1.52 jmc 1795: .It Fl outform Cm der | pem
1796: The output format.
1.1 jsing 1797: .It Fl paramfile Ar file
1.52 jmc 1798: Some public key algorithms generate a private key based on a set of parameters,
1799: which can be supplied using this option.
1.1 jsing 1800: If this option is used the public key
1801: algorithm used is determined by the parameters.
1.52 jmc 1802: This option must precede any
1.1 jsing 1803: .Fl pkeyopt
1804: options.
1805: The options
1806: .Fl paramfile
1807: and
1808: .Fl algorithm
1809: are mutually exclusive.
1810: .It Fl pass Ar arg
1811: The output file password source.
1812: .It Fl pkeyopt Ar opt : Ns Ar value
1813: Set the public key algorithm option
1814: .Ar opt
1815: to
1.52 jmc 1816: .Ar value ,
1817: as follows:
1.1 jsing 1818: .Bl -tag -width Ds -offset indent
1819: .It rsa_keygen_bits : Ns Ar numbits
1820: (RSA)
1821: The number of bits in the generated key.
1.52 jmc 1822: The default is 2048.
1.1 jsing 1823: .It rsa_keygen_pubexp : Ns Ar value
1824: (RSA)
1825: The RSA public exponent value.
1826: This can be a large decimal or hexadecimal value if preceded by 0x.
1.52 jmc 1827: The default is 65537.
1.1 jsing 1828: .It dsa_paramgen_bits : Ns Ar numbits
1829: (DSA)
1830: The number of bits in the generated parameters.
1.52 jmc 1831: The default is 1024.
1.1 jsing 1832: .It dh_paramgen_prime_len : Ns Ar numbits
1833: (DH)
1834: The number of bits in the prime parameter
1835: .Ar p .
1836: .It dh_paramgen_generator : Ns Ar value
1837: (DH)
1838: The value to use for the generator
1839: .Ar g .
1840: .It ec_paramgen_curve : Ns Ar curve
1841: (EC)
1842: The EC curve to use.
1843: .El
1.52 jmc 1844: .It Fl text
1.64 jmc 1845: Print the private/public key in plain text.
1.52 jmc 1846: .El
1.1 jsing 1847: .Sh GENRSA
1848: .nr nS 1
1849: .Nm "openssl genrsa"
1850: .Op Fl 3 | f4
1.53 jmc 1851: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 1852: .Op Fl out Ar file
1853: .Op Fl passout Ar arg
1854: .Op Ar numbits
1855: .nr nS 0
1856: .Pp
1857: The
1858: .Nm genrsa
1.53 jmc 1859: command generates an RSA private key,
1860: which essentially involves the generation of two prime numbers.
1861: When generating the key,
1862: various symbols will be output to indicate the progress of the generation.
1863: A
1864: .Sq \&.
1865: represents each number which has passed an initial sieve test;
1866: .Sq +
1867: means a number has passed a single round of the Miller-Rabin primality test.
1868: A newline means that the number has passed all the prime tests
1869: (the actual number depends on the key size).
1.1 jsing 1870: .Pp
1871: The options are as follows:
1872: .Bl -tag -width Ds
1873: .It Fl 3 | f4
1874: The public exponent to use, either 3 or 65537.
1875: The default is 65537.
1.53 jmc 1876: .It Fl aes128 | aes192 | aes256 | des | des3
1877: Encrypt the private key with the AES, DES,
1.1 jsing 1878: or the triple DES ciphers, respectively, before outputting it.
1879: If none of these options are specified, no encryption is used.
1880: If encryption is used, a pass phrase is prompted for,
1881: if it is not supplied via the
1882: .Fl passout
1883: option.
1884: .It Fl out Ar file
1.53 jmc 1885: The output file to write to,
1.57 jmc 1886: or standard output if not specified.
1.1 jsing 1887: .It Fl passout Ar arg
1888: The output file password source.
1889: .It Ar numbits
1890: The size of the private key to generate in bits.
1891: This must be the last option specified.
1892: The default is 2048.
1893: .El
1894: .Sh NSEQ
1895: .Nm openssl nseq
1896: .Op Fl in Ar file
1897: .Op Fl out Ar file
1898: .Op Fl toseq
1899: .Pp
1900: The
1901: .Nm nseq
1.54 jmc 1902: command takes a file containing a Netscape certificate sequence
1903: (an alternative to the standard PKCS#7 format)
1904: and prints out the certificates contained in it,
1905: or takes a file of certificates
1906: and converts it into a Netscape certificate sequence.
1907: .Pp
1.1 jsing 1908: The options are as follows:
1909: .Bl -tag -width Ds
1910: .It Fl in Ar file
1.54 jmc 1911: The input file to read from,
1912: or standard input if not specified.
1.1 jsing 1913: .It Fl out Ar file
1.54 jmc 1914: The output file to write to,
1915: or standard output if not specified.
1.1 jsing 1916: .It Fl toseq
1917: Normally, a Netscape certificate sequence will be input and the output
1918: is the certificates contained in it.
1919: With the
1920: .Fl toseq
1921: option the situation is reversed:
1922: a Netscape certificate sequence is created from a file of certificates.
1923: .El
1924: .Sh OCSP
1925: .nr nS 1
1926: .Nm "openssl ocsp"
1927: .Op Fl CA Ar file
1928: .Op Fl CAfile Ar file
1929: .Op Fl CApath Ar directory
1930: .Op Fl cert Ar file
1931: .Op Fl dgst Ar alg
1.55 jmc 1932: .Op Fl host Ar hostname : Ns Ar port
1.1 jsing 1933: .Op Fl index Ar indexfile
1934: .Op Fl issuer Ar file
1935: .Op Fl ndays Ar days
1936: .Op Fl nmin Ar minutes
1937: .Op Fl no_cert_checks
1938: .Op Fl no_cert_verify
1939: .Op Fl no_certs
1940: .Op Fl no_chain
1941: .Op Fl no_intern
1942: .Op Fl no_nonce
1943: .Op Fl no_signature_verify
1944: .Op Fl nonce
1945: .Op Fl noverify
1946: .Op Fl nrequest Ar number
1947: .Op Fl out Ar file
1948: .Op Fl path Ar path
1949: .Op Fl port Ar portnum
1950: .Op Fl req_text
1951: .Op Fl reqin Ar file
1952: .Op Fl reqout Ar file
1953: .Op Fl resp_key_id
1954: .Op Fl resp_no_certs
1955: .Op Fl resp_text
1956: .Op Fl respin Ar file
1957: .Op Fl respout Ar file
1958: .Op Fl rkey Ar file
1959: .Op Fl rother Ar file
1960: .Op Fl rsigner Ar file
1961: .Op Fl serial Ar number
1962: .Op Fl sign_other Ar file
1963: .Op Fl signer Ar file
1964: .Op Fl signkey Ar file
1965: .Op Fl status_age Ar age
1966: .Op Fl text
1967: .Op Fl trust_other
1968: .Op Fl url Ar responder_url
1969: .Op Fl VAfile Ar file
1970: .Op Fl validity_period Ar nsec
1971: .Op Fl verify_other Ar file
1972: .nr nS 0
1973: .Pp
1.55 jmc 1974: The Online Certificate Status Protocol (OCSP)
1975: enables applications to determine the (revocation) state
1976: of an identified certificate (RFC 2560).
1.1 jsing 1977: .Pp
1978: The
1979: .Nm ocsp
1980: command performs many common OCSP tasks.
1981: It can be used to print out requests and responses,
1982: create requests and send queries to an OCSP responder,
1983: and behave like a mini OCSP server itself.
1984: .Pp
1985: The options are as follows:
1986: .Bl -tag -width Ds
1987: .It Fl CAfile Ar file , Fl CApath Ar directory
1.55 jmc 1988: A file or path containing trusted CA certificates,
1989: used to verify the signature on the OCSP response.
1.1 jsing 1990: .It Fl cert Ar file
1991: Add the certificate
1992: .Ar file
1993: to the request.
1994: The issuer certificate is taken from the previous
1995: .Fl issuer
1996: option, or an error occurs if no issuer certificate is specified.
1997: .It Fl dgst Ar alg
1.55 jmc 1998: Use the digest algorithm
1999: .Ar alg
2000: for certificate identification in the OCSP request.
1.1 jsing 2001: By default SHA-1 is used.
2002: .It Xo
2003: .Fl host Ar hostname : Ns Ar port ,
2004: .Fl path Ar path
2005: .Xc
1.55 jmc 2006: Send
2007: the OCSP request to
1.1 jsing 2008: .Ar hostname
1.55 jmc 2009: on
1.1 jsing 2010: .Ar port .
2011: .Fl path
2012: specifies the HTTP path name to use, or
1.55 jmc 2013: .Pa /
1.1 jsing 2014: by default.
2015: .It Fl issuer Ar file
1.81 jmc 2016: The current issuer certificate, in PEM format.
2017: Can be used multiple times and must come before any
1.1 jsing 2018: .Fl cert
2019: options.
2020: .It Fl no_cert_checks
2021: Don't perform any additional checks on the OCSP response signer's certificate.
2022: That is, do not make any checks to see if the signer's certificate is
2023: authorised to provide the necessary status information:
2024: as a result this option should only be used for testing purposes.
2025: .It Fl no_cert_verify
2026: Don't verify the OCSP response signer's certificate at all.
2027: Since this option allows the OCSP response to be signed by any certificate,
2028: it should only be used for testing purposes.
2029: .It Fl no_certs
1.55 jmc 2030: Don't include any certificates in the signed request.
1.1 jsing 2031: .It Fl no_chain
2032: Do not use certificates in the response as additional untrusted CA
2033: certificates.
2034: .It Fl no_intern
2035: Ignore certificates contained in the OCSP response
2036: when searching for the signer's certificate.
1.55 jmc 2037: The signer's certificate must be specified with either the
1.1 jsing 2038: .Fl verify_other
2039: or
2040: .Fl VAfile
2041: options.
2042: .It Fl no_signature_verify
2043: Don't check the signature on the OCSP response.
2044: Since this option tolerates invalid signatures on OCSP responses,
2045: it will normally only be used for testing purposes.
2046: .It Fl nonce , no_nonce
1.55 jmc 2047: Add an OCSP nonce extension to a request,
2048: or disable an OCSP nonce addition.
1.1 jsing 2049: Normally, if an OCSP request is input using the
2050: .Fl respin
1.55 jmc 2051: option no nonce is added:
1.1 jsing 2052: using the
2053: .Fl nonce
1.55 jmc 2054: option will force the addition of a nonce.
1.1 jsing 2055: If an OCSP request is being created (using the
2056: .Fl cert
2057: and
2058: .Fl serial
2059: options)
1.55 jmc 2060: a nonce is automatically added; specifying
1.1 jsing 2061: .Fl no_nonce
2062: overrides this.
2063: .It Fl noverify
1.55 jmc 2064: Don't attempt to verify the OCSP response signature or the nonce values.
2065: This is normally only be used for debugging
1.1 jsing 2066: since it disables all verification of the responder's certificate.
2067: .It Fl out Ar file
1.55 jmc 2068: Specify the output file to write to,
1.57 jmc 2069: or standard output if not specified.
1.1 jsing 2070: .It Fl req_text , resp_text , text
2071: Print out the text form of the OCSP request, response, or both, respectively.
2072: .It Fl reqin Ar file , Fl respin Ar file
2073: Read an OCSP request or response file from
2074: .Ar file .
2075: These options are ignored
2076: if an OCSP request or response creation is implied by other options
2077: (for example with the
2078: .Fl serial , cert ,
2079: and
2080: .Fl host
2081: options).
2082: .It Fl reqout Ar file , Fl respout Ar file
2083: Write out the DER-encoded certificate request or response to
2084: .Ar file .
2085: .It Fl serial Ar num
2086: Same as the
2087: .Fl cert
2088: option except the certificate with serial number
2089: .Ar num
2090: is added to the request.
2091: The serial number is interpreted as a decimal integer unless preceded by
2092: .Sq 0x .
1.55 jmc 2093: Negative integers can also be specified
2094: by preceding the value with a minus sign.
1.1 jsing 2095: .It Fl sign_other Ar file
2096: Additional certificates to include in the signed request.
2097: .It Fl signer Ar file , Fl signkey Ar file
2098: Sign the OCSP request using the certificate specified in the
2099: .Fl signer
2100: option and the private key specified by the
2101: .Fl signkey
2102: option.
2103: If the
2104: .Fl signkey
2105: option is not present, then the private key is read from the same file
2106: as the certificate.
2107: If neither option is specified, the OCSP request is not signed.
2108: .It Fl trust_other
2109: The certificates specified by the
2110: .Fl verify_other
2111: option should be explicitly trusted and no additional checks will be
2112: performed on them.
2113: This is useful when the complete responder certificate chain is not available
2114: or trusting a root CA is not appropriate.
2115: .It Fl url Ar responder_url
2116: Specify the responder URL.
2117: Both HTTP and HTTPS
2118: .Pq SSL/TLS
2119: URLs can be specified.
2120: .It Fl VAfile Ar file
1.55 jmc 2121: A file containing explicitly trusted responder certificates.
1.1 jsing 2122: Equivalent to the
2123: .Fl verify_other
2124: and
2125: .Fl trust_other
2126: options.
2127: .It Fl validity_period Ar nsec , Fl status_age Ar age
1.55 jmc 2128: The range of times, in seconds, which will be tolerated in an OCSP response.
2129: Each certificate status response includes a notBefore time
2130: and an optional notAfter time.
1.1 jsing 2131: The current time should fall between these two values,
2132: but the interval between the two times may be only a few seconds.
2133: In practice the OCSP responder and clients' clocks may not be precisely
2134: synchronised and so such a check may fail.
2135: To avoid this the
2136: .Fl validity_period
2137: option can be used to specify an acceptable error range in seconds,
1.55 jmc 2138: the default value being 5 minutes.
1.1 jsing 2139: .Pp
1.55 jmc 2140: If the notAfter time is omitted from a response,
2141: it means that new status information is immediately available.
2142: In this case the age of the notBefore field is checked
2143: to see it is not older than
1.1 jsing 2144: .Ar age
2145: seconds old.
2146: By default, this additional check is not performed.
2147: .It Fl verify_other Ar file
1.55 jmc 2148: A file containing additional certificates to search
2149: when attempting to locate the OCSP response signing certificate.
2150: Some responders omit the actual signer's certificate from the response,
2151: so this can be used to supply the necessary certificate.
1.1 jsing 2152: .El
1.55 jmc 2153: .Pp
2154: The options for the OCSP server are as follows:
1.1 jsing 2155: .Bl -tag -width "XXXX"
2156: .It Fl CA Ar file
2157: CA certificate corresponding to the revocation information in
2158: .Ar indexfile .
2159: .It Fl index Ar indexfile
2160: .Ar indexfile
1.55 jmc 2161: is a text index file in ca format
2162: containing certificate revocation information.
1.1 jsing 2163: .Pp
1.55 jmc 2164: If this option is specified,
1.1 jsing 2165: .Nm ocsp
1.55 jmc 2166: is in responder mode, otherwise it is in client mode.
2167: The requests the responder processes can be either specified on
1.1 jsing 2168: the command line (using the
2169: .Fl issuer
2170: and
2171: .Fl serial
2172: options), supplied in a file (using the
2173: .Fl respin
1.55 jmc 2174: option), or via external OCSP clients (if
1.1 jsing 2175: .Ar port
2176: or
2177: .Ar url
2178: is specified).
2179: .Pp
1.55 jmc 2180: If this option is present, then the
1.1 jsing 2181: .Fl CA
2182: and
2183: .Fl rsigner
2184: options must also be present.
2185: .It Fl nmin Ar minutes , Fl ndays Ar days
2186: Number of
2187: .Ar minutes
2188: or
2189: .Ar days
1.55 jmc 2190: when fresh revocation information is available:
2191: used in the nextUpdate field.
2192: If neither option is present,
2193: the nextUpdate field is omitted,
2194: meaning fresh revocation information is immediately available.
1.1 jsing 2195: .It Fl nrequest Ar number
1.55 jmc 2196: Exit after receiving
1.1 jsing 2197: .Ar number
1.55 jmc 2198: requests (the default is unlimited).
1.1 jsing 2199: .It Fl port Ar portnum
2200: Port to listen for OCSP requests on.
1.55 jmc 2201: May also be specified using the
1.1 jsing 2202: .Fl url
2203: option.
2204: .It Fl resp_key_id
2205: Identify the signer certificate using the key ID;
1.55 jmc 2206: the default is to use the subject name.
1.1 jsing 2207: .It Fl resp_no_certs
2208: Don't include any certificates in the OCSP response.
2209: .It Fl rkey Ar file
2210: The private key to sign OCSP responses with;
2211: if not present, the file specified in the
2212: .Fl rsigner
2213: option is used.
2214: .It Fl rother Ar file
2215: Additional certificates to include in the OCSP response.
2216: .It Fl rsigner Ar file
2217: The certificate to sign OCSP responses with.
2218: .El
2219: .Pp
2220: Initially the OCSP responder certificate is located and the signature on
2221: the OCSP request checked using the responder certificate's public key.
2222: Then a normal certificate verify is performed on the OCSP responder certificate
2223: building up a certificate chain in the process.
2224: The locations of the trusted certificates used to build the chain can be
2225: specified by the
2226: .Fl CAfile
2227: and
2228: .Fl CApath
2229: options or they will be looked for in the standard
1.55 jmc 2230: .Nm openssl
2231: certificates directory.
1.1 jsing 2232: .Pp
1.55 jmc 2233: If the initial verify fails, the OCSP verify process halts with an error.
1.1 jsing 2234: Otherwise the issuing CA certificate in the request is compared to the OCSP
2235: responder certificate: if there is a match then the OCSP verify succeeds.
2236: .Pp
2237: Otherwise the OCSP responder certificate's CA is checked against the issuing
2238: CA certificate in the request.
2239: If there is a match and the OCSPSigning extended key usage is present
2240: in the OCSP responder certificate, then the OCSP verify succeeds.
2241: .Pp
2242: Otherwise the root CA of the OCSP responder's CA is checked to see if it
2243: is trusted for OCSP signing.
2244: If it is, the OCSP verify succeeds.
2245: .Pp
2246: If none of these checks is successful, the OCSP verify fails.
2247: What this effectively means is that if the OCSP responder certificate is
2248: authorised directly by the CA it is issuing revocation information about
1.55 jmc 2249: (and it is correctly configured),
1.1 jsing 2250: then verification will succeed.
2251: .Pp
1.55 jmc 2252: If the OCSP responder is a global responder,
2253: which can give details about multiple CAs
2254: and has its own separate certificate chain,
2255: then its root CA can be trusted for OCSP signing.
1.1 jsing 2256: Alternatively, the responder certificate itself can be explicitly trusted
2257: with the
2258: .Fl VAfile
2259: option.
2260: .Sh PASSWD
2261: .nr nS 1
2262: .Nm "openssl passwd"
2263: .Op Fl 1 | apr1 | crypt
2264: .Op Fl in Ar file
2265: .Op Fl noverify
2266: .Op Fl quiet
2267: .Op Fl reverse
2268: .Op Fl salt Ar string
2269: .Op Fl stdin
2270: .Op Fl table
2271: .Op Ar password
2272: .nr nS 0
2273: .Pp
2274: The
2275: .Nm passwd
1.56 jmc 2276: command computes the hash of a password.
1.1 jsing 2277: .Pp
2278: The options are as follows:
2279: .Bl -tag -width Ds
2280: .It Fl 1
2281: Use the MD5 based
2282: .Bx
2283: password algorithm
1.56 jmc 2284: .Qq 1 .
1.1 jsing 2285: .It Fl apr1
2286: Use the
1.56 jmc 2287: .Qq apr1
1.1 jsing 2288: algorithm
1.56 jmc 2289: .Po
2290: Apache variant of the
1.1 jsing 2291: .Bx
1.56 jmc 2292: algorithm
2293: .Pc .
1.1 jsing 2294: .It Fl crypt
2295: Use the
1.56 jmc 2296: .Qq crypt
2297: algorithm (the default).
1.1 jsing 2298: .It Fl in Ar file
2299: Read passwords from
2300: .Ar file .
2301: .It Fl noverify
2302: Don't verify when reading a password from the terminal.
2303: .It Fl quiet
2304: Don't output warnings when passwords given on the command line are truncated.
2305: .It Fl reverse
2306: Switch table columns.
2307: This only makes sense in conjunction with the
2308: .Fl table
2309: option.
2310: .It Fl salt Ar string
1.56 jmc 2311: Use the salt specified by
2312: .Ar string .
1.1 jsing 2313: When reading a password from the terminal, this implies
2314: .Fl noverify .
2315: .It Fl stdin
1.56 jmc 2316: Read passwords from standard input.
1.1 jsing 2317: .It Fl table
2318: In the output list, prepend the cleartext password and a TAB character
2319: to each password hash.
2320: .El
2321: .Sh PKCS7
2322: .nr nS 1
2323: .Nm "openssl pkcs7"
2324: .Op Fl in Ar file
1.57 jmc 2325: .Op Fl inform Cm der | pem
1.1 jsing 2326: .Op Fl noout
2327: .Op Fl out Ar file
1.57 jmc 2328: .Op Fl outform Cm der | pem
1.1 jsing 2329: .Op Fl print_certs
2330: .Op Fl text
2331: .nr nS 0
2332: .Pp
2333: The
2334: .Nm pkcs7
2335: command processes PKCS#7 files in DER or PEM format.
1.57 jmc 2336: The PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC 2315.
2337: .Pp
1.1 jsing 2338: The options are as follows:
2339: .Bl -tag -width Ds
2340: .It Fl in Ar file
1.57 jmc 2341: The input file to read from,
2342: or standard input if not specified.
2343: .It Fl inform Cm der | pem
2344: The input format.
1.1 jsing 2345: .It Fl noout
2346: Don't output the encoded version of the PKCS#7 structure
2347: (or certificates if
2348: .Fl print_certs
2349: is set).
2350: .It Fl out Ar file
1.57 jmc 2351: The output to write to,
2352: or standard output if not specified.
2353: .It Fl outform Cm der | pem
2354: The output format.
1.1 jsing 2355: .It Fl print_certs
1.57 jmc 2356: Print any certificates or CRLs contained in the file,
2357: preceded by their subject and issuer names in a one-line format.
1.1 jsing 2358: .It Fl text
1.57 jmc 2359: Print certificate details in full rather than just subject and issuer names.
1.1 jsing 2360: .El
2361: .Sh PKCS8
2362: .nr nS 1
2363: .Nm "openssl pkcs8"
2364: .Op Fl in Ar file
1.58 jmc 2365: .Op Fl inform Cm der | pem
1.1 jsing 2366: .Op Fl nocrypt
2367: .Op Fl noiter
2368: .Op Fl out Ar file
1.58 jmc 2369: .Op Fl outform Cm der | pem
1.1 jsing 2370: .Op Fl passin Ar arg
2371: .Op Fl passout Ar arg
2372: .Op Fl topk8
2373: .Op Fl v1 Ar alg
2374: .Op Fl v2 Ar alg
2375: .nr nS 0
2376: .Pp
2377: The
2378: .Nm pkcs8
1.58 jmc 2379: command processes private keys
2380: (both encrypted and unencrypted)
2381: in PKCS#8 format
2382: with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
2383: The default encryption is only 56 bits;
2384: keys encrypted using PKCS#5 v2.0 algorithms and high iteration counts
2385: are more secure.
2386: .Pp
1.1 jsing 2387: The options are as follows:
2388: .Bl -tag -width Ds
2389: .It Fl in Ar file
1.58 jmc 2390: The input file to read from,
2391: or standard input if not specified.
1.1 jsing 2392: If the key is encrypted, a pass phrase will be prompted for.
1.58 jmc 2393: .It Fl inform Cm der | pem
2394: The input format.
1.1 jsing 2395: .It Fl nocrypt
1.58 jmc 2396: Generate an unencrypted PrivateKeyInfo structure.
2397: This option does not encrypt private keys at all
2398: and should only be used when absolutely necessary.
1.1 jsing 2399: .It Fl noiter
2400: Use an iteration count of 1.
2401: See the
2402: .Sx PKCS12
2403: section below for a detailed explanation of this option.
2404: .It Fl out Ar file
1.58 jmc 2405: The output file to write to,
2406: or standard output if none is specified.
1.1 jsing 2407: If any encryption options are set, a pass phrase will be prompted for.
1.58 jmc 2408: .It Fl outform Cm der | pem
2409: The output format.
1.1 jsing 2410: .It Fl passin Ar arg
2411: The key password source.
2412: .It Fl passout Ar arg
2413: The output file password source.
2414: .It Fl topk8
1.58 jmc 2415: Read a traditional format private key and write a PKCS#8 format key.
1.1 jsing 2416: .It Fl v1 Ar alg
1.58 jmc 2417: Specify a PKCS#5 v1.5 or PKCS#12 algorithm to use.
2418: .Pp
2419: .Bl -tag -width "XXXX" -compact
2420: .It PBE-MD5-DES
2421: 56-bit DES.
2422: .It PBE-SHA1-RC2-64 | PBE-MD5-RC2-64 | PBE-SHA1-DES
2423: 64-bit RC2 or 56-bit DES.
2424: .It PBE-SHA1-RC4-128 | PBE-SHA1-RC4-40 | PBE-SHA1-3DES
2425: .It PBE-SHA1-2DES | PBE-SHA1-RC2-128 | PBE-SHA1-RC2-40
2426: PKCS#12 password-based encryption algorithm,
2427: which allow strong encryption algorithms like triple DES or 128-bit RC2.
2428: .El
1.1 jsing 2429: .It Fl v2 Ar alg
1.58 jmc 2430: Use PKCS#5 v2.0 algorithms.
2431: Supports algorithms such as 168-bit triple DES or 128-bit RC2,
2432: however not many implementations support PKCS#5 v2.0 yet
2433: (if using private keys with
2434: .Nm openssl
2435: this doesn't matter).
1.1 jsing 2436: .Pp
2437: .Ar alg
1.58 jmc 2438: is the encryption algorithm to use;
2439: valid values include des, des3, and rc2.
2440: It is recommended that des3 is used.
1.1 jsing 2441: .El
2442: .Sh PKCS12
2443: .nr nS 1
2444: .Nm "openssl pkcs12"
1.59 jmc 2445: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 2446: .Op Fl cacerts
2447: .Op Fl CAfile Ar file
2448: .Op Fl caname Ar name
2449: .Op Fl CApath Ar directory
2450: .Op Fl certfile Ar file
2451: .Op Fl certpbe Ar alg
2452: .Op Fl chain
2453: .Op Fl clcerts
2454: .Op Fl CSP Ar name
2455: .Op Fl descert
2456: .Op Fl export
2457: .Op Fl in Ar file
2458: .Op Fl info
2459: .Op Fl inkey Ar file
2460: .Op Fl keyex
2461: .Op Fl keypbe Ar alg
2462: .Op Fl keysig
2463: .Op Fl macalg Ar alg
2464: .Op Fl maciter
2465: .Op Fl name Ar name
2466: .Op Fl nocerts
2467: .Op Fl nodes
2468: .Op Fl noiter
2469: .Op Fl nokeys
2470: .Op Fl nomac
2471: .Op Fl nomaciter
2472: .Op Fl nomacver
2473: .Op Fl noout
2474: .Op Fl out Ar file
2475: .Op Fl passin Ar arg
2476: .Op Fl passout Ar arg
2477: .Op Fl twopass
2478: .nr nS 0
2479: .Pp
2480: The
2481: .Nm pkcs12
2482: command allows PKCS#12 files
2483: .Pq sometimes referred to as PFX files
2484: to be created and parsed.
2485: By default, a PKCS#12 file is parsed;
2486: a PKCS#12 file can be created by using the
2487: .Fl export
1.59 jmc 2488: option.
2489: .Pp
2490: The options for parsing a PKCS12 file are as follows:
1.1 jsing 2491: .Bl -tag -width "XXXX"
1.59 jmc 2492: .It Fl aes128 | aes192 | aes256 | des | des3
2493: Encrypt private keys
2494: using AES, DES, or triple DES, respectively.
1.1 jsing 2495: The default is triple DES.
2496: .It Fl cacerts
2497: Only output CA certificates
2498: .Pq not client certificates .
2499: .It Fl clcerts
2500: Only output client certificates
2501: .Pq not CA certificates .
2502: .It Fl in Ar file
1.59 jmc 2503: The input file to read from,
2504: or standard input if not specified.
1.1 jsing 2505: .It Fl info
2506: Output additional information about the PKCS#12 file structure,
2507: algorithms used, and iteration counts.
2508: .It Fl nocerts
1.59 jmc 2509: Do not output certificates.
1.1 jsing 2510: .It Fl nodes
1.59 jmc 2511: Do not encrypt private keys.
1.1 jsing 2512: .It Fl nokeys
1.59 jmc 2513: Do not output private keys.
1.1 jsing 2514: .It Fl nomacver
1.59 jmc 2515: Do not attempt to verify the integrity MAC before reading the file.
1.1 jsing 2516: .It Fl noout
1.59 jmc 2517: Do not output the keys and certificates to the output file
1.1 jsing 2518: version of the PKCS#12 file.
2519: .It Fl out Ar file
1.59 jmc 2520: The output file to write to,
2521: or standard output if not specified.
1.1 jsing 2522: .It Fl passin Ar arg
2523: The key password source.
2524: .It Fl passout Ar arg
2525: The output file password source.
2526: .It Fl twopass
2527: Prompt for separate integrity and encryption passwords: most software
2528: always assumes these are the same so this option will render such
2529: PKCS#12 files unreadable.
2530: .El
1.59 jmc 2531: .Pp
2532: The options for PKCS12 file creation are as follows:
1.1 jsing 2533: .Bl -tag -width "XXXX"
2534: .It Fl CAfile Ar file
2535: CA storage as a file.
2536: .It Fl CApath Ar directory
2537: CA storage as a directory.
1.59 jmc 2538: The directory must be a standard certificate directory:
1.1 jsing 2539: that is, a hash of each subject name (using
1.59 jmc 2540: .Nm x509 Fl hash )
1.1 jsing 2541: should be linked to each certificate.
2542: .It Fl caname Ar name
1.59 jmc 2543: Specify the
1.1 jsing 2544: .Qq friendly name
2545: for other certificates.
1.59 jmc 2546: May be used multiple times to specify names for all certificates
1.1 jsing 2547: in the order they appear.
2548: .It Fl certfile Ar file
2549: A file to read additional certificates from.
2550: .It Fl certpbe Ar alg , Fl keypbe Ar alg
1.59 jmc 2551: Specify the algorithm used to encrypt the private key and
1.1 jsing 2552: certificates to be selected.
1.59 jmc 2553: Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name can be used.
1.1 jsing 2554: If a cipher name
2555: (as output by the
2556: .Cm list-cipher-algorithms
2557: command) is specified then it
2558: is used with PKCS#5 v2.0.
2559: For interoperability reasons it is advisable to only use PKCS#12 algorithms.
2560: .It Fl chain
1.59 jmc 2561: Include the entire certificate chain of the user certificate.
1.1 jsing 2562: The standard CA store is used for this search.
2563: If the search fails, it is considered a fatal error.
2564: .It Fl CSP Ar name
2565: Write
2566: .Ar name
2567: as a Microsoft CSP name.
2568: .It Fl descert
2569: Encrypt the certificate using triple DES; this may render the PKCS#12
2570: file unreadable by some
2571: .Qq export grade
2572: software.
2573: By default, the private key is encrypted using triple DES and the
2574: certificate using 40-bit RC2.
2575: .It Fl export
1.59 jmc 2576: Create a PKCS#12 file (rather than parsing one).
1.1 jsing 2577: .It Fl in Ar file
1.59 jmc 2578: The input file to read from,
1.81 jmc 2579: or standard input if not specified.
1.1 jsing 2580: The order doesn't matter but one private key and its corresponding
2581: certificate should be present.
2582: If additional certificates are present, they will also be included
2583: in the PKCS#12 file.
2584: .It Fl inkey Ar file
1.59 jmc 2585: File to read a private key from.
1.1 jsing 2586: If not present, a private key must be present in the input file.
2587: .It Fl keyex | keysig
1.59 jmc 2588: Specify whether the private key is to be used for key exchange or just signing.
1.1 jsing 2589: Normally,
2590: .Qq export grade
2591: software will only allow 512-bit RSA keys to be
2592: used for encryption purposes, but arbitrary length keys for signing.
2593: The
2594: .Fl keysig
2595: option marks the key for signing only.
2596: Signing only keys can be used for S/MIME signing, authenticode
1.66 jmc 2597: (ActiveX control signing)
1.59 jmc 2598: and SSL client authentication.
1.1 jsing 2599: .It Fl macalg Ar alg
2600: Specify the MAC digest algorithm.
1.59 jmc 2601: The default is SHA1.
1.1 jsing 2602: .It Fl maciter
1.66 jmc 2603: Included for compatibility only:
1.59 jmc 2604: it used to be needed to use MAC iterations counts
2605: but they are now used by default.
1.1 jsing 2606: .It Fl name Ar name
1.59 jmc 2607: Specify the
1.1 jsing 2608: .Qq friendly name
2609: for the certificate and private key.
2610: This name is typically displayed in list boxes by software importing the file.
2611: .It Fl nomac
2612: Don't attempt to provide the MAC integrity.
2613: .It Fl nomaciter , noiter
1.59 jmc 2614: Affect the iteration counts on the MAC and key algorithms.
1.1 jsing 2615: .Pp
2616: To discourage attacks by using large dictionaries of common passwords,
2617: the algorithm that derives keys from passwords can have an iteration count
2618: applied to it: this causes a certain part of the algorithm to be repeated
2619: and slows it down.
2620: The MAC is used to check the file integrity but since it will normally
2621: have the same password as the keys and certificates it could also be attacked.
2622: By default, both MAC and encryption iteration counts are set to 2048;
2623: using these options the MAC and encryption iteration counts can be set to 1.
2624: Since this reduces the file security you should not use these options
2625: unless you really have to.
2626: Most software supports both MAC and key iteration counts.
2627: .It Fl out Ar file
1.59 jmc 2628: The output file to write to,
2629: or standard output if not specified.
1.1 jsing 2630: .It Fl passin Ar arg
2631: The key password source.
2632: .It Fl passout Ar arg
2633: The output file password source.
2634: .El
2635: .Sh PKEY
2636: .nr nS 1
2637: .Nm "openssl pkey"
2638: .Op Ar cipher
2639: .Op Fl in Ar file
1.60 jmc 2640: .Op Fl inform Cm der | pem
1.1 jsing 2641: .Op Fl noout
2642: .Op Fl out Ar file
1.60 jmc 2643: .Op Fl outform Cm der | pem
1.1 jsing 2644: .Op Fl passin Ar arg
2645: .Op Fl passout Ar arg
2646: .Op Fl pubin
2647: .Op Fl pubout
2648: .Op Fl text
2649: .Op Fl text_pub
2650: .nr nS 0
2651: .Pp
2652: The
2653: .Nm pkey
2654: command processes public or private keys.
2655: They can be converted between various forms
2656: and their components printed out.
2657: .Pp
2658: The options are as follows:
2659: .Bl -tag -width Ds
2660: .It Ar cipher
1.60 jmc 2661: Encrypt the private key with the specified cipher.
1.1 jsing 2662: Any algorithm name accepted by
1.60 jmc 2663: .Xr EVP_get_cipherbyname 3
1.1 jsing 2664: is acceptable, such as
2665: .Cm des3 .
2666: .It Fl in Ar file
1.60 jmc 2667: The input file to read from,
2668: or standard input if not specified.
1.1 jsing 2669: If the key is encrypted a pass phrase will be prompted for.
1.60 jmc 2670: .It Fl inform Cm der | pem
2671: The input format.
1.1 jsing 2672: .It Fl noout
2673: Do not output the encoded version of the key.
2674: .It Fl out Ar file
1.60 jmc 2675: The output file to write to,
2676: or standard output if not specified.
1.1 jsing 2677: If any encryption options are set then a pass phrase
2678: will be prompted for.
1.60 jmc 2679: .It Fl outform Cm der | pem
2680: The output format.
1.1 jsing 2681: .It Fl passin Ar arg
2682: The key password source.
2683: .It Fl passout Ar arg
2684: The output file password source.
2685: .It Fl pubin
1.60 jmc 2686: Read in a public key, not a private key.
1.1 jsing 2687: .It Fl pubout
1.60 jmc 2688: Output a public key, not a private key.
2689: Automatically set if the input is a public key.
1.1 jsing 2690: .It Fl text
1.64 jmc 2691: Print the public/private key in plain text.
1.1 jsing 2692: .It Fl text_pub
2693: Print out only public key components
2694: even if a private key is being processed.
2695: .El
2696: .Sh PKEYPARAM
2697: .Cm openssl pkeyparam
2698: .Op Fl in Ar file
2699: .Op Fl noout
2700: .Op Fl out Ar file
2701: .Op Fl text
2702: .Pp
2703: The
1.61 jmc 2704: .Nm pkeyparam
1.1 jsing 2705: command processes public or private keys.
1.61 jmc 2706: The key type is determined by the PEM headers.
1.1 jsing 2707: .Pp
2708: The options are as follows:
2709: .Bl -tag -width Ds
2710: .It Fl in Ar file
1.61 jmc 2711: The input file to read from,
2712: or standard input if not specified.
1.1 jsing 2713: .It Fl noout
2714: Do not output the encoded version of the parameters.
2715: .It Fl out Ar file
1.61 jmc 2716: The output file to write to,
2717: or standard output if not specified.
1.1 jsing 2718: .It Fl text
1.64 jmc 2719: Print the parameters in plain text.
1.1 jsing 2720: .El
2721: .Sh PKEYUTL
2722: .nr nS 1
2723: .Nm "openssl pkeyutl"
2724: .Op Fl asn1parse
2725: .Op Fl certin
2726: .Op Fl decrypt
2727: .Op Fl derive
2728: .Op Fl encrypt
2729: .Op Fl hexdump
2730: .Op Fl in Ar file
2731: .Op Fl inkey Ar file
1.62 jmc 2732: .Op Fl keyform Cm der | pem
1.1 jsing 2733: .Op Fl out Ar file
2734: .Op Fl passin Ar arg
1.62 jmc 2735: .Op Fl peerform Cm der | pem
1.1 jsing 2736: .Op Fl peerkey Ar file
2737: .Op Fl pkeyopt Ar opt : Ns Ar value
2738: .Op Fl pubin
2739: .Op Fl rev
2740: .Op Fl sigfile Ar file
2741: .Op Fl sign
2742: .Op Fl verify
2743: .Op Fl verifyrecover
2744: .nr nS 0
2745: .Pp
2746: The
2747: .Nm pkeyutl
2748: command can be used to perform public key operations using
2749: any supported algorithm.
2750: .Pp
2751: The options are as follows:
2752: .Bl -tag -width Ds
2753: .It Fl asn1parse
1.84 jmc 2754: ASN.1 parse the output data.
1.1 jsing 2755: This is useful when combined with the
2756: .Fl verifyrecover
1.84 jmc 2757: option when an ASN.1 structure is signed.
1.1 jsing 2758: .It Fl certin
2759: The input is a certificate containing a public key.
2760: .It Fl decrypt
2761: Decrypt the input data using a private key.
2762: .It Fl derive
2763: Derive a shared secret using the peer key.
2764: .It Fl encrypt
2765: Encrypt the input data using a public key.
2766: .It Fl hexdump
2767: Hex dump the output data.
2768: .It Fl in Ar file
1.62 jmc 2769: The input file to read from,
2770: or standard input if not specified.
1.1 jsing 2771: .It Fl inkey Ar file
2772: The input key file.
2773: By default it should be a private key.
1.62 jmc 2774: .It Fl keyform Cm der | pem
2775: The key format.
1.1 jsing 2776: .It Fl out Ar file
1.62 jmc 2777: The output file to write to,
2778: or standard output if not specified.
1.1 jsing 2779: .It Fl passin Ar arg
2780: The key password source.
1.62 jmc 2781: .It Fl peerform Cm der | pem
2782: The peer key format.
1.1 jsing 2783: .It Fl peerkey Ar file
2784: The peer key file, used by key derivation (agreement) operations.
2785: .It Fl pkeyopt Ar opt : Ns Ar value
1.62 jmc 2786: Set the public key algorithm option
2787: .Ar opt
2788: to
2789: .Ar value .
2790: Unless otherwise mentioned, all algorithms support the format
2791: .Ar digest : Ns Ar alg ,
2792: which specifies the digest to use
1.1 jsing 2793: for sign, verify, and verifyrecover operations.
2794: The value
2795: .Ar alg
2796: should represent a digest name as used in the
1.62 jmc 2797: .Xr EVP_get_digestbyname 3
2798: function.
2799: .Pp
1.1 jsing 2800: The RSA algorithm supports the
2801: encrypt, decrypt, sign, verify, and verifyrecover operations in general.
2802: Some padding modes only support some of these
2803: operations however.
2804: .Bl -tag -width Ds
2805: .It rsa_padding_mode : Ns Ar mode
2806: This sets the RSA padding mode.
2807: Acceptable values for
2808: .Ar mode
2809: are
2810: .Cm pkcs1
2811: for PKCS#1 padding;
2812: .Cm none
2813: for no padding;
2814: .Cm oaep
2815: for OAEP mode;
2816: .Cm x931
2817: for X9.31 mode;
2818: and
2819: .Cm pss
2820: for PSS.
2821: .Pp
2822: In PKCS#1 padding if the message digest is not set then the supplied data is
2823: signed or verified directly instead of using a DigestInfo structure.
2824: If a digest is set then a DigestInfo
2825: structure is used and its length
2826: must correspond to the digest type.
2827: For oeap mode only encryption and decryption is supported.
2828: For x931 if the digest type is set it is used to format the block data;
2829: otherwise the first byte is used to specify the X9.31 digest ID.
2830: Sign, verify, and verifyrecover can be performed in this mode.
2831: For pss mode only sign and verify are supported and the digest type must be
2832: specified.
2833: .It rsa_pss_saltlen : Ns Ar len
2834: For pss
2835: mode only this option specifies the salt length.
2836: Two special values are supported:
2837: -1 sets the salt length to the digest length.
2838: When signing -2 sets the salt length to the maximum permissible value.
2839: When verifying -2 causes the salt length to be automatically determined
2840: based on the PSS block structure.
2841: .El
1.62 jmc 2842: .Pp
1.1 jsing 2843: The DSA algorithm supports the sign and verify operations.
2844: Currently there are no additional options other than
2845: .Ar digest .
2846: Only the SHA1 digest can be used and this digest is assumed by default.
1.62 jmc 2847: .Pp
1.1 jsing 2848: The DH algorithm supports the derive operation
2849: and no additional options.
1.62 jmc 2850: .Pp
1.1 jsing 2851: The EC algorithm supports the sign, verify, and derive operations.
2852: The sign and verify operations use ECDSA and derive uses ECDH.
2853: Currently there are no additional options other than
2854: .Ar digest .
2855: Only the SHA1 digest can be used and this digest is assumed by default.
1.62 jmc 2856: .It Fl pubin
2857: The input file is a public key.
2858: .It Fl rev
2859: Reverse the order of the input buffer.
2860: .It Fl sigfile Ar file
2861: Signature file (verify operation only).
2862: .It Fl sign
2863: Sign the input data and output the signed result.
2864: This requires a private key.
2865: .It Fl verify
2866: Verify the input data against the signature file and indicate if the
2867: verification succeeded or failed.
2868: .It Fl verifyrecover
2869: Verify the input data and output the recovered data.
2870: .El
1.1 jsing 2871: .Sh PRIME
2872: .Cm openssl prime
2873: .Op Fl bits Ar n
2874: .Op Fl checks Ar n
2875: .Op Fl generate
2876: .Op Fl hex
2877: .Op Fl safe
2878: .Ar p
2879: .Pp
2880: The
2881: .Nm prime
2882: command is used to generate prime numbers,
2883: or to check numbers for primality.
2884: Results are probabilistic:
2885: they have an exceedingly high likelihood of being correct,
2886: but are not guaranteed.
2887: .Pp
2888: The options are as follows:
2889: .Bl -tag -width Ds
2890: .It Fl bits Ar n
2891: Specify the number of bits in the generated prime number.
2892: Must be used in conjunction with
2893: .Fl generate .
2894: .It Fl checks Ar n
2895: Perform a Miller-Rabin probabilistic primality test with
2896: .Ar n
2897: iterations.
2898: The default is 20.
2899: .It Fl generate
2900: Generate a pseudo-random prime number.
2901: Must be used in conjunction with
2902: .Fl bits .
2903: .It Fl hex
2904: Output in hex format.
2905: .It Fl safe
2906: Generate only
2907: .Qq safe
2908: prime numbers
2909: (i.e. a prime p so that (p-1)/2 is also prime).
2910: .It Ar p
2911: Test if number
2912: .Ar p
2913: is prime.
2914: .El
2915: .Sh RAND
2916: .nr nS 1
2917: .Nm "openssl rand"
2918: .Op Fl base64
2919: .Op Fl hex
2920: .Op Fl out Ar file
2921: .Ar num
2922: .nr nS 0
2923: .Pp
2924: The
2925: .Nm rand
2926: command outputs
2927: .Ar num
2928: pseudo-random bytes.
2929: .Pp
2930: The options are as follows:
2931: .Bl -tag -width Ds
2932: .It Fl base64
1.81 jmc 2933: Perform base64 encoding on the output.
1.1 jsing 2934: .It Fl hex
2935: Specify hexadecimal output.
2936: .It Fl out Ar file
1.63 jmc 2937: The output file to write to,
2938: or standard output if not specified.
1.1 jsing 2939: .El
2940: .Sh REQ
2941: .nr nS 1
2942: .Nm "openssl req"
2943: .Op Fl asn1-kludge
2944: .Op Fl batch
2945: .Op Fl config Ar file
2946: .Op Fl days Ar n
2947: .Op Fl extensions Ar section
2948: .Op Fl in Ar file
1.63 jmc 2949: .Op Fl inform Cm der | pem
1.1 jsing 2950: .Op Fl key Ar keyfile
1.63 jmc 2951: .Op Fl keyform Cm der | pem
1.1 jsing 2952: .Op Fl keyout Ar file
1.28 doug 2953: .Op Fl md4 | md5 | sha1
1.1 jsing 2954: .Op Fl modulus
2955: .Op Fl nameopt Ar option
2956: .Op Fl new
2957: .Op Fl newhdr
2958: .Op Fl newkey Ar arg
2959: .Op Fl no-asn1-kludge
2960: .Op Fl nodes
2961: .Op Fl noout
2962: .Op Fl out Ar file
1.63 jmc 2963: .Op Fl outform Cm der | pem
1.1 jsing 2964: .Op Fl passin Ar arg
2965: .Op Fl passout Ar arg
2966: .Op Fl pubkey
2967: .Op Fl reqexts Ar section
2968: .Op Fl reqopt Ar option
2969: .Op Fl set_serial Ar n
2970: .Op Fl subj Ar arg
2971: .Op Fl subject
2972: .Op Fl text
2973: .Op Fl utf8
2974: .Op Fl verbose
2975: .Op Fl verify
2976: .Op Fl x509
2977: .nr nS 0
2978: .Pp
2979: The
2980: .Nm req
2981: command primarily creates and processes certificate requests
2982: in PKCS#10 format.
2983: It can additionally create self-signed certificates,
2984: for use as root CAs, for example.
2985: .Pp
2986: The options are as follows:
2987: .Bl -tag -width Ds
2988: .It Fl asn1-kludge
1.63 jmc 2989: Produce requests in an invalid format for certain picky CAs.
2990: Very few CAs still require the use of this option.
1.1 jsing 2991: .It Fl batch
2992: Non-interactive mode.
2993: .It Fl config Ar file
1.63 jmc 2994: Specify an alternative configuration file.
1.1 jsing 2995: .It Fl days Ar n
1.63 jmc 2996: Specify the number of days to certify the certificate for.
2997: The default is 30 days.
2998: Used with the
1.1 jsing 2999: .Fl x509
1.63 jmc 3000: option.
1.1 jsing 3001: .It Fl extensions Ar section , Fl reqexts Ar section
1.63 jmc 3002: Specify alternative sections to include certificate
3003: extensions (with
3004: .Fl x509 )
3005: or certificate request extensions,
3006: allowing several different sections to be used in the same configuration file.
1.1 jsing 3007: .It Fl in Ar file
1.63 jmc 3008: The input file to read a request from,
3009: or standard input if not specified.
1.1 jsing 3010: A request is only read if the creation options
3011: .Fl new
3012: and
3013: .Fl newkey
3014: are not specified.
1.63 jmc 3015: .It Fl inform Cm der | pem
3016: The input format.
1.1 jsing 3017: .It Fl key Ar keyfile
1.63 jmc 3018: The file to read the private key from.
1.1 jsing 3019: It also accepts PKCS#8 format private keys for PEM format files.
1.63 jmc 3020: .It Fl keyform Cm der | pem
1.1 jsing 3021: The format of the private key file specified in the
3022: .Fl key
3023: argument.
1.81 jmc 3024: The default is
3025: .Cm pem .
1.1 jsing 3026: .It Fl keyout Ar file
1.63 jmc 3027: The file to write the newly created private key to.
3028: If this option is not specified,
3029: the filename present in the configuration file is used.
1.4 sthen 3030: .It Fl md5 | sha1 | sha256
1.63 jmc 3031: The message digest to sign the request with.
1.1 jsing 3032: This overrides the digest algorithm specified in the configuration file.
3033: .Pp
3034: Some public key algorithms may override this choice.
3035: For instance, DSA signatures always use SHA1.
3036: .It Fl modulus
1.63 jmc 3037: Print the value of the modulus of the public key contained in the request.
1.1 jsing 3038: .It Fl nameopt Ar option , Fl reqopt Ar option
1.63 jmc 3039: Determine how the subject or issuer names are displayed.
1.1 jsing 3040: .Ar option
1.63 jmc 3041: can be a single option or multiple options separated by commas.
1.1 jsing 3042: Alternatively, these options may be used more than once to set multiple options.
3043: See the
3044: .Sx X509
3045: section below for details.
3046: .It Fl new
1.63 jmc 3047: Generate a new certificate request.
3048: The user is prompted for the relevant field values.
1.1 jsing 3049: The actual fields prompted for and their maximum and minimum sizes
3050: are specified in the configuration file and any requested extensions.
3051: .Pp
3052: If the
3053: .Fl key
3054: option is not used, it will generate a new RSA private
3055: key using information specified in the configuration file.
3056: .It Fl newhdr
1.63 jmc 3057: Add the word NEW to the PEM file header and footer lines
1.1 jsing 3058: on the outputed request.
1.63 jmc 3059: Some software and CAs need this.
1.1 jsing 3060: .It Fl newkey Ar arg
1.63 jmc 3061: Create a new certificate request and a new private key.
1.1 jsing 3062: The argument takes one of several forms.
1.63 jmc 3063: .Pp
3064: .No rsa : Ns Ar nbits
3065: generates an RSA key
1.1 jsing 3066: .Ar nbits
3067: in size.
3068: If
3069: .Ar nbits
1.63 jmc 3070: is omitted
3071: the default key size is used.
3072: .Pp
3073: .No dsa : Ns Ar file
3074: generates a DSA key using the parameters in
3075: .Ar file .
3076: .Pp
3077: .No param : Ns Ar file
3078: generates a key using the parameters or certificate in
3079: .Ar file .
3080: .Pp
3081: All other algorithms support the form
3082: .Ar algorithm : Ns Ar file ,
1.1 jsing 3083: where file may be an algorithm parameter file,
3084: created by the
3085: .Cm genpkey -genparam
1.14 jmc 3086: command or an X.509 certificate for a key with appropriate algorithm.
1.63 jmc 3087: .Ar file
3088: can be omitted,
3089: in which case any parameters can be specified via the
1.1 jsing 3090: .Fl pkeyopt
3091: option.
3092: .It Fl no-asn1-kludge
1.63 jmc 3093: Reverse the effect of
1.1 jsing 3094: .Fl asn1-kludge .
3095: .It Fl nodes
1.63 jmc 3096: Do not encrypt the private key.
1.1 jsing 3097: .It Fl noout
1.63 jmc 3098: Do not output the encoded version of the request.
1.1 jsing 3099: .It Fl out Ar file
1.63 jmc 3100: The output file to write to,
1.99 jmc 3101: or standard output if not specified.
1.63 jmc 3102: .It Fl outform Cm der | pem
3103: The output format.
1.1 jsing 3104: .It Fl passin Ar arg
3105: The key password source.
3106: .It Fl passout Ar arg
3107: The output file password source.
3108: .It Fl pubkey
1.63 jmc 3109: Output the public key.
1.1 jsing 3110: .It Fl reqopt Ar option
3111: Customise the output format used with
3112: .Fl text .
3113: The
3114: .Ar option
3115: argument can be a single option or multiple options separated by commas.
1.63 jmc 3116: See also the discussion of
1.1 jsing 3117: .Fl certopt
1.63 jmc 3118: in the
1.1 jsing 3119: .Nm x509
3120: command.
3121: .It Fl set_serial Ar n
3122: Serial number to use when outputting a self-signed certificate.
3123: This may be specified as a decimal value or a hex value if preceded by
3124: .Sq 0x .
3125: It is possible to use negative serial numbers but this is not recommended.
3126: .It Fl subj Ar arg
1.63 jmc 3127: Replaces the subject field of an input request
3128: with the specified data and output the modified request.
3129: .Ar arg
3130: must be formatted as /type0=value0/type1=value1/type2=...;
1.1 jsing 3131: characters may be escaped by
3132: .Sq \e
1.63 jmc 3133: (backslash);
1.1 jsing 3134: no spaces are skipped.
3135: .It Fl subject
1.63 jmc 3136: Print the request subject (or certificate subject if
1.1 jsing 3137: .Fl x509
1.63 jmc 3138: is specified).
1.1 jsing 3139: .It Fl text
1.64 jmc 3140: Print the certificate request in plain text.
1.1 jsing 3141: .It Fl utf8
1.63 jmc 3142: Interpret field values as UTF8 strings, not ASCII.
1.1 jsing 3143: .It Fl verbose
3144: Print extra details about the operations being performed.
3145: .It Fl verify
1.63 jmc 3146: Verify the signature on the request.
1.1 jsing 3147: .It Fl x509
1.63 jmc 3148: Output a self-signed certificate instead of a certificate request.
3149: This is typically used to generate a test certificate or a self-signed root CA.
3150: The extensions added to the certificate (if any)
1.1 jsing 3151: are specified in the configuration file.
3152: Unless specified using the
3153: .Fl set_serial
1.63 jmc 3154: option, 0 is used for the serial number.
1.1 jsing 3155: .El
1.63 jmc 3156: .Pp
1.1 jsing 3157: The configuration options are specified in the
1.63 jmc 3158: .Qq req
1.1 jsing 3159: section of the configuration file.
1.63 jmc 3160: The options available are as follows:
1.1 jsing 3161: .Bl -tag -width "XXXX"
1.63 jmc 3162: .It Cm attributes
3163: The section containing any request attributes: its format
1.1 jsing 3164: is the same as
1.63 jmc 3165: .Cm distinguished_name .
3166: Typically these may contain the challengePassword or unstructuredName types.
3167: They are currently ignored by the
3168: .Nm openssl
1.1 jsing 3169: request signing utilities, but some CAs might want them.
1.63 jmc 3170: .It Cm default_bits
3171: The default key size, in bits.
3172: The default is 2048.
1.1 jsing 3173: It is used if the
3174: .Fl new
1.63 jmc 3175: option is used and can be overridden by using the
1.1 jsing 3176: .Fl newkey
3177: option.
1.63 jmc 3178: .It Cm default_keyfile
3179: The default file to write a private key to,
3180: or standard output if not specified.
3181: It can be overridden by the
1.1 jsing 3182: .Fl keyout
3183: option.
1.63 jmc 3184: .It Cm default_md
3185: The digest algorithm to use.
1.1 jsing 3186: Possible values include
1.63 jmc 3187: .Cm md5 ,
3188: .Cm sha1
1.1 jsing 3189: and
1.63 jmc 3190: .Cm sha256
3191: (the default).
3192: It can be overridden on the command line.
3193: .It Cm distinguished_name
3194: The section containing the distinguished name fields to
1.1 jsing 3195: prompt for when generating a certificate or certificate request.
1.63 jmc 3196: The format is described below.
3197: .It Cm encrypt_key
3198: If set to
3199: .Qq no
3200: and a private key is generated, it is not encrypted.
3201: It is equivalent to the
1.1 jsing 3202: .Fl nodes
1.63 jmc 3203: option.
1.1 jsing 3204: For compatibility,
1.63 jmc 3205: .Cm encrypt_rsa_key
1.1 jsing 3206: is an equivalent option.
1.63 jmc 3207: .It Cm input_password | output_password
3208: The passwords for the input private key file (if present)
3209: and the output private key file (if one will be created).
1.1 jsing 3210: The command line options
3211: .Fl passin
3212: and
3213: .Fl passout
3214: override the configuration file values.
1.63 jmc 3215: .It Cm oid_file
3216: A file containing additional OBJECT IDENTIFIERS.
1.1 jsing 3217: Each line of the file should consist of the numerical form of the
3218: object identifier, followed by whitespace, then the short name followed
3219: by whitespace and finally the long name.
1.63 jmc 3220: .It Cm oid_section
3221: Specify a section in the configuration file containing extra
1.1 jsing 3222: object identifiers.
3223: Each line should consist of the short name of the
3224: object identifier followed by
3225: .Sq =
3226: and the numerical form.
3227: The short and long names are the same when this option is used.
1.63 jmc 3228: .It Cm prompt
3229: If set to
3230: .Qq no ,
3231: it disables prompting of certificate fields
1.1 jsing 3232: and just takes values from the config file directly.
3233: It also changes the expected format of the
1.63 jmc 3234: .Cm distinguished_name
1.1 jsing 3235: and
1.63 jmc 3236: .Cm attributes
1.1 jsing 3237: sections.
1.63 jmc 3238: .It Cm req_extensions
3239: The configuration file section containing a list of
1.1 jsing 3240: extensions to add to the certificate request.
3241: It can be overridden by the
3242: .Fl reqexts
1.63 jmc 3243: option.
3244: .It Cm string_mask
3245: Limit the string types for encoding certain fields.
1.1 jsing 3246: The following values may be used, limiting strings to the indicated types:
3247: .Bl -tag -width "MASK:number"
1.63 jmc 3248: .It Cm utf8only
3249: UTF8String.
1.1 jsing 3250: This is the default, as recommended by PKIX in RFC 2459.
1.63 jmc 3251: .It Cm default
3252: PrintableString, IA5String, T61String, BMPString, UTF8String.
3253: .It Cm pkix
3254: PrintableString, IA5String, BMPString, UTF8String.
3255: Inspired by the PKIX recommendation in RFC 2459 for certificates
3256: generated before 2004, but differs by also permitting IA5String.
3257: .It Cm nombstr
3258: PrintableString, IA5String, T61String, UniversalString.
3259: A workaround for some ancient software that had problems
3260: with the variable-sized BMPString and UTF8String types.
1.1 jsing 3261: .It Cm MASK : Ns Ar number
1.63 jmc 3262: An explicit bitmask of permitted types, where
1.1 jsing 3263: .Ar number
3264: is a C-style hex, decimal, or octal number that's a bit-wise OR of
3265: .Dv B_ASN1_*
3266: values from
3267: .In openssl/asn1.h .
3268: .El
1.63 jmc 3269: .It Cm utf8
3270: If set to
3271: .Qq yes ,
1.72 jmc 3272: field values are interpreted as UTF8 strings.
1.63 jmc 3273: .It Cm x509_extensions
3274: The configuration file section containing a list of
1.1 jsing 3275: extensions to add to a certificate generated when the
3276: .Fl x509
3277: switch is used.
3278: It can be overridden by the
3279: .Fl extensions
1.72 jmc 3280: command line switch.
1.1 jsing 3281: .El
1.63 jmc 3282: .Pp
1.1 jsing 3283: There are two separate formats for the distinguished name and attribute
3284: sections.
3285: If the
3286: .Fl prompt
3287: option is set to
1.63 jmc 3288: .Qq no ,
1.72 jmc 3289: then these sections just consist of field names and values.
3290: If the
1.1 jsing 3291: .Fl prompt
3292: option is absent or not set to
1.63 jmc 3293: .Qq no ,
1.72 jmc 3294: then the file contains field prompting information of the form:
1.1 jsing 3295: .Bd -unfilled -offset indent
3296: fieldName="prompt"
3297: fieldName_default="default field value"
3298: fieldName_min= 2
3299: fieldName_max= 4
3300: .Ed
3301: .Pp
3302: .Qq fieldName
3303: is the field name being used, for example
1.63 jmc 3304: .Cm commonName
3305: (or CN).
1.1 jsing 3306: The
3307: .Qq prompt
3308: string is used to ask the user to enter the relevant details.
3309: If the user enters nothing, the default value is used;
3310: if no default value is present, the field is omitted.
3311: A field can still be omitted if a default value is present,
3312: if the user just enters the
3313: .Sq \&.
3314: character.
3315: .Pp
3316: The number of characters entered must be between the
1.63 jmc 3317: fieldName_min and fieldName_max limits:
1.1 jsing 3318: there may be additional restrictions based on the field being used
3319: (for example
1.63 jmc 3320: .Cm countryName
1.1 jsing 3321: can only ever be two characters long and must fit in a
1.63 jmc 3322: .Cm PrintableString ) .
1.1 jsing 3323: .Pp
3324: Some fields (such as
1.63 jmc 3325: .Cm organizationName )
1.1 jsing 3326: can be used more than once in a DN.
3327: This presents a problem because configuration files will
3328: not recognize the same name occurring twice.
3329: To avoid this problem, if the
1.63 jmc 3330: .Cm fieldName
1.1 jsing 3331: contains some characters followed by a full stop, they will be ignored.
3332: So, for example, a second
1.63 jmc 3333: .Cm organizationName
1.1 jsing 3334: can be input by calling it
3335: .Qq 1.organizationName .
3336: .Pp
3337: The actual permitted field names are any object identifier short or
3338: long names.
3339: These are compiled into
1.63 jmc 3340: .Nm openssl
1.1 jsing 3341: and include the usual values such as
1.63 jmc 3342: .Cm commonName , countryName , localityName , organizationName ,
1.89 jmc 3343: .Cm organizationalUnitName , stateOrProvinceName .
1.1 jsing 3344: Additionally,
1.63 jmc 3345: .Cm emailAddress
1.1 jsing 3346: is included as well as
1.63 jmc 3347: .Cm name , surname , givenName , initials
1.1 jsing 3348: and
1.63 jmc 3349: .Cm dnQualifier .
1.1 jsing 3350: .Pp
3351: Additional object identifiers can be defined with the
1.63 jmc 3352: .Cm oid_file
1.1 jsing 3353: or
1.63 jmc 3354: .Cm oid_section
1.1 jsing 3355: options in the configuration file.
3356: Any additional fields will be treated as though they were a
1.63 jmc 3357: .Cm DirectoryString .
1.1 jsing 3358: .Sh RSA
3359: .nr nS 1
3360: .Nm "openssl rsa"
1.64 jmc 3361: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 3362: .Op Fl check
3363: .Op Fl in Ar file
1.64 jmc 3364: .Op Fl inform Cm der | net | pem
1.1 jsing 3365: .Op Fl modulus
3366: .Op Fl noout
3367: .Op Fl out Ar file
1.64 jmc 3368: .Op Fl outform Cm der | net | pem
1.1 jsing 3369: .Op Fl passin Ar arg
3370: .Op Fl passout Ar arg
3371: .Op Fl pubin
3372: .Op Fl pubout
3373: .Op Fl sgckey
3374: .Op Fl text
3375: .nr nS 0
3376: .Pp
3377: The
3378: .Nm rsa
3379: command processes RSA keys.
3380: They can be converted between various forms and their components printed out.
1.64 jmc 3381: .Nm rsa
3382: uses the traditional
1.1 jsing 3383: .Nm SSLeay
3384: compatible format for private key encryption:
3385: newer applications should use the more secure PKCS#8 format using the
3386: .Nm pkcs8
3387: utility.
3388: .Pp
3389: The options are as follows:
3390: .Bl -tag -width Ds
1.64 jmc 3391: .It Fl aes128 | aes192 | aes256 | des | des3
3392: Encrypt the private key with the AES, DES,
1.1 jsing 3393: or the triple DES ciphers, respectively, before outputting it.
3394: A pass phrase is prompted for.
3395: If none of these options are specified, the key is written in plain text.
3396: This means that using the
3397: .Nm rsa
3398: utility to read in an encrypted key with no encryption option can be used
3399: to remove the pass phrase from a key, or by setting the encryption options
3400: it can be used to add or change the pass phrase.
3401: These options can only be used with PEM format output files.
3402: .It Fl check
1.64 jmc 3403: Check the consistency of an RSA private key.
1.1 jsing 3404: .It Fl in Ar file
1.64 jmc 3405: The input file to read from,
3406: or standard input if not specified.
1.1 jsing 3407: If the key is encrypted, a pass phrase will be prompted for.
1.64 jmc 3408: .It Fl inform Cm der | net | pem
3409: The input format.
1.1 jsing 3410: .It Fl noout
1.64 jmc 3411: Do not output the encoded version of the key.
1.1 jsing 3412: .It Fl modulus
1.64 jmc 3413: Print the value of the modulus of the key.
1.1 jsing 3414: .It Fl out Ar file
1.64 jmc 3415: The output file to write to,
3416: or standard output if not specified.
3417: .It Fl outform Cm der | net | pem
3418: The output format.
1.1 jsing 3419: .It Fl passin Ar arg
3420: The key password source.
3421: .It Fl passout Ar arg
3422: The output file password source.
3423: .It Fl pubin
1.64 jmc 3424: Read in a public key,
3425: not a private key.
1.1 jsing 3426: .It Fl pubout
1.64 jmc 3427: Output a public key,
3428: not a private key.
3429: Automatically set if the input is a public key.
1.1 jsing 3430: .It Fl sgckey
1.64 jmc 3431: Use the modified NET algorithm used with some versions of Microsoft IIS
3432: and SGC keys.
1.1 jsing 3433: .It Fl text
1.64 jmc 3434: Print the public/private key components in plain text.
1.1 jsing 3435: .El
3436: .Sh RSAUTL
3437: .nr nS 1
3438: .Nm "openssl rsautl"
3439: .Op Fl asn1parse
3440: .Op Fl certin
3441: .Op Fl decrypt
3442: .Op Fl encrypt
3443: .Op Fl hexdump
3444: .Op Fl in Ar file
3445: .Op Fl inkey Ar file
1.65 jmc 3446: .Op Fl keyform Cm der | pem
1.100 tb 3447: .Op Fl oaep | pkcs | raw | x931
1.1 jsing 3448: .Op Fl out Ar file
1.100 tb 3449: .Op Fl passin Ar arg
1.1 jsing 3450: .Op Fl pubin
1.100 tb 3451: .Op Fl rev
1.1 jsing 3452: .Op Fl sign
3453: .Op Fl verify
3454: .nr nS 0
3455: .Pp
3456: The
3457: .Nm rsautl
3458: command can be used to sign, verify, encrypt and decrypt
3459: data using the RSA algorithm.
3460: .Pp
3461: The options are as follows:
3462: .Bl -tag -width Ds
3463: .It Fl asn1parse
3464: Asn1parse the output data; this is useful when combined with the
3465: .Fl verify
3466: option.
3467: .It Fl certin
3468: The input is a certificate containing an RSA public key.
3469: .It Fl decrypt
3470: Decrypt the input data using an RSA private key.
3471: .It Fl encrypt
3472: Encrypt the input data using an RSA public key.
3473: .It Fl hexdump
3474: Hex dump the output data.
3475: .It Fl in Ar file
1.65 jmc 3476: The input to read from,
3477: or standard input if not specified.
1.1 jsing 3478: .It Fl inkey Ar file
1.65 jmc 3479: The input key file; by default an RSA private key.
3480: .It Fl keyform Cm der | pem
1.85 tb 3481: The private key format.
1.65 jmc 3482: The default is
3483: .Cm pem .
1.100 tb 3484: .It Fl oaep | pkcs | raw | x931
1.1 jsing 3485: The padding to use:
1.100 tb 3486: PKCS#1 OAEP, PKCS#1 v1.5 (the default), no padding, or ANSI X9.31,
3487: respectively.
1.1 jsing 3488: For signatures, only
3489: .Fl pkcs
3490: and
3491: .Fl raw
3492: can be used.
3493: .It Fl out Ar file
1.65 jmc 3494: The output file to write to,
3495: or standard output if not specified.
1.100 tb 3496: .It Fl passin Ar arg
3497: The key password source.
1.1 jsing 3498: .It Fl pubin
3499: The input file is an RSA public key.
1.100 tb 3500: .It Fl rev
3501: Reverse the order of the input buffer.
1.1 jsing 3502: .It Fl sign
3503: Sign the input data and output the signed result.
3504: This requires an RSA private key.
3505: .It Fl verify
3506: Verify the input data and output the recovered data.
3507: .El
3508: .Sh S_CLIENT
3509: .nr nS 1
3510: .Nm "openssl s_client"
3511: .Op Fl 4 | 6
3512: .Op Fl bugs
3513: .Op Fl CAfile Ar file
3514: .Op Fl CApath Ar directory
3515: .Op Fl cert Ar file
3516: .Op Fl check_ss_sig
3517: .Op Fl cipher Ar cipherlist
1.66 jmc 3518: .Op Fl connect Ar host Ns Op : Ns Ar port
1.1 jsing 3519: .Op Fl crl_check
3520: .Op Fl crl_check_all
3521: .Op Fl crlf
3522: .Op Fl debug
3523: .Op Fl extended_crl
1.87 jmc 3524: .Op Fl groups
1.1 jsing 3525: .Op Fl ign_eof
3526: .Op Fl ignore_critical
3527: .Op Fl issuer_checks
3528: .Op Fl key Ar keyfile
3529: .Op Fl msg
3530: .Op Fl nbio
3531: .Op Fl nbio_test
3532: .Op Fl no_ticket
3533: .Op Fl no_tls1
1.6 guenther 3534: .Op Fl no_tls1_1
3535: .Op Fl no_tls1_2
1.1 jsing 3536: .Op Fl pause
3537: .Op Fl policy_check
3538: .Op Fl prexit
1.11 bluhm 3539: .Op Fl proxy Ar host : Ns Ar port
1.1 jsing 3540: .Op Fl psk Ar key
3541: .Op Fl psk_identity Ar identity
3542: .Op Fl quiet
3543: .Op Fl reconnect
1.5 jsing 3544: .Op Fl servername Ar name
1.1 jsing 3545: .Op Fl showcerts
3546: .Op Fl starttls Ar protocol
3547: .Op Fl state
3548: .Op Fl tls1
1.31 jmc 3549: .Op Fl tls1_1
3550: .Op Fl tls1_2
1.1 jsing 3551: .Op Fl tlsextdebug
3552: .Op Fl verify Ar depth
3553: .Op Fl x509_strict
1.19 landry 3554: .Op Fl xmpphost Ar host
1.1 jsing 3555: .nr nS 0
3556: .Pp
3557: The
3558: .Nm s_client
3559: command implements a generic SSL/TLS client which connects
3560: to a remote host using SSL/TLS.
1.66 jmc 3561: .Pp
3562: If a connection is established with an SSL server, any data received
3563: from the server is displayed and any key presses will be sent to the
3564: server.
3565: When used interactively (which means neither
3566: .Fl quiet
3567: nor
3568: .Fl ign_eof
3569: have been given), the session will be renegotiated if the line begins with an
3570: .Cm R ;
3571: if the line begins with a
3572: .Cm Q
3573: or if end of file is reached, the connection will be closed down.
1.1 jsing 3574: .Pp
3575: The options are as follows:
3576: .Bl -tag -width Ds
3577: .It Fl 4
1.66 jmc 3578: Attempt connections using IPv4 only.
1.1 jsing 3579: .It Fl 6
1.66 jmc 3580: Attempt connections using IPv6 only.
1.1 jsing 3581: .It Fl bugs
1.66 jmc 3582: Enable various workarounds for buggy implementations.
1.1 jsing 3583: .It Fl CAfile Ar file
3584: A
3585: .Ar file
3586: containing trusted certificates to use during server authentication
3587: and to use when attempting to build the client certificate chain.
3588: .It Fl CApath Ar directory
3589: The
3590: .Ar directory
3591: to use for server certificate verification.
3592: This directory must be in
3593: .Qq hash format ;
3594: see
3595: .Fl verify
3596: for more information.
3597: These are also used when building the client certificate chain.
3598: .It Fl cert Ar file
3599: The certificate to use, if one is requested by the server.
3600: The default is not to use a certificate.
3601: .It Xo
3602: .Fl check_ss_sig ,
3603: .Fl crl_check ,
3604: .Fl crl_check_all ,
3605: .Fl extended_crl ,
3606: .Fl ignore_critical ,
3607: .Fl issuer_checks ,
3608: .Fl policy_check ,
3609: .Fl x509_strict
3610: .Xc
3611: Set various certificate chain validation options.
3612: See the
1.66 jmc 3613: .Nm verify
1.1 jsing 3614: command for details.
3615: .It Fl cipher Ar cipherlist
1.66 jmc 3616: Modify the cipher list sent by the client.
1.1 jsing 3617: Although the server determines which cipher suite is used, it should take
3618: the first supported cipher in the list sent by the client.
3619: See the
1.66 jmc 3620: .Nm ciphers
3621: command for more information.
3622: .It Fl connect Ar host Ns Op : Ns Ar port
3623: The
1.1 jsing 3624: .Ar host
1.66 jmc 3625: and
1.1 jsing 3626: .Ar port
3627: to connect to.
3628: If not specified, an attempt is made to connect to the local host
3629: on port 4433.
3630: Alternatively, the host and port pair may be separated using a forward-slash
1.66 jmc 3631: character,
3632: which is useful for numeric IPv6 addresses.
1.1 jsing 3633: .It Fl crlf
1.66 jmc 3634: Translate a line feed from the terminal into CR+LF,
3635: as required by some servers.
1.1 jsing 3636: .It Fl debug
1.66 jmc 3637: Print extensive debugging information, including a hex dump of all traffic.
1.87 jmc 3638: .It Fl groups Ar ecgroups
3639: Specify a colon-separated list of permitted EC curve groups.
1.1 jsing 3640: .It Fl ign_eof
1.66 jmc 3641: Inhibit shutting down the connection when end of file is reached in the input.
1.1 jsing 3642: .It Fl key Ar keyfile
3643: The private key to use.
3644: If not specified, the certificate file will be used.
3645: .It Fl msg
3646: Show all protocol messages with hex dump.
3647: .It Fl nbio
1.66 jmc 3648: Turn on non-blocking I/O.
1.1 jsing 3649: .It Fl nbio_test
1.66 jmc 3650: Test non-blocking I/O.
1.31 jmc 3651: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.66 jmc 3652: Disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 3653: .It Fl no_ticket
3654: Disable RFC 4507 session ticket support.
3655: .It Fl pause
1.66 jmc 3656: Pause 1 second between each read and write call.
1.1 jsing 3657: .It Fl prexit
3658: Print session information when the program exits.
3659: This will always attempt
3660: to print out information even if the connection fails.
3661: Normally, information will only be printed out once if the connection succeeds.
3662: This option is useful because the cipher in use may be renegotiated
3663: or the connection may fail because a client certificate is required or is
3664: requested only after an attempt is made to access a certain URL.
1.66 jmc 3665: Note that the output produced by this option is not always accurate
3666: because a connection might never have been established.
1.11 bluhm 3667: .It Fl proxy Ar host : Ns Ar port
3668: Use the HTTP proxy at
3669: .Ar host
3670: and
3671: .Ar port .
3672: The connection to the proxy is done in cleartext and the
3673: .Fl connect
3674: argument is given to the proxy.
3675: If not specified, localhost is used as final destination.
3676: After that, switch the connection through the proxy to the destination
3677: to TLS.
1.1 jsing 3678: .It Fl psk Ar key
3679: Use the PSK key
3680: .Ar key
3681: when using a PSK cipher suite.
3682: The key is given as a hexadecimal number without the leading 0x,
3683: for example -psk 1a2b3c4d.
3684: .It Fl psk_identity Ar identity
1.66 jmc 3685: Use the PSK
1.1 jsing 3686: .Ar identity
3687: when using a PSK cipher suite.
3688: .It Fl quiet
3689: Inhibit printing of session and certificate information.
3690: This implicitly turns on
3691: .Fl ign_eof
3692: as well.
3693: .It Fl reconnect
1.66 jmc 3694: Reconnect to the same server 5 times using the same session ID; this can
1.1 jsing 3695: be used as a test that session caching is working.
1.5 jsing 3696: .It Fl servername Ar name
3697: Include the TLS Server Name Indication (SNI) extension in the ClientHello
3698: message, using the specified server
3699: .Ar name .
1.1 jsing 3700: .It Fl showcerts
3701: Display the whole server certificate chain: normally only the server
3702: certificate itself is displayed.
3703: .It Fl starttls Ar protocol
1.66 jmc 3704: Send the protocol-specific messages to switch to TLS for communication.
1.1 jsing 3705: .Ar protocol
3706: is a keyword for the intended protocol.
3707: Currently, the supported keywords are
3708: .Qq ftp ,
3709: .Qq imap ,
3710: .Qq smtp ,
3711: .Qq pop3 ,
3712: and
3713: .Qq xmpp .
3714: .It Fl state
1.66 jmc 3715: Print the SSL session states.
1.31 jmc 3716: .It Fl tls1 | tls1_1 | tls1_2
3717: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 3718: .It Fl tlsextdebug
1.66 jmc 3719: Print a hex dump of any TLS extensions received from the server.
1.1 jsing 3720: .It Fl verify Ar depth
1.66 jmc 3721: Turn on server certificate verification,
3722: with a maximum length of
3723: .Ar depth .
1.1 jsing 3724: Currently the verify operation continues after errors so all the problems
3725: with a certificate chain can be seen.
3726: As a side effect the connection will never fail due to a server
3727: certificate verify failure.
1.19 landry 3728: .It Fl xmpphost Ar hostname
1.66 jmc 3729: When used with
1.19 landry 3730: .Fl starttls Ar xmpp ,
1.66 jmc 3731: specify the host for the "to" attribute of the stream element.
1.19 landry 3732: If this option is not specified then the host specified with
3733: .Fl connect
3734: will be used.
1.1 jsing 3735: .El
3736: .Sh S_SERVER
3737: .nr nS 1
3738: .Nm "openssl s_server"
3739: .Op Fl accept Ar port
3740: .Op Fl bugs
3741: .Op Fl CAfile Ar file
3742: .Op Fl CApath Ar directory
3743: .Op Fl cert Ar file
3744: .Op Fl cipher Ar cipherlist
3745: .Op Fl context Ar id
3746: .Op Fl crl_check
3747: .Op Fl crl_check_all
3748: .Op Fl crlf
3749: .Op Fl dcert Ar file
3750: .Op Fl debug
3751: .Op Fl dhparam Ar file
3752: .Op Fl dkey Ar file
3753: .Op Fl hack
3754: .Op Fl HTTP
3755: .Op Fl id_prefix Ar arg
3756: .Op Fl key Ar keyfile
3757: .Op Fl msg
3758: .Op Fl nbio
3759: .Op Fl nbio_test
3760: .Op Fl no_dhe
3761: .Op Fl no_tls1
1.6 guenther 3762: .Op Fl no_tls1_1
3763: .Op Fl no_tls1_2
1.1 jsing 3764: .Op Fl no_tmp_rsa
3765: .Op Fl nocert
3766: .Op Fl psk Ar key
3767: .Op Fl psk_hint Ar hint
3768: .Op Fl quiet
3769: .Op Fl serverpref
3770: .Op Fl state
3771: .Op Fl tls1
1.31 jmc 3772: .Op Fl tls1_1
3773: .Op Fl tls1_2
1.1 jsing 3774: .Op Fl Verify Ar depth
3775: .Op Fl verify Ar depth
3776: .Op Fl WWW
3777: .Op Fl www
3778: .nr nS 0
3779: .Pp
3780: The
3781: .Nm s_server
3782: command implements a generic SSL/TLS server which listens
3783: for connections on a given port using SSL/TLS.
3784: .Pp
1.67 jmc 3785: If a connection request is established with a client and neither the
3786: .Fl www
3787: nor the
3788: .Fl WWW
3789: option has been used, then any data received
3790: from the client is displayed and any key presses are sent to the client.
3791: Certain single letter commands perform special operations:
3792: .Pp
3793: .Bl -tag -width "XXXX" -compact
3794: .It Ic P
3795: Send plain text, which should cause the client to disconnect.
3796: .It Ic Q
3797: End the current SSL connection and exit.
3798: .It Ic q
3799: End the current SSL connection, but still accept new connections.
3800: .It Ic R
3801: Renegotiate the SSL session and request a client certificate.
3802: .It Ic r
3803: Renegotiate the SSL session.
3804: .It Ic S
3805: Print out some session cache status information.
3806: .El
3807: .Pp
1.1 jsing 3808: The options are as follows:
3809: .Bl -tag -width Ds
3810: .It Fl accept Ar port
1.67 jmc 3811: Listen on TCP
1.1 jsing 3812: .Ar port
1.67 jmc 3813: for connections.
3814: The default is port 4433.
1.1 jsing 3815: .It Fl bugs
1.67 jmc 3816: Enable various workarounds for buggy implementations.
1.1 jsing 3817: .It Fl CAfile Ar file
1.67 jmc 3818: A
3819: .Ar file
3820: containing trusted certificates to use during client authentication
1.1 jsing 3821: and to use when attempting to build the server certificate chain.
3822: The list is also used in the list of acceptable client CAs passed to the
3823: client when a certificate is requested.
3824: .It Fl CApath Ar directory
3825: The
3826: .Ar directory
3827: to use for client certificate verification.
3828: This directory must be in
3829: .Qq hash format ;
3830: see
3831: .Fl verify
3832: for more information.
3833: These are also used when building the server certificate chain.
3834: .It Fl cert Ar file
1.67 jmc 3835: The certificate to use: most server's cipher suites require the use of a
3836: certificate and some require a certificate with a certain public key type.
3837: For example, the DSS cipher suites require a certificate containing a DSS
3838: (DSA) key.
1.1 jsing 3839: If not specified, the file
3840: .Pa server.pem
3841: will be used.
3842: .It Fl cipher Ar cipherlist
1.67 jmc 3843: Modify the cipher list used by the server.
1.1 jsing 3844: This allows the cipher list used by the server to be modified.
3845: When the client sends a list of supported ciphers, the first client cipher
3846: also included in the server list is used.
3847: Because the client specifies the preference order, the order of the server
3848: cipherlist is irrelevant.
3849: See the
1.67 jmc 3850: .Nm ciphers
3851: command for more information.
1.1 jsing 3852: .It Fl context Ar id
1.67 jmc 3853: Set the SSL context ID.
1.1 jsing 3854: It can be given any string value.
3855: .It Fl crl_check , crl_check_all
3856: Check the peer certificate has not been revoked by its CA.
3857: The CRLs are appended to the certificate file.
3858: .Fl crl_check_all
1.67 jmc 3859: checks all CRLs of all CAs in the chain.
1.1 jsing 3860: .It Fl crlf
1.67 jmc 3861: Translate a line feed from the terminal into CR+LF.
1.1 jsing 3862: .It Fl dcert Ar file , Fl dkey Ar file
3863: Specify an additional certificate and private key; these behave in the
3864: same manner as the
3865: .Fl cert
3866: and
3867: .Fl key
3868: options except there is no default if they are not specified
1.67 jmc 3869: (no additional certificate or key is used).
1.1 jsing 3870: By using RSA and DSS certificates and keys,
3871: a server can support clients which only support RSA or DSS cipher suites
3872: by using an appropriate certificate.
3873: .It Fl debug
1.67 jmc 3874: Print extensive debugging information, including a hex dump of all traffic.
1.1 jsing 3875: .It Fl dhparam Ar file
3876: The DH parameter file to use.
3877: The ephemeral DH cipher suites generate keys
3878: using a set of DH parameters.
3879: If not specified, an attempt is made to
3880: load the parameters from the server certificate file.
3881: If this fails, a static set of parameters hard coded into the
3882: .Nm s_server
3883: program will be used.
3884: .It Fl hack
1.67 jmc 3885: Enables a further workaround for some early Netscape SSL code.
1.1 jsing 3886: .It Fl HTTP
1.67 jmc 3887: Emulate a simple web server.
3888: Pages are resolved relative to the current directory.
3889: For example if the URL
1.1 jsing 3890: .Pa https://myhost/page.html
3891: is requested, the file
3892: .Pa ./page.html
3893: will be loaded.
3894: The files loaded are assumed to contain a complete and correct HTTP
3895: response (lines that are part of the HTTP response line and headers
3896: must end with CRLF).
3897: .It Fl id_prefix Ar arg
3898: Generate SSL/TLS session IDs prefixed by
3899: .Ar arg .
3900: This is mostly useful for testing any SSL/TLS code
1.81 jmc 3901: that wish to deal with multiple servers,
3902: when each of which might be generating a unique range of session IDs.
1.1 jsing 3903: .It Fl key Ar keyfile
3904: The private key to use.
3905: If not specified, the certificate file will be used.
3906: .It Fl msg
3907: Show all protocol messages with hex dump.
3908: .It Fl nbio
1.67 jmc 3909: Turn on non-blocking I/O.
1.1 jsing 3910: .It Fl nbio_test
1.67 jmc 3911: Test non-blocking I/O.
1.1 jsing 3912: .It Fl no_dhe
1.67 jmc 3913: Disable ephemeral DH cipher suites.
1.31 jmc 3914: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.67 jmc 3915: Disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 3916: .It Fl no_tmp_rsa
1.67 jmc 3917: Disable temporary RSA key generation.
1.1 jsing 3918: .It Fl nocert
1.67 jmc 3919: Do not use a certificate.
1.1 jsing 3920: This restricts the cipher suites available to the anonymous ones
1.67 jmc 3921: (currently just anonymous DH).
1.1 jsing 3922: .It Fl psk Ar key
3923: Use the PSK key
3924: .Ar key
3925: when using a PSK cipher suite.
3926: The key is given as a hexadecimal number without the leading 0x,
3927: for example -psk 1a2b3c4d.
3928: .It Fl psk_hint Ar hint
3929: Use the PSK identity hint
3930: .Ar hint
3931: when using a PSK cipher suite.
3932: .It Fl quiet
3933: Inhibit printing of session and certificate information.
3934: .It Fl serverpref
3935: Use server's cipher preferences.
3936: .It Fl state
1.67 jmc 3937: Print the SSL session states.
1.31 jmc 3938: .It Fl tls1 | tls1_1 | tls1_2
3939: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 3940: .It Fl WWW
1.67 jmc 3941: Emulate a simple web server.
3942: Pages are resolved relative to the current directory.
3943: For example if the URL
1.1 jsing 3944: .Pa https://myhost/page.html
3945: is requested, the file
3946: .Pa ./page.html
3947: will be loaded.
3948: .It Fl www
1.67 jmc 3949: Send a status message to the client when it connects,
3950: including information about the ciphers used and various session parameters.
1.1 jsing 3951: The output is in HTML format so this option will normally be used with a
3952: web browser.
3953: .It Fl Verify Ar depth , Fl verify Ar depth
1.67 jmc 3954: Request a certificate chain from the client,
3955: with a maximum length of
3956: .Ar depth .
3957: With
3958: .Fl Verify ,
3959: the client must supply a certificate or an error occurs;
3960: with
3961: .Fl verify ,
3962: a certificate is requested but the client does not have to send one.
1.1 jsing 3963: .El
3964: .Sh S_TIME
3965: .nr nS 1
3966: .Nm "openssl s_time"
3967: .Op Fl bugs
3968: .Op Fl CAfile Ar file
3969: .Op Fl CApath Ar directory
3970: .Op Fl cert Ar file
3971: .Op Fl cipher Ar cipherlist
1.68 jmc 3972: .Op Fl connect Ar host Ns Op : Ns Ar port
1.1 jsing 3973: .Op Fl key Ar keyfile
3974: .Op Fl nbio
3975: .Op Fl new
1.20 lteo 3976: .Op Fl no_shutdown
1.1 jsing 3977: .Op Fl reuse
3978: .Op Fl time Ar seconds
3979: .Op Fl verify Ar depth
3980: .Op Fl www Ar page
3981: .nr nS 0
3982: .Pp
3983: The
1.68 jmc 3984: .Nm s_time
1.1 jsing 3985: command implements a generic SSL/TLS client which connects to a
3986: remote host using SSL/TLS.
3987: It can request a page from the server and includes
3988: the time to transfer the payload data in its timing measurements.
3989: It measures the number of connections within a given timeframe,
3990: the amount of data transferred
3991: .Pq if any ,
3992: and calculates the average time spent for one connection.
3993: .Pp
3994: The options are as follows:
3995: .Bl -tag -width Ds
3996: .It Fl bugs
1.68 jmc 3997: Enable various workarounds for buggy implementations.
1.1 jsing 3998: .It Fl CAfile Ar file
1.68 jmc 3999: A
4000: .Ar file
4001: containing trusted certificates to use during server authentication
1.1 jsing 4002: and to use when attempting to build the client certificate chain.
4003: .It Fl CApath Ar directory
4004: The directory to use for server certificate verification.
4005: This directory must be in
4006: .Qq hash format ;
4007: see
4008: .Nm verify
4009: for more information.
4010: These are also used when building the client certificate chain.
4011: .It Fl cert Ar file
4012: The certificate to use, if one is requested by the server.
4013: The default is not to use a certificate.
4014: .It Fl cipher Ar cipherlist
1.68 jmc 4015: Modify the cipher list sent by the client.
1.1 jsing 4016: Although the server determines which cipher suite is used,
4017: it should take the first supported cipher in the list sent by the client.
4018: See the
4019: .Nm ciphers
4020: command for more information.
1.68 jmc 4021: .It Fl connect Ar host Ns Op : Ns Ar port
4022: The host and port to connect to.
1.1 jsing 4023: .It Fl key Ar keyfile
4024: The private key to use.
4025: If not specified, the certificate file will be used.
4026: .It Fl nbio
1.68 jmc 4027: Turn on non-blocking I/O.
1.1 jsing 4028: .It Fl new
1.68 jmc 4029: Perform the timing test using a new session ID for each connection.
1.1 jsing 4030: If neither
4031: .Fl new
4032: nor
4033: .Fl reuse
4034: are specified,
4035: they are both on by default and executed in sequence.
1.20 lteo 4036: .It Fl no_shutdown
1.21 jmc 4037: Shut down the connection without sending a
1.68 jmc 4038: .Qq close notify
1.20 lteo 4039: shutdown alert to the server.
1.1 jsing 4040: .It Fl reuse
1.68 jmc 4041: Perform the timing test using the same session ID for each connection.
1.1 jsing 4042: If neither
4043: .Fl new
4044: nor
4045: .Fl reuse
4046: are specified,
4047: they are both on by default and executed in sequence.
4048: .It Fl time Ar seconds
1.68 jmc 4049: Limit
1.1 jsing 4050: .Nm s_time
1.68 jmc 4051: benchmarks to the number of
4052: .Ar seconds .
1.1 jsing 4053: The default is 30 seconds.
4054: .It Fl verify Ar depth
1.68 jmc 4055: Turn on server certificate verification,
4056: with a maximum length of
4057: .Ar depth .
1.1 jsing 4058: Currently the verify operation continues after errors, so all the problems
4059: with a certificate chain can be seen.
4060: As a side effect,
4061: the connection will never fail due to a server certificate verify failure.
4062: .It Fl www Ar page
1.68 jmc 4063: The page to GET from the server.
1.1 jsing 4064: A value of
4065: .Sq /
4066: gets the index.htm[l] page.
4067: If this parameter is not specified,
4068: .Nm s_time
4069: will only perform the handshake to establish SSL connections
4070: but not transfer any payload data.
4071: .El
4072: .Sh SESS_ID
4073: .nr nS 1
4074: .Nm "openssl sess_id"
4075: .Op Fl cert
4076: .Op Fl context Ar ID
4077: .Op Fl in Ar file
1.69 jmc 4078: .Op Fl inform Cm der | pem
1.1 jsing 4079: .Op Fl noout
4080: .Op Fl out Ar file
1.69 jmc 4081: .Op Fl outform Cm der | pem
1.1 jsing 4082: .Op Fl text
4083: .nr nS 0
4084: .Pp
4085: The
4086: .Nm sess_id
4087: program processes the encoded version of the SSL session structure and
4088: optionally prints out SSL session details
1.69 jmc 4089: (for example the SSL session master key)
1.72 jmc 4090: in human-readable format.
1.1 jsing 4091: .Pp
4092: The options are as follows:
4093: .Bl -tag -width Ds
4094: .It Fl cert
4095: If a certificate is present in the session,
4096: it will be output using this option;
4097: if the
4098: .Fl text
4099: option is also present, then it will be printed out in text form.
4100: .It Fl context Ar ID
1.69 jmc 4101: Set the session
1.1 jsing 4102: .Ar ID .
1.69 jmc 4103: The ID can be any string of characters.
1.1 jsing 4104: .It Fl in Ar file
1.69 jmc 4105: The input file to read from,
4106: or standard input if not specified.
4107: .It Fl inform Cm der | pem
4108: The input format.
4109: .Cm der
1.84 jmc 4110: uses an ASN.1 DER-encoded format containing session details.
1.1 jsing 4111: The precise format can vary from one version to the next.
1.69 jmc 4112: .Cm pem
4113: is the default format: it consists of the DER
1.1 jsing 4114: format base64-encoded with additional header and footer lines.
4115: .It Fl noout
1.69 jmc 4116: Do not output the encoded version of the session.
1.1 jsing 4117: .It Fl out Ar file
1.69 jmc 4118: The output file to write to,
4119: or standard output if not specified.
4120: .It Fl outform Cm der | pem
4121: The output format.
1.1 jsing 4122: .It Fl text
1.69 jmc 4123: Print the various public or private key components in plain text,
4124: in addition to the encoded version.
1.1 jsing 4125: .El
4126: .Pp
1.69 jmc 4127: The output of
4128: .Nm sess_id
4129: is composed as follows:
1.1 jsing 4130: .Pp
1.69 jmc 4131: .Bl -tag -width "Verify return code " -offset 3n -compact
4132: .It Protocol
4133: The protocol in use.
4134: .It Cipher
4135: The actual raw SSL or TLS cipher code.
4136: .It Session-ID
4137: The SSL session ID, in hex format.
4138: .It Session-ID-ctx
4139: The session ID context, in hex format.
4140: .It Master-Key
4141: The SSL session master key.
4142: .It Key-Arg
1.1 jsing 4143: The key argument; this is only used in SSL v2.
1.69 jmc 4144: .It Start Time
4145: The session start time.
1.1 jsing 4146: .Ux
4147: format.
1.69 jmc 4148: .It Timeout
4149: The timeout, in seconds.
4150: .It Verify return code
4151: The return code when a certificate is verified.
1.1 jsing 4152: .El
4153: .Pp
4154: Since the SSL session output contains the master key, it is possible to read
4155: the contents of an encrypted session using this information.
4156: Therefore appropriate security precautions
4157: should be taken if the information is being output by a
4158: .Qq real
4159: application.
4160: This is, however, strongly discouraged and should only be used for
4161: debugging purposes.
4162: .Sh SMIME
4163: .nr nS 1
4164: .Nm "openssl smime"
4165: .Oo
4166: .Fl aes128 | aes192 | aes256 | des |
4167: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4168: .Oc
4169: .Op Fl binary
4170: .Op Fl CAfile Ar file
4171: .Op Fl CApath Ar directory
4172: .Op Fl certfile Ar file
4173: .Op Fl check_ss_sig
4174: .Op Fl content Ar file
4175: .Op Fl crl_check
4176: .Op Fl crl_check_all
4177: .Op Fl decrypt
4178: .Op Fl encrypt
4179: .Op Fl extended_crl
4180: .Op Fl from Ar addr
4181: .Op Fl ignore_critical
4182: .Op Fl in Ar file
4183: .Op Fl indef
1.70 jmc 4184: .Op Fl inform Cm der | pem | smime
1.1 jsing 4185: .Op Fl inkey Ar file
4186: .Op Fl issuer_checks
1.70 jmc 4187: .Op Fl keyform Cm pem
1.1 jsing 4188: .Op Fl md Ar digest
4189: .Op Fl noattr
4190: .Op Fl nocerts
4191: .Op Fl nochain
4192: .Op Fl nodetach
4193: .Op Fl noindef
4194: .Op Fl nointern
4195: .Op Fl nosigs
4196: .Op Fl noverify
4197: .Op Fl out Ar file
1.70 jmc 4198: .Op Fl outform Cm der | pem | smime
1.1 jsing 4199: .Op Fl passin Ar arg
4200: .Op Fl pk7out
4201: .Op Fl policy_check
4202: .Op Fl recip Ar file
4203: .Op Fl resign
4204: .Op Fl sign
4205: .Op Fl signer Ar file
4206: .Op Fl stream
4207: .Op Fl subject Ar s
4208: .Op Fl text
4209: .Op Fl to Ar addr
4210: .Op Fl verify
4211: .Op Fl x509_strict
4212: .Op Ar cert.pem ...
4213: .nr nS 0
4214: .Pp
4215: The
4216: .Nm smime
1.70 jmc 4217: command handles S/MIME mail.
4218: It can encrypt, decrypt, sign, and verify S/MIME messages.
4219: .Pp
4220: The MIME message must be sent without any blank lines between the
4221: headers and the output.
4222: Some mail programs will automatically add a blank line.
4223: Piping the mail directly to an MTA is one way to
4224: achieve the correct format.
4225: .Pp
4226: The supplied message to be signed or encrypted must include the necessary
4227: MIME headers or many S/MIME clients won't display it properly (if at all).
4228: Use the
4229: .Fl text
4230: option to automatically add plain text headers.
1.1 jsing 4231: .Pp
1.70 jmc 4232: A
4233: .Qq signed and encrypted
4234: message is one where a signed message is then encrypted.
4235: This can be produced by encrypting an already signed message.
1.1 jsing 4236: .Pp
1.70 jmc 4237: There are a number of operations that can be performed, as follows:
1.1 jsing 4238: .Bl -tag -width "XXXX"
4239: .It Fl decrypt
4240: Decrypt mail using the supplied certificate and private key.
1.70 jmc 4241: The input file is an encrypted mail message in MIME format.
1.1 jsing 4242: The decrypted mail is written to the output file.
4243: .It Fl encrypt
4244: Encrypt mail for the given recipient certificates.
1.70 jmc 4245: The input is the message to be encrypted.
4246: The output file is the encrypted mail, in MIME format.
1.1 jsing 4247: .It Fl pk7out
1.70 jmc 4248: Take an input message and write out a PEM-encoded PKCS#7 structure.
1.1 jsing 4249: .It Fl resign
4250: Resign a message: take an existing message and one or more new signers.
4251: .It Fl sign
4252: Sign mail using the supplied certificate and private key.
1.70 jmc 4253: The input file is the message to be signed.
4254: The signed message, in MIME format, is written to the output file.
1.1 jsing 4255: .It Fl verify
4256: Verify signed mail.
1.70 jmc 4257: The input is a signed mail message and the output is the signed data.
1.1 jsing 4258: Both clear text and opaque signing is supported.
4259: .El
4260: .Pp
1.14 jmc 4261: The remaining options are as follows:
1.1 jsing 4262: .Bl -tag -width "XXXX"
4263: .It Xo
4264: .Fl aes128 | aes192 | aes256 | des |
4265: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4266: .Xc
4267: The encryption algorithm to use.
1.70 jmc 4268: 128-, 192-, or 256-bit AES, DES (56 bits), triple DES (168 bits),
1.1 jsing 4269: or 40-, 64-, or 128-bit RC2, respectively;
4270: if not specified, 40-bit RC2 is
4271: used.
4272: Only used with
4273: .Fl encrypt .
4274: .It Fl binary
4275: Normally, the input message is converted to
4276: .Qq canonical
1.70 jmc 4277: format which uses CR/LF as end of line,
4278: as required by the S/MIME specification.
1.1 jsing 4279: When this option is present no translation occurs.
1.70 jmc 4280: This is useful when handling binary data which may not be in MIME format.
1.1 jsing 4281: .It Fl CAfile Ar file
4282: A
4283: .Ar file
4284: containing trusted CA certificates; only used with
4285: .Fl verify .
4286: .It Fl CApath Ar directory
4287: A
4288: .Ar directory
4289: containing trusted CA certificates; only used with
4290: .Fl verify .
4291: This directory must be a standard certificate directory:
4292: that is, a hash of each subject name (using
4293: .Nm x509 -hash )
4294: should be linked to each certificate.
4295: .It Ar cert.pem ...
4296: One or more certificates of message recipients: used when encrypting
4297: a message.
4298: .It Fl certfile Ar file
4299: Allows additional certificates to be specified.
4300: When signing, these will be included with the message.
4301: When verifying, these will be searched for the signers' certificates.
4302: The certificates should be in PEM format.
4303: .It Xo
4304: .Fl check_ss_sig ,
4305: .Fl crl_check ,
4306: .Fl crl_check_all ,
4307: .Fl extended_crl ,
4308: .Fl ignore_critical ,
4309: .Fl issuer_checks ,
4310: .Fl policy_check ,
4311: .Fl x509_strict
4312: .Xc
4313: Set various certificate chain validation options.
4314: See the
1.70 jmc 4315: .Nm verify
1.1 jsing 4316: command for details.
4317: .It Fl content Ar file
1.70 jmc 4318: A file containing the detached content.
1.1 jsing 4319: This is only useful with the
4320: .Fl verify
1.70 jmc 4321: option,
4322: and only usable if the PKCS#7 structure is using the detached
1.1 jsing 4323: signature form where the content is not included.
1.70 jmc 4324: This option will override any content if the input format is S/MIME
4325: and it uses the multipart/signed MIME content type.
1.1 jsing 4326: .It Xo
4327: .Fl from Ar addr ,
4328: .Fl subject Ar s ,
4329: .Fl to Ar addr
4330: .Xc
4331: The relevant mail headers.
4332: These are included outside the signed
4333: portion of a message so they may be included manually.
1.70 jmc 4334: When signing, many S/MIME
1.1 jsing 4335: mail clients check that the signer's certificate email
4336: address matches the From: address.
4337: .It Fl in Ar file
1.70 jmc 4338: The input file to read from.
1.1 jsing 4339: .It Fl indef
4340: Enable streaming I/O for encoding operations.
4341: This permits single pass processing of data without
4342: the need to hold the entire contents in memory,
4343: potentially supporting very large files.
4344: Streaming is automatically set for S/MIME signing with detached
4345: data if the output format is SMIME;
4346: it is currently off by default for all other operations.
1.70 jmc 4347: .It Fl inform Cm der | pem | smime
4348: The input format.
1.1 jsing 4349: .It Fl inkey Ar file
1.70 jmc 4350: The private key to use when signing or decrypting,
4351: which must match the corresponding certificate.
1.1 jsing 4352: If this option is not specified, the private key must be included
4353: in the certificate file specified with
4354: the
4355: .Fl recip
4356: or
4357: .Fl signer
4358: file.
4359: When signing,
4360: this option can be used multiple times to specify successive keys.
1.70 jmc 4361: .It Fl keyform Cm pem
1.1 jsing 4362: Input private key format.
4363: .It Fl md Ar digest
4364: The digest algorithm to use when signing or resigning.
4365: If not present then the default digest algorithm for the signing key is used
4366: (usually SHA1).
4367: .It Fl noattr
1.70 jmc 4368: Do not include attributes.
1.1 jsing 4369: .It Fl nocerts
1.70 jmc 4370: Do not include the signer's certificate.
1.1 jsing 4371: This will reduce the size of the signed message but the verifier must
4372: have a copy of the signer's certificate available locally (passed using the
4373: .Fl certfile
4374: option, for example).
4375: .It Fl nochain
4376: Do not do chain verification of signers' certificates: that is,
4377: don't use the certificates in the signed message as untrusted CAs.
4378: .It Fl nodetach
4379: When signing a message use opaque signing: this form is more resistant
4380: to translation by mail relays but it cannot be read by mail agents that
1.70 jmc 4381: do not support S/MIME.
4382: Without this option cleartext signing with the MIME type
4383: multipart/signed is used.
1.1 jsing 4384: .It Fl noindef
1.70 jmc 4385: Disable streaming I/O where it would produce an encoding of indefinite length
4386: (currently has no effect).
1.1 jsing 4387: .It Fl nointern
1.70 jmc 4388: Only use certificates specified in the
4389: .Fl certfile .
4390: The supplied certificates can still be used as untrusted CAs.
1.1 jsing 4391: .It Fl nosigs
1.70 jmc 4392: Do not try to verify the signatures on the message.
1.1 jsing 4393: .It Fl noverify
4394: Do not verify the signer's certificate of a signed message.
4395: .It Fl out Ar file
1.70 jmc 4396: The output file to write to.
4397: .It Fl outform Cm der | pem | smime
4398: The output format.
4399: The default is smime, which writes an S/MIME format message.
4400: .Cm pem
1.1 jsing 4401: and
1.70 jmc 4402: .Cm der
4403: change this to write PEM and DER format PKCS#7 structures instead.
1.1 jsing 4404: This currently only affects the output format of the PKCS#7
4405: structure; if no PKCS#7 structure is being output (for example with
4406: .Fl verify
4407: or
4408: .Fl decrypt )
4409: this option has no effect.
4410: .It Fl passin Ar arg
4411: The key password source.
4412: .It Fl recip Ar file
4413: The recipients certificate when decrypting a message.
4414: This certificate
4415: must match one of the recipients of the message or an error occurs.
4416: .It Fl signer Ar file
4417: A signing certificate when signing or resigning a message;
4418: this option can be used multiple times if more than one signer is required.
4419: If a message is being verified, the signer's certificates will be
4420: written to this file if the verification was successful.
4421: .It Fl stream
4422: The same as
4423: .Fl indef .
4424: .It Fl text
1.70 jmc 4425: Add plain text (text/plain) MIME
1.1 jsing 4426: headers to the supplied message if encrypting or signing.
4427: If decrypting or verifying, it strips off text headers:
1.70 jmc 4428: if the decrypted or verified message is not of MIME type text/plain
4429: then an error occurs.
1.1 jsing 4430: .El
4431: .Pp
1.70 jmc 4432: The exit codes for
4433: .Nm smime
4434: are as follows:
1.1 jsing 4435: .Pp
1.70 jmc 4436: .Bl -tag -width "XXXX" -offset 3n -compact
4437: .It 0
1.1 jsing 4438: The operation was completely successful.
1.70 jmc 4439: .It 1
1.1 jsing 4440: An error occurred parsing the command options.
1.70 jmc 4441: .It 2
1.1 jsing 4442: One of the input files could not be read.
1.70 jmc 4443: .It 3
4444: An error occurred creating the file or when reading the message.
4445: .It 4
1.1 jsing 4446: An error occurred decrypting or verifying the message.
1.70 jmc 4447: .It 5
4448: An error occurred writing certificates.
1.1 jsing 4449: .El
4450: .Sh SPEED
4451: .nr nS 1
4452: .Nm "openssl speed"
1.71 jmc 4453: .Op Ar algorithm
1.1 jsing 4454: .Op Fl decrypt
4455: .Op Fl elapsed
1.71 jmc 4456: .Op Fl evp Ar algorithm
1.1 jsing 4457: .Op Fl mr
4458: .Op Fl multi Ar number
4459: .nr nS 0
4460: .Pp
4461: The
4462: .Nm speed
4463: command is used to test the performance of cryptographic algorithms.
4464: .Bl -tag -width "XXXX"
1.71 jmc 4465: .It Ar algorithm
4466: Perform the test using
4467: .Ar algorithm .
4468: The default is to test all algorithms.
1.1 jsing 4469: .It Fl decrypt
1.71 jmc 4470: Time decryption instead of encryption;
4471: must be used with
4472: .Fl evp .
1.1 jsing 4473: .It Fl elapsed
4474: Measure time in real time instead of CPU user time.
1.71 jmc 4475: .It Fl evp Ar algorithm
4476: Perform the test using one of the algorithms accepted by
4477: .Xr EVP_get_cipherbyname 3 .
1.1 jsing 4478: .It Fl mr
4479: Produce machine readable output.
4480: .It Fl multi Ar number
4481: Run
4482: .Ar number
4483: benchmarks in parallel.
4484: .El
1.77 jmc 4485: .Sh SPKAC
4486: .nr nS 1
4487: .Nm "openssl spkac"
4488: .Op Fl challenge Ar string
4489: .Op Fl in Ar file
4490: .Op Fl key Ar keyfile
4491: .Op Fl noout
4492: .Op Fl out Ar file
4493: .Op Fl passin Ar arg
4494: .Op Fl pubkey
4495: .Op Fl spkac Ar spkacname
4496: .Op Fl spksect Ar section
4497: .Op Fl verify
4498: .nr nS 0
4499: .Pp
4500: The
4501: .Nm spkac
4502: command processes signed public key and challenge (SPKAC) files.
4503: It can print out their contents, verify the signature,
4504: and produce its own SPKACs from a supplied private key.
4505: .Pp
4506: The options are as follows:
4507: .Bl -tag -width Ds
4508: .It Fl challenge Ar string
4509: The challenge string, if an SPKAC is being created.
4510: .It Fl in Ar file
4511: The input file to read from,
4512: or standard input if not specified.
4513: Ignored if the
4514: .Fl key
4515: option is used.
4516: .It Fl key Ar keyfile
4517: Create an SPKAC file using the private key in
4518: .Ar keyfile .
4519: The
4520: .Fl in , noout , spksect ,
4521: and
4522: .Fl verify
4523: options are ignored, if present.
4524: .It Fl noout
4525: Do not output the text version of the SPKAC.
4526: .It Fl out Ar file
4527: The output file to write to,
4528: or standard output if not specified.
4529: .It Fl passin Ar arg
4530: The key password source.
4531: .It Fl pubkey
4532: Output the public key of an SPKAC.
4533: .It Fl spkac Ar spkacname
4534: An alternative name for the variable containing the SPKAC.
4535: The default is "SPKAC".
4536: This option affects both generated and input SPKAC files.
4537: .It Fl spksect Ar section
4538: An alternative name for the
4539: .Ar section
4540: containing the SPKAC.
4541: .It Fl verify
4542: Verify the digital signature on the supplied SPKAC.
4543: .El
1.1 jsing 4544: .Sh TS
4545: .nr nS 1
4546: .Nm "openssl ts"
4547: .Fl query
1.29 bcook 4548: .Op Fl md4 | md5 | ripemd160 | sha1
1.1 jsing 4549: .Op Fl cert
4550: .Op Fl config Ar configfile
4551: .Op Fl data Ar file_to_hash
4552: .Op Fl digest Ar digest_bytes
4553: .Op Fl in Ar request.tsq
4554: .Op Fl no_nonce
4555: .Op Fl out Ar request.tsq
4556: .Op Fl policy Ar object_id
4557: .Op Fl text
4558: .nr nS 0
4559: .Pp
4560: .nr nS 1
4561: .Nm "openssl ts"
4562: .Fl reply
4563: .Op Fl chain Ar certs_file.pem
4564: .Op Fl config Ar configfile
4565: .Op Fl in Ar response.tsr
4566: .Op Fl inkey Ar private.pem
4567: .Op Fl out Ar response.tsr
4568: .Op Fl passin Ar arg
4569: .Op Fl policy Ar object_id
4570: .Op Fl queryfile Ar request.tsq
4571: .Op Fl section Ar tsa_section
4572: .Op Fl signer Ar tsa_cert.pem
4573: .Op Fl text
4574: .Op Fl token_in
4575: .Op Fl token_out
4576: .nr nS 0
4577: .Pp
4578: .nr nS 1
4579: .Nm "openssl ts"
4580: .Fl verify
4581: .Op Fl CAfile Ar trusted_certs.pem
4582: .Op Fl CApath Ar trusted_cert_path
4583: .Op Fl data Ar file_to_hash
4584: .Op Fl digest Ar digest_bytes
4585: .Op Fl in Ar response.tsr
4586: .Op Fl queryfile Ar request.tsq
4587: .Op Fl token_in
4588: .Op Fl untrusted Ar cert_file.pem
4589: .nr nS 0
4590: .Pp
4591: The
4592: .Nm ts
4593: command is a basic Time Stamping Authority (TSA) client and server
4594: application as specified in RFC 3161 (Time-Stamp Protocol, TSP).
4595: A TSA can be part of a PKI deployment and its role is to provide long
1.72 jmc 4596: term proof of the existence of specific data.
1.1 jsing 4597: Here is a brief description of the protocol:
4598: .Bl -enum
4599: .It
4600: The TSA client computes a one-way hash value for a data file and sends
4601: the hash to the TSA.
4602: .It
4603: The TSA attaches the current date and time to the received hash value,
4604: signs them and sends the time stamp token back to the client.
4605: By creating this token the TSA certifies the existence of the original
4606: data file at the time of response generation.
4607: .It
4608: The TSA client receives the time stamp token and verifies the
4609: signature on it.
4610: It also checks if the token contains the same hash
4611: value that it had sent to the TSA.
4612: .El
4613: .Pp
4614: There is one DER-encoded protocol data unit defined for transporting a time
4615: stamp request to the TSA and one for sending the time stamp response
4616: back to the client.
4617: The
4618: .Nm ts
4619: command has three main functions:
4620: creating a time stamp request based on a data file;
4621: creating a time stamp response based on a request;
4622: and verifying if a response corresponds
4623: to a particular request or a data file.
4624: .Pp
4625: There is no support for sending the requests/responses automatically
4626: over HTTP or TCP yet as suggested in RFC 3161.
4627: Users must send the requests either by FTP or email.
4628: .Pp
4629: The
4630: .Fl query
4631: switch can be used for creating and printing a time stamp
4632: request with the following options:
4633: .Bl -tag -width Ds
4634: .It Fl cert
1.72 jmc 4635: Expect the TSA to include its signing certificate in the response.
1.1 jsing 4636: .It Fl config Ar configfile
1.72 jmc 4637: Specify an alternative configuration file.
4638: Only the OID section is used.
1.1 jsing 4639: .It Fl data Ar file_to_hash
4640: The data file for which the time stamp request needs to be created.
1.72 jmc 4641: The default is standard input.
1.1 jsing 4642: .It Fl digest Ar digest_bytes
1.72 jmc 4643: Specify the message imprint explicitly without the data file.
1.1 jsing 4644: The imprint must be specified in a hexadecimal format,
4645: two characters per byte,
1.72 jmc 4646: the bytes optionally separated by colons.
1.1 jsing 4647: The number of bytes must match the message digest algorithm in use.
4648: .It Fl in Ar request.tsq
1.72 jmc 4649: A previously created time stamp request in DER
1.1 jsing 4650: format that will be printed into the output file.
1.72 jmc 4651: Useful for examining the content of a request in human-readable format.
1.76 jmc 4652: .It Fl md4 | md5 | ripemd160 | sha | sha1
1.1 jsing 4653: The message digest to apply to the data file.
4654: It supports all the message digest algorithms that are supported by the
4655: .Nm dgst
4656: command.
4657: The default is SHA-1.
4658: .It Fl no_nonce
1.72 jmc 4659: Specify no nonce in the request.
4660: The default, to include a 64-bit long pseudo-random nonce,
4661: is recommended to protect against replay attacks.
1.1 jsing 4662: .It Fl out Ar request.tsq
1.72 jmc 4663: The output file to write to,
4664: or standard output if not specified.
1.1 jsing 4665: .It Fl policy Ar object_id
4666: The policy that the client expects the TSA to use for creating the
4667: time stamp token.
1.72 jmc 4668: Either dotted OID notation or OID names defined
1.1 jsing 4669: in the config file can be used.
1.72 jmc 4670: If no policy is requested the TSA uses its own default policy.
1.1 jsing 4671: .It Fl text
1.72 jmc 4672: Output in human-readable text format instead of DER.
1.1 jsing 4673: .El
4674: .Pp
4675: A time stamp response (TimeStampResp) consists of a response status
4676: and the time stamp token itself (ContentInfo),
4677: if the token generation was successful.
4678: The
4679: .Fl reply
4680: command is for creating a time stamp
4681: response or time stamp token based on a request and printing the
4682: response/token in human-readable format.
4683: If
4684: .Fl token_out
4685: is not specified the output is always a time stamp response (TimeStampResp),
4686: otherwise it is a time stamp token (ContentInfo).
4687: .Bl -tag -width Ds
4688: .It Fl chain Ar certs_file.pem
1.72 jmc 4689: The collection of PEM certificates
1.1 jsing 4690: that will be included in the response
4691: in addition to the signer certificate if the
4692: .Fl cert
4693: option was used for the request.
4694: This file is supposed to contain the certificate chain
4695: for the signer certificate from its issuer upwards.
4696: The
4697: .Fl reply
4698: command does not build a certificate chain automatically.
4699: .It Fl config Ar configfile
1.72 jmc 4700: Specify an alternative configuration file.
1.1 jsing 4701: .It Fl in Ar response.tsr
1.72 jmc 4702: Specify a previously created time stamp response (or time stamp token, if
1.1 jsing 4703: .Fl token_in
1.72 jmc 4704: is also specified)
1.1 jsing 4705: in DER format that will be written to the output file.
4706: This option does not require a request;
4707: it is useful, for example,
1.72 jmc 4708: to examine the content of a response or token
4709: or to extract the time stamp token from a response.
1.1 jsing 4710: If the input is a token and the output is a time stamp response a default
1.72 jmc 4711: .Qq granted
1.1 jsing 4712: status info is added to the token.
4713: .It Fl inkey Ar private.pem
4714: The signer private key of the TSA in PEM format.
4715: Overrides the
4716: .Cm signer_key
4717: config file option.
4718: .It Fl out Ar response.tsr
4719: The response is written to this file.
4720: The format and content of the file depends on other options (see
4721: .Fl text
4722: and
4723: .Fl token_out ) .
4724: The default is stdout.
4725: .It Fl passin Ar arg
4726: The key password source.
4727: .It Fl policy Ar object_id
1.72 jmc 4728: The default policy to use for the response.
4729: Either dotted OID notation or OID names defined
4730: in the config file can be used.
4731: If no policy is requested the TSA uses its own default policy.
1.1 jsing 4732: .It Fl queryfile Ar request.tsq
1.72 jmc 4733: The file containing a DER-encoded time stamp request.
1.1 jsing 4734: .It Fl section Ar tsa_section
1.72 jmc 4735: The config file section containing the settings for response generation.
1.1 jsing 4736: .It Fl signer Ar tsa_cert.pem
1.72 jmc 4737: The PEM signer certificate of the TSA.
1.1 jsing 4738: The TSA signing certificate must have exactly one extended key usage
4739: assigned to it: timeStamping.
4740: The extended key usage must also be critical,
4741: otherwise the certificate is going to be refused.
4742: Overrides the
4743: .Cm signer_cert
4744: variable of the config file.
4745: .It Fl text
1.72 jmc 4746: Output in human-readable text format instead of DER.
1.1 jsing 4747: .It Fl token_in
1.72 jmc 4748: The input is a DER-encoded time stamp token (ContentInfo)
4749: instead of a time stamp response (TimeStampResp).
1.1 jsing 4750: .It Fl token_out
1.72 jmc 4751: The output is a time stamp token (ContentInfo)
4752: instead of a time stamp response (TimeStampResp).
1.1 jsing 4753: .El
4754: .Pp
4755: The
4756: .Fl verify
4757: command is for verifying if a time stamp response or time stamp token
4758: is valid and matches a particular time stamp request or data file.
4759: The
4760: .Fl verify
4761: command does not use the configuration file.
4762: .Bl -tag -width Ds
4763: .It Fl CAfile Ar trusted_certs.pem
1.72 jmc 4764: The file containing a set of trusted self-signed PEM CA certificates.
4765: See
1.1 jsing 4766: .Nm verify
4767: for additional details.
4768: Either this option or
4769: .Fl CApath
4770: must be specified.
4771: .It Fl CApath Ar trusted_cert_path
1.72 jmc 4772: The directory containing the trused CA certificates of the client.
4773: See
1.1 jsing 4774: .Nm verify
4775: for additional details.
4776: Either this option or
4777: .Fl CAfile
4778: must be specified.
4779: .It Fl data Ar file_to_hash
4780: The response or token must be verified against
4781: .Ar file_to_hash .
4782: The file is hashed with the message digest algorithm specified in the token.
4783: The
4784: .Fl digest
4785: and
4786: .Fl queryfile
4787: options must not be specified with this one.
4788: .It Fl digest Ar digest_bytes
4789: The response or token must be verified against the message digest specified
4790: with this option.
4791: The number of bytes must match the message digest algorithm
4792: specified in the token.
4793: The
4794: .Fl data
4795: and
4796: .Fl queryfile
4797: options must not be specified with this one.
4798: .It Fl in Ar response.tsr
4799: The time stamp response that needs to be verified, in DER format.
4800: This option in mandatory.
4801: .It Fl queryfile Ar request.tsq
4802: The original time stamp request, in DER format.
4803: The
4804: .Fl data
4805: and
4806: .Fl digest
4807: options must not be specified with this one.
4808: .It Fl token_in
1.72 jmc 4809: The input is a DER-encoded time stamp token (ContentInfo)
4810: instead of a time stamp response (TimeStampResp).
1.1 jsing 4811: .It Fl untrusted Ar cert_file.pem
1.72 jmc 4812: Additional untrusted PEM certificates which may be needed
4813: when building the certificate chain for the TSA's signing certificate.
1.1 jsing 4814: This file must contain the TSA signing certificate and
4815: all intermediate CA certificates unless the response includes them.
4816: .El
4817: .Pp
1.72 jmc 4818: Options specified on the command line always override
4819: the settings in the config file:
1.1 jsing 4820: .Bl -tag -width Ds
4821: .It Cm tsa Ar section , Cm default_tsa
4822: This is the main section and it specifies the name of another section
4823: that contains all the options for the
4824: .Fl reply
4825: option.
1.72 jmc 4826: This section can be overridden with the
1.1 jsing 4827: .Fl section
4828: command line switch.
4829: .It Cm oid_file
4830: See
4831: .Nm ca
4832: for a description.
4833: .It Cm oid_section
4834: See
4835: .Nm ca
4836: for a description.
4837: .It Cm serial
1.72 jmc 4838: The file containing the hexadecimal serial number of the
1.1 jsing 4839: last time stamp response created.
4840: This number is incremented by 1 for each response.
1.72 jmc 4841: If the file does not exist at the time of response generation
4842: a new file is created with serial number 1.
1.1 jsing 4843: This parameter is mandatory.
4844: .It Cm signer_cert
4845: TSA signing certificate, in PEM format.
4846: The same as the
4847: .Fl signer
4848: command line option.
4849: .It Cm certs
1.72 jmc 4850: A set of PEM-encoded certificates that need to be
1.1 jsing 4851: included in the response.
4852: The same as the
4853: .Fl chain
4854: command line option.
4855: .It Cm signer_key
4856: The private key of the TSA, in PEM format.
4857: The same as the
4858: .Fl inkey
4859: command line option.
4860: .It Cm default_policy
4861: The default policy to use when the request does not mandate any policy.
4862: The same as the
4863: .Fl policy
4864: command line option.
4865: .It Cm other_policies
4866: Comma separated list of policies that are also acceptable by the TSA
4867: and used only if the request explicitly specifies one of them.
4868: .It Cm digests
4869: The list of message digest algorithms that the TSA accepts.
4870: At least one algorithm must be specified.
4871: This parameter is mandatory.
4872: .It Cm accuracy
4873: The accuracy of the time source of the TSA in seconds, milliseconds
4874: and microseconds.
4875: For example, secs:1, millisecs:500, microsecs:100.
4876: If any of the components is missing,
4877: zero is assumed for that field.
4878: .It Cm clock_precision_digits
1.72 jmc 4879: The maximum number of digits, which represent the fraction of seconds,
4880: that need to be included in the time field.
1.1 jsing 4881: The trailing zeroes must be removed from the time,
1.72 jmc 4882: so there might actually be fewer digits
1.1 jsing 4883: or no fraction of seconds at all.
4884: The maximum value is 6;
4885: the default is 0.
4886: .It Cm ordering
4887: If this option is yes,
4888: the responses generated by this TSA can always be ordered,
4889: even if the time difference between two responses is less
4890: than the sum of their accuracies.
4891: The default is no.
4892: .It Cm tsa_name
4893: Set this option to yes if the subject name of the TSA must be included in
4894: the TSA name field of the response.
4895: The default is no.
4896: .It Cm ess_cert_id_chain
4897: The SignedData objects created by the TSA always contain the
4898: certificate identifier of the signing certificate in a signed
4899: attribute (see RFC 2634, Enhanced Security Services).
4900: If this option is set to yes and either the
4901: .Cm certs
4902: variable or the
4903: .Fl chain
4904: option is specified then the certificate identifiers of the chain will also
4905: be included in the SigningCertificate signed attribute.
4906: If this variable is set to no,
4907: only the signing certificate identifier is included.
4908: The default is no.
4909: .El
4910: .Sh VERIFY
4911: .nr nS 1
4912: .Nm "openssl verify"
4913: .Op Fl CAfile Ar file
4914: .Op Fl CApath Ar directory
4915: .Op Fl check_ss_sig
4916: .Op Fl crl_check
4917: .Op Fl crl_check_all
4918: .Op Fl explicit_policy
4919: .Op Fl extended_crl
4920: .Op Fl help
4921: .Op Fl ignore_critical
4922: .Op Fl inhibit_any
4923: .Op Fl inhibit_map
4924: .Op Fl issuer_checks
4925: .Op Fl policy_check
4926: .Op Fl purpose Ar purpose
4927: .Op Fl untrusted Ar file
4928: .Op Fl verbose
4929: .Op Fl x509_strict
4930: .Op Ar certificates
4931: .nr nS 0
4932: .Pp
4933: The
4934: .Nm verify
4935: command verifies certificate chains.
4936: .Pp
4937: The options are as follows:
4938: .Bl -tag -width Ds
4939: .It Fl check_ss_sig
4940: Verify the signature on the self-signed root CA.
4941: This is disabled by default
4942: because it doesn't add any security.
4943: .It Fl CAfile Ar file
4944: A
4945: .Ar file
4946: of trusted certificates.
4947: The
4948: .Ar file
4949: should contain multiple certificates in PEM format, concatenated together.
4950: .It Fl CApath Ar directory
4951: A
4952: .Ar directory
4953: of trusted certificates.
1.76 jmc 4954: The certificates, or symbolic links to them,
4955: should have names of the form
4956: .Ar hash Ns .0 ,
4957: where
4958: .Ar hash
4959: is the hashed certificate subject name
4960: (see the
1.1 jsing 4961: .Fl hash
4962: option of the
4963: .Nm x509
4964: utility).
4965: .It Fl crl_check
1.76 jmc 4966: Check end entity certificate validity by attempting to look up a valid CRL.
1.1 jsing 4967: If a valid CRL cannot be found an error occurs.
4968: .It Fl crl_check_all
1.76 jmc 4969: Check the validity of all certificates in the chain by attempting
1.1 jsing 4970: to look up valid CRLs.
4971: .It Fl explicit_policy
1.76 jmc 4972: Set policy variable require-explicit-policy (RFC 3280).
1.1 jsing 4973: .It Fl extended_crl
4974: Enable extended CRL features such as indirect CRLs and alternate CRL
4975: signing keys.
4976: .It Fl help
1.76 jmc 4977: Print a usage message.
1.1 jsing 4978: .It Fl ignore_critical
1.76 jmc 4979: Ignore critical extensions instead of rejecting the certificate.
1.1 jsing 4980: .It Fl inhibit_any
1.76 jmc 4981: Set policy variable inhibit-any-policy (RFC 3280).
1.1 jsing 4982: .It Fl inhibit_map
1.76 jmc 4983: Set policy variable inhibit-policy-mapping (RFC 3280).
1.1 jsing 4984: .It Fl issuer_checks
1.76 jmc 4985: Print diagnostics relating to searches for the issuer certificate
4986: of the current certificate
4987: showing why each candidate issuer certificate was rejected.
4988: The presence of rejection messages
4989: does not itself imply that anything is wrong:
4990: during the normal verify process several rejections may take place.
1.1 jsing 4991: .It Fl policy_check
1.76 jmc 4992: Enable certificate policy processing.
1.1 jsing 4993: .It Fl purpose Ar purpose
4994: The intended use for the certificate.
4995: Without this option no chain verification will be done.
4996: Currently accepted uses are
1.76 jmc 4997: .Cm sslclient , sslserver ,
4998: .Cm nssslserver , smimesign ,
4999: .Cm smimeencrypt , crlsign ,
5000: .Cm any ,
1.1 jsing 5001: and
1.76 jmc 5002: .Cm ocsphelper .
1.1 jsing 5003: .It Fl untrusted Ar file
5004: A
5005: .Ar file
5006: of untrusted certificates.
5007: The
5008: .Ar file
5009: should contain multiple certificates.
5010: .It Fl verbose
5011: Print extra information about the operations being performed.
5012: .It Fl x509_strict
5013: Disable workarounds for broken certificates which have to be disabled
5014: for strict X.509 compliance.
5015: .It Ar certificates
1.76 jmc 5016: One or more PEM
1.1 jsing 5017: .Ar certificates
5018: to verify.
5019: If no certificate files are included, an attempt is made to read
5020: a certificate from standard input.
1.76 jmc 5021: If the first certificate filename begins with a dash,
5022: use a lone dash to mark the last option.
1.1 jsing 5023: .El
1.76 jmc 5024: .Pp
1.1 jsing 5025: The
5026: .Nm verify
5027: program uses the same functions as the internal SSL and S/MIME verification,
1.76 jmc 5028: with one crucial difference:
5029: wherever possible an attempt is made to continue after an error,
5030: whereas normally the verify operation would halt on the first error.
1.1 jsing 5031: This allows all the problems with a certificate chain to be determined.
5032: .Pp
1.76 jmc 5033: The verify operation consists of a number of separate steps.
1.1 jsing 5034: Firstly a certificate chain is built up starting from the supplied certificate
5035: and ending in the root CA.
5036: It is an error if the whole chain cannot be built up.
5037: The chain is built up by looking up the issuer's certificate of the current
5038: certificate.
5039: If a certificate is found which is its own issuer, it is assumed
5040: to be the root CA.
5041: .Pp
1.76 jmc 5042: All certificates whose subject name matches the issuer name
1.1 jsing 5043: of the current certificate are subject to further tests.
5044: The relevant authority key identifier components of the current certificate
1.76 jmc 5045: (if present) must match the subject key identifier (if present)
5046: and issuer and serial number of the candidate issuer;
5047: in addition the
5048: .Cm keyUsage
5049: extension of the candidate issuer (if present) must permit certificate signing.
1.1 jsing 5050: .Pp
5051: The lookup first looks in the list of untrusted certificates and if no match
5052: is found the remaining lookups are from the trusted certificates.
1.76 jmc 5053: The root CA is always looked up in the trusted certificate list:
5054: if the certificate to verify is a root certificate,
5055: then an exact match must be found in the trusted list.
1.1 jsing 5056: .Pp
5057: The second operation is to check every untrusted certificate's extensions for
5058: consistency with the supplied purpose.
5059: If the
5060: .Fl purpose
5061: option is not included, then no checks are done.
5062: The supplied or
5063: .Qq leaf
5064: certificate must have extensions compatible with the supplied purpose
5065: and all other certificates must also be valid CA certificates.
5066: The precise extensions required are described in more detail in
5067: the
1.76 jmc 5068: .Nm X509
1.1 jsing 5069: section below.
5070: .Pp
5071: The third operation is to check the trust settings on the root CA.
5072: The root CA should be trusted for the supplied purpose.
1.76 jmc 5073: A certificate with no trust settings is considered to be valid for
1.1 jsing 5074: all purposes.
5075: .Pp
5076: The final operation is to check the validity of the certificate chain.
5077: The validity period is checked against the current system time and the
1.76 jmc 5078: .Cm notBefore
1.1 jsing 5079: and
1.76 jmc 5080: .Cm notAfter
1.1 jsing 5081: dates in the certificate.
5082: The certificate signatures are also checked at this point.
5083: .Pp
5084: If all operations complete successfully, the certificate is considered
5085: valid.
5086: If any operation fails then the certificate is not valid.
5087: When a verify operation fails, the output messages can be somewhat cryptic.
5088: The general form of the error message is:
1.76 jmc 5089: .Bd -literal
5090: server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024-bit)
5091: error 24 at 1 depth lookup:invalid CA certificate
1.1 jsing 5092: .Ed
5093: .Pp
5094: The first line contains the name of the certificate being verified, followed by
5095: the subject name of the certificate.
5096: The second line contains the error number and the depth.
5097: The depth is the number of the certificate being verified when a
5098: problem was detected starting with zero for the certificate being verified
5099: itself, then 1 for the CA that signed the certificate and so on.
5100: Finally a text version of the error number is presented.
5101: .Pp
5102: An exhaustive list of the error codes and messages is shown below; this also
5103: includes the name of the error code as defined in the header file
1.12 bentley 5104: .In openssl/x509_vfy.h .
1.76 jmc 5105: Some of the error codes are defined but never returned: these are described as
1.1 jsing 5106: .Qq unused .
5107: .Bl -tag -width "XXXX"
1.78 jmc 5108: .It 0 X509_V_OK
1.1 jsing 5109: The operation was successful.
1.78 jmc 5110: .It 2 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
5111: The issuer certificate of an untrusted certificate could not be found.
5112: .It 3 X509_V_ERR_UNABLE_TO_GET_CRL
1.1 jsing 5113: The CRL of a certificate could not be found.
1.78 jmc 5114: .It 4 X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE
1.1 jsing 5115: The certificate signature could not be decrypted.
1.78 jmc 5116: This means that the actual signature value could not be determined
5117: rather than it not matching the expected value.
1.1 jsing 5118: This is only meaningful for RSA keys.
1.78 jmc 5119: .It 5 X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE
5120: The CRL signature could not be decrypted.
5121: This means that the actual signature value could not be determined
5122: rather than it not matching the expected value.
1.1 jsing 5123: Unused.
1.78 jmc 5124: .It 6 X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY
1.1 jsing 5125: The public key in the certificate
1.76 jmc 5126: .Cm SubjectPublicKeyInfo
1.1 jsing 5127: could not be read.
1.78 jmc 5128: .It 7 X509_V_ERR_CERT_SIGNATURE_FAILURE
1.1 jsing 5129: The signature of the certificate is invalid.
1.78 jmc 5130: .It 8 X509_V_ERR_CRL_SIGNATURE_FAILURE
1.1 jsing 5131: The signature of the certificate is invalid.
1.78 jmc 5132: .It 9 X509_V_ERR_CERT_NOT_YET_VALID
1.1 jsing 5133: The certificate is not yet valid: the
1.76 jmc 5134: .Cm notBefore
1.1 jsing 5135: date is after the current time.
1.78 jmc 5136: .It 10 X509_V_ERR_CERT_HAS_EXPIRED
1.1 jsing 5137: The certificate has expired; that is, the
1.76 jmc 5138: .Cm notAfter
1.1 jsing 5139: date is before the current time.
1.78 jmc 5140: .It 11 X509_V_ERR_CRL_NOT_YET_VALID
1.1 jsing 5141: The CRL is not yet valid.
1.78 jmc 5142: .It 12 X509_V_ERR_CRL_HAS_EXPIRED
1.1 jsing 5143: The CRL has expired.
1.78 jmc 5144: .It 13 X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
1.1 jsing 5145: The certificate
1.76 jmc 5146: .Cm notBefore
1.1 jsing 5147: field contains an invalid time.
1.78 jmc 5148: .It 14 X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
1.1 jsing 5149: The certificate
1.76 jmc 5150: .Cm notAfter
1.1 jsing 5151: field contains an invalid time.
1.78 jmc 5152: .It 15 X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD
1.1 jsing 5153: The CRL
1.76 jmc 5154: .Cm lastUpdate
1.1 jsing 5155: field contains an invalid time.
1.78 jmc 5156: .It 16 X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD
1.1 jsing 5157: The CRL
1.76 jmc 5158: .Cm nextUpdate
1.1 jsing 5159: field contains an invalid time.
1.78 jmc 5160: .It 17 X509_V_ERR_OUT_OF_MEM
1.1 jsing 5161: An error occurred trying to allocate memory.
5162: This should never happen.
1.78 jmc 5163: .It 18 X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
1.1 jsing 5164: The passed certificate is self-signed and the same certificate cannot be
5165: found in the list of trusted certificates.
1.78 jmc 5166: .It 19 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
1.1 jsing 5167: The certificate chain could be built up using the untrusted certificates but
5168: the root could not be found locally.
1.78 jmc 5169: .It 20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
1.1 jsing 5170: The issuer certificate of a locally looked up certificate could not be found.
5171: This normally means the list of trusted certificates is not complete.
1.78 jmc 5172: .It 21 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
1.1 jsing 5173: No signatures could be verified because the chain contains only one
5174: certificate and it is not self-signed.
1.78 jmc 5175: .It 22 X509_V_ERR_CERT_CHAIN_TOO_LONG
1.1 jsing 5176: The certificate chain length is greater than the supplied maximum depth.
5177: Unused.
1.78 jmc 5178: .It 23 X509_V_ERR_CERT_REVOKED
1.1 jsing 5179: The certificate has been revoked.
1.78 jmc 5180: .It 24 X509_V_ERR_INVALID_CA
1.1 jsing 5181: A CA certificate is invalid.
5182: Either it is not a CA or its extensions are not consistent
5183: with the supplied purpose.
1.78 jmc 5184: .It 25 X509_V_ERR_PATH_LENGTH_EXCEEDED
1.1 jsing 5185: The
1.76 jmc 5186: .Cm basicConstraints
1.1 jsing 5187: pathlength parameter has been exceeded.
1.78 jmc 5188: .It 26 X509_V_ERR_INVALID_PURPOSE
1.1 jsing 5189: The supplied certificate cannot be used for the specified purpose.
1.78 jmc 5190: .It 27 X509_V_ERR_CERT_UNTRUSTED
1.1 jsing 5191: The root CA is not marked as trusted for the specified purpose.
1.78 jmc 5192: .It 28 X509_V_ERR_CERT_REJECTED
1.1 jsing 5193: The root CA is marked to reject the specified purpose.
1.78 jmc 5194: .It 29 X509_V_ERR_SUBJECT_ISSUER_MISMATCH
1.1 jsing 5195: The current candidate issuer certificate was rejected because its subject name
5196: did not match the issuer name of the current certificate.
5197: Only displayed when the
5198: .Fl issuer_checks
5199: option is set.
1.78 jmc 5200: .It 30 X509_V_ERR_AKID_SKID_MISMATCH
1.1 jsing 5201: The current candidate issuer certificate was rejected because its subject key
5202: identifier was present and did not match the authority key identifier current
5203: certificate.
5204: Only displayed when the
5205: .Fl issuer_checks
5206: option is set.
1.78 jmc 5207: .It 31 X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH
1.1 jsing 5208: The current candidate issuer certificate was rejected because its issuer name
5209: and serial number were present and did not match the authority key identifier
5210: of the current certificate.
5211: Only displayed when the
5212: .Fl issuer_checks
5213: option is set.
1.78 jmc 5214: .It 32 X509_V_ERR_KEYUSAGE_NO_CERTSIGN
1.1 jsing 5215: The current candidate issuer certificate was rejected because its
1.76 jmc 5216: .Cm keyUsage
1.1 jsing 5217: extension does not permit certificate signing.
1.78 jmc 5218: .It 50 X509_V_ERR_APPLICATION_VERIFICATION
1.1 jsing 5219: An application specific error.
5220: Unused.
5221: .El
5222: .Sh VERSION
5223: .Nm openssl version
5224: .Op Fl abdfopv
5225: .Pp
5226: The
5227: .Nm version
5228: command is used to print out version information about
1.79 jmc 5229: .Nm openssl .
1.1 jsing 5230: .Pp
5231: The options are as follows:
5232: .Bl -tag -width Ds
5233: .It Fl a
5234: All information: this is the same as setting all the other flags.
5235: .It Fl b
5236: The date the current version of
1.79 jmc 5237: .Nm openssl
1.1 jsing 5238: was built.
5239: .It Fl d
5240: .Ev OPENSSLDIR
5241: setting.
5242: .It Fl f
5243: Compilation flags.
5244: .It Fl o
5245: Option information: various options set when the library was built.
5246: .It Fl p
5247: Platform setting.
5248: .It Fl v
5249: The current
1.79 jmc 5250: .Nm openssl
1.1 jsing 5251: version.
5252: .El
5253: .Sh X509
5254: .nr nS 1
5255: .Nm "openssl x509"
5256: .Op Fl C
5257: .Op Fl addreject Ar arg
5258: .Op Fl addtrust Ar arg
5259: .Op Fl alias
5260: .Op Fl CA Ar file
5261: .Op Fl CAcreateserial
1.80 jmc 5262: .Op Fl CAform Cm der | pem
1.1 jsing 5263: .Op Fl CAkey Ar file
1.80 jmc 5264: .Op Fl CAkeyform Cm der | pem
1.1 jsing 5265: .Op Fl CAserial Ar file
5266: .Op Fl certopt Ar option
5267: .Op Fl checkend Ar arg
5268: .Op Fl clrext
5269: .Op Fl clrreject
5270: .Op Fl clrtrust
5271: .Op Fl dates
5272: .Op Fl days Ar arg
5273: .Op Fl email
5274: .Op Fl enddate
5275: .Op Fl extensions Ar section
5276: .Op Fl extfile Ar file
5277: .Op Fl fingerprint
5278: .Op Fl hash
5279: .Op Fl in Ar file
1.80 jmc 5280: .Op Fl inform Cm der | net | pem
1.1 jsing 5281: .Op Fl issuer
5282: .Op Fl issuer_hash
5283: .Op Fl issuer_hash_old
1.80 jmc 5284: .Op Fl keyform Cm der | pem
1.29 bcook 5285: .Op Fl md5 | sha1
1.1 jsing 5286: .Op Fl modulus
5287: .Op Fl nameopt Ar option
5288: .Op Fl noout
5289: .Op Fl ocsp_uri
5290: .Op Fl ocspid
5291: .Op Fl out Ar file
1.80 jmc 5292: .Op Fl outform Cm der | net | pem
1.1 jsing 5293: .Op Fl passin Ar arg
5294: .Op Fl pubkey
5295: .Op Fl purpose
5296: .Op Fl req
5297: .Op Fl serial
5298: .Op Fl set_serial Ar n
5299: .Op Fl setalias Ar arg
5300: .Op Fl signkey Ar file
5301: .Op Fl startdate
5302: .Op Fl subject
5303: .Op Fl subject_hash
5304: .Op Fl subject_hash_old
5305: .Op Fl text
5306: .Op Fl trustout
5307: .Op Fl x509toreq
5308: .nr nS 0
5309: .Pp
5310: The
5311: .Nm x509
5312: command is a multi-purpose certificate utility.
5313: It can be used to display certificate information, convert certificates to
5314: various forms, sign certificate requests like a
5315: .Qq mini CA ,
5316: or edit certificate trust settings.
5317: .Pp
1.80 jmc 5318: The following are x509 input, output, and general purpose options:
1.1 jsing 5319: .Bl -tag -width "XXXX"
5320: .It Fl in Ar file
1.80 jmc 5321: The input file to read from,
5322: or standard input if not specified.
5323: .It Fl inform Cm der | net | pem
5324: The input format.
1.1 jsing 5325: Normally, the command will expect an X.509 certificate,
5326: but this can change if other options such as
5327: .Fl req
5328: are present.
1.29 bcook 5329: .It Fl md5 | sha1
1.1 jsing 5330: The digest to use.
5331: This affects any signing or display option that uses a message digest,
5332: such as the
5333: .Fl fingerprint , signkey ,
5334: and
5335: .Fl CA
5336: options.
5337: If not specified, MD5 is used.
1.80 jmc 5338: SHA1 is always used with DSA keys.
1.1 jsing 5339: .It Fl out Ar file
1.80 jmc 5340: The output file to write to,
5341: or standard output if none is specified.
5342: .It Fl outform Cm der | net | pem
5343: The output format.
1.1 jsing 5344: .It Fl passin Ar arg
5345: The key password source.
5346: .El
1.80 jmc 5347: .Pp
5348: The following are x509 display options:
1.1 jsing 5349: .Bl -tag -width "XXXX"
5350: .It Fl C
1.80 jmc 5351: Output the certificate in the form of a C source file.
1.1 jsing 5352: .It Fl certopt Ar option
5353: Customise the output format used with
1.80 jmc 5354: .Fl text ,
5355: either using a list of comma-separated options or by specifying
1.1 jsing 5356: .Fl certopt
1.80 jmc 5357: multiple times.
5358: The default behaviour is to print all fields.
5359: The options are as follows:
5360: .Pp
5361: .Bl -tag -width "no_extensions" -offset indent -compact
5362: .It Cm ca_default
5363: Equivalent to
5364: .Cm no_issuer , no_pubkey , no_header ,
5365: .Cm no_version , no_sigdump ,
5366: and
5367: .Cm no_signame .
5368: .It Cm compatible
5369: Equivalent to no output options at all.
5370: .It Cm ext_default
5371: Print unsupported certificate extensions.
5372: .It Cm ext_dump
5373: Hex dump unsupported extensions.
5374: .It Cm ext_error
5375: Print an error message for unsupported certificate extensions.
5376: .It Cm ext_parse
1.84 jmc 5377: ASN.1 parse unsupported extensions.
1.80 jmc 5378: .It Cm no_aux
5379: Do not print certificate trust information.
5380: .It Cm no_extensions
5381: Do not print X509V3 extensions.
5382: .It Cm no_header
5383: Do not print header (Certificate and Data) information.
5384: .It Cm no_issuer
5385: Do not print the issuer name.
5386: .It Cm no_pubkey
5387: Do not print the public key.
5388: .It Cm no_serial
5389: Do not print the serial number.
5390: .It Cm no_sigdump
5391: Do not give a hexadecimal dump of the certificate signature.
5392: .It Cm no_signame
5393: Do not print the signature algorithm used.
5394: .It Cm no_subject
5395: Do not print the subject name.
5396: .It Cm no_validity
5397: Do not print the
5398: .Cm notBefore
5399: and
5400: .Cm notAfter
5401: (validity) fields.
5402: .It Cm no_version
5403: Do not print the version number.
5404: .El
1.1 jsing 5405: .It Fl dates
1.80 jmc 5406: Print the start and expiry date of a certificate.
1.1 jsing 5407: .It Fl email
1.80 jmc 5408: Output the email addresses, if any.
1.1 jsing 5409: .It Fl enddate
1.80 jmc 5410: Print the expiry date of the certificate; that is, the
5411: .Cm notAfter
1.1 jsing 5412: date.
5413: .It Fl fingerprint
1.80 jmc 5414: Print the digest of the DER-encoded version of the whole certificate.
1.1 jsing 5415: .It Fl hash
5416: A synonym for
1.80 jmc 5417: .Fl subject_hash .
1.1 jsing 5418: .It Fl issuer
1.80 jmc 5419: Print the issuer name.
1.1 jsing 5420: .It Fl issuer_hash
1.80 jmc 5421: Print the hash of the certificate issuer name.
1.1 jsing 5422: .It Fl issuer_hash_old
1.80 jmc 5423: Print the hash of the certificate issuer name
5424: using the older algorithm as used by
5425: .Nm openssl
1.1 jsing 5426: versions before 1.0.0.
5427: .It Fl modulus
1.80 jmc 5428: Print the value of the modulus of the public key contained in the certificate.
1.1 jsing 5429: .It Fl nameopt Ar option
1.80 jmc 5430: Customise how the subject or issuer names are displayed,
5431: either using a list of comma-separated options or by specifying
1.1 jsing 5432: .Fl nameopt
1.80 jmc 5433: multiple times.
5434: The default behaviour is to use the
5435: .Cm oneline
5436: format.
5437: The options,
5438: which can be preceded by a dash to turn them off,
5439: are as follows:
5440: .Bl -tag -width "XXXX"
5441: .It Cm align
5442: Align field values for a more readable output.
5443: Only usable with
5444: .Ar sep_multiline .
5445: .It Cm compat
5446: Use the old format,
5447: equivalent to specifying no options at all.
5448: .It Cm dn_rev
5449: Reverse the fields of the DN, as required by RFC 2253.
5450: As a side effect, this also reverses the order of multiple AVAs.
5451: .It Cm dump_all
5452: Dump all fields.
5453: When used with
5454: .Ar dump_der ,
5455: it allows the DER encoding of the structure to be unambiguously determined.
5456: .It Cm dump_der
5457: Any fields that need to be hexdumped are
5458: dumped using the DER encoding of the field.
5459: Otherwise just the content octets will be displayed.
5460: Both options use the RFC 2253 #XXXX... format.
5461: .It Cm dump_nostr
5462: Dump non-character string types
5463: (for example OCTET STRING);
5464: usually, non-character string types are displayed
5465: as though each content octet represents a single character.
5466: .It Cm dump_unknown
5467: Dump any field whose OID is not recognised by
5468: .Nm openssl .
5469: .It Cm esc_2253
5470: Escape the
5471: .Qq special
5472: characters required by RFC 2253 in a field that is
5473: .Dq \& ,+"<>; .
5474: Additionally,
5475: .Sq #
5476: is escaped at the beginning of a string
5477: and a space character at the beginning or end of a string.
5478: .It Cm esc_ctrl
5479: Escape control characters.
5480: That is, those with ASCII values less than 0x20 (space)
5481: and the delete (0x7f) character.
5482: They are escaped using the RFC 2253 \eXX notation (where XX are two hex
5483: digits representing the character value).
5484: .It Cm esc_msb
5485: Escape characters with the MSB set; that is, with ASCII values larger than
5486: 127.
5487: .It Cm multiline
5488: A multiline format.
5489: Equivalent to
5490: .Cm esc_ctrl , esc_msb , sep_multiline ,
5491: .Cm space_eq , lname ,
5492: and
5493: .Cm align .
5494: .It Cm no_type
5495: Do not attempt to interpret multibyte characters.
5496: That is, content octets are merely dumped as though one octet
5497: represents each character.
5498: This is useful for diagnostic purposes
5499: but results in rather odd looking output.
5500: .It Cm nofname , sname , lname , oid
5501: Alter how the field name is displayed:
5502: .Cm nofname
5503: does not display the field at all;
5504: .Cm sname
5505: uses the short name form (CN for
5506: .Cm commonName ,
5507: for example);
5508: .Cm lname
5509: uses the long form.
5510: .Cm oid
5511: represents the OID in numerical form and is useful for diagnostic purpose.
5512: .It Cm oneline
5513: A one line format which is more readable than
5514: .Cm RFC2253 .
5515: Equivalent to
5516: .Cm esc_2253 , esc_ctrl , esc_msb , utf8 ,
5517: .Cm dump_nostr , dump_der , use_quote , sep_comma_plus_spc ,
5518: .Cm space_eq ,
5519: and
5520: .Cm sname .
5521: .It Cm RFC2253
5522: Displays names compatible with RFC 2253.
5523: Equivalent to
5524: .Cm esc_2253 , esc_ctrl ,
5525: .Cm esc_msb , utf8 , dump_nostr , dump_unknown ,
5526: .Cm dump_der , sep_comma_plus , dn_rev ,
5527: and
5528: .Cm sname .
5529: .It Cm sep_comma_plus , sep_comma_plus_space , sep_semi_plus_space , sep_multiline
5530: Determine the field separators:
5531: the first character is between RDNs and the second between multiple AVAs
5532: (multiple AVAs are very rare and their use is discouraged).
5533: The options ending in
5534: .Qq space
5535: additionally place a space after the separator to make it more readable.
5536: .Cm sep_multiline
5537: uses a linefeed character for the RDN separator and a spaced
5538: .Sq +
5539: for the AVA separator,
5540: as well as indenting the fields by four characters.
5541: .It Cm show_type
1.84 jmc 5542: Show the type of the ASN.1 character string.
1.80 jmc 5543: The type precedes the field contents.
5544: For example
5545: .Qq BMPSTRING: Hello World .
5546: .It Cm space_eq
5547: Place spaces round the
5548: .Sq =
5549: character which follows the field name.
5550: .It Cm use_quote
5551: Escape some characters by surrounding the whole string with
5552: .Sq \&"
5553: characters.
5554: Without the option, all escaping is done with the
5555: .Sq \e
5556: character.
5557: .It Cm utf8
5558: Convert all strings to UTF8 format first, as required by RFC 2253.
5559: On a UTF8 compatible terminal,
5560: the use of this option (and not setting
5561: .Cm esc_msb )
5562: may result in the correct display of multibyte characters.
5563: Usually, multibyte characters larger than 0xff
5564: are represented using the format \eUXXXX for 16 bits and \eWXXXXXXXX
5565: for 32 bits,
5566: and any UTF8Strings are converted to their character form first.
5567: .El
1.1 jsing 5568: .It Fl noout
1.80 jmc 5569: Do not output the encoded version of the request.
1.1 jsing 5570: .It Fl ocsp_uri
1.80 jmc 5571: Print the OCSP responder addresses, if any.
1.1 jsing 5572: .It Fl ocspid
5573: Print OCSP hash values for the subject name and public key.
5574: .It Fl pubkey
1.80 jmc 5575: Print the public key.
1.1 jsing 5576: .It Fl serial
1.80 jmc 5577: Print the certificate serial number.
1.1 jsing 5578: .It Fl startdate
1.80 jmc 5579: Print the start date of the certificate; that is, the
5580: .Cm notBefore
1.1 jsing 5581: date.
5582: .It Fl subject
1.80 jmc 5583: Print the subject name.
1.1 jsing 5584: .It Fl subject_hash
1.80 jmc 5585: Print the hash of the certificate subject name.
1.1 jsing 5586: This is used in
1.80 jmc 5587: .Nm openssl
1.1 jsing 5588: to form an index to allow certificates in a directory to be looked up
5589: by subject name.
5590: .It Fl subject_hash_old
1.80 jmc 5591: Print the hash of the certificate subject name
5592: using the older algorithm as used by
5593: .Nm openssl
1.1 jsing 5594: versions before 1.0.0.
5595: .It Fl text
1.80 jmc 5596: Print the full certificate in text form.
1.1 jsing 5597: .El
5598: .Pp
1.80 jmc 5599: A trusted certificate is a certificate which has several
1.1 jsing 5600: additional pieces of information attached to it such as the permitted
1.80 jmc 5601: and prohibited uses of the certificate and an alias.
5602: When a certificate is being verified at least one certificate must be trusted.
5603: By default, a trusted certificate must be stored locally and be a root CA.
5604: The following are x509 trust settings options:
1.1 jsing 5605: .Bl -tag -width "XXXX"
5606: .It Fl addreject Ar arg
1.80 jmc 5607: Add a prohibited use.
5608: Accepts the same values as the
1.1 jsing 5609: .Fl addtrust
5610: option.
5611: .It Fl addtrust Ar arg
1.80 jmc 5612: Add a trusted certificate use.
1.1 jsing 5613: Any object name can be used here, but currently only
1.80 jmc 5614: .Cm clientAuth
5615: (SSL client use),
5616: .Cm serverAuth
5617: (SSL server use),
5618: and
5619: .Cm emailProtection
5620: (S/MIME email) are used.
1.1 jsing 5621: .It Fl alias
1.80 jmc 5622: Output the certificate alias.
1.1 jsing 5623: .It Fl clrreject
1.80 jmc 5624: Clear all the prohibited or rejected uses of the certificate.
1.1 jsing 5625: .It Fl clrtrust
1.80 jmc 5626: Clear all the permitted or trusted uses of the certificate.
1.1 jsing 5627: .It Fl purpose
1.80 jmc 5628: Perform tests on the certificate extensions.
5629: The same code is used when verifying untrusted certificates in chains,
5630: so this section is useful if a chain is rejected by the verify code.
5631: .Pp
5632: The
5633: .Cm basicConstraints
5634: extension CA flag is used to determine whether the
5635: certificate can be used as a CA.
5636: If the CA flag is true, it is a CA;
5637: if the CA flag is false, it is not a CA.
5638: All CAs should have the CA flag set to true.
5639: .Pp
5640: If the
5641: .Cm basicConstraints
5642: extension is absent, then the certificate is
5643: considered to be a possible CA;
5644: other extensions are checked according to the intended use of the certificate.
5645: A warning is given in this case because the certificate should really not
5646: be regarded as a CA.
5647: However it is allowed to be a CA to work around some broken software.
5648: .Pp
5649: If the certificate is a V1 certificate
5650: (and thus has no extensions) and it is self-signed,
5651: it is also assumed to be a CA but a warning is again given.
5652: This is to work around the problem of Verisign roots
5653: which are V1 self-signed certificates.
5654: .Pp
5655: If the
5656: .Cm keyUsage
5657: extension is present, then additional restraints are
5658: made on the uses of the certificate.
5659: A CA certificate must have the
5660: .Cm keyCertSign
5661: bit set if the
5662: .Cm keyUsage
5663: extension is present.
5664: .Pp
5665: The extended key usage extension places additional restrictions on the
5666: certificate uses.
5667: If this extension is present, whether critical or not,
5668: the key can only be used for the purposes specified.
5669: .Pp
5670: A complete description of each test is given below.
5671: The comments about
5672: .Cm basicConstraints
5673: and
5674: .Cm keyUsage
5675: and V1 certificates above apply to all CA certificates.
5676: .Bl -tag -width "XXXX"
5677: .It SSL Client
5678: The extended key usage extension must be absent or include the
5679: web client authentication OID.
5680: .Cm keyUsage
5681: must be absent or it must have the
5682: .Cm digitalSignature
5683: bit set.
5684: The Netscape certificate type must be absent
5685: or it must have the SSL client bit set.
5686: .It SSL Client CA
5687: The extended key usage extension must be absent or include the
5688: web client authentication OID.
5689: The Netscape certificate type must be absent
5690: or it must have the SSL CA bit set:
5691: this is used as a workaround if the
5692: .Cm basicConstraints
5693: extension is absent.
5694: .It SSL Server
5695: The extended key usage extension must be absent or include the
5696: web server authentication and/or one of the SGC OIDs.
5697: .Cm keyUsage
5698: must be absent or it must have the
5699: .Cm digitalSignature
5700: set, the
5701: .Cm keyEncipherment
5702: set, or both bits set.
5703: The Netscape certificate type must be absent or have the SSL server bit set.
5704: .It SSL Server CA
5705: The extended key usage extension must be absent or include the
5706: web server authentication and/or one of the SGC OIDs.
5707: The Netscape certificate type must be absent or the SSL CA bit must be set:
5708: this is used as a workaround if the
5709: .Cm basicConstraints
5710: extension is absent.
5711: .It Netscape SSL Server
5712: For Netscape SSL clients to connect to an SSL server; it must have the
5713: .Cm keyEncipherment
5714: bit set if the
5715: .Cm keyUsage
5716: extension is present.
5717: This isn't always valid because some cipher suites use the key for
5718: digital signing.
5719: Otherwise it is the same as a normal SSL server.
5720: .It Common S/MIME Client Tests
5721: The extended key usage extension must be absent or include the
5722: email protection OID.
5723: The Netscape certificate type must be absent or should have the S/MIME bit set.
5724: If the S/MIME bit is not set in Netscape certificate type, then the SSL
5725: client bit is tolerated as an alternative but a warning is shown:
5726: this is because some Verisign certificates don't set the S/MIME bit.
5727: .It S/MIME Signing
5728: In addition to the common S/MIME client tests, the
5729: .Cm digitalSignature
5730: bit must be set if the
5731: .Cm keyUsage
5732: extension is present.
5733: .It S/MIME Encryption
5734: In addition to the common S/MIME tests, the
5735: .Cm keyEncipherment
5736: bit must be set if the
5737: .Cm keyUsage
5738: extension is present.
5739: .It S/MIME CA
5740: The extended key usage extension must be absent or include the
5741: email protection OID.
5742: The Netscape certificate type must be absent
5743: or must have the S/MIME CA bit set:
5744: this is used as a workaround if the
5745: .Cm basicConstraints
5746: extension is absent.
5747: .It CRL Signing
5748: The
5749: .Cm keyUsage
5750: extension must be absent or it must have the CRL signing bit set.
5751: .It CRL Signing CA
5752: The normal CA tests apply, except the
5753: .Cm basicConstraints
5754: extension must be present.
5755: .El
1.1 jsing 5756: .It Fl setalias Ar arg
1.80 jmc 5757: Set the alias of the certificate,
5758: allowing the certificate to be referred to using a nickname,
5759: such as
1.1 jsing 5760: .Qq Steve's Certificate .
5761: .It Fl trustout
1.80 jmc 5762: Output a trusted certificate
5763: (the default if any trust settings are modified).
1.1 jsing 5764: An ordinary or trusted certificate can be input, but by default an ordinary
5765: certificate is output and any trust settings are discarded.
5766: .El
1.80 jmc 5767: .Pp
1.1 jsing 5768: The
5769: .Nm x509
1.80 jmc 5770: utility can be used to sign certificates and requests:
5771: it can thus behave like a mini CA.
5772: The following are x509 signing options:
1.1 jsing 5773: .Bl -tag -width "XXXX"
5774: .It Fl CA Ar file
1.80 jmc 5775: The CA certificate to be used for signing.
1.1 jsing 5776: When this option is present,
5777: .Nm x509
1.80 jmc 5778: behaves like a mini CA.
1.1 jsing 5779: The input file is signed by the CA using this option;
5780: that is, its issuer name is set to the subject name of the CA and it is
5781: digitally signed using the CA's private key.
5782: .Pp
5783: This option is normally combined with the
5784: .Fl req
5785: option.
5786: Without the
5787: .Fl req
5788: option, the input is a certificate which must be self-signed.
5789: .It Fl CAcreateserial
1.80 jmc 5790: Create the CA serial number file if it does not exist
5791: instead of generating an error.
5792: The file will contain the serial number
1.1 jsing 5793: .Sq 02
5794: and the certificate being signed will have
5795: .Sq 1
5796: as its serial number.
1.80 jmc 5797: .It Fl CAform Cm der | pem
1.1 jsing 5798: The format of the CA certificate file.
5799: The default is
1.80 jmc 5800: .Cm pem .
1.1 jsing 5801: .It Fl CAkey Ar file
1.80 jmc 5802: Set the CA private key to sign a certificate with.
5803: Otherwise it is assumed that the CA private key is present
5804: in the CA certificate file.
5805: .It Fl CAkeyform Cm der | pem
1.1 jsing 5806: The format of the CA private key.
5807: The default is
1.80 jmc 5808: .Cm pem .
1.1 jsing 5809: .It Fl CAserial Ar file
1.80 jmc 5810: Use the serial number in
5811: .Ar file
5812: to sign a certificate.
5813: The file should consist of one line containing an even number of hex digits
1.1 jsing 5814: with the serial number to use.
5815: After each use the serial number is incremented and written out
5816: to the file again.
5817: .Pp
5818: The default filename consists of the CA certificate file base name with
5819: .Pa .srl
5820: appended.
5821: For example, if the CA certificate file is called
5822: .Pa mycacert.pem ,
5823: it expects to find a serial number file called
5824: .Pa mycacert.srl .
5825: .It Fl checkend Ar arg
5826: Check whether the certificate expires in the next
5827: .Ar arg
5828: seconds.
5829: If so, exit with return value 1;
5830: otherwise exit with return value 0.
5831: .It Fl clrext
5832: Delete any extensions from a certificate.
5833: This option is used when a certificate is being created from another
5834: certificate (for example with the
5835: .Fl signkey
5836: or the
5837: .Fl CA
5838: options).
5839: Normally, all extensions are retained.
5840: .It Fl days Ar arg
1.80 jmc 5841: The number of days to make a certificate valid for.
1.1 jsing 5842: The default is 30 days.
5843: .It Fl extensions Ar section
5844: The section to add certificate extensions from.
5845: If this option is not specified, the extensions should either be
1.80 jmc 5846: contained in the unnamed (default) section
5847: or the default section should contain a variable called
1.1 jsing 5848: .Qq extensions
5849: which contains the section to use.
5850: .It Fl extfile Ar file
5851: File containing certificate extensions to use.
5852: If not specified, no extensions are added to the certificate.
1.80 jmc 5853: .It Fl keyform Cm der | pem
5854: The format of the private key file used in the
1.1 jsing 5855: .Fl signkey
5856: option.
5857: .It Fl req
1.80 jmc 5858: Expect a certificate request on input instead of a certificate.
1.1 jsing 5859: .It Fl set_serial Ar n
1.80 jmc 5860: The serial number to use.
1.1 jsing 5861: This option can be used with either the
5862: .Fl signkey
5863: or
5864: .Fl CA
5865: options.
5866: If used in conjunction with the
5867: .Fl CA
5868: option, the serial number file (as specified by the
5869: .Fl CAserial
5870: or
5871: .Fl CAcreateserial
5872: options) is not used.
5873: .Pp
5874: The serial number can be decimal or hex (if preceded by
5875: .Sq 0x ) .
5876: Negative serial numbers can also be specified but their use is not recommended.
5877: .It Fl signkey Ar file
1.80 jmc 5878: Self-sign
5879: .Ar file
5880: using the supplied private key.
1.1 jsing 5881: .Pp
5882: If the input file is a certificate, it sets the issuer name to the
1.80 jmc 5883: subject name (i.e. makes it self-signed),
1.1 jsing 5884: changes the public key to the supplied value,
5885: and changes the start and end dates.
5886: The start date is set to the current time and the end date is set to
5887: a value determined by the
5888: .Fl days
5889: option.
5890: Any certificate extensions are retained unless the
5891: .Fl clrext
5892: option is supplied.
5893: .Pp
5894: If the input is a certificate request, a self-signed certificate
5895: is created using the supplied private key using the subject name in
5896: the request.
5897: .It Fl x509toreq
1.80 jmc 5898: Convert a certificate into a certificate request.
1.1 jsing 5899: The
5900: .Fl signkey
5901: option is used to pass the required private key.
5902: .El
1.38 jmc 5903: .Sh COMMON NOTATION
5904: Several commands share a common syntax,
5905: as detailed below.
5906: .Pp
5907: Password arguments, typically specified using
1.33 jmc 5908: .Fl passin
5909: and
5910: .Fl passout
1.38 jmc 5911: for input and output passwords,
5912: allow passwords to be obtained from a variety of sources.
5913: Both of these options take a single argument, described below.
1.33 jmc 5914: If no password argument is given and a password is required,
5915: then the user is prompted to enter one:
5916: this will typically be read from the current terminal with echoing turned off.
1.38 jmc 5917: .Bl -tag -width "pass:password" -offset indent
5918: .It Cm pass : Ns Ar password
1.33 jmc 5919: The actual password is
5920: .Ar password .
1.38 jmc 5921: Since the password is visible to utilities,
1.33 jmc 5922: this form should only be used where security is not important.
1.38 jmc 5923: .It Cm env : Ns Ar var
1.33 jmc 5924: Obtain the password from the environment variable
5925: .Ar var .
1.38 jmc 5926: Since the environment of other processes is visible,
5927: this option should be used with caution.
5928: .It Cm file : Ns Ar path
1.33 jmc 5929: The first line of
5930: .Ar path
5931: is the password.
5932: If the same
5933: .Ar path
5934: argument is supplied to
5935: .Fl passin
5936: and
5937: .Fl passout ,
5938: then the first line will be used for the input password and the next line
5939: for the output password.
5940: .Ar path
5941: need not refer to a regular file:
5942: it could, for example, refer to a device or named pipe.
1.38 jmc 5943: .It Cm fd : Ns Ar number
1.33 jmc 5944: Read the password from the file descriptor
5945: .Ar number .
1.38 jmc 5946: This can be used to send the data via a pipe, for example.
5947: .It Cm stdin
1.33 jmc 5948: Read the password from standard input.
1.35 jmc 5949: .El
1.38 jmc 5950: .Pp
1.64 jmc 5951: Input/output formats,
1.38 jmc 5952: typically specified using
5953: .Fl inform
5954: and
5955: .Fl outform ,
1.64 jmc 5956: indicate the format being read from or written to.
1.38 jmc 5957: The argument is case insensitive.
5958: .Pp
5959: .Bl -tag -width Ds -offset indent -compact
5960: .It Cm der
5961: Distinguished Encoding Rules (DER)
5962: is a binary format.
1.64 jmc 5963: .It Cm net
5964: Insecure legacy format.
1.38 jmc 5965: .It Cm pem
5966: Privacy Enhanced Mail (PEM)
5967: is base64-encoded.
1.70 jmc 5968: .It Cm smime
5969: An SMIME format message.
1.38 jmc 5970: .It Cm txt
5971: Plain ASCII text.
5972: .El
1.35 jmc 5973: .Sh ENVIRONMENT
5974: The following environment variables affect the execution of
5975: .Nm openssl :
1.38 jmc 5976: .Bl -tag -width "/etc/ssl/openssl.cnf"
1.35 jmc 5977: .It Ev OPENSSL_CONF
5978: The location of the master configuration file.
1.33 jmc 5979: .El
1.1 jsing 5980: .Sh FILES
5981: .Bl -tag -width "/etc/ssl/openssl.cnf" -compact
1.17 sobrado 5982: .It Pa /etc/ssl/
1.1 jsing 5983: Default config directory for
5984: .Nm openssl .
1.17 sobrado 5985: .It Pa /etc/ssl/lib/
1.1 jsing 5986: Unused.
1.17 sobrado 5987: .It Pa /etc/ssl/private/
1.1 jsing 5988: Default private key directory.
1.17 sobrado 5989: .It Pa /etc/ssl/openssl.cnf
1.1 jsing 5990: Default configuration file for
5991: .Nm openssl .
1.17 sobrado 5992: .It Pa /etc/ssl/x509v3.cnf
1.1 jsing 5993: Default configuration file for
5994: .Nm x509
5995: certificates.
5996: .El
5997: .Sh SEE ALSO
1.74 jmc 5998: .Xr acme-client 1 ,
1.26 jmc 5999: .Xr nc 1 ,
1.90 schwarze 6000: .Xr openssl.cnf 5 ,
6001: .Xr x509v3.cnf 5 ,
1.1 jsing 6002: .Xr ssl 8 ,
6003: .Xr starttls 8
6004: .Sh STANDARDS
6005: .Rs
6006: .%A T. Dierks
6007: .%A C. Allen
6008: .%D January 1999
6009: .%R RFC 2246
6010: .%T The TLS Protocol Version 1.0
6011: .Re
6012: .Pp
6013: .Rs
6014: .%A M. Wahl
6015: .%A S. Killie
6016: .%A T. Howes
6017: .%D December 1997
6018: .%R RFC 2253
6019: .%T Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names
6020: .Re
6021: .Pp
6022: .Rs
6023: .%A B. Kaliski
6024: .%D March 1998
6025: .%R RFC 2315
6026: .%T PKCS #7: Cryptographic Message Syntax Version 1.5
6027: .Re
6028: .Pp
6029: .Rs
6030: .%A R. Housley
6031: .%A W. Ford
6032: .%A W. Polk
6033: .%A D. Solo
6034: .%D January 1999
6035: .%R RFC 2459
6036: .%T Internet X.509 Public Key Infrastructure Certificate and CRL Profile
6037: .Re
6038: .Pp
6039: .Rs
6040: .%A M. Myers
6041: .%A R. Ankney
6042: .%A A. Malpani
6043: .%A S. Galperin
6044: .%A C. Adams
6045: .%D June 1999
6046: .%R RFC 2560
6047: .%T X.509 Internet Public Key Infrastructure Online Certificate Status Protocol \(en OCSP
6048: .Re
6049: .Pp
6050: .Rs
6051: .%A R. Housley
6052: .%D June 1999
6053: .%R RFC 2630
6054: .%T Cryptographic Message Syntax
6055: .Re
6056: .Pp
6057: .Rs
6058: .%A P. Chown
6059: .%D June 2002
6060: .%R RFC 3268
1.24 jmc 6061: .%T Advanced Encryption Standard (AES) Ciphersuites for Transport Layer Security (TLS)
1.1 jsing 6062: .Re
![[BACK]](/icons/back.gif){kind=icon}
Return to openssl.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / openssl