Documentation

Horde_Auth_Shibboleth extends Horde_Auth_Base
in package

Auth

The Horde_Auth_Shibboleth class only provides transparent authentication based on the headers set by a Shibboleth SP.

Note that this class does not provide any actual SP functionality, it just takes the username from the HTTP headers that should be set by the Shibboleth SP.

$_capabilities

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.


    protected
        array<string|int, mixed>
    $_capabilities
     = array('transparent' => \true)

$_credentials

The credentials currently being authenticated.


    protected
        array<string|int, mixed>
    $_credentials
     = array('change' => \false, 'credentials' => array(), 'expire' => \null, 'userId' => '')

$_error

Authentication error information.


    protected
        array<string|int, mixed>
    $_error

$_history_api

History object.


    protected
        Horde_History
    $_history_api

$_lock_api

Lock object.


    protected
        Horde_Lock
    $_lock_api

$_logger

Logger object.


    protected
        Horde_Log_Logger
    $_logger

$_params

Hash containing parameters needed for the drivers.


    protected
        array<string|int, mixed>
    $_params
     = array()

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $params = array() ]) : mixed

Parameters

$params : array<string|int, mixed> = array()

Parameters:

'password_header' - (string) Name of the header holding the password of
                    the logged in user.
'password_holder' - (string) Where the hordeauth password is stored.
'password_preference' - (string) Name of the Horde preference holding
                        the password of the logged in user.
'username_header' - (string) [REQUIRED] Name of the header holding the
                    username of the logged in user.

Return values

mixed —

addUser()

Adds a set of authentication credentials.


    public
                    addUser(string $userId, array<string|int, mixed> $credentials) : mixed

Parameters

$userId : string: The userId to add.
$credentials : array<string|int, mixed>: The credentials to use.

Return values

mixed —

authenticate()

Finds out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.


    public
                    authenticate(string $userId, array<string|int, mixed> $credentials[, bool $login = true ]) : bool

Parameters

$userId : string: The userId to check.
$credentials : array<string|int, mixed>: The credentials to check.
$login : bool = true: Whether to log the user in. If false, we'll only test the credentials and won't modify the current session. Defaults to true.

Return values

bool —

Whether or not the credentials are valid.

exists()

Checks if $userId exists in the system.


    public
                    exists(string $userId) : bool

Parameters

$userId : string: User ID for which to check

Return values

bool —

Whether or not $userId already exists.

getCredential()

Returns internal credential value(s).


    public
                    getCredential([mixed $name = null ]) : mixed

Parameters

$name : mixed = null

The credential value to get. If null, will return the entire credential list. Valid names:

'change': (boolean) Do credentials need to be changed?
'credentials': (array) The credentials needed to authenticate.
'expire': (integer) UNIX timestamp of the credential expiration date.
'userId': (string) The user ID.

Return values

mixed —

The credential information, or null if the credential doesn't exist.

getError()

Returns the error type or message for an invalid authentication.


    public
                    getError([bool $msg = false ]) : mixed

Parameters

$msg : bool = false: If true, returns the message string (if set).

Return values

mixed —

Error type, error message (if $msg is true) or false if entry doesn't exist.

getParam()

Returns the named parameter for the current auth driver.


    public
                    getParam(string $param) : string

Parameters

$param : string: The parameter to fetch.

Return values

string —

The parameter's value, or null if it doesn't exist.

hasCapability()

Queries the current driver to find out if it supports the given capability.


    public
                    hasCapability(string $capability) : bool

Parameters

$capability : string: The capability to test for.

Return values

bool —

Whether or not the capability is supported.

isLocked()

Returns whether a user is currently locked.


    public
                    isLocked(string $userId[, bool $show_details = false ]) : bool|array<string|int, mixed>

Parameters

$userId : string: The user to check.
$show_details : bool = false: Return timeout too?

Return values

bool|array<string|int, mixed> —

If $show_details is a true, an array with 'locked' and 'lock_timeout' values. Whether the user is locked, otherwise.

listUsers()

Lists all users in the system.


    public
                    listUsers([bool $sort = false ]) : mixed

Parameters

$sort : bool = false: Sort the users?

Return values

mixed —

The array of userIds.

lockUser()

Locks a user indefinitely or for a specified time.


    public
                    lockUser(string $userId, int $time) : mixed

Parameters

$userId : string: The user to lock.
$time : int: The duration in minutes, 0 = permanent.

Return values

