contentbox.models.security.twofactor.ITwoFactorProvider
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- This is the interface to needed to implement two-factor authentication methods for ContentBox
Method Summary | |
---|---|
boolean
|
allowTrustedDevice()
If true, then ContentBox will set a tracking cookie for the authentication provider user browser. |
any
|
finalize(string code, any author)
This method is called once a two factor challenge is accepted and valid. |
any
|
getAuthorSetupForm(any author)
Returns html to display to the user for required two-factor fields. |
any
|
getAuthorSetupHelp(any author)
Get the display help for the provider. |
any
|
getDisplayName()
Get the display name for the provider. |
any
|
getName()
Get the internal name of a provider, used for registration, internal naming and more. |
any
|
getVerificationHelp()
Get the verification help for the provider. |
struct
|
sendChallenge(any author)
Send a challenge via the 2 factor auth implementation. |
struct
|
verifyChallenge(string code, any author)
Leverage the default provider to verify a challenge for the specific user. |
Method Detail |
---|
If true, then ContentBox will set a tracking cookie for the authentication provider user browser. If the user, logs in and the device is within the trusted timespan, then no two-factor authentication validation will occur.
This method is called once a two factor challenge is accepted and valid. Meaning the user has completed the validation and will be logged in to ContentBox now.
code
- The verification codeauthor
- The author to verify challengeReturns html to display to the user for required two-factor fields
author
Get the display help for the provider. Used in the UI setup screens for the author
author
Get the display name for the provider. Used in all UI screens
Get the internal name of a provider, used for registration, internal naming and more.
Get the verification help for the provider. Used in the UI verification screen.
Send a challenge via the 2 factor auth implementation. The return must be a struct with an error boolean bit and a messages string
author
- The author to challengeLeverage 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