Package org.apereo.cas.configuration.model.support.mfa.yubikey

Class YubiKeyMultifactorAuthenticationProperties

java.lang.Object

org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties

org.apereo.cas.configuration.model.support.mfa.yubikey.YubiKeyMultifactorAuthenticationProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-yubikey")
public class YubiKeyMultifactorAuthenticationProperties
extends BaseMultifactorAuthenticationProviderProperties

This is YubiKeyMultifactorAuthenticationProperties.

Since:

5.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions	Device validation options.

Nested classes/interfaces inherited from class org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties

BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IDENTIFIER	Provider id by default.

Constructor Summary

Constructors

Constructor	Description
YubiKeyMultifactorAuthenticationProperties()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAllowedDevices()	Collection of allowed devices allowed per user.
List<String>	getApiUrls()	YubiKey API urls to contact for verification of credentials.
Integer	getClientId()	Yubikey client id.
EncryptionJwtSigningJwtCryptographyProperties	getCrypto()	Crypto settings that sign/encrypt the yubikey registration records.
YubiKeyDynamoDbMultifactorProperties	getDynamoDb()	Keep device registration records inside a dynamo db resource.
YubiKeyJpaMultifactorProperties	getJpa()	Keep device registration records inside a JDBC resource.
org.springframework.core.io.Resource	getJsonFile()	Keep device registration records inside a static JSON resource.
YubiKeyMongoDbMultifactorProperties	getMongo()	Keep device registration records inside a MongoDb resource.
YubiKeyRedisMultifactorProperties	getRedis()	Keep device registration records inside a redis resource.
YubiKeyRestfulMultifactorProperties	getRest()	Keep device registration records inside a rest api.
String	getSecretKey()	Yubikey secret key.
YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions	getValidator()	Define the strategy that controls how devices should be validated.
boolean	isMultipleDeviceRegistrationEnabled()	When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.
boolean	isTrustedDeviceEnabled()	Indicates whether this provider should support trusted devices.
YubiKeyMultifactorAuthenticationProperties	setAllowedDevices(Map<String,String> allowedDevices)	Collection of allowed devices allowed per user.
YubiKeyMultifactorAuthenticationProperties	setApiUrls(List<String> apiUrls)	YubiKey API urls to contact for verification of credentials.
YubiKeyMultifactorAuthenticationProperties	setClientId(Integer clientId)	Yubikey client id.
YubiKeyMultifactorAuthenticationProperties	setCrypto(EncryptionJwtSigningJwtCryptographyProperties crypto)	Crypto settings that sign/encrypt the yubikey registration records.
YubiKeyMultifactorAuthenticationProperties	setDynamoDb(YubiKeyDynamoDbMultifactorProperties dynamoDb)	Keep device registration records inside a dynamo db resource.
YubiKeyMultifactorAuthenticationProperties	setJpa(YubiKeyJpaMultifactorProperties jpa)	Keep device registration records inside a JDBC resource.
YubiKeyMultifactorAuthenticationProperties	setJsonFile(org.springframework.core.io.Resource jsonFile)	Keep device registration records inside a static JSON resource.
YubiKeyMultifactorAuthenticationProperties	setMongo(YubiKeyMongoDbMultifactorProperties mongo)	Keep device registration records inside a MongoDb resource.
YubiKeyMultifactorAuthenticationProperties	setMultipleDeviceRegistrationEnabled(boolean multipleDeviceRegistrationEnabled)	When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.
YubiKeyMultifactorAuthenticationProperties	setRedis(YubiKeyRedisMultifactorProperties redis)	Keep device registration records inside a redis resource.
YubiKeyMultifactorAuthenticationProperties	setRest(YubiKeyRestfulMultifactorProperties rest)	Keep device registration records inside a rest api.
YubiKeyMultifactorAuthenticationProperties	setSecretKey(String secretKey)	Yubikey secret key.
YubiKeyMultifactorAuthenticationProperties	setTrustedDeviceEnabled(boolean trustedDeviceEnabled)	Indicates whether this provider should support trusted devices.
YubiKeyMultifactorAuthenticationProperties	setValidator(YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions validator)	Define the strategy that controls how devices should be validated.

Methods inherited from class org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties

equals, getBypass, getFailureMode, getId, getName, getOrder, getRank, hashCode, setBypass, setFailureMode, setId, setName, setOrder, setRank

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_IDENTIFIER

public static final String DEFAULT_IDENTIFIER

Provider id by default.

See Also:

• Constant Field Values

Constructor Details

YubiKeyMultifactorAuthenticationProperties

