はじめのいっぽ  ページ一覧  更新履歴

s_client(1)

 
 =pod
 
 =head1 NAME

NAME

 s_client - SSL/TLS client program

s_client - SSL/TLSクライアントプログラム

 =head1 SYNOPSIS

SYNOPSIS

 B<openssl> B<s_client>
 [B<-connect> host:port>]
 [B<-verify depth>]
 [B<-cert filename>]
 [B<-key filename>]
 [B<-CApath directory>]
 [B<-CAfile filename>]
 [B<-reconnect>]
 [B<-pause>]
 [B<-showcerts>]
 [B<-debug>]
 [B<-msg>]
 [B<-nbio_test>]
 [B<-state>]
 [B<-nbio>]
 [B<-crlf>]
 [B<-ign_eof>]
 [B<-quiet>]
 [B<-ssl2>]
 [B<-ssl3>]
 [B<-tls1>]
 [B<-no_ssl2>]
 [B<-no_ssl3>]
 [B<-no_tls1>]
 [B<-bugs>]
 [B<-cipher cipherlist>]
 [B<-starttls protocol>]
 [B<-engine id>]
 [B<-rand file(s)>]
 =head1 DESCRIPTION

DESCRIPTION

 The B<s_client> command implements a generic SSL/TLS client which connects
 to a remote host using SSL/TLS. It is a I<very> useful diagnostic tool for
 SSL servers.

s_client コマンドは SSL/TLS を利用してリモートホストに接続するための、標準的なSSL/TLSクライアントである。SSLサーバの解析ツールとして非常に役立つ。

 =head1 OPTIONS

OPTIONS

 =over 4
 
 =item B<-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.

-connect host:port

これは、接続先のホスト名と必要であればポート番号を指定する。もしも指定されなければ、ローカルホストの4433番ポートへの接続を試みる。

 =item B<-cert certname>
 
 The certificate to use, if one is requested by the server. The default is
 not to use a certificate.

-cert certname

サーバからの要求があった場合に利用する証明書を指定する。デフォルトは証明書を利用しない。

 =item B<-key keyfile>
 
 The private key to use. If not specified then the certificate file will
 be used.

-key keyfile

利用する秘密鍵を指定する。指定されない場合、証明書ファイルが利用される。

 =item B<-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.

-verify depth

検証で利用する階層の深さを指定する。これは、サーバ証明書チェインの最大長を指定し、サーバ証明書の検証に利用する。現在、検証の操作はエラーが発生するまで続けられる。そのため、証明書チェインのすべての問題が見られる。副次効果として、証明書の検証の失敗が原因では接続は決して失敗しなくなる。

 =item B<-CApath directory>
 
 The directory to use for server certificate verification. This directory
 must be in "hash format", see B<verify> for more information. These are
 also used when building the client certificate chain.

-CApath directory

サーバ証明書の検証のために利用するディレクトリ。このディレクトリは「ハッシュフォーマット」でなければならない。詳細はverifyを参照のこと。これは、クライアントの証明書チェインを構築する際にも利用される。

 =item B<-CAfile file>
 
 A file containing trusted certificates to use during server authentication
 and to use when attempting to build the client certificate chain.

-CAfile file

サーバ認証およびクライアント証明書チェインの構築の際に利用する、信頼する証明書を含んだファイル。

 =item B<-reconnect>
 
 reconnects to the same server 5 times using the same session ID, this can
 be used as a test that session caching is working.

-reconnect

同じセッションIDを使って5回同一のサーバに再接続する。これは、セッションのキャッシュが有効になっているかテストするために利用される。

 =item B<-pause>
 
 pauses 1 second between each read and write call.

-pause

一回のread及びwriteコールの間に1秒ポーズする。

 =item B<-showcerts>
 
 display the whole server certificate chain: normally only the server
 certificate itself is displayed.

-showcerts

サーバ証明書チェイン全体を表示する。:通常はサーバ証明書自身のみが表示される。

 =item B<-prexit>
 
 print session information when the program exits. This will always attempt
 to print out information even if the connection fails. Normally information
 will only be printed out once if the connection succeeds. This option is useful
 because the cipher in use may be renegotiated or the connection may fail
 because a client certificate is required or is requested only after an
 attempt is made to access a certain URL. Note: the output produced by this
 option is not always accurate because a connection might never have been
 established.

-prexit

プログラムが存在する場合に、セッション情報を表示する。これはいつでも、接続に失敗しても情報の表示を試みる。通常、情報は接続に成功した場合のみ表示される。このオプションは、特定のURLに接続を試みた後にクライアント証明書が必要とされるか、あるいは要求され、利用されている暗号が再調整されるか、あるいは接続が失敗した場合に役立つ。注意: このオプションによる出力は、接続が一度も確立していないために大抵正確ではない。

 =item B<-state>
 
 prints out the SSL session states.

