doc/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  Creattion 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
  31 =head1 COMMAND SUMMARY
  32
  33 The B<openssl> program provides a rich variety of commands (I<command> in the
  34 SYNOPSIS above), each of which often has a wealth of options and arguments
  35 (I<command_opts> and I<command_args> in the SYNOPSIS).
  36
  37 =over 10
  38
  39 =item B<s_client>
  40
  41 This implements a generic SSL/TLS client which can establish a transparent
  42 connection to a remote server speaking SSL/TLS. It's intended for testing
  43 purposes only and provides only rudimentary interface functionality but
  44 internally uses mostly all functionality of the OpenSSL B<ssl> library.
  45
  46 =item B<s_server>
  47
  48 This implements a generic SSL/TLS server which accepts connections from remote
  49 clients speaking SSL/TLS. It's intended for testing purposes only and provides
  50 only rudimentary interface functionality but internally uses mostly all
  51 functionality of the OpenSSL B<ssl> library.  It provides both an own command
  52 line oriented protocol for testing SSL functions and a simple HTTP response
  53 facility to emulate an SSL/TLS-aware webserver.
  54
  55 =back
  56
  57 =head1 DETAILED COMMAND DESCRIPTION
  58
  59 The following is a detailed description of every B<openssl> I<command>.
  60
  61 =over 4
  62
  63 =item B<openssl> B<s_client>
  64 [B<-connect> I<host>B<:>I<port>]
  65 [B<-verify> I<arg>]
  66 [B<-cert> I<arg>]
  67 [B<-key> I<arg>]
  68 [B<-CApath> I<arg>]
  69 [B<-CAfile> I<arg>]
  70 [B<-reconnect>]
  71 [B<-pause>]
  72 [B<-debug>]
  73 [B<-nbio_test>]
  74 [B<-state>]
  75 [B<-nbio>]
  76 [B<-quiet>]
  77 [B<-ssl2>]
  78 [B<-ssl3>]
  79 [B<-tls1>]
  80 [B<-no_ssl2>]
  81 [B<-no_ssl3>]
  82 [B<-no_tls1>]
  83 [B<-bugs>]
  84 [B<-cipher>]
  85
  86 The B<s_client> command implements a generic SSL/TLS client which can
  87 establish a transparent connection to a remote I<host> and I<port> speaking
  88 SSL/TLS.
  89
  90 =item B<openssl> B<s_server>
  91 [B<-accept> I<port>]
  92 [B<-verify> I<arg>]
  93 [B<-Verify> I<arg>]
  94 [B<-cert> I<arg>]
  95 [B<-key> I<arg>]
  96 [B<-nbio>]
  97 [B<-nbio_test>]
  98 [B<-debug>]
  99 [B<-state>]
 100 [B<-CApath> I<arg>]
 101 [B<-CAfile> I<arg>]
 102 [B<-nocert>]
 103 [B<-cipher> I<arg>]
 104 [B<-quiet>]
 105 [B<-no_tmp_rsa>]
 106 [B<-ssl2>]
 107 [B<-ssl3>]
 108 [B<-tls1>]
 109 [B<-no_ssl2>]
 110 [B<-no_ssl3>]
 111 [B<-no_tls1>]
 112 [B<-bugs>]
 113 [B<-www>]
 114 [B<-WWW>]
 115
 116 The B<s_server> command implements a generic SSL/TLS server which accepts
 117 connections from remote clients on I<port> speaking SSL/TLS.
 118
 119 =back
 120
 121 ...
 122
 123 =head1 SEE ALSO
 124
 125 crypto(3), ssl(3)
 126
 127 =head1 AUTHORS
 128
 129 Ralf S. Engelschall
 130
 131 =cut
 132