javax.net.ssl

Класс SSLSocket

java.lang. Объект

java.net. Сокет

javax.net.ssl. SSLSocket

Все Реализованные Интерфейсы:

Closeable, AutoCloseable

public abstract class SSLSocket
extends Socket

Этот класс расширяется Sockets и обеспечивает защищенный сокет, используя протоколы, такие как "Уровень защищенных сокетов" (SSL) или IETF "Безопасность Транспортного уровня" (TLS) протоколы.

Такие сокеты являются нормальными потоковыми сокетами, но они добавляют уровень средств обеспечения безопасности по базовому сетевому транспортному протоколу, таких как TCP. Те защиты включают:

• Защита целостности. SSL защищает от модификации сообщений активным wiretapper.
• Аутентификация. В большинстве режимов SSL обеспечивает равноправную аутентификацию. Серверы обычно аутентифицируются, и клиенты могут аутентифицироваться согласно просьбе серверами.
• Конфиденциальность (Защита конфиденциальности). В большинстве режимов SSL шифрует данные, отправляемые между клиентом и сервером. Это защищает конфиденциальность данных, так, чтобы пассивный wiretappers не видел уязвимых данных, таких как финансовая информация или персональные данные многих видов.

Эти виды защиты определяются "комплектом шифра", который является комбинацией криптографических алгоритмов, используемых данным соединением SSL. Во время процесса согласования эти две конечных точки должны договориться о ciphersuite, который доступен в обеих средах. Если нет такого комплекта вместе, никакое соединение SSL не может быть установлено, и никакие данные не могут быть переданы.

Используемый комплект шифра устанавливается процессом согласования, вызванным, "квитируя". Цель этого процесса состоит в том, чтобы создать или воссоединиться с "сеансом", который может защитить много соединений в течение долгого времени. После того, как квитирование завершилось, можно получить доступ к атрибутам сеанса при использовании getSession метода. Начальное квитирование на этом соединении может инициироваться одним из трех способов:

• вызов startHandshake который явно начинает квитирования, или
• любая попытка читать или записать данные приложения по этому сокету вызывает неявное квитирование, или
• звонок getSession делаются попытки установить сеанс, если нет никакого в настоящий момент допустимого сеанса, и неявного квитирования.

Квитируя сбои по любой причине, SSLSocket закрывается, и никакая futher связь не может быть сделана.

Есть две группы комплектов шифра, о которых Вы должны будете знать, управляя комплектами шифра:

• Поддерживаемые комплекты шифра: все комплекты, которые поддерживаются реализацией SSL. Об этом списке сообщают, используя getSupportedCipherSuites.
• Включенные комплекты шифра, которые могут быть меньше чем полный комплект поддерживаемых комплектов. Эта группа устанавливается, используя setEnabledCipherSuites метод, и запрашивала использование getEnabledCipherSuites метода. Первоначально, набор по умолчанию комплектов шифра будет включен на новом сокете, который представляет минимальную предложенную конфигурацию.

Значения по умолчанию реализации требуют, что только комплекты шифра, которые аутентифицируют серверы и обеспечивают конфиденциальность быть включенными по умолчанию. Только если обе стороны явно соглашаются на неаутентифицируемую и/или нечастную (незашифрованную) связь, будет такой ciphersuite быть выбранным.

Когда SSLSockets сначала создаются, никакое квитирование не делается так, чтобы приложения могли сначала установить свое коммуникационное предпочтение: какие комплекты шифра использовать, должен ли сокет быть в клиенте или режиме сервера и т.д. Однако, безопасность всегда обеспечивается к тому времени, когда данные приложения отправляются по соединению.

Можно зарегистрироваться, чтобы получить уведомление о событии завершения квитирования. Это включает использование двух дополнительных классов. Объекты HandshakeCompletedEvent передают к экземплярам HandshakeCompletedListener, которые регистрируются пользователями этого API. SSLSockets создаются SSLSocketFactorys, или acceptлуг соединение от a SSLServerSocket.

Сокет SSL должен хотеть работать в режиме сервера или клиенте. Это определит, кто начинает процесс квитирования, так же как какие сообщения должны быть отправлены каждой стороной. У каждого соединения должны быть один клиент и один сервер, или квитирование не будет прогрессировать должным образом. Как только начальное квитирование запустилось, сокет не может переключиться между режимами клиента и сервера, выполняя пересмотры.

