PHP Class sspmod_consent_Consent_Store_Cookie, simplesamlphp

This class implements a consent store which stores the consent information in cookies on the users computer. Example - Consent module with cookie store:


'authproc' => array(
  array(
    'consent:Consent',
    'store' => 'consent:Cookie',
    ),
  ),

Author: Olav Morken ([email protected])

Inheritance: extends sspmod_consent_Store

Show file Open project: simplesamlphp/simplesamlphp

Public Methods

Method	Description
deleteAllConsents ( string $userId ) : void	Delete consent.
deleteConsent ( string $userId, string $destinationId ) : void	Delete consent.
getConsents ( string $userId ) : array	Retrieve consents.
hasConsent ( string $userId, string $destinationId, string $attributeSet ) : boolean	Check for consent.
saveConsent ( string $userId, string $destinationId, string $attributeSet ) : void	Save consent.

Private Methods

Method	Description
_getCookieName ( string $userId, string $destinationId ) : string	Get cookie name.
_setConsentCookie ( string $name, string \| null $value ) : void	Helper function for setting a cookie.
_sign ( string $data ) : string	Calculate a signature of some data.
_verify ( string $signedData ) : string \| false	Verify signed data.

Method Details

deleteAllConsents() public method

Delete consent.

public deleteAllConsents ( string $userId ) : void
$userId	string	The hash identifying the user at an IdP.
return	void	This method does not return.

deleteConsent() public method

Called when a user revokes consent for a given destination.

public deleteConsent ( string $userId, string $destinationId ) : void
$userId	string	The hash identifying the user at an IdP.
$destinationId	string	A string which identifies the destination.
return	void

getConsents() public method

This function should return a list of consents the user has saved.

public getConsents ( string $userId ) : array
$userId	string	The hash identifying the user at an IdP.
return	array	Array of all destination ids the user has given consent for.

hasConsent() public method

This function checks whether a given user has authorized the release of the attributes identified by $attributeSet from $source to $destination.

public hasConsent ( string $userId, string $destinationId, string $attributeSet ) : boolean
$userId	string	The hash identifying the user at an IdP.
$destinationId	string	A string which identifies the destination.
$attributeSet	string	A hash which identifies the attributes.
return	boolean	True if the user has given consent earlier, false if not (or on error).

saveConsent() public method

Called when the user asks for the consent to be saved. If consent information for the given user and destination already exists, it should be overwritten.

public saveConsent ( string $userId, string $destinationId, string $attributeSet ) : void
$userId	string	The hash identifying the user at an IdP.
$destinationId	string	A string which identifies the destination.
$attributeSet	string	A hash which identifies the attributes.
return	void