org.apereo.cas.adaptors.yubikey

Interface YubiKeyAccountRegistry

All Known Implementing Classes:

BaseYubiKeyAccountRegistry, ClosedYubiKeyAccountRegistry, JpaYubiKeyAccountRegistry, JsonYubiKeyAccountRegistry, MongoDbYubiKeyAccountRegistry, OpenYubiKeyAccountRegistry, WhitelistYubiKeyAccountRegistry

public interface YubiKeyAccountRegistry

General contract that allows one to determine whether a particular YubiKey account is allowed to participate in the authentication. Accounts are noted by the username and the public id of the YubiKey device.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
java.util.Optional<YubiKeyAccount>	getAccount(java.lang.String uid) Gets account.
java.util.Collection<YubiKeyAccount>	getAccounts() Gets accounts for all users.
YubiKeyAccountValidator	getAccountValidator() Gets account validator.
CipherExecutor<java.io.Serializable,java.lang.String>	getCipherExecutor() Gets cipher executor.
boolean	isYubiKeyRegisteredFor(java.lang.String uid) Is yubi key registered for boolean.
boolean	isYubiKeyRegisteredFor(java.lang.String uid, java.lang.String yubikeyPublicId) Determines whether the registered YubiKey public id is allowed for the uid received.
boolean	registerAccountFor(java.lang.String uid, java.lang.String token) Register account/device.

Method Detail

isYubiKeyRegisteredFor

boolean isYubiKeyRegisteredFor(java.lang.String uid,
                               java.lang.String yubikeyPublicId)

Determines whether the registered YubiKey public id is allowed for the uid received.

Parameters:

uid - user id

yubikeyPublicId - public id of the yubi id

Returns:

true if the public id is allowed and registered for the uid.

isYubiKeyRegisteredFor

boolean isYubiKeyRegisteredFor(java.lang.String uid)

Is yubi key registered for boolean.

Parameters:

uid - the uid

Returns:

the boolean

registerAccountFor

boolean registerAccountFor(java.lang.String uid,
                           java.lang.String token)

Register account/device.

Parameters:

uid - the uid

token - the yubikey token

Returns:

the boolean

getAccounts

java.util.Collection<YubiKeyAccount> getAccounts()

Gets accounts for all users.

Returns:

the accounts

getAccount

java.util.Optional<YubiKeyAccount> getAccount(java.lang.String uid)

Gets account.

Parameters:

uid - the uid

Returns:

the account

getAccountValidator

YubiKeyAccountValidator getAccountValidator()

Gets account validator.

Returns:

the account validator

getCipherExecutor

CipherExecutor<java.io.Serializable,java.lang.String> getCipherExecutor()

Gets cipher executor.

Returns:

the cipher executor