С тех пор:

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() Возвращает true, если новые сеансы SSL могут быть установлены этим сокетом.
SSLSession	getHandshakeSession() Возвраты SSLSession будучи созданным во время квитирования SSL/TLS.
abstract boolean	getNeedClientAuth() Возвращает true, если сокет потребует аутентификации клиента.
abstract SSLSession	getSession() Возвращает Сеанс SSL в использовании этим соединением.
SSLParameters	getSSLParameters() Возвращает SSLParameters в действительности для этого SSLSocket.
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) Конфигурирует сокет, чтобы потребовать аутентификации клиента.
void	setSSLParameters(SSLParameters params) Применяет SSLParameters к этому сокету.
abstract void	setUseClientMode(boolean mode) Конфигурирует сокет, чтобы использовать клиент (или сервер) режим, квитируя.
abstract void	setWantClientAuth(boolean want) Конфигурирует сокет, чтобы запросить аутентификацию клиента.
abstract void	startHandshake() Запускает квитирование SSL на этом соединении.

Методы java.net унаследованный от класса. Сокет

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, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString

Методы java.lang унаследованный от класса. Объект

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.

Если есть менеджер безопасности, checkConnect метод вызывают с адресом узла и port как его параметры. Это могло привести к SecurityException.

Параметры:

host - имя узла, с которым можно соединиться, или null для петлевого адреса.

port - число порта сервера

Броски:

IOException - если ошибка ввода-вывода происходит, создавая сокет

SecurityException - если менеджер безопасности существует и checkConnect метод не позволяет работу.

UnknownHostException - если узел не известен

IllegalArgumentException - если параметр порта вне указанного диапазона допустимых значений порта, который является между 0 и 65535, включительно.

См. Также:

SecurityManager.checkConnect(java.lang.String, int)

SSLSocket

protected SSLSocket(InetAddress address,
         int port)
             throws IOException

Используемый только подклассами. Создает соединение TCP с сервером в указанном адресе и порту. Это действует как клиент SSL.

Если есть менеджер безопасности, checkConnect метод вызывают с адресом узла и port как его параметры. Это могло привести к SecurityException.

Параметры:

address - узел сервера

port - его порт

Броски:

IOException - если ошибка ввода-вывода происходит, создавая сокет

SecurityException - если менеджер безопасности существует и checkConnect метод не позволяет работу.

IllegalArgumentException - если параметр порта вне указанного диапазона допустимых значений порта, который является между 0 и 65535, включительно.

NullPointerException - если address нуль.

См. Также:

SecurityManager.checkConnect(java.lang.String, int)

SSLSocket

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

Используемый только подклассами. Создает соединение SSL с именованным узлом в указанном порту, связывая клиентскую сторону соединения данный адрес и порт. Это действует как клиент SSL.

Если есть менеджер безопасности, checkConnect метод вызывают с адресом узла и port как его параметры. Это могло привести к SecurityException.

Параметры:

host - имя узла, с которым можно соединиться, или null для петлевого адреса.

port - число порта сервера

clientAddress - адрес клиента сокет связывается с, или null для anyLocal адрес.

clientPort - порт клиента сокет связывается с, или zero для системы, выбранной франко-порт.

Броски:

IOException - если ошибка ввода-вывода происходит, создавая сокет

SecurityException - если менеджер безопасности существует и checkConnect метод не позволяет работу.

UnknownHostException - если узел не известен

IllegalArgumentException - если параметр порта или clientPort параметр вне указанного диапазона допустимых значений порта, который является между 0 и 65535, включительно.

См. Также:

SecurityManager.checkConnect(java.lang.String, int)

SSLSocket

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

Используемый только подклассами. Создает соединение SSL с сервером в указанном адресе и порту TCP, связывая клиентскую сторону соединения данный адрес и порт. Это действует как клиент SSL.

Если есть менеджер безопасности, checkConnect метод вызывают с адресом узла и port как его параметры. Это могло привести к SecurityException.

Параметры:

address - узел сервера

port - его порт

clientAddress - адрес клиента сокет связывается с, или null для anyLocal адрес.

