Annotation of src/usr.bin/openssl/openssl.1, Revision 1.65
1.65 ! jmc 1: .\" $OpenBSD: openssl.1,v 1.64 2016/08/28 19:34:15 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.65 ! jmc 115: .Dd $Mdocdate: August 28 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
358: Specifies the configuration file to use.
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
2697: .Pq 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.59 jmc 2703: Included for compatability only:
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.
3266: As with all configuration files, if no value is specified in the specific
1.63 jmc 3267: section then the initial unnamed or default section is searched too.
1.1 jsing 3268: .Pp
1.63 jmc 3269: The options available are as follows:
1.1 jsing 3270: .Bl -tag -width "XXXX"
1.63 jmc 3271: .It Cm attributes
3272: The section containing any request attributes: its format
1.1 jsing 3273: is the same as
1.63 jmc 3274: .Cm distinguished_name .
3275: Typically these may contain the challengePassword or unstructuredName types.
3276: They are currently ignored by the
3277: .Nm openssl
1.1 jsing 3278: request signing utilities, but some CAs might want them.
1.63 jmc 3279: .It Cm default_bits
3280: The default key size, in bits.
3281: The default is 2048.
1.1 jsing 3282: It is used if the
3283: .Fl new
1.63 jmc 3284: option is used and can be overridden by using the
1.1 jsing 3285: .Fl newkey
3286: option.
1.63 jmc 3287: .It Cm default_keyfile
3288: The default file to write a private key to,
3289: or standard output if not specified.
3290: It can be overridden by the
1.1 jsing 3291: .Fl keyout
3292: option.
1.63 jmc 3293: .It Cm default_md
3294: The digest algorithm to use.
1.1 jsing 3295: Possible values include
1.63 jmc 3296: .Cm md5 ,
3297: .Cm sha1
1.1 jsing 3298: and
1.63 jmc 3299: .Cm sha256
3300: (the default).
3301: It can be overridden on the command line.
3302: .It Cm distinguished_name
3303: The section containing the distinguished name fields to
1.1 jsing 3304: prompt for when generating a certificate or certificate request.
1.63 jmc 3305: The format is described below.
3306: .It Cm encrypt_key
3307: If set to
3308: .Qq no
3309: and a private key is generated, it is not encrypted.
3310: It is equivalent to the
1.1 jsing 3311: .Fl nodes
1.63 jmc 3312: option.
1.1 jsing 3313: For compatibility,
1.63 jmc 3314: .Cm encrypt_rsa_key
1.1 jsing 3315: is an equivalent option.
1.63 jmc 3316: .It Cm input_password | output_password
3317: The passwords for the input private key file (if present)
3318: and the output private key file (if one will be created).
1.1 jsing 3319: The command line options
3320: .Fl passin
3321: and
3322: .Fl passout
3323: override the configuration file values.
1.63 jmc 3324: .It Cm oid_file
3325: A file containing additional OBJECT IDENTIFIERS.
1.1 jsing 3326: Each line of the file should consist of the numerical form of the
3327: object identifier, followed by whitespace, then the short name followed
3328: by whitespace and finally the long name.
1.63 jmc 3329: .It Cm oid_section
3330: Specify a section in the configuration file containing extra
1.1 jsing 3331: object identifiers.
3332: Each line should consist of the short name of the
3333: object identifier followed by
3334: .Sq =
3335: and the numerical form.
3336: The short and long names are the same when this option is used.
1.63 jmc 3337: .It Cm prompt
3338: If set to
3339: .Qq no ,
3340: it disables prompting of certificate fields
1.1 jsing 3341: and just takes values from the config file directly.
3342: It also changes the expected format of the
1.63 jmc 3343: .Cm distinguished_name
1.1 jsing 3344: and
1.63 jmc 3345: .Cm attributes
1.1 jsing 3346: sections.
1.63 jmc 3347: .It Cm req_extensions
3348: The configuration file section containing a list of
1.1 jsing 3349: extensions to add to the certificate request.
3350: It can be overridden by the
3351: .Fl reqexts
1.63 jmc 3352: option.
3353: .It Cm string_mask
3354: Limit the string types for encoding certain fields.
1.1 jsing 3355: The following values may be used, limiting strings to the indicated types:
3356: .Bl -tag -width "MASK:number"
1.63 jmc 3357: .It Cm utf8only
3358: UTF8String.
1.1 jsing 3359: This is the default, as recommended by PKIX in RFC 2459.
1.63 jmc 3360: .It Cm default
3361: PrintableString, IA5String, T61String, BMPString, UTF8String.
3362: .It Cm pkix
3363: PrintableString, IA5String, BMPString, UTF8String.
3364: Inspired by the PKIX recommendation in RFC 2459 for certificates
3365: generated before 2004, but differs by also permitting IA5String.
3366: .It Cm nombstr
3367: PrintableString, IA5String, T61String, UniversalString.
3368: A workaround for some ancient software that had problems
3369: with the variable-sized BMPString and UTF8String types.
1.1 jsing 3370: .It Cm MASK : Ns Ar number
1.63 jmc 3371: An explicit bitmask of permitted types, where
1.1 jsing 3372: .Ar number
3373: is a C-style hex, decimal, or octal number that's a bit-wise OR of
3374: .Dv B_ASN1_*
3375: values from
3376: .In openssl/asn1.h .
3377: .El
1.63 jmc 3378: .It Cm utf8
3379: If set to
3380: .Qq yes ,
3381: field values are interpreted as UTF8 strings, not ASCII.
3382: .It Cm x509_extensions
3383: The configuration file section containing a list of
1.1 jsing 3384: extensions to add to a certificate generated when the
3385: .Fl x509
3386: switch is used.
3387: It can be overridden by the
3388: .Fl extensions
1.63 jmc 3389: option.
1.1 jsing 3390: .El
1.63 jmc 3391: .Pp
1.1 jsing 3392: There are two separate formats for the distinguished name and attribute
3393: sections.
3394: If the
3395: .Fl prompt
3396: option is set to
1.63 jmc 3397: .Qq no ,
3398: the sections consist of just field names and values,
3399: which allows external programs to generate a template file
3400: with all the field names and values and just pass it to
1.1 jsing 3401: .Nm req .
3402: .Pp
3403: Alternatively if the
3404: .Fl prompt
3405: option is absent or not set to
1.63 jmc 3406: .Qq no ,
1.1 jsing 3407: then the file contains field prompting information.
3408: It consists of lines of the form:
3409: .Bd -unfilled -offset indent
3410: fieldName="prompt"
3411: fieldName_default="default field value"
3412: fieldName_min= 2
3413: fieldName_max= 4
3414: .Ed
3415: .Pp
3416: .Qq fieldName
3417: is the field name being used, for example
1.63 jmc 3418: .Cm commonName
3419: (or CN).
1.1 jsing 3420: The
3421: .Qq prompt
3422: string is used to ask the user to enter the relevant details.
3423: If the user enters nothing, the default value is used;
3424: if no default value is present, the field is omitted.
3425: A field can still be omitted if a default value is present,
3426: if the user just enters the
3427: .Sq \&.
3428: character.
3429: .Pp
3430: The number of characters entered must be between the
1.63 jmc 3431: fieldName_min and fieldName_max limits:
1.1 jsing 3432: there may be additional restrictions based on the field being used
3433: (for example
1.63 jmc 3434: .Cm countryName
1.1 jsing 3435: can only ever be two characters long and must fit in a
1.63 jmc 3436: .Cm PrintableString ) .
1.1 jsing 3437: .Pp
3438: Some fields (such as
1.63 jmc 3439: .Cm organizationName )
1.1 jsing 3440: can be used more than once in a DN.
3441: This presents a problem because configuration files will
3442: not recognize the same name occurring twice.
3443: To avoid this problem, if the
1.63 jmc 3444: .Cm fieldName
1.1 jsing 3445: contains some characters followed by a full stop, they will be ignored.
3446: So, for example, a second
1.63 jmc 3447: .Cm organizationName
1.1 jsing 3448: can be input by calling it
3449: .Qq 1.organizationName .
3450: .Pp
3451: The actual permitted field names are any object identifier short or
3452: long names.
3453: These are compiled into
1.63 jmc 3454: .Nm openssl
1.1 jsing 3455: and include the usual values such as
1.63 jmc 3456: .Cm commonName , countryName , localityName , organizationName ,
3457: .Cm organizationUnitName , stateOrProvinceName .
1.1 jsing 3458: Additionally,
1.63 jmc 3459: .Cm emailAddress
1.1 jsing 3460: is included as well as
1.63 jmc 3461: .Cm name , surname , givenName , initials
1.1 jsing 3462: and
1.63 jmc 3463: .Cm dnQualifier .
1.1 jsing 3464: .Pp
3465: Additional object identifiers can be defined with the
1.63 jmc 3466: .Cm oid_file
1.1 jsing 3467: or
1.63 jmc 3468: .Cm oid_section
1.1 jsing 3469: options in the configuration file.
3470: Any additional fields will be treated as though they were a
1.63 jmc 3471: .Cm DirectoryString .
1.1 jsing 3472: .Sh RSA
3473: .nr nS 1
3474: .Nm "openssl rsa"
1.64 jmc 3475: .Op Fl aes128 | aes192 | aes256 | des | des3
1.1 jsing 3476: .Op Fl check
3477: .Op Fl in Ar file
1.64 jmc 3478: .Op Fl inform Cm der | net | pem
1.1 jsing 3479: .Op Fl modulus
3480: .Op Fl noout
3481: .Op Fl out Ar file
1.64 jmc 3482: .Op Fl outform Cm der | net | pem
1.1 jsing 3483: .Op Fl passin Ar arg
3484: .Op Fl passout Ar arg
3485: .Op Fl pubin
3486: .Op Fl pubout
3487: .Op Fl sgckey
3488: .Op Fl text
3489: .nr nS 0
3490: .Pp
3491: The
3492: .Nm rsa
3493: command processes RSA keys.
3494: They can be converted between various forms and their components printed out.
1.64 jmc 3495: .Nm rsa
3496: uses the traditional
1.1 jsing 3497: .Nm SSLeay
3498: compatible format for private key encryption:
3499: newer applications should use the more secure PKCS#8 format using the
3500: .Nm pkcs8
3501: utility.
3502: .Pp
3503: The options are as follows:
3504: .Bl -tag -width Ds
1.64 jmc 3505: .It Fl aes128 | aes192 | aes256 | des | des3
3506: Encrypt the private key with the AES, DES,
1.1 jsing 3507: or the triple DES ciphers, respectively, before outputting it.
3508: A pass phrase is prompted for.
3509: If none of these options are specified, the key is written in plain text.
3510: This means that using the
3511: .Nm rsa
3512: utility to read in an encrypted key with no encryption option can be used
3513: to remove the pass phrase from a key, or by setting the encryption options
3514: it can be used to add or change the pass phrase.
3515: These options can only be used with PEM format output files.
3516: .It Fl check
1.64 jmc 3517: Check the consistency of an RSA private key.
1.1 jsing 3518: .It Fl in Ar file
1.64 jmc 3519: The input file to read from,
3520: or standard input if not specified.
1.1 jsing 3521: If the key is encrypted, a pass phrase will be prompted for.
1.64 jmc 3522: .It Fl inform Cm der | net | pem
3523: The input format.
1.1 jsing 3524: .It Fl noout
1.64 jmc 3525: Do not output the encoded version of the key.
1.1 jsing 3526: .It Fl modulus
1.64 jmc 3527: Print the value of the modulus of the key.
1.1 jsing 3528: .It Fl out Ar file
1.64 jmc 3529: The output file to write to,
3530: or standard output if not specified.
3531: .It Fl outform Cm der | net | pem
3532: The output format.
1.1 jsing 3533: .It Fl passin Ar arg
3534: The key password source.
3535: .It Fl passout Ar arg
3536: The output file password source.
3537: .It Fl pubin
1.64 jmc 3538: Read in a public key,
3539: not a private key.
1.1 jsing 3540: .It Fl pubout
1.64 jmc 3541: Output a public key,
3542: not a private key.
3543: Automatically set if the input is a public key.
1.1 jsing 3544: .It Fl sgckey
1.64 jmc 3545: Use the modified NET algorithm used with some versions of Microsoft IIS
3546: and SGC keys.
1.1 jsing 3547: .It Fl text
1.64 jmc 3548: Print the public/private key components in plain text.
1.1 jsing 3549: .El
3550: .Sh RSAUTL
3551: .nr nS 1
3552: .Nm "openssl rsautl"
3553: .Op Fl asn1parse
3554: .Op Fl certin
3555: .Op Fl decrypt
3556: .Op Fl encrypt
3557: .Op Fl hexdump
3558: .Op Fl in Ar file
3559: .Op Fl inkey Ar file
1.65 ! jmc 3560: .Op Fl keyform Cm der | pem
1.1 jsing 3561: .Op Fl oaep | pkcs | raw | ssl
3562: .Op Fl out Ar file
3563: .Op Fl pubin
3564: .Op Fl sign
3565: .Op Fl verify
3566: .nr nS 0
3567: .Pp
3568: The
3569: .Nm rsautl
3570: command can be used to sign, verify, encrypt and decrypt
3571: data using the RSA algorithm.
3572: .Pp
3573: The options are as follows:
3574: .Bl -tag -width Ds
3575: .It Fl asn1parse
3576: Asn1parse the output data; this is useful when combined with the
3577: .Fl verify
3578: option.
3579: .It Fl certin
3580: The input is a certificate containing an RSA public key.
3581: .It Fl decrypt
3582: Decrypt the input data using an RSA private key.
3583: .It Fl encrypt
3584: Encrypt the input data using an RSA public key.
3585: .It Fl hexdump
3586: Hex dump the output data.
3587: .It Fl in Ar file
1.65 ! jmc 3588: The input to read from,
! 3589: or standard input if not specified.
1.1 jsing 3590: .It Fl inkey Ar file
1.65 ! jmc 3591: The input key file; by default an RSA private key.
! 3592: .It Fl keyform Cm der | pem
! 3593: The private ket format.
! 3594: The default is
! 3595: .Cm pem .
1.1 jsing 3596: .It Fl oaep | pkcs | raw | ssl
3597: The padding to use:
1.65 ! jmc 3598: PKCS#1 OAEP, PKCS#1 v1.5 (the default), or no padding, respectively.
1.1 jsing 3599: For signatures, only
3600: .Fl pkcs
3601: and
3602: .Fl raw
3603: can be used.
3604: .It Fl out Ar file
1.65 ! jmc 3605: The output file to write to,
! 3606: or standard output if not specified.
1.1 jsing 3607: .It Fl pubin
3608: The input file is an RSA public key.
3609: .It Fl sign
3610: Sign the input data and output the signed result.
3611: This requires an RSA private key.
3612: .It Fl verify
3613: Verify the input data and output the recovered data.
3614: .El
3615: .\"
3616: .\" S_CLIENT
3617: .\"
3618: .Sh S_CLIENT
3619: .nr nS 1
3620: .Nm "openssl s_client"
3621: .Bk -words
3622: .Op Fl 4 | 6
3623: .Op Fl bugs
3624: .Op Fl CAfile Ar file
3625: .Op Fl CApath Ar directory
3626: .Op Fl cert Ar file
3627: .Op Fl check_ss_sig
3628: .Op Fl cipher Ar cipherlist
3629: .Oo
3630: .Fl connect Ar host : Ns Ar port |
3631: .Ar host Ns / Ns Ar port
3632: .Oc
3633: .Op Fl crl_check
3634: .Op Fl crl_check_all
3635: .Op Fl crlf
3636: .Op Fl debug
3637: .Op Fl extended_crl
3638: .Op Fl ign_eof
3639: .Op Fl ignore_critical
3640: .Op Fl issuer_checks
3641: .Op Fl key Ar keyfile
3642: .Op Fl msg
3643: .Op Fl nbio
3644: .Op Fl nbio_test
3645: .Op Fl no_ticket
3646: .Op Fl no_tls1
1.6 guenther 3647: .Op Fl no_tls1_1
3648: .Op Fl no_tls1_2
1.1 jsing 3649: .Op Fl pause
3650: .Op Fl policy_check
3651: .Op Fl prexit
1.11 bluhm 3652: .Op Fl proxy Ar host : Ns Ar port
1.1 jsing 3653: .Op Fl psk Ar key
3654: .Op Fl psk_identity Ar identity
3655: .Op Fl quiet
3656: .Op Fl reconnect
1.5 jsing 3657: .Op Fl servername Ar name
1.1 jsing 3658: .Op Fl showcerts
3659: .Op Fl starttls Ar protocol
3660: .Op Fl state
3661: .Op Fl tls1
1.31 jmc 3662: .Op Fl tls1_1
3663: .Op Fl tls1_2
1.1 jsing 3664: .Op Fl tlsextdebug
3665: .Op Fl verify Ar depth
3666: .Op Fl x509_strict
1.19 landry 3667: .Op Fl xmpphost Ar host
1.1 jsing 3668: .Ek
3669: .nr nS 0
3670: .Pp
3671: The
3672: .Nm s_client
3673: command implements a generic SSL/TLS client which connects
3674: to a remote host using SSL/TLS.
3675: It is a
3676: .Em very
3677: useful diagnostic tool for SSL servers.
3678: .Pp
3679: The options are as follows:
3680: .Bl -tag -width Ds
3681: .It Fl 4
3682: Specify that
3683: .Nm s_client
3684: should attempt connections using IPv4 only.
3685: .It Fl 6
3686: Specify that
3687: .Nm s_client
3688: should attempt connections using IPv6 only.
3689: .It Fl bugs
3690: There are several known bugs in SSL and TLS implementations.
3691: Adding this option enables various workarounds.
3692: .It Fl CAfile Ar file
3693: A
3694: .Ar file
3695: containing trusted certificates to use during server authentication
3696: and to use when attempting to build the client certificate chain.
3697: .It Fl CApath Ar directory
3698: The
3699: .Ar directory
3700: to use for server certificate verification.
3701: This directory must be in
3702: .Qq hash format ;
3703: see
3704: .Fl verify
3705: for more information.
3706: These are also used when building the client certificate chain.
3707: .It Fl cert Ar file
3708: The certificate to use, if one is requested by the server.
3709: The default is not to use a certificate.
3710: .It Xo
3711: .Fl check_ss_sig ,
3712: .Fl crl_check ,
3713: .Fl crl_check_all ,
3714: .Fl extended_crl ,
3715: .Fl ignore_critical ,
3716: .Fl issuer_checks ,
3717: .Fl policy_check ,
3718: .Fl x509_strict
3719: .Xc
3720: Set various certificate chain validation options.
3721: See the
3722: .Nm VERIFY
3723: command for details.
3724: .It Fl cipher Ar cipherlist
3725: This allows the cipher list sent by the client to be modified.
3726: Although the server determines which cipher suite is used, it should take
3727: the first supported cipher in the list sent by the client.
3728: See the
3729: .Sx CIPHERS
3730: section above for more information.
3731: .It Xo
3732: .Fl connect Ar host : Ns Ar port |
3733: .Ar host Ns / Ns Ar port
3734: .Xc
3735: This specifies the
3736: .Ar host
3737: and optional
3738: .Ar port
3739: to connect to.
3740: If not specified, an attempt is made to connect to the local host
3741: on port 4433.
3742: Alternatively, the host and port pair may be separated using a forward-slash
3743: character.
3744: This form is useful for numeric IPv6 addresses.
3745: .It Fl crlf
3746: This option translates a line feed from the terminal into CR+LF as required
3747: by some servers.
3748: .It Fl debug
3749: Print extensive debugging information including a hex dump of all traffic.
3750: .It Fl ign_eof
3751: Inhibit shutting down the connection when end of file is reached in the
3752: input.
3753: .It Fl key Ar keyfile
3754: The private key to use.
3755: If not specified, the certificate file will be used.
3756: .It Fl msg
3757: Show all protocol messages with hex dump.
3758: .It Fl nbio
3759: Turns on non-blocking I/O.
3760: .It Fl nbio_test
3761: Tests non-blocking I/O.
1.31 jmc 3762: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.1 jsing 3763: By default, the initial handshake uses a method which should be compatible
1.31 jmc 3764: with servers supporting any version of TLS.
3765: These options disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 3766: .Pp
3767: Unfortunately there are a lot of ancient and broken servers in use which
3768: cannot handle this technique and will fail to connect.
3769: .It Fl no_ticket
3770: Disable RFC 4507 session ticket support.
3771: .It Fl pause
3772: Pauses 1 second between each read and write call.
3773: .It Fl prexit
3774: Print session information when the program exits.
3775: This will always attempt
3776: to print out information even if the connection fails.
3777: Normally, information will only be printed out once if the connection succeeds.
3778: This option is useful because the cipher in use may be renegotiated
3779: or the connection may fail because a client certificate is required or is
3780: requested only after an attempt is made to access a certain URL.
3781: .Sy Note :
3782: the output produced by this option is not always accurate because a
3783: connection might never have been established.
1.11 bluhm 3784: .It Fl proxy Ar host : Ns Ar port
3785: Use the HTTP proxy at
3786: .Ar host
3787: and
3788: .Ar port .
3789: The connection to the proxy is done in cleartext and the
3790: .Fl connect
3791: argument is given to the proxy.
3792: If not specified, localhost is used as final destination.
3793: After that, switch the connection through the proxy to the destination
3794: to TLS.
1.1 jsing 3795: .It Fl psk Ar key
3796: Use the PSK key
3797: .Ar key
3798: when using a PSK cipher suite.
3799: The key is given as a hexadecimal number without the leading 0x,
3800: for example -psk 1a2b3c4d.
3801: .It Fl psk_identity Ar identity
3802: Use the PSK identity
3803: .Ar identity
3804: when using a PSK cipher suite.
3805: .It Fl quiet
3806: Inhibit printing of session and certificate information.
3807: This implicitly turns on
3808: .Fl ign_eof
3809: as well.
3810: .It Fl reconnect
3811: Reconnects to the same server 5 times using the same session ID; this can
3812: be used as a test that session caching is working.
1.5 jsing 3813: .It Fl servername Ar name
3814: Include the TLS Server Name Indication (SNI) extension in the ClientHello
3815: message, using the specified server
3816: .Ar name .
1.1 jsing 3817: .It Fl showcerts
3818: Display the whole server certificate chain: normally only the server
3819: certificate itself is displayed.
3820: .It Fl starttls Ar protocol
3821: Send the protocol-specific message(s) to switch to TLS for communication.
3822: .Ar protocol
3823: is a keyword for the intended protocol.
3824: Currently, the supported keywords are
3825: .Qq ftp ,
3826: .Qq imap ,
3827: .Qq smtp ,
3828: .Qq pop3 ,
3829: and
3830: .Qq xmpp .
3831: .It Fl state
3832: Prints out the SSL session states.
1.31 jmc 3833: .It Fl tls1 | tls1_1 | tls1_2
3834: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 3835: .It Fl tlsextdebug
3836: Print out a hex dump of any TLS extensions received from the server.
3837: .It Fl verify Ar depth
3838: The verify
3839: .Ar depth
3840: to use.
3841: This specifies the maximum length of the
3842: server certificate chain and turns on server certificate verification.
3843: Currently the verify operation continues after errors so all the problems
3844: with a certificate chain can be seen.
3845: As a side effect the connection will never fail due to a server
3846: certificate verify failure.
1.19 landry 3847: .It Fl xmpphost Ar hostname
3848: This option, when used with
3849: .Fl starttls Ar xmpp ,
3850: specifies the host for the "to" attribute of the stream element.
3851: If this option is not specified then the host specified with
3852: .Fl connect
3853: will be used.
1.1 jsing 3854: .El
3855: .Sh S_CLIENT CONNECTED COMMANDS
3856: If a connection is established with an SSL server, any data received
3857: from the server is displayed and any key presses will be sent to the
3858: server.
3859: When used interactively (which means neither
3860: .Fl quiet
3861: nor
3862: .Fl ign_eof
3863: have been given), the session will be renegotiated if the line begins with an
3864: .Em R ;
3865: if the line begins with a
3866: .Em Q
3867: or if end of file is reached, the connection will be closed down.
3868: .Sh S_CLIENT NOTES
3869: .Nm s_client
3870: can be used to debug SSL servers.
3871: To connect to an SSL HTTP server the command:
3872: .Pp
3873: .Dl $ openssl s_client -connect servername:443
3874: .Pp
3875: would typically be used
3876: .Pq HTTPS uses port 443 .
3877: If the connection succeeds, an HTTP command can be given such as
3878: .Qq GET
3879: to retrieve a web page.
3880: .Pp
3881: If the handshake fails, there are several possible causes; if it is
3882: nothing obvious like no client certificate, then the
1.31 jmc 3883: .Fl bugs , tls1 , tls1_1, tls1_2 , no_tls1 , no_tls1_1 ,
1.1 jsing 3884: and
1.6 guenther 3885: .Fl no_tls1_2
1.1 jsing 3886: options can be tried in case it is a buggy server.
3887: .Pp
3888: A frequent problem when attempting to get client certificates working
3889: is that a web client complains it has no certificates or gives an empty
3890: list to choose from.
3891: This is normally because the server is not sending the client's certificate
3892: authority in its
3893: .Qq acceptable CA list
3894: when it requests a certificate.
3895: By using
3896: .Nm s_client
3897: the CA list can be viewed and checked.
3898: However some servers only request client authentication
3899: after a specific URL is requested.
3900: To obtain the list in this case it is necessary to use the
3901: .Fl prexit
3902: option and send an HTTP request for an appropriate page.
3903: .Pp
3904: If a certificate is specified on the command line using the
3905: .Fl cert
3906: option, it will not be used unless the server specifically requests
3907: a client certificate.
3908: Therefore merely including a client certificate
3909: on the command line is no guarantee that the certificate works.
3910: .Pp
3911: If there are problems verifying a server certificate, the
3912: .Fl showcerts
3913: option can be used to show the whole chain.
3914: .Pp
3915: Compression methods are only supported for
3916: .Fl tls1 .
3917: .Sh S_CLIENT BUGS
3918: Because this program has a lot of options and also because some of
3919: the techniques used are rather old, the C source of
3920: .Nm s_client
3921: is rather hard to read and not a model of how things should be done.
3922: A typical SSL client program would be much simpler.
3923: .Pp
3924: The
3925: .Fl verify
3926: option should really exit if the server verification fails.
3927: .Pp
3928: The
3929: .Fl prexit
3930: option is a bit of a hack.
3931: We should really report information whenever a session is renegotiated.
3932: .\"
3933: .\" S_SERVER
3934: .\"
3935: .Sh S_SERVER
3936: .nr nS 1
3937: .Nm "openssl s_server"
3938: .Bk -words
3939: .Op Fl accept Ar port
3940: .Op Fl bugs
3941: .Op Fl CAfile Ar file
3942: .Op Fl CApath Ar directory
3943: .Op Fl cert Ar file
3944: .Op Fl cipher Ar cipherlist
3945: .Op Fl context Ar id
3946: .Op Fl crl_check
3947: .Op Fl crl_check_all
3948: .Op Fl crlf
3949: .Op Fl dcert Ar file
3950: .Op Fl debug
3951: .Op Fl dhparam Ar file
3952: .Op Fl dkey Ar file
3953: .Op Fl hack
3954: .Op Fl HTTP
3955: .Op Fl id_prefix Ar arg
3956: .Op Fl key Ar keyfile
3957: .Op Fl msg
3958: .Op Fl nbio
3959: .Op Fl nbio_test
3960: .Op Fl no_dhe
3961: .Op Fl no_tls1
1.6 guenther 3962: .Op Fl no_tls1_1
3963: .Op Fl no_tls1_2
1.1 jsing 3964: .Op Fl no_tmp_rsa
3965: .Op Fl nocert
3966: .Op Fl psk Ar key
3967: .Op Fl psk_hint Ar hint
3968: .Op Fl quiet
3969: .Op Fl serverpref
3970: .Op Fl state
3971: .Op Fl tls1
1.31 jmc 3972: .Op Fl tls1_1
3973: .Op Fl tls1_2
1.1 jsing 3974: .Op Fl Verify Ar depth
3975: .Op Fl verify Ar depth
3976: .Op Fl WWW
3977: .Op Fl www
3978: .Ek
3979: .nr nS 0
3980: .Pp
3981: The
3982: .Nm s_server
3983: command implements a generic SSL/TLS server which listens
3984: for connections on a given port using SSL/TLS.
3985: .Pp
3986: The options are as follows:
3987: .Bl -tag -width Ds
3988: .It Fl accept Ar port
3989: The TCP
3990: .Ar port
3991: to listen on for connections.
3992: If not specified, 4433 is used.
3993: .It Fl bugs
3994: There are several known bugs in SSL and TLS implementations.
3995: Adding this option enables various workarounds.
3996: .It Fl CAfile Ar file
3997: A file containing trusted certificates to use during client authentication
3998: and to use when attempting to build the server certificate chain.
3999: The list is also used in the list of acceptable client CAs passed to the
4000: client when a certificate is requested.
4001: .It Fl CApath Ar directory
4002: The
4003: .Ar directory
4004: to use for client certificate verification.
4005: This directory must be in
4006: .Qq hash format ;
4007: see
4008: .Fl verify
4009: for more information.
4010: These are also used when building the server certificate chain.
4011: .It Fl cert Ar file
4012: The certificate to use; most server's cipher suites require the use of a
4013: certificate and some require a certificate with a certain public key type:
4014: for example the DSS cipher suites require a certificate containing a DSS
4015: .Pq DSA
4016: key.
4017: If not specified, the file
4018: .Pa server.pem
4019: will be used.
4020: .It Fl cipher Ar cipherlist
4021: This allows the cipher list used by the server to be modified.
4022: When the client sends a list of supported ciphers, the first client cipher
4023: also included in the server list is used.
4024: Because the client specifies the preference order, the order of the server
4025: cipherlist is irrelevant.
4026: See the
4027: .Sx CIPHERS
4028: section for more information.
4029: .It Fl context Ar id
4030: Sets the SSL context ID.
4031: It can be given any string value.
4032: If this option is not present, a default value will be used.
4033: .It Fl crl_check , crl_check_all
4034: Check the peer certificate has not been revoked by its CA.
4035: The CRLs are appended to the certificate file.
4036: With the
4037: .Fl crl_check_all
4038: option, all CRLs of all CAs in the chain are checked.
4039: .It Fl crlf
4040: This option translates a line feed from the terminal into CR+LF.
4041: .It Fl dcert Ar file , Fl dkey Ar file
4042: Specify an additional certificate and private key; these behave in the
4043: same manner as the
4044: .Fl cert
4045: and
4046: .Fl key
4047: options except there is no default if they are not specified
4048: .Pq no additional certificate or key is used .
4049: As noted above some cipher suites require a certificate containing a key of
4050: a certain type.
4051: Some cipher suites need a certificate carrying an RSA key
4052: and some a DSS
4053: .Pq DSA
4054: key.
4055: By using RSA and DSS certificates and keys,
4056: a server can support clients which only support RSA or DSS cipher suites
4057: by using an appropriate certificate.
4058: .It Fl debug
4059: Print extensive debugging information including a hex dump of all traffic.
4060: .It Fl dhparam Ar file
4061: The DH parameter file to use.
4062: The ephemeral DH cipher suites generate keys
4063: using a set of DH parameters.
4064: If not specified, an attempt is made to
4065: load the parameters from the server certificate file.
4066: If this fails, a static set of parameters hard coded into the
4067: .Nm s_server
4068: program will be used.
4069: .It Fl hack
4070: This option enables a further workaround for some early Netscape
4071: SSL code
4072: .Pq \&? .
4073: .It Fl HTTP
4074: Emulates a simple web server.
4075: Pages will be resolved relative to the current directory;
4076: for example if the URL
4077: .Pa https://myhost/page.html
4078: is requested, the file
4079: .Pa ./page.html
4080: will be loaded.
4081: The files loaded are assumed to contain a complete and correct HTTP
4082: response (lines that are part of the HTTP response line and headers
4083: must end with CRLF).
4084: .It Fl id_prefix Ar arg
4085: Generate SSL/TLS session IDs prefixed by
4086: .Ar arg .
4087: This is mostly useful for testing any SSL/TLS code
4088: .Pq e.g. proxies
4089: that wish to deal with multiple servers, when each of which might be
4090: generating a unique range of session IDs
4091: .Pq e.g. with a certain prefix .
4092: .It Fl key Ar keyfile
4093: The private key to use.
4094: If not specified, the certificate file will be used.
4095: .It Fl msg
4096: Show all protocol messages with hex dump.
4097: .It Fl nbio
4098: Turns on non-blocking I/O.
4099: .It Fl nbio_test
4100: Tests non-blocking I/O.
4101: .It Fl no_dhe
4102: If this option is set, no DH parameters will be loaded, effectively
4103: disabling the ephemeral DH cipher suites.
1.31 jmc 4104: .It Fl no_tls1 | no_tls1_1 | no_tls1_2
1.1 jsing 4105: By default, the initial handshake uses a method which should be compatible
1.32 jmc 4106: with clients supporting any version of TLS.
1.31 jmc 4107: These options disable the use of TLS1.0, 1.1, and 1.2, respectively.
1.1 jsing 4108: .It Fl no_tmp_rsa
4109: Certain export cipher suites sometimes use a temporary RSA key; this option
4110: disables temporary RSA key generation.
4111: .It Fl nocert
4112: If this option is set, no certificate is used.
4113: This restricts the cipher suites available to the anonymous ones
4114: .Pq currently just anonymous DH .
4115: .It Fl psk Ar key
4116: Use the PSK key
4117: .Ar key
4118: when using a PSK cipher suite.
4119: The key is given as a hexadecimal number without the leading 0x,
4120: for example -psk 1a2b3c4d.
4121: .It Fl psk_hint Ar hint
4122: Use the PSK identity hint
4123: .Ar hint
4124: when using a PSK cipher suite.
4125: .It Fl quiet
4126: Inhibit printing of session and certificate information.
4127: .It Fl serverpref
4128: Use server's cipher preferences.
4129: .It Fl state
4130: Prints out the SSL session states.
1.31 jmc 4131: .It Fl tls1 | tls1_1 | tls1_2
4132: Permit only TLS1.0, 1.1, or 1.2, respectively.
1.1 jsing 4133: .It Fl WWW
4134: Emulates a simple web server.
4135: Pages will be resolved relative to the current directory;
4136: for example if the URL
4137: .Pa https://myhost/page.html
4138: is requested, the file
4139: .Pa ./page.html
4140: will be loaded.
4141: .It Fl www
4142: Sends a status message back to the client when it connects.
4143: This includes lots of information about the ciphers used and various
4144: session parameters.
4145: The output is in HTML format so this option will normally be used with a
4146: web browser.
4147: .It Fl Verify Ar depth , Fl verify Ar depth
4148: The verify
4149: .Ar depth
4150: to use.
4151: This specifies the maximum length of the client certificate chain
4152: and makes the server request a certificate from the client.
4153: With the
4154: .Fl Verify
4155: option, the client must supply a certificate or an error occurs.
4156: With the
4157: .Fl verify
4158: option, a certificate is requested but the client does not have to send one.
4159: .El
4160: .Sh S_SERVER CONNECTED COMMANDS
4161: If a connection request is established with an SSL client and neither the
4162: .Fl www
4163: nor the
4164: .Fl WWW
4165: option has been used, then normally any data received
4166: from the client is displayed and any key presses will be sent to the client.
4167: .Pp
4168: Certain single letter commands are also recognized which perform special
4169: operations: these are listed below.
4170: .Bl -tag -width "XXXX"
4171: .It Ar P
4172: Send some plain text down the underlying TCP connection: this should
4173: cause the client to disconnect due to a protocol violation.
4174: .It Ar Q
4175: End the current SSL connection and exit.
4176: .It Ar q
4177: End the current SSL connection, but still accept new connections.
4178: .It Ar R
4179: Renegotiate the SSL session and request a client certificate.
4180: .It Ar r
4181: Renegotiate the SSL session.
4182: .It Ar S
4183: Print out some session cache status information.
4184: .El
4185: .Sh S_SERVER NOTES
4186: .Nm s_server
4187: can be used to debug SSL clients.
4188: To accept connections from a web browser the command:
4189: .Pp
4190: .Dl $ openssl s_server -accept 443 -www
4191: .Pp
4192: can be used, for example.
4193: .Pp
4194: Most web browsers
4195: .Pq in particular Netscape and MSIE
4196: only support RSA cipher suites, so they cannot connect to servers
4197: which don't use a certificate carrying an RSA key or a version of
4198: .Nm OpenSSL
4199: with RSA disabled.
4200: .Pp
4201: Although specifying an empty list of CAs when requesting a client certificate
4202: is strictly speaking a protocol violation, some SSL
4203: clients interpret this to mean any CA is acceptable.
4204: This is useful for debugging purposes.
4205: .Pp
4206: The session parameters can printed out using the
4207: .Nm sess_id
4208: program.
4209: .Sh S_SERVER BUGS
4210: Because this program has a lot of options and also because some of
4211: the techniques used are rather old, the C source of
4212: .Nm s_server
4213: is rather hard to read and not a model of how things should be done.
4214: A typical SSL server program would be much simpler.
4215: .Pp
4216: The output of common ciphers is wrong: it just gives the list of ciphers that
4217: .Nm OpenSSL
4218: recognizes and the client supports.
4219: .Pp
4220: There should be a way for the
4221: .Nm s_server
4222: program to print out details of any
4223: unknown cipher suites a client says it supports.
4224: .\"
4225: .\" S_TIME
4226: .\"
4227: .Sh S_TIME
4228: .nr nS 1
4229: .Nm "openssl s_time"
4230: .Bk -words
4231: .Op Fl bugs
4232: .Op Fl CAfile Ar file
4233: .Op Fl CApath Ar directory
4234: .Op Fl cert Ar file
4235: .Op Fl cipher Ar cipherlist
4236: .Op Fl connect Ar host : Ns Ar port
4237: .Op Fl key Ar keyfile
4238: .Op Fl nbio
4239: .Op Fl new
1.20 lteo 4240: .Op Fl no_shutdown
1.1 jsing 4241: .Op Fl reuse
4242: .Op Fl time Ar seconds
4243: .Op Fl verify Ar depth
4244: .Op Fl www Ar page
4245: .Ek
4246: .nr nS 0
4247: .Pp
4248: The
4249: .Nm s_client
4250: command implements a generic SSL/TLS client which connects to a
4251: remote host using SSL/TLS.
4252: It can request a page from the server and includes
4253: the time to transfer the payload data in its timing measurements.
4254: It measures the number of connections within a given timeframe,
4255: the amount of data transferred
4256: .Pq if any ,
4257: and calculates the average time spent for one connection.
4258: .Pp
4259: The options are as follows:
4260: .Bl -tag -width Ds
4261: .It Fl bugs
4262: There are several known bugs in SSL and TLS implementations.
4263: Adding this option enables various workarounds.
4264: .It Fl CAfile Ar file
4265: A file containing trusted certificates to use during server authentication
4266: and to use when attempting to build the client certificate chain.
4267: .It Fl CApath Ar directory
4268: The directory to use for server certificate verification.
4269: This directory must be in
4270: .Qq hash format ;
4271: see
4272: .Nm verify
4273: for more information.
4274: These are also used when building the client certificate chain.
4275: .It Fl cert Ar file
4276: The certificate to use, if one is requested by the server.
4277: The default is not to use a certificate.
4278: The file is in PEM format.
4279: .It Fl cipher Ar cipherlist
4280: This allows the cipher list sent by the client to be modified.
4281: Although the server determines which cipher suite is used,
4282: it should take the first supported cipher in the list sent by the client.
4283: See the
4284: .Nm ciphers
4285: command for more information.
4286: .It Fl connect Ar host : Ns Ar port
4287: This specifies the host and optional port to connect to.
4288: .It Fl key Ar keyfile
4289: The private key to use.
4290: If not specified, the certificate file will be used.
4291: The file is in PEM format.
4292: .It Fl nbio
4293: Turns on non-blocking I/O.
4294: .It Fl new
4295: Performs the timing test using a new session ID for each connection.
4296: If neither
4297: .Fl new
4298: nor
4299: .Fl reuse
4300: are specified,
4301: they are both on by default and executed in sequence.
1.20 lteo 4302: .It Fl no_shutdown
1.21 jmc 4303: Shut down the connection without sending a
1.20 lteo 4304: .Dq close notify
4305: shutdown alert to the server.
1.1 jsing 4306: .It Fl reuse
4307: Performs the timing test using the same session ID;
4308: this can be used as a test that session caching is working.
4309: If neither
4310: .Fl new
4311: nor
4312: .Fl reuse
4313: are specified,
4314: they are both on by default and executed in sequence.
4315: .It Fl time Ar seconds
4316: Specifies how long
4317: .Pq in seconds
4318: .Nm s_time
4319: should establish connections and
4320: optionally transfer payload data from a server.
4321: The default is 30 seconds.
4322: Server and client performance and the link speed
4323: determine how many connections
4324: .Nm s_time
4325: can establish.
4326: .It Fl verify Ar depth
4327: The verify depth to use.
4328: This specifies the maximum length of the server certificate chain
4329: and turns on server certificate verification.
4330: Currently the verify operation continues after errors, so all the problems
4331: with a certificate chain can be seen.
4332: As a side effect,
4333: the connection will never fail due to a server certificate verify failure.
4334: .It Fl www Ar page
4335: This specifies the page to GET from the server.
4336: A value of
4337: .Sq /
4338: gets the index.htm[l] page.
4339: If this parameter is not specified,
4340: .Nm s_time
4341: will only perform the handshake to establish SSL connections
4342: but not transfer any payload data.
4343: .El
4344: .Sh S_TIME NOTES
4345: .Nm s_client
4346: can be used to measure the performance of an SSL connection.
4347: To connect to an SSL HTTP server and get the default page the command
4348: .Bd -literal -offset indent
4349: $ openssl s_time -connect servername:443 -www / -CApath yourdir \e
1.18 jmc 4350: -CAfile yourfile.pem -cipher commoncipher
1.1 jsing 4351: .Ed
4352: .Pp
4353: would typically be used
4354: .Pq HTTPS uses port 443 .
4355: .Dq commoncipher
4356: is a cipher to which both client and server can agree;
4357: see the
4358: .Nm ciphers
4359: command for details.
4360: .Pp
4361: If the handshake fails, there are several possible causes:
4362: if it is nothing obvious like no client certificate, the
4363: .Fl bugs
1.18 jmc 4364: option can be tried in case it is a buggy server.
1.1 jsing 4365: .Pp
4366: A frequent problem when attempting to get client certificates working
4367: is that a web client complains it has no certificates or gives an empty
4368: list to choose from.
4369: This is normally because the server is not sending
4370: the clients certificate authority in its
4371: .Qq acceptable CA list
4372: when it requests a certificate.
4373: By using
4374: .Nm s_client ,
4375: the CA list can be viewed and checked.
4376: However some servers only request client authentication
4377: after a specific URL is requested.
4378: To obtain the list in this case, it is necessary to use the
4379: .Fl prexit
4380: option of
4381: .Nm s_client
4382: and send an HTTP request for an appropriate page.
4383: .Pp
4384: If a certificate is specified on the command line using the
4385: .Fl cert
4386: option,
4387: it will not be used unless the server specifically requests
4388: a client certificate.
4389: Therefore merely including a client certificate
4390: on the command line is no guarantee that the certificate works.
4391: .Sh S_TIME BUGS
4392: Because this program does not have all the options of the
4393: .Nm s_client
4394: program to turn protocols on and off,
4395: you may not be able to measure the performance
4396: of all protocols with all servers.
4397: .Pp
4398: The
4399: .Fl verify
4400: option should really exit if the server verification fails.
4401: .\"
4402: .\" SESS_ID
4403: .\"
4404: .Sh SESS_ID
4405: .nr nS 1
4406: .Nm "openssl sess_id"
4407: .Bk -words
4408: .Op Fl cert
4409: .Op Fl context Ar ID
4410: .Op Fl in Ar file
4411: .Op Fl inform Ar DER | PEM
4412: .Op Fl noout
4413: .Op Fl out Ar file
4414: .Op Fl outform Ar DER | PEM
4415: .Op Fl text
4416: .Ek
4417: .nr nS 0
4418: .Pp
4419: The
4420: .Nm sess_id
4421: program processes the encoded version of the SSL session structure and
4422: optionally prints out SSL session details
4423: .Pq for example the SSL session master key
4424: in human readable format.
4425: Since this is a diagnostic tool that needs some knowledge of the SSL
4426: protocol to use properly, most users will not need to use it.
4427: .Pp
4428: The options are as follows:
4429: .Bl -tag -width Ds
4430: .It Fl cert
4431: If a certificate is present in the session,
4432: it will be output using this option;
4433: if the
4434: .Fl text
4435: option is also present, then it will be printed out in text form.
4436: .It Fl context Ar ID
4437: This option can set the session ID so the output session information uses the
4438: supplied
4439: .Ar ID .
4440: The
4441: .Ar ID
4442: can be any string of characters.
4443: This option won't normally be used.
4444: .It Fl in Ar file
4445: This specifies the input
4446: .Ar file
4447: to read session information from, or standard input by default.
4448: .It Fl inform Ar DER | PEM
4449: This specifies the input format.
4450: The
4451: .Ar DER
4452: argument uses an ASN1 DER-encoded
4453: format containing session details.
4454: The precise format can vary from one version to the next.
4455: The
4456: .Ar PEM
4457: form is the default format: it consists of the DER
4458: format base64-encoded with additional header and footer lines.
4459: .It Fl noout
4460: This option prevents output of the encoded version of the session.
4461: .It Fl out Ar file
4462: This specifies the output
4463: .Ar file
4464: to write session information to, or standard
4465: output if this option is not specified.
4466: .It Fl outform Ar DER | PEM
4467: This specifies the output format; the options have the same meaning as the
4468: .Fl inform
4469: option.
4470: .It Fl text
4471: Prints out the various public or private key components in
4472: plain text in addition to the encoded version.
4473: .El
4474: .Sh SESS_ID OUTPUT
4475: Typical output:
4476: .Bd -literal
4477: SSL-Session:
4478: Protocol : TLSv1
4479: Cipher : 0016
4480: Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
4481: Session-ID-ctx: 01000000
4482: Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
4483: Key-Arg : None
4484: Start Time: 948459261
4485: Timeout : 300 (sec)
4486: Verify return code 0 (ok)
4487: .Ed
4488: .Pp
4489: These are described below in more detail.
4490: .Pp
4491: .Bl -tag -width "Verify return code " -compact
4492: .It Ar Protocol
1.18 jmc 4493: This is the protocol in use.
1.1 jsing 4494: .It Ar Cipher
4495: The cipher used is the actual raw SSL or TLS cipher code;
4496: see the SSL or TLS specifications for more information.
4497: .It Ar Session-ID
4498: The SSL session ID in hex format.
4499: .It Ar Session-ID-ctx
4500: The session ID context in hex format.
4501: .It Ar Master-Key
4502: This is the SSL session master key.
4503: .It Ar Key-Arg
4504: The key argument; this is only used in SSL v2.
4505: .It Ar Start Time
4506: This is the session start time, represented as an integer in standard
4507: .Ux
4508: format.
4509: .It Ar Timeout
4510: The timeout in seconds.
4511: .It Ar Verify return code
4512: This is the return code when an SSL client certificate is verified.
4513: .El
4514: .Sh SESS_ID NOTES
4515: The PEM-encoded session format uses the header and footer lines:
4516: .Bd -unfilled -offset indent
4517: -----BEGIN SSL SESSION PARAMETERS-----
4518: -----END SSL SESSION PARAMETERS-----
4519: .Ed
4520: .Pp
4521: Since the SSL session output contains the master key, it is possible to read
4522: the contents of an encrypted session using this information.
4523: Therefore appropriate security precautions
4524: should be taken if the information is being output by a
4525: .Qq real
4526: application.
4527: This is, however, strongly discouraged and should only be used for
4528: debugging purposes.
4529: .Sh SESS_ID BUGS
4530: The cipher and start time should be printed out in human readable form.
4531: .\"
4532: .\" SMIME
4533: .\"
4534: .Sh SMIME
4535: .nr nS 1
4536: .Nm "openssl smime"
4537: .Bk -words
4538: .Oo
4539: .Fl aes128 | aes192 | aes256 | des |
4540: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4541: .Oc
4542: .Op Fl binary
4543: .Op Fl CAfile Ar file
4544: .Op Fl CApath Ar directory
4545: .Op Fl certfile Ar file
4546: .Op Fl check_ss_sig
4547: .Op Fl content Ar file
4548: .Op Fl crl_check
4549: .Op Fl crl_check_all
4550: .Op Fl decrypt
4551: .Op Fl encrypt
4552: .Op Fl extended_crl
4553: .Op Fl from Ar addr
4554: .Op Fl ignore_critical
4555: .Op Fl in Ar file
4556: .Op Fl indef
4557: .Op Fl inform Ar DER | PEM | SMIME
4558: .Op Fl inkey Ar file
4559: .Op Fl issuer_checks
1.22 bcook 4560: .Op Fl keyform Ar PEM
1.1 jsing 4561: .Op Fl md Ar digest
4562: .Op Fl noattr
4563: .Op Fl nocerts
4564: .Op Fl nochain
4565: .Op Fl nodetach
4566: .Op Fl noindef
4567: .Op Fl nointern
4568: .Op Fl nosigs
4569: .Op Fl noverify
4570: .Op Fl out Ar file
4571: .Op Fl outform Ar DER | PEM | SMIME
4572: .Op Fl passin Ar arg
4573: .Op Fl pk7out
4574: .Op Fl policy_check
4575: .Op Fl recip Ar file
4576: .Op Fl resign
4577: .Op Fl sign
4578: .Op Fl signer Ar file
4579: .Op Fl stream
4580: .Op Fl subject Ar s
4581: .Op Fl text
4582: .Op Fl to Ar addr
4583: .Op Fl verify
4584: .Op Fl x509_strict
4585: .Op Ar cert.pem ...
4586: .Ek
4587: .nr nS 0
4588: .Pp
4589: The
4590: .Nm smime
4591: command handles
4592: .Em S/MIME
4593: mail.
4594: It can encrypt, decrypt, sign, and verify
4595: .Em S/MIME
4596: messages.
4597: .Pp
4598: There are six operation options that set the type of operation to be performed.
4599: The meaning of the other options varies according to the operation type.
4600: .Pp
4601: The six operation options are as follows:
4602: .Bl -tag -width "XXXX"
4603: .It Fl decrypt
4604: Decrypt mail using the supplied certificate and private key.
4605: Expects an encrypted mail message in
4606: .Em MIME
4607: format for the input file.
4608: The decrypted mail is written to the output file.
4609: .It Fl encrypt
4610: Encrypt mail for the given recipient certificates.
4611: Input file is the message to be encrypted.
4612: The output file is the encrypted mail in
4613: .Em MIME
4614: format.
4615: .It Fl pk7out
4616: Takes an input message and writes out a PEM-encoded PKCS#7 structure.
4617: .It Fl resign
4618: Resign a message: take an existing message and one or more new signers.
4619: .It Fl sign
4620: Sign mail using the supplied certificate and private key.
4621: Input file is the message to be signed.
4622: The signed message in
4623: .Em MIME
4624: format is written to the output file.
4625: .It Fl verify
4626: Verify signed mail.
4627: Expects a signed mail message on input and outputs the signed data.
4628: Both clear text and opaque signing is supported.
4629: .El
4630: .Pp
1.14 jmc 4631: The remaining options are as follows:
1.1 jsing 4632: .Bl -tag -width "XXXX"
4633: .It Xo
4634: .Fl aes128 | aes192 | aes256 | des |
4635: .Fl des3 | rc2-40 | rc2-64 | rc2-128
4636: .Xc
4637: The encryption algorithm to use.
4638: 128-, 192-, or 256-bit AES,
4639: DES
4640: .Pq 56 bits ,
4641: triple DES
4642: .Pq 168 bits ,
4643: or 40-, 64-, or 128-bit RC2, respectively;
4644: if not specified, 40-bit RC2 is
4645: used.
4646: Only used with
4647: .Fl encrypt .
4648: .It Fl binary
4649: Normally, the input message is converted to
4650: .Qq canonical
4651: format which is effectively using CR and LF as end of line \-
4652: as required by the
4653: .Em S/MIME
4654: specification.
4655: When this option is present no translation occurs.
4656: This is useful when handling binary data which may not be in
4657: .Em MIME
4658: format.
4659: .It Fl CAfile Ar file
4660: A
4661: .Ar file
4662: containing trusted CA certificates; only used with
4663: .Fl verify .
4664: .It Fl CApath Ar directory
4665: A
4666: .Ar directory
4667: containing trusted CA certificates; only used with
4668: .Fl verify .
4669: This directory must be a standard certificate directory:
4670: that is, a hash of each subject name (using
4671: .Nm x509 -hash )
4672: should be linked to each certificate.
4673: .It Ar cert.pem ...
4674: One or more certificates of message recipients: used when encrypting
4675: a message.
4676: .It Fl certfile Ar file
4677: Allows additional certificates to be specified.
4678: When signing, these will be included with the message.
4679: When verifying, these will be searched for the signers' certificates.
4680: The certificates should be in PEM format.
4681: .It Xo
4682: .Fl check_ss_sig ,
4683: .Fl crl_check ,
4684: .Fl crl_check_all ,
4685: .Fl extended_crl ,
4686: .Fl ignore_critical ,
4687: .Fl issuer_checks ,
4688: .Fl policy_check ,
4689: .Fl x509_strict
4690: .Xc
4691: Set various certificate chain validation options.
4692: See the
4693: .Nm VERIFY
4694: command for details.
4695: .It Fl content Ar file
4696: This specifies a file containing the detached content.
4697: This is only useful with the
4698: .Fl verify
4699: command.
4700: This is only usable if the PKCS#7 structure is using the detached
4701: signature form where the content is not included.
4702: This option will override any content if the input format is
4703: .Em S/MIME
4704: and it uses the multipart/signed
4705: .Em MIME
4706: content type.
4707: .It Xo
4708: .Fl from Ar addr ,
4709: .Fl subject Ar s ,
4710: .Fl to Ar addr
4711: .Xc
4712: The relevant mail headers.
4713: These are included outside the signed
4714: portion of a message so they may be included manually.
4715: When signing, many
4716: .Em S/MIME
4717: mail clients check that the signer's certificate email
4718: address matches the From: address.
4719: .It Fl in Ar file
4720: The input message to be encrypted or signed or the
4721: .Em MIME
4722: message to
4723: be decrypted or verified.
4724: .It Fl indef
4725: Enable streaming I/O for encoding operations.
4726: This permits single pass processing of data without
4727: the need to hold the entire contents in memory,
4728: potentially supporting very large files.
4729: Streaming is automatically set for S/MIME signing with detached
4730: data if the output format is SMIME;
4731: it is currently off by default for all other operations.
4732: .It Fl inform Ar DER | PEM | SMIME
4733: This specifies the input format for the PKCS#7 structure.
4734: The default is
4735: .Em SMIME ,
4736: which reads an
4737: .Em S/MIME
4738: format message.
4739: .Ar PEM
4740: and
4741: .Ar DER
4742: format change this to expect PEM and DER format PKCS#7 structures
4743: instead.
4744: This currently only affects the input format of the PKCS#7
4745: structure; if no PKCS#7 structure is being input (for example with
4746: .Fl encrypt
4747: or
4748: .Fl sign ) ,
4749: this option has no effect.
4750: .It Fl inkey Ar file
4751: The private key to use when signing or decrypting.
4752: This must match the corresponding certificate.
4753: If this option is not specified, the private key must be included
4754: in the certificate file specified with
4755: the
4756: .Fl recip
4757: or
4758: .Fl signer
4759: file.
4760: When signing,
4761: this option can be used multiple times to specify successive keys.
1.22 bcook 4762: .It Fl keyform Ar PEM
1.1 jsing 4763: Input private key format.
4764: .It Fl md Ar digest
4765: The digest algorithm to use when signing or resigning.
4766: If not present then the default digest algorithm for the signing key is used
4767: (usually SHA1).
4768: .It Fl noattr
4769: Normally, when a message is signed a set of attributes are included which
4770: include the signing time and supported symmetric algorithms.
4771: With this option they are not included.
4772: .It Fl nocerts
4773: When signing a message, the signer's certificate is normally included;
4774: with this option it is excluded.
4775: This will reduce the size of the signed message but the verifier must
4776: have a copy of the signer's certificate available locally (passed using the
4777: .Fl certfile
4778: option, for example).
4779: .It Fl nochain
4780: Do not do chain verification of signers' certificates: that is,
4781: don't use the certificates in the signed message as untrusted CAs.
4782: .It Fl nodetach
4783: When signing a message use opaque signing: this form is more resistant
4784: to translation by mail relays but it cannot be read by mail agents that
4785: do not support
4786: .Em S/MIME .
4787: Without this option cleartext signing with the
4788: .Em MIME
4789: type multipart/signed is used.
4790: .It Fl noindef
4791: Disable streaming I/O where it would produce an encoding of indefinite length.
4792: This option currently has no effect.
4793: In future streaming will be enabled by default on all relevant operations
4794: and this option will disable it.
4795: .It Fl nointern
4796: When verifying a message, normally certificates
4797: .Pq if any
4798: included in the message are searched for the signing certificate.
4799: With this option, only the certificates specified in the
4800: .Fl certfile
4801: option are used.
4802: The supplied certificates can still be used as untrusted CAs however.
4803: .It Fl nosigs
4804: Don't try to verify the signatures on the message.
4805: .It Fl noverify
4806: Do not verify the signer's certificate of a signed message.
4807: .It Fl out Ar file
4808: The message text that has been decrypted or verified, or the output
4809: .Em MIME
4810: format message that has been signed or verified.
4811: .It Fl outform Ar DER | PEM | SMIME
4812: This specifies the output format for the PKCS#7 structure.
4813: The default is
4814: .Em SMIME ,
4815: which writes an
4816: .Em S/MIME
4817: format message.
4818: .Ar PEM
4819: and
4820: .Ar DER
4821: format change this to write PEM and DER format PKCS#7 structures
4822: instead.
4823: This currently only affects the output format of the PKCS#7
4824: structure; if no PKCS#7 structure is being output (for example with
4825: .Fl verify
4826: or
4827: .Fl decrypt )
4828: this option has no effect.
4829: .It Fl passin Ar arg
4830: The key password source.
4831: .It Fl recip Ar file
4832: The recipients certificate when decrypting a message.
4833: This certificate
4834: must match one of the recipients of the message or an error occurs.
4835: .It Fl signer Ar file
4836: A signing certificate when signing or resigning a message;
4837: this option can be used multiple times if more than one signer is required.
4838: If a message is being verified, the signer's certificates will be
4839: written to this file if the verification was successful.
4840: .It Fl stream
4841: The same as
4842: .Fl indef .
4843: .It Fl text
4844: This option adds plain text
4845: .Pq text/plain
4846: .Em MIME
4847: headers to the supplied message if encrypting or signing.
4848: If decrypting or verifying, it strips off text headers:
4849: if the decrypted or verified message is not of
4850: .Em MIME
4851: type text/plain then an error occurs.
4852: .El
4853: .Sh SMIME NOTES
4854: The
4855: .Em MIME
4856: message must be sent without any blank lines between the
4857: headers and the output.
4858: Some mail programs will automatically add a blank line.
1.3 jmc 4859: Piping the mail directly to an MTA is one way to
1.1 jsing 4860: achieve the correct format.
4861: .Pp
4862: The supplied message to be signed or encrypted must include the
4863: necessary
4864: .Em MIME
4865: headers or many
4866: .Em S/MIME
4867: clients won't display it properly
4868: .Pq if at all .
4869: You can use the
4870: .Fl text
4871: option to automatically add plain text headers.
4872: .Pp
4873: A
4874: .Qq signed and encrypted
4875: message is one where a signed message is then encrypted.
4876: This can be produced by encrypting an already signed message:
4877: see the
4878: .Sx SMIME EXAMPLES
4879: section.
4880: .Pp
4881: This version of the program only allows one signer per message, but it
4882: will verify multiple signers on received messages.
4883: Some
4884: .Em S/MIME
4885: clients choke if a message contains multiple signers.
4886: It is possible to sign messages
4887: .Qq in parallel
4888: by signing an already signed message.
4889: .Pp
4890: The options
4891: .Fl encrypt
4892: and
4893: .Fl decrypt
4894: reflect common usage in
4895: .Em S/MIME
4896: clients.
4897: Strictly speaking these process PKCS#7 enveloped data: PKCS#7
4898: encrypted data is used for other purposes.
4899: .Pp
4900: The
4901: .Fl resign
4902: option uses an existing message digest when adding a new signer.
4903: This means that attributes must be present in at least one existing
4904: signer using the same message digest or this operation will fail.
4905: .Pp
4906: The
4907: .Fl stream
4908: and
4909: .Fl indef
4910: options enable experimental streaming I/O support.
4911: As a result the encoding is BER using indefinite length constructed encoding
4912: and no longer DER.
4913: Streaming is supported for the
4914: .Fl encrypt
4915: and
4916: .Fl sign
4917: operations if the content is not detached.
4918: .Pp
4919: Streaming is always used for the
4920: .Fl sign
4921: operation with detached data
4922: but since the content is no longer part of the PKCS#7 structure
4923: the encoding remains DER.
4924: .Sh SMIME EXIT CODES
4925: .Bl -tag -width "XXXX"
4926: .It Ar 0
4927: The operation was completely successful.
4928: .It Ar 1
4929: An error occurred parsing the command options.
4930: .It Ar 2
4931: One of the input files could not be read.
4932: .It Ar 3
4933: An error occurred creating the PKCS#7 file or when reading the
4934: .Em MIME
4935: message.
4936: .It Ar 4
4937: An error occurred decrypting or verifying the message.
4938: .It Ar 5
4939: The message was verified correctly, but an error occurred writing out
4940: the signer's certificates.
4941: .El
4942: .Sh SMIME EXAMPLES
4943: Create a cleartext signed message:
4944: .Bd -literal -offset indent
4945: $ openssl smime -sign -in message.txt -text -out mail.msg \e
4946: -signer mycert.pem
4947: .Ed
4948: .Pp
4949: Create an opaque signed message:
4950: .Bd -literal -offset indent
4951: $ openssl smime -sign -in message.txt -text -out mail.msg \e
4952: -nodetach -signer mycert.pem
4953: .Ed
4954: .Pp
4955: Create a signed message, include some additional certificates and
4956: read the private key from another file:
4957: .Bd -literal -offset indent
4958: $ openssl smime -sign -in in.txt -text -out mail.msg \e
4959: -signer mycert.pem -inkey mykey.pem -certfile mycerts.pem
4960: .Ed
4961: .Pp
4962: Create a signed message with two signers:
4963: .Bd -literal -offset indent
4964: openssl smime -sign -in message.txt -text -out mail.msg \e
4965: -signer mycert.pem -signer othercert.pem
4966: .Ed
4967: .Pp
4968: Send a signed message under
4969: .Ux
4970: directly to
4971: .Xr sendmail 8 ,
4972: including headers:
4973: .Bd -literal -offset indent
4974: $ openssl smime -sign -in in.txt -text -signer mycert.pem \e
4975: -from steve@openssl.org -to someone@somewhere \e
4976: -subject "Signed message" | sendmail someone@somewhere
4977: .Ed
4978: .Pp
4979: Verify a message and extract the signer's certificate if successful:
4980: .Bd -literal -offset indent
4981: $ openssl smime -verify -in mail.msg -signer user.pem \e
4982: -out signedtext.txt
4983: .Ed
4984: .Pp
4985: Send encrypted mail using triple DES:
4986: .Bd -literal -offset indent
4987: $ openssl smime -encrypt -in in.txt -from steve@openssl.org \e
4988: -to someone@somewhere -subject "Encrypted message" \e
4989: -des3 -out mail.msg user.pem
4990: .Ed
4991: .Pp
4992: Sign and encrypt mail:
4993: .Bd -literal -offset indent
4994: $ openssl smime -sign -in ml.txt -signer my.pem -text | \e
4995: openssl smime -encrypt -out mail.msg \e
4996: -from steve@openssl.org -to someone@somewhere \e
4997: -subject "Signed and Encrypted message" -des3 user.pem
4998: .Ed
4999: .Pp
5000: .Sy Note :
5001: The encryption command does not include the
5002: .Fl text
5003: option because the message being encrypted already has
5004: .Em MIME
5005: headers.
5006: .Pp
5007: Decrypt mail:
5008: .Bd -literal -offset indent
5009: $ openssl smime -decrypt -in mail.msg -recip mycert.pem \e
5010: -inkey key.pem"
5011: .Ed
5012: .Pp
5013: The output from Netscape form signing is a PKCS#7 structure with the
5014: detached signature format.
5015: You can use this program to verify the signature by line wrapping the
5016: base64-encoded structure and surrounding it with:
5017: .Bd -unfilled -offset indent
5018: -----BEGIN PKCS7-----
5019: -----END PKCS7-----
5020: .Ed
5021: .Pp
5022: and using the command:
5023: .Bd -literal -offset indent
5024: $ openssl smime -verify -inform PEM -in signature.pem \e
5025: -content content.txt
5026: .Ed
5027: .Pp
5028: Alternatively, you can base64 decode the signature and use:
5029: .Bd -literal -offset indent
5030: $ openssl smime -verify -inform DER -in signature.der \e
5031: -content content.txt
5032: .Ed
5033: .Pp
5034: Create an encrypted message using 128-bit AES:
5035: .Bd -literal -offset indent
5036: openssl smime -encrypt -in plain.txt -aes128 \e
5037: -out mail.msg cert.pem
5038: .Ed
5039: .Pp
5040: Add a signer to an existing message:
5041: .Bd -literal -offset indent
5042: openssl smime -resign -in mail.msg -signer newsign.pem \e
5043: -out mail2.msg
5044: .Ed
5045: .Sh SMIME BUGS
5046: The
5047: .Em MIME
5048: parser isn't very clever: it seems to handle most messages that I've thrown
5049: at it, but it may choke on others.
5050: .Pp
5051: The code currently will only write out the signer's certificate to a file:
5052: if the signer has a separate encryption certificate this must be manually
5053: extracted.
5054: There should be some heuristic that determines the correct encryption
5055: certificate.
5056: .Pp
5057: Ideally, a database should be maintained of a certificate for each email
5058: address.
5059: .Pp
5060: The code doesn't currently take note of the permitted symmetric encryption
5061: algorithms as supplied in the
5062: .Em SMIMECapabilities
5063: signed attribute.
5064: This means the user has to manually include the correct encryption algorithm.
5065: It should store the list of permitted ciphers in a database and only use those.
5066: .Pp
5067: No revocation checking is done on the signer's certificate.
5068: .Pp
5069: The current code can only handle
5070: .Em S/MIME
5071: v2 messages; the more complex
5072: .Em S/MIME
5073: v3 structures may cause parsing errors.
5074: .Sh SMIME HISTORY
5075: The use of multiple
5076: .Fl signer
5077: options and the
5078: .Fl resign
5079: command were first added in
5080: .Nm OpenSSL
5081: 1.0.0.
5082: .\"
5083: .\" SPEED
5084: .\"
5085: .Sh SPEED
5086: .nr nS 1
5087: .Nm "openssl speed"
5088: .Bk -words
5089: .Op Cm aes
5090: .Op Cm aes-128-cbc
5091: .Op Cm aes-192-cbc
5092: .Op Cm aes-256-cbc
1.25 bcook 5093: .Op Cm aes-128-gcm
5094: .Op Cm aes-256-gcm
1.1 jsing 5095: .Op Cm blowfish
5096: .Op Cm bf-cbc
5097: .Op Cm cast
5098: .Op Cm cast-cbc
1.25 bcook 5099: .Op Cm chacha20-poly1305
1.1 jsing 5100: .Op Cm des
5101: .Op Cm des-cbc
5102: .Op Cm des-ede3
5103: .Op Cm dsa
5104: .Op Cm dsa512
5105: .Op Cm dsa1024
5106: .Op Cm dsa2048
5107: .Op Cm hmac
1.28 doug 5108: .Op Cm md4
1.1 jsing 5109: .Op Cm md5
5110: .Op Cm rc2
5111: .Op Cm rc2-cbc
5112: .Op Cm rc4
5113: .Op Cm rmd160
5114: .Op Cm rsa
5115: .Op Cm rsa512
5116: .Op Cm rsa1024
5117: .Op Cm rsa2048
5118: .Op Cm rsa4096
5119: .Op Cm sha1
5120: .Op Fl decrypt
5121: .Op Fl elapsed
5122: .Op Fl evp Ar e
5123: .Op Fl mr
5124: .Op Fl multi Ar number
5125: .Ek
5126: .nr nS 0
5127: .Pp
5128: The
5129: .Nm speed
5130: command is used to test the performance of cryptographic algorithms.
5131: .Bl -tag -width "XXXX"
5132: .It Bq Cm zero or more test algorithms
5133: If any options are given,
5134: .Nm speed
5135: tests those algorithms, otherwise all of the above are tested.
5136: .It Fl decrypt
5137: Time decryption instead of encryption
5138: .Pq only EVP .
5139: .It Fl elapsed
5140: Measure time in real time instead of CPU user time.
5141: .It Fl evp Ar e
5142: Use EVP
5143: .Ar e .
5144: .It Fl mr
5145: Produce machine readable output.
5146: .It Fl multi Ar number
5147: Run
5148: .Ar number
5149: benchmarks in parallel.
5150: .El
5151: .\"
5152: .\" TS
5153: .\"
5154: .Sh TS
5155: .nr nS 1
5156: .Nm "openssl ts"
5157: .Bk -words
5158: .Fl query
1.29 bcook 5159: .Op Fl md4 | md5 | ripemd160 | sha1
1.1 jsing 5160: .Op Fl cert
5161: .Op Fl config Ar configfile
5162: .Op Fl data Ar file_to_hash
5163: .Op Fl digest Ar digest_bytes
5164: .Op Fl in Ar request.tsq
5165: .Op Fl no_nonce
5166: .Op Fl out Ar request.tsq
5167: .Op Fl policy Ar object_id
5168: .Op Fl text
5169: .Ek
5170: .nr nS 0
5171: .Pp
5172: .nr nS 1
5173: .Nm "openssl ts"
5174: .Bk -words
5175: .Fl reply
5176: .Op Fl chain Ar certs_file.pem
5177: .Op Fl config Ar configfile
5178: .Op Fl in Ar response.tsr
5179: .Op Fl inkey Ar private.pem
5180: .Op Fl out Ar response.tsr
5181: .Op Fl passin Ar arg
5182: .Op Fl policy Ar object_id
5183: .Op Fl queryfile Ar request.tsq
5184: .Op Fl section Ar tsa_section
5185: .Op Fl signer Ar tsa_cert.pem
5186: .Op Fl text
5187: .Op Fl token_in
5188: .Op Fl token_out
5189: .Ek
5190: .nr nS 0
5191: .Pp
5192: .nr nS 1
5193: .Nm "openssl ts"
5194: .Bk -words
5195: .Fl verify
5196: .Op Fl CAfile Ar trusted_certs.pem
5197: .Op Fl CApath Ar trusted_cert_path
5198: .Op Fl data Ar file_to_hash
5199: .Op Fl digest Ar digest_bytes
5200: .Op Fl in Ar response.tsr
5201: .Op Fl queryfile Ar request.tsq
5202: .Op Fl token_in
5203: .Op Fl untrusted Ar cert_file.pem
5204: .Ek
5205: .nr nS 0
5206: .Pp
5207: The
5208: .Nm ts
5209: command is a basic Time Stamping Authority (TSA) client and server
5210: application as specified in RFC 3161 (Time-Stamp Protocol, TSP).
5211: A TSA can be part of a PKI deployment and its role is to provide long
5212: term proof of the existence of a certain datum before a particular time.
5213: Here is a brief description of the protocol:
5214: .Bl -enum
5215: .It
5216: The TSA client computes a one-way hash value for a data file and sends
5217: the hash to the TSA.
5218: .It
5219: The TSA attaches the current date and time to the received hash value,
5220: signs them and sends the time stamp token back to the client.
5221: By creating this token the TSA certifies the existence of the original
5222: data file at the time of response generation.
5223: .It
5224: The TSA client receives the time stamp token and verifies the
5225: signature on it.
5226: It also checks if the token contains the same hash
5227: value that it had sent to the TSA.
5228: .El
5229: .Pp
5230: There is one DER-encoded protocol data unit defined for transporting a time
5231: stamp request to the TSA and one for sending the time stamp response
5232: back to the client.
5233: The
5234: .Nm ts
5235: command has three main functions:
5236: creating a time stamp request based on a data file;
5237: creating a time stamp response based on a request;
5238: and verifying if a response corresponds
5239: to a particular request or a data file.
5240: .Pp
5241: There is no support for sending the requests/responses automatically
5242: over HTTP or TCP yet as suggested in RFC 3161.
5243: Users must send the requests either by FTP or email.
5244: .Pp
5245: The
5246: .Fl query
5247: switch can be used for creating and printing a time stamp
5248: request with the following options:
5249: .Bl -tag -width Ds
5250: .It Fl cert
5251: The TSA is expected to include its signing certificate in the
5252: response.
5253: .It Fl config Ar configfile
5254: The configuration file to use.
5255: This option overrides the
5256: .Ev OPENSSL_CONF
5257: environment variable.
5258: Only the OID section of the config file is used with the
5259: .Fl query
5260: command.
5261: .It Fl data Ar file_to_hash
5262: The data file for which the time stamp request needs to be created.
5263: stdin is the default if neither the
5264: .Fl data
5265: nor the
5266: .Fl digest
5267: option is specified.
5268: .It Fl digest Ar digest_bytes
5269: It is possible to specify the message imprint explicitly without the data
5270: file.
5271: The imprint must be specified in a hexadecimal format,
5272: two characters per byte,
5273: the bytes optionally separated by colons (e.g. 1A:F6:01:... or 1AF601...).
5274: The number of bytes must match the message digest algorithm in use.
5275: .It Fl in Ar request.tsq
5276: This option specifies a previously created time stamp request in DER
5277: format that will be printed into the output file.
5278: Useful when you need to examine the content of a request in human-readable
5279: format.
1.28 doug 5280: .It Fl md4|md5|ripemd160|sha|sha1
1.1 jsing 5281: The message digest to apply to the data file.
5282: It supports all the message digest algorithms that are supported by the
5283: .Nm dgst
5284: command.
5285: The default is SHA-1.
5286: .It Fl no_nonce
5287: No nonce is specified in the request if this option is given.
5288: Otherwise a 64-bit long pseudo-random none is
5289: included in the request.
5290: It is recommended to use nonce to protect against replay-attacks.
5291: .It Fl out Ar request.tsq
5292: Name of the output file to which the request will be written.
5293: The default is stdout.
5294: .It Fl policy Ar object_id
5295: The policy that the client expects the TSA to use for creating the
5296: time stamp token.
5297: Either the dotted OID notation or OID names defined
5298: in the config file can be used.
5299: If no policy is requested the TSA will
5300: use its own default policy.
5301: .It Fl text
5302: If this option is specified the output is in human-readable text format
5303: instead of DER.
5304: .El
5305: .Pp
5306: A time stamp response (TimeStampResp) consists of a response status
5307: and the time stamp token itself (ContentInfo),
5308: if the token generation was successful.
5309: The
5310: .Fl reply
5311: command is for creating a time stamp
5312: response or time stamp token based on a request and printing the
5313: response/token in human-readable format.
5314: If
5315: .Fl token_out
5316: is not specified the output is always a time stamp response (TimeStampResp),
5317: otherwise it is a time stamp token (ContentInfo).
5318: .Bl -tag -width Ds
5319: .It Fl chain Ar certs_file.pem
5320: The collection of certificates, in PEM format,
5321: that will be included in the response
5322: in addition to the signer certificate if the
5323: .Fl cert
5324: option was used for the request.
5325: This file is supposed to contain the certificate chain
5326: for the signer certificate from its issuer upwards.
5327: The
5328: .Fl reply
5329: command does not build a certificate chain automatically.
5330: .It Fl config Ar configfile
5331: The configuration file to use.
5332: This option overrides the
5333: .Ev OPENSSL_CONF
5334: environment variable.
5335: See
5336: .Sx TS CONFIGURATION FILE OPTIONS
5337: for configurable variables.
5338: .It Fl in Ar response.tsr
5339: Specifies a previously created time stamp response or time stamp token, if
5340: .Fl token_in
5341: is also specified,
5342: in DER format that will be written to the output file.
5343: This option does not require a request;
5344: it is useful, for example,
5345: when you need to examine the content of a response or token
5346: or you want to extract the time stamp token from a response.
5347: If the input is a token and the output is a time stamp response a default
5348: .Dq granted
5349: status info is added to the token.
5350: .It Fl inkey Ar private.pem
5351: The signer private key of the TSA in PEM format.
5352: Overrides the
5353: .Cm signer_key
5354: config file option.
5355: .It Fl out Ar response.tsr
5356: The response is written to this file.
5357: The format and content of the file depends on other options (see
5358: .Fl text
5359: and
5360: .Fl token_out ) .
5361: The default is stdout.
5362: .It Fl passin Ar arg
5363: The key password source.
5364: .It Fl policy Ar object_id
5365: The default policy to use for the response unless the client
5366: explicitly requires a particular TSA policy.
5367: The OID can be specified either in dotted notation or with its name.
5368: Overrides the
5369: .Cm default_policy
5370: config file option.
5371: .It Fl queryfile Ar request.tsq
5372: The name of the file containing a DER-encoded time stamp request.
5373: .It Fl section Ar tsa_section
5374: The name of the config file section containing the settings for the
5375: response generation.
5376: If not specified the default TSA section is used; see
5377: .Sx TS CONFIGURATION FILE OPTIONS
5378: for details.
5379: .It Fl signer Ar tsa_cert.pem
5380: The signer certificate of the TSA in PEM format.
5381: The TSA signing certificate must have exactly one extended key usage
5382: assigned to it: timeStamping.
5383: The extended key usage must also be critical,
5384: otherwise the certificate is going to be refused.
5385: Overrides the
5386: .Cm signer_cert
5387: variable of the config file.
5388: .It Fl text
5389: If this option is specified the output is human-readable text format
5390: instead of DER.
5391: .It Fl token_in
5392: This flag can be used together with the
5393: .Fl in
5394: option and indicates that the input is a DER-encoded time stamp token
5395: (ContentInfo) instead of a time stamp response (TimeStampResp).
5396: .It Fl token_out
5397: The output is a time stamp token (ContentInfo) instead of time stamp
5398: response (TimeStampResp).
5399: .El
5400: .Pp
5401: The
5402: .Fl verify
5403: command is for verifying if a time stamp response or time stamp token
5404: is valid and matches a particular time stamp request or data file.
5405: The
5406: .Fl verify
5407: command does not use the configuration file.
5408: .Bl -tag -width Ds
5409: .It Fl CAfile Ar trusted_certs.pem
5410: The name of the file containing a set of trusted self-signed CA
5411: certificates in PEM format.
5412: See the similar option of
5413: .Nm verify
5414: for additional details.
5415: Either this option or
5416: .Fl CApath
5417: must be specified.
5418: .It Fl CApath Ar trusted_cert_path
5419: The name of the directory containing the trused CA certificates of the
5420: client.
5421: See the similar option of
5422: .Nm verify
5423: for additional details.
5424: Either this option or
5425: .Fl CAfile
5426: must be specified.
5427: .It Fl data Ar file_to_hash
5428: The response or token must be verified against
5429: .Ar file_to_hash .
5430: The file is hashed with the message digest algorithm specified in the token.
5431: The
5432: .Fl digest
5433: and
5434: .Fl queryfile
5435: options must not be specified with this one.
5436: .It Fl digest Ar digest_bytes
5437: The response or token must be verified against the message digest specified
5438: with this option.
5439: The number of bytes must match the message digest algorithm
5440: specified in the token.
5441: The
5442: .Fl data
5443: and
5444: .Fl queryfile
5445: options must not be specified with this one.
5446: .It Fl in Ar response.tsr
5447: The time stamp response that needs to be verified, in DER format.
5448: This option in mandatory.
5449: .It Fl queryfile Ar request.tsq
5450: The original time stamp request, in DER format.
5451: The
5452: .Fl data
5453: and
5454: .Fl digest
5455: options must not be specified with this one.
5456: .It Fl token_in
5457: This flag can be used together with the
5458: .Fl in
5459: option and indicates that the input is a DER-encoded time stamp token
5460: (ContentInfo) instead of a time stamp response (TimeStampResp).
5461: .It Fl untrusted Ar cert_file.pem
5462: Set of additional untrusted certificates in PEM format which may be
5463: needed when building the certificate chain for the TSA's signing
5464: certificate.
5465: This file must contain the TSA signing certificate and
5466: all intermediate CA certificates unless the response includes them.
5467: .El
5468: .Sh TS CONFIGURATION FILE OPTIONS
5469: The
5470: .Fl query
5471: and
5472: .Fl reply
5473: options make use of a configuration file defined by the
5474: .Ev OPENSSL_CONF
5475: environment variable.
5476: The
5477: .Fl query
5478: option uses only the symbolic OID names section
5479: and it can work without it.
5480: However, the
5481: .Fl reply
5482: option needs the config file for its operation.
5483: .Pp
5484: When there is a command line switch equivalent of a variable the
5485: switch always overrides the settings in the config file.
5486: .Bl -tag -width Ds
5487: .It Cm tsa Ar section , Cm default_tsa
5488: This is the main section and it specifies the name of another section
5489: that contains all the options for the
5490: .Fl reply
5491: option.
5492: This default section can be overridden with the
5493: .Fl section
5494: command line switch.
5495: .It Cm oid_file
5496: See
5497: .Nm ca
5498: for a description.
5499: .It Cm oid_section
5500: See
5501: .Nm ca
5502: for a description.
5503: .It Cm serial
5504: The name of the file containing the hexadecimal serial number of the
5505: last time stamp response created.
5506: This number is incremented by 1 for each response.
5507: If the file does not exist at the time of response
5508: generation a new file is created with serial number 1.
5509: This parameter is mandatory.
5510: .It Cm signer_cert
5511: TSA signing certificate, in PEM format.
5512: The same as the
5513: .Fl signer
5514: command line option.
5515: .It Cm certs
5516: A file containing a set of PEM-encoded certificates that need to be
5517: included in the response.
5518: The same as the
5519: .Fl chain
5520: command line option.
5521: .It Cm signer_key
5522: The private key of the TSA, in PEM format.
5523: The same as the
5524: .Fl inkey
5525: command line option.
5526: .It Cm default_policy
5527: The default policy to use when the request does not mandate any policy.
5528: The same as the
5529: .Fl policy
5530: command line option.
5531: .It Cm other_policies
5532: Comma separated list of policies that are also acceptable by the TSA
5533: and used only if the request explicitly specifies one of them.
5534: .It Cm digests
5535: The list of message digest algorithms that the TSA accepts.
5536: At least one algorithm must be specified.
5537: This parameter is mandatory.
5538: .It Cm accuracy
5539: The accuracy of the time source of the TSA in seconds, milliseconds
5540: and microseconds.
5541: For example, secs:1, millisecs:500, microsecs:100.
5542: If any of the components is missing,
5543: zero is assumed for that field.
5544: .It Cm clock_precision_digits
5545: Specifies the maximum number of digits, which represent the fraction of
5546: seconds, that need to be included in the time field.
5547: The trailing zeroes must be removed from the time,
5548: so there might actually be fewer digits,
5549: or no fraction of seconds at all.
5550: The maximum value is 6;
5551: the default is 0.
5552: .It Cm ordering
5553: If this option is yes,
5554: the responses generated by this TSA can always be ordered,
5555: even if the time difference between two responses is less
5556: than the sum of their accuracies.
5557: The default is no.
5558: .It Cm tsa_name
5559: Set this option to yes if the subject name of the TSA must be included in
5560: the TSA name field of the response.
5561: The default is no.
5562: .It Cm ess_cert_id_chain
5563: The SignedData objects created by the TSA always contain the
5564: certificate identifier of the signing certificate in a signed
5565: attribute (see RFC 2634, Enhanced Security Services).
5566: If this option is set to yes and either the
5567: .Cm certs
5568: variable or the
5569: .Fl chain
5570: option is specified then the certificate identifiers of the chain will also
5571: be included in the SigningCertificate signed attribute.
5572: If this variable is set to no,
5573: only the signing certificate identifier is included.
5574: The default is no.
5575: .El
5576: .Sh TS ENVIRONMENT VARIABLES
5577: .Ev OPENSSL_CONF
5578: contains the path of the configuration file and can be
5579: overridden by the
5580: .Fl config
5581: command line option.
5582: .Sh TS EXAMPLES
5583: All the examples below presume that
5584: .Ev OPENSSL_CONF
5585: is set to a proper configuration file,
5586: e.g. the example configuration file
5587: .Pa openssl/apps/openssl.cnf
5588: will do.
5589: .Pp
5590: To create a time stamp request for design1.txt with SHA-1
5591: without nonce and policy and no certificate is required in the response:
5592: .Bd -literal -offset indent
5593: $ openssl ts -query -data design1.txt -no_nonce \e
5594: -out design1.tsq
5595: .Ed
5596: .Pp
5597: To create a similar time stamp request but specifying the message imprint
5598: explicitly:
5599: .Bd -literal -offset indent
5600: $ openssl ts -query \e
5601: -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \e
5602: -no_nonce -out design1.tsq
5603: .Ed
5604: .Pp
5605: To print the content of the previous request in human readable format:
5606: .Bd -literal -offset indent
5607: $ openssl ts -query -in design1.tsq -text
5608: .Ed
5609: .Pp
5610: To create a time stamp request which includes the MD5 digest
5611: of design2.txt, requests the signer certificate and nonce,
5612: specifies a policy ID
5613: (assuming the tsa_policy1 name is defined in the
5614: OID section of the config file):
5615: .Bd -literal -offset indent
5616: $ openssl ts -query -data design2.txt -md5 \e
5617: -policy tsa_policy1 -cert -out design2.tsq
5618: .Ed
5619: .Pp
5620: Before generating a response,
5621: a signing certificate must be created for the TSA that contains the
5622: .Cm timeStamping
5623: critical extended key usage extension
5624: without any other key usage extensions.
5625: You can add the
5626: .Dq extendedKeyUsage = critical,timeStamping
5627: line to the user certificate section
5628: of the config file to generate a proper certificate.
5629: See the
5630: .Nm req ,
5631: .Nm ca ,
5632: and
5633: .Nm x509
5634: commands for instructions.
5635: The examples below assume that cacert.pem contains the certificate of the CA,
5636: tsacert.pem is the signing certificate issued by cacert.pem and
5637: tsakey.pem is the private key of the TSA.
5638: .Pp
5639: To create a time stamp response for a request:
5640: .Bd -literal -offset indent
5641: $ openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \e
5642: -signer tsacert.pem -out design1.tsr
5643: .Ed
5644: .Pp
5645: If you want to use the settings in the config file you could just write:
5646: .Bd -literal -offset indent
5647: $ openssl ts -reply -queryfile design1.tsq -out design1.tsr
5648: .Ed
5649: .Pp
5650: To print a time stamp reply to stdout in human readable format:
5651: .Bd -literal -offset indent
5652: $ openssl ts -reply -in design1.tsr -text
5653: .Ed
5654: .Pp
5655: To create a time stamp token instead of time stamp response:
5656: .Bd -literal -offset indent
5657: $ openssl ts -reply -queryfile design1.tsq \e
5658: -out design1_token.der -token_out
5659: .Ed
5660: .Pp
5661: To print a time stamp token to stdout in human readable format:
5662: .Bd -literal -offset indent
5663: $ openssl ts -reply -in design1_token.der -token_in \e
5664: -text -token_out
5665: .Ed
5666: .Pp
5667: To extract the time stamp token from a response:
5668: .Bd -literal -offset indent
5669: $ openssl ts -reply -in design1.tsr -out design1_token.der \e
5670: -token_out
5671: .Ed
5672: .Pp
5673: To add
5674: .Dq granted
5675: status info to a time stamp token thereby creating a valid response:
5676: .Bd -literal -offset indent
5677: $ openssl ts -reply -in design1_token.der \e
5678: -token_in -out design1.tsr
5679: .Ed
5680: .Pp
5681: To verify a time stamp reply against a request:
5682: .Bd -literal -offset indent
5683: $ openssl ts -verify -queryfile design1.tsq -in design1.tsr \e
5684: -CAfile cacert.pem -untrusted tsacert.pem
5685: .Ed
5686: .Pp
5687: To verify a time stamp reply that includes the certificate chain:
5688: .Bd -literal -offset indent
5689: $ openssl ts -verify -queryfile design2.tsq -in design2.tsr \e
5690: -CAfile cacert.pem
5691: .Ed
5692: .Pp
5693: To verify a time stamp token against the original data file:
5694: .Bd -literal -offset indent
5695: $ openssl ts -verify -data design2.txt -in design2.tsr \e
5696: -CAfile cacert.pem
5697: .Ed
5698: .Pp
5699: To verify a time stamp token against a message imprint:
5700: .Bd -literal -offset indent
5701: $ openssl ts -verify \e
5702: -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \e
5703: -in design2.tsr -CAfile cacert.pem
5704: .Ed
5705: .Sh TS BUGS
5706: No support for time stamps over SMTP, though it is quite easy
5707: to implement an automatic email-based TSA with
5708: .Xr procmail
5709: and
5710: .Xr perl 1 .
5711: Pure TCP/IP is not supported.
5712: .Pp
5713: The file containing the last serial number of the TSA is not
5714: locked when being read or written.
5715: This is a problem if more than one instance of
5716: .Nm OpenSSL
5717: is trying to create a time stamp
5718: response at the same time.
5719: .Pp
5720: Look for the FIXME word in the source files.
5721: .Pp
5722: The source code should really be reviewed by somebody else, too.
5723: .Pp
5724: More testing is needed.
5725: .Sh TS AUTHORS
5726: .An Zoltan Glozik Aq Mt zglozik@opentsa.org ,
5727: OpenTSA project
5728: .Pq Lk http://www.opentsa.org .
5729: .\"
5730: .\" SPKAC
5731: .\"
5732: .Sh SPKAC
5733: .nr nS 1
5734: .Nm "openssl spkac"
5735: .Bk -words
5736: .Op Fl challenge Ar string
5737: .Op Fl in Ar file
5738: .Op Fl key Ar keyfile
5739: .Op Fl noout
5740: .Op Fl out Ar file
5741: .Op Fl passin Ar arg
5742: .Op Fl pubkey
5743: .Op Fl spkac Ar spkacname
5744: .Op Fl spksect Ar section
5745: .Op Fl verify
5746: .Ek
5747: .nr nS 0
5748: .Pp
5749: The
5750: .Nm spkac
5751: command processes Netscape signed public key and challenge
5752: .Pq SPKAC
5753: files.
5754: It can print out their contents, verify the signature,
5755: and produce its own SPKACs from a supplied private key.
5756: .Pp
5757: The options are as follows:
5758: .Bl -tag -width Ds
5759: .It Fl challenge Ar string
5760: Specifies the challenge string if an SPKAC is being created.
5761: .It Fl in Ar file
5762: This specifies the input
5763: .Ar file
5764: to read from, or standard input if this option is not specified.
5765: Ignored if the
5766: .Fl key
5767: option is used.
5768: .It Fl key Ar keyfile
5769: Create an SPKAC file using the private key in
5770: .Ar keyfile .
5771: The
5772: .Fl in , noout , spksect ,
5773: and
5774: .Fl verify
5775: options are ignored if present.
5776: .It Fl noout
5777: Don't output the text version of the SPKAC
5778: .Pq not used if an SPKAC is being created .
5779: .It Fl out Ar file
5780: Specifies the output
5781: .Ar file
5782: to write to, or standard output by default.
5783: .It Fl passin Ar arg
5784: The key password source.
5785: .It Fl pubkey
5786: Output the public key of an SPKAC
5787: .Pq not used if an SPKAC is being created .
5788: .It Fl spkac Ar spkacname
5789: Allows an alternative name for the variable containing the SPKAC.
5790: The default is "SPKAC".
5791: This option affects both generated and input SPKAC files.
5792: .It Fl spksect Ar section
5793: Allows an alternative name for the
5794: .Ar section
5795: containing the SPKAC.
5796: The default is the default section.
5797: .It Fl verify
5798: Verifies the digital signature on the supplied SPKAC.
5799: .El
5800: .Sh SPKAC EXAMPLES
5801: Print out the contents of an SPKAC:
5802: .Pp
5803: .Dl $ openssl spkac -in spkac.cnf
5804: .Pp
5805: Verify the signature of an SPKAC:
5806: .Pp
5807: .Dl $ openssl spkac -in spkac.cnf -noout -verify
5808: .Pp
5809: Create an SPKAC using the challenge string
5810: .Qq hello :
5811: .Pp
5812: .Dl $ openssl spkac -key key.pem -challenge hello -out spkac.cnf
5813: .Pp
5814: Example of an SPKAC,
5815: .Pq long lines split up for clarity :
5816: .Bd -unfilled -offset indent
5817: SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA1cCoq2Wa3Ixs47uI7F\e
5818: PVwHVIPDx5yso105Y6zpozam135a8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03u\e
5819: PFoQIDAQABFgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJh1bEIYuc\e
5820: 2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnDdq+NQ3F+X4deMx9AaEglZtULwV\e
5821: 4=
5822: .Ed
5823: .Sh SPKAC NOTES
5824: A created SPKAC with suitable DN components appended can be fed into
5825: the
5826: .Nm ca
5827: utility.
5828: .Pp
5829: SPKACs are typically generated by Netscape when a form is submitted
5830: containing the
5831: .Em KEYGEN
5832: tag as part of the certificate enrollment process.
5833: .Pp
5834: The challenge string permits a primitive form of proof of possession
5835: of private key.
5836: By checking the SPKAC signature and a random challenge
5837: string, some guarantee is given that the user knows the private key
5838: corresponding to the public key being certified.
5839: This is important in some applications.
5840: Without this it is possible for a previous SPKAC
5841: to be used in a
5842: .Qq replay attack .
5843: .\"
5844: .\" VERIFY
5845: .\"
5846: .Sh VERIFY
5847: .nr nS 1
5848: .Nm "openssl verify"
5849: .Bk -words
5850: .Op Fl CAfile Ar file
5851: .Op Fl CApath Ar directory
5852: .Op Fl check_ss_sig
5853: .Op Fl crl_check
5854: .Op Fl crl_check_all
5855: .Op Fl explicit_policy
5856: .Op Fl extended_crl
5857: .Op Fl help
5858: .Op Fl ignore_critical
5859: .Op Fl inhibit_any
5860: .Op Fl inhibit_map
5861: .Op Fl issuer_checks
5862: .Op Fl policy_check
5863: .Op Fl purpose Ar purpose
5864: .Op Fl untrusted Ar file
5865: .Op Fl verbose
5866: .Op Fl x509_strict
5867: .Op Fl
5868: .Op Ar certificates
5869: .Ek
5870: .nr nS 0
5871: .Pp
5872: The
5873: .Nm verify
5874: command verifies certificate chains.
5875: .Pp
5876: The options are as follows:
5877: .Bl -tag -width Ds
5878: .It Fl check_ss_sig
5879: Verify the signature on the self-signed root CA.
5880: This is disabled by default
5881: because it doesn't add any security.
5882: .It Fl CAfile Ar file
5883: A
5884: .Ar file
5885: of trusted certificates.
5886: The
5887: .Ar file
5888: should contain multiple certificates in PEM format, concatenated together.
5889: .It Fl CApath Ar directory
5890: A
5891: .Ar directory
5892: of trusted certificates.
5893: The certificates should have names of the form
5894: .Em hash.0 ,
5895: or have symbolic links to them of this form
5896: ("hash" is the hashed certificate subject name: see the
5897: .Fl hash
5898: option of the
5899: .Nm x509
5900: utility).
5901: The
5902: .Nm c_rehash
5903: script distributed with OpenSSL
5904: will automatically create symbolic links to a directory of certificates.
5905: .It Fl crl_check
5906: Checks end entity certificate validity by attempting to look up a valid CRL.
5907: If a valid CRL cannot be found an error occurs.
5908: .It Fl crl_check_all
5909: Checks the validity of all certificates in the chain by attempting
5910: to look up valid CRLs.
5911: .It Fl explicit_policy
5912: Set policy variable require-explicit-policy (see RFC 3280 et al).
5913: .It Fl extended_crl
5914: Enable extended CRL features such as indirect CRLs and alternate CRL
5915: signing keys.
5916: .It Fl help
5917: Prints out a usage message.
5918: .It Fl ignore_critical
5919: Normally if an unhandled critical extension is present which is not
5920: supported by
5921: .Nm OpenSSL ,
5922: the certificate is rejected (as required by RFC 3280 et al).
5923: If this option is set, critical extensions are ignored.
5924: .It Fl inhibit_any
5925: Set policy variable inhibit-any-policy (see RFC 3280 et al).
5926: .It Fl inhibit_map
5927: Set policy variable inhibit-policy-mapping (see RFC 3280 et al).
5928: .It Fl issuer_checks
5929: Print out diagnostics relating to searches for the issuer certificate
5930: of the current certificate.
5931: This shows why each candidate issuer certificate was rejected.
5932: However the presence of rejection messages
5933: does not itself imply that anything is wrong: during the normal
5934: verify process several rejections may take place.
5935: .It Fl policy_check
5936: Enables certificate policy processing.
5937: .It Fl purpose Ar purpose
5938: The intended use for the certificate.
5939: Without this option no chain verification will be done.
5940: Currently accepted uses are
5941: .Ar sslclient , sslserver ,
5942: .Ar nssslserver , smimesign ,
5943: .Ar smimeencrypt , crlsign ,
5944: .Ar any ,
5945: and
5946: .Ar ocsphelper .
5947: See the
5948: .Sx VERIFY OPERATION
5949: section for more information.
5950: .It Fl untrusted Ar file
5951: A
5952: .Ar file
5953: of untrusted certificates.
5954: The
5955: .Ar file
5956: should contain multiple certificates.
5957: .It Fl verbose
5958: Print extra information about the operations being performed.
5959: .It Fl x509_strict
5960: Disable workarounds for broken certificates which have to be disabled
5961: for strict X.509 compliance.
5962: .It Fl
5963: Marks the last option.
5964: All arguments following this are assumed to be certificate files.
5965: This is useful if the first certificate filename begins with a
5966: .Sq - .
5967: .It Ar certificates
5968: One or more
5969: .Ar certificates
5970: to verify.
5971: If no certificate files are included, an attempt is made to read
5972: a certificate from standard input.
5973: They should all be in PEM format.
5974: .El
5975: .Sh VERIFY OPERATION
5976: The
5977: .Nm verify
5978: program uses the same functions as the internal SSL and S/MIME verification,
5979: therefore this description applies to these verify operations too.
5980: .Pp
5981: There is one crucial difference between the verify operations performed
5982: by the
5983: .Nm verify
5984: program: wherever possible an attempt is made to continue
5985: after an error, whereas normally the verify operation would halt on the
5986: first error.
5987: This allows all the problems with a certificate chain to be determined.
5988: .Pp
5989: The verify operation consists of a number of separate steps:
5990: .Pp
5991: Firstly a certificate chain is built up starting from the supplied certificate
5992: and ending in the root CA.
5993: It is an error if the whole chain cannot be built up.
5994: The chain is built up by looking up the issuer's certificate of the current
5995: certificate.
5996: If a certificate is found which is its own issuer, it is assumed
5997: to be the root CA.
5998: .Pp
5999: The process of
6000: .Qq looking up the issuer's certificate
6001: itself involves a number of steps.
6002: In versions of
6003: .Nm OpenSSL
6004: before 0.9.5a the first certificate whose subject name matched the issuer
6005: of the current certificate was assumed to be the issuer's certificate.
6006: In
6007: .Nm OpenSSL
6008: 0.9.6 and later all certificates whose subject name matches the issuer name
6009: of the current certificate are subject to further tests.
6010: The relevant authority key identifier components of the current certificate
6011: .Pq if present
6012: must match the subject key identifier
6013: .Pq if present
6014: and issuer and serial number of the candidate issuer; in addition the
6015: .Em keyUsage
6016: extension of the candidate issuer
6017: .Pq if present
6018: must permit certificate signing.
6019: .Pp
6020: The lookup first looks in the list of untrusted certificates and if no match
6021: is found the remaining lookups are from the trusted certificates.
6022: The root CA is always looked up in the trusted certificate list: if the
6023: certificate to verify is a root certificate, then an exact match must be
6024: found in the trusted list.
6025: .Pp
6026: The second operation is to check every untrusted certificate's extensions for
6027: consistency with the supplied purpose.
6028: If the
6029: .Fl purpose
6030: option is not included, then no checks are done.
6031: The supplied or
6032: .Qq leaf
6033: certificate must have extensions compatible with the supplied purpose
6034: and all other certificates must also be valid CA certificates.
6035: The precise extensions required are described in more detail in
6036: the
6037: .Sx X.509 CERTIFICATE EXTENSIONS
6038: section below.
6039: .Pp
6040: The third operation is to check the trust settings on the root CA.
6041: The root CA should be trusted for the supplied purpose.
6042: For compatibility with previous versions of
6043: .Nm SSLeay
6044: and
6045: .Nm OpenSSL ,
6046: a certificate with no trust settings is considered to be valid for
6047: all purposes.
6048: .Pp
6049: The final operation is to check the validity of the certificate chain.
6050: The validity period is checked against the current system time and the
6051: .Em notBefore
6052: and
6053: .Em notAfter
6054: dates in the certificate.
6055: The certificate signatures are also checked at this point.
6056: .Pp
6057: If all operations complete successfully, the certificate is considered
6058: valid.
6059: If any operation fails then the certificate is not valid.
6060: .Sh VERIFY DIAGNOSTICS
6061: When a verify operation fails, the output messages can be somewhat cryptic.
6062: The general form of the error message is:
6063: .Bd -unfilled
6064: \& server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024-bit)
6065: \& error 24 at 1 depth lookup:invalid CA certificate
6066: .Ed
6067: .Pp
6068: The first line contains the name of the certificate being verified, followed by
6069: the subject name of the certificate.
6070: The second line contains the error number and the depth.
6071: The depth is the number of the certificate being verified when a
6072: problem was detected starting with zero for the certificate being verified
6073: itself, then 1 for the CA that signed the certificate and so on.
6074: Finally a text version of the error number is presented.
6075: .Pp
6076: An exhaustive list of the error codes and messages is shown below; this also
6077: includes the name of the error code as defined in the header file
1.12 bentley 6078: .In openssl/x509_vfy.h .
1.1 jsing 6079: Some of the error codes are defined but never returned: these are described
6080: as
6081: .Qq unused .
6082: .Bl -tag -width "XXXX"
6083: .It Ar "0 X509_V_OK: ok"
6084: The operation was successful.
6085: .It Ar 2 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT: unable to get issuer certificate
6086: The issuer certificate could not be found: this occurs if the issuer certificate
6087: of an untrusted certificate cannot be found.
6088: .It Ar 3 X509_V_ERR_UNABLE_TO_GET_CRL: unable to get certificate CRL
6089: The CRL of a certificate could not be found.
6090: .It Ar 4 X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE: unable to decrypt certificate's signature
6091: The certificate signature could not be decrypted.
6092: This means that the actual signature value could not be determined rather
6093: than it not matching the expected value.
6094: This is only meaningful for RSA keys.
6095: .It Ar 5 X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE: unable to decrypt CRL's signature
6096: The CRL signature could not be decrypted: this means that the actual
6097: signature value could not be determined rather than it not matching the
6098: expected value.
6099: Unused.
6100: .It Ar 6 X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY: unable to decode issuer public key
6101: The public key in the certificate
6102: .Em SubjectPublicKeyInfo
6103: could not be read.
6104: .It Ar 7 X509_V_ERR_CERT_SIGNATURE_FAILURE: certificate signature failure
6105: The signature of the certificate is invalid.
6106: .It Ar 8 X509_V_ERR_CRL_SIGNATURE_FAILURE: CRL signature failure
6107: The signature of the certificate is invalid.
6108: .It Ar 9 X509_V_ERR_CERT_NOT_YET_VALID: certificate is not yet valid
6109: The certificate is not yet valid: the
6110: .Em notBefore
6111: date is after the current time.
6112: .It Ar 10 X509_V_ERR_CERT_HAS_EXPIRED: certificate has expired
6113: The certificate has expired; that is, the
6114: .Em notAfter
6115: date is before the current time.
6116: .It Ar 11 X509_V_ERR_CRL_NOT_YET_VALID: CRL is not yet valid
6117: The CRL is not yet valid.
6118: .It Ar 12 X509_V_ERR_CRL_HAS_EXPIRED: CRL has expired
6119: The CRL has expired.
6120: .It Ar 13 X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD: format error in certificate's notBefore field
6121: The certificate
6122: .Em notBefore
6123: field contains an invalid time.
6124: .It Ar 14 X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD: format error in certificate's notAfter field
6125: The certificate
6126: .Em notAfter
6127: field contains an invalid time.
6128: .It Ar 15 X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD: format error in CRL's lastUpdate field
6129: The CRL
6130: .Em lastUpdate
6131: field contains an invalid time.
6132: .It Ar 16 X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD: format error in CRL's nextUpdate field
6133: The CRL
6134: .Em nextUpdate
6135: field contains an invalid time.
6136: .It Ar 17 X509_V_ERR_OUT_OF_MEM: out of memory
6137: An error occurred trying to allocate memory.
6138: This should never happen.
6139: .It Ar 18 X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: self signed certificate
6140: The passed certificate is self-signed and the same certificate cannot be
6141: found in the list of trusted certificates.
6142: .It Ar 19 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: self signed certificate in certificate chain
6143: The certificate chain could be built up using the untrusted certificates but
6144: the root could not be found locally.
6145: .It Ar 20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: unable to get local issuer certificate
6146: The issuer certificate of a locally looked up certificate could not be found.
6147: This normally means the list of trusted certificates is not complete.
6148: .It Ar 21 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE: unable to verify the first certificate
6149: No signatures could be verified because the chain contains only one
6150: certificate and it is not self-signed.
6151: .It Ar 22 X509_V_ERR_CERT_CHAIN_TOO_LONG: certificate chain too long
6152: The certificate chain length is greater than the supplied maximum depth.
6153: Unused.
6154: .It Ar 23 X509_V_ERR_CERT_REVOKED: certificate revoked
6155: The certificate has been revoked.
6156: .It Ar 24 X509_V_ERR_INVALID_CA: invalid CA certificate
6157: A CA certificate is invalid.
6158: Either it is not a CA or its extensions are not consistent
6159: with the supplied purpose.
6160: .It Ar 25 X509_V_ERR_PATH_LENGTH_EXCEEDED: path length constraint exceeded
6161: The
6162: .Em basicConstraints
6163: pathlength parameter has been exceeded.
6164: .It Ar 26 X509_V_ERR_INVALID_PURPOSE: unsupported certificate purpose
6165: The supplied certificate cannot be used for the specified purpose.
6166: .It Ar 27 X509_V_ERR_CERT_UNTRUSTED: certificate not trusted
6167: The root CA is not marked as trusted for the specified purpose.
6168: .It Ar 28 X509_V_ERR_CERT_REJECTED: certificate rejected
6169: The root CA is marked to reject the specified purpose.
6170: .It Ar 29 X509_V_ERR_SUBJECT_ISSUER_MISMATCH: subject issuer mismatch
6171: The current candidate issuer certificate was rejected because its subject name
6172: did not match the issuer name of the current certificate.
6173: Only displayed when the
6174: .Fl issuer_checks
6175: option is set.
6176: .It Ar 30 X509_V_ERR_AKID_SKID_MISMATCH: authority and subject key identifier mismatch
6177: The current candidate issuer certificate was rejected because its subject key
6178: identifier was present and did not match the authority key identifier current
6179: certificate.
6180: Only displayed when the
6181: .Fl issuer_checks
6182: option is set.
6183: .It Ar 31 X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH: authority and issuer serial number mismatch
6184: The current candidate issuer certificate was rejected because its issuer name
6185: and serial number were present and did not match the authority key identifier
6186: of the current certificate.
6187: Only displayed when the
6188: .Fl issuer_checks
6189: option is set.
6190: .It Ar 32 X509_V_ERR_KEYUSAGE_NO_CERTSIGN:key usage does not include certificate signing
6191: The current candidate issuer certificate was rejected because its
6192: .Em keyUsage
6193: extension does not permit certificate signing.
6194: .It Ar 50 X509_V_ERR_APPLICATION_VERIFICATION: application verification failure
6195: An application specific error.
6196: Unused.
6197: .El
6198: .Sh VERIFY BUGS
6199: Although the issuer checks are a considerable improvement over the old
6200: technique, they still suffer from limitations in the underlying
6201: X509_LOOKUP API.
6202: One consequence of this is that trusted certificates with matching subject
6203: name must either appear in a file (as specified by the
6204: .Fl CAfile
6205: option) or a directory (as specified by
6206: .Fl CApath ) .
6207: If they occur in both, only the certificates in the file will
6208: be recognised.
6209: .Pp
6210: Previous versions of
6211: .Nm OpenSSL
6212: assumed certificates with matching subject name were identical and
6213: mishandled them.
6214: .\"
6215: .\" VERSION
6216: .\"
6217: .Sh VERSION
6218: .Nm openssl version
6219: .Op Fl abdfopv
6220: .Pp
6221: The
6222: .Nm version
6223: command is used to print out version information about
6224: .Nm OpenSSL .
6225: .Pp
6226: The options are as follows:
6227: .Bl -tag -width Ds
6228: .It Fl a
6229: All information: this is the same as setting all the other flags.
6230: .It Fl b
6231: The date the current version of
6232: .Nm OpenSSL
6233: was built.
6234: .It Fl d
6235: .Ev OPENSSLDIR
6236: setting.
6237: .It Fl f
6238: Compilation flags.
6239: .It Fl o
6240: Option information: various options set when the library was built.
6241: .It Fl p
6242: Platform setting.
6243: .It Fl v
6244: The current
6245: .Nm OpenSSL
6246: version.
6247: .El
6248: .Sh VERSION NOTES
6249: The output of
6250: .Nm openssl version -a
6251: would typically be used when sending in a bug report.
6252: .Sh VERSION HISTORY
6253: The
6254: .Fl d
6255: option was added in
6256: .Nm OpenSSL
6257: 0.9.7.
6258: .\"
6259: .\" X509
6260: .\"
6261: .Sh X509
6262: .nr nS 1
6263: .Nm "openssl x509"
6264: .Bk -words
6265: .Op Fl C
6266: .Op Fl addreject Ar arg
6267: .Op Fl addtrust Ar arg
6268: .Op Fl alias
6269: .Op Fl CA Ar file
6270: .Op Fl CAcreateserial
6271: .Op Fl CAform Ar DER | PEM
6272: .Op Fl CAkey Ar file
6273: .Op Fl CAkeyform Ar DER | PEM
6274: .Op Fl CAserial Ar file
6275: .Op Fl certopt Ar option
6276: .Op Fl checkend Ar arg
6277: .Op Fl clrext
6278: .Op Fl clrreject
6279: .Op Fl clrtrust
6280: .Op Fl dates
6281: .Op Fl days Ar arg
6282: .Op Fl email
6283: .Op Fl enddate
6284: .Op Fl extensions Ar section
6285: .Op Fl extfile Ar file
6286: .Op Fl fingerprint
6287: .Op Fl hash
6288: .Op Fl in Ar file
6289: .Op Fl inform Ar DER | NET | PEM
6290: .Op Fl issuer
6291: .Op Fl issuer_hash
6292: .Op Fl issuer_hash_old
6293: .Op Fl keyform Ar DER | PEM
1.29 bcook 6294: .Op Fl md5 | sha1
1.1 jsing 6295: .Op Fl modulus
6296: .Op Fl nameopt Ar option
6297: .Op Fl noout
6298: .Op Fl ocsp_uri
6299: .Op Fl ocspid
6300: .Op Fl out Ar file
6301: .Op Fl outform Ar DER | NET | PEM
6302: .Op Fl passin Ar arg
6303: .Op Fl pubkey
6304: .Op Fl purpose
6305: .Op Fl req
6306: .Op Fl serial
6307: .Op Fl set_serial Ar n
6308: .Op Fl setalias Ar arg
6309: .Op Fl signkey Ar file
6310: .Op Fl startdate
6311: .Op Fl subject
6312: .Op Fl subject_hash
6313: .Op Fl subject_hash_old
6314: .Op Fl text
6315: .Op Fl trustout
6316: .Op Fl x509toreq
6317: .Ek
6318: .nr nS 0
6319: .Pp
6320: The
6321: .Nm x509
6322: command is a multi-purpose certificate utility.
6323: It can be used to display certificate information, convert certificates to
6324: various forms, sign certificate requests like a
6325: .Qq mini CA ,
6326: or edit certificate trust settings.
6327: .Pp
6328: Since there are a large number of options, they are split up into
6329: various sections.
6330: .Sh X509 INPUT, OUTPUT, AND GENERAL PURPOSE OPTIONS
6331: .Bl -tag -width "XXXX"
6332: .It Fl in Ar file
6333: This specifies the input
6334: .Ar file
6335: to read a certificate from, or standard input if this option is not specified.
6336: .It Fl inform Ar DER | NET | PEM
6337: This specifies the input format.
6338: Normally, the command will expect an X.509 certificate,
6339: but this can change if other options such as
6340: .Fl req
6341: are present.
6342: The
6343: .Ar DER
6344: format is the DER encoding of the certificate and
6345: .Ar PEM
6346: is the base64 encoding of the DER encoding with header and footer lines added.
6347: The
6348: .Ar NET
6349: option is an obscure Netscape server format that is now
6350: obsolete.
1.29 bcook 6351: .It Fl md5 | sha1
1.1 jsing 6352: The digest to use.
6353: This affects any signing or display option that uses a message digest,
6354: such as the
6355: .Fl fingerprint , signkey ,
6356: and
6357: .Fl CA
6358: options.
6359: If not specified, MD5 is used.
6360: If the key being used to sign with is a DSA key,
6361: this option has no effect: SHA1 is always used with DSA keys.
6362: .It Fl out Ar file
6363: This specifies the output
6364: .Ar file
6365: to write to, or standard output by default.
6366: .It Fl outform Ar DER | NET | PEM
6367: This specifies the output format; the options have the same meaning as the
6368: .Fl inform
6369: option.
6370: .It Fl passin Ar arg
6371: The key password source.
6372: .El
6373: .Sh X509 DISPLAY OPTIONS
6374: .Sy Note :
6375: The
6376: .Fl alias
6377: and
6378: .Fl purpose
6379: options are also display options but are described in the
6380: .Sx X509 TRUST SETTINGS
6381: section.
6382: .Bl -tag -width "XXXX"
6383: .It Fl C
6384: This outputs the certificate in the form of a C source file.
6385: .It Fl certopt Ar option
6386: Customise the output format used with
6387: .Fl text .
6388: The
6389: .Ar option
6390: argument can be a single option or multiple options separated by commas.
6391: The
6392: .Fl certopt
6393: switch may also be used more than once to set multiple options.
6394: See the
6395: .Sx X509 TEXT OPTIONS
6396: section for more information.
6397: .It Fl dates
6398: Prints out the start and expiry dates of a certificate.
6399: .It Fl email
6400: Outputs the email address(es), if any.
6401: .It Fl enddate
6402: Prints out the expiry date of the certificate; that is, the
6403: .Em notAfter
6404: date.
6405: .It Fl fingerprint
6406: Prints out the digest of the DER-encoded version of the whole certificate
6407: (see
6408: .Sx DIGEST OPTIONS ) .
6409: .It Fl hash
6410: A synonym for
6411: .Fl subject_hash ,
6412: for backwards compatibility.
6413: .It Fl issuer
6414: Outputs the issuer name.
6415: .It Fl issuer_hash
6416: Outputs the
6417: .Qq hash
6418: of the certificate issuer name.
6419: .It Fl issuer_hash_old
6420: Outputs the
6421: .Qq hash
6422: of the certificate issuer name using the older algorithm
6423: as used by
6424: .Nm OpenSSL
6425: versions before 1.0.0.
6426: .It Fl modulus
6427: This option prints out the value of the modulus of the public key
6428: contained in the certificate.
6429: .It Fl nameopt Ar option
6430: Option which determines how the subject or issuer names are displayed.
6431: The
6432: .Ar option
6433: argument can be a single option or multiple options separated by commas.
6434: Alternatively, the
6435: .Fl nameopt
6436: switch may be used more than once to set multiple options.
6437: See the
6438: .Sx X509 NAME OPTIONS
6439: section for more information.
6440: .It Fl noout
6441: This option prevents output of the encoded version of the request.
6442: .It Fl ocsp_uri
6443: Outputs the OCSP responder addresses, if any.
6444: .It Fl ocspid
6445: Print OCSP hash values for the subject name and public key.
6446: .It Fl pubkey
6447: Output the public key.
6448: .It Fl serial
6449: Outputs the certificate serial number.
6450: .It Fl startdate
6451: Prints out the start date of the certificate; that is, the
6452: .Em notBefore
6453: date.
6454: .It Fl subject
6455: Outputs the subject name.
6456: .It Fl subject_hash
6457: Outputs the
6458: .Qq hash
6459: of the certificate subject name.
6460: This is used in
6461: .Nm OpenSSL
6462: to form an index to allow certificates in a directory to be looked up
6463: by subject name.
6464: .It Fl subject_hash_old
6465: Outputs the
6466: .Qq hash
6467: of the certificate subject name using the older algorithm
6468: as used by
6469: .Nm OpenSSL
6470: versions before 1.0.0.
6471: .It Fl text
6472: Prints out the certificate in text form.
6473: Full details are output including the public key, signature algorithms,
6474: issuer and subject names, serial number, any extensions present,
6475: and any trust settings.
6476: .El
6477: .Sh X509 TRUST SETTINGS
6478: Please note these options are currently experimental and may well change.
6479: .Pp
6480: A
6481: .Em trusted certificate
6482: is an ordinary certificate which has several
6483: additional pieces of information attached to it such as the permitted
6484: and prohibited uses of the certificate and an
6485: .Qq alias .
6486: .Pp
6487: Normally, when a certificate is being verified at least one certificate
6488: must be
6489: .Qq trusted .
6490: By default, a trusted certificate must be stored
6491: locally and must be a root CA: any certificate chain ending in this CA
6492: is then usable for any purpose.
6493: .Pp
6494: Trust settings currently are only used with a root CA.
6495: They allow a finer control over the purposes the root CA can be used for.
6496: For example, a CA may be trusted for an SSL client but not for
6497: SSL server use.
6498: .Pp
6499: See the description of the
6500: .Nm verify
6501: utility for more information on the meaning of trust settings.
6502: .Pp
6503: Future versions of
6504: .Nm OpenSSL
6505: will recognize trust settings on any certificate: not just root CAs.
6506: .Bl -tag -width "XXXX"
6507: .It Fl addreject Ar arg
6508: Adds a prohibited use.
6509: It accepts the same values as the
6510: .Fl addtrust
6511: option.
6512: .It Fl addtrust Ar arg
6513: Adds a trusted certificate use.
6514: Any object name can be used here, but currently only
6515: .Ar clientAuth
6516: .Pq SSL client use ,
6517: .Ar serverAuth
6518: .Pq SSL server use ,
6519: and
6520: .Ar emailProtection
6521: .Pq S/MIME email
6522: are used.
6523: Other
6524: .Nm OpenSSL
6525: applications may define additional uses.
6526: .It Fl alias
6527: Outputs the certificate alias, if any.
6528: .It Fl clrreject
6529: Clears all the prohibited or rejected uses of the certificate.
6530: .It Fl clrtrust
6531: Clears all the permitted or trusted uses of the certificate.
6532: .It Fl purpose
6533: This option performs tests on the certificate extensions and outputs
6534: the results.
6535: For a more complete description, see the
6536: .Sx X.509 CERTIFICATE EXTENSIONS
6537: section.
6538: .It Fl setalias Ar arg
6539: Sets the alias of the certificate.
6540: This will allow the certificate to be referred to using a nickname,
6541: for example
6542: .Qq Steve's Certificate .
6543: .It Fl trustout
6544: This causes
6545: .Nm x509
6546: to output a
6547: .Em trusted certificate .
6548: An ordinary or trusted certificate can be input, but by default an ordinary
6549: certificate is output and any trust settings are discarded.
6550: With the
6551: .Fl trustout
6552: option a trusted certificate is output.
6553: A trusted certificate is automatically output if any trust settings
6554: are modified.
6555: .El
6556: .Sh X509 SIGNING OPTIONS
6557: The
6558: .Nm x509
6559: utility can be used to sign certificates and requests: it
6560: can thus behave like a
6561: .Qq mini CA .
6562: .Bl -tag -width "XXXX"
6563: .It Fl CA Ar file
6564: Specifies the CA certificate to be used for signing.
6565: When this option is present,
6566: .Nm x509
6567: behaves like a
6568: .Qq mini CA .
6569: The input file is signed by the CA using this option;
6570: that is, its issuer name is set to the subject name of the CA and it is
6571: digitally signed using the CA's private key.
6572: .Pp
6573: This option is normally combined with the
6574: .Fl req
6575: option.
6576: Without the
6577: .Fl req
6578: option, the input is a certificate which must be self-signed.
6579: .It Fl CAcreateserial
6580: With this option the CA serial number file is created if it does not exist:
6581: it will contain the serial number
6582: .Sq 02
6583: and the certificate being signed will have
6584: .Sq 1
6585: as its serial number.
6586: Normally, if the
6587: .Fl CA
6588: option is specified and the serial number file does not exist, it is an error.
6589: .It Fl CAform Ar DER | PEM
6590: The format of the CA certificate file.
6591: The default is
6592: .Ar PEM .
6593: .It Fl CAkey Ar file
6594: Sets the CA private key to sign a certificate with.
6595: If this option is not specified, it is assumed that the CA private key
6596: is present in the CA certificate file.
6597: .It Fl CAkeyform Ar DER | PEM
6598: The format of the CA private key.
6599: The default is
6600: .Ar PEM .
6601: .It Fl CAserial Ar file
6602: Sets the CA serial number file to use.
6603: .Pp
6604: When the
6605: .Fl CA
6606: option is used to sign a certificate,
6607: it uses a serial number specified in a file.
6608: This file consists of one line containing an even number of hex digits
6609: with the serial number to use.
6610: After each use the serial number is incremented and written out
6611: to the file again.
6612: .Pp
6613: The default filename consists of the CA certificate file base name with
6614: .Pa .srl
6615: appended.
6616: For example, if the CA certificate file is called
6617: .Pa mycacert.pem ,
6618: it expects to find a serial number file called
6619: .Pa mycacert.srl .
6620: .It Fl checkend Ar arg
6621: Check whether the certificate expires in the next
6622: .Ar arg
6623: seconds.
6624: If so, exit with return value 1;
6625: otherwise exit with return value 0.
6626: .It Fl clrext
6627: Delete any extensions from a certificate.
6628: This option is used when a certificate is being created from another
6629: certificate (for example with the
6630: .Fl signkey
6631: or the
6632: .Fl CA
6633: options).
6634: Normally, all extensions are retained.
6635: .It Fl days Ar arg
6636: Specifies the number of days to make a certificate valid for.
6637: The default is 30 days.
6638: .It Fl extensions Ar section
6639: The section to add certificate extensions from.
6640: If this option is not specified, the extensions should either be
6641: contained in the unnamed
6642: .Pq default
6643: section or the default section should contain a variable called
6644: .Qq extensions
6645: which contains the section to use.
6646: .It Fl extfile Ar file
6647: File containing certificate extensions to use.
6648: If not specified, no extensions are added to the certificate.
6649: .It Fl keyform Ar DER | PEM
6650: Specifies the format
6651: .Pq DER or PEM
6652: of the private key file used in the
6653: .Fl signkey
6654: option.
6655: .It Fl req
6656: By default, a certificate is expected on input.
6657: With this option a certificate request is expected instead.
6658: .It Fl set_serial Ar n
6659: Specifies the serial number to use.
6660: This option can be used with either the
6661: .Fl signkey
6662: or
6663: .Fl CA
6664: options.
6665: If used in conjunction with the
6666: .Fl CA
6667: option, the serial number file (as specified by the
6668: .Fl CAserial
6669: or
6670: .Fl CAcreateserial
6671: options) is not used.
6672: .Pp
6673: The serial number can be decimal or hex (if preceded by
6674: .Sq 0x ) .
6675: Negative serial numbers can also be specified but their use is not recommended.
6676: .It Fl signkey Ar file
6677: This option causes the input file to be self-signed using the supplied
6678: private key.
6679: .Pp
6680: If the input file is a certificate, it sets the issuer name to the
6681: subject name
6682: .Pq i.e. makes it self-signed ,
6683: changes the public key to the supplied value,
6684: and changes the start and end dates.
6685: The start date is set to the current time and the end date is set to
6686: a value determined by the
6687: .Fl days
6688: option.
6689: Any certificate extensions are retained unless the
6690: .Fl clrext
6691: option is supplied.
6692: .Pp
6693: If the input is a certificate request, a self-signed certificate
6694: is created using the supplied private key using the subject name in
6695: the request.
6696: .It Fl x509toreq
6697: Converts a certificate into a certificate request.
6698: The
6699: .Fl signkey
6700: option is used to pass the required private key.
6701: .El
6702: .Sh X509 NAME OPTIONS
6703: The
6704: .Fl nameopt
6705: command line switch determines how the subject and issuer
6706: names are displayed.
6707: If no
6708: .Fl nameopt
6709: switch is present, the default
6710: .Qq oneline
6711: format is used which is compatible with previous versions of
6712: .Nm OpenSSL .
6713: Each option is described in detail below; all options can be preceded by a
6714: .Sq -
6715: to turn the option off.
6716: Only
6717: .Ar compat ,
6718: .Ar RFC2253 ,
6719: .Ar oneline ,
6720: and
6721: .Ar multiline
6722: will normally be used.
6723: .Bl -tag -width "XXXX"
6724: .It Ar align
6725: Align field values for a more readable output.
6726: Only usable with
6727: .Ar sep_multiline .
6728: .It Ar compat
6729: Use the old format.
6730: This is equivalent to specifying no name options at all.
6731: .It Ar dn_rev
6732: Reverse the fields of the DN.
6733: This is required by RFC 2253.
6734: As a side effect, this also reverses the order of multiple AVAs but this is
6735: permissible.
6736: .It Ar dump_all
6737: Dump all fields.
6738: This option, when used with
6739: .Ar dump_der ,
6740: allows the DER encoding of the structure to be unambiguously determined.
6741: .It Ar dump_der
6742: When this option is set, any fields that need to be hexdumped will
6743: be dumped using the DER encoding of the field.
6744: Otherwise just the content octets will be displayed.
6745: Both options use the RFC 2253 #XXXX... format.
6746: .It Ar dump_nostr
6747: Dump non-character string types
6748: .Pq for example OCTET STRING ;
6749: if this option is not set, non-character string types will be displayed
6750: as though each content octet represents a single character.
6751: .It Ar dump_unknown
6752: Dump any field whose OID is not recognised by
6753: .Nm OpenSSL .
6754: .It Ar esc_2253
6755: Escape the
6756: .Qq special
6757: characters required by RFC 2253 in a field that is
6758: .Dq \& ,+"\*(Lt\*(Gt; .
6759: Additionally,
6760: .Sq #
6761: is escaped at the beginning of a string
6762: and a space character at the beginning or end of a string.
6763: .It Ar esc_ctrl
6764: Escape control characters.
6765: That is, those with ASCII values less than 0x20
6766: .Pq space
6767: and the delete
6768: .Pq 0x7f
6769: character.
6770: They are escaped using the RFC 2253 \eXX notation (where XX are two hex
6771: digits representing the character value).
6772: .It Ar esc_msb
6773: Escape characters with the MSB set; that is, with ASCII values larger than
6774: 127.
6775: .It Ar multiline
6776: A multiline format.
6777: It is equivalent to
6778: .Ar esc_ctrl , esc_msb , sep_multiline ,
6779: .Ar space_eq , lname ,
6780: and
6781: .Ar align .
6782: .It Ar no_type
6783: This option does not attempt to interpret multibyte characters in any
6784: way.
6785: That is, their content octets are merely dumped as though one octet
6786: represents each character.
6787: This is useful for diagnostic purposes but will result in rather odd
6788: looking output.
6789: .It Ar nofname , sname , lname , oid
6790: These options alter how the field name is displayed.
6791: .Ar nofname
6792: does not display the field at all.
6793: .Ar sname
6794: uses the
6795: .Qq short name
6796: form (CN for
6797: .Ar commonName ,
6798: for example).
6799: .Ar lname
6800: uses the long form.
6801: .Ar oid
6802: represents the OID in numerical form and is useful for diagnostic purpose.
6803: .It Ar oneline
6804: A oneline format which is more readable than
6805: .Ar RFC2253 .
6806: It is equivalent to specifying the
6807: .Ar esc_2253 , esc_ctrl , esc_msb , utf8 ,
6808: .Ar dump_nostr , dump_der , use_quote , sep_comma_plus_spc ,
6809: .Ar space_eq ,
6810: and
6811: .Ar sname
6812: options.
6813: .It Ar RFC2253
6814: Displays names compatible with RFC 2253; equivalent to
6815: .Ar esc_2253 , esc_ctrl ,
6816: .Ar esc_msb , utf8 , dump_nostr , dump_unknown ,
6817: .Ar dump_der , sep_comma_plus , dn_rev ,
6818: and
6819: .Ar sname .
6820: .It Ar sep_comma_plus , sep_comma_plus_space , sep_semi_plus_space , sep_multiline
6821: These options determine the field separators.
6822: The first character is between RDNs and the second between multiple AVAs
6823: (multiple AVAs are very rare and their use is discouraged).
6824: The options ending in
6825: .Qq space
6826: additionally place a space after the separator to make it more readable.
6827: The
6828: .Ar sep_multiline
6829: uses a linefeed character for the RDN separator and a spaced
6830: .Sq +
6831: for the AVA separator.
6832: It also indents the fields by four characters.
6833: .It Ar show_type
6834: Show the type of the ASN1 character string.
6835: The type precedes the field contents.
6836: For example
6837: .Qq BMPSTRING: Hello World .
6838: .It Ar space_eq
6839: Places spaces round the
6840: .Sq =
6841: character which follows the field name.
6842: .It Ar use_quote
6843: Escapes some characters by surrounding the whole string with
6844: .Sq \&"
6845: characters.
6846: Without the option, all escaping is done with the
6847: .Sq \e
6848: character.
6849: .It Ar utf8
6850: Convert all strings to UTF8 format first.
6851: This is required by RFC 2253.
6852: If you are lucky enough to have a UTF8 compatible terminal,
6853: the use of this option (and
6854: .Em not
6855: setting
6856: .Ar esc_msb )
6857: may result in the correct display of multibyte
6858: .Pq international
6859: characters.
6860: If this option is not present, multibyte characters larger than 0xff
6861: will be represented using the format \eUXXXX for 16 bits and \eWXXXXXXXX
6862: for 32 bits.
6863: Also, if this option is off, any UTF8Strings will be converted to their
6864: character form first.
6865: .El
6866: .Sh X509 TEXT OPTIONS
6867: As well as customising the name output format, it is also possible to
6868: customise the actual fields printed using the
6869: .Fl certopt
6870: options when the
6871: .Fl text
6872: option is present.
6873: The default behaviour is to print all fields.
6874: .Bl -tag -width "XXXX"
6875: .It Ar ca_default
6876: The value used by the
6877: .Nm ca
6878: utility; equivalent to
6879: .Ar no_issuer , no_pubkey , no_header ,
6880: .Ar no_version , no_sigdump ,
6881: and
6882: .Ar no_signame .
6883: .It Ar compatible
6884: Use the old format.
6885: This is equivalent to specifying no output options at all.
6886: .It Ar ext_default
6887: Retain default extension behaviour: attempt to print out unsupported
6888: certificate extensions.
6889: .It Ar ext_dump
6890: Hex dump unsupported extensions.
6891: .It Ar ext_error
6892: Print an error message for unsupported certificate extensions.
6893: .It Ar ext_parse
6894: ASN1 parse unsupported extensions.
6895: .It Ar no_aux
6896: Don't print out certificate trust information.
6897: .It Ar no_extensions
6898: Don't print out any X509V3 extensions.
6899: .It Ar no_header
6900: Don't print header information: that is, the lines saying
6901: .Qq Certificate
6902: and
6903: .Qq Data .
6904: .It Ar no_issuer
6905: Don't print out the issuer name.
6906: .It Ar no_pubkey
6907: Don't print out the public key.
6908: .It Ar no_serial
6909: Don't print out the serial number.
6910: .It Ar no_sigdump
6911: Don't give a hexadecimal dump of the certificate signature.
6912: .It Ar no_signame
6913: Don't print out the signature algorithm used.
6914: .It Ar no_subject
6915: Don't print out the subject name.
6916: .It Ar no_validity
6917: Don't print the validity; that is, the
6918: .Em notBefore
6919: and
6920: .Em notAfter
6921: fields.
6922: .It Ar no_version
6923: Don't print out the version number.
6924: .El
6925: .Sh X509 EXAMPLES
6926: Display the contents of a certificate:
6927: .Pp
6928: .Dl $ openssl x509 -in cert.pem -noout -text
6929: .Pp
6930: Display the certificate serial number:
6931: .Pp
6932: .Dl $ openssl x509 -in cert.pem -noout -serial
6933: .Pp
6934: Display the certificate subject name:
6935: .Pp
6936: .Dl $ openssl x509 -in cert.pem -noout -subject
6937: .Pp
6938: Display the certificate subject name in RFC 2253 form:
6939: .Pp
6940: .Dl $ openssl x509 -in cert.pem -noout -subject -nameopt RFC2253
6941: .Pp
6942: Display the certificate subject name in oneline form on a terminal
6943: supporting UTF8:
6944: .Bd -literal -offset indent
6945: $ openssl x509 -in cert.pem -noout -subject \e
6946: -nameopt oneline,-esc_msb
6947: .Ed
6948: .Pp
6949: Display the certificate MD5 fingerprint:
6950: .Pp
6951: .Dl $ openssl x509 -in cert.pem -noout -fingerprint
6952: .Pp
6953: Display the certificate SHA1 fingerprint:
6954: .Pp
6955: .Dl $ openssl x509 -sha1 -in cert.pem -noout -fingerprint
6956: .Pp
6957: Convert a certificate from PEM to DER format:
6958: .Pp
6959: .Dl "$ openssl x509 -in cert.pem -inform PEM -out cert.der -outform DER"
6960: .Pp
6961: Convert a certificate to a certificate request:
6962: .Bd -literal -offset indent
6963: $ openssl x509 -x509toreq -in cert.pem -out req.pem \e
6964: -signkey key.pem
6965: .Ed
6966: .Pp
6967: Convert a certificate request into a self-signed certificate using
6968: extensions for a CA:
6969: .Bd -literal -offset indent
6970: $ openssl x509 -req -in careq.pem -extfile openssl.cnf -extensions \e
6971: v3_ca -signkey key.pem -out cacert.pem
6972: .Ed
6973: .Pp
6974: Sign a certificate request using the CA certificate above and add user
6975: certificate extensions:
6976: .Bd -literal -offset indent
6977: $ openssl x509 -req -in req.pem -extfile openssl.cnf -extensions \e
6978: v3_usr -CA cacert.pem -CAkey key.pem -CAcreateserial
6979: .Ed
6980: .Pp
6981: Set a certificate to be trusted for SSL
6982: client use and set its alias to
6983: .Qq Steve's Class 1 CA :
6984: .Bd -literal -offset indent
6985: $ openssl x509 -in cert.pem -addtrust clientAuth \e
6986: -setalias "Steve's Class 1 CA" -out trust.pem
6987: .Ed
6988: .Sh X509 NOTES
6989: The PEM format uses the header and footer lines:
6990: .Bd -unfilled -offset indent
6991: -----BEGIN CERTIFICATE-----
6992: -----END CERTIFICATE-----
6993: .Ed
6994: .Pp
6995: It will also handle files containing:
6996: .Bd -unfilled -offset indent
6997: -----BEGIN X509 CERTIFICATE-----
6998: -----END X509 CERTIFICATE-----
6999: .Ed
7000: .Pp
7001: Trusted certificates have the lines:
7002: .Bd -unfilled -offset indent
7003: -----BEGIN TRUSTED CERTIFICATE-----
7004: -----END TRUSTED CERTIFICATE-----
7005: .Ed
7006: .Pp
7007: The conversion to UTF8 format used with the name options assumes that
7008: T61Strings use the ISO 8859-1 character set.
7009: This is wrong, but Netscape and MSIE do this, as do many certificates.
7010: So although this is incorrect
7011: it is more likely to display the majority of certificates correctly.
7012: .Pp
7013: The
7014: .Fl fingerprint
7015: option takes the digest of the DER-encoded certificate.
7016: This is commonly called a
7017: .Qq fingerprint .
7018: Because of the nature of message digests, the fingerprint of a certificate
7019: is unique to that certificate and two certificates with the same fingerprint
7020: can be considered to be the same.
7021: .Pp
7022: The Netscape fingerprint uses MD5, whereas MSIE uses SHA1.
7023: .Pp
7024: The
7025: .Fl email
7026: option searches the subject name and the subject alternative
7027: name extension.
7028: Only unique email addresses will be printed out: it will
7029: not print the same address more than once.
7030: .Sh X.509 CERTIFICATE EXTENSIONS
7031: The
7032: .Fl purpose
7033: option checks the certificate extensions and determines
7034: what the certificate can be used for.
7035: The actual checks done are rather
7036: complex and include various hacks and workarounds to handle broken
7037: certificates and software.
7038: .Pp
7039: The same code is used when verifying untrusted certificates in chains,
7040: so this section is useful if a chain is rejected by the verify code.
7041: .Pp
7042: The
7043: .Em basicConstraints
7044: extension CA flag is used to determine whether the
7045: certificate can be used as a CA.
7046: If the CA flag is true, it is a CA;
7047: if the CA flag is false, it is not a CA.
7048: .Em All
7049: CAs should have the CA flag set to true.
7050: .Pp
7051: If the
7052: .Em basicConstraints
7053: extension is absent, then the certificate is
7054: considered to be a
7055: .Qq possible CA ;
7056: other extensions are checked according to the intended use of the certificate.
7057: A warning is given in this case because the certificate should really not
7058: be regarded as a CA: however,
7059: it is allowed to be a CA to work around some broken software.
7060: .Pp
7061: If the certificate is a V1 certificate
7062: .Pq and thus has no extensions
7063: and it is self-signed, it is also assumed to be a CA but a warning is again
7064: given: this is to work around the problem of Verisign roots which are V1
7065: self-signed certificates.
7066: .Pp
7067: If the
7068: .Em keyUsage
7069: extension is present, then additional restraints are
7070: made on the uses of the certificate.
7071: A CA certificate
7072: .Em must
7073: have the
7074: .Em keyCertSign
7075: bit set if the
7076: .Em keyUsage
7077: extension is present.
7078: .Pp
7079: The extended key usage extension places additional restrictions on the
7080: certificate uses.
7081: If this extension is present
7082: .Pq whether critical or not ,
7083: the key can only be used for the purposes specified.
7084: .Pp
7085: A complete description of each test is given below.
7086: The comments about
7087: .Em basicConstraints
7088: and
7089: .Em keyUsage
7090: and V1 certificates above apply to
7091: .Em all
7092: CA certificates.
7093: .Bl -tag -width "XXXX"
7094: .It Ar SSL Client
7095: The extended key usage extension must be absent or include the
7096: .Qq web client authentication
7097: OID.
7098: .Ar keyUsage
7099: must be absent or it must have the
7100: .Em digitalSignature
7101: bit set.
7102: Netscape certificate type must be absent or it must have the SSL
7103: client bit set.
7104: .It Ar SSL Client CA
7105: The extended key usage extension must be absent or include the
7106: .Qq web client authentication
7107: OID.
7108: Netscape certificate type must be absent or it must have the SSL CA
7109: bit set: this is used as a work around if the
7110: .Em basicConstraints
7111: extension is absent.
7112: .It Ar SSL Server
7113: The extended key usage extension must be absent or include the
7114: .Qq web server authentication
7115: and/or one of the SGC OIDs.
7116: .Em keyUsage
7117: must be absent or it must have the
7118: .Em digitalSignature
7119: set, the
7120: .Em keyEncipherment
7121: set, or both bits set.
7122: Netscape certificate type must be absent or have the SSL server bit set.
7123: .It Ar SSL Server CA
7124: The extended key usage extension must be absent or include the
7125: .Qq web server authentication
7126: and/or one of the SGC OIDs.
7127: Netscape certificate type must be absent or the SSL CA
7128: bit must be set: this is used as a work around if the
7129: .Em basicConstraints
7130: extension is absent.
7131: .It Ar Netscape SSL Server
7132: For Netscape SSL clients to connect to an SSL server; it must have the
7133: .Em keyEncipherment
7134: bit set if the
7135: .Em keyUsage
7136: extension is present.
7137: This isn't always valid because some cipher suites use the key for
7138: digital signing.
7139: Otherwise it is the same as a normal SSL server.
7140: .It Ar Common S/MIME Client Tests
7141: The extended key usage extension must be absent or include the
7142: .Qq email protection
7143: OID.
7144: Netscape certificate type must be absent or should have the
7145: .Em S/MIME
7146: bit set.
7147: If the
7148: .Em S/MIME
7149: bit is not set in Netscape certificate type, then the SSL
7150: client bit is tolerated as an alternative but a warning is shown:
7151: this is because some Verisign certificates don't set the
7152: .Em S/MIME
7153: bit.
7154: .It Ar S/MIME Signing
7155: In addition to the common
7156: .Em S/MIME
7157: client tests, the
7158: .Em digitalSignature
7159: bit must be set if the
7160: .Em keyUsage
7161: extension is present.
7162: .It Ar S/MIME Encryption
7163: In addition to the common
7164: .Em S/MIME
7165: tests, the
7166: .Em keyEncipherment
7167: bit must be set if the
7168: .Em keyUsage
7169: extension is present.
7170: .It Ar S/MIME CA
7171: The extended key usage extension must be absent or include the
7172: .Qq email protection
7173: OID.
7174: Netscape certificate type must be absent or must have the
7175: .Em S/MIME CA
7176: bit set: this is used as a work around if the
7177: .Em basicConstraints
7178: extension is absent.
7179: .It Ar CRL Signing
7180: The
7181: .Em keyUsage
7182: extension must be absent or it must have the
7183: .Em CRL
7184: signing bit set.
7185: .It Ar CRL Signing CA
7186: The normal CA tests apply.
7187: Except in this case the
7188: .Em basicConstraints
7189: extension must be present.
7190: .El
7191: .Sh X509 BUGS
7192: Extensions in certificates are not transferred to certificate requests and
7193: vice versa.
7194: .Pp
7195: It is possible to produce invalid certificates or requests by specifying the
7196: wrong private key or using inconsistent options in some cases: these should
7197: be checked.
7198: .Pp
7199: There should be options to explicitly set such things as start and end dates,
7200: rather than an offset from the current time.
7201: .Pp
7202: The code to implement the verify behaviour described in the
7203: .Sx X509 TRUST SETTINGS
7204: is currently being developed.
7205: It thus describes the intended behaviour rather than the current behaviour.
7206: It is hoped that it will represent reality in
7207: .Nm OpenSSL
7208: 0.9.5 and later.
7209: .Sh X509 HISTORY
7210: Before
7211: .Nm OpenSSL
7212: 0.9.8,
7213: the default digest for RSA keys was MD5.
7214: .Pp
7215: The hash algorithm used in the
7216: .Fl subject_hash
7217: and
7218: .Fl issuer_hash
7219: options before
7220: .Nm OpenSSL
7221: 1.0.0 was based on the deprecated MD5 algorithm and the encoding
7222: of the distinguished name.
7223: In
7224: .Nm OpenSSL
7225: 1.0.0 and later it is based on a canonical version of the DN using SHA1.
7226: This means that any directories using the old form
7227: must have their links rebuilt using
7228: .Ar c_rehash
7229: or similar.
1.38 jmc 7230: .Sh COMMON NOTATION
7231: Several commands share a common syntax,
7232: as detailed below.
7233: .Pp
7234: Password arguments, typically specified using
1.33 jmc 7235: .Fl passin
7236: and
7237: .Fl passout
1.38 jmc 7238: for input and output passwords,
7239: allow passwords to be obtained from a variety of sources.
7240: Both of these options take a single argument, described below.
1.33 jmc 7241: If no password argument is given and a password is required,
7242: then the user is prompted to enter one:
7243: this will typically be read from the current terminal with echoing turned off.
1.38 jmc 7244: .Bl -tag -width "pass:password" -offset indent
7245: .It Cm pass : Ns Ar password
1.33 jmc 7246: The actual password is
7247: .Ar password .
1.38 jmc 7248: Since the password is visible to utilities,
1.33 jmc 7249: this form should only be used where security is not important.
1.38 jmc 7250: .It Cm env : Ns Ar var
1.33 jmc 7251: Obtain the password from the environment variable
7252: .Ar var .
1.38 jmc 7253: Since the environment of other processes is visible,
7254: this option should be used with caution.
7255: .It Cm file : Ns Ar path
1.33 jmc 7256: The first line of
7257: .Ar path
7258: is the password.
7259: If the same
7260: .Ar path
7261: argument is supplied to
7262: .Fl passin
7263: and
7264: .Fl passout ,
7265: then the first line will be used for the input password and the next line
7266: for the output password.
7267: .Ar path
7268: need not refer to a regular file:
7269: it could, for example, refer to a device or named pipe.
1.38 jmc 7270: .It Cm fd : Ns Ar number
1.33 jmc 7271: Read the password from the file descriptor
7272: .Ar number .
1.38 jmc 7273: This can be used to send the data via a pipe, for example.
7274: .It Cm stdin
1.33 jmc 7275: Read the password from standard input.
1.35 jmc 7276: .El
1.38 jmc 7277: .Pp
1.64 jmc 7278: Input/output formats,
1.38 jmc 7279: typically specified using
7280: .Fl inform
7281: and
7282: .Fl outform ,
1.64 jmc 7283: indicate the format being read from or written to.
1.38 jmc 7284: The argument is case insensitive.
7285: .Pp
7286: .Bl -tag -width Ds -offset indent -compact
7287: .It Cm der
7288: Distinguished Encoding Rules (DER)
7289: is a binary format.
1.64 jmc 7290: .It Cm net
7291: Insecure legacy format.
1.38 jmc 7292: .It Cm pem
7293: Privacy Enhanced Mail (PEM)
7294: is base64-encoded.
7295: .It Cm txt
7296: Plain ASCII text.
7297: .El
1.35 jmc 7298: .Sh ENVIRONMENT
7299: The following environment variables affect the execution of
7300: .Nm openssl :
1.38 jmc 7301: .Bl -tag -width "/etc/ssl/openssl.cnf"
1.35 jmc 7302: .It Ev OPENSSL_CONF
7303: The location of the master configuration file.
1.33 jmc 7304: .El
1.1 jsing 7305: .\"
7306: .\" FILES
7307: .\"
7308: .Sh FILES
7309: .Bl -tag -width "/etc/ssl/openssl.cnf" -compact
1.17 sobrado 7310: .It Pa /etc/ssl/
1.1 jsing 7311: Default config directory for
7312: .Nm openssl .
1.17 sobrado 7313: .It Pa /etc/ssl/lib/
1.1 jsing 7314: Unused.
1.17 sobrado 7315: .It Pa /etc/ssl/private/
1.1 jsing 7316: Default private key directory.
1.17 sobrado 7317: .It Pa /etc/ssl/openssl.cnf
1.1 jsing 7318: Default configuration file for
7319: .Nm openssl .
1.17 sobrado 7320: .It Pa /etc/ssl/x509v3.cnf
1.1 jsing 7321: Default configuration file for
7322: .Nm x509
7323: certificates.
7324: .El
7325: .\"
7326: .\" SEE ALSO
7327: .\"
7328: .Sh SEE ALSO
1.26 jmc 7329: .Xr nc 1 ,
1.1 jsing 7330: .Xr ssl 8 ,
7331: .Xr starttls 8
7332: .Sh STANDARDS
7333: .Rs
7334: .%D February 1995
7335: .%Q Netscape Communications Corp.
7336: .%T The SSL Protocol
7337: .Re
7338: .Pp
7339: .Rs
7340: .%D November 1996
7341: .%Q Netscape Communications Corp.
7342: .%T The SSL 3.0 Protocol
7343: .Re
7344: .Pp
7345: .Rs
7346: .%A T. Dierks
7347: .%A C. Allen
7348: .%D January 1999
7349: .%R RFC 2246
7350: .%T The TLS Protocol Version 1.0