Интерфейс SaslClient

public interface SaslClient

Выполняет аутентификацию SASL в качестве клиента.

Библиотека протоколов, такая как библиотека для LDAP, получает экземпляр этого класса для выполнения аутентификации, определённой конкретным механизмом SASL. Вызов методов экземпляра SaslClient обрабатывает запросы и создаёт ответы в соответствии с механизмом SASL, реализованным SaslClient. По мере выполнения аутентификации экземпляр encapsulates состояние обмена аутентификацией SASL-клиента.

Вот пример, как библиотека LDAP может использовать SaslClient. Сначала она получает экземпляр SaslClient:


 SaslClient sc = Sasl.createSaslClient(mechanisms,
     authorizationId, protocol, serverName, props, callbackHandler);

Затем она может продолжить использование клиента для аутентификации. Например, библиотека LDAP может использовать клиент следующим образом:


 // Get initial response and send to server
 byte[] response = (sc.hasInitialResponse() ? sc.evaluateChallenge(new byte[0]) :
     null);
 LdapResult res = ldap.sendBindRequest(dn, sc.getName(), response);
 while (!sc.isComplete() &&
     (res.status == SASL_BIND_IN_PROGRESS || res.status == SUCCESS)) {
     response = sc.evaluateChallenge(res.getBytes());
     if (res.status == SUCCESS) {
         // we're done; don't expect to send another BIND
         if (response != null) {
             throw new SaslException(
                 "Protocol error: attempting to send response after completion");
         }
         break;
     }
     res = ldap.sendBindRequest(dn, sc.getName(), response);
 }
 if (sc.isComplete() && res.status == SUCCESS) {
    String qop = (String) sc.getNegotiatedProperty(Sasl.QOP);
    if (qop != null
        && (qop.equalsIgnoreCase("auth-int")
            || qop.equalsIgnoreCase("auth-conf"))) {

      // Use SaslClient.wrap() and SaslClient.unwrap() for future
      // communication with server
      ldap.in = new SecureInputStream(sc, ldap.in);
      ldap.out = new SecureOutputStream(sc, ldap.out);
    }
 }

Если механизм имеет начальный ответ, библиотека вызывает evaluateChallenge() с пустым запросом, чтобы получить начальный ответ. Протоколы, такие как IMAP4, которые не включают начальный ответ в первой команде аутентификации серверу, начинают аутентификацию без предварительного вызова hasInitialResponse() или evaluateChallenge(). Когда сервер отвечает на команду, он отправляет начальный запрос. Для механизма SASL, в котором клиент отправляет данные первым, сервер должен отправить запрос без данных. Это приведёт к вызову (на клиенте) evaluateChallenge() с пустым запросом.

Since:

1.5

See Also:

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

Модификатор и тип	Метод	Описание
`void`	`dispose()`	Освобождает системные ресурсы или конфиденциальную информацию, которые может использовать SaslClient.
`byte[]`	`evaluateChallenge(byte[] challenge)`	Оценивает данные запроса и генерирует ответ.
`String`	`getMechanismName()`	Возвращает имя механизма, зарегистрированного в IANA, для этого SASL-клиента.
`Object`	`getNegotiatedProperty(String propName)`	Получает переговорное свойство.
`boolean`	`hasInitialResponse()`	Определяет, имеет ли этот механизм необязательный начальный ответ.
`boolean`	`isComplete()`	Определяет, завершён ли обмен аутентификации.
`byte[]`	`unwrap(byte[] incoming, int offset, int len)`	Распаковывает массив байтов, полученный от сервера.
`byte[]`	`wrap(byte[] outgoing, int offset, int len)`	Запаковывает массив байтов, который будет отправлен на сервер.

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

getMechanismName

String getMechanismName()

Возвращает имя механизма, зарегистрированного в IANA, для этого SASL-клиента. (например, "CRAM-MD5", "GSSAPI").

Returns:: Непустая строка, представляющая имя механизма, зарегистрированного в IANA.

