Documentation du code de SPIP et de ses plugins

SPIP

SpipCles
in package

FinalYes

Gestion des clés d’authentification / chiffrement de SPIP

Table of Contents

Properties

$cles  : Cles
$file  : string
$hostingKey  : string
$instances  : array<string|int, mixed>
$meta  : mixed

Methods

backup()  : string
Fournir une sauvegarde chiffree des cles (a l'aide d'une autre clé, comme le pass d'un auteur)
getSecretActions()  : string|null
Renvoyer le secret des actions
getSecretAuth()  : string|null
Renvoyer le secret des authentifications
getSecretSite()  : string|null
Renvoyer le secret du site
instance()  : self
restore()  : bool
Restaurer les cles manquantes depuis une sauvegarde chiffree des cles (si la sauvegarde est bien valide)
save()  : bool
secret_des_actions()  : string|null
Retourne le secret des actions (shorthand)
secret_du_site()  : string|null
Retourne le secret du site (shorthand)
__construct()  : mixed
_xor()  : string
getCachableKeyValue()  : string
getHostingKey()  : string
getKey()  : string|null
getKeyfromCachedValue()  : string|null
getMetaKey()  : string|null
Lit la clé `$name` en meta
read()  : array<string|int, mixed>

Properties

$instances

private static array<string|int, mixed> $instances = []

Methods

backup()

Fournir une sauvegarde chiffree des cles (a l'aide d'une autre clé, comme le pass d'un auteur)

public backup(string $withKey) : string
Parameters
$withKey : string

Clé de chiffrage de la sauvegarde

Return values
string —

Contenu de la sauvegarde chiffrée générée

getSecretActions()

Renvoyer le secret des actions

public getSecretActions([bool $autoInit = true ]) : string|null
Parameters
$autoInit : bool = true
Return values
string|null

getSecretAuth()

Renvoyer le secret des authentifications

public getSecretAuth([bool $autoInit = false ]) : string|null
Parameters
$autoInit : bool = false
Return values
string|null

getSecretSite()

Renvoyer le secret du site

public getSecretSite([bool $autoInit = true ]) : string|null

Le secret du site doit rester aussi secret que possible, et est eternel On ne doit pas l'exporter

Le secret est partagé entre une clé disque et une clé bdd

Parameters
$autoInit : bool = true
Return values
string|null

instance()

public static instance([string $file = '' ]) : self
Parameters
$file : string = ''
Return values
self

restore()

Restaurer les cles manquantes depuis une sauvegarde chiffree des cles (si la sauvegarde est bien valide)

public restore(string $backup, string $password_clair, string $password_hash, int $id_auteur) : bool
Parameters
$backup : string
$password_clair : string
$password_hash : string
$id_auteur : int
Return values
bool

secret_des_actions()

Retourne le secret des actions (shorthand)

public static secret_des_actions() : string|null
Tags
uses
self::getSecretActions()
Return values
string|null

secret_du_site()

Retourne le secret du site (shorthand)

public static secret_du_site() : string|null
Tags
uses
self::getSecretSite()
Return values
string|null

__construct()

private __construct([string $file = '' ]) : mixed
Parameters
$file : string = ''

_xor()

private _xor(string $message, string $key) : string
Parameters
$message : string
$key : string
Return values
string

getCachableKeyValue()

private getCachableKeyValue(string $key) : string
Parameters
$key : string
Return values
string

getHostingKey()

private getHostingKey() : string
Return values
string

getKey()

private getKey(string $name, bool $autoInit) : string|null
Parameters
$name : string
$autoInit : bool
Return values
string|null

getKeyfromCachedValue()

private getKeyfromCachedValue(string $cachedValue) : string|null
Parameters
$cachedValue : string
Return values
string|null

getMetaKey()

Lit la clé `$name` en meta

private getMetaKey(string $name[, bool $autoInit = true ]) : string|null

La meta $name est déclarée sensible (spip.config.sensitive_keys) : elle n'est ni dans le cache de config ni dans $GLOBALS['meta'], et sa lecture coûte une requête SQL. Hors CLI, on lui adjoint une meta cache_{$name} cachable, brouillée par une clé liée à l'hébergement, qui évite cette requête à chaque hit. Elle doit être préfixée et non suffixée : toute meta secret_* est sensible, donc jamais cachée. En CLI la clé d'hébergement diffère de celle en HTTP : on lit toujours la meta $name.

Parameters
$name : string
$autoInit : bool = true
Return values
string|null

read()

private read() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results