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