LimeSurvey API - Master branch

TwoFactorAdminLogin extends AuthPluginBase

in package

• Application

Table of Contents

Constants

ERROR_ALREADY_EXISTING_USER  = 120

ERROR_AUTH_METHOD_INVALID  = 30

ERROR_INVALID_EMAIL  = 110

ERROR_IP_LOCKED_OUT  = 98

ERROR_LDAP_CONNECTION  = 130

ERROR_LDAP_MODE  = 135

ERROR_LDAP_NO_BIND  = 160

ERROR_LDAP_NO_EMAIL  = 140

ERROR_LDAP_NO_FULLNAME  = 150

ERROR_LDAP_NO_SEARCH_RESULT  = 170

ERROR_NONE  = 0

These constants reflect the error codes to be used by the identity, they are copied from LSUserIdentity and CBaseUserIdentity for easier access.

ERROR_NOT_ADDED  = 5

ERROR_PASSWORD_INVALID  = 20

ERROR_UNKNOWN_HANDLER  = 99

ERROR_UNKNOWN_IDENTITY  = 100

ERROR_USERNAME_INVALID  = 10

LDAP_INVALID_PASSWORD_TEXT  = "INVALID_PASSWORD-LDAP_USER"

Properties

$allowedPublicMethods  : mixed

$_password  : mixed

$_username  : mixed

$description  : mixed

$name  : mixed

$settings  : mixed

$storage  : mixed

$o2FA  : mixed

Methods

afterLoginFormSubmit()  : null

Set username and password by post request

afterSuccessfulLogin()  : void

If force 2FA login is enabled, redirect to the 2FA page

beforeActivate()  : void

Register new table and populate it.

beforeAdminMenuRender()  : void

Add menue to the top bar

beforeDeactivate()  : void

Delete the created tables again

deleteKeyForUserId()  : string

Deletes a users secret, effectively ending the 2FA login mechanism for that user CLI version.

deleteKeyForUserName()  : string

Deletes a users secret, effectively ending the 2FA login mechanism for that user CLI version.

direct()  : void

Event direct happen Usage : index --target=value [--function=] [--option=]

directCallConfirmKey()  : bool

Checks a submitted authentication code and stores the underlaying secret key into the Database.

directCallCreateNewKey()  : string

Renders modal content for creating a new 2FA key for a user.

directCallDeleteKey()  : bool

Deletes a users secret, effectively ending the 2FA login mechanism for that user.

getAuthMethodName()  : string

Returns the authentication method's name

index()  : string

Renders a list of users including their 2FA settings To be called by fullpagewrapper

init()  : mixed

newDirectRequest()  : void

Listen to direct requests Necessary for the getMetadata function

newLoginForm()  : void

Add Two-Factor field to login page.

newUserSession()  : void

Control if login is successful by checking the transmitted 2FA-token value

remoteControlLogin()  : null

Set username and password by event

setAuthFailure()  : AuthPluginBase

Set authentication result to failure.

setAuthPlugin()  : AuthPluginBase

Set this plugin to handle the authentication

setAuthSuccess()  : AuthPluginBase

Set authentication result to success for the given user object.

userindex()  : string

Renders the user configuration page To be called by fullpagewrapper

createJSONResponse()  : bool

Generates a printed JSON-Response

getPassword()  : string|null

Get the password (if set)

getUserName()  : string|null

Get the username (if set)

pageScripts()  : void

Applies the necessary page scripts to the page through CClientScript derivate

setPassword()  : AuthPluginBase

Set the password to use for authentication

setUsername()  : AuthPluginBase

Set the username to use for authentication

confirmKey()  : bool

Checks a 2FA OTP authentication code against the stored secret

get2FAObject()  : TwoFactorAuth

Creates or returns a 2FA-library object Using Rob Janssen TwoFactorAuth - Library https://github.com/RobThree/TwoFactorAuth

getYubikeyOtpHelper()  : TFAYubikeyOtpHelper

Returns a TFAYubikeyOtpHelper instance for the given YubiKey OTP code.

setupTotp()  : mixed

setupYubi()  : mixed