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