1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 | <?php /** * Yadis service manager to be used during yadis-driven authentication * attempts. * * @package OpenID */ /** * The base session class used by the Auth_Yadis_Manager. This * class wraps the default PHP session machinery and should be * subclassed if your application doesn't use PHP sessioning. * * @package OpenID */ class Auth_Yadis_PHPSession { /** * Set a session key/value pair. * * @param string $name The name of the session key to add. * @param string $value The value to add to the session. */ function set($name, $value) { $_SESSION[$name] = $value; } /** * Get a key's value from the session. * * @param string $name The name of the key to retrieve. * @param string $default The optional value to return if the key * is not found in the session. * @return string $result The key's value in the session or * $default if it isn't found. */ function get($name, $default=null) { if (array_key_exists($name, $_SESSION)) { return $_SESSION[$name]; } else { return $default; } } /** * Remove a key/value pair from the session. * * @param string $name The name of the key to remove. */ function del($name) { unset($_SESSION[$name]); } /** * Return the contents of the session in array form. */ function contents() { return $_SESSION; } } /** * A session helper class designed to translate between arrays and * objects. Note that the class used must have a constructor that * takes no parameters. This is not a general solution, but it works * for dumb objects that just need to have attributes set. The idea * is that you'll subclass this and override $this->check($data) -> * bool to implement your own session data validation. * * @package OpenID */ class Auth_Yadis_SessionLoader { /** * Override this. * * @access private */ function check($data) { return true; } /** * Given a session data value (an array), this creates an object * (returned by $this->newObject()) whose attributes and values * are those in $data. Returns null if $data lacks keys found in * $this->requiredKeys(). Returns null if $this->check($data) * evaluates to false. Returns null if $this->newObject() * evaluates to false. * * @access private */ function fromSession($data) { if (!$data) { return null; } $required = $this->requiredKeys(); foreach ($required as $k) { if (!array_key_exists($k, $data)) { return null; } } if (!$this->check($data)) { return null; } $data = array_merge($data, $this->prepareForLoad($data)); $obj = $this->newObject($data); if (!$obj) { return null; } foreach ($required as $k) { $obj->$k = $data[$k]; } return $obj; } /** * Prepares the data array by making any necessary changes. * Returns an array whose keys and values will be used to update * the original data array before calling $this->newObject($data). * * @access private */ function prepareForLoad($data) { return array(); } /** * Returns a new instance of this loader's class, using the * session data to construct it if necessary. The object need * only be created; $this->fromSession() will take care of setting * the object's attributes. * * @access private */ function newObject($data) { return null; } /** * Returns an array of keys and values built from the attributes * of $obj. If $this->prepareForSave($obj) returns an array, its keys * and values are used to update the $data array of attributes * from $obj. * * @access private */ function toSession($obj) { $data = array(); foreach ($obj as $k => $v) { $data[$k] = $v; } $extra = $this->prepareForSave($obj); if ($extra && is_array($extra)) { foreach ($extra as $k => $v) { $data[$k] = $v; } } return $data; } /** * Override this. * * @access private */ function prepareForSave($obj) { return array(); } } /** * A concrete loader implementation for Auth_OpenID_ServiceEndpoints. * * @package OpenID */ class Auth_OpenID_ServiceEndpointLoader extends Auth_Yadis_SessionLoader { function newObject($data) { return new Auth_OpenID_ServiceEndpoint(); } function requiredKeys() { $obj = new Auth_OpenID_ServiceEndpoint(); $data = array(); foreach ($obj as $k => $v) { $data[] = $k; } return $data; } function check($data) { return is_array($data['type_uris']); } } /** * A concrete loader implementation for Auth_Yadis_Managers. * * @package OpenID */ class Auth_Yadis_ManagerLoader extends Auth_Yadis_SessionLoader { function requiredKeys() { return array('starting_url', 'yadis_url', 'services', 'session_key', '_current', 'stale'); } function newObject($data) { return new Auth_Yadis_Manager($data['starting_url'], $data['yadis_url'], $data['services'], $data['session_key']); } function check($data) { return is_array($data['services']); } function prepareForLoad($data) { $loader = new Auth_OpenID_ServiceEndpointLoader(); $services = array(); foreach ($data['services'] as $s) { $services[] = $loader->fromSession($s); } return array('services' => $services); } function prepareForSave($obj) { $loader = new Auth_OpenID_ServiceEndpointLoader(); $services = array(); foreach ($obj->services as $s) { $services[] = $loader->toSession($s); } return array('services' => $services); } } /** * The Yadis service manager which stores state in a session and * iterates over <Service> elements in a Yadis XRDS document and lets * a caller attempt to use each one. This is used by the Yadis * library internally. * * @package OpenID */ class Auth_Yadis_Manager { /** * Intialize a new yadis service manager. * * @access private */ function Auth_Yadis_Manager($starting_url, $yadis_url, $services, $session_key) { // The URL that was used to initiate the Yadis protocol $this->starting_url = $starting_url; // The URL after following redirects (the identifier) $this->yadis_url = $yadis_url; // List of service elements $this->services = $services; $this->session_key = $session_key; // Reference to the current service object $this->_current = null; // Stale flag for cleanup if PHP lib has trouble. $this->stale = false; } /** * @access private */ function length() { // How many untried services remain? return count($this->services); } /** * Return the next service * * $this->current() will continue to return that service until the * next call to this method. */ function nextService() { if ($this->services) { $this->_current = array_shift($this->services); } else { $this->_current = null; } return $this->_current; } /** * @access private */ function current() { // Return the current service. // Returns None if there are no services left. return $this->_current; } /** * @access private */ function forURL($url) { return in_array($url, array($this->starting_url, $this->yadis_url)); } /** * @access private */ function started() { // Has the first service been returned? return $this->_current !== null; } } /** * State management for discovery. * * High-level usage pattern is to call .getNextService(discover) in * order to find the next available service for this user for this * session. Once a request completes, call .cleanup() to clean up the * session state. * * @package OpenID */ class Auth_Yadis_Discovery { /** * @access private */ var $DEFAULT_SUFFIX = 'auth'; /** * @access private */ var $PREFIX = '_yadis_services_'; /** * Initialize a discovery object. * * @param Auth_Yadis_PHPSession $session An object which * implements the Auth_Yadis_PHPSession API. * @param string $url The URL on which to attempt discovery. * @param string $session_key_suffix The optional session key * suffix override. */ function Auth_Yadis_Discovery($session, $url, $session_key_suffix = null) { /// Initialize a discovery object $this->session = $session; $this->url = $url; if ($session_key_suffix === null) { $session_key_suffix = $this->DEFAULT_SUFFIX; } $this->session_key_suffix = $session_key_suffix; $this->session_key = $this->PREFIX . $this->session_key_suffix; } /** * Return the next authentication service for the pair of * user_input and session. This function handles fallback. */ function getNextService($discover_cb, $fetcher) { $manager = $this->getManager(); if (!$manager || (!$manager->services)) { $this->destroyManager(); list($yadis_url, $services) = call_user_func($discover_cb, $this->url, $fetcher); $manager = $this->createManager($services, $yadis_url); } if ($manager) { $loader = new Auth_Yadis_ManagerLoader(); $service = $manager->nextService(); $this->session->set($this->session_key, serialize($loader->toSession($manager))); } else { $service = null; } return $service; } /** * Clean up Yadis-related services in the session and return the * most-recently-attempted service from the manager, if one * exists. * * @param $force True if the manager should be deleted regardless * of whether it's a manager for $this->url. */ function cleanup($force=false) { $manager = $this->getManager($force); if ($manager) { $service = $manager->current(); $this->destroyManager($force); } else { $service = null; } |