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
- Since:
- 5.2.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Device validation options.Nested classes/interfaces inherited from class org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties
BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCollection of allowed devices allowed per user.YubiKey API urls to contact for verification of credentials.Yubikey client id.Crypto settings that sign/encrypt the yubikey registration records.Keep device registration records inside a dynamo db resource.getJpa()
Keep device registration records inside a JDBC resource.org.springframework.core.io.Resource
Keep device registration records inside a static JSON resource.getMongo()
Keep device registration records inside a MongoDb resource.getRedis()
Keep device registration records inside a redis resource.getRest()
Keep device registration records inside a rest api.Yubikey secret key.Define the strategy that controls how devices should be validated.boolean
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
Indicates whether this provider should support trusted devices.setAllowedDevices
(Map<String, String> allowedDevices) Collection of allowed devices allowed per user.setApiUrls
(List<String> apiUrls) YubiKey API urls to contact for verification of credentials.setClientId
(Integer clientId) Yubikey client id.Crypto settings that sign/encrypt the yubikey registration records.Keep device registration records inside a dynamo db resource.Keep device registration records inside a JDBC resource.setJsonFile
(org.springframework.core.io.Resource jsonFile) Keep device registration records inside a static JSON resource.Keep device registration records inside a MongoDb resource.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.Keep device registration records inside a redis resource.Keep device registration records inside a rest api.setSecretKey
(String secretKey) Yubikey secret key.setTrustedDeviceEnabled
(boolean trustedDeviceEnabled) Indicates whether this provider should support trusted devices.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
-
Field Details
-
DEFAULT_IDENTIFIER
Provider id by default.- See Also:
-
-
Constructor Details
-
YubiKeyMultifactorAuthenticationProperties
public YubiKeyMultifactorAuthenticationProperties()
-
-
Method Details
-
getClientId
Yubikey client id. -
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
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
YubiKey API urls to contact for verification of credentials. -
isTrustedDeviceEnabled
public boolean isTrustedDeviceEnabled()Indicates whether this provider should support trusted devices. -
getValidator
Define the strategy that controls how devices should be validated. -
getJpa
Keep device registration records inside a JDBC resource. -
getMongo
Keep device registration records inside a MongoDb resource. -
getRedis
Keep device registration records inside a redis resource. -
getDynamoDb
Keep device registration records inside a dynamo db resource. -
getRest
Keep device registration records inside a rest api. -
getCrypto
Crypto settings that sign/encrypt the yubikey registration records. -
setClientId
Yubikey client id.- Returns:
this
.
-
setSecretKey
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
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
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
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
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
.
-