class Scope in OAuth2 Server 7

Provides a scope-checking utility to the library.

Hierarchy

• class \Drupal\oauth2_server\Scope implements \OAuth2\ScopeInterface

4 string references to 'Scope'

OAuth2ScopeI18nStringController::hook_object_info in includes/oauth2_server.scope_i18n.inc

Overrides EntityDefaultI18nStringController::hook_object_info().

OAuth2ServerScopeUIController::overviewTableHeaders in includes/oauth2_server.scope_admin.inc

Overrides EntityDefaultUIController::overviewTableHeaders().

OAuth2ServerScopeUIController::__construct in includes/oauth2_server.scope_admin.inc

oauth2_server_services_controller_settings in includes/oauth2_server.services_auth.inc

Services authentication "controller_settings" callback.

File

lib/Drupal/oauth2_server/Scope.php, line 11

Namespace

Drupal\oauth2_server

class Scope implements ScopeInterface {
  private $server;
  public function __construct($server) {
    $this->server = $server;
  }

  /**
   * Check if everything in required scope is contained in available scope.
   *
   * @param string $required_scope
   *   A space-separated string of scopes.
   *
   * @return bool
   *   TRUE if everything in required scope is contained in available scope,
   *   and FALSE if it isn't.
   *
   * @see http://tools.ietf.org/html/rfc6749#section-7
   *
   * @ingroup oauth2_section_7
   */
  function checkScope($required_scope, $available_scope) {
    $required_scope = explode(' ', trim($required_scope));
    $available_scope = explode(' ', trim($available_scope));
    return count(array_diff($required_scope, $available_scope)) == 0;
  }

  /**
   * Check if the provided scope exists in storage.
   *
   * @param $scope
   *   A space-separated string of scopes.
   * @param $client_id
   *   The requesting client.
   *
   * @return bool
   *   TRUE if it exists, FALSE otherwise.
   */
  function scopeExists($scope, $client_id = null) {
    $scope = explode(' ', trim($scope));

    // Get all scope entities that match the provided scope.
    // Compare the difference.
    $query = new \EntityFieldQuery();
    $query
      ->entityCondition('entity_type', 'oauth2_server_scope');
    $query
      ->propertyCondition('server', $this->server->name);
    $query
      ->propertyCondition('name', $scope);
    $query
      ->addTag('oauth2_server_scope_access');
    $query
      ->addMetaData('oauth2_server', $this->server);
    $results = $query
      ->execute();
    if ($results) {
      $scope_ids = array_keys($results['oauth2_server_scope']);
      $loaded_scopes = entity_load('oauth2_server_scope', $scope_ids);
      $found_scope = array();
      foreach ($loaded_scopes as $loaded_scope) {
        $found_scope[] = $loaded_scope->name;
      }
      return count(array_diff($scope, $found_scope)) == 0;
    }
    return FALSE;
  }
  public function getScopeFromRequest(RequestInterface $request) {

    // "scope" is valid if passed in either POST or QUERY
    return $request
      ->request('scope', $request
      ->query('scope'));
  }
  public function getDefaultScope($client_id = NULL) {

    // Allow any hook_oauth2_server_default_scope() implementations to supply
    // the default scope. The first one to return a scope wins.
    foreach (module_implements('oauth2_server_default_scope') as $module) {
      $function = $module . '_' . 'oauth2_server_default_scope';
      $args = array(
        $this->server,
      );
      $result = call_user_func_array($function, $args);
      if (is_array($result)) {
        return implode(' ', $result);
      }
    }

    // If there's a valid default scope set in server settings, return it.
    $default_scope = $this->server->settings['default_scope'];
    if (!empty($default_scope) && oauth2_server_scope_load($this->server->name, $default_scope)) {
      return $default_scope;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Scope::$server	private	property
Scope::checkScope		function	Check if everything in required scope is contained in available scope.
Scope::getDefaultScope	public	function
Scope::getScopeFromRequest	public	function
Scope::scopeExists		function	Check if the provided scope exists in storage.
Scope::__construct	public	function