compact3

javax.security.sasl

Интерфейс SaslClient

public interface SaslClient

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

Библиотека протокола такой как один для LDAP приводит экземпляр в порядок этого class, чтобы выполнить аутентификацию, определенную определенным механизмом SASL. Вызов методов на экземпляре SaslClient обрабатывает проблемы и создает ответы согласно механизму SASL, реализованному SaslClient. Поскольку аутентификация продолжается, экземпляр инкапсулирует состояние обмена аутентификации клиента 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() с пустой проблемой.

С тех пор:

1.5

См. Также:

Sasl, SaslClientFactory

Сводка метода

Модификатор и Тип	Метод и Описание
void	dispose() Избавляется от любых системных ресурсов или уязвимой информации безопасности, которую мог бы использовать SaslClient.
byte[]	evaluateChallenge(byte[] challenge) Оценивает данные проблемы и генерирует ответ.
Строка	getMechanismName() Возвращает зарегистрированное в IANA имя механизма этого клиента SASL.
Объект	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").

Возвраты:

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

hasInitialResponse

boolean hasInitialResponse()

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

Возвраты:

истина, если у этого механизма есть начальный ответ.

evaluateChallenge

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

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

Параметры:

challenge - Ненулевая проблема передалась от сервера. У массива проблемы может быть нулевая длина.

Возвраты:

Возможно нуль reponse, чтобы передаться к серверу. Это - нуль, если проблема, сопровождаемая, состояние "УСПЕХА" и проблема только содержат данные для клиента, чтобы обновить его состояние, и никакой ответ не должен быть отправлен серверу. Ответ является байтовым массивом нулевым длиной, если клиент должен отправить ответ без данных.

Броски:

SaslException - Если ошибка произошла, обрабатывая проблему или генерируя ответ.

isComplete

boolean isComplete()

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

Возвраты:

истина, если обмен аутентификации завершился; ложь иначе.

развернуть

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

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

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

Параметры:

incoming - Ненулевой байтовый массив, содержащий закодированные байты от сервера.

offset - Стартовая позиция в incoming байтов, чтобы использовать.

len - Число байтов от incoming, чтобы использовать.

Возвраты:

Ненулевой байтовый массив, содержащий декодируемые байты.

Броски:

SaslException - если incoming не может быть успешно развернут.

IllegalStateException - если обмен аутентификации не завершился, или если у согласованного качества защиты нет ни целостности, ни конфиденциальности.

обертка

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

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

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

Параметры:

outgoing - Ненулевой байтовый массив, содержащий байты, чтобы закодировать.

offset - Стартовая позиция в outgoing байтов, чтобы использовать.

len - Число байтов от outgoing, чтобы использовать.

Возвраты:

Ненулевой байтовый массив, содержащий закодированные байты.

Броски:

SaslException - если outgoing не может быть успешно обернут.

IllegalStateException - если обмен аутентификации не завершился, или если у согласованного качества защиты нет ни целостности, ни конфиденциальности.

getNegotiatedProperty

Object getNegotiatedProperty(String propName)

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

Параметры:

propName - Ненулевое имя свойства.

Возвраты:

Значение согласованного свойства. Если ноль, свойство не было согласовано или не применимо к этому механизму.

Броски:

IllegalStateException - если этот обмен аутентификации не завершился

расположить

void dispose()
      throws SaslException

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

Броски:

SaslException - Если с проблемой встретились, располагая ресурсы.