diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/s_client.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/s_client.1 | 107 |
1 files changed, 52 insertions, 55 deletions
diff --git a/secure/usr.bin/openssl/man/s_client.1 b/secure/usr.bin/openssl/man/s_client.1 index 8e9583c..3c1afbc 100644 --- a/secure/usr.bin/openssl/man/s_client.1 +++ b/secure/usr.bin/openssl/man/s_client.1 @@ -1,8 +1,7 @@ -.\" Automatically generated by Pod::Man version 1.15 -.\" Wed Feb 19 16:49:36 2003 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: -.\" ====================================================================== +.\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp @@ -15,12 +14,6 @@ .if t .sp .5v .if n .sp .. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. .de Vb \" Begin verbatim text .ft CW .nf @@ -28,15 +21,14 @@ .. .de Ve \" End verbatim text .ft R - .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used -.\" to do unbreakable dashes and therefore won't be available. \*(C` and -.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ @@ -56,10 +48,10 @@ . ds R" '' 'br\} .\" -.\" If the F register is turned on, we'll generate index entries on stderr -.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and -.\" index entries marked with X<> in POD. Of course, you'll have to process -.\" the output yourself in some meaningful fashion. +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" @@ -68,14 +60,13 @@ . rr F .\} .\" -.\" For nroff, turn off justification. Always turn off hyphenation; it -.\" makes way too many mistakes in technical documents. +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. -.bd B 3 . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 @@ -135,17 +126,16 @@ . ds Ae AE .\} .rm #[ #] #H #V #F C -.\" ====================================================================== +.\" ======================================================================== .\" .IX Title "S_CLIENT 1" -.TH S_CLIENT 1 "0.9.7a" "2003-02-19" "OpenSSL" -.UC +.TH S_CLIENT 1 "2005-02-25" "0.9.7d" "OpenSSL" .SH "NAME" -s_client \- \s-1SSL/TLS\s0 client program +s_client \- SSL/TLS client program .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBs_client\fR -[\fB\-connect\fR host:port>] +[\fB\-connect host:port\fR] [\fB\-verify depth\fR] [\fB\-cert filename\fR] [\fB\-key filename\fR] @@ -170,8 +160,9 @@ s_client \- \s-1SSL/TLS\s0 client program [\fB\-no_tls1\fR] [\fB\-bugs\fR] [\fB\-cipher cipherlist\fR] +[\fB\-starttls protocol\fR] [\fB\-engine id\fR] -[\fB\-rand \f(BIfile\fB\|(s)\fR] +[\fB\-rand file(s)\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBs_client\fR command implements a generic \s-1SSL/TLS\s0 client which connects @@ -179,46 +170,46 @@ to a remote host using \s-1SSL/TLS\s0. It is a \fIvery\fR useful diagnostic tool \&\s-1SSL\s0 servers. .SH "OPTIONS" .IX Header "OPTIONS" -.Ip "\fB\-connect host:port\fR" 4 +.IP "\fB\-connect host:port\fR" 4 .IX Item "-connect host:port" This specifies the host and optional port to connect to. If not specified then an attempt is made to connect to the local host on port 4433. -.Ip "\fB\-cert certname\fR" 4 +.IP "\fB\-cert certname\fR" 4 .IX Item "-cert certname" The certificate to use, if one is requested by the server. The default is not to use a certificate. -.Ip "\fB\-key keyfile\fR" 4 +.IP "\fB\-key keyfile\fR" 4 .IX Item "-key keyfile" The private key to use. If not specified then the certificate file will be used. -.Ip "\fB\-verify depth\fR" 4 +.IP "\fB\-verify depth\fR" 4 .IX Item "-verify depth" The verify depth to use. This specifies the maximum length of the server certificate chain and turns on server certificate verification. Currently the verify operation continues after errors so all the problems with a certificate chain can be seen. As a side effect the connection will never fail due to a server certificate verify failure. -.Ip "\fB\-CApath directory\fR" 4 +.IP "\fB\-CApath directory\fR" 4 .IX Item "-CApath directory" The directory to use for server certificate verification. This directory must be in \*(L"hash format\*(R", see \fBverify\fR for more information. These are also used when building the client certificate chain. -.Ip "\fB\-CAfile file\fR" 4 +.IP "\fB\-CAfile file\fR" 4 .IX Item "-CAfile file" A file containing trusted certificates to use during server authentication and to use when attempting to build the client certificate chain. -.Ip "\fB\-reconnect\fR" 4 +.IP "\fB\-reconnect\fR" 4 .IX Item "-reconnect" reconnects to the same server 5 times using the same session \s-1ID\s0, this can be used as a test that session caching is working. -.Ip "\fB\-pause\fR" 4 +.IP "\fB\-pause\fR" 4 .IX Item "-pause" pauses 1 second between each read and write call. -.Ip "\fB\-showcerts\fR" 4 +.IP "\fB\-showcerts\fR" 4 .IX Item "-showcerts" display the whole server certificate chain: normally only the server certificate itself is displayed. -.Ip "\fB\-prexit\fR" 4 +.IP "\fB\-prexit\fR" 4 .IX Item "-prexit" print session information when the program exits. This will always attempt to print out information even if the connection fails. Normally information @@ -228,34 +219,34 @@ because a client certificate is required or is requested only after an attempt is made to access a certain \s-1URL\s0. Note: the output produced by this option is not always accurate because a connection might never have been established. -.Ip "\fB\-state\fR" 4 +.IP "\fB\-state\fR" 4 .IX Item "-state" prints out the \s-1SSL\s0 session states. -.Ip "\fB\-debug\fR" 4 +.IP "\fB\-debug\fR" 4 .IX Item "-debug" print extensive debugging information including a hex dump of all traffic. -.Ip "\fB\-msg\fR" 4 +.IP "\fB\-msg\fR" 4 .IX Item "-msg" show all protocol messages with hex dump. -.Ip "\fB\-nbio_test\fR" 4 +.IP "\fB\-nbio_test\fR" 4 .IX Item "-nbio_test" tests non-blocking I/O -.Ip "\fB\-nbio\fR" 4 +.IP "\fB\-nbio\fR" 4 .IX Item "-nbio" turns on non-blocking I/O -.Ip "\fB\-crlf\fR" 4 +.IP "\fB\-crlf\fR" 4 .IX Item "-crlf" this option translated a line feed from the terminal into \s-1CR+LF\s0 as required by some servers. -.Ip "\fB\-ign_eof\fR" 4 +.IP "\fB\-ign_eof\fR" 4 .IX Item "-ign_eof" inhibit shutting down the connection when end of file is reached in the input. -.Ip "\fB\-quiet\fR" 4 +.IP "\fB\-quiet\fR" 4 .IX Item "-quiet" inhibit printing of session and certificate information. This implicitly turns on \fB\-ign_eof\fR as well. -.Ip "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4 +.IP "\fB\-ssl2\fR, \fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR" 4 .IX Item "-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1" these options disable the use of certain \s-1SSL\s0 or \s-1TLS\s0 protocols. By default the initial handshake uses a method which should be compatible with all @@ -265,28 +256,33 @@ Unfortunately there are a lot of ancient and broken servers in use which cannot handle this technique and will fail to connect. Some servers only work if \s-1TLS\s0 is turned off with the \fB\-no_tls\fR option others will only support \s-1SSL\s0 v2 and may need the \fB\-ssl2\fR option. -.Ip "\fB\-bugs\fR" 4 +.IP "\fB\-bugs\fR" 4 .IX Item "-bugs" there are several known bug in \s-1SSL\s0 and \s-1TLS\s0 implementations. Adding this option enables various workarounds. -.Ip "\fB\-cipher cipherlist\fR" 4 +.IP "\fB\-cipher cipherlist\fR" 4 .IX Item "-cipher cipherlist" this allows the cipher list sent by the client to be modified. Although the server determines which cipher suite is used it should take the first supported cipher in the list sent by the client. See the \fBciphers\fR command for more information. -.Ip "\fB\-engine id\fR" 4 +.IP "\fB\-starttls protocol\fR" 4 +.IX Item "-starttls protocol" +send the protocol-specific message(s) to switch to \s-1TLS\s0 for communication. +\&\fBprotocol\fR is a keyword for the intended protocol. Currently, the only +supported keywords are \*(L"smtp\*(R" and \*(L"pop3\*(R". +.IP "\fB\-engine id\fR" 4 .IX Item "-engine id" specifying an engine (by it's unique \fBid\fR string) will cause \fBs_client\fR to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. -.Ip "\fB\-rand \f(BIfile\fB\|(s)\fR" 4 -.IX Item "-rand file" +.IP "\fB\-rand file(s)\fR" 4 +.IX Item "-rand file(s)" a file or files containing random data used to seed the random number -generator, or an \s-1EGD\s0 socket (see RAND_egd(3)). +generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)). Multiple files can be specified separated by a OS-dependent character. -The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for +The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for all others. .SH "CONNECTED COMMANDS" .IX Header "CONNECTED COMMANDS" @@ -304,12 +300,13 @@ server the command: .Vb 1 \& openssl s_client -connect servername:443 .Ve +.PP would typically be used (https uses port 443). If the connection succeeds then an \s-1HTTP\s0 command can be given such as \*(L"\s-1GET\s0 /\*(R" to retrieve a web page. .PP If the handshake fails then there are several possible causes, if it is nothing obvious like no client certificate then the \fB\-bugs\fR, \fB\-ssl2\fR, -\&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR can be tried +\&\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-no_ssl2\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR options can be tried in case it is a buggy server. In particular you should play with these options \fBbefore\fR submitting a bug report to an OpenSSL mailing list. .PP @@ -320,7 +317,7 @@ the clients certificate authority in its \*(L"acceptable \s-1CA\s0 list\*(R" whe requests a certificate. By using \fBs_client\fR the \s-1CA\s0 list can be viewed and checked. However some servers only request client authentication after a specific \s-1URL\s0 is requested. To obtain the list in this case it -is necessary to use the \fB\-prexit\fR command and send an \s-1HTTP\s0 request +is necessary to use the \fB\-prexit\fR option and send an \s-1HTTP\s0 request for an appropriate page. .PP If a certificate is specified on the command line using the \fB\-cert\fR @@ -344,4 +341,4 @@ The \fB\-prexit\fR option is a bit of a hack. We should really report information whenever a session is renegotiated. .SH "SEE ALSO" .IX Header "SEE ALSO" -sess_id(1), s_server(1), ciphers(1) +\&\fIsess_id\fR\|(1), \fIs_server\fR\|(1), \fIciphers\fR\|(1) |