mixed —

removeUser()

Deletes a set of authentication credentials.


    public
                    removeUser(string $userId) : mixed

Parameters

$userId : string: The userId to delete.

Return values

mixed —

resetPassword()

Reset a user's password. Used for example when the user does not remember the existing password.


    public
                    resetPassword(string $userId) : string

Parameters

$userId : string: The user id for which to reset the password.

Return values

string —

The new password on success.

searchUsers()

Searches the users for a substring.


    public
                    searchUsers(string $search) : array<string|int, mixed>

Parameters

$search : string: The search term.

Return values

array<string|int, mixed> —

A list of all matching users.

setCredential()

Sets an internal credential value.


    public
                    setCredential(string $type, mixed $value) : mixed

Parameters

$type : string: The credential name to set. See getCredential() for the list of valid credentials/types.
$value : mixed: The credential value to set.

Return values

mixed —

setError()

Sets the error message for an invalid authentication.


    public
                    setError(string $type[, string $msg = null ]) : mixed

Parameters

$type : string: The type of error (Horde_Auth::REASON_* constant).
$msg : string = null: The error message/reason for invalid authentication.

Return values

mixed —

transparent()

Automatic authentication: checks if the username is set in the configured header.


    public
                    transparent() : bool

Return values

bool —

Whether or not the client is allowed.

unlockUser()

Unlocks a user and optionally resets the bad login count.


    public
                    unlockUser(string $userId[, bool $resetBadLogins = false ]) : mixed

Parameters

$userId : string: The user to unlock.
$resetBadLogins : bool = false: Reset bad login counter?

Return values

mixed —

updateUser()

Updates a set of authentication credentials.


    public
                    updateUser(string $oldID, string $newID, array<string|int, mixed> $credentials) : mixed

Parameters

$oldID : string: The old userId.
$newID : string: The new userId.
$credentials : array<string|int, mixed>: The new credentials

Return values

mixed —

validateAuth()

Checks for triggers that may invalidate the current auth.


    public
                    validateAuth() : bool

These triggers are independent of the credentials.

Return values

bool —

True if the results of authenticate() are still valid.

_authenticate()

Not implemented.


    protected
                    _authenticate(string $userId, array<string|int, mixed> $credentials) : mixed

Parameters

$userId : string: The userID to check.
$credentials : array<string|int, mixed>: An array of login credentials.

Return values

mixed —

_badLogin()

Handles a bad login.


    protected
                    _badLogin(string $userId) : mixed

Parameters

$userId : string: The user with a bad login.

Return values

mixed —

_removeScope()

Removes the scope from the user name, if present.


    protected
                    _removeScope(string $username) : string

Parameters

$username : string: The full user name.

Return values

string —

The user name without scope.

_resetBadLogins()

Resets the bad login counter.


    protected
                    _resetBadLogins(string $userId) : mixed

Parameters

$userId : string: The user to reset.

Return values

mixed —

_sort()

Basic sort implementation.


    protected
                    _sort(array<string|int, mixed> $users, bool $sort) : array<string|int, mixed>

If the backend has listUsers and doesn't have a native sorting option, fall back to this method.

Parameters

$users : array<string|int, mixed>: An array of usernames.
$sort : bool: Whether to sort or not.

Return values

array<string|int, mixed> —

the users, sorted or not

Horde_Auth_Shibboleth extends Horde_Auth_Base in package Auth

Tags

Table of Contents

Properties

$_capabilities

$_credentials

$_error

$_history_api

$_lock_api

$_logger

$_params

Methods

__construct()

Parameters

Tags

Return values

addUser()

Parameters

Tags

Return values

authenticate()

Parameters

Return values

exists()

Parameters

Return values

getCredential()

Parameters

Return values

getError()

Parameters

Return values

getParam()

Parameters

Return values

hasCapability()

Parameters

Return values

isLocked()

Parameters

Tags

Return values

listUsers()

Parameters

Tags

Return values

lockUser()

Parameters

Tags

Return values

removeUser()

Parameters

Tags

Return values

resetPassword()

Parameters

Tags

Return values

searchUsers()

Parameters

Tags

Return values

setCredential()

Parameters

Return values

setError()

Parameters

Return values

transparent()

Return values

unlockUser()

Parameters

Tags

Return values

updateUser()

Parameters

Tags

Return values

validateAuth()

Return values

Horde_Auth_Shibboleth extends Horde_Auth_Base
in package

Auth