javax.net.ssl
クラス SSLSocket

java.lang.Object
  |
  +--java.net.Socket
        |
        +--javax.net.ssl.SSLSocket

public abstract class SSLSocket

extends Socket

このクラスは Socket を拡張し、Secure Sockets Layer (SSL) や IETF Transport Layer Security (TLS) などのプロトコルを使用するセキュアソケットを提供します。

これらのソケットは、通常のストリームソケットですが、TCP などの基本となるネットワークトランスポートプロトコル上にセキュリティ保護層を追加します。次のセキュリティ保護が行われます。

• 完全性の保護。 SSL がメッセージを盗聴による改ざんから保護する
• 認証。 ほとんどの SSL モードでは、ピア認証が提供される。通常は、サーバ認証が行われる。サーバからの要求に応じて、クライアント認証も行われる
• 機密性 (プライバシーの保護)。 ほとんどの SSL モードでは、クライアントとサーバ間で送信されるデータが暗号化され、データの機密性が保護される。この結果、受動盗聴によって、金融情報や個人情報などの機密性の高いデータが盗聴されることがない

これらのセキュリティ保護は、「符号化方式」を使用して指定します。符号化方式は、指定された SSL 接続で使用される暗号化アルゴリズムの組み合わせです。ネゴシエーションを行うには、2 つの終端が同じ符号化方式を選択し、その符号化方式が両方の環境で使用可能でなければなりません。共通の符号化方式がない場合は、SSL 接続を確立できず、データを交換できません。

使用される符号化方式は、「ハンドシェーク」と呼ばれるネゴシエーションプロセスによって確立されます。ハンドシェークでは、セッションの作成または参加が行われます。作成または参加したセッションは、無効になるまでさまざまな接続を保護します。ハンドシェークが完了すると、getSession メソッドを使用してセッション属性にアクセスできます。接続の最初のハンドシェークは、次のいずれかの方法で開始できます。

• startHandshake を呼び出し、ハンドシェークを明示的に開始する
• このソケットに対してアプリケーションデータの読み込みまたは書き込みを行うと、ハンドシェークが暗黙的に開始される
• getSession を呼び出すと、有効なセッションが現在存在しない場合はセッションが設定され、ハンドシェークが暗黙的に開始される

なんらかの理由でハンドシェークが失敗した場合、SSLSocket が閉じ、通信できなくなります。

符号化方式を使用するときは、2 つのグループについて理解する必要があります。

• サポートされている符号化方式。SSL 実装でサポートされるすべての符号化方式。このリストは、getSupportedCipherSuites を使用して報告される
• 使用可能な符号化方式。サポートされている符号化方式より少ないことがある。このグループは、setEnabledCipherSuites メソッドを使用して設定し、getEnabledCipherSuites メソッドを使用して照会する。新しいソケットでは、最小限の推奨構成を表すデフォルトの符号化方式が使用可能になっている。

デフォルトの実装で使用可能にする符号化方式では、サーバを認証し、機密性が保証されなければなりません。サーバ認証が行われず機密性が保証されない符号化方式を選択する場合は、サーバ認証が行われず非公開性が保証されない (暗号化されない) 通信が使用されることに 2 つの終端が明示的に同意する必要があります。

SSLSocket が最初に作成されるときには、ハンドシェークは行われません。このため、使用する符号化方式やソケットモード (クライアントモードまたはサーバモード) などの通信設定は、アプリケーションから行います。ただし、その接続を使用してアプリケーションデータを送信するときは、常にセキュリティが保証されます。

ハンドシェークの完了を示すイベント通知を受け取るように登録することもできます。これには、2 つのクラスを使用する必要があります。この API のユーザが HandshakeCompletedListener インスタンスを登録すると、HandshakeCompletedEvent オブジェクトがこのインスタンスに渡されます。SSLSocket は、SSLSocketFactory によって作成されるか、SSLServerSocket からの接続を accept したときに作成されます。

SSL ソケットの動作には、クライアントモードまたはサーバモードがあります。ハンドシェークプロセスを開始するピア、および各ピアから送信されるメッセージは、モードによって決まります。ただし、接続には、クライアントとサーバが 1 つずつ必要です。この要件を満たしていない場合は、ハンドシェークを正しく進行しません。

導入されたバージョン:

1.4

関連項目:

Socket, SSLServerSocket, SSLSocketFactory

コンストラクタの概要

protected	SSLSocket() サブクラスでだけ使用されます。
protected	SSLSocket(InetAddress address, int port) サブクラスでだけ使用されます。
protected	SSLSocket(InetAddress address, int port, InetAddress clientAddress, int clientPort) サブクラスでだけ使用されます。
protected	SSLSocket(String host, int port) サブクラスでだけ使用されます。
protected	SSLSocket(String host, int port, InetAddress clientAddress, int clientPort) サブクラスでだけ使用されます。