-state

SSLセッションのステータスを表示する。

 =item B<-debug>
 
 print extensive debugging information including a hex dump of all traffic.

-debug

すべてのトラフィックのダンプを含む、大量のデバッグ情報を表示する。

 =item B<-msg>
 
 show all protocol messages with hex dump.

-msg

ダンプを含む、すべてのプロトコルメッセージを表示する。

 =item B<-nbio_test>
 
 tests non-blocking I/O

-nbio_test

non-blocking I/O をテストする。

 =item B<-nbio>
 
 turns on non-blocking I/O

-nbio

non-blocking I/Oを有効にする。

 =item B<-crlf>
 
 this option translated a line feed from the terminal into CR+LF as required
 by some servers.

-crlf

このオプションは、ターミナルから送られる改行文字をCR+LFに変換する。一部のサーバで必要とされる。

 =item B<-ign_eof>
 
 inhibit shutting down the connection when end of file is reached in the
 input.

-ign_eof

入力時に end of file がある時に、接続の切断を抑制する。

 =item B<-quiet>
 
 inhibit printing of session and certificate information.  This implicitly
 turns on B<-ign_eof> as well.

-quiet

セッションと証明書情報の表示を抑制する。これは、-ign_eof が指定されると自動的に設定される。

 =item B<-ssl2>, B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1>
 
 these options disable the use of certain SSL or TLS protocols. By default
 the initial handshake uses a method which should be compatible with all
 servers and permit them to use SSL v3, SSL v2 or TLS as appropriate.
 
 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 TLS is turned off with the B<-no_tls> option others will only
 support SSL v2 and may need the B<-ssl2> option.

-ssl2, -ssl3, -tls1, -no_ssl2, -no_ssl3, -no_tls1

これらのオプションは特定の SSL あるいは TLS プロトコルでは利用できない。デフォルトで、initial handshake はすべてのサーバと互換性があるメソッドを利用する。必要に応じてSSL v3、 SSL v2 あるいは TLS の利用を許可する。

残念なことに、現在利用されている多くのサーバが古かったり壊れていたりするため、この方法ではハンドルできずに接続に失敗する。一部のサーバは TLS が-no_tlsオプションによって無効にされている場合のみ動作し、その他は SSL v2のみをサポートしているため -ssl2 オプションが必要となる。

 =item B<-bugs>
 
 there are several known bug in SSL and TLS implementations. Adding this
 option enables various workarounds.

-bugs

SSL 及び TLS の実装にはいくつかのバグが知られている。このオプションを追加することで、様々な対処が可能となる。

 =item B<-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 B<ciphers>
 command for more information.

-cipher cipherlist

これは、クライアントから送られた暗号リストの編集を許可する。サーバはどの暗号組合せを利用するかを決定できるけれども、それは、クライアントから送られたリストの最初にサポートされている暗号である必要がある。詳細はciphersコマンドを参照のこと。

 =item B<-starttls protocol>
 
 send the protocol-specific message(s) to switch to TLS for communication.
 B<protocol> is a keyword for the intended protocol.  Currently, the only
 supported keyword is "smtp".

-starttls protocol

