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