ilCtrlTokenRepository Class Reference

Class ilCtrlTokenRepository. More...

Inheritance diagram for ilCtrlTokenRepository:

Collaboration diagram for ilCtrlTokenRepository:

Public Member Functions
	getToken ()
	@inheritDoc More...
	getToken ()
	Returns a temporary ilCtrlToken for the given session (id). More...

Protected Member Functions
	fetchToken ()
	Returns the currently stored token from the session. More...
	storeToken (ilCtrlTokenInterface $token)
	Stores the given token in the curren session. More...
	generateToken ()
	Returns a cryptographically secure token. More...

Detailed Description

Class ilCtrlTokenRepository.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 26 of file class.ilCtrlTokenRepository.php.

Member Function Documentation

fetchToken()

ilCtrlTokenRepository::fetchToken ( )

protected

Returns the currently stored token from the session.

Returns

ilCtrlTokenInterface|null

Definition at line 45 of file class.ilCtrlTokenRepository.php.

                                   : ?ilCtrlTokenInterface
    {
        if (ilSession::has(ilCtrlInterface::PARAM_CSRF_TOKEN)) {
            return unserialize(ilSession::get(ilCtrlInterface::PARAM_CSRF_TOKEN), [ilCtrlTokenInterface::class]);
        }
 
        return null;
    }

References ilSession\get(), ilSession\has(), and ilCtrlInterface\PARAM_CSRF_TOKEN.

Referenced by getToken().

Here is the call graph for this function:

Here is the caller graph for this function:

generateToken()

ilCtrlTokenRepository::generateToken ( )

protected

Returns a cryptographically secure token.

Returns

ilCtrlToken

Definition at line 69 of file class.ilCtrlTokenRepository.php.

                                      : ilCtrlTokenInterface
    {
        // random_bytes() is cryptographically secure but
        // depends on the system it's running on. If the
        // generation fails, we use a less secure option
        // that is available for sure.
 
        try {
            $token = bin2hex(random_bytes(32));
        } catch (Throwable $t) {
            $token = md5(uniqid((string) time(), true));
        }
 
        return new ilCtrlToken($token);
    }

References $token.

Referenced by getToken().

Here is the caller graph for this function:

getToken()

ilCtrlTokenRepository::getToken

(

)

@inheritDoc

Implements ilCtrlTokenRepositoryInterface.

Definition at line 31 of file class.ilCtrlTokenRepository.php.

                              : ilCtrlTokenInterface
    {
        $token = $this->fetchToken() ?? $this->generateToken();
 
        $this->storeToken($token);
 
        return $token;
    }

References $token, fetchToken(), generateToken(), and storeToken().

Here is the call graph for this function:

storeToken()

ilCtrlTokenRepository::storeToken ( ilCtrlTokenInterface  $token )

protected

Stores the given token in the curren session.

Parameters

ilCtrlTokenInterface

$token

Definition at line 59 of file class.ilCtrlTokenRepository.php.

                                                              : void
    {
        ilSession::set(ilCtrlInterface::PARAM_CSRF_TOKEN, serialize($token));
    }

References $token, ilCtrlInterface\PARAM_CSRF_TOKEN, and ilSession\set().

Referenced by getToken().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/UICore/classes/Token/class.ilCtrlTokenRepository.php