clientPort - порт клиента сокет связывается с, или zero для системы, выбранной франко-порт.

Броски:

IOException - если ошибка ввода-вывода происходит, создавая сокет

SecurityException - если менеджер безопасности существует и checkConnect метод не позволяет работу.

IllegalArgumentException - если параметр порта или clientPort параметр вне указанного диапазона допустимых значений порта, который является между 0 и 65535, включительно.

NullPointerException - если address нуль.

См. Также:

SecurityManager.checkConnect(java.lang.String, int)

Деталь метода

getSupportedCipherSuites

public abstract String[] getSupportedCipherSuites()

Возвращает имена комплектов шифра, которые могли быть включены для использования на этом соединении. Обычно, только подмножество их будет фактически включено по умолчанию, так как этот список может включать комплекты шифра, которые не встречают качество требований службы для тех значений по умолчанию. Такие комплекты шифра могли бы быть полезными в специализированных приложениях.

Возвраты:

массив имен комплекта шифра

См. Также:

getEnabledCipherSuites(), setEnabledCipherSuites(String [])

getEnabledCipherSuites

public abstract String[] getEnabledCipherSuites()

Возвращает имена комплектов шифра SSL, которые в настоящий момент включаются для использования на этом соединении. Когда SSLSocket сначала создается, все включенные комплекты шифра поддерживают минимальное качество службы. Таким образом в некоторых средах это значение могло бы быть пустым.

