Класс KeyStoreLoginModule

java.lang.Object

com.sun.security.auth.module.KeyStoreLoginModule

Все реализованные интерфейсы:: LoginModule

public class KeyStoreLoginModule extends Object implements LoginModule

Предоставляет модуль входа JAAS, который запрашивает алиас хранилища ключей и заполняет субъект принципалом и учетными данными алиаса. Хранит X500Principal для имени субъекта первой сертификата в учетных данных алиаса в принципалах субъекта, путь сертификата алиаса в публичных учетных данных субъекта и X500PrivateCredential сертификат которого является первой сертификатом в пути сертификата алиаса, а его закрытый ключ — это закрытый ключ алиаса, в частных учетных данных субъекта.

Признаёт следующие параметры в файле конфигурации:

keyStoreURL: URL, который указывает расположение хранилища ключей. По умолчанию — URL, указывающий на файл .keystore в каталоге, указанном в системном свойстве user.home. Поступающий из этого URL поток передаётся методу KeyStore.load. Можно указать "NONE", если необходимо передать поток null методу KeyStore.load. Это нужно, например, если хранилище ключей расположено на устройстве с аппаратным токеном.
keyStoreType: Тип хранилища ключей. Если не указан, по умолчанию используется результат вызова KeyStore.getDefaultType(). Если тип "PKCS11", то keyStoreURL должен быть "NONE", а privateKeyPasswordURL не должен быть указан.
keyStoreProvider: Поставщик хранилища ключей. Если не указан, используется стандартный порядок поиска поставщика.
keyStoreAlias: Алиас в хранилище ключей для входа. Требуется, когда не указан обработчик обратного вызова. Значение по умолчанию отсутствует.
keyStorePasswordURL: URL, который указывает расположение пароля хранилища ключей. Требуется, когда не указан обработчик обратного вызова и protected равно false. Значение по умолчанию отсутствует.
privateKeyPasswordURL: URL, который указывает расположение пароля конкретного закрытого ключа, необходимого для доступа к закрытому ключу для данного алиаса. Если это значение нужно, но не указано, используется пароль хранилища ключей.
protected: Это значение должно быть установлено в "true", если хранилище ключей имеет отдельный, защищённый путь аутентификации (например, отдельный блок ввода PIN, подключённый к смарт-карте). По умолчанию "false". Если "true", то keyStorePasswordURL и privateKeyPasswordURL не должны быть указаны.

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

Конструктор	Описание
`KeyStoreLoginModule()`	Создаёт `KeyStoreLoginModule`.

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

Модификатор и тип	Метод	Описание
`boolean`	`abort()`	Этот метод вызывается, если общая аутентификация LoginContext завершилась неудачей.
`boolean`	`commit()`	Абстрактный метод для подтверждения процесса аутентификации (этап 2).
`void`	`initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)`	Инициализирует этот `LoginModule`.
`boolean`	`login()`	Проводит аутентификацию пользователя.
`boolean`	`logout()`	Выход пользователя.

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

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

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

KeyStoreLoginModule

public KeyStoreLoginModule()

Создаёт KeyStoreLoginModule.

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

initialize

public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)

Инициализирует этот LoginModule.

Определено в:: initialize в интерфейсе LoginModule
Параметры:: subject - Subject для аутентификации.; callbackHandler - CallbackHandler для взаимодействия с конечным пользователем (например, запрос имён пользователей и паролей), который может быть null.; sharedState - общие LoginModule данные.; options - параметры, указанные в файле входа Configuration для данного LoginModule.

login

public boolean login() throws LoginException

Проводит аутентификацию пользователя.

Получает алиас хранилища ключей и соответствующие пароли. Извлекает принципал и учетные данные алиаса из хранилища ключей.

Определено в:: login в интерфейсе LoginModule
Возвращает:: true во всех случаях (этот LoginModule не должен игнорироваться).
Исключения:: FailedLoginException - если аутентификация завершилась неудачей.; LoginException - если аутентификация завершилась неудачей

commit

public boolean commit() throws LoginException

Абстрактный метод для подтверждения процесса аутентификации (этап 2).

Этот метод вызывается, если общая аутентификация LoginContext прошла успешно (соответствующие модули входа REQUIRED, REQUISITE, SUFFICIENT и OPTIONAL завершились успешно).

Если попытка аутентификации данного модуля входа прошла успешно (проверяется путём извлечения сохранённого внутреннего состояния методом login), то этот метод связывает X500Principal для имени субъекта первой сертификата в учетных данных алиаса в принципалах субъекта, путь сертификата алиаса в публичных учетных данных субъекта и X500PrivateCredential сертификат которого является первой сертификатом в пути сертификата алиаса, а его закрытый ключ — это закрытый ключ алиаса, в частных учетных данных субъекта. Если попытка аутентификации данного модуля входа завершилась неудачей, то этот метод удаляет любое сохранённое состояние.

Определено в:: commit в интерфейсе LoginModule
Возвращает:: true, если попытки входа и подтверждения данного модуля входа завершились успешно, или false в противном случае.
Исключения:: LoginException - если подтверждение завершилось неудачей

abort

public boolean abort() throws LoginException

Этот метод вызывается, если общая аутентификация LoginContext завершилась неудачей. (соответствующие модули входа REQUIRED, REQUISITE, SUFFICIENT и OPTIONAL не завершились успешно).

Если попытка аутентификации данного модуля входа прошла успешно (проверяется путём извлечения сохранённого внутреннего состояния методами login и commit), то этот метод очищает любое сохранённое состояние.

Если поставщик загруженного хранилища ключей расширяет java.security.AuthProvider, то вызывается метод logout поставщика.

Определено в:: abort в интерфейсе LoginModule
Возвращает:: false, если попытки входа и/или подтверждения данного модуля входа завершились неудачей, и true в противном случае.
Исключения:: LoginException - если прерывание завершилось неудачей.

logout

public boolean logout() throws LoginException

Выход пользователя.

Этот метод удаляет принципалы, публичные учетные данные и закрытые учетные данные, которые были добавлены методом commit.

Определено в:: logout в интерфейсе LoginModule
Возвращает:: true во всех случаях, так как этот LoginModule не должен игнорироваться.
Исключения:: LoginException - если выход завершился неудачей.

© 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/jdk.security.auth/com/sun/security/auth/module/KeyStoreLoginModule.html