SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

auth.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

inc_auth_dist()  : array<string|int, mixed>|int|string
Teste l'authentification d'un visiteur
auth_controler_password_auteur_connecte()  : bool
Vérifier qu'un mot de passe saisi pour confirmer une action est bien celui de l'auteur connecté
auth_echec()  : array<string|int, mixed>|string
fonction appliquee par ecrire/index sur le resultat de la precedente en cas de refus de connexion.
auth_mode()  : array<string|int, mixed>|bool|string
Retourne la description d'un authentifie par cookie ou http_auth Et affecte la globale $connect_login
auth_init_droits()  : array<string|int, mixed>|string|bool
Initialisation des globales pour tout l'espace privé si visiteur connu
auth_desensibiliser_session()  : array<string|int, mixed>
Enlever les clés sensibles d'une ligne auteur
auth_a_loger()  : string
Retourne l'url de connexion
auth_trace()  : mixed
Tracer en base la date de dernière connexion de l'auteur
auth_administrer()  : mixed
Fonction privée d'aiguillage des fonctions d'authentification
auth_formulaire_login()  : array<string|int, mixed>
Pipeline pour inserer du contenu dans le formulaire de login
auth_retrouver_login()  : mixed
Retrouver le login interne lie a une info login saisie la saisie peut correspondre a un login delegue qui sera alors converti en login interne apres verification
auth_informer_login()  : array<string|int, mixed>
informer sur un login Ce dernier transmet le tableau ci-dessous a la fonction JS informer_auteur Il est invoque par la fonction JS actualise_auteur via la globale JS page_auteur=#URL_PAGE{informer_auteur} dans le squelette login N'y aurait-il pas plus simple ?
auth_identifier_login()  : mixed
Essayer les differentes sources d'authenfication dans l'ordre specifie.
auth_url_retour_login()  : string
Fournir une url de retour apres login par un SSO pour finir l'authentification
auth_terminer_identifier_login()  : mixed
Terminer l'action d'authentification d'un auteur
auth_loger()  : bool
Loger un auteur suite a son identification
auth_deloger()  : mixed
Déconnexion de l'auteur
auth_autoriser_modifier_login()  : bool
Tester la possibilité de modifier le login d'authentification pour la méthode donnée
auth_verifier_login()  : string
Verifier la validite d'un nouveau login pour modification pour la methode donnee
auth_modifier_login()  : bool
Modifier le login d'un auteur pour la methode donnee
auth_autoriser_modifier_pass()  : bool
Tester la possibilité de modifier le pass pour la méthode donnée
auth_verifier_pass()  : string
Verifier la validite d'un pass propose pour modification pour la methode donnee
auth_modifier_pass()  : bool
Modifier le mot de passe d'un auteur pour la methode donnee
auth_synchroniser_distant()  : mixed
Synchroniser un compte sur une base distante pour la methode donnée lorsque des modifications sont faites dans la base auteur
lire_php_auth()  : array<string|int, mixed>|bool
Vérifier si l'auteur est bien authentifié
ask_php_auth()  : mixed
entête php_auth (est-encore utilisé ?)

Functions

inc_auth_dist()

Teste l'authentification d'un visiteur

inc_auth_dist() : array<string|int, mixed>|int|string

Cette fonction ne fait pas l'authentification en soit ; elle vérifie simplement qu'une personne est connectée ou non.

Tags
used-by
exec_install_dist()
Return values
array<string|int, mixed>|int|string —
  • URL de connexion si on ne sait rien (pas de cookie, pas Auth_user);
  • un tableau si visiteur sans droit (tableau = sa ligne SQL)
  • code numerique d'erreur SQL
  • une chaîne vide si autorisation à pénétrer dans l'espace privé.

auth_controler_password_auteur_connecte()

Vérifier qu'un mot de passe saisi pour confirmer une action est bien celui de l'auteur connecté

auth_controler_password_auteur_connecte(string $password) : bool
Parameters
$password : string
Return values
bool

auth_echec()

fonction appliquee par ecrire/index sur le resultat de la precedente en cas de refus de connexion.