メソッドの概要

abstract void	addHandshakeCompletedListener(HandshakeCompletedListener listener) この接続の SSL ハンドシェークの完了通知を受け取るためのイベントリスナーを登録します。
abstract String[]	getEnabledCipherSuites() この接続で現在使用可能になっている SSL 符号化方式の名前を返します。
abstract String[]	getEnabledProtocols() この接続に対して現在使用可能になっているプロトコルの名前を返します。
abstract boolean	getEnableSessionCreation() このソケットで新しい SSL セッションを確立できる場合は true を返します。
abstract boolean	getNeedClientAuth() このソケットがクライアント認証を要求する場合は true を返します。
abstract SSLSession	getSession() この接続で使用されている SSL セッションを返します。
abstract String[]	getSupportedCipherSuites() この接続で使用可能にできる符号化方式の名前を返します。
abstract String[]	getSupportedProtocols() SSL 接続で使用可能にできるプロトコルの名前を返します。
abstract boolean	getUseClientMode() 最初のハンドシェークでクライアントモードを使用するようにソケットが設定されている場合は true
abstract boolean	getWantClientAuth() このソケットがクライアント認証を要求する場合は、true を返します。
abstract void	removeHandshakeCompletedListener(HandshakeCompletedListener listener) 以前に登録されたハンドシェーク完了リスナーを削除します。
abstract void	setEnabledCipherSuites(String[] suites) この接続に対して使用可能にする符号化方式を制御します。
abstract void	setEnabledProtocols(String[] protocols) この接続に対して使用可能にするプロトコルを制御します。
abstract void	setEnableSessionCreation(boolean flag) このソケットで新しい SSL セッションを確立できるかどうかを制御します。
abstract void	setNeedClientAuth(boolean need) クライアント認証を要求するようにソケットを設定します。
abstract void	setUseClientMode(boolean mode) 最初のハンドシェークでクライアント (またはサーバ) モードを使用するようにソケットを設定します。
abstract void	setWantClientAuth(boolean want) クライアント認証を要求するようにソケットを設定します。
abstract void	startHandshake() この接続上で SSL ハンドシェークを開始します。

クラス java.net.Socket から継承したメソッド

bind, close, connect, connect, getChannel, getInetAddress, getInputStream, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getOutputStream, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

SSLSocket

protected SSLSocket()

サブクラスでだけ使用されます。初期化されていない未接続の TCP ソケットを作成します。

SSLSocket

protected SSLSocket(String host,
                    int port)
             throws IOException,
                    UnknownHostException

サブクラスでだけ使用されます。指定されたポートの指名されたホストに対する TCP 接続を作成します。このソケットは、SSL クライアントとして動作します。

パラメータ:

host - 接続するホストの名前

port - サーバのポート番号

例外:

IOException - ソケットの生成中に入出力エラーが発生した場合

UnknownHostException - ホストが不明の場合

SSLSocket

protected SSLSocket(InetAddress address,
                    int port)
             throws IOException,
                    UnknownHostException

サブクラスでだけ使用されます。指定されたアドレスとポートのサーバに対する TCP 接続を作成します。このソケットは、SSL クライアントとして動作します。

パラメータ:

address - サーバのホスト

port - ポート

例外:

IOException - ソケットの生成中に入出力エラーが発生した場合

UnknownHostException - ホストが不明の場合

SSLSocket

protected SSLSocket(String host,
                    int port,
                    InetAddress clientAddress,
                    int clientPort)
             throws IOException,
                    UnknownHostException

サブクラスでだけ使用されます。指定されたポートの指名されたホストに対する SSL 接続を作成します。接続のクライアント側は、指定されたアドレスとポートにバインドされます。このソケットは、SSL クライアントとして動作します。

パラメータ:

host - 接続するホストの名前

port - サーバのポート番号

clientAddress - クライアントのホスト

clientPort - クライアントのポート番号

例外:

IOException - ソケットの生成中に入出力エラーが発生した場合

UnknownHostException - ホストが不明の場合

SSLSocket

protected SSLSocket(InetAddress address,
                    int port,
                    InetAddress clientAddress,
                    int clientPort)
             throws IOException,
                    UnknownHostException

サブクラスでだけ使用されます。指定されたアドレスと TCP ポートのサーバに対する SSL 接続を作成します。接続のクライアント側は、指定されたアドレスとポートにバインドされます。このソケットは、SSL クライアントとして動作します。

パラメータ:

address - サーバのホスト

port - ポート

clientAddress - クライアントのホスト

clientPort - クライアントのポート番号

例外:

IOException - ソケットの生成中に入出力エラーが発生した場合

UnknownHostException - ホストが不明の場合

メソッドの詳細

getSupportedCipherSuites

public abstract String[] getSupportedCipherSuites()

この接続で使用可能にできる符号化方式の名前を返します。通常は、これらの符号化方式の一部だけが、デフォルト実装で使用可能になります。一部の符号化方式は、デフォルト実装のサービス品質要件を満たしていないことがあるためです。これらの符号化方式は、特殊なアプリケーションで使用されます。

戻り値:

符号化方式名の配列

関連項目:

getEnabledCipherSuites(), setEnabledCipherSuites(String [])

getEnabledCipherSuites

public abstract String[] getEnabledCipherSuites()

この接続で現在使用可能になっている SSL 符号化方式の名前を返します。SSL ソケットが最初に作成されたときに、使用可能になっている符号化方式では、すべて最小限のサービス品質が保証されます。環境によっては、この値は空の場合もあります。

実際に使用する符号化方式は、要件に応じて適切に選択してください。たとえば、サーバソケットがなんらかの認証を要求するように設定されているときに、符号化方式で使用できる非公開鍵がサーバソケットに割り当てられていない場合、または符号化方式が匿名であるためクライアント認証を使用できない場合、それらの符号化方式は実際には使用できません。

戻り値:

符号化方式名の配列

関連項目:

getSupportedCipherSuites(), setEnabledCipherSuites(String [])

setEnabledCipherSuites

public abstract void setEnabledCipherSuites(String[] suites)

この接続に対して使用可能にする符号化方式を制御します。使用可能にする符号化方式は、getSupportedCipherSuites() から返される符号化方式のリストで使用可能になっていなければなりません。使用可能になっているときでも、ピアがその符号化方式をサポートしていなかったり、必要な証明書と非公開鍵を入手できなかったりする場合、その符号化方式は使用できません。

パラメータ:

suites - 使用可能にするすべての符号化方式の名前

例外:

IllegalArgumentException - パラメータに指定された符号化方式の一部がサポートされない場合、またはパラメータが null の場合

関連項目:

getSupportedCipherSuites(), getEnabledCipherSuites()

getSupportedProtocols

public abstract String[] getSupportedProtocols()

SSL 接続で使用可能にできるプロトコルの名前を返します。

戻り値:

サポートされているプロトコルの配列

getEnabledProtocols

public abstract String[] getEnabledProtocols()

この接続に対して現在使用可能になっているプロトコルの名前を返します。

戻り値:

プロトコルの配列

関連項目:

setEnabledProtocols(java.lang.String[])

setEnabledProtocols

public abstract void setEnabledProtocols(String[] protocols)

この接続に対して使用可能にするプロトコルを制御します。使用可能にするプロトコルは、getSupportedProtocols() から返されるプロトコルのリストで使用可能になっていなければなりません。

パラメータ:

protocols - 使用可能にするすべてのプロトコルの名前

例外:

IllegalArgumentException - パラメータに指定されたプロトコルの一部がサポートされない場合、またはパラメータが null の場合

関連項目:

getEnabledProtocols()

getSession

public abstract SSLSession getSession()

この接続で使用されている SSL セッションを返します。SSL セッションは有効期間が長く、ユーザによってはログインセッション全体に対応することもあります。セッションには、セッション内のすべての接続で使用される符号化方式と、セッションのクライアントとサーバの識別情報が指定されています。

このメソッドは、必要に応じて初期ハンドシェークを開始し、ハンドシェークが確立したときにブロックを解除します。

初期ハンドシェークでエラーが発生すると、無効なセッションオブジェクトが返され、「SSL_NULL_WITH_NULL_NULL」という無効な符号化方式が報告されます。

戻り値:

SSLSession

addHandshakeCompletedListener

public abstract void addHandshakeCompletedListener(HandshakeCompletedListener listener)

この接続の SSL ハンドシェークの完了通知を受け取るためのイベントリスナーを登録します。

パラメータ:

listener - HandShakeCompleted イベントリスナー

例外:

IllegalArgumentException - 引数が null の場合

関連項目:

startHandshake(), removeHandshakeCompletedListener(HandshakeCompletedListener)

removeHandshakeCompletedListener

public abstract void removeHandshakeCompletedListener(HandshakeCompletedListener listener)

以前に登録されたハンドシェーク完了リスナーを削除します。

パラメータ:

listener - HandShakeCompleted イベントリスナー

例外:

IllegalArgumentException - リスナーが登録されていない場合、または引数が null の場合

関連項目:

addHandshakeCompletedListener(HandshakeCompletedListener)

startHandshake

public abstract void startHandshake()
                             throws IOException

この接続上で SSL ハンドシェークを開始します。たとえば、新しい暗号化鍵を使用するとき、符号化方式を変更するとき、新しいセッションを開始するときなどに、SSL ハンドシェークを開始します。完全な再認証を強制的に実行するには、ハンドシェークを開始する前に、現在のセッションを無効にする必要があります。

この接続を介してデータがすでに送信されている場合、ハンドシェーク中も引き続きデータは送信されます。ハンドシェークが完了すると、イベントによって通知されます。このメソッドは、接続の初期ハンドシェークの場合は同期的に実行され、ネゴシエーションを行ったハンドシェークが完了したときに復帰します。一部のプロトコルでは、既存のソケットに対して複数のハンドシェークを実行できません。実行した場合は、IOException がスローされます。

例外:

IOException - ネットワークレベルのエラー

関連項目:

addHandshakeCompletedListener(HandshakeCompletedListener)

setUseClientMode

public abstract void setUseClientMode(boolean mode)

最初のハンドシェークでクライアント (またはサーバ) モードを使用するようにソケットを設定します。通常、サーバ認証は行いますが、クライアント認証は行う必要がありません。

パラメータ:

mode - 最初のハンドシェークをクライアントモードで開始する場合は true

例外:

IllegalArgumentException - ハンドシェークが開始したあとに、モードを変更しようとした場合

関連項目:

getUseClientMode()

getUseClientMode

public abstract boolean getUseClientMode()

最初のハンドシェークでクライアントモードを使用するようにソケットが設定されている場合は true

戻り値:

最初のハンドシェークをクライアントモードで開始する場合は true

関連項目:

setUseClientMode(boolean)

setNeedClientAuth

public abstract void setNeedClientAuth(boolean need)

クライアント認証を要求するようにソケットを設定します。このオプションは、サーバモードのソケットだけで使用できます。

setWantClientAuth(boolean) と異なり、クライアント認証情報を提供しない場合は、ネゴシエーションが停止し、接続が切断されます。

パラメータ:

need - クライアント認証が必要な場合は、true に設定する必要がある。このパラメータを true に設定すると、setWantClientAuth(boolean) の現在の設定がオーバーライドされる

関連項目:

getNeedClientAuth(), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)

getNeedClientAuth

public abstract boolean getNeedClientAuth()

このソケットがクライアント認証を要求する場合は true を返します。このオプションは、サーバモードのソケットだけで使用します。

戻り値:

サーバモードのソケットが、クライアント認証を要求する場合は true

関連項目:

setNeedClientAuth(boolean), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)

setWantClientAuth

public abstract void setWantClientAuth(boolean want)

クライアント認証を要求するようにソケットを設定します。ただし、ネゴシエーションに使用される符号化方式がクライアント認証が要求する場合だけです。このオプションは、サーバモードのソケットだけで使用します。setNeedClientAuth(boolean) は異なり、クライアント認証情報を提供しない場合でも、ネゴシエーションは続行します。

ソケットはサーバモードでなければなりません。

パラメータ:

want - クライアント認証が必要な場合は true に設定する必要がある。このパラメータを true に設定すると、setNeedClientAuth(boolean) の設定がオーバーライドされる

関連項目:

getWantClientAuth(), setNeedClientAuth(boolean), getNeedClientAuth(), setUseClientMode(boolean)

getWantClientAuth

public abstract boolean getWantClientAuth()

このソケットがクライアント認証を要求する場合は、true を返します。このオプションは、サーバモードのソケットだけで使用します。

戻り値:

サーバモードのソケットがクライアント認証を要求する場合は、true

関連項目:

setNeedClientAuth(boolean), getNeedClientAuth(), setWantClientAuth(boolean), setUseClientMode(boolean)

setEnableSessionCreation

public abstract void setEnableSessionCreation(boolean flag)

このソケットで新しい SSL セッションを確立できるかどうかを制御します。セッションを作成できず、再開できる既存のセッションがない場合、ハンドシェークは成功しません。

パラメータ:

flag - セッションを作成できる場合は true (デフォルト)。既存のセッションを再開する場合は false

関連項目:

getEnableSessionCreation()

getEnableSessionCreation

public abstract boolean getEnableSessionCreation()

このソケットで新しい SSL セッションを確立できる場合は true を返します。

戻り値:

セッションを作成できる場合は true (デフォルト)。既存のセッションを再開する場合は false

関連項目:

setEnableSessionCreation(boolean)