hasInitialResponse

boolean hasInitialResponse()

Определяет, имеет ли этот механизм необязательный начальный ответ. Если true, вызывающий должен вызвать evaluateChallenge() с пустым массивом, чтобы получить начальный ответ.

Returns:: true, если этот механизм имеет начальный ответ.

evaluateChallenge

byte[] evaluateChallenge(byte[] challenge) throws SaslException

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

Parameters:: challenge - Непустой запрос, отправленный сервером. Массив запроса может иметь нулевую длину.
Returns:: Возможный ответ, который нужно отправить серверу. Он равен null, если запрос сопровождался статусом "SUCCESS", и запрос содержит только данные для обновления состояния клиента, и ответ серверу отправлять не нужно. Ответ имеет нулевую длину, если клиент должен отправить ответ без данных.
Throws:: SaslException - Если произошла ошибка при обработке запроса или генерации ответа.

isComplete

boolean isComplete()

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

Returns:: true, если обмен аутентификации завершён; false в противном случае.

unwrap

byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException

Распаковывает массив байтов, полученный от сервера. Этот метод можно вызывать только после завершения обмена аутентификацией (т.е., когда isComplete() возвращает true) и только если обмен аутентификацией согласовал целостность и/или конфиденциальность в качестве качества защиты; в противном случае выбрасывается IllegalStateException.

incoming - содержимое буфера SASL, как определено в RFC 2222 без четырёх начальных байтов, представляющих длину. offset и len указывают на часть incoming, которую использовать.

Parameters:: incoming - Непустой массив байтов, содержащий закодированные байты с сервера.; offset - Начальная позиция в incoming байтов для использования.; len - Количество байтов с incoming для использования.
Returns:: Непустой массив байтов, содержащий декодированные байты.
Throws:: SaslException - если incoming не может быть успешно распакован.; IllegalStateException - если обмен аутентификацией не завершен, или если согласованное качество защиты не включает целостность и/или конфиденциальность.

wrap

byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException

Запаковывает массив байтов, который будет отправлен на сервер. Этот метод можно вызывать только после завершения обмена аутентификацией (т.е., когда isComplete() возвращает true) и только если обмен аутентификацией согласовал целостность и/или конфиденциальность в качестве качества защиты; в противном случае выбрасывается IllegalStateException.

Результат этого метода составит содержимое буфера SASL, как определено в RFC 2222 без четырёх начальных байтов, представляющих длину. offset и len указывают на часть outgoing, которую использовать.

Parameters:: outgoing - Непустой массив байтов, содержащий байты для кодирования.; offset - Начальная позиция в outgoing байтов для использования.; len - Количество байтов с outgoing для использования.
Returns:: Непустой массив байтов, содержащий закодированные байты.
Throws:: SaslException - если outgoing не может быть успешно упакован.; IllegalStateException - если обмен аутентификацией не завершен, или если согласованное качество защиты не включает целостность и/или конфиденциальность.

getNegotiatedProperty

Object getNegotiatedProperty(String propName)

Получает переговорное свойство. Этот метод можно вызывать только после завершения обмена аутентификацией (т.е., когда isComplete() возвращает true); в противном случае выбрасывается IllegalStateException.

Класс Sasl включает несколько известных имён свойств (например, Sasl.QOP). SASL-провайдер может поддерживать другие свойства, специфичные для производителя и/или механизма.

Parameters:: propName - Непустое имя свойства.
Returns:: Значение согласованного свойства. Если null, свойство не было согласовано или не применимо к этому механизму.
Throws:: IllegalStateException - если этот обмен аутентификацией не завершен

dispose

void dispose() throws SaslException

Освобождает любые системные ресурсы или конфиденциальную информацию, которые может использовать SaslClient. Вызов этого метода делает экземпляр SaslClient недействительным. Этот метод idempotent.

Throws:: SaslException - Если при освобождении ресурсов возникла проблема.

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.security.sasl/javax/security/sasl/SaslClient.html