auth_echec(mixed $raison) : array<string|int, mixed>|string

Retourne un message a afficher ou redirige illico.

Parameters
$raison : mixed
Return values
array<string|int, mixed>|string

auth_mode()

Retourne la description d'un authentifie par cookie ou http_auth Et affecte la globale $connect_login

auth_mode() : array<string|int, mixed>|bool|string
Return values
array<string|int, mixed>|bool|string

auth_init_droits()

Initialisation des globales pour tout l'espace privé si visiteur connu

auth_init_droits(array<string|int, mixed> $row) : array<string|int, mixed>|string|bool

Le tableau global visiteur_session contient toutes les infos pertinentes et à jour (tandis que $visiteur_session peut avoir des valeurs un peu datées s'il est pris dans le fichier de session)

Les plus utiles sont aussi dans les variables simples ci-dessus si la globale est vide ce n'est pas un tableau, on la force pour empêcher un warning.

Parameters
$row : array<string|int, mixed>
Return values
array<string|int, mixed>|string|bool

auth_desensibiliser_session()

Enlever les clés sensibles d'une ligne auteur

auth_desensibiliser_session(array<string|int, mixed> $auteur) : array<string|int, mixed>
Parameters
$auteur : array<string|int, mixed>
Return values
array<string|int, mixed>

auth_a_loger()

Retourne l'url de connexion

auth_a_loger() : string
Return values
string

auth_trace()

Tracer en base la date de dernière connexion de l'auteur

auth_trace(array<string|int, mixed> $row[, null|string $date = null ]) : mixed
Parameters
$row : array<string|int, mixed>
$date : null|string = null
Tags
pipeline_appel

trig_auth_trace

auth_administrer()

Fonction privée d'aiguillage des fonctions d'authentification

auth_administrer(string $fonction, array<string|int, mixed> $args[, mixed $defaut = false ]) : mixed

Charge une fonction d'authentification présente dans un répertoire auth/. Ainsi, utiliser auth_administrer('informer_login', array('spip', ...) appellera auth_spip_informer_login() de ecrire/auth/spip.php.

Parameters
$fonction : string

Nom de la fonction d'authentification

$args : array<string|int, mixed>

Le premier élément du tableau doit être le nom du système d'authentification choisi, tel que spip (par défaut) ou encore ldap.

$defaut : mixed = false
Tags
uses
charger_fonction()
used-by
auth_terminer_identifier_login()
used-by
auth_autoriser_modifier_login()
used-by
auth_autoriser_modifier_pass()

auth_formulaire_login()

Pipeline pour inserer du contenu dans le formulaire de login

auth_formulaire_login(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

auth_retrouver_login()

Retrouver le login interne lie a une info login saisie la saisie peut correspondre a un login delegue qui sera alors converti en login interne apres verification

auth_retrouver_login(string $login[, string $serveur = '' ]) : mixed
Parameters
$login : string
$serveur : string = ''
Tags
@return

string/bool

auth_informer_login()

informer sur un login Ce dernier transmet le tableau ci-dessous a la fonction JS informer_auteur Il est invoque par la fonction JS actualise_auteur via la globale JS page_auteur=#URL_PAGE{informer_auteur} dans le squelette login N'y aurait-il pas plus simple ?

auth_informer_login(string $login[, string $serveur = '' ]) : array<string|int, mixed>
Parameters
$login : string
$serveur : string = ''
Return values
array<string|int, mixed>

auth_identifier_login()

Essayer les differentes sources d'authenfication dans l'ordre specifie.

auth_identifier_login(string $login, string $password[, string $serveur = '' ][, bool $phpauth = false ]) : mixed

S'en souvenir dans visiteur_session['auth']

Parameters
$login : string
$password : string
$serveur : string = ''
$phpauth : bool = false

auth_url_retour_login()

Fournir une url de retour apres login par un SSO pour finir l'authentification

auth_url_retour_login(string $auth_methode, string $login[, string $redirect = '' ][, string $serveur = '' ]) : string
Parameters
$auth_methode : string
$login : string
$redirect : string = ''
$serveur : string = ''
Return values
string

auth_terminer_identifier_login()

Terminer l'action d'authentification d'un auteur

auth_terminer_identifier_login(string $auth_methode, string $login[, string $serveur = '' ]) : mixed
Parameters
$auth_methode : string
$login : string
$serveur : string = ''
Tags
uses
auth_administrer()

auth_loger()

Loger un auteur suite a son identification

auth_loger(array<string|int, mixed> $auteur) : bool
Parameters
$auteur : array<string|int, mixed>
Return values
bool

auth_autoriser_modifier_login()

Tester la possibilité de modifier le login d'authentification pour la méthode donnée

auth_autoriser_modifier_login(string $auth_methode[, string $serveur = '' ]) : bool
Parameters
$auth_methode : string
$serveur : string = ''
Tags
uses
auth_administrer()
Return values
bool

auth_verifier_login()

Verifier la validite d'un nouveau login pour modification pour la methode donnee

auth_verifier_login(string $auth_methode, string $new_login[, int $id_auteur = 0 ][, string $serveur = '' ]) : string
Parameters
$auth_methode : string
$new_login : string
$id_auteur : int = 0
$serveur : string = ''
Return values
string —

message d'erreur ou chaine vide si pas d'erreur

auth_modifier_login()

Modifier le login d'un auteur pour la methode donnee

auth_modifier_login(string $auth_methode, string $new_login, int $id_auteur[, string $serveur = '' ]) : bool
Parameters
$auth_methode : string
$new_login : string
$id_auteur : int
$serveur : string = ''
Return values
bool

auth_autoriser_modifier_pass()

Tester la possibilité de modifier le pass pour la méthode donnée

auth_autoriser_modifier_pass(string $auth_methode[, string $serveur = '' ]) : bool
Parameters
$auth_methode : string
$serveur : string = ''
Tags
uses
auth_administrer()
Return values
bool —

succès ou échec

auth_verifier_pass()

Verifier la validite d'un pass propose pour modification pour la methode donnee

auth_verifier_pass(string $auth_methode, string $login, string $new_pass[, int $id_auteur = 0 ][, string $serveur = '' ]) : string
Parameters
$auth_methode : string
$login : string
$new_pass : string
$id_auteur : int = 0
$serveur : string = ''
Return values
string —

message d'erreur ou chaine vide si pas d'erreur

auth_modifier_pass()

Modifier le mot de passe d'un auteur pour la methode donnee

auth_modifier_pass(string $auth_methode, string $login, string $new_pass, int $id_auteur[, string $serveur = '' ]) : bool
Parameters
$auth_methode : string
$login : string
$new_pass : string
$id_auteur : int
$serveur : string = ''
Return values
bool —

succes ou echec

auth_synchroniser_distant()

Synchroniser un compte sur une base distante pour la methode donnée lorsque des modifications sont faites dans la base auteur

auth_synchroniser_distant([string|bool $auth_methode = true ][, int $id_auteur = 0 ][, array<string|int, mixed> $champs = [] ][, array<string|int, mixed> $options = [] ][, string $serveur = '' ]) : mixed
Parameters
$auth_methode : string|bool = true

ici true permet de forcer la synchronisation de tous les acces pour toutes les methodes

$id_auteur : int = 0
$champs : array<string|int, mixed> = []
$options : array<string|int, mixed> = []
$serveur : string = ''
Tags
used-by
base_upgrade_dist()

lire_php_auth()

Vérifier si l'auteur est bien authentifié

lire_php_auth(string $login, string $pw[, string $serveur = '' ]) : array<string|int, mixed>|bool
Parameters
$login : string
$pw : string
$serveur : string = ''
Return values
array<string|int, mixed>|bool

ask_php_auth()

entête php_auth (est-encore utilisé ?)

ask_php_auth(string $pb, string $raison[, string $retour = '' ][, string $url = '' ][, string $re = '' ][, string $lien = '' ]) : mixed
Parameters
$pb : string
$raison : string
$retour : string = ''
$url : string = ''
$re : string = ''
$lien : string = '' 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results