Даже если комплект был включен, он никогда не мог бы использоваться. (Например, коллега не поддерживает это, необходимые сертификаты (и закрытые ключи) для комплекта не доступны, или анонимный комплект включается, но аутентификация требуется.

Возвраты:

массив имен комплекта шифра

См. Также:

getSupportedCipherSuites(), setEnabledCipherSuites(String [])

setEnabledCipherSuites

public abstract void setEnabledCipherSuites(String[] suites)

Устанавливает комплекты шифра, включенные для использования на этом соединении.

Каждый комплект шифра в suites параметр, должно быть, был перечислен getSupportedCipherSuites (), или метод перестанет работать. После успешного вызова к этому методу, только комплекты, перечисленные в suites параметр включается для использования.

См. getEnabledCipherSuites() для получения дополнительной информации о том, почему определенный ciphersuite никогда не может использоваться на соединении.

Параметры:

suites - Имена всех комплектов шифра, чтобы включить

Броски:

IllegalArgumentException - когда один или больше шифров, названных параметром, не поддерживается, или когда параметр является нулем.

См. Также:

getSupportedCipherSuites(), getEnabledCipherSuites()

getSupportedProtocols

public abstract String[] getSupportedProtocols()

Возвращает имена протоколов, которые могли быть включены для использования на соединении SSL.

Возвраты:

массив протоколов поддерживается

getEnabledProtocols

public abstract String[] getEnabledProtocols()

Возвращает имена версий протокола, которые в настоящий момент включаются для использования на этом соединении.

Возвраты:

массив протоколов

См. Также:

setEnabledProtocols(String [])

setEnabledProtocols

public abstract void setEnabledProtocols(String[] protocols)

Устанавливает версии протокола, включенные для использования на этом соединении.

Протоколы, должно быть, были перечислены getSupportedProtocols() как поддерживаемый. После успешного вызова к этому методу, только протоколы, перечисленные в protocols параметр включается для использования.

Параметры:

protocols - Имена всех протоколов, чтобы включить.

Броски:

IllegalArgumentException - когда один или больше протоколов, названных параметром, не поддерживается или когда параметр протоколов является нулем.

См. Также:

getEnabledProtocols()

getSession

public abstract SSLSession getSession()

Возвращает Сеанс SSL в использовании этим соединением. Они могут быть долговечными, и часто соответствовать всему сеансу входа в систему для некоторого пользователя. Сеанс определяет определенный комплект шифра, который активно используется всеми соединениями в том сеансе, так же как идентификационными данными клиента и сервера сеанса.

Этот метод будет инициировать начальное квитирование в случае необходимости и затем блокировать, пока квитирование не было установлено.

Если ошибка происходит во время начального квитирования, этот метод возвращает недопустимый объект сеанса, который сообщает о недопустимом комплекте шифра "SSL_NULL_WITH_NULL_NULL".

Возвраты:

SSLSession

getHandshakeSession

public SSLSession getHandshakeSession()

Возвраты SSLSession будучи созданным во время квитирования SSL/TLS.

Протоколы TLS могут согласовать параметры, которые необходимы при использовании экземпляра этого класса, но перед SSLSession был полностью инициализирован и сделан доступный через getSession. Например, список алгоритмов действительной подписи может ограничить тип сертификатов, которые могут используемый во время решений TrustManager, или максимальные пакетные размеры фрагмента TLS могут быть изменены, чтобы лучше поддерживать сетевую среду.

Этот метод обеспечивает ранний доступ к SSLSession быть созданным. В зависимости от того, как далеко прогрессировало квитирование, некоторые данные еще, возможно, не доступны для использования. Например, если удаленный сервер будет отправлять цепочку Сертификата, но что цепочка еще не была обработана, getPeerCertificates метод SSLSession бросит SSLPeerUnverifiedException. Как только та цепочка была обработана, getPeerCertificates возвратит собственное значение.

В отличие от этого getSession(), этот метод не инициирует начальное квитирование и не блокирует, пока квитирование не полно.

Возвраты:

нуль, если этот экземпляр в настоящий момент не квитирует, или если текущее квитирование не прогрессировало достаточно далеко, чтобы создать основной SSLSession. Иначе, этот метод возвращается SSLSession в настоящий момент быть согласованным.

Броски:

UnsupportedOperationException - если базовый провайдер не реализует работу.

С тех пор:

1.7

См. Также:

SSLEngine, SSLSession, ExtendedSSLSession, X509ExtendedKeyManager, X509ExtendedTrustManager

addHandshakeCompletedListener

public abstract void addHandshakeCompletedListener(HandshakeCompletedListener listener)

Регистрирует слушателя события, чтобы получить уведомления, что квитирование SSL завершилось на этом соединении.

Параметры:

listener - слушатель события HandShake Completed

Броски:

IllegalArgumentException - если параметром является нуль.

См. Также:

startHandshake(), removeHandshakeCompletedListener(HandshakeCompletedListener)

removeHandshakeCompletedListener

public abstract void removeHandshakeCompletedListener(HandshakeCompletedListener listener)

Удаляет ранее зарегистрированного слушателя завершения квитирования.

Параметры:

listener - слушатель события HandShake Completed

Броски:

IllegalArgumentException - если слушатель не регистрируется, или параметром является нуль.

См. Также:

addHandshakeCompletedListener(HandshakeCompletedListener)

startHandshake

public abstract void startHandshake()
                             throws IOException

Запускает квитирование SSL на этом соединении. Общие причины включают потребность использовать новые ключи шифрования, изменить комплекты шифра, или инициировать новый сеанс. Чтобы вызвать полную переаутентификацию, текущий сеанс мог быть лишен законной силы прежде, чем запустить это квитирование.

Если данные были уже отправлены на соединении, они продолжают течь во время этого квитирования. Когда квитирование завершится, это будет сообщено с событием. Этот метод синхронен для начального квитирования на соединении и возвращается, когда согласованное квитирование полно. Некоторые протоколы, возможно, не поддерживают многократные квитирования на существующем сокете и могут бросить IOException.

Броски:

IOException - на сетевой ошибке уровня

См. Также:

addHandshakeCompletedListener(HandshakeCompletedListener)

setUseClientMode

public abstract void setUseClientMode(boolean mode)

Конфигурирует сокет, чтобы использовать клиент (или сервер) режим, квитируя.

Этот метод нужно вызвать прежде, чем любое квитирование происходит. Как только квитирование началось, режим не может быть сброшен для жизни этого сокета.

Серверы обычно аутентифицируют себя, и клиенты не обязаны делать так.

Параметры:

mode - истина, если сокет должен запустить свое квитирование в "клиентском" режиме

Броски:

IllegalArgumentException - если изменение режима предпринимается после того, как начальное квитирование началось.

См. Также:

getUseClientMode()

getUseClientMode

public abstract boolean getUseClientMode()

Возвращает true, если сокет устанавливается использовать клиентский режим, квитируя.

Возвраты:

истина, если сокет должен сделать квитирование в "клиентском" режиме

См. Также:

setUseClientMode(boolean)

setNeedClientAuth

public abstract void setNeedClientAuth(boolean need)

Конфигурирует сокет, чтобы потребовать аутентификации клиента. Эта опция только полезна для сокетов в режиме сервера.

Установка аутентификации клиента сокета является одним из следующего:

• аутентификация клиента требуется
• аутентификацию клиента требуют
• никакая аутентификация клиента не требуется

В отличие от этого setWantClientAuth(boolean), если эта опция будет установлена, и клиент хочет не предоставлять информацию об аутентификации о себе, то согласования остановятся, и соединение будет отброшено.

Вызов этого метода переопределяет любую предыдущую установку, сделанную этим методом или setWantClientAuth(boolean).

Параметры:

need - набор к истине, если аутентификация клиента требуется, или ложь, если никакая аутентификация клиента не требуется.

См. Также:

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

getNeedClientAuth

public abstract boolean getNeedClientAuth()

Возвращает true, если сокет потребует аутентификации клиента. Эта опция только полезна для сокетов в режиме сервера.

Возвраты:

истина, если аутентификация клиента требуется, или ложь, если никакая аутентификация клиента не требуется.

См. Также:

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

setWantClientAuth

public abstract void setWantClientAuth(boolean want)

Конфигурирует сокет, чтобы запросить аутентификацию клиента. Эта опция только полезна для сокетов в режиме сервера.

Установка аутентификации клиента сокета является одним из следующего:

• аутентификация клиента требуется
• аутентификацию клиента требуют
• никакая аутентификация клиента не требуется

В отличие от этого setNeedClientAuth(boolean), если эта опция будет установлена, и клиент хочет не предоставлять информацию об аутентификации о себе, то согласования будут продолжаться.

Вызов этого метода переопределяет любую предыдущую установку, сделанную этим методом или setNeedClientAuth(boolean).

Параметры:

want - набор к истине, если аутентификацию клиента требуют, или ложь, если никакая аутентификация клиента не требуется.

См. Также:

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

getWantClientAuth

public abstract boolean getWantClientAuth()

Возвращает true, если сокет запросит аутентификацию клиента. Эта опция только полезна для сокетов в режиме сервера.

Возвраты:

истина, если аутентификацию клиента требуют, или ложь, если никакая аутентификация клиента не требуется.

См. Также:

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

setEnableSessionCreation

public abstract void setEnableSessionCreation(boolean flag)

Средства управления, могут ли новые сеансы SSL быть установлены этим сокетом. Если создания сеанса не позволяются, и нет никаких существующих сеансов, чтобы возобновиться, не будет никакого успешного квитирования.

Параметры:

flag - истина указывает, что сеансы могут быть созданы; это - значение по умолчанию. ложь указывает, что должен быть возобновлен существующий сеанс

См. Также:

getEnableSessionCreation()

getEnableSessionCreation

public abstract boolean getEnableSessionCreation()

Возвращает true, если новые сеансы SSL могут быть установлены этим сокетом.

Возвраты:

истина указывает, что сеансы могут быть созданы; это - значение по умолчанию. ложь указывает, что должен быть возобновлен существующий сеанс

См. Также:

setEnableSessionCreation(boolean)

getSSLParameters

public SSLParameters getSSLParameters()

Возвращает SSLParameters в действительности для этого SSLSocket. ciphersuites и протоколы возвращенного SSLParameters всегда являются ненулем.

Возвраты:

SSLParameters в действительности для этого SSLSocket.

С тех пор:

1.6

setSSLParameters

public void setSSLParameters(SSLParameters params)

Применяет SSLParameters к этому сокету.

Это означает:

• если params.getCipherSuites() ненуль, setEnabledCipherSuites() вызывается с тем значением
• если params.getProtocols() ненуль, setEnabledProtocols() вызывается с тем значением
• если params.getNeedClientAuth() или params.getWantClientAuth() возвратиться true, setNeedClientAuth(true) и setWantClientAuth(true) вызываются, соответственно; иначе setWantClientAuth(false) вызывается.

Параметры:

params - параметры

Броски:

IllegalArgumentException - если setEnabledCipherSuites () или setEnabledProtocols () вызывают сбои

С тех пор:

1.6