DigestAuthentication
class DigestAuthentication extends AuthenticationHook
This class is being used exclusively for webdav requests and is not made public in the general authentication methods But we still want to keep the class / handling consistent - so we use the generic AuthenticationHook scheme
Constants
| HOOK_PREFIX |
|
Properties
| Controller | $mod | Instance providing the hook |
from BaseHook |
| array | $_hook_info | Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => "" |
from BaseHook |
| protected string | $name | Name of authentication method |
from AuthenticationHook |
| protected string | $description | Short description of authentication method |
from AuthenticationHook |
| protected int | $ttl | from AuthenticationHook |
Methods
User authentication is wrapped for Auth Hooks
No description
Generate new Digest for User
Return configuration variable for auth method
Load Auth Method Hook without Access Check
No description
Get current Digest for userId
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
Return Auth Method information as keyed array [name, description, config]
Show this authentication method if installed, even if its not configured yet
No description
No description
No description
Details
in
AuthenticationHook at line 83
final bool
authenticate_user(string $userid, string $password)
User authentication is wrapped for Auth Hooks
at line 61
bool
authorizeUserFromDigest(string $AuthorizationHeader)
No description
at line 158
static string|null
generateNewDigestPasswordForUser(int|null $userId = null)
Generate new Digest for User
in
AuthenticationHook at line 132
final protected mixed
getAuthConfig(string $config_var)
Return configuration variable for auth method
in
AuthenticationHook at line 51
final static null|static
getAuthHook(string $hook_identifier = null)
Load Auth Method Hook without Access Check
in
AuthenticationHook at line 142
final string
getAuthID()
Get internal Auth ID
at line 48
array
getConfigurationFDL()
No description
at line 132
static string|null
getDigestPasswordForUser(int|null $userId = null)
Get current Digest for userId
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
in
BaseHook at line 97
mixed
getOption(string $key)
Returns the option with $key set in the config.yml
in
AuthenticationHook at line 70
int
getSessionTTL()
No description
in
AuthenticationHook at line 107
final array
get_module_info()
Return Auth Method information as keyed array [name, description, config]
in
AuthenticationHook at line 95
final array
get_user_details()
No description
at line 31
bool
isAvailable()
Show this authentication method if installed, even if its not configured yet
at line 23
UserDetails|bool
login(string $userid, string $password = null)
No description
in
AuthenticationHook at line 172
void
onBeforeExecute()
Override in your auth method
at line 176
static bool|null
removeDigestPasswordForUser(int|null $userId)
No description
at line 52
sendAuthenticateHeader()
No description
in
AuthenticationHook at line 17
void
setName(mixed $name)
No description