PrivacyIDEAProvider
extends BaseProvider
in package
Provider for privacyIDEA.
Table of Contents
- $config : mixed
- __construct() : mixed
- Constructor.
- addCustomInput() : mixed
- Adds the custom input fields to the form.
- getSerials() : mixed
- {@inheritDoc}
- hasCustomInputForm() : has
- Returns if the service has a custom input form.
- isShowSubmitButton() : bool
- Returns if the submit button should be shown.
- supportsToRememberDevice() : bool
- verify2ndFactor() : mixed
- {@inheritDoc}
- getLoginAttributeValue() : string
- Returns the value of the user attribute in LDAP.
- authenticate() : string
- Authenticates against the server
- getCurl() : object
- Returns the curl object.
- getSerialsForUser() : array<string|int, string>
- Returns the serial numbers of the user.
- verify() : mixed
- Verifies if the given 2nd factor input is valid.
Properties
$config
protected
mixed
$config
Methods
__construct()
Constructor.
public
__construct(TwoFactorConfiguration &$config) : mixed
Parameters
- $config : TwoFactorConfiguration
-
configuration
Return values
mixed —addCustomInput()
Adds the custom input fields to the form.
public
addCustomInput(mixed &$row, mixed $userDn) : mixed
Parameters
- $row : mixed
-
row where to add the input fields
- $userDn : mixed
-
user DN
Tags
Return values
mixed —getSerials()
{@inheritDoc}
public
getSerials(mixed $user, mixed $password) : mixed
Parameters
- $user : mixed
- $password : mixed
Tags
Return values
mixed —hasCustomInputForm()
Returns if the service has a custom input form.
public
hasCustomInputForm() : has
Tags
Return values
has —custom input form
isShowSubmitButton()
Returns if the submit button should be shown.
public
isShowSubmitButton() : bool
Tags
Return values
bool —show submit button
supportsToRememberDevice()
public
supportsToRememberDevice() : bool
Tags
Return values
bool —verify2ndFactor()
{@inheritDoc}
public
verify2ndFactor(mixed $user, mixed $password, mixed $serial, mixed $twoFactorInput) : mixed
Parameters
- $user : mixed
- $password : mixed
- $serial : mixed
- $twoFactorInput : mixed
Tags
Return values
mixed —getLoginAttributeValue()
Returns the value of the user attribute in LDAP.
protected
getLoginAttributeValue(string $userDn) : string
Parameters
- $userDn : string
-
user DN
Return values
string —user name
authenticate()
Authenticates against the server
private
authenticate(string $user, string $password) : string
Parameters
- $user : string
-
user name
- $password : string
-
password
Tags
Return values
string —token
getCurl()
Returns the curl object.
private
getCurl() : object
Tags
Return values
object —curl handle
getSerialsForUser()
Returns the serial numbers of the user.
private
getSerialsForUser(string $user, string $token) : array<string|int, string>
Parameters
- $user : string
-
user name
- $token : string
-
login token
Tags
Return values
array<string|int, string> —serials
verify()
Verifies if the given 2nd factor input is valid.
private
verify(string $token, string $serial, string $twoFactorInput) : mixed
Parameters
- $token : string
-
login token
- $serial : string
-
serial number
- $twoFactorInput : string
-
2factor pin + password