danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Install, update and uninstall functions for the openid module.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_schema().
danielebarchiesi@0:  */
danielebarchiesi@0: function openid_schema() {
danielebarchiesi@0:   $schema['openid_association'] = array(
danielebarchiesi@0:     'description' => 'Stores temporary shared key association information for OpenID authentication.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'idp_endpoint_uri' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'URI of the OpenID Provider endpoint.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'assoc_handle' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'description' => 'Primary Key: Used to refer to this association in subsequent messages.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'assoc_type' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 32,
danielebarchiesi@0:         'description' => 'The signature algorithm used: one of HMAC-SHA1 or HMAC-SHA256.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'session_type' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 32,
danielebarchiesi@0:         'description' => 'Valid association session types: "no-encryption", "DH-SHA1", and "DH-SHA256".',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'mac_key' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'The MAC key (shared secret) for this association.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'created' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'UNIX timestamp for when the association was created.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'expires_in' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'The lifetime, in seconds, of this association.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('assoc_handle'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $schema['openid_nonce'] = array(
danielebarchiesi@0:     'description' => 'Stores received openid.response_nonce per OpenID endpoint URL to prevent replay attacks.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'idp_endpoint_uri' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'URI of the OpenID Provider endpoint.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'nonce' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'The value of openid.response_nonce.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'expires' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'A Unix timestamp indicating when the entry should expire.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'nonce' => array('nonce'),
danielebarchiesi@0:       'expires' => array('expires'),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $schema;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_requirements().
danielebarchiesi@0:  */
danielebarchiesi@0: function openid_requirements($phase) {
danielebarchiesi@0:   $requirements = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if ($phase == 'runtime') {
danielebarchiesi@0:     // Check for the PHP BC Math library.
danielebarchiesi@0:     if (!function_exists('bcadd') && !function_exists('gmp_add')) {
danielebarchiesi@0:       $requirements['openid_math'] = array(
danielebarchiesi@0:         'value' => t('Not installed'),
danielebarchiesi@0:         'severity' => REQUIREMENT_ERROR,
danielebarchiesi@0:         'description' => t('OpenID suggests the use of either the <a href="@gmp">GMP Math</a> (recommended for performance) or <a href="@bc">BC Math</a> libraries to enable OpenID associations.', array('@gmp' => 'http://php.net/manual/en/book.gmp.php', '@bc' => 'http://www.php.net/manual/en/book.bc.php')),
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (!function_exists('gmp_add')) {
danielebarchiesi@0:       $requirements['openid_math'] = array(
danielebarchiesi@0:         'value' => t('Not optimized'),
danielebarchiesi@0:         'severity' => REQUIREMENT_WARNING,
danielebarchiesi@0:         'description' => t('OpenID suggests the use of the GMP Math library for PHP for optimal performance. Check the <a href="@url">GMP Math Library documentation</a> for installation instructions.', array('@url' => 'http://www.php.net/manual/en/book.gmp.php')),
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $requirements['openid_math'] = array(
danielebarchiesi@0:         'value' => t('Installed'),
danielebarchiesi@0:         'severity' => REQUIREMENT_OK,
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0:     $requirements['openid_math']['title'] = t('OpenID Math library');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $requirements;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @addtogroup updates-6.x-to-7.x
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add a table to store nonces.
danielebarchiesi@0:  */
danielebarchiesi@0: function openid_update_6000() {
danielebarchiesi@0:   $schema['openid_nonce'] = array(
danielebarchiesi@0:     'description' => 'Stores received openid.response_nonce per OpenID endpoint URL to prevent replay attacks.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'idp_endpoint_uri' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'URI of the OpenID Provider endpoint.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'nonce' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'description' => 'The value of openid.response_nonce'
danielebarchiesi@0:         ),
danielebarchiesi@0:       'expires' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'A Unix timestamp indicating when the entry should expire.',
danielebarchiesi@0:         ),
danielebarchiesi@0:       ),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'nonce' => array('nonce'),
danielebarchiesi@0:       'expires' => array('expires'),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   db_create_table('openid_nonce', $schema['openid_nonce']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @} End of "addtogroup updates-6.x-to-7.x".
danielebarchiesi@0:  */