acces.php
SPIP, Système de publication pour l'internet
Copyright © avec tendresse depuis 2001 Arnaud Martin, Antoine Pitrou, Philippe Rivière, Emmanuel Saint-James
Ce programme est un logiciel libre distribué sous licence GNU/GPL.
Table of Contents
Functions
- creer_pass_aleatoire() : string
- Créer un mot de passe
- creer_uniqid() : string
- Créer un identifiant aléatoire
- charger_aleas() : string
- Charge les aléas ehpémères s'il ne sont pas encore dans la globale
- renouvelle_alea() : mixed
- Renouveller l'alea (utilisé pour sécuriser les scripts du répertoire `action/`)
- low_sec() : string
- Retourne une clé de sécurité faible (low_sec) pour l'auteur indiqué
- securiser_acces_low_sec() : bool
- Vérifie un accès à faible sécurité
- generer_url_api_low_sec() : string
- Generer une url xxx.api/$id_auteur/$cle/$format/$fond?$args
- afficher_low_sec() : string
- Retourne une clé basée sur le low_sec de l'auteur et l'action demandé
- verifier_low_sec() : bool
- Vérifie une clé basée sur le low_sec de l'auteur et l'action demandé
- effacer_low_sec() : mixed
- Efface la clé de sécurité faible (low_sec) d'un auteur
- ecrire_acces() : null|void
- Créer un fichier htpasswd
- generer_htpasswd_files() : mixed
- Generer le fichier de htpasswd contenant les htpass
- generer_htpass() : void|string
- Créer un password htaccess
- verifier_htaccess() : bool
- Installe ou vérifie un fichier .htaccess, y compris sa prise en compte par Apache
- gerer_htaccess() : string
- Créer un fichier .htaccess pour chaque répertoire d'extension dans `_DIR_IMG` si la configuration le demande
Functions
creer_pass_aleatoire()
Créer un mot de passe
    
                    creer_pass_aleatoire([int $longueur = 16 ][, string $sel = '' ]) : string
    
        Parameters
- $longueur : int = 16
- 
                    Longueur du password créé 
- $sel : string = ''
- 
                    Clé pour un salage supplémentaire 
Return values
string —Mot de passe
creer_uniqid()
Créer un identifiant aléatoire
    
                    creer_uniqid() : string
    
    
    
            Return values
string —Identifiant
charger_aleas()
Charge les aléas ehpémères s'il ne sont pas encore dans la globale
    
                    charger_aleas() : string
        Si les métas 'alea_ephemere' et 'alea_ephemere_ancien' se sont pas encore chargées en méta (car elles ne sont pas stockées, pour sécurité, dans le fichier cache des métas), alors on les récupère en base. Et on les ajoute à nos métas globales.
Tags
Return values
string —Retourne l'alea éphemère actuel au passage
renouvelle_alea()
Renouveller l'alea (utilisé pour sécuriser les scripts du répertoire `action/`)
    
                    renouvelle_alea() : mixed
    
    
    
    
low_sec()
Retourne une clé de sécurité faible (low_sec) pour l'auteur indiqué
    
                    low_sec(int $id_auteur) : string
        low-security est un ensemble de fonctions pour gérer de l'identification faible via les URLs (suivi RSS, iCal...)
Retourne la clé de sécurité low_sec de l'auteur (la génère si elle n'exite pas) ou la clé de sécurité low_sec du site (si auteur invalide)(la génère si elle n'existe pas).
Parameters
- $id_auteur : int
- 
                    Identifiant de l'auteur 
Return values
string —Clé de sécurité.
securiser_acces_low_sec()
Vérifie un accès à faible sécurité
    
                    securiser_acces_low_sec(int $id_auteur, string $cle, string $dir[, string $op = '' ][, string $args = '' ]) : bool
        Vérifie qu'un visiteur peut accéder à la page demandée, qui est protégée par une clé, calculée à partir du low_sec de l'auteur, et des paramètres le composant l'appel (op, args)
Parameters
- $id_auteur : int
- 
                    L'auteur qui demande la page 
- $cle : string
- 
                    La clé à tester 
- $dir : string
- 
                    Un type d'accès (nom du répertoire dans lequel sont rangés les squelettes demandés, tel que 'rss') 
- $op : string = ''
- 
                    Nom de l'opération éventuelle 
- $args : string = ''
- 
                    Nom de l'argument calculé 
Tags
Return values
bool —True si on a le droit d'accès, false sinon.
*@example
[(#ID_AUTEUR|securiser_acces{#ENV{cle}, rss, #ENV{op}, #ENV{args}}|sinon_interdire_acces)]
generer_url_api_low_sec()
Generer une url xxx.api/$id_auteur/$cle/$format/$fond?$args
    
                    generer_url_api_low_sec(string $script, string $format, string $fond, string $path, string $args[, bool $no_entities = false ][, bool|null $public = null ]) : string
    
        Parameters
- $script : string
- $format : string
- $fond : string
- $path : string
- $args : string
- $no_entities : bool = false
- $public : bool|null = null
Return values
stringafficher_low_sec()
Retourne une clé basée sur le low_sec de l'auteur et l'action demandé
    
                    afficher_low_sec(int $id_auteur[, string $action = '' ]) : string
    
        Parameters
- $id_auteur : int
- 
                    Identifiant de l'auteur 
- $action : string = ''
- 
                    Action désirée 
Tags
Return values
string —Clé
verifier_low_sec()
Vérifie une clé basée sur le low_sec de l'auteur et l'action demandé
    
                    verifier_low_sec(int $id_auteur, string $cle[, string $action = '' ]) : bool
    
        Parameters
- $id_auteur : int
- 
                    Identifiant de l'auteur 
- $cle : string
- 
                    Clé à comparer 
- $action : string = ''
- 
                    Action désirée 
Tags
Return values
bool —true si les clés corresponde, false sinon
effacer_low_sec()
Efface la clé de sécurité faible (low_sec) d'un auteur
    
                    effacer_low_sec(int $id_auteur) : mixed
    
        Parameters
- $id_auteur : int
- 
                    Identifiant de l'auteur 
ecrire_acces()
Créer un fichier htpasswd
    
                    ecrire_acces() : null|void
        Cette fonction ne sert qu'à la connexion en mode http_auth.non LDAP. Voir le plugin «Accès Restreint»
S'appuie sur la meta creer_htpasswd pour savoir s'il faut créer
le .htpasswd.
Return values
null|void —- null si pas de htpasswd à créer, ou si LDAP
- void sinon.
generer_htpasswd_files()
Generer le fichier de htpasswd contenant les htpass
    
                    generer_htpasswd_files(string $htpasswd, string $htpasswd_admin) : mixed
    
        Parameters
- $htpasswd : string
- $htpasswd_admin : string
generer_htpass()
Créer un password htaccess
    
                    generer_htpass(string $pass) : void|string
    
        Parameters
- $pass : string
- 
                    Le mot de passe 
Tags
Return values
void|string —La chaîne hachée si fonction crypt présente, rien sinon.
verifier_htaccess()
Installe ou vérifie un fichier .htaccess, y compris sa prise en compte par Apache
    
                    verifier_htaccess(string $rep[, bool $force = false ]) : bool
    
        Parameters
- $rep : string
- 
                    Nom du répertoire où SPIP doit vérifier l'existence d'un fichier .htaccess 
- $force : bool = false
Tags
Return values
boolgerer_htaccess()
Créer un fichier .htaccess pour chaque répertoire d'extension dans `_DIR_IMG` si la configuration le demande
    
                    gerer_htaccess() : string
    
    
    
    Tags
Return values
string —Valeur de la configuration creer_htaccess