Класс SSLContext

java.lang.Object

javax.net.ssl.SSLContext

public class SSLContext extends Object

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

Каждая реализация Java платформы обязана поддерживать следующие стандартные SSLContext протоколы:

TLSv1.2

Этот протокол описан в разделе SSLContext спецификации стандартных имён алгоритмов Java Security. Обратитесь к документации реализации для просмотра поддержки других протоколов.

Since:: 1.4

Краткое описание конструкторов

SSLContext(SSLContextSpi contextSpi,
 Provider provider,
 String protocol)

Модификатор	Конструктор	Описание
`protected`	Создаёт объект SSLContext.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final SSLEngine`	`createSSLEngine()`	Создаёт новый `SSLEngine` с использованием данного контекста.
`final SSLEngine`	`createSSLEngine(String peerHost, int peerPort)`	Создаёт новый `SSLEngine` с использованием данного контекста, используя консультативную информацию о peer.
`final SSLSessionContext`	`getClientSessionContext()`	Возвращает контекст сессии клиента, который представляет набор SSL сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне клиента.
`static SSLContext`	`getDefault()`	Возвращает стандартный SSL контекст.
`final SSLParameters`	`getDefaultSSLParameters()`	Возвращает копию SSLParameters, указывающую значения по умолчанию для данного SSL контекста.
`static SSLContext`	`getInstance(String protocol)`	Возвращает объект `SSLContext`, реализующий указанный протокол защищённого сокета.
`static SSLContext`	`getInstance(String protocol, String provider)`	Возвращает объект `SSLContext`, реализующий указанный протокол защищённого сокета.
`static SSLContext`	`getInstance(String protocol, Provider provider)`	Возвращает объект `SSLContext`, реализующий указанный протокол защищённого сокета.
`final String`	`getProtocol()`	Возвращает имя протокола данного объекта `SSLContext`.
`final Provider`	`getProvider()`	Возвращает поставщика данного объекта `SSLContext`.
`final SSLSessionContext`	`getServerSessionContext()`	Возвращает контекст сессии сервера, который представляет набор SSL сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне сервера.
`final SSLServerSocketFactory`	`getServerSocketFactory()`	Возвращает объект `ServerSocketFactory` для данного контекста.
`final SSLSocketFactory`	`getSocketFactory()`	Возвращает объект `SocketFactory` для данного контекста.
`final SSLParameters`	`getSupportedSSLParameters()`	Возвращает копию SSLParameters, указывающую поддерживаемые настройки для данного SSL контекста.
`final void`	`init(KeyManager[] km, TrustManager[] tm, SecureRandom random)`	Инициализирует данный контекст.
`static void`	`setDefault(SSLContext context)`	Устанавливает стандартный SSL контекст.

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

SSLContext

protected SSLContext(SSLContextSpi contextSpi, Provider provider, String protocol)

Создаёт объект SSLContext.

Параметры:: contextSpi - делегат; provider - поставщик; protocol - протокол

Подробное описание методов

getDefault

public static SSLContext getDefault() throws NoSuchAlgorithmException

Возвращает контекст SSL по умолчанию.

Если контекст по умолчанию был задан с помощью метода SSLContext.setDefault(), он возвращается. В противном случае, первый вызов этого метода вызывает SSLContext.getInstance("Default"). Если операция выполнена успешно, этот объект становится контекстом SSL по умолчанию и возвращается.

Контекст по умолчанию сразу готов к использованию и не требует инициализации.

Возвращает:: контекст SSL по умолчанию
Исключения:: NoSuchAlgorithmException - если вызов SSLContext.getInstance() завершился ошибкой
С:: 1.6

setDefault

public static void setDefault(SSLContext context)

Устанавливает контекст SSL по умолчанию. Он будет возвращаться последующими вызовами getDefault(). Контекст по умолчанию должен быть сразу готов к использованию и не требует инициализации.

Параметры:: context - контекст SSL
Исключения:: NullPointerException - если контекст null; SecurityException - если менеджер безопасности существует и его метод checkPermission не разрешает SSLPermission("setDefaultSSLContext")
С:: 1.6

getInstance

public static SSLContext getInstance(String protocol) throws NoSuchAlgorithmException

Возвращает объект SSLContext, реализующий указанный протокол безопасного сокета.

Этот метод перебирает список зарегистрированных поставщиков безопасности, начиная с наиболее предпочтительного. Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi из первого поставщика, поддерживающего указанный протокол.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Примечание реализации:

Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

protocol - стандартное имя запрошенного протокола. См. раздел SSLContext в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах протоколов.

Возвращает:

новый объект SSLContext

Исключения:

NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию Provider для указанного протокола

NullPointerException - если protocol равно null

См. также:

Provider

getInstance

public static SSLContext getInstance(String protocol, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

Возвращает объект SSLContext, реализующий указанный протокол безопасного сокета.

Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi от указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Параметры:

provider - имя поставщика.

Возвращает:

новый объект SSLContext

Исключения:

IllegalArgumentException - если имя поставщика null или пустое

NoSuchAlgorithmException - если реализация SSLContextSpi для указанного протокола недоступна от указанного поставщика

NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности

NullPointerException - если protocol равно null

См. также:

Provider

getInstance

public static SSLContext getInstance(String protocol, Provider provider) throws NoSuchAlgorithmException

Возвращает объект SSLContext, реализующий указанный протокол безопасного сокета.

Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi от указанного объекта поставщика. Обратите внимание, что указанный объект поставщика не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:

provider - экземпляр поставщика.

Возвращает:

новый объект SSLContext

Исключения:

IllegalArgumentException - если поставщик null

NoSuchAlgorithmException - если реализация SSLContextSpi для указанного протокола недоступна от указанного объекта Provider

NullPointerException - если protocol равно null

См. также:

Provider

getProtocol

public final String getProtocol()

Возвращает имя протокола этого объекта SSLContext.

Это то же самое имя, которое было указано в одном из вызовов getInstance, создавших этот объект SSLContext.

Возвращает:: имя протокола этого объекта SSLContext.

getProvider

public final Provider getProvider()

Возвращает поставщика этого объекта SSLContext.

Возвращает:: поставщика этого объекта SSLContext

init

public final void init(KeyManager[] km, TrustManager[] tm, SecureRandom random) throws KeyManagementException

Инициализирует этот контекст. Любой из первых двух параметров может быть null, в этом случае установленные поставщики безопасности будут искать реализацию наивысшего приоритета соответствующего фабричного метода. Аналогично, параметр secure random может быть null, в этом случае будет использоваться реализация по умолчанию.

Используется только первый экземпляр определённого типа менеджера ключей и/или доверия в массиве. (Например, будет использован только первый javax.net.ssl.X509KeyManager в массиве.)

Параметры:: km - источники ключей аутентификации или null; tm - источники решений доверия к проверке подлинности партнёров или null; random - источник случайности для этого генератора или null
Исключения:: KeyManagementException - если операция завершается ошибкой

getSocketFactory

public final SSLSocketFactory getSocketFactory()

Возвращает объект SocketFactory для этого контекста.

Возвращает:: объект SocketFactory
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, а метод init() не был вызван

getServerSocketFactory

public final SSLServerSocketFactory getServerSocketFactory()

Возвращает объект ServerSocketFactory для этого контекста.

Возвращает:: объект ServerSocketFactory
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, а метод init() не был вызван

createSSLEngine

public final SSLEngine createSSLEngine()

Создаёт новый SSLEngine с использованием данного контекста.

Приложения, использующие этот фабричный метод, не предоставляют подсказок для стратегии повторного использования внутренней сессии. Если требуются подсказки, следует использовать createSSLEngine(String, int) вместо этого.

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

Замечание по реализации:: От поставщика зависит, использует ли возвращаемый SSLEngine по умолчанию режим клиента или сервера для (D)TLS-соединения. Реализация поставщика JDK SunJSSE по умолчанию использует режим сервера. Однако рекомендуется всегда явно устанавливать требуемый режим, вызвав SSLEngine.setUseClientMode() перед вызовом других методов SSLEngine.
Возвращает:: объект SSLEngine
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, а init() не был вызван
С:: 1.5

createSSLEngine

public final SSLEngine createSSLEngine(String peerHost, int peerPort)

Создаёт новый SSLEngine с использованием данного контекста, используя консультативную информацию о партнёре.

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

Некоторые наборы шифров (например, Kerberos) требуют информацию о удалённом имени хоста, в этом случае peerHost необходимо указать.

Замечание по реализации:: От поставщика зависит, использует ли возвращаемый SSLEngine по умолчанию режим клиента или сервера для (D)TLS-соединения. Реализация поставщика JDK SunJSSE по умолчанию использует режим сервера. Однако рекомендуется всегда явно устанавливать требуемый режим, вызвав SSLEngine.setUseClientMode() перед вызовом других методов SSLEngine.
Параметры:: peerHost - неофициальное имя хоста; peerPort - неофициально указанный порт
Возвращает:: новый объект SSLEngine
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, а init() не был вызван
С:: 1.5

getServerSessionContext

public final SSLSessionContext getServerSessionContext()

Возвращает контекст сессии сервера, который представляет набор SSL-сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне сервера.

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

Возвращает:: контекст сессии сервера, привязанный к этому SSL-контексту

getClientSessionContext

public final SSLSessionContext getClientSessionContext()

Возвращает контекст сессии клиента, который представляет набор SSL-сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне клиента.

Возвращает:: контекст сессии клиента, привязанный к этому SSL-контексту

getDefaultSSLParameters

public final SSLParameters getDefaultSSLParameters()

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

Массивы ciphersuites и protocols всегда будут иметь значения, отличные от null.

Возвращает:: копию объекта SSLParameters с параметрами по умолчанию
Исключения:: UnsupportedOperationException - если параметры SSL по умолчанию получить не удалось.
С:: 1.6

getSupportedSSLParameters

public final SSLParameters getSupportedSSLParameters()

Возвращает копию SSLParameters, указывающую на поддерживаемые настройки для этого SSL-контекста.

Массивы ciphersuites и protocols всегда будут иметь значения, отличные от null.

Возвращает:: копию объекта SSLParameters с поддерживаемыми настройками
Исключения:: UnsupportedOperationException - если поддерживаемые параметры SSL получить не удалось.
С:: 1.6

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html