-<?php namespace BookStack\Auth\Access;
-
-use BookStack\Auth\User;
-use BookStack\Exceptions\JsonDebugException;
-use BookStack\Exceptions\OpenIdException;
-use BookStack\Exceptions\UserRegistrationException;
-use Exception;
-use Lcobucci\JWT\Signer\Rsa\Sha256;
-use Lcobucci\JWT\Token;
-use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
-use OpenIDConnectClient\AccessToken;
-use OpenIDConnectClient\Exception\InvalidTokenException;
-use OpenIDConnectClient\OpenIDConnectProvider;
-
-/**
- * Class OpenIdService
- * Handles any app-specific OpenId tasks.
- */
-class OpenIdService extends ExternalAuthService
-{
- protected $config;
-
- /**
- * OpenIdService constructor.
- */
- public function __construct(RegistrationService $registrationService, User $user)
- {
- parent::__construct($registrationService, $user);
-
- $this->config = config('oidc');
- }
-
- /**
- * Initiate an authorization flow.
- * @throws Exception
- */
- public function login(): array
- {
- $provider = $this->getProvider();
- return [
- 'url' => $provider->getAuthorizationUrl(),
- 'state' => $provider->getState(),
- ];
- }
-
- /**
- * Initiate a logout flow.
- */
- public function logout(): array
- {
- $this->actionLogout();
- $url = '/';
- $id = null;
-
- return ['url' => $url, 'id' => $id];
- }
-
- /**
- * Refresh the currently logged in user.
- * @throws Exception
- */
- public function refresh(): bool
- {
- // Retrieve access token for current session
- $json = session()->get('openid_token');
-
- // If no access token was found, reject the refresh
- if (!$json) {
- $this->actionLogout();
- return false;
- }
-
- $accessToken = new AccessToken(json_decode($json, true) ?? []);
-
- // If the token is not expired, refreshing isn't necessary
- if ($this->isUnexpired($accessToken)) {
- return true;
- }
-
- // Try to obtain refreshed access token
- try {
- $newAccessToken = $this->refreshAccessToken($accessToken);
- } catch (Exception $e) {
- // Log out if an unknown problem arises
- $this->actionLogout();
- throw $e;
- }
-
- // If a token was obtained, update the access token, otherwise log out
- if ($newAccessToken !== null) {
- session()->put('openid_token', json_encode($newAccessToken));
- return true;
- } else {
- $this->actionLogout();
- return false;
- }
- }
-
- /**
- * Check whether an access token or OpenID token isn't expired.
- */
- protected function isUnexpired(AccessToken $accessToken): bool
- {
- $idToken = $accessToken->getIdToken();
-
- $accessTokenUnexpired = $accessToken->getExpires() && !$accessToken->hasExpired();
- $idTokenUnexpired = !$idToken || !$idToken->isExpired();
-
- return $accessTokenUnexpired && $idTokenUnexpired;
- }
-
- /**
- * Generate an updated access token, through the associated refresh token.
- * @throws Exception
- */
- protected function refreshAccessToken(AccessToken $accessToken): ?AccessToken
- {
- // If no refresh token available, abort
- if ($accessToken->getRefreshToken() === null) {
- return null;
- }
-
- // ID token or access token is expired, we refresh it using the refresh token
- try {
- return $this->getProvider()->getAccessToken('refresh_token', [
- 'refresh_token' => $accessToken->getRefreshToken(),
- ]);
- } catch (IdentityProviderException $e) {
- // Refreshing failed
- return null;
- }
- }
-
- /**
- * Process the Authorization response from the authorization server and
- * return the matching, or new if registration active, user matched to
- * the authorization server.
- * Returns null if not authenticated.
- * @throws Exception
- * @throws InvalidTokenException
- */
- public function processAuthorizeResponse(?string $authorizationCode): ?User
- {
- $provider = $this->getProvider();
-
- // Try to exchange authorization code for access token
- $accessToken = $provider->getAccessToken('authorization_code', [
- 'code' => $authorizationCode,
- ]);
-
- return $this->processAccessTokenCallback($accessToken);
- }
-
- /**
- * Do the required actions to log a user out.
- */
- protected function actionLogout()
- {
- auth()->logout();
- session()->invalidate();
- }
-
- /**
- * Load the underlying OpenID Connect Provider.
- */
- protected function getProvider(): OpenIDConnectProvider
- {
- // Setup settings
- $settings = [
- 'clientId' => $this->config['client_id'],
- 'clientSecret' => $this->config['client_secret'],
- 'idTokenIssuer' => $this->config['issuer'],
- 'redirectUri' => url('/openid/redirect'),
- 'urlAuthorize' => $this->config['authorization_endpoint'],
- 'urlAccessToken' => $this->config['token_endpoint'],
- 'urlResourceOwnerDetails' => null,
- 'publicKey' => $this->config['jwt_public_key'],
- 'scopes' => 'profile email',
- ];
-
- // Setup services
- $services = [
- 'signer' => new Sha256(),
- ];
-
- return new OpenIDConnectProvider($settings, $services);
- }
-
- /**
- * Calculate the display name
- */
- protected function getUserDisplayName(Token $token, string $defaultValue): string
- {
- $displayNameAttr = $this->config['display_name_claims'];
-
- $displayName = [];
- foreach ($displayNameAttr as $dnAttr) {
- $dnComponent = $token->claims()->get($dnAttr, '');
- if ($dnComponent !== '') {
- $displayName[] = $dnComponent;
- }
- }
-
- if (count($displayName) == 0) {
- $displayName[] = $defaultValue;
- }
-
- return implode(' ', $displayName);;
- }
-
- /**
- * Extract the details of a user from an ID token.
- */
- protected function getUserDetails(Token $token): array
- {
- $id = $token->claims()->get('sub');
- return [
- 'external_id' => $id,
- 'email' => $token->claims()->get('email'),
- 'name' => $this->getUserDisplayName($token, $id),
- ];
- }
-
- /**
- * Processes a received access token for a user. Login the user when
- * they exist, optionally registering them automatically.
- * @throws OpenIdException
- * @throws JsonDebugException
- * @throws UserRegistrationException
- */
- public function processAccessTokenCallback(AccessToken $accessToken): User
- {
- $userDetails = $this->getUserDetails($accessToken->getIdToken());
- $isLoggedIn = auth()->check();
-
- if ($this->config['dump_user_details']) {
- throw new JsonDebugException($accessToken->jsonSerialize());
- }
-
- if ($userDetails['email'] === null) {
- throw new OpenIdException(trans('errors.openid_no_email_address'));
- }
-
- if ($isLoggedIn) {
- throw new OpenIdException(trans('errors.openid_already_logged_in'), '/login');
- }
-
- $user = $this->getOrRegisterUser($userDetails);
- if ($user === null) {
- throw new OpenIdException(trans('errors.openid_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
- }
-
- auth()->login($user);
- session()->put('openid_token', json_encode($accessToken));
- return $user;
- }
-}