javax.net.ssl
クラス SSLServerSocket

java.lang.Object
  java.net.ServerSocket
      javax.net.ssl.SSLServerSocket

public abstract class SSLServerSocket
extends ServerSocket

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

このクラスのインスタンスを作成するときは、通常、SSLServerSocketFactory を使用します。SSLServerSocket は、接続を accept して SSLSocket を作成します。

SSLServerSocket の一部の状態データは、作成される SSLSocket に継承されます。たとえば、有効になっている暗号化方式群とプロトコル、クライアント認証が必要かどうか、このソケットがハンドシェークを開始するときのモード (クライアントモードまたはサーバーモード)、などの情報が継承されます。作成された SSLSocket に継承された状態は、対応するメソッドを呼び出してオーバーライドできます。

導入されたバージョン:

1.4

関連項目:

ServerSocket, SSLSocket

コンストラクタの概要

protected	SSLServerSocket() サブクラスでだけ使用されます。
protected	SSLServerSocket(int port) サブクラスでだけ使用されます。
protected	SSLServerSocket(int port, int backlog) サブクラスでだけ使用されます。
protected	SSLServerSocket(int port, int backlog, InetAddress address) サブクラスでだけ使用されます。

メソッドの概要

abstract String[]	getEnabledCipherSuites() 新しく受け入れた接続で現在使用可能になっている暗号化方式群のリストを返します。
abstract String[]	getEnabledProtocols() 新しく受け入れた接続で現在使用可能になっているプロトコル名を返します。
abstract boolean	getEnableSessionCreation() このサーバーソケットから作成されたソケットで、新しい SSL セッションを確立する場合は true を返します。
abstract boolean	getNeedClientAuth() 新しく accept したサーバーモードの SSLSocket 上でクライアント認証が「必須」の場合、true を返します。
abstract String[]	getSupportedCipherSuites() SSL 接続で使用可能にできる暗号化方式群の名前を返します。
abstract String[]	getSupportedProtocols() 使用可能にできるプロトコルの名前を返します。
abstract boolean	getUseClientMode() 受け入れた接続が SSL クライアントモードになる場合は true を返します。
abstract boolean	getWantClientAuth() 新しく受け入れたサーバーモードの接続上でクライアント認証が「要求」される場合、true を返します。
abstract void	setEnabledCipherSuites(String[] suites) 受け入れられた接続で使用可能な暗号化方式群を設定します。
abstract void	setEnabledProtocols(String[] protocols) 受け入れた接続で使用可能なプロトコルを制御します。
abstract void	setEnableSessionCreation(boolean flag) このサーバーソケットから作成されたソケットで、新しい SSL セッションを確立すかどうかを制御します。
abstract void	setNeedClientAuth(boolean need) 受け入れたサーバーモードの SSLSockets で、クライアント認証が「必須」とされるように初期設定するかどうかを制御します。
abstract void	setUseClientMode(boolean mode) 受け入れた接続がデフォルトで SSL サーバーモードになるか、SSL クライアントモードになるかを制御します。
abstract void	setWantClientAuth(boolean want) 受け入れたサーバーモードの SSLSockets が、クライアント認証を「要求」するように初期設定するかどうかを制御します。

クラス java.net.ServerSocket から継承されたメソッド

accept, bind, bind, close, getChannel, getInetAddress, getLocalPort, getLocalSocketAddress, getReceiveBufferSize, getReuseAddress, getSoTimeout, implAccept, isBound, isClosed, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSocketFactory, setSoTimeout, toString

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

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

コンストラクタの詳細

SSLServerSocket

protected SSLServerSocket()
                   throws IOException

サブクラスでだけ使用されます。

デフォルトの認証コンテキストを使用して、バインドされていない TCP サーバーソケットを作成します。

例外:

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

SSLServerSocket

protected SSLServerSocket(int port)
                   throws IOException

サブクラスでだけ使用されます。

