Класс SSLParameters

Оборачивает параметры для подключения SSL/TLS. Параметры включают список поддерживаемых наборов шифрования в рукопожатии SSL/TLS, список разрешенных протоколов, алгоритм идентификации конечной точки во время рукопожатия SSL/TLS, указание имени сервера (SNI), ограничения алгоритмов и то, должны ли серверы SSL/TLS запрашивать или требовать аутентификацию клиента и т.д.

SSLParameters можно создать с помощью конструкторов в этом классе. Объекты также можно получить, используя методы getSSLParameters() в SSLSocket и SSLServerSocket и SSLEngine, или методы getDefaultSSLParameters() и getSupportedSSLParameters() в SSLContext.

SSLParameters можно применить к подключению через методы SSLSocket.setSSLParameters() и SSLServerSocket.setSSLParameters() и SSLEngine.setSSLParameters().

Например:

SSLParameters p = sslSocket.getSSLParameters();
p.setProtocols(new String[] { "TLSv1.2" });
p.setCipherSuites(
    new String[] { "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", ... });
p.setApplicationProtocols(new String[] {"h2", "http/1.1"});
sslSocket.setSSLParameters(p);

Конструкторы

SSLParameters

public SSLParameters()

SSLParameters

public SSLParameters(String[] cipherSuites)

Параметры:

cipherSuites - массив наборов шифров (или null)

SSLParameters

public SSLParameters(String[] cipherSuites,
                     String[] protocols)

Параметры:

cipherSuites - массив наборов шифров (или null)

protocols - массив протоколов (или null)

Методы

getCipherSuites

public String[] getCipherSuites()

Возвращает копию массива наборов шифров или null, если они не были заданы.

Возвращает:

копию массива наборов шифров или null, если они не были заданы.

setCipherSuites

public void setCipherSuites(String[] cipherSuites)

Устанавливает массив наборов шифров.

Параметры:

cipherSuites - массив наборов шифров (или null)

getProtocols

public String[] getProtocols()

Возвращает копию массива протоколов или null, если они не были заданы.

Возвращает:

копию массива протоколов или null, если они не были заданы.

setProtocols

public void setProtocols(String[] protocols)

Устанавливает массив протоколов.

Параметры:

protocols - массив протоколов (или null)

getWantClientAuth

public boolean getWantClientAuth()

Возвращает, требуется ли аутентификация клиента.

Возвращает:

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

setWantClientAuth

public void setWantClientAuth(boolean wantClientAuth)

Устанавливает, требуется ли аутентификация клиента. Вызов этого метода очищает флаг needClientAuth.

Параметры:

wantClientAuth - требуется ли аутентификация клиента

getNeedClientAuth

public boolean getNeedClientAuth()

Возвращает, обязательна ли аутентификация клиента.

Возвращает:

обязательна ли аутентификация клиента.

setNeedClientAuth

public void setNeedClientAuth(boolean needClientAuth)

Устанавливает, обязательна ли аутентификация клиента. Вызов этого метода очищает флаг wantClientAuth.

Параметры:

needClientAuth - обязательна ли аутентификация клиента

getAlgorithmConstraints

public AlgorithmConstraints getAlgorithmConstraints()

Возвращает ограничения криптографических алгоритмов.

Возвращает:

ограничения криптографических алгоритмов или null, если ограничения не были установлены

С:

1.7

См. также:

setAlgorithmConstraints(AlgorithmConstraints)

setAlgorithmConstraints

public void setAlgorithmConstraints(AlgorithmConstraints constraints)

Параметры:

constraints - ограничения алгоритмов (или null)

С:

1.7

getEndpointIdentificationAlgorithm

public String getEndpointIdentificationAlgorithm()

Получает алгоритм идентификации конечной точки.

Возвращает:

алгоритм идентификации конечной точки или null, если он не был задан.

С:

1.7

См. также:

X509ExtendedTrustManager, setEndpointIdentificationAlgorithm(String)

setEndpointIdentificationAlgorithm

public void setEndpointIdentificationAlgorithm(String algorithm)

Параметры:

algorithm - Стандартное строковое имя алгоритма идентификации конечной точки (или null). См. Приложение А в Спецификации и справке API архитектуры Java Cryptography для получения информации о стандартных именах алгоритмов.

С:

1.7

См. также:

X509ExtendedTrustManager

setServerNames

public final void setServerNames(List<SNIServerName> serverNames)

Параметры:

serverNames - список требуемых SNIServerName (или null)

Исключения:

NullPointerException - если serverNames содержит null элемент

IllegalArgumentException - если serverNames содержит более одного имени одного типа

С:

1.8

См. также:

SNIServerName, getServerNames()

getServerNames

public final List<SNIServerName> getServerNames()

Socket socket =
         sslSocketFactory.createSocket("www.example.com", 443);

SSLEngine engine =
         sslContext.createSSLEngine("www.example.com", 443);

Возвращает:

null или неизменяемый список ненулевых SNIServerName

С:

1.8

См. также:

List, setServerNames(List)

setSNIMatchers

public final void setSNIMatchers(Collection<SNIMatcher> matchers)

Параметры:

matchers - коллекция SNIMatcher (или null)

Исключения:

NullPointerException - если matchers содержит null элемент

IllegalArgumentException - если matchers содержит более одного имени одного типа

С:

1.8

См. также:

Collection, SNIMatcher, getSNIMatchers()

getSNIMatchers

public final Collection<SNIMatcher> getSNIMatchers()

Возвращает:

null или неизменяемая коллекция ненулевых SNIMatcher

С:

1.8

См. также:

SNIMatcher, setSNIMatchers(Collection)

setUseCipherSuitesOrder

public final void setUseCipherSuitesOrder(boolean honorOrder)

Устанавливает, должны ли быть учтены предпочтения локальных наборов шифров.

Параметры:

honorOrder - должны ли быть учтены предпочтения локальных наборов шифров в #getCipherSuites во время рукопожатия SSL/TLS.

С:

1.8

См. также:

getUseCipherSuitesOrder()

getUseCipherSuitesOrder

public final boolean getUseCipherSuitesOrder()

Возвращает, должны ли быть учтены предпочтения локальных наборов шифров.

Возвращает:

должны ли быть учтены предпочтения локальных наборов шифров в #getCipherSuites во время рукопожатия SSL/TLS.

С:

1.8

См. также:

setUseCipherSuitesOrder(boolean)

getApplicationProtocols

public String[] getApplicationProtocols()

Возвращает:

не нулевой, возможно, пустой массив имён прикладных протоколов. Массив упорядочен по предпочтению протоколов, при этом protocols[0] имеет наивысший приоритет.

Since:

8

См. также:

setApplicationProtocols(java.lang.String[])

setApplicationProtocols

public void setApplicationProtocols(String[] protocols)

Требования к реализации:

Этот метод создаст копию массива protocols.

Параметры:

protocols - упорядоченный массив протоколов прикладного уровня, где protocols[0] имеет наивысший приоритет. Если массив пустой (нулевой длины), указания протоколов не будут использоваться.

Исключение:

IllegalArgumentException - если protocols равен null или если какой-либо элемент в непустом массиве равен null или является пустой (нулевой длины) строкой

Since:

8

См. также:

getApplicationProtocols()