public YubiKeyMultifactorAuthenticationProperties()

Method Details

getClientId

public Integer getClientId()

Yubikey client id.

getSecretKey

@Nonnull
public String getSecretKey()

Yubikey secret key.

isMultipleDeviceRegistrationEnabled

public boolean isMultipleDeviceRegistrationEnabled()

When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.

getJsonFile

public org.springframework.core.io.Resource getJsonFile()

Keep device registration records inside a static JSON resource.

getAllowedDevices

public Map<String,String> getAllowedDevices()

Collection of allowed devices allowed per user. This is done using a key-value structure where the key is the user the value is the allowed collection of yubikey device ids.

getApiUrls

public List<String> getApiUrls()

YubiKey API urls to contact for verification of credentials.

isTrustedDeviceEnabled

public boolean isTrustedDeviceEnabled()

Indicates whether this provider should support trusted devices.

getValidator

public YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions getValidator()

Define the strategy that controls how devices should be validated.

getJpa

public YubiKeyJpaMultifactorProperties getJpa()

Keep device registration records inside a JDBC resource.

getMongo

public YubiKeyMongoDbMultifactorProperties getMongo()

Keep device registration records inside a MongoDb resource.

getRedis

public YubiKeyRedisMultifactorProperties getRedis()

Keep device registration records inside a redis resource.

getDynamoDb

public YubiKeyDynamoDbMultifactorProperties getDynamoDb()

Keep device registration records inside a dynamo db resource.

getRest

public YubiKeyRestfulMultifactorProperties getRest()

Keep device registration records inside a rest api.

getCrypto

public EncryptionJwtSigningJwtCryptographyProperties getCrypto()

Crypto settings that sign/encrypt the yubikey registration records.

setClientId

public YubiKeyMultifactorAuthenticationProperties setClientId(Integer clientId)

Yubikey client id.

Returns:

this.

setSecretKey

public YubiKeyMultifactorAuthenticationProperties setSecretKey(@Nonnull
 String secretKey)

Yubikey secret key.

Returns:

this.

setMultipleDeviceRegistrationEnabled

public YubiKeyMultifactorAuthenticationProperties setMultipleDeviceRegistrationEnabled(boolean multipleDeviceRegistrationEnabled)

When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically.

Returns:

this.

setJsonFile

public YubiKeyMultifactorAuthenticationProperties setJsonFile(org.springframework.core.io.Resource jsonFile)

Keep device registration records inside a static JSON resource.

Returns:

this.

setAllowedDevices

public YubiKeyMultifactorAuthenticationProperties setAllowedDevices(Map<String,String> allowedDevices)

Collection of allowed devices allowed per user. This is done using a key-value structure where the key is the user the value is the allowed collection of yubikey device ids.

Returns:

this.

setApiUrls

public YubiKeyMultifactorAuthenticationProperties setApiUrls(List<String> apiUrls)

YubiKey API urls to contact for verification of credentials.

Returns:

this.

setTrustedDeviceEnabled

public YubiKeyMultifactorAuthenticationProperties setTrustedDeviceEnabled(boolean trustedDeviceEnabled)

Indicates whether this provider should support trusted devices.

Returns:

this.

setValidator

public YubiKeyMultifactorAuthenticationProperties setValidator(YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions validator)

Define the strategy that controls how devices should be validated.

Returns:

this.

setJpa

public YubiKeyMultifactorAuthenticationProperties setJpa(YubiKeyJpaMultifactorProperties jpa)

Keep device registration records inside a JDBC resource.

Returns:

this.

setMongo

public YubiKeyMultifactorAuthenticationProperties setMongo(YubiKeyMongoDbMultifactorProperties mongo)

Keep device registration records inside a MongoDb resource.

Returns:

this.

setRedis

public YubiKeyMultifactorAuthenticationProperties setRedis(YubiKeyRedisMultifactorProperties redis)

Keep device registration records inside a redis resource.

Returns:

this.

setDynamoDb

public YubiKeyMultifactorAuthenticationProperties setDynamoDb(YubiKeyDynamoDbMultifactorProperties dynamoDb)

Keep device registration records inside a dynamo db resource.

Returns:

this.

setRest

public YubiKeyMultifactorAuthenticationProperties setRest(YubiKeyRestfulMultifactorProperties rest)

Keep device registration records inside a rest api.

Returns:

this.

setCrypto

public YubiKeyMultifactorAuthenticationProperties setCrypto(EncryptionJwtSigningJwtCryptographyProperties crypto)

Crypto settings that sign/encrypt the yubikey registration records.

Returns:

this.