| 1 |
<?php
|
1 |
<?php
|
| 2 |
|
2 |
|
| 3 |
// composer
|
3 |
// composer
|
| 4 |
require_once '../vendor/autoload.php';
|
4 |
require_once '../vendor/autoload.php';
|
| 5 |
|
5 |
|
| 6 |
/**
|
6 |
/**
|
| 7 |
* Tentative de service d'authentification / SSO bien organisé
|
7 |
* Tentative de service d'authentification / SSO bien organisé
|
| 8 |
* SSO - Mettez un tigre dans votre annuaire !
|
8 |
* SSO - Mettez un tigre dans votre annuaire !
|
| 9 |
* @author mathias
|
9 |
* @author mathias
|
| 10 |
* © Tela Botanica 2015
|
10 |
* © Tela Botanica 2015
|
| 11 |
*
|
11 |
*
|
| 12 |
* @TODO se baser sur autre chose que JRest qui est obsolète
|
12 |
* @TODO se baser sur autre chose que JRest qui est obsolète
|
| 13 |
*/
|
13 |
*/
|
| 14 |
class Auth extends JRestService {
|
14 |
class Auth extends JRestService {
|
| 15 |
|
15 |
|
| 16 |
/** Clef utilisée pour signer les jetons JWT */
|
16 |
/** Clef utilisée pour signer les jetons JWT */
|
| 17 |
private $clef;
|
17 |
private $clef;
|
| 18 |
|
18 |
|
| 19 |
/** Si true, refusera une connexion non-HTTPS */
|
19 |
/** Si true, refusera une connexion non-HTTPS */
|
| 20 |
protected $forcerSSL = true;
|
20 |
protected $forcerSSL = true;
|
| 21 |
|
21 |
|
| 22 |
/** Durée en secondes du jeton (doit être faible en l'absence de mécanisme d'invalidation) */
|
22 |
/** Durée en secondes du jeton (doit être faible en l'absence de mécanisme d'invalidation) */
|
| 23 |
protected $dureeJeton = 900;
|
23 |
protected $dureeJeton = 900;
|
| 24 |
|
24 |
|
| 25 |
/** Durée en secondes du cookie */
|
25 |
/** Durée en secondes du cookie */
|
| 26 |
protected $dureeCookie = 31536000; // 3600 * 24 * 365
|
26 |
protected $dureeCookie = 31536000; // 3600 * 24 * 365
|
| 27 |
|
27 |
|
| 28 |
/** Nom du cookie */
|
28 |
/** Nom du cookie */
|
| 29 |
protected $nomCookie = "this_is_not_a_good_cookie_name";
|
29 |
protected $nomCookie = "this_is_not_a_good_cookie_name";
|
| 30 |
|
30 |
|
| 31 |
public function __construct($config, $demarrer_session = true) {
|
31 |
public function __construct($config, $demarrer_session = true) {
|
| 32 |
parent::__construct($config, $demarrer_session);
|
32 |
parent::__construct($config, $demarrer_session);
|
| 33 |
$this->clef = file_get_contents("clef-auth.ini");
|
33 |
$this->clef = file_get_contents("clef-auth.ini");
|
| 34 |
if (strlen($this->clef) < 16) {
|
34 |
if (strlen($this->clef) < 16) {
|
| 35 |
throw new Exception("Clef trop courte - placez une clef d'au moins 16 caractères dans configurations/clef-auth.ini");
|
35 |
throw new Exception("Clef trop courte - placez une clef d'au moins 16 caractères dans configurations/clef-auth.ini");
|
| 36 |
}
|
36 |
}
|
| 37 |
$this->forcerSSL = ($this->config['auth']['forcer_ssl'] == "1");
|
37 |
$this->forcerSSL = ($this->config['auth']['forcer_ssl'] == "1");
|
| 38 |
$this->dureeJeton = $this->config['auth']['duree_jeton'];
|
38 |
$this->dureeJeton = $this->config['auth']['duree_jeton'];
|
| 39 |
$this->dureeCookie = $this->config['auth']['duree_cookie'];
|
39 |
$this->dureeCookie = $this->config['auth']['duree_cookie'];
|
| 40 |
$this->nomCookie = $this->config['auth']['nom_cookie'];
|
40 |
$this->nomCookie = $this->config['auth']['nom_cookie'];
|
| 41 |
}
|
41 |
}
|
| 42 |
|
42 |
|
| 43 |
/**
|
43 |
/**
|
| 44 |
* Notice d'utilisation succincte
|
44 |
* Notice d'utilisation succincte
|
| 45 |
* @TODO essayer de choisir entre anglais et français
|
45 |
* @TODO essayer de choisir entre anglais et français
|
| 46 |
*/
|
46 |
*/
|
| 47 |
protected function infosService() {
|
47 |
protected function infosService() {
|
| 48 |
$uri = $this->config['settings']['baseAlternativeURL'];
|
48 |
$uri = $this->config['settings']['baseAlternativeURL'];
|
| 49 |
if ($uri == '') {
|
49 |
if ($uri == '') {
|
| 50 |
$uri = $this->config['settings']['baseURL'];
|
50 |
$uri = $this->config['settings']['baseURL'];
|
| 51 |
}
|
51 |
}
|
| 52 |
$uri = $uri . "auth/";
|
52 |
$uri = $uri . "auth/";
|
| 53 |
|
53 |
|
| 54 |
$infos = array(
|
54 |
$infos = array(
|
| 55 |
'service' => 'TelaBotanica/annuaire/auth',
|
55 |
'service' => 'TelaBotanica/annuaire/auth',
|
| 56 |
'methodes' => array(
|
56 |
'methodes' => array(
|
| 57 |
'connexion' => array(
|
57 |
'connexion' => array(
|
| 58 |
"uri" => $uri . "connexion",
|
58 |
"uri" => $uri . "connexion",
|
| 59 |
"parametres" => array(
|
59 |
"parametres" => array(
|
| 60 |
"login" => "adresse email (ex: name@domain.com)",
|
60 |
"login" => "adresse email (ex: name@domain.com)",
|
| 61 |
"password" => "mot de passe"
|
61 |
"password" => "mot de passe"
|
| 62 |
),
|
62 |
),
|
| 63 |
"alias" => $uri . "login",
|
63 |
"alias" => $uri . "login",
|
| 64 |
"description" => "connexion avec login et mot de passe; renvoie un jeton et un cookie " . $this->nomCookie
|
64 |
"description" => "connexion avec login et mot de passe; renvoie un jeton et un cookie " . $this->nomCookie
|
| 65 |
),
|
65 |
),
|
| 66 |
'deconnexion' => array(
|
66 |
'deconnexion' => array(
|
| 67 |
"uri" => $uri . "deconnexion",
|
67 |
"uri" => $uri . "deconnexion",
|
| 68 |
"parametres" => null,
|
68 |
"parametres" => null,
|
| 69 |
"alias" => $uri . "logout",
|
69 |
"alias" => $uri . "logout",
|
| 70 |
"description" => "déconnexion; renvoie un jeton null et supprime le cookie " . $this->nomCookie
|
70 |
"description" => "déconnexion; renvoie un jeton null et supprime le cookie " . $this->nomCookie
|
| 71 |
),
|
71 |
),
|
| 72 |
'identite' => array(
|
72 |
'identite' => array(
|
| 73 |
"uri" => $uri . "identite",
|
73 |
"uri" => $uri . "identite",
|
| 74 |
"parametres" => array(
|
74 |
"parametres" => array(
|
| 75 |
"token" => "jeton JWT (facultatif)",
|
75 |
"token" => "jeton JWT (facultatif)",
|
| 76 |
),
|
76 |
),
|
| 77 |
"alias" => array(
|
77 |
"alias" => array(
|
| 78 |
$uri . "identity",
|
78 |
$uri . "identity",
|
| 79 |
$uri . "rafraichir",
|
79 |
$uri . "rafraichir",
|
| 80 |
$uri . "refresh"
|
80 |
$uri . "refresh"
|
| 81 |
),
|
81 |
),
|
| 82 |
"description" => "confirme l'authentification et la session; rafraîchit le jeton fourni (dans le cookie " . $this->nomCookie . ", le header Authorization ou en paramètre)"
|
82 |
"description" => "confirme l'authentification et la session; rafraîchit le jeton fourni (dans le cookie " . $this->nomCookie . ", le header Authorization ou en paramètre)"
|
| 83 |
),
|
83 |
),
|
| 84 |
'verifierjeton' => array(
|
84 |
'verifierjeton' => array(
|
| 85 |
"uri" => $uri . "verifierjeton",
|
85 |
"uri" => $uri . "verifierjeton",
|
| 86 |
"parametres" => array(
|
86 |
"parametres" => array(
|
| 87 |
"token" => "jeton JWT",
|
87 |
"token" => "jeton JWT",
|
| 88 |
),
|
88 |
),
|
| 89 |
"alias" => $uri . "verifytoken",
|
89 |
"alias" => $uri . "verifytoken",
|
| 90 |
"description" => "retourne true si le jeton fourni en paramètre ou dans le header Authorization est valide, une erreur sinon"
|
90 |
"description" => "retourne true si le jeton fourni en paramètre ou dans le header Authorization est valide, une erreur sinon"
|
| 91 |
)
|
91 |
)
|
| 92 |
)
|
92 |
)
|
| 93 |
);
|
93 |
);
|
| 94 |
$this->envoyerJson($infos);
|
94 |
$this->envoyerJson($infos);
|
| 95 |
}
|
95 |
}
|
| 96 |
|
96 |
|
| 97 |
/**
|
97 |
/**
|
| 98 |
* Lorsqu'appelé sans éléments d'URL (service:annuaire:auth);
|
98 |
* Lorsqu'appelé sans éléments d'URL (service:annuaire:auth);
|
| 99 |
* les paramètres GET sont ignorés
|
99 |
* les paramètres GET sont ignorés
|
| 100 |
*/
|
100 |
*/
|
| 101 |
public function getRessource() {
|
101 |
public function getRessource() {
|
| 102 |
//echo "get ressource\n";
|
102 |
//echo "get ressource\n";
|
| 103 |
$this->infosService();
|
103 |
$this->infosService();
|
| 104 |
}
|
104 |
}
|
| 105 |
|
105 |
|
| 106 |
/**
|
106 |
/**
|
| 107 |
* Lorsqu'appelé avec des éléments d'URL (service:annuaire:auth/machin/chose);
|
107 |
* Lorsqu'appelé avec des éléments d'URL (service:annuaire:auth/machin/chose);
|
| 108 |
* les paramètres GET sont ignorés
|
108 |
* les paramètres GET sont ignorés
|
| 109 |
*
|
109 |
*
|
| 110 |
* @param array $ressources les éléments d'URL
|
110 |
* @param array $ressources les éléments d'URL
|
| 111 |
*/
|
111 |
*/
|
| 112 |
public function getElement($ressources) {
|
112 |
public function getElement($ressources) {
|
| 113 |
// Achtétépéèch portouguech lolch
|
113 |
// Achtétépéèch portouguech lolch
|
| 114 |
$this->verifierSSL();
|
114 |
$this->verifierSSL();
|
| 115 |
// le premier paramètre d'URL définit la méthode (non-magique)
|
115 |
// le premier paramètre d'URL définit la méthode (non-magique)
|
| 116 |
if (count($ressources) > 0) {
|
116 |
if (count($ressources) > 0) {
|
| 117 |
switch ($ressources[0]) {
|
117 |
switch ($ressources[0]) {
|
| 118 |
case 'login':
|
118 |
case 'login':
|
| 119 |
case 'connexion':
|
119 |
case 'connexion':
|
| 120 |
$this->connexion($ressources);
|
120 |
$this->connexion($ressources);
|
| 121 |
break;
|
121 |
break;
|
| 122 |
case 'logout':
|
122 |
case 'logout':
|
| 123 |
case 'deconnexion':
|
123 |
case 'deconnexion':
|
| 124 |
$this->deconnexion();
|
124 |
$this->deconnexion();
|
| 125 |
break;
|
125 |
break;
|
| 126 |
case 'identity':
|
126 |
case 'identity':
|
| 127 |
case 'identite':
|
127 |
case 'identite':
|
| 128 |
case 'rafraichir':
|
128 |
case 'rafraichir':
|
| 129 |
case 'refresh':
|
129 |
case 'refresh':
|
| 130 |
$this->identite();
|
130 |
$this->identite();
|
| 131 |
break;
|
131 |
break;
|
| 132 |
case 'verifytoken':
|
132 |
case 'verifytoken':
|
| 133 |
case 'verifierjeton':
|
133 |
case 'verifierjeton':
|
| 134 |
$this->verifierJeton();
|
134 |
$this->verifierJeton();
|
| 135 |
break;
|
135 |
break;
|
| 136 |
case 'info':
|
136 |
case 'info':
|
| 137 |
default:
|
137 |
default:
|
| 138 |
$this->infosService();
|
138 |
$this->infosService();
|
| 139 |
}
|
139 |
}
|
| 140 |
}
|
140 |
}
|
| 141 |
}
|
141 |
}
|
| 142 |
|
142 |
|
| 143 |
/**
|
143 |
/**
|
| 144 |
* Lors d'un POST avec au moins une donnée dans le body (data);
|
144 |
* Lors d'un POST avec au moins une donnée dans le body (data);
|
| 145 |
* les paramètres GET sont ignorés
|
145 |
* les paramètres GET sont ignorés
|
| 146 |
* @TODO faire un point d'entrée POST qui renvoie vers les méthodes GET
|
146 |
* @TODO faire un point d'entrée POST qui renvoie vers les méthodes GET
|
| 147 |
*
|
147 |
*
|
| 148 |
* @param array $ressources les éléments d'URL
|
148 |
* @param array $ressources les éléments d'URL
|
| 149 |
* @param array $pairs les paramètres POST
|
149 |
* @param array $pairs les paramètres POST
|
| 150 |
*/
|
150 |
*/
|
| 151 |
public function updateElement($ressources, $pairs) {
|
151 |
public function updateElement($ressources, $pairs) {
|
| 152 |
//echo "update element\n";
|
152 |
//echo "update element\n";
|
| 153 |
$this->nonImplemente();
|
153 |
$this->nonImplemente();
|
| 154 |
}
|
154 |
}
|
| 155 |
|
155 |
|
| 156 |
/**
|
156 |
/**
|
| 157 |
* Lors d'un PUT (les éléments d'URL sont ignorés) ou d'un POST avec au moins
|
157 |
* Lors d'un PUT (les éléments d'URL sont ignorés) ou d'un POST avec au moins
|
| 158 |
* un élément d'URL; dans tous les cas les paramètres GET sont ignorés
|
158 |
* un élément d'URL; dans tous les cas les paramètres GET sont ignorés
|
| 159 |
*
|
159 |
*
|
| 160 |
* @param array $pairs les paramètres POST
|
160 |
* @param array $pairs les paramètres POST
|
| 161 |
*/
|
161 |
*/
|
| 162 |
public function createElement($pairs) {
|
162 |
public function createElement($pairs) {
|
| 163 |
//echo "create element\n";
|
163 |
//echo "create element\n";
|
| 164 |
$this->nonImplemente();
|
164 |
$this->nonImplemente();
|
| 165 |
}
|
165 |
}
|
| 166 |
|
166 |
|
| 167 |
/**
|
167 |
/**
|
| 168 |
* Lors d'un DELETE avec au moins un élément d'URL
|
168 |
* Lors d'un DELETE avec au moins un élément d'URL
|
| 169 |
* @TODO utiliser pour invalider un jeton (nécessite stockage)
|
169 |
* @TODO utiliser pour invalider un jeton (nécessite stockage)
|
| 170 |
*
|
170 |
*
|
| 171 |
* @param array $ressources les éléments d'URL
|
171 |
* @param array $ressources les éléments d'URL
|
| 172 |
*/
|
172 |
*/
|
| 173 |
public function deleteElement($ressources) {
|
173 |
public function deleteElement($ressources) {
|
| 174 |
//echo "delete element\n";
|
174 |
//echo "delete element\n";
|
| 175 |
$this->nonImplemente();
|
175 |
$this->nonImplemente();
|
| 176 |
}
|
176 |
}
|
| 177 |
|
177 |
|
| 178 |
/**
|
178 |
/**
|
| 179 |
* Vérifie l'identité d'un utilisateur à partir de son courriel et son
|
179 |
* Vérifie l'identité d'un utilisateur à partir de son courriel et son
|
| 180 |
* mot de passe ou d'un cookie; lui accorde un jeton et un cookie si
|
180 |
* mot de passe ou d'un cookie; lui accorde un jeton et un cookie si
|
| 181 |
* tout va bien, sinon renvoie une erreur et détruit le cookie
|
181 |
* tout va bien, sinon renvoie une erreur et détruit le cookie
|
| 182 |
* @WARNING si vous n'utilisez pas urlencode() pour fournir le mot de passe,
|
182 |
* @WARNING si vous n'utilisez pas urlencode() pour fournir le mot de passe,
|
| 183 |
* le caractère "&" posera problème en GET
|
183 |
* le caractère "&" posera problème en GET
|
| 184 |
*
|
184 |
*
|
| 185 |
* @param array $ressources non utilisé
|
185 |
* @param array $ressources non utilisé
|
| 186 |
*/
|
186 |
*/
|
| 187 |
protected function connexion($ressources) {
|
187 |
protected function connexion($ressources) {
|
| 188 |
$login = $this->getParam('login');
|
188 |
$login = $this->getParam('login');
|
| 189 |
$password = $this->getParam('password', null);
|
189 |
$password = $this->getParam('password', null);
|
| 190 |
if ($login == '' || $password == '') {
|
190 |
if ($login == '' || $password == '') {
|
| 191 |
$this->erreur("parameters <login> and <password> required");
|
191 |
$this->erreur("parameters <login> and <password> required");
|
| 192 |
}
|
192 |
}
|
| 193 |
// vérification login / password
|
193 |
// vérification login / password
|
| 194 |
$acces = $this->verifierAcces($login, $password);
|
194 |
$acces = $this->verifierAcces($login, $password);
|
| 195 |
if ($acces === false) {
|
195 |
if ($acces === false) {
|
| 196 |
$this->detruireCookie();
|
196 |
$this->detruireCookie();
|
| 197 |
if(!empty($_GET['redirect_url'])) {
|
- |
|
| 198 |
header('Location: '.$_GET['redirect_url']);
|
197 |
// redirection si demandée - se charge de sortir du script en cas de succès
|
| 199 |
exit;
|
198 |
$this->rediriger();
|
| 200 |
} else {
|
199 |
// si la redirection n'a pas eu lieu
|
| 201 |
$this->erreur("authentication failed", 401);
|
200 |
$this->erreur("authentication failed", 401);
|
| 202 |
}
|
- |
|
| 203 |
|
- |
|
| 204 |
}
|
201 |
}
|
| 205 |
// infos utilisateur
|
202 |
// infos utilisateur
|
| 206 |
$util = new Utilisateur($this->config);
|
203 |
$util = new Utilisateur($this->config);
|
| 207 |
$infos = $util->getIdentiteParCourriel($login);
|
204 |
$infos = $util->getIdentiteParCourriel($login);
|
| 208 |
if (count($infos) == 0 || empty($infos[$login])) {
|
205 |
if (count($infos) == 0 || empty($infos[$login])) {
|
| 209 |
if(!empty($_GET['redirect_url'])) {
|
- |
|
| 210 |
header('Location: '.$_GET['redirect_url']);
|
206 |
// redirection si demandée - se charge de sortir du script en cas de succès
|
| 211 |
exit;
|
207 |
$this->rediriger();
|
| 212 |
} else {
|
208 |
// si la redirection n'a pas eu lieu
|
| 213 |
$this->erreur("could not get user info");
|
209 |
$this->erreur("could not get user info");
|
| 214 |
}
|
- |
|
| 215 |
}
|
210 |
}
|
| 216 |
// nom Wiki
|
211 |
// nom Wiki
|
| 217 |
$infos[$login]['nomWiki'] = $util->formaterNomWiki($infos[$login], "UnknownWikiName");
|
212 |
$infos[$login]['nomWiki'] = $util->formaterNomWiki($infos[$login], "UnknownWikiName");
|
| 218 |
// date de dernière modification du profil
|
213 |
// date de dernière modification du profil
|
| 219 |
$dateDerniereModif = $util->getDateDerniereModifProfil($infos[$login]['id'], true);
|
214 |
$dateDerniereModif = $util->getDateDerniereModifProfil($infos[$login]['id'], true);
|
| 220 |
$infos[$login]['dateDerniereModif'] = $dateDerniereModif;
|
215 |
$infos[$login]['dateDerniereModif'] = $dateDerniereModif;
|
| 221 |
// création du jeton
|
216 |
// création du jeton
|
| 222 |
$jwt = $this->creerJeton($login, $infos[$login]);
|
217 |
$jwt = $this->creerJeton($login, $infos[$login]);
|
| 223 |
// création du cookie
|
218 |
// création du cookie
|
| 224 |
$this->creerCookie($jwt);
|
219 |
$this->creerCookie($jwt);
|
| 225 |
|
- |
|
| 226 |
if(!empty($_GET['redirect_url'])) {
|
220 |
// redirection si demandée - se charge de sortir du script en cas de succès
|
| 227 |
$this->redirigerAvecJeton($_GET['redirect_url'], $jwt);
|
221 |
$this->rediriger($jwt);
|
| 228 |
} else {
|
- |
|
| 229 |
// envoi
|
222 |
// envoi
|
| 230 |
$this->envoyerJson(array(
|
223 |
$this->envoyerJson(array(
|
| 231 |
"session" => true,
|
224 |
"session" => true,
|
| 232 |
"token" => $jwt,
|
225 |
"token" => $jwt,
|
| 233 |
"duration" => intval($this->dureeJeton),
|
226 |
"duration" => intval($this->dureeJeton),
|
| 234 |
"token_id" => $this->nomCookie,
|
227 |
"token_id" => $this->nomCookie,
|
| 235 |
"last_modif" => $infos[$login]['dateDerniereModif']
|
228 |
"last_modif" => $infos[$login]['dateDerniereModif']
|
| 236 |
));
|
229 |
));
|
| 237 |
}
|
- |
|
| 238 |
}
|
230 |
}
|
| 239 |
|
231 |
|
| 240 |
/**
|
232 |
/**
|
| 241 |
* Détruit le cookie et renvoie un jeton vide ou NULL - le client
|
233 |
* Détruit le cookie et renvoie un jeton vide ou NULL - le client
|
| 242 |
* devrait toujours remplacer son jeton par celui renvoyé par les
|
234 |
* devrait toujours remplacer son jeton par celui renvoyé par les
|
| 243 |
* méthodes de l'annuaire
|
235 |
* méthodes de l'annuaire
|
| 244 |
*/
|
236 |
*/
|
| 245 |
protected function deconnexion() {
|
237 |
protected function deconnexion() {
|
| 246 |
// suppression du cookie
|
238 |
// suppression du cookie
|
| 247 |
$this->detruireCookie();
|
239 |
$this->detruireCookie();
|
| 248 |
// envoi d'un jeton null
|
240 |
// envoi d'un jeton null
|
| 249 |
$jwt = null;
|
241 |
$jwt = null;
|
| 250 |
if(!empty($_GET['redirect_url'])) {
|
242 |
// redirection si demandée - se charge de sortir du script en cas de succès
|
| 251 |
header('Location: '.$_GET['redirect_url']);
|
243 |
$this->rediriger();
|
| 252 |
} else {
|
244 |
// si la redirection n'a pas eu lieu
|
| 253 |
$this->envoyerJson(array(
|
245 |
$this->envoyerJson(array(
|
| 254 |
"session" => false,
|
246 |
"session" => false,
|
| 255 |
"token" => $jwt,
|
247 |
"token" => $jwt,
|
| 256 |
"token_id" => $this->nomCookie
|
248 |
"token_id" => $this->nomCookie
|
| 257 |
));
|
249 |
));
|
| 258 |
}
|
- |
|
| 259 |
}
|
250 |
}
|
| 260 |
|
251 |
|
| 261 |
/**
|
252 |
/**
|
| 262 |
* Renvoie un jeton rafraîchi (durée de validité augmentée de $this->dureeJeton
|
253 |
* Renvoie un jeton rafraîchi (durée de validité augmentée de $this->dureeJeton
|
| 263 |
* si l'utilisateur est reconnu comme détenteur d'une session active (cookie valide,
|
254 |
* si l'utilisateur est reconnu comme détenteur d'une session active (cookie valide,
|
| 264 |
* header HTTP "Authorization" ou jeton valide); renvoie une erreur si le cookie
|
255 |
* header HTTP "Authorization" ou jeton valide); renvoie une erreur si le cookie
|
| 265 |
* et/ou le jeton sont expirés;
|
256 |
* et/ou le jeton sont expirés;
|
| 266 |
* cela permet en théorie de forger des cookies avec des jetons expirés pour se les
|
257 |
* cela permet en théorie de forger des cookies avec des jetons expirés pour se les
|
| 267 |
* faire rafraîchir frauduleusement, mais le canal HTTPS fait qu'un client ne peut
|
258 |
* faire rafraîchir frauduleusement, mais le canal HTTPS fait qu'un client ne peut
|
| 268 |
* être en possession que de ses propres jetons... au pire on peut se faire prolonger
|
259 |
* être en possession que de ses propres jetons... au pire on peut se faire prolonger
|
| 269 |
* à l'infini même si on n'est plus inscrit à l'annuaire... @TODO faire mieux un jour
|
260 |
* à l'infini même si on n'est plus inscrit à l'annuaire... @TODO faire mieux un jour
|
| 270 |
* Priorité : cookie > header "Authorization" > paramètre "token" @TODO vérifier cette
|
261 |
* Priorité : cookie > header "Authorization" > paramètre "token" @TODO vérifier cette
|
| 271 |
* stratégie, l'inverse est peut-être plus malin
|
262 |
* stratégie, l'inverse est peut-être plus malin
|
| 272 |
*/
|
263 |
*/
|
| 273 |
protected function identite() {
|
264 |
protected function identite() {
|
| 274 |
$cookieAvecJetonValide = false;
|
265 |
$cookieAvecJetonValide = false;
|
| 275 |
$jetonRetour = null;
|
266 |
$jetonRetour = null;
|
| 276 |
$erreur = '';
|
267 |
$erreur = '';
|
| 277 |
// lire cookie
|
268 |
// lire cookie
|
| 278 |
if (isset($_COOKIE[$this->nomCookie])) {
|
269 |
if (isset($_COOKIE[$this->nomCookie])) {
|
| 279 |
$jwt = $_COOKIE[$this->nomCookie];
|
270 |
$jwt = $_COOKIE[$this->nomCookie];
|
| 280 |
try {
|
271 |
try {
|
| 281 |
// rafraîchir jeton quelque soit son état - "true" permet
|
272 |
// rafraîchir jeton quelque soit son état - "true" permet
|
| 282 |
// d'ignorer les ExpiredException (on rafraîchit le jeton
|
273 |
// d'ignorer les ExpiredException (on rafraîchit le jeton
|
| 283 |
// expiré car le cookie est encore valide)
|
274 |
// expiré car le cookie est encore valide)
|
| 284 |
$jetonRetour = $this->rafraichirJeton($jwt, true);
|
275 |
$jetonRetour = $this->rafraichirJeton($jwt, true);
|
| 285 |
// on ne tentera pas de lire un jeton fourni en paramètre
|
276 |
// on ne tentera pas de lire un jeton fourni en paramètre
|
| 286 |
$cookieAvecJetonValide = true;
|
277 |
$cookieAvecJetonValide = true;
|
| 287 |
} catch (Exception $e) {
|
278 |
} catch (Exception $e) {
|
| 288 |
// si le rafraîchissement a échoué (jeton invalide - hors expiration - ou vide)
|
279 |
// si le rafraîchissement a échoué (jeton invalide - hors expiration - ou vide)
|
| 289 |
// on ne fait rien et on tente la suite (jeton fourni hors cookie ?)
|
280 |
// on ne fait rien et on tente la suite (jeton fourni hors cookie ?)
|
| 290 |
$erreur = "invalid token in cookie";
|
281 |
$erreur = "invalid token in cookie";
|
| 291 |
}
|
282 |
}
|
| 292 |
}
|
283 |
}
|
| 293 |
// si le cookie n'existait pas ou ne contenait pas un jeton
|
284 |
// si le cookie n'existait pas ou ne contenait pas un jeton
|
| 294 |
if (! $cookieAvecJetonValide) {
|
285 |
if (! $cookieAvecJetonValide) {
|
| 295 |
// lire jeton depuis header ou paramètre
|
286 |
// lire jeton depuis header ou paramètre
|
| 296 |
$jwt = $this->lireJetonDansHeader();
|
287 |
$jwt = $this->lireJetonDansHeader();
|
| 297 |
if ($jwt == null) {
|
288 |
if ($jwt == null) {
|
| 298 |
// dernière chance
|
289 |
// dernière chance
|
| 299 |
$jwt = $this->getParam('token');
|
290 |
$jwt = $this->getParam('token');
|
| 300 |
}
|
291 |
}
|
| 301 |
// toutes les possibilités ont été essayées
|
292 |
// toutes les possibilités ont été essayées
|
| 302 |
if ($jwt != null) {
|
293 |
if ($jwt != null) {
|
| 303 |
try {
|
294 |
try {
|
| 304 |
// rafraîchir jeton si non expiré
|
295 |
// rafraîchir jeton si non expiré
|
| 305 |
$jetonRetour = $this->rafraichirJeton($jwt);
|
296 |
$jetonRetour = $this->rafraichirJeton($jwt);
|
| 306 |
} catch (Exception $e) {
|
297 |
} catch (Exception $e) {
|
| 307 |
// si le rafraîchissement a échoué (jeton invalide, expiré ou vide)
|
298 |
// si le rafraîchissement a échoué (jeton invalide, expiré ou vide)
|
| 308 |
$erreur = "invalid or expired token in Authorization header or parameter <token>";
|
299 |
$erreur = "invalid or expired token in Authorization header or parameter <token>";
|
| 309 |
}
|
300 |
}
|
| 310 |
} else {
|
301 |
} else {
|
| 311 |
// pas de jeton valide passé en paramètre
|
302 |
// pas de jeton valide passé en paramètre
|
| 312 |
$erreur = ($erreur == "" ? "no token or cookie" : "invalid token in cookie / invalid or expired token in Authorization header or parameter <token>");
|
303 |
$erreur = ($erreur == "" ? "no token or cookie" : "invalid token in cookie / invalid or expired token in Authorization header or parameter <token>");
|
| 313 |
}
|
304 |
}
|
| 314 |
}
|
305 |
}
|
| 315 |
if(!empty($_GET['redirect_url'])) {
|
- |
|
| 316 |
if ($jetonRetour != null) {
|
- |
|
| 317 |
$this->redirigerAvecJeton($_GET['redirect_url'], $jetonRetour);
|
306 |
// redirection si demandée - se charge de sortir du script en cas de succès
|
| 318 |
} else {
|
- |
|
| 319 |
header('Location: '.$_GET['redirect_url']);
|
307 |
$this->rediriger($jetonRetour);
|
| 320 |
}
|
- |
|
| 321 |
} else {
|
- |
|
| 322 |
// renvoi jeton
|
308 |
// renvoi jeton
|
| 323 |
if ($jetonRetour === null) {
|
309 |
if ($jetonRetour === null) {
|
| 324 |
$this->erreur($erreur);
|
310 |
$this->erreur($erreur);
|
| 325 |
} else {
|
311 |
} else {
|
| 326 |
$this->envoyerJson(array(
|
312 |
$this->envoyerJson(array(
|
| 327 |
"session" => true,
|
313 |
"session" => true,
|
| 328 |
"token" => $jetonRetour,
|
314 |
"token" => $jetonRetour,
|
| 329 |
"duration" => intval($this->dureeJeton),
|
315 |
"duration" => intval($this->dureeJeton),
|
| 330 |
"token_id" => $this->nomCookie
|
316 |
"token_id" => $this->nomCookie
|
| 331 |
));
|
317 |
));
|
| 332 |
}
|
- |
|
| 333 |
}
|
318 |
}
|
| 334 |
}
|
319 |
}
|
| - |
|
320 |
|
| - |
|
321 |
/**
|
| - |
|
322 |
* Si $_GET['redirect_url'] est non-vide, redirige vers l'URL qu'il contient et sort du programme;
|
| - |
|
323 |
* sinon, ne fait rien et passe la main
|
| - |
|
324 |
*
|
| - |
|
325 |
* @param string $jetonRetour jeton JWT à passer à l'URL de destination (en GET
|
| - |
|
326 |
* et dans le header "Authorization"); par défaut null
|
| 335 |
|
327 |
*/
|
| - |
|
328 |
protected function rediriger($jetonRetour=null) {
|
| 336 |
protected function redirigerAvecJeton($url, $jetonRetour) {
|
329 |
if (!empty($_GET['redirect_url'])) {
|
| 337 |
// dans le cas où une url de redirection est précisée,
|
330 |
// dans le cas où une url de redirection est précisée,
|
| 338 |
// on est généreux et on précise le jeton dans le header et le get
|
- |
|
| 339 |
if ($jetonRetour != null) {
|
331 |
// on est généreux et on précise le jeton dans le header et le get
|
| - |
|
332 |
$url_redirection = $_GET['redirect_url'];
|
| 340 |
$url_redirection = $_GET['redirect_url'];
|
333 |
if ($jetonRetour !== null) {
|
| 341 |
$separateur = (parse_url($url_redirection, PHP_URL_QUERY) == NULL) ? '?' : '&';
|
334 |
$separateur = (parse_url($url_redirection, PHP_URL_QUERY) == NULL) ? '?' : '&';
|
| 342 |
$url_redirection .= $separateur.'Authorization='.$jetonRetour;
|
335 |
$url_redirection .= $separateur.'Authorization='.$jetonRetour;
|
| - |
|
336 |
header('Authorization: '.$jetonRetour);
|
| - |
|
337 |
}
|
| - |
|
338 |
header('Location: '.$url_redirection);
|
| 343 |
header('Authorization: '.$jetonRetour);
|
339 |
exit;
|
| 344 |
}
|
- |
|
| 345 |
header('Location: '.$url_redirection);
|
- |
|
| 346 |
exit;
|
340 |
}
|
| 347 |
}
|
341 |
}
|
| 348 |
|
342 |
|
| 349 |
/**
|
343 |
/**
|
| 350 |
* Vérifie si un jeton est valide; retourne true si oui, une erreur avec
|
344 |
* Vérifie si un jeton est valide; retourne true si oui, une erreur avec
|
| 351 |
* des détails si non;
|
345 |
* des détails si non;
|
| 352 |
* Priorité : header "Authorization" > paramètre "token"
|
346 |
* Priorité : header "Authorization" > paramètre "token"
|
| 353 |
*/
|
347 |
*/
|
| 354 |
protected function verifierJeton() {
|
348 |
protected function verifierJeton() {
|
| 355 |
// vérifie que le jeton provient bien d'ici,
|
349 |
// vérifie que le jeton provient bien d'ici,
|
| 356 |
// et qu'il est encore valide (date)
|
350 |
// et qu'il est encore valide (date)
|
| 357 |
$jwt = $this->lireJetonDansHeader();
|
351 |
$jwt = $this->lireJetonDansHeader();
|
| 358 |
if ($jwt == null) {
|
352 |
if ($jwt == null) {
|
| 359 |
$jwt = $this->getParam('token');
|
353 |
$jwt = $this->getParam('token');
|
| 360 |
if ($jwt == '') {
|
354 |
if ($jwt == '') {
|
| 361 |
$this->erreur("parameter <token> or Authorization header required");
|
355 |
$this->erreur("parameter <token> or Authorization header required");
|
| 362 |
}
|
356 |
}
|
| 363 |
}
|
357 |
}
|
| 364 |
try {
|
358 |
try {
|
| 365 |
$jeton = JWT::decode($jwt, $this->clef, array('HS256'));
|
359 |
$jeton = JWT::decode($jwt, $this->clef, array('HS256'));
|
| 366 |
$jeton = (array) $jeton;
|
360 |
$jeton = (array) $jeton;
|
| 367 |
} catch (Exception $e) {
|
361 |
} catch (Exception $e) {
|
| 368 |
$this->erreur($e->getMessage());
|
362 |
$this->erreur($e->getMessage());
|
| 369 |
exit;
|
363 |
exit;
|
| 370 |
}
|
364 |
}
|
| 371 |
$this->envoyerJson(true);
|
365 |
$this->envoyerJson(true);
|
| 372 |
}
|
366 |
}
|
| 373 |
|
367 |
|
| 374 |
/**
|
368 |
/**
|
| 375 |
* Reçoit un jeton JWT, et s'il est non-vide ("sub" != null), lui redonne
|
369 |
* Reçoit un jeton JWT, et s'il est non-vide ("sub" != null), lui redonne
|
| 376 |
* une période de validité de $this->dureeJeton; si $ignorerExpiration
|
370 |
* une période de validité de $this->dureeJeton; si $ignorerExpiration
|
| 377 |
* vaut true, rafraîchira le jeton même s'il a expiré
|
371 |
* vaut true, rafraîchira le jeton même s'il a expiré
|
| 378 |
* (attention à ne pas appeler cette méthode n'importe comment !);
|
372 |
* (attention à ne pas appeler cette méthode n'importe comment !);
|
| 379 |
* jette une exception si le jeton est vide, mal signé ou autre erreur,
|
373 |
* jette une exception si le jeton est vide, mal signé ou autre erreur,
|
| 380 |
* ou s'il a expiré et que $ignorerExpiration est différent de true
|
374 |
* ou s'il a expiré et que $ignorerExpiration est différent de true
|
| 381 |
*
|
375 |
*
|
| 382 |
* @param string $jwt le jeton JWT
|
376 |
* @param string $jwt le jeton JWT
|
| 383 |
* @return string le jeton rafraîchi
|
377 |
* @return string le jeton rafraîchi
|
| 384 |
*/
|
378 |
*/
|
| 385 |
protected function rafraichirJeton($jwt, $ignorerExpiration=false) /* throws Exception */ {
|
379 |
protected function rafraichirJeton($jwt, $ignorerExpiration=false) /* throws Exception */ {
|
| 386 |
$infos = array();
|
380 |
$infos = array();
|
| 387 |
// vérification avec lib JWT
|
381 |
// vérification avec lib JWT
|
| 388 |
try {
|
382 |
try {
|
| 389 |
$infos = JWT::decode($jwt, $this->clef, array('HS256'));
|
383 |
$infos = JWT::decode($jwt, $this->clef, array('HS256'));
|
| 390 |
$infos = (array) $infos;
|
384 |
$infos = (array) $infos;
|
| 391 |
} catch (ExpiredException $e) {
|
385 |
} catch (ExpiredException $e) {
|
| 392 |
if ($ignorerExpiration === true) {
|
386 |
if ($ignorerExpiration === true) {
|
| 393 |
// on se fiche qu'il soit expiré
|
387 |
// on se fiche qu'il soit expiré
|
| 394 |
// décodage d'un jeton expiré
|
388 |
// décodage d'un jeton expiré
|
| 395 |
// @WARNING considère que la lib JWT jette ExpiredException en dernier (vrai 12/05/2015),
|
389 |
// @WARNING considère que la lib JWT jette ExpiredException en dernier (vrai 12/05/2015),
|
| 396 |
// ce qui signifie que la signature et le domaine sont tout de même valides - à surveiller !
|
390 |
// ce qui signifie que la signature et le domaine sont tout de même valides - à surveiller !
|
| 397 |
$infos = $this->decoderJetonExpireManuellement($jwt);
|
391 |
$infos = $this->decoderJetonExpireManuellement($jwt);
|
| 398 |
} else {
|
392 |
} else {
|
| 399 |
// on renvoie l'exception plus haut
|
393 |
// on renvoie l'exception plus haut
|
| 400 |
throw $e;
|
394 |
throw $e;
|
| 401 |
}
|
395 |
}
|
| 402 |
}
|
396 |
}
|
| 403 |
// vérification des infos
|
397 |
// vérification des infos
|
| 404 |
if (empty($infos['sub'])) {
|
398 |
if (empty($infos['sub'])) {
|
| 405 |
// jeton vide (wtf?)
|
399 |
// jeton vide (wtf?)
|
| 406 |
throw new Exception("empty token (no <sub>)");
|
400 |
throw new Exception("empty token (no <sub>)");
|
| 407 |
}
|
401 |
}
|
| 408 |
// rafraîchissement
|
402 |
// rafraîchissement
|
| 409 |
$infos['exp'] = time() + $this->dureeJeton;
|
403 |
$infos['exp'] = time() + $this->dureeJeton;
|
| 410 |
$jwtSortie = JWT::encode($infos, $this->clef);
|
404 |
$jwtSortie = JWT::encode($infos, $this->clef);
|
| 411 |
|
405 |
|
| 412 |
return $jwtSortie;
|
406 |
return $jwtSortie;
|
| 413 |
}
|
407 |
}
|
| 414 |
|
408 |
|
| 415 |
/**
|
409 |
/**
|
| 416 |
* Décode manuellement un jeton JWT, SANS VÉRIFIER SA SIGNATURE OU
|
410 |
* Décode manuellement un jeton JWT, SANS VÉRIFIER SA SIGNATURE OU
|
| 417 |
* SON DOMAINE ! @WARNING ne pas utiliser hors du cas d'un jeton
|
411 |
* SON DOMAINE ! @WARNING ne pas utiliser hors du cas d'un jeton
|
| 418 |
* correct (vérifié avec la lib JWT) mais expiré !
|
412 |
* correct (vérifié avec la lib JWT) mais expiré !
|
| 419 |
*
|
413 |
*
|
| 420 |
* @param string $jwt un jeton vérifié comme valide, mais expiré
|
414 |
* @param string $jwt un jeton vérifié comme valide, mais expiré
|
| 421 |
*/
|
415 |
*/
|
| 422 |
protected function decoderJetonExpireManuellement($jwt) {
|
416 |
protected function decoderJetonExpireManuellement($jwt) {
|
| 423 |
$parts = explode('.', $jwt);
|
417 |
$parts = explode('.', $jwt);
|
| 424 |
$payload = $parts[1];
|
418 |
$payload = $parts[1];
|
| 425 |
$payload = base64_decode($payload);
|
419 |
$payload = base64_decode($payload);
|
| 426 |
$payload = json_decode($payload, true);
|
420 |
$payload = json_decode($payload, true);
|
| 427 |
|
421 |
|
| 428 |
return $payload;
|
422 |
return $payload;
|
| 429 |
}
|
423 |
}
|
| 430 |
|
424 |
|
| 431 |
/**
|
425 |
/**
|
| 432 |
* Crée un jeton JWT signé avec la clef
|
426 |
* Crée un jeton JWT signé avec la clef
|
| 433 |
*
|
427 |
*
|
| 434 |
* @param mixed $sub subject: l'id utilisateur du détenteur du jeton si authentifié, null sinon
|
428 |
* @param mixed $sub subject: l'id utilisateur du détenteur du jeton si authentifié, null sinon
|
| 435 |
* @param string $exp la date d'expiration du jeton, par défaut la date actuelle plus $this->dureeJeton
|
429 |
* @param string $exp la date d'expiration du jeton, par défaut la date actuelle plus $this->dureeJeton
|
| 436 |
* @param array $donnees les données à ajouter au jeton (infos utilisateur)
|
430 |
* @param array $donnees les données à ajouter au jeton (infos utilisateur)
|
| 437 |
*
|
431 |
*
|
| 438 |
* @return string un jeton JWT signé
|
432 |
* @return string un jeton JWT signé
|
| 439 |
*/
|
433 |
*/
|
| 440 |
protected function creerJeton($sub, $donnees=array(), $exp=null) {
|
434 |
protected function creerJeton($sub, $donnees=array(), $exp=null) {
|
| 441 |
if ($exp === null) {
|
435 |
if ($exp === null) {
|
| 442 |
$exp = time() + $this->dureeJeton;
|
436 |
$exp = time() + $this->dureeJeton;
|
| 443 |
}
|
437 |
}
|
| 444 |
$jeton = array(
|
438 |
$jeton = array(
|
| 445 |
"iss" => "https://www.tela-botanica.org",
|
439 |
"iss" => "https://www.tela-botanica.org",
|
| 446 |
"token_id" => $this->nomCookie,
|
440 |
"token_id" => $this->nomCookie,
|
| 447 |
//"aud" => "http://example.com",
|
441 |
//"aud" => "http://example.com",
|
| 448 |
"sub" => $sub,
|
442 |
"sub" => $sub,
|
| 449 |
"iat" => time(),
|
443 |
"iat" => time(),
|
| 450 |
"exp" => $exp,
|
444 |
"exp" => $exp,
|
| 451 |
//"nbf" => time() + 60,
|
445 |
//"nbf" => time() + 60,
|
| 452 |
"scopes" => array("tela-botanica.org")
|
446 |
"scopes" => array("tela-botanica.org")
|
| 453 |
);
|
447 |
);
|
| 454 |
if (! empty($donnees)) {
|
448 |
if (! empty($donnees)) {
|
| 455 |
$jeton = array_merge($jeton, $donnees);
|
449 |
$jeton = array_merge($jeton, $donnees);
|
| 456 |
}
|
450 |
}
|
| 457 |
$jwt = JWT::encode($jeton, $this->clef);
|
451 |
$jwt = JWT::encode($jeton, $this->clef);
|
| 458 |
|
452 |
|
| 459 |
return $jwt;
|
453 |
return $jwt;
|
| 460 |
}
|
454 |
}
|
| 461 |
|
455 |
|
| 462 |
/**
|
456 |
/**
|
| 463 |
* Essaye de trouver un jeton JWT non vide dans l'entête HTTP $nomHeader (par
|
457 |
* Essaye de trouver un jeton JWT non vide dans l'entête HTTP $nomHeader (par
|
| 464 |
* défaut "Authorization")
|
458 |
* défaut "Authorization")
|
| 465 |
*
|
459 |
*
|
| 466 |
* @param string $nomHeader nom de l'entête dans lequel chercher le jeton
|
460 |
* @param string $nomHeader nom de l'entête dans lequel chercher le jeton
|
| 467 |
* @return String un jeton JWT ou null
|
461 |
* @return String un jeton JWT ou null
|
| 468 |
*/
|
462 |
*/
|
| 469 |
protected function lireJetonDansHeader($nomHeader="Authorization") {
|
463 |
protected function lireJetonDansHeader($nomHeader="Authorization") {
|
| 470 |
$jwt = null;
|
464 |
$jwt = null;
|
| 471 |
$headers = apache_request_headers();
|
465 |
$headers = apache_request_headers();
|
| 472 |
if (isset($headers[$nomHeader]) && ($headers[$nomHeader] != "")) {
|
466 |
if (isset($headers[$nomHeader]) && ($headers[$nomHeader] != "")) {
|
| 473 |
$jwt = $headers[$nomHeader];
|
467 |
$jwt = $headers[$nomHeader];
|
| 474 |
}
|
468 |
}
|
| 475 |
return $jwt;
|
469 |
return $jwt;
|
| 476 |
}
|
470 |
}
|
| 477 |
|
471 |
|
| 478 |
/**
|
472 |
/**
|
| 479 |
* Crée un cookie de durée $this->dureeCookie, nommé $this->nomCookie et
|
473 |
* Crée un cookie de durée $this->dureeCookie, nommé $this->nomCookie et
|
| 480 |
* contenant $valeur
|
474 |
* contenant $valeur
|
| 481 |
*
|
475 |
*
|
| 482 |
* @param string $valeur le contenu du cookie (de préférence un jeton JWT)
|
476 |
* @param string $valeur le contenu du cookie (de préférence un jeton JWT)
|
| 483 |
*/
|
477 |
*/
|
| 484 |
protected function creerCookie($valeur) {
|
478 |
protected function creerCookie($valeur) {
|
| 485 |
setcookie($this->nomCookie, $valeur, time() + $this->dureeCookie, '/', null, true);
|
479 |
setcookie($this->nomCookie, $valeur, time() + $this->dureeCookie, '/', null, true);
|
| 486 |
}
|
480 |
}
|
| 487 |
|
481 |
|
| 488 |
/**
|
482 |
/**
|
| 489 |
* Renvoie le cookie avec une valeur vide et une date d'expiration dans le
|
483 |
* Renvoie le cookie avec une valeur vide et une date d'expiration dans le
|
| 490 |
* passé, afin que le navigateur le détruise au prochain appel
|
484 |
* passé, afin que le navigateur le détruise au prochain appel
|
| 491 |
* @TODO envisager l'envoi d'un jeton vide plutôt que la suppression du cookie
|
485 |
* @TODO envisager l'envoi d'un jeton vide plutôt que la suppression du cookie
|
| 492 |
*
|
486 |
*
|
| 493 |
* @param string $valeur la valeur du cookie, par défaut ""
|
487 |
* @param string $valeur la valeur du cookie, par défaut ""
|
| 494 |
*/
|
488 |
*/
|
| 495 |
protected function detruireCookie() {
|
489 |
protected function detruireCookie() {
|
| 496 |
setcookie($this->nomCookie, "", -1, '/', null, true);
|
490 |
setcookie($this->nomCookie, "", -1, '/', null, true);
|
| 497 |
}
|
491 |
}
|
| 498 |
|
492 |
|
| 499 |
// ---------------- Méthodes à génériciser ci-dessous ----------------------------------
|
493 |
// ---------------- Méthodes à génériciser ci-dessous ----------------------------------
|
| 500 |
|
494 |
|
| 501 |
/**
|
495 |
/**
|
| 502 |
* Message succinct pour méthodes / actions non implémentées
|
496 |
* Message succinct pour méthodes / actions non implémentées
|
| 503 |
*/
|
497 |
*/
|
| 504 |
protected function nonImplemente() {
|
498 |
protected function nonImplemente() {
|
| 505 |
$this->erreur("not implemented");
|
499 |
$this->erreur("not implemented");
|
| 506 |
}
|
500 |
}
|
| 507 |
|
501 |
|
| 508 |
/**
|
502 |
/**
|
| 509 |
* Si $this->forcerSSL vaut true, envoie une erreur et termine le programme si SSL n'est pas utilisé
|
503 |
* Si $this->forcerSSL vaut true, envoie une erreur et termine le programme si SSL n'est pas utilisé
|
| 510 |
*/
|
504 |
*/
|
| 511 |
protected function verifierSSL() {
|
505 |
protected function verifierSSL() {
|
| 512 |
if ($this->forcerSSL === true) {
|
506 |
if ($this->forcerSSL === true) {
|
| 513 |
if (empty($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == 'off') {
|
507 |
if (empty($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == 'off') {
|
| 514 |
$this->erreur("HTTPS required");
|
508 |
$this->erreur("HTTPS required");
|
| 515 |
exit;
|
509 |
exit;
|
| 516 |
}
|
510 |
}
|
| 517 |
}
|
511 |
}
|
| 518 |
}
|
512 |
}
|
| 519 |
|
513 |
|
| 520 |
protected function getParamChain($names) {
|
514 |
protected function getParamChain($names) {
|
| 521 |
if (! is_array($names)) {
|
515 |
if (! is_array($names)) {
|
| 522 |
// Hou ? (cri de chouette solitaire)
|
516 |
// Hou ? (cri de chouette solitaire)
|
| 523 |
}
|
517 |
}
|
| 524 |
}
|
518 |
}
|
| 525 |
|
519 |
|
| 526 |
/**
|
520 |
/**
|
| 527 |
* Capture un paramètre de requête ($_REQUEST)
|
521 |
* Capture un paramètre de requête ($_REQUEST)
|
| 528 |
*
|
522 |
*
|
| 529 |
* @param string $name nom du paramètre à capturer
|
523 |
* @param string $name nom du paramètre à capturer
|
| 530 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
524 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
| 531 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
525 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
| 532 |
*
|
526 |
*
|
| 533 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
527 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
| 534 |
*/
|
528 |
*/
|
| 535 |
protected function getParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
529 |
protected function getParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
| 536 |
$ret = $default;
|
530 |
$ret = $default;
|
| 537 |
if (isset($_REQUEST[$name])) {
|
531 |
if (isset($_REQUEST[$name])) {
|
| 538 |
if ($traiterVideCommeDefaut === false || $_REQUEST[$name] !== '') {
|
532 |
if ($traiterVideCommeDefaut === false || $_REQUEST[$name] !== '') {
|
| 539 |
$ret = $_REQUEST[$name];
|
533 |
$ret = $_REQUEST[$name];
|
| 540 |
}
|
534 |
}
|
| 541 |
}
|
535 |
}
|
| 542 |
return $ret;
|
536 |
return $ret;
|
| 543 |
}
|
537 |
}
|
| 544 |
|
538 |
|
| 545 |
/**
|
539 |
/**
|
| 546 |
* Capture un paramètre GET
|
540 |
* Capture un paramètre GET
|
| 547 |
*
|
541 |
*
|
| 548 |
* @param string $name nom du paramètre GET à capturer
|
542 |
* @param string $name nom du paramètre GET à capturer
|
| 549 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
543 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
| 550 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
544 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
| 551 |
*
|
545 |
*
|
| 552 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
546 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
| 553 |
*/
|
547 |
*/
|
| 554 |
protected function getGetParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
548 |
protected function getGetParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
| 555 |
$ret = $default;
|
549 |
$ret = $default;
|
| 556 |
if (isset($_GET[$name])) {
|
550 |
if (isset($_GET[$name])) {
|
| 557 |
if ($traiterVideCommeDefaut === false || $_GET[$name] !== '') {
|
551 |
if ($traiterVideCommeDefaut === false || $_GET[$name] !== '') {
|
| 558 |
$ret = $_GET[$name];
|
552 |
$ret = $_GET[$name];
|
| 559 |
}
|
553 |
}
|
| 560 |
}
|
554 |
}
|
| 561 |
return $ret;
|
555 |
return $ret;
|
| 562 |
}
|
556 |
}
|
| 563 |
|
557 |
|
| 564 |
/**
|
558 |
/**
|
| 565 |
* Capture un paramètre POST
|
559 |
* Capture un paramètre POST
|
| 566 |
*
|
560 |
*
|
| 567 |
* @param string $name nom du paramètre POST à capturer
|
561 |
* @param string $name nom du paramètre POST à capturer
|
| 568 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
562 |
* @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
|
| 569 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
563 |
* @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
|
| 570 |
*
|
564 |
*
|
| 571 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
565 |
* @return string la valeur du paramètre si défini, sinon la valeur par défaut
|
| 572 |
*/
|
566 |
*/
|
| 573 |
protected function getPostParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
567 |
protected function getPostParam($name, $default=null, $traiterVideCommeDefaut=false) {
|
| 574 |
$ret = $default;
|
568 |
$ret = $default;
|
| 575 |
if (isset($_POST[$name])) {
|
569 |
if (isset($_POST[$name])) {
|
| 576 |
if ($traiterVideCommeDefaut === false || $_POST[$name] !== '') {
|
570 |
if ($traiterVideCommeDefaut === false || $_POST[$name] !== '') {
|
| 577 |
$ret = $_POST[$name];
|
571 |
$ret = $_POST[$name];
|
| 578 |
}
|
572 |
}
|
| 579 |
}
|
573 |
}
|
| 580 |
return $ret;
|
574 |
return $ret;
|
| 581 |
}
|
575 |
}
|
| 582 |
|
576 |
|
| 583 |
/**
|
577 |
/**
|
| 584 |
* Envoie une erreur HTTP $code (400 par défaut) avec les données $data en JSON
|
578 |
* Envoie une erreur HTTP $code (400 par défaut) avec les données $data en JSON
|
| 585 |
*
|
579 |
*
|
| 586 |
* @param mixed $data données JSON de l'erreur - généralement array("error" => "raison de l'erreur") - si
|
580 |
* @param mixed $data données JSON de l'erreur - généralement array("error" => "raison de l'erreur") - si
|
| 587 |
* seule une chaîne est transmise, sera convertie en array("error" => $data)
|
581 |
* seule une chaîne est transmise, sera convertie en array("error" => $data)
|
| 588 |
* @param number $code code HTTP de l'erreur, par défaut 400 (bad request)
|
582 |
* @param number $code code HTTP de l'erreur, par défaut 400 (bad request)
|
| 589 |
* @param boolean $exit si true (par défaut), termine le script après avoir envoyé l'erreur
|
583 |
* @param boolean $exit si true (par défaut), termine le script après avoir envoyé l'erreur
|
| 590 |
*/
|
584 |
*/
|
| 591 |
protected function erreur($data, $code=400, $exit=true) {
|
585 |
protected function erreur($data, $code=400, $exit=true) {
|
| 592 |
if (! is_array($data)) {
|
586 |
if (! is_array($data)) {
|
| 593 |
$data = array(
|
587 |
$data = array(
|
| 594 |
"error" => $data
|
588 |
"error" => $data
|
| 595 |
);
|
589 |
);
|
| 596 |
}
|
590 |
}
|
| 597 |
http_response_code($code);
|
591 |
http_response_code($code);
|
| 598 |
$this->envoyerJson($data);
|
592 |
$this->envoyerJson($data);
|
| 599 |
if ($exit === true) {
|
593 |
if ($exit === true) {
|
| 600 |
exit;
|
594 |
exit;
|
| 601 |
}
|
595 |
}
|
| 602 |
}
|
596 |
}
|
| 603 |
}
|
597 |
}
|
| 604 |
|
598 |
|
| 605 |
/**
|
599 |
/**
|
| 606 |
* Mode moderne pour PHP < 5.4
|
600 |
* Mode moderne pour PHP < 5.4
|
| 607 |
*/
|
601 |
*/
|
| 608 |
if (!function_exists('http_response_code')) {
|
602 |
if (!function_exists('http_response_code')) {
|
| 609 |
function http_response_code($code = NULL) {
|
603 |
function http_response_code($code = NULL) {
|
| 610 |
if ($code !== NULL) {
|
604 |
if ($code !== NULL) {
|
| 611 |
switch ($code) {
|
605 |
switch ($code) {
|
| 612 |
case 100: $text = 'Continue'; break;
|
606 |
case 100: $text = 'Continue'; break;
|
| 613 |
case 101: $text = 'Switching Protocols'; break;
|
607 |
case 101: $text = 'Switching Protocols'; break;
|
| 614 |
case 200: $text = 'OK'; break;
|
608 |
case 200: $text = 'OK'; break;
|
| 615 |
case 201: $text = 'Created'; break;
|
609 |
case 201: $text = 'Created'; break;
|
| 616 |
case 202: $text = 'Accepted'; break;
|
610 |
case 202: $text = 'Accepted'; break;
|
| 617 |
case 203: $text = 'Non-Authoritative Information'; break;
|
611 |
case 203: $text = 'Non-Authoritative Information'; break;
|
| 618 |
case 204: $text = 'No Content'; break;
|
612 |
case 204: $text = 'No Content'; break;
|
| 619 |
case 205: $text = 'Reset Content'; break;
|
613 |
case 205: $text = 'Reset Content'; break;
|
| 620 |
case 206: $text = 'Partial Content'; break;
|
614 |
case 206: $text = 'Partial Content'; break;
|
| 621 |
case 300: $text = 'Multiple Choices'; break;
|
615 |
case 300: $text = 'Multiple Choices'; break;
|
| 622 |
case 301: $text = 'Moved Permanently'; break;
|
616 |
case 301: $text = 'Moved Permanently'; break;
|
| 623 |
case 302: $text = 'Moved Temporarily'; break;
|
617 |
case 302: $text = 'Moved Temporarily'; break;
|
| 624 |
case 303: $text = 'See Other'; break;
|
618 |
case 303: $text = 'See Other'; break;
|
| 625 |
case 304: $text = 'Not Modified'; break;
|
619 |
case 304: $text = 'Not Modified'; break;
|
| 626 |
case 305: $text = 'Use Proxy'; break;
|
620 |
case 305: $text = 'Use Proxy'; break;
|
| 627 |
case 400: $text = 'Bad Request'; break;
|
621 |
case 400: $text = 'Bad Request'; break;
|
| 628 |
case 401: $text = 'Unauthorized'; break;
|
622 |
case 401: $text = 'Unauthorized'; break;
|
| 629 |
case 402: $text = 'Payment Required'; break;
|
623 |
case 402: $text = 'Payment Required'; break;
|
| 630 |
case 403: $text = 'Forbidden'; break;
|
624 |
case 403: $text = 'Forbidden'; break;
|
| 631 |
case 404: $text = 'Not Found'; break;
|
625 |
case 404: $text = 'Not Found'; break;
|
| 632 |
case 405: $text = 'Method Not Allowed'; break;
|
626 |
case 405: $text = 'Method Not Allowed'; break;
|
| 633 |
case 406: $text = 'Not Acceptable'; break;
|
627 |
case 406: $text = 'Not Acceptable'; break;
|
| 634 |
case 407: $text = 'Proxy Authentication Required'; break;
|
628 |
case 407: $text = 'Proxy Authentication Required'; break;
|
| 635 |
case 408: $text = 'Request Time-out'; break;
|
629 |
case 408: $text = 'Request Time-out'; break;
|
| 636 |
case 409: $text = 'Conflict'; break;
|
630 |
case 409: $text = 'Conflict'; break;
|
| 637 |
case 410: $text = 'Gone'; break;
|
631 |
case 410: $text = 'Gone'; break;
|
| 638 |
case 411: $text = 'Length Required'; break;
|
632 |
case 411: $text = 'Length Required'; break;
|
| 639 |
case 412: $text = 'Precondition Failed'; break;
|
633 |
case 412: $text = 'Precondition Failed'; break;
|
| 640 |
case 413: $text = 'Request Entity Too Large'; break;
|
634 |
case 413: $text = 'Request Entity Too Large'; break;
|
| 641 |
case 414: $text = 'Request-URI Too Large'; break;
|
635 |
case 414: $text = 'Request-URI Too Large'; break;
|
| 642 |
case 415: $text = 'Unsupported Media Type'; break;
|
636 |
case 415: $text = 'Unsupported Media Type'; break;
|
| 643 |
case 500: $text = 'Internal Server Error'; break;
|
637 |
case 500: $text = 'Internal Server Error'; break;
|
| 644 |
case 501: $text = 'Not Implemented'; break;
|
638 |
case 501: $text = 'Not Implemented'; break;
|
| 645 |
case 502: $text = 'Bad Gateway'; break;
|
639 |
case 502: $text = 'Bad Gateway'; break;
|
| 646 |
case 503: $text = 'Service Unavailable'; break;
|
640 |
case 503: $text = 'Service Unavailable'; break;
|
| 647 |
case 504: $text = 'Gateway Time-out'; break;
|
641 |
case 504: $text = 'Gateway Time-out'; break;
|
| 648 |
case 505: $text = 'HTTP Version not supported'; break;
|
642 |
case 505: $text = 'HTTP Version not supported'; break;
|
| 649 |
case 666: $text = 'Couscous overheat'; break;
|
643 |
case 666: $text = 'Couscous overheat'; break;
|
| 650 |
default:
|
644 |
default:
|
| 651 |
exit('Unknown http status code "' . htmlentities($code) . '"');
|
645 |
exit('Unknown http status code "' . htmlentities($code) . '"');
|
| 652 |
break;
|
646 |
break;
|
| 653 |
}
|
647 |
}
|
| 654 |
|
648 |
|
| 655 |
$protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
|
649 |
$protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
|
| 656 |
header($protocol . ' ' . $code . ' ' . $text);
|
650 |
header($protocol . ' ' . $code . ' ' . $text);
|
| 657 |
$GLOBALS['http_response_code'] = $code;
|
651 |
$GLOBALS['http_response_code'] = $code;
|
| 658 |
} else {
|
652 |
} else {
|
| 659 |
$code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
|
653 |
$code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
|
| 660 |
}
|
654 |
}
|
| 661 |
return $code;
|
655 |
return $code;
|
| 662 |
}
|
656 |
}
|
| 663 |
}
|
657 |
}
|