From c145023afdc2852ff703b61b6eae429c94ca7ed4 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Thu, 22 Oct 2020 22:46:03 -0700 Subject: [PATCH] dev/core#2141 - Schema - Add OAuthClient and OAuthSysToken Depends on OAuthProvider and permissions ('manage OAuth client' and 'manage OAuth client secrets') --- .../CRM/OAuth/BAO/OAuthClient.php | 39 ++ .../CRM/OAuth/BAO/OAuthSysToken.php | 59 +++ .../CRM/OAuth/DAO/OAuthClient.php | 318 ++++++++++++ .../CRM/OAuth/DAO/OAuthSysToken.php | 471 ++++++++++++++++++ ext/oauth-client/oauth_client.civix.php | 13 +- ext/oauth-client/sql/auto_install.sql | 105 ++++ ext/oauth-client/sql/auto_uninstall.sql | 23 + .../CRM/OAuth/OAuthClient.entityType.php | 10 + .../xml/schema/CRM/OAuth/OAuthClient.xml | 100 ++++ .../CRM/OAuth/OAuthSysToken.entityType.php | 10 + .../xml/schema/CRM/OAuth/OAuthSysToken.xml | 166 ++++++ 11 files changed, 1313 insertions(+), 1 deletion(-) create mode 100644 ext/oauth-client/CRM/OAuth/BAO/OAuthClient.php create mode 100644 ext/oauth-client/CRM/OAuth/BAO/OAuthSysToken.php create mode 100644 ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php create mode 100644 ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php create mode 100644 ext/oauth-client/sql/auto_install.sql create mode 100644 ext/oauth-client/sql/auto_uninstall.sql create mode 100644 ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.entityType.php create mode 100644 ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.xml create mode 100644 ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.entityType.php create mode 100644 ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.xml diff --git a/ext/oauth-client/CRM/OAuth/BAO/OAuthClient.php b/ext/oauth-client/CRM/OAuth/BAO/OAuthClient.php new file mode 100644 index 0000000000..2a70e189b5 --- /dev/null +++ b/ext/oauth-client/CRM/OAuth/BAO/OAuthClient.php @@ -0,0 +1,39 @@ +copyValues($params); + * $instance->save(); + * CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance); + * + * return $instance; + * } */ + +} diff --git a/ext/oauth-client/CRM/OAuth/BAO/OAuthSysToken.php b/ext/oauth-client/CRM/OAuth/BAO/OAuthSysToken.php new file mode 100644 index 0000000000..14402d18dc --- /dev/null +++ b/ext/oauth-client/CRM/OAuth/BAO/OAuthSysToken.php @@ -0,0 +1,59 @@ +copyValues($params); + * $instance->save(); + * CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance); + * + * return $instance; + * } */ + + /** + * Redact the content of a token. + * + * This is useful for processes which must internally use the entire token + * record -- but then report on their progress to a permissioned party. + * + * @param array $tokenRecord + * @return array + */ + public static function redact($tokenRecord) { + if (!\CRM_Core_Permission::check('manage OAuth client secrets')) { + return \CRM_Utils_Array::subset($tokenRecord, self::$returnFields); + } + else { + return $tokenRecord; + } + } + +} diff --git a/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php b/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php new file mode 100644 index 0000000000..0307da99b4 --- /dev/null +++ b/ext/oauth-client/CRM/OAuth/DAO/OAuthClient.php @@ -0,0 +1,318 @@ +__table = 'civicrm_oauth_client'; + parent::__construct(); + } + + /** + * Returns localized title of this entity. + * + * @param bool $plural + * Whether to return the plural version of the title. + */ + public static function getEntityTitle($plural = FALSE) { + return $plural ? E::ts('OAuth Clients') : E::ts('OAuth Client'); + } + + /** + * Returns all the column names of this table + * + * @return array + */ + public static function &fields() { + if (!isset(Civi::$statics[__CLASS__]['fields'])) { + Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ + 'name' => 'id', + 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Internal Client ID'), + 'description' => E::ts('Internal Client ID'), + 'where' => 'civicrm_oauth_client.id', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + 'provider' => [ + 'name' => 'provider', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Provider'), + 'description' => E::ts('Provider'), + 'required' => TRUE, + 'maxlength' => 128, + 'size' => CRM_Utils_Type::HUGE, + 'where' => 'civicrm_oauth_client.provider', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'pseudoconstant' => [ + 'callback' => 'CRM_OAuth_BAO_OAuthClient::getProviders', + ], + 'add' => '5.32', + ], + 'guid' => [ + 'name' => 'guid', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Client ID'), + 'description' => E::ts('Client ID'), + 'required' => TRUE, + 'maxlength' => 128, + 'size' => CRM_Utils_Type::HUGE, + 'where' => 'civicrm_oauth_client.guid', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + 'secret' => [ + 'name' => 'secret', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Client Secret'), + 'description' => E::ts('Client Secret'), + 'where' => 'civicrm_oauth_client.secret', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + 'options' => [ + 'name' => 'options', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Options'), + 'description' => E::ts('Extra override options for the service (JSON)'), + 'where' => 'civicrm_oauth_client.options', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'serialize' => self::SERIALIZE_JSON, + 'add' => '5.32', + ], + 'is_active' => [ + 'name' => 'is_active', + 'type' => CRM_Utils_Type::T_BOOLEAN, + 'title' => E::ts('Is Active'), + 'description' => E::ts('Is the client currently enabled?'), + 'required' => TRUE, + 'where' => 'civicrm_oauth_client.is_active', + 'default' => '1', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + 'created_date' => [ + 'name' => 'created_date', + 'type' => CRM_Utils_Type::T_TIMESTAMP, + 'title' => E::ts('Created Date'), + 'description' => E::ts('When the client was created.'), + 'required' => TRUE, + 'where' => 'civicrm_oauth_client.created_date', + 'default' => 'CURRENT_TIMESTAMP', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + 'modified_date' => [ + 'name' => 'modified_date', + 'type' => CRM_Utils_Type::T_TIMESTAMP, + 'title' => E::ts('Modified Date'), + 'description' => E::ts('When the client was created or modified.'), + 'required' => TRUE, + 'where' => 'civicrm_oauth_client.modified_date', + 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP', + 'table_name' => 'civicrm_oauth_client', + 'entity' => 'OAuthClient', + 'bao' => 'CRM_OAuth_DAO_OAuthClient', + 'localizable' => 0, + 'add' => '5.32', + ], + ]; + CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); + } + return Civi::$statics[__CLASS__]['fields']; + } + + /** + * Return a mapping from field-name to the corresponding key (as used in fields()). + * + * @return array + * Array(string $name => string $uniqueName). + */ + public static function &fieldKeys() { + if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { + Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); + } + return Civi::$statics[__CLASS__]['fieldKeys']; + } + + /** + * Returns the names of this table + * + * @return string + */ + public static function getTableName() { + return self::$_tableName; + } + + /** + * Returns if this table needs to be logged + * + * @return bool + */ + public function getLog() { + return self::$_log; + } + + /** + * Returns the list of fields that can be imported + * + * @param bool $prefix + * + * @return array + */ + public static function &import($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'oauth_client', $prefix, []); + return $r; + } + + /** + * Returns the list of fields that can be exported + * + * @param bool $prefix + * + * @return array + */ + public static function &export($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'oauth_client', $prefix, []); + return $r; + } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = [ + 'UI_provider' => [ + 'name' => 'UI_provider', + 'field' => [ + 0 => 'provider', + ], + 'localizable' => FALSE, + 'sig' => 'civicrm_oauth_client::0::provider', + ], + 'UI_guid' => [ + 'name' => 'UI_guid', + 'field' => [ + 0 => 'guid', + ], + 'localizable' => FALSE, + 'sig' => 'civicrm_oauth_client::0::guid', + ], + ]; + return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + +} diff --git a/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php b/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php new file mode 100644 index 0000000000..3fbbcc9ced --- /dev/null +++ b/ext/oauth-client/CRM/OAuth/DAO/OAuthSysToken.php @@ -0,0 +1,471 @@ +__table = 'civicrm_oauth_systoken'; + parent::__construct(); + } + + /** + * Returns localized title of this entity. + * + * @param bool $plural + * Whether to return the plural version of the title. + */ + public static function getEntityTitle($plural = FALSE) { + return $plural ? E::ts('OAuth Sys Tokens') : E::ts('OAuth Sys Token'); + } + + /** + * Returns foreign keys and entity references. + * + * @return array + * [CRM_Core_Reference_Interface] + */ + public static function getReferenceColumns() { + if (!isset(Civi::$statics[__CLASS__]['links'])) { + Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); + Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'client_id', 'civicrm_oauth_client', 'id'); + CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); + } + return Civi::$statics[__CLASS__]['links']; + } + + /** + * Returns all the column names of this table + * + * @return array + */ + public static function &fields() { + if (!isset(Civi::$statics[__CLASS__]['fields'])) { + Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ + 'name' => 'id', + 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Token ID'), + 'description' => E::ts('Token ID'), + 'required' => TRUE, + 'where' => 'civicrm_oauth_systoken.id', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'tag' => [ + 'name' => 'tag', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Tag'), + 'description' => E::ts('The tag specifies how this token will be used.'), + 'maxlength' => 128, + 'size' => CRM_Utils_Type::HUGE, + 'where' => 'civicrm_oauth_systoken.tag', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'client_id' => [ + 'name' => 'client_id', + 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Client ID'), + 'description' => E::ts('Client ID'), + 'where' => 'civicrm_oauth_systoken.client_id', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'FKClassName' => 'CRM_OAuth_DAO_OAuthClient', + 'add' => '5.32', + ], + 'grant_type' => [ + 'name' => 'grant_type', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Grant type'), + 'description' => E::ts('Ex: authorization_code'), + 'maxlength' => 31, + 'size' => CRM_Utils_Type::MEDIUM, + 'where' => 'civicrm_oauth_systoken.grant_type', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'scopes' => [ + 'name' => 'scopes', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Scopes'), + 'description' => E::ts('List of scopes addressed by this token'), + 'where' => 'civicrm_oauth_systoken.scopes', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'serialize' => self::SERIALIZE_SEPARATOR_BOOKEND, + 'add' => '5.32', + ], + 'token_type' => [ + 'name' => 'token_type', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Token Type'), + 'description' => E::ts('Ex: Bearer or MAC'), + 'maxlength' => 128, + 'size' => CRM_Utils_Type::HUGE, + 'where' => 'civicrm_oauth_systoken.token_type', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'access_token' => [ + 'name' => 'access_token', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Access Token'), + 'description' => E::ts('Token to present when accessing resources'), + 'where' => 'civicrm_oauth_systoken.access_token', + 'permission' => [ + [ + 'manage OAuth client secrets', + ], + ], + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'expires' => [ + 'name' => 'expires', + 'type' => CRM_Utils_Type::T_INT, + 'title' => E::ts('Expiration time'), + 'description' => E::ts('Expiration time for the access_token (seconds since epoch)'), + 'where' => 'civicrm_oauth_systoken.expires', + 'default' => '0', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '4.7', + ], + 'refresh_token' => [ + 'name' => 'refresh_token', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Refresh Token'), + 'description' => E::ts('Token to present when refreshing the access_token'), + 'where' => 'civicrm_oauth_systoken.refresh_token', + 'permission' => [ + [ + 'manage OAuth client secrets', + ], + ], + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'resource_owner_name' => [ + 'name' => 'resource_owner_name', + 'type' => CRM_Utils_Type::T_STRING, + 'title' => E::ts('Resource Owner Name'), + 'description' => E::ts('Identifier for the resource owner. Structure varies by service.'), + 'maxlength' => 128, + 'size' => CRM_Utils_Type::HUGE, + 'where' => 'civicrm_oauth_systoken.resource_owner_name', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'resource_owner' => [ + 'name' => 'resource_owner', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Resource Owner'), + 'description' => E::ts('Cached details describing the resource owner'), + 'where' => 'civicrm_oauth_systoken.resource_owner', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'serialize' => self::SERIALIZE_JSON, + 'add' => '5.32', + ], + 'error' => [ + 'name' => 'error', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Error'), + 'description' => E::ts('List of scopes addressed by this token'), + 'where' => 'civicrm_oauth_systoken.error', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'serialize' => self::SERIALIZE_JSON, + 'add' => '5.32', + ], + 'raw' => [ + 'name' => 'raw', + 'type' => CRM_Utils_Type::T_TEXT, + 'title' => E::ts('Raw token'), + 'description' => E::ts('The token response data, per AccessToken::jsonSerialize'), + 'where' => 'civicrm_oauth_systoken.raw', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'serialize' => self::SERIALIZE_JSON, + 'add' => '5.32', + ], + 'created_date' => [ + 'name' => 'created_date', + 'type' => CRM_Utils_Type::T_TIMESTAMP, + 'title' => E::ts('Created Date'), + 'description' => E::ts('When the client was created.'), + 'required' => FALSE, + 'where' => 'civicrm_oauth_systoken.created_date', + 'default' => 'CURRENT_TIMESTAMP', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + 'modified_date' => [ + 'name' => 'modified_date', + 'type' => CRM_Utils_Type::T_TIMESTAMP, + 'title' => E::ts('Modified Date'), + 'description' => E::ts('When the client was created or modified.'), + 'required' => FALSE, + 'where' => 'civicrm_oauth_systoken.modified_date', + 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP', + 'table_name' => 'civicrm_oauth_systoken', + 'entity' => 'OAuthSysToken', + 'bao' => 'CRM_OAuth_DAO_OAuthSysToken', + 'localizable' => 0, + 'add' => '5.32', + ], + ]; + CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); + } + return Civi::$statics[__CLASS__]['fields']; + } + + /** + * Return a mapping from field-name to the corresponding key (as used in fields()). + * + * @return array + * Array(string $name => string $uniqueName). + */ + public static function &fieldKeys() { + if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { + Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); + } + return Civi::$statics[__CLASS__]['fieldKeys']; + } + + /** + * Returns the names of this table + * + * @return string + */ + public static function getTableName() { + return self::$_tableName; + } + + /** + * Returns if this table needs to be logged + * + * @return bool + */ + public function getLog() { + return self::$_log; + } + + /** + * Returns the list of fields that can be imported + * + * @param bool $prefix + * + * @return array + */ + public static function &import($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'oauth_systoken', $prefix, []); + return $r; + } + + /** + * Returns the list of fields that can be exported + * + * @param bool $prefix + * + * @return array + */ + public static function &export($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'oauth_systoken', $prefix, []); + return $r; + } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = [ + 'UI_tag' => [ + 'name' => 'UI_tag', + 'field' => [ + 0 => 'tag', + ], + 'localizable' => FALSE, + 'sig' => 'civicrm_oauth_systoken::0::tag', + ], + ]; + return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + +} diff --git a/ext/oauth-client/oauth_client.civix.php b/ext/oauth-client/oauth_client.civix.php index bcdb78cac1..64892d344e 100644 --- a/ext/oauth-client/oauth_client.civix.php +++ b/ext/oauth-client/oauth_client.civix.php @@ -473,5 +473,16 @@ function _oauth_client_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NU * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes */ function _oauth_client_civix_civicrm_entityTypes(&$entityTypes) { - $entityTypes = array_merge($entityTypes, []); + $entityTypes = array_merge($entityTypes, [ + 'CRM_OAuth_DAO_OAuthClient' => [ + 'name' => 'OAuthClient', + 'class' => 'CRM_OAuth_DAO_OAuthClient', + 'table' => 'civicrm_oauth_client', + ], + 'CRM_OAuth_DAO_OAuthSysToken' => [ + 'name' => 'OAuthSysToken', + 'class' => 'CRM_OAuth_DAO_OAuthSysToken', + 'table' => 'civicrm_oauth_systoken', + ], + ]); } diff --git a/ext/oauth-client/sql/auto_install.sql b/ext/oauth-client/sql/auto_install.sql new file mode 100644 index 0000000000..fd7f643397 --- /dev/null +++ b/ext/oauth-client/sql/auto_install.sql @@ -0,0 +1,105 @@ +-- +--------------------------------------------------------------------+ +-- | Copyright CiviCRM LLC. All rights reserved. | +-- | | +-- | This work is published under the GNU AGPLv3 license with some | +-- | permitted exceptions and without any warranty. For full license | +-- | and copyright information, see https://civicrm.org/licensing | +-- +--------------------------------------------------------------------+ +-- +-- Generated from schema.tpl +-- DO NOT EDIT. Generated by CRM_Core_CodeGen +-- + + +-- +--------------------------------------------------------------------+ +-- | Copyright CiviCRM LLC. All rights reserved. | +-- | | +-- | This work is published under the GNU AGPLv3 license with some | +-- | permitted exceptions and without any warranty. For full license | +-- | and copyright information, see https://civicrm.org/licensing | +-- +--------------------------------------------------------------------+ +-- +-- Generated from drop.tpl +-- DO NOT EDIT. Generated by CRM_Core_CodeGen +-- +-- /******************************************************* +-- * +-- * Clean up the exisiting tables +-- * +-- *******************************************************/ + +SET FOREIGN_KEY_CHECKS=0; + +DROP TABLE IF EXISTS `civicrm_oauth_systoken`; +DROP TABLE IF EXISTS `civicrm_oauth_client`; + +SET FOREIGN_KEY_CHECKS=1; +-- /******************************************************* +-- * +-- * Create new tables +-- * +-- *******************************************************/ + +-- /******************************************************* +-- * +-- * civicrm_oauth_client +-- * +-- *******************************************************/ +CREATE TABLE `civicrm_oauth_client` ( + + + `id` int unsigned AUTO_INCREMENT COMMENT 'Internal Client ID', + `provider` varchar(128) NOT NULL COMMENT 'Provider', + `guid` varchar(128) NOT NULL COMMENT 'Client ID', + `secret` text COMMENT 'Client Secret', + `options` text COMMENT 'Extra override options for the service (JSON)', + `is_active` tinyint NOT NULL DEFAULT 1 COMMENT 'Is the client currently enabled?', + `created_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'When the client was created.', + `modified_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'When the client was created or modified.' +, + PRIMARY KEY (`id`) + + , INDEX `UI_provider`( + provider + ) + , INDEX `UI_guid`( + guid + ) + + +) ; + +-- /******************************************************* +-- * +-- * civicrm_oauth_systoken +-- * +-- *******************************************************/ +CREATE TABLE `civicrm_oauth_systoken` ( + + + `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Token ID', + `tag` varchar(128) COMMENT 'The tag specifies how this token will be used.', + `client_id` int unsigned COMMENT 'Client ID', + `grant_type` varchar(31) COMMENT 'Ex: authorization_code', + `scopes` text COMMENT 'List of scopes addressed by this token', + `token_type` varchar(128) COMMENT 'Ex: Bearer or MAC', + `access_token` text COMMENT 'Token to present when accessing resources', + `expires` int unsigned DEFAULT 0 COMMENT 'Expiration time for the access_token (seconds since epoch)', + `refresh_token` text COMMENT 'Token to present when refreshing the access_token', + `resource_owner_name` varchar(128) COMMENT 'Identifier for the resource owner. Structure varies by service.', + `resource_owner` text COMMENT 'Cached details describing the resource owner', + `error` text COMMENT 'List of scopes addressed by this token', + `raw` text COMMENT 'The token response data, per AccessToken::jsonSerialize', + `created_date` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'When the client was created.', + `modified_date` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'When the client was created or modified.' +, + PRIMARY KEY (`id`) + + , INDEX `UI_tag`( + tag + ) + +, CONSTRAINT FK_civicrm_oauth_systoken_client_id FOREIGN KEY (`client_id`) REFERENCES `civicrm_oauth_client`(`id`) ON DELETE CASCADE +) ; + + \ No newline at end of file diff --git a/ext/oauth-client/sql/auto_uninstall.sql b/ext/oauth-client/sql/auto_uninstall.sql new file mode 100644 index 0000000000..db6fecf209 --- /dev/null +++ b/ext/oauth-client/sql/auto_uninstall.sql @@ -0,0 +1,23 @@ +-- +--------------------------------------------------------------------+ +-- | Copyright CiviCRM LLC. All rights reserved. | +-- | | +-- | This work is published under the GNU AGPLv3 license with some | +-- | permitted exceptions and without any warranty. For full license | +-- | and copyright information, see https://civicrm.org/licensing | +-- +--------------------------------------------------------------------+ +-- +-- Generated from drop.tpl +-- DO NOT EDIT. Generated by CRM_Core_CodeGen +-- +-- /******************************************************* +-- * +-- * Clean up the exisiting tables +-- * +-- *******************************************************/ + +SET FOREIGN_KEY_CHECKS=0; + +DROP TABLE IF EXISTS `civicrm_oauth_systoken`; +DROP TABLE IF EXISTS `civicrm_oauth_client`; + +SET FOREIGN_KEY_CHECKS=1; \ No newline at end of file diff --git a/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.entityType.php b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.entityType.php new file mode 100644 index 0000000000..21e774a295 --- /dev/null +++ b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.entityType.php @@ -0,0 +1,10 @@ + 'OAuthClient', + 'class' => 'CRM_OAuth_DAO_OAuthClient', + 'table' => 'civicrm_oauth_client', + ], +]; diff --git a/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.xml b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.xml new file mode 100644 index 0000000000..9b3649a6f9 --- /dev/null +++ b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthClient.xml @@ -0,0 +1,100 @@ + + CRM/OAuth + OAuthClient + civicrm_oauth_client + 5.32 + + id + Internal Client ID + int unsigned + Internal Client ID + 5.32 + + + id + true + + + + provider + Provider + varchar + 128 + + CRM_OAuth_BAO_OAuthClient::getProviders + + true + Provider + 5.32 + + + UI_provider + provider + 5.32 + + + + guid + Client ID + varchar + 128 + true + Client ID + 5.32 + + + UI_guid + guid + 5.32 + + + + secret + Client Secret + text + Client Secret + 5.32 + + + + + + + + options + text + Extra override options for the service (JSON) + + JSON + 5.32 + + + + + + is_active + Is Active + boolean + 1 + true + Is the client currently enabled? + 5.32 + + + created_date + timestamp + When the client was created. + true + CURRENT_TIMESTAMP + 5.32 + + + modified_date + timestamp + When the client was created or modified. + true + CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP + 5.32 + + +
diff --git a/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.entityType.php b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.entityType.php new file mode 100644 index 0000000000..5c53dd6fc1 --- /dev/null +++ b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.entityType.php @@ -0,0 +1,10 @@ + 'OAuthSysToken', + 'class' => 'CRM_OAuth_DAO_OAuthSysToken', + 'table' => 'civicrm_oauth_systoken', + ], +]; diff --git a/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.xml b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.xml new file mode 100644 index 0000000000..45fc80ce61 --- /dev/null +++ b/ext/oauth-client/xml/schema/CRM/OAuth/OAuthSysToken.xml @@ -0,0 +1,166 @@ + + CRM/OAuth + OAuthSysToken + civicrm_oauth_systoken + 5.32 + + id + Token ID + int unsigned + true + Token ID + 5.32 + + + id + true + + + + + + tag + Tag + varchar + 128 + The tag specifies how this token will be used. + 5.32 + + + UI_tag + tag + 5.32 + + + + client_id + Client ID + int unsigned + Client ID + 5.32 + + + client_id +
civicrm_oauth_client
+ id + 5.32 + CASCADE + + + + grant_type + Grant type + varchar + 31 + + Ex: authorization_code + 5.32 + + + + scopes + text + List of scopes addressed by this token + SEPARATOR_BOOKEND + 5.32 + + + + + + token_type + Token Type + varchar + 128 + Ex: Bearer or MAC + 5.32 + + + + access_token + Access Token + text + + + manage OAuth client secrets + + Token to present when accessing resources + 5.32 + + + + expires + int unsigned + Expiration time + 0 + Expiration time for the access_token (seconds since epoch) + 4.7 + + + + refresh_token + Refresh Token + text + + + manage OAuth client secrets + + Token to present when refreshing the access_token + 5.32 + + + + resource_owner_name + Resource Owner Name + varchar + 128 + Identifier for the resource owner. Structure varies by service. + 5.32 + + + + resource_owner + Resource Owner + text + Cached details describing the resource owner + JSON + 5.32 + + + + error + text + List of scopes addressed by this token + JSON + 5.32 + + + + raw + Raw token + text + JSON + The token response data, per AccessToken::jsonSerialize + 5.32 + + + + + + created_date + timestamp + When the client was created. + false + CURRENT_TIMESTAMP + 5.32 + + + modified_date + timestamp + When the client was created or modified. + false + CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP + 5.32 + + + -- 2.25.1