接続の際に、TLS に移行するために必要なプロトコル特有のメッセージを送信する。protocol はプロトコルに依存したキーワードである。現在、サポートされているキーワードは「 smtp 」のみである。

 =item B<-engine id>
 
 specifying an engine (by it's unique B<id> string) will cause B<s_client>
 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.

-engine id

(固定の id 文字列で規定される) エンジンを指定した場合、 s_client はそのエンジンの機能の参照を試み、それに対応して必要であれば初期化を行なう。エンジンはすべての利用可能なアルゴリズムがデフォルトとして設定される。

 
 =item B<-rand file(s)>
 
 a file or files containing random data used to seed the random number
 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
 Multiple files can be specified separated by a OS-dependent character.
 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 all others.

-rand file(s)

乱数生成装置のシードとして利用する乱数データを含むファイル群、あるいは EGD ソケット (詳細は RAND_egd(3) 参照) を指定する。OS 毎に決まったキャラクタをセパレータとして利用することで、複数のファイルを指定可能である。セパレータは、MS-Windows の場合は ; 、VMS の場合は , その他は : を利用する。

 =back
 
 =head1 CONNECTED COMMANDS

CONNECTED COMMANDS

 If a connection is established with an SSL server then any data received
 from the server is displayed and any key presses will be sent to the
 server. When used interactively (which means neither B<-quiet> nor B<-ign_eof>
 have been given), the session will be renegotiated if the line begins with an
 B<R>, and if the line begins with a B<Q> or if end of file is reached, the
 connection will be closed down.

もしもSSLサーバとの接続が確立した場合、サーバから受け取ったデータはすべて表示され。すべてのキー入力がサーバに送られる。インタラクティブに利用する (つまり-quiet と -ign_eofのどちらも設定されていない) 時 、セッションは 「R」で始まる行でネゴシエーションをやりなおし、「Q」で始まる行、あるいはend of file が見つかったら接続は終了する。

 =head1 NOTES

NOTES

 B<s_client> can be used to debug SSL servers. To connect to an SSL HTTP
 server the command:
 
  openssl s_client -connect servername:443
 
 would typically be used (https uses port 443). If the connection succeeds
 then an HTTP command can be given such as "GET /" to retrieve a web page.

s_client はSSLサーバのデバッグに利用される。SSL HTTPサーバに接続するためのコマンド、

openssl s_client -connect servername:443

は、その典型的な例である (httpsのポートは443)。接続に成功した場合、webページを取得するために「GET /」などのHTTPSコマンドを利用できる。

 If the handshake fails then there are several possible causes, if it is
 nothing obvious like no client certificate then the B<-bugs>, B<-ssl2>,
 B<-ssl3>, B<-tls1>, B<-no_ssl2>, B<-no_ssl3>, B<-no_tls1> can be tried
 in case it is a buggy server. In particular you should play with these
 options B<before> submitting a bug report to an OpenSSL mailing list.

もしもハンドシェイクに失敗するのであれば、いくつかの可能性が考えられる。もしもクライアント証明書がないといったことがわかっていなければ、サーバに問題があることも想定して -bugs、-ssl2、 -ssl3、 -tls1、 -no_ssl2、 -no_ssl3、 -no_tls1 を試行できる。とりわけ、OpenSSLメーリングリストにバグレポートを「出す前に!」、これらのオプションを試すべきである。

 A frequent problem when attempting to get client certificates working
 is that a web client complains it has no certificates or gives an empty
 list to choose from. This is normally because the server is not sending
 the clients certificate authority in its "acceptable CA list" when it
 requests a certificate. By using B<s_client> the CA list can be viewed
 and checked. However some servers only request client authentication
 after a specific URL is requested. To obtain the list in this case it
 is necessary to use the B<-prexit> command and send an HTTP request
 for an appropriate page.

クライアント証明書の取得を試みる際の多くの問題は、証明書が存在しない、あるいは選択用のリストが空であると、web クライアントが文句を言うことである。これは通常、証明書が要求された時に、サーバが「信頼された認証局リスト (acceptable CA list) 」に掲載されている認証局で発行されたクライアント証明書を送っていないからである。s_clientを利用すれば、CAリストの確認ができる。しかし、いくつかのサーバは、特定のURLが要求された後、クライアント認証を要求する。このような場合にリストを表示するには、-prexitコマンドを利用し、適切なページにHTTPリクエストを送信する必要がある。

 If a certificate is specified on the command line using the B<-cert>
 option it will not be used unless the server specifically requests
 a client certificate. Therefor merely including a client certificate
 on the command line is no guarantee that the certificate works.

-cert オプションを使ってコマンドライン上で証明書が指定される場合、サーバが特に要求しない限り、クライアント証明書は利用されない。単にコマンドラインにクライアント証明書を含めても、証明書の動作について保証はない。

 If there are problems verifying a server certificate then the
 B<-showcerts> option can be used to show the whole chain.

もしもサーバ証明書の検証に問題があれば、-showcertsオプションを使ってチェイン全体を確認できる。

 =head1 BUGS

BUGS

 Because this program has a lot of options and also because some of
 the techniques used are rather old, the C source of s_client is rather
 hard to read and not a model of how things should be done. A typical
 SSL client program would be much simpler.

このプログラムは多くのオプションがあり、また一部で利用されているテクニックは古いものもあるため、s_clientのCソースは読み辛く、どのように作業をすべきかのモデルにはならない。標準的な SSL クライアントプログラムはもっと単純になるはずだ。

 The B<-verify> option should really exit if the server verification
 fails.

-verify オプションは、本当はサーバ検証に失敗したら終了すべきである。

 The B<-prexit> option is a bit of a hack. We should really report
 information whenever a session is renegotiated.

-prexit オプションはもう少しハックする。セッションがネゴシエートしなおす時は必ず情報をレポートすべきである。

 =head1 SEE ALSO

SEE ALSO

 L<sess_id(1)|sess_id(1)>, L<s_server(1)|s_server(1)>, L<ciphers(1)|ciphers(1)>

sess_id(1), s_server(1), ciphers(1)

 =cut