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 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 | <?php /** * SQL-backed OpenID stores. * * PHP versions 4 and 5 * * LICENSE: See the COPYING file included in this distribution. * * @package OpenID * @author JanRain, Inc. <openid@janrain.com> * @copyright 2005-2008 Janrain, Inc. * @license http://www.apache.org/licenses/LICENSE-2.0 Apache */ /** * @access private */ require_once 'Auth/OpenID/Interface.php'; require_once 'Auth/OpenID/Nonce.php'; /** * @access private */ require_once 'Auth/OpenID.php'; /** * @access private */ require_once 'Auth/OpenID/Nonce.php'; /** * This is the parent class for the SQL stores, which contains the * logic common to all of the SQL stores. * * The table names used are determined by the class variables * associations_table_name and nonces_table_name. To change the name * of the tables used, pass new table names into the constructor. * * To create the tables with the proper schema, see the createTables * method. * * This class shouldn't be used directly. Use one of its subclasses * instead, as those contain the code necessary to use a specific * database. If you're an OpenID integrator and you'd like to create * an SQL-driven store that wraps an application's database * abstraction, be sure to create a subclass of * {@link Auth_OpenID_DatabaseConnection} that calls the application's * database abstraction calls. Then, pass an instance of your new * database connection class to your SQLStore subclass constructor. * * All methods other than the constructor and createTables should be * considered implementation details. * * @package OpenID */ class Auth_OpenID_SQLStore extends Auth_OpenID_OpenIDStore { /** * This creates a new SQLStore instance. It requires an * established database connection be given to it, and it allows * overriding the default table names. * * @param connection $connection This must be an established * connection to a database of the correct type for the SQLStore * subclass you're using. This must either be an PEAR DB * connection handle or an instance of a subclass of * Auth_OpenID_DatabaseConnection. * * @param associations_table: This is an optional parameter to * specify the name of the table used for storing associations. * The default value is 'oid_associations'. * * @param nonces_table: This is an optional parameter to specify * the name of the table used for storing nonces. The default * value is 'oid_nonces'. */ function Auth_OpenID_SQLStore($connection, $associations_table = null, $nonces_table = null) { $this->associations_table_name = "oid_associations"; $this->nonces_table_name = "oid_nonces"; // Check the connection object type to be sure it's a PEAR // database connection. if (!(is_object($connection) && (is_subclass_of($connection, 'db_common') || is_subclass_of($connection, 'auth_openid_databaseconnection')))) { trigger_error("Auth_OpenID_SQLStore expected PEAR connection " . "object (got ".get_class($connection).")", E_USER_ERROR); return; } $this->connection = $connection; // Be sure to set the fetch mode so the results are keyed on // column name instead of column index. This is a PEAR // constant, so only try to use it if PEAR is present. Note // that Auth_Openid_Databaseconnection instances need not // implement ::setFetchMode for this reason. if (is_subclass_of($this->connection, 'db_common')) { $this->connection->setFetchMode(DB_FETCHMODE_ASSOC); } if ($associations_table) { $this->associations_table_name = $associations_table; } if ($nonces_table) { $this->nonces_table_name = $nonces_table; } $this->max_nonce_age = 6 * 60 * 60; // Be sure to run the database queries with auto-commit mode // turned OFF, because we want every function to run in a // transaction, implicitly. As a rule, methods named with a // leading underscore will NOT control transaction behavior. // Callers of these methods will worry about transactions. $this->connection->autoCommit(false); // Create an empty SQL strings array. $this->sql = array(); // Call this method (which should be overridden by subclasses) // to populate the $this->sql array with SQL strings. $this->setSQL(); // Verify that all required SQL statements have been set, and // raise an error if any expected SQL strings were either // absent or empty. list($missing, $empty) = $this->_verifySQL(); if ($missing) { trigger_error("Expected keys in SQL query list: " . implode(", ", $missing), E_USER_ERROR); return; } if ($empty) { trigger_error("SQL list keys have no SQL strings: " . implode(", ", $empty), E_USER_ERROR); return; } // Add table names to queries. $this->_fixSQL(); } function tableExists($table_name) { return !$this->isError( $this->connection->query( sprintf("SELECT * FROM %s LIMIT 0", $table_name))); } /** * Returns true if $value constitutes a database error; returns * false otherwise. */ function isError($value) { return PEAR::isError($value); } /** * Converts a query result to a boolean. If the result is a * database error according to $this->isError(), this returns * false; otherwise, this returns true. */ function resultToBool($obj) { if ($this->isError($obj)) { return false; } else { return true; } } /** * This method should be overridden by subclasses. This method is * called by the constructor to set values in $this->sql, which is * an array keyed on sql name. */ function setSQL() { } /** * Resets the store by removing all records from the store's * tables. */ function reset() { $this->connection->query(sprintf("DELETE FROM %s", $this->associations_table_name)); $this->connection->query(sprintf("DELETE FROM %s", $this->nonces_table_name)); } /** * @access private */ function _verifySQL() { $missing = array(); $empty = array(); $required_sql_keys = array( 'nonce_table', 'assoc_table', 'set_assoc', 'get_assoc', 'get_assocs', 'remove_assoc' ); foreach ($required_sql_keys as $key) { if (!array_key_exists($key, $this->sql)) { $missing[] = $key; } else if (!$this->sql[$key]) { $empty[] = $key; } } return array($missing, $empty); } /** * @access private */ function _fixSQL() { $replacements = array( array( 'value' => $this->nonces_table_name, 'keys' => array('nonce_table', 'add_nonce', 'clean_nonce') ), array( 'value' => $this->associations_table_name, 'keys' => array('assoc_table', 'set_assoc', 'get_assoc', 'get_assocs', 'remove_assoc', 'clean_assoc') ) ); foreach ($replacements as $item) { $value = $item['value']; $keys = $item['keys']; foreach ($keys as $k) { if (is_array($this->sql[$k])) { foreach ($this->sql[$k] as $part_key => $part_value) { $this->sql[$k][$part_key] = sprintf($part_value, $value); } } else { $this->sql[$k] = sprintf($this->sql[$k], $value); } } } } function blobDecode($blob) { return $blob; } function blobEncode($str) { return $str; } function createTables() { $this->connection->autoCommit(true); $n = $this->create_nonce_table(); $a = $this->create_assoc_table(); $this->connection->autoCommit(false); if ($n && $a) { return true; } else { return false; } } function create_nonce_table() { if (!$this->tableExists($this->nonces_table_name)) { $r = $this->connection->query($this->sql['nonce_table']); return $this->resultToBool($r); } return true; } function create_assoc_table() { if (!$this->tableExists($this->associations_table_name)) { $r = $this->connection->query($this->sql['assoc_table']); return $this->resultToBool($r); } return true; } /** * @access private */ function _set_assoc($server_url, $handle, $secret, $issued, $lifetime, $assoc_type) { return $this->connection->query($this->sql['set_assoc'], array( $server_url, $handle, $secret, $issued, $lifetime, $assoc_type)); } function storeAssociation($server_url, $association) { if ($this->resultToBool($this->_set_assoc( $server_url, $association->handle, $this->blobEncode( $association->secret), $association->issued, $association->lifetime, $association->assoc_type ))) { $this->connection->commit(); } else { $this->connection->rollback(); } } /** * @access private */ function _get_assoc($server_url, $handle) { $result = $this->connection->getRow($this->sql['get_assoc'], array($server_url, $handle)); if ($this->isError($result)) { return null; } else { return $result; } } /** * @access private */ function _get_assocs($server_url) { $result = $this->connection->getAll($this->sql['get_assocs'], array($server_url)); if ($this->isError($result)) { return array(); } else { return $result; } } function removeAssociation($server_url, $handle) { if ($this->_get_assoc($server_url, $handle) == null) { return false; } if ($this->resultToBool($this->connection->query( $this->sql['remove_assoc'], array($server_url, $handle)))) { $this->connection->commit(); } else { $this->c |