compact3

javax.security.sasl

Интерфейс SaslServer

public interface SaslServer

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

Сервер такой сервер LDAP приводит экземпляр в порядок этого class, чтобы выполнить аутентификацию, определенную определенным механизмом SASL. Вызов методов на экземпляре SaslServer генерирует проблемы согласно механизму SASL, реализованному SaslServer. Поскольку аутентификация продолжается, экземпляр инкапсулирует состояние обмена аутентификации сервера SASL.

Вот пример того, как сервер LDAP мог бы использовать SaslServer. Это сначала получает экземпляр SaslServer для механизма SASL, который требует клиент:

 SaslServer ss = Sasl.createSaslServer(mechanism,
     "ldap", myFQDN, props, callbackHandler);

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

 while (!ss.isComplete()) {
     try {
         byte[] challenge = ss.evaluateResponse(response);
         if (ss.isComplete()) {
             status = ldap.sendBindResponse(mechanism, challenge, SUCCESS);
         } else {
             status = ldap.sendBindResponse(mechanism, challenge,
                   SASL_BIND_IN_PROGRESS);
             response = ldap.readBindRequest();
         }
     } catch (SaslException e) {
          status = ldap.sendErrorResponse(e);
          break;
     }
 }
 if (ss.isComplete() && status == SUCCESS) {
    String qop = (String) sc.getNegotiatedProperty(Sasl.QOP);
    if (qop != null
        && (qop.equalsIgnoreCase("auth-int")
            || qop.equalsIgnoreCase("auth-conf"))) {

      // Use SaslServer.wrap() and SaslServer.unwrap() for future
      // communication with client
      ldap.in = new SecureInputStream(ss, ldap.in);
      ldap.out = new SecureOutputStream(ss, ldap.out);
    }
 }

С тех пор:

1.5

См. Также:

Sasl, SaslServerFactory

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

Модификатор и Тип	Метод и Описание
void	dispose() Избавляется от любых системных ресурсов или уязвимой информации безопасности, которую мог бы использовать SaslServer.
byte[]	evaluateResponse(byte[] response) Оценивает данные ответа и генерирует проблему.
Строка	getAuthorizationID() Сообщает ID авторизации в действительности для клиента этого сеанса.
Строка	getMechanismName() Возвращает зарегистрированное в IANA имя механизма этого сервера SASL.
Объект	getNegotiatedProperty(String propName) Получает согласованное свойство.
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 имя механизма.

evaluateResponse

byte[] evaluateResponse(byte[] response)
                 throws SaslException

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

Параметры:

response - Ненуль (но возможно пустой) ответ передался клиентом.

Возвраты:

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

Броски:

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

isComplete

boolean isComplete()

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

Возвраты:

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

getAuthorizationID

String getAuthorizationID()

Сообщает ID авторизации в действительности для клиента этого сеанса. Этот метод можно только вызвать, если isComplete () возвращает true.

Возвраты:

ID авторизации клиента.

Броски:

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

развернуть

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), и только если обмен аутентификации согласовал целостность и/или конфиденциальность как качество защиты; иначе, SaslException бросается.

Результат этого метода составит содержание буфера 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

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

Броски:

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