doc/apps/openssl.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 openssl - OpenSSL command line tool
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl>
  11 I<command>
  12 [ I<command_opts> ]
  13 [ I<command_args> ]
  14
  15 =head1 DESCRIPTION
  16
  17 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
  18 v2/v3) and Transport Layer Security (TLS v1) network protocols and related
  19 cryptography standards required by them.
  20
  21 The B<openssl> program is a command line tool for using the various
  22 cryptography functions of OpenSSL's B<crypto> library from the shell.
  23 It can be used for
  24
  25  o  Creation of RSA, DH and DSA key parameters
  26  o  Creation of X.509 certificates, CSRs and CRLs
  27  o  Calculation of Message Digests
  28  o  Encryption and Decryption with Ciphers
  29  o  SSL/TLS Client and Server Tests
  30  o  Handling of S/MIME signed or encrypted mail
  31
  32 =head1 COMMAND SUMMARY
  33
  34 The B<openssl> program provides a rich variety of commands (I<command> in the
  35 SYNOPSIS above), each of which often has a wealth of options and arguments
  36 (I<command_opts> and I<command_args> in the SYNOPSIS).
  37
  38 =head2 STANDARD COMMANDS
  39
  40 =over 10
  41
  42 =item B<asn1parse>
  43
  44 Parse an ASN.1 sequence.
  45
  46 =item B<ca>
  47
  48 Certificate Authority (CA) Management.
  49
  50 =item B<ciphers>
  51
  52 Cipher Suite Description Determination.
  53
  54 =item B<crl>
  55
  56 Certificate Revocation List (CRL) Management.
  57
  58 =item B<crl2pkcs7>
  59
  60 CRL to PKCS#7 Conversion.
  61
  62 =item B<dgst>
  63
  64 Message Digest Calculation.
  65
  66 =item B<dh>
  67
  68 Diffie-Hellman Data Management.
  69
  70 =item B<dsa>
  71
  72 DSA Data Management.
  73
  74 =item B<dsaparam>
  75
  76 DSA Parameter Generation.
  77
  78 =item B<enc>
  79
  80 Encoding with Ciphers.
  81
  82 =item B<errstr>
  83
  84 Error Number to Error String Conversion.
  85
  86 =item B<gendh>
  87
  88 Generation of Diffie-Hellman Parameters.
  89
  90 =item B<gendsa>
  91
  92 Generation of DSA Parameters.
  93
  94 =item B<genrsa>
  95
  96 Generation of RSA Parameters.
  97
  98 =item B<passwd>
  99
 100 Generation of hashed passwords.
 101
 102 =item B<pkcs7>
 103
 104 PKCS#7 Data Management.
 105
 106 =item B<req>
 107
 108 X.509 Certificate Signing Request (CSR) Management.
 109
 110 =item B<rsa>
 111
 112 RSA Data Management.
 113
 114 =item B<s_client>
 115
 116 This implements a generic SSL/TLS client which can establish a transparent
 117 connection to a remote server speaking SSL/TLS. It's intended for testing
 118 purposes only and provides only rudimentary interface functionality but
 119 internally uses mostly all functionality of the OpenSSL B<ssl> library.
 120
 121 =item B<s_server>
 122
 123 This implements a generic SSL/TLS server which accepts connections from remote
 124 clients speaking SSL/TLS. It's intended for testing purposes only and provides
 125 only rudimentary interface functionality but internally uses mostly all
 126 functionality of the OpenSSL B<ssl> library.  It provides both an own command
 127 line oriented protocol for testing SSL functions and a simple HTTP response
 128 facility to emulate an SSL/TLS-aware webserver.
 129
 130 =item B<s_time>
 131
 132 SSL Connection Timer.
 133
 134 =item B<sess_id>
 135
 136 SSL Session Data Management.
 137
 138 =item B<smime>
 139
 140 S/MIME mail processing.
 141
 142 =item B<speed>
 143
 144 Algorithm Speed Measurement.
 145
 146 =item B<verify>
 147
 148 X.509 Certificate Verification.
 149
 150 =item B<version>
 151
 152 OpenSSL Version Information.
 153
 154 =item B<x509>
 155
 156 X.509 Certificate Data Management.
 157
 158 =back
 159
 160 =head2 MESSAGE DIGEST COMMANDS
 161
 162 =over 10
 163
 164 =item B<md2>
 165
 166 MD2 Digest
 167
 168 =item B<md5>
 169
 170 MD5 Digest
 171
 172 =item B<mdc2>
 173
 174 MDC2 Digest
 175
 176 =item B<rmd160>
 177
 178 RMD-160 Digest
 179
 180 =item B<sha>
 181
 182 SHA Digest
 183
 184 =item B<sha1>
 185
 186 SHA-1 Digest
 187
 188 =back
 189
 190 =head2 ENCODING AND CIPHER COMMANDS
 191
 192 =over 10
 193
 194 =item B<base64>
 195
 196 Base64 Encoding
 197
 198 =item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
 199
 200 Blowfish Cipher
 201
 202 =item B<cast cast-cbc>
 203
 204 CAST Cipher
 205
 206 =item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
 207
 208 CAST5 Cipher
 209
 210 =item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
 211
 212 DES Cipher
 213
 214 =item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
 215
 216 Triple-DES Cipher
 217
 218 =item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
 219
 220 IDEA Cipher
 221
 222 =item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
 223
 224 RC2 Cipher
 225
 226 =item B<rc4>
 227
 228 RC4 Cipher
 229
 230 =item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
 231
 232 RC5 Cipher
 233
 234 =back
 235
 236 =head1 PASS PHRASE ARGUMENTS
 237
 238 Several commands accept password arguments, typically using B<-passin>
 239 and B<-passout> for input and output passwords respectively. These allow
 240 the password to be obtained from a variety of sources. Both of these
 241 options take a single argument whose format is described below. If no
 242 password argument is given and a password is required then the user is
 243 prompted to enter one: this will typically be read from the current
 244 terminal with echoing turned off.
 245
 246 =over 10
 247
 248 =item B<pass:password>
 249
 250 the actual password is B<password>. Since the password is visible
 251 to utilities (like 'ps' under Unix) this form should only be used
 252 where security is not important.
 253
 254 =item B<env:var>
 255
 256 obtain the password from the environment variable B<var>. Since
 257 the environment of other processes is visible on certain platforms
 258 (e.g. ps under certain Unix OSes) this option should be used with caution.
 259
 260 =item B<file:pathname>
 261
 262 the first line of B<pathname> is the password. If the same B<pathname>
 263 argument is supplied to B<-passin> and B<-passout> arguments then the first
 264 line will be used for the input password and the next line for the output
 265 password. B<pathname> need not refer to a regular file: it could for example
 266 refer to a device or named pipe.
 267
 268 =item B<fd:number>
 269
 270 read the password from the file descriptor B<number>. This can be used to
 271 send the data via a pipe for example.
 272
 273 =item B<stdin>
 274
 275 read the password from standard input.
 276
 277 =back
 278
 279 =head1 SEE ALSO
 280
 281 L<asn1parse(1)|asn1parse(1)>, L<ca(1)|ca(1)>, L<config(5)|config(5)>,
 282 L<crl(1)|crl(1)>, L<crl2pkcs7(1)|crl2pkcs7(1)>, L<dgst(1)|dgst(1)>,
 283 L<dhparam(1)|dhparam(1)>, L<dsa(1)|dsa(1)>, L<dsaparam(1)|dsaparam(1)>,
 284 L<enc(1)|enc(1)>, L<gendsa(1)|gendsa(1)>,
 285 L<genrsa(1)|genrsa(1)>, L<nseq(1)|nseq(1)>, L<openssl(1)|openssl(1)>,
 286 L<passwd(1)|passwd(1)>,
 287 L<pkcs12(1)|pkcs12(1)>, L<pkcs7(1)|pkcs7(1)>, L<pkcs8(1)|pkcs8(1)>,
 288 L<req(1)|req(1)>, L<rsa(1)|rsa(1)>, L<s_client(1)|s_client(1)>,
 289 L<s_server(1)|s_server(1)>, L<smime(1)|smime(1)>, L<spkac(1)|spkac(1)>,
 290 L<verify(1)|verify(1)>, L<version(1)|version(1)>, L<x509(1)|x509(1)>,
 291 L<crypto(3)|crypto(3)>, L<ssl(3)|ssl(3)>
 292
 293 =head1 HISTORY
 294
 295 The openssl(1) document appeared in OpenSSL 0.9.2
 296
 297 =cut
 298