BookStack Code Mirror - bookstack/blob - app/Auth/Access/Oidc/OidcOAuthProvider.php

   1 <?php
   2
   3 namespace BookStack\Auth\Access\Oidc;
   4
   5 use League\OAuth2\Client\Grant\AbstractGrant;
   6 use League\OAuth2\Client\Provider\AbstractProvider;
   7 use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
   8 use League\OAuth2\Client\Provider\GenericResourceOwner;
   9 use League\OAuth2\Client\Provider\ResourceOwnerInterface;
  10 use League\OAuth2\Client\Token\AccessToken;
  11 use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
  12 use Psr\Http\Message\ResponseInterface;
  13
  14 /**
  15  * Extended OAuth2Provider for using with OIDC.
  16  * Credit to the https://github.com/steverhoades/oauth2-openid-connect-client
  17  * project for the idea of extending a League\OAuth2 client for this use-case.
  18  */
  19 class OidcOAuthProvider extends AbstractProvider
  20 {
  21     use BearerAuthorizationTrait;
  22
  23     /**
  24      * @var string
  25      */
  26     protected $authorizationEndpoint;
  27
  28     /**
  29      * @var string
  30      */
  31     protected $tokenEndpoint;
  32
  33
  34     /**
  35      * Returns the base URL for authorizing a client.
  36      */
  37     public function getBaseAuthorizationUrl(): string
  38     {
  39         return $this->authorizationEndpoint;
  40     }
  41
  42     /**
  43      * Returns the base URL for requesting an access token.
  44      */
  45     public function getBaseAccessTokenUrl(array $params): string
  46     {
  47         return $this->tokenEndpoint;
  48     }
  49
  50     /**
  51      * Returns the URL for requesting the resource owner's details.
  52      */
  53     public function getResourceOwnerDetailsUrl(AccessToken $token): string
  54     {
  55         return '';
  56     }
  57
  58     /**
  59      * Returns the default scopes used by this provider.
  60      *
  61      * This should only be the scopes that are required to request the details
  62      * of the resource owner, rather than all the available scopes.
  63      */
  64     protected function getDefaultScopes(): array
  65     {
  66         return ['openid', 'profile', 'email'];
  67     }
  68
  69
  70     /**
  71      * Returns the string that should be used to separate scopes when building
  72      * the URL for requesting an access token.
  73      */
  74     protected function getScopeSeparator(): string
  75     {
  76         return ' ';
  77     }
  78
  79     /**
  80      * Checks a provider response for errors.
  81      *
  82      * @param ResponseInterface $response
  83      * @param array|string $data Parsed response data
  84      * @return void
  85      * @throws IdentityProviderException
  86      */
  87     protected function checkResponse(ResponseInterface $response, $data)
  88     {
  89         if ($response->getStatusCode() >= 400 || isset($data['error'])) {
  90             throw new IdentityProviderException(
  91                 $data['error'] ?? $response->getReasonPhrase(),
  92                 $response->getStatusCode(),
  93                 (string) $response->getBody()
  94             );
  95         }
  96     }
  97
  98     /**
  99      * Generates a resource owner object from a successful resource owner
 100      * details request.
 101      *
 102      * @param array $response
 103      * @param AccessToken $token
 104      * @return ResourceOwnerInterface
 105      */
 106     protected function createResourceOwner(array $response, AccessToken $token)
 107     {
 108         return new GenericResourceOwner($response, '');
 109     }
 110
 111     /**
 112      * Creates an access token from a response.
 113      *
 114      * The grant that was used to fetch the response can be used to provide
 115      * additional context.
 116      *
 117      * @param array $response
 118      * @param AbstractGrant $grant
 119      * @return OidcAccessToken
 120      */
 121     protected function createAccessToken(array $response, AbstractGrant $grant)
 122     {
 123         return new OidcAccessToken($response);
 124     }
 125
 126
 127 }