lucee.Componentcontentbox.models.security.twofactor.TwoFactorService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manages Two Factor Authenticators
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
authorService
|
true
|
false
|
|
any
|
cookieStorage
|
true
|
false
|
|
struct
|
providers
Providers registry.
|
true
|
false
|
|
any
|
securityService
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
Constructor Summary | |
---|---|
init(any wirebox)
Constructor. |
Method Summary | |
---|---|
boolean
|
canChallenge(any author)
Can we challenge this author for two factor authentication. |
string
|
getAuthorService()
|
string
|
getCookieStorage()
|
string
|
getDefaultProvider()
Get the default system provider name. |
ITwoFactorProvider
|
getDefaultProviderObject()
Get the default system provider object. |
ITwoFactorProvider
|
getProvider(any name)
Get a registered provider instance. |
string
|
getProviders()
|
array
|
getRegisteredProviders()
Get an array of registered provider names in alphabetical order. |
array
|
getRegisteredProvidersMap()
Get an array of registered provider names in alphabetical order with their display names. |
string
|
getSecurityService()
|
string
|
getSettingService()
|
numeric
|
getTrustedDeviceTimespan()
Get the default system trusted device timespan. |
boolean
|
hasProvider(any name)
Check if an provider exists or not. |
boolean
|
isForceTwoFactorAuth()
Are we forcing global two factor authentication. |
boolean
|
isTrustedDevice(any trustedID)
Verify if the incoming trusted ID is valid. |
TwoFactorService
|
registerProvider(ITwoFactorProvider provider)
Register a new two factor authenticator in ContentBox. |
struct
|
sendChallenge(any author)
Leverage the default provider to send a challenge to the specific user. |
any
|
setAuthorService(any authorService)
|
any
|
setCookieStorage(any cookieStorage)
|
any
|
setProviders(struct providers)
|
any
|
setSecurityService(any securityService)
|
any
|
setSettingService(any settingService)
|
TwoFactorService
|
setTrustedDevice(any trustedID)
Set a trusted device cookie for a user, usually called if the two factor authentication was valid. |
TwoFactorService
|
unRegisterProvider(any name)
UnRegister a provider in ContentBox. |
struct
|
verifyChallenge(string code, any author)
Leverage the default provider to verify a challenge for the specific user. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
wirebox
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- authorService@cbserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- cookieStorage@cbStoragesserializable
- trueProviders registry
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- securityService@cbserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- settingService@cbserializable
- trueMethod Detail |
---|
Can we challenge this author for two factor authentication
author
- The author to challenge or notGet the default system provider name
Get the default system provider object
Get a registered provider instance
name
- The name of the providerGet an array of registered provider names in alphabetical order
Get an array of registered provider names in alphabetical order with their display names
Get the default system trusted device timespan
Check if an provider exists or not
name
- The name of the providerAre we forcing global two factor authentication
Verify if the incoming trusted ID is valid
trustedID
- The trusted ID to verifyRegister a new two factor authenticator in ContentBox
provider
- The provider instance to registerLeverage the default provider to send a challenge to the specific user. The return is a structure containing an error flag and a messages string.
author
- The author to challengeauthorService
cookieStorage
providers
securityService
settingService
Set a trusted device cookie for a user, usually called if the two factor authentication was valid.
trustedID
- The trusted ID to track in the tracking cookieUnRegister a provider in ContentBox
name
- The name of the provider to unregisterLeverage the default provider to verify a challenge for the specific user. The return is a structure containing an error flag and a messages string.
code
- The verification codeauthor
- The author to verify challenge