デフォルトの認証コンテキストを使用して、ポート上に TCP サーバーソケットを作成します。キューに格納される接続バックログの最大数は、デフォルトで 50 に設定されています。 キュー内の接続要求が最大数を超えると、新しい接続要求は拒否されます。

パラメータ:

port - 待機するポート

例外:

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

SSLServerSocket

protected SSLServerSocket(int port,
                          int backlog)
                   throws IOException

サブクラスでだけ使用されます。

デフォルトの認証コンテキストと、指定された接続バックログを使用して、ポート上に TCP サーバーソケットを作成します。

パラメータ:

port - 待機するポート

backlog - 最大保留接続数。 この接続数を超えると、新しい要求が拒否される

例外:

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

SSLServerSocket

protected SSLServerSocket(int port,
                          int backlog,
                          InetAddress address)
                   throws IOException

サブクラスでだけ使用されます。

デフォルトの認証コンテキスト、指定された接続バックログ、および指定されたネットワークインタフェースを使用して、ポート上に TCP サーバーソケットを作成します。このコンストラクタは、ファイアウォールやルータとして使用されるマルチホームホスト上で使用され、ネットワークサービスを提供するインタフェースを制御します。

パラメータ:

port - 待機するポート

backlog - 最大保留接続数。 この接続数を超えると、新しい要求が拒否される

address - 接続を受け入れるネットワークインタフェースのアドレス

例外:

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

メソッドの詳細

getEnabledCipherSuites

public abstract String[] getEnabledCipherSuites()

新しく受け入れた接続で現在使用可能になっている暗号化方式群のリストを返します。

このリストが明示的に変更されていない場合は、システムデフォルトにより、使用可能なすべての暗号化方式群で、最小限のサービス品質が保証されます。

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

戻り値:

使用可能な暗号化方式群の配列

関連項目:

getSupportedCipherSuites(), setEnabledCipherSuites(String [])

setEnabledCipherSuites

public abstract void setEnabledCipherSuites(String[] suites)

受け入れられた接続で使用可能な暗号化方式群を設定します。

暗号化方式群は、getSupportedCipherSuites() により、サポート対象としてリストされていなければいけません。このメソッドの呼び出しが正常に行われたとき、suites パラメータにリストされた暗号化方式群のみ、使用することができます。

この ServerSocket の認証コンテキストで使用できない認証情報を要求する暗号化方式群は、たとえ有効になっていても使用されません。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:

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

例外:

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

関連項目:

getSupportedCipherSuites(), getEnabledCipherSuites()

getSupportedCipherSuites

public abstract String[] getSupportedCipherSuites()

SSL 接続で使用可能にできる暗号化方式群の名前を返します。

通常は、その一部だけがデフォルトで使用可能になります。 デフォルトのサービス品質要件を満たしていない暗号化方式群は、使用不可になります。それらの暗号化方式群は、特殊なアプリケーションで使用します。

戻り値:

暗号化方式群名の配列

関連項目:

getEnabledCipherSuites(), setEnabledCipherSuites(String [])

getSupportedProtocols

public abstract String[] getSupportedProtocols()

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

戻り値:

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

関連項目:

getEnabledProtocols(), setEnabledProtocols(String [])

getEnabledProtocols

public abstract String[] getEnabledProtocols()

新しく受け入れた接続で現在使用可能になっているプロトコル名を返します。

戻り値:

プロトコル名の配列

関連項目:

getSupportedProtocols(), setEnabledProtocols(String [])

setEnabledProtocols

public abstract void setEnabledProtocols(String[] protocols)

受け入れた接続で使用可能なプロトコルを制御します。

プロトコルは、getSupportedProtocols() により、サポート対象としてリストされていなければいけません。このメソッドの呼び出しが正常に行われたとき、protocols パラメータにリストされたプロトコルのみ、使用することができます。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:

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

例外:

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

関連項目:

getEnabledProtocols(), getSupportedProtocols()

setNeedClientAuth

public abstract void setNeedClientAuth(boolean need)

受け入れたサーバーモードの SSLSockets で、クライアント認証が「必須」とされるように初期設定するかどうかを制御します。

ソケットのクライアント認証設定は、次のいずれかになります。

• クライアント認証を必須にする
• クライアント認証を要求する
• クライアント認証を不要にする

setWantClientAuth(boolean) と異なり、受け入れたソケットのオプションが設定されていて、かつクライアント認証情報が提供されない場合は、ネゴシエーションが停止し、接続が切断されます。

このメソッドを呼び出すと、これまでにこのメソッドまたは setWantClientAuth(boolean) によって設定された内容がオーバーライドされます。

SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すと、継承された初期設定がオーバーライドされます。

パラメータ:

need - クライアント認証が必須の場合は true、クライアント認証が不要な場合は false

関連項目:

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

getNeedClientAuth

public abstract boolean getNeedClientAuth()

新しく accept したサーバーモードの SSLSocket 上でクライアント認証が「必須」の場合、true を返します。

SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すと、継承された初期設定がオーバーライドされます。

戻り値:

クライアント認証が必須の場合は true、クライアント認証が不要な場合は false

関連項目:

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

setWantClientAuth

public abstract void setWantClientAuth(boolean want)

受け入れたサーバーモードの SSLSockets が、クライアント認証を「要求」するように初期設定するかどうかを制御します。

ソケットのクライアント認証設定は、次のいずれかになります。

• クライアント認証を必須にする
• クライアント認証を要求する
• クライアント認証を不要にする

setNeedClientAuth(boolean) と異なり、受け入れたソケットのオプションが設定されていて、かつクライアント認証情報が提供されない場合でも、ネゴシエーションは続行されます。

このメソッドを呼び出すと、これまでにこのメソッドまたは setNeedClientAuth(boolean) によって設定された内容がオーバーライドされます。

SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すと、継承された初期設定がオーバーライドされます。

パラメータ:

want - クライアント認証が要求された場合は true、クライアント認証が不要な場合は false

関連項目:

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

getWantClientAuth

public abstract boolean getWantClientAuth()

新しく受け入れたサーバーモードの接続上でクライアント認証が「要求」される場合、true を返します。

SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すと、継承された初期設定がオーバーライドされます。

戻り値:

クライアント認証が要求された場合は true、クライアント認証が不要な場合は false

関連項目:

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

setUseClientMode

public abstract void setUseClientMode(boolean mode)

受け入れた接続がデフォルトで SSL サーバーモードになるか、SSL クライアントモードになるかを制御します。

通常、サーバーは自身を認証しますが、クライアントは必ずしもそうとは限りません。

新しく受け入れた接続が、SSL クライアントモードの TCP サーバーを要求することがあります。たとえば、FTP クライアントは、サーバーソケットを取得すると、そのソケット上でサーバーからの接続を待機します。FTP クライアントは、サーバーからの接続を受け入れるときに、クライアントモードの SSLServerSocket を使用します。 FTP サーバーは、接続を開始するときにクライアントモードを無効にした SSLSocket を使用します。この場合、ハンドシェークを行うときは、既存の SSL セッションが再利用されます。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:

mode - 新しく受け入れた接続が SSL クライアントモードを使用する場合は true

関連項目:

getUseClientMode()

getUseClientMode

public abstract boolean getUseClientMode()

受け入れた接続が SSL クライアントモードになる場合は true を返します。

戻り値:

接続が SSL クライアントモードを使用する場合は true。

関連項目:

setUseClientMode(boolean)

setEnableSessionCreation

public abstract void setEnableSessionCreation(boolean flag)

このサーバーソケットから作成されたソケットで、新しい SSL セッションを確立すかどうかを制御します。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:

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

関連項目:

getEnableSessionCreation()

getEnableSessionCreation

public abstract boolean getEnableSessionCreation()

このサーバーソケットから作成されたソケットで、新しい SSL セッションを確立する場合は true を返します。

戻り値:

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

関連項目:

setEnableSessionCreation(boolean)