google_oauthcallback.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2022       Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2015       Frederic France      <frederic.france@free.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
// This page should make the process to login and get token as described here:
// https://developers.google.com/identity/protocols/oauth2/openid-connect#server-flow
 
// Load Dolibarr environment
require '../../../main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
use OAuth\Common\Storage\DoliStorage;
use OAuth\Common\Consumer\Credentials;
use OAuth\OAuth2\Service\Google;
 
// Define $urlwithroot
$urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
$urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
//$urlwithroot=DOL_MAIN_URL_ROOT;         // This is to use same domain name than current
 
 
 
$action = GETPOST('action', 'aZ09');
$backtourl = GETPOST('backtourl', 'alpha');
$keyforprovider = GETPOST('keyforprovider', 'aZ09');
if (!GETPOSTISSET('keyforprovider') && !empty($_SESSION["oauthkeyforproviderbeforeoauthjump"]) && (GETPOST('code') || $action == 'delete')) {
  // If we are coming from the Oauth page
  $keyforprovider = $_SESSION["oauthkeyforproviderbeforeoauthjump"];
}
 
 
$uriFactory = new \OAuth\Common\Http\Uri\UriFactory();
//$currentUri = $uriFactory->createFromSuperGlobalArray($_SERVER);
//$currentUri->setQuery('');
$currentUri = $uriFactory->createFromAbsolute($urlwithroot.'/core/modules/oauth/google_oauthcallback.php');
 
 
$serviceFactory = new \OAuth\ServiceFactory();
$httpClient = new \OAuth\Common\Http\Client\CurlClient();
// TODO Set options for proxy and timeout
// $params=array('CURLXXX'=>value, ...)
//$httpClient->setCurlParameters($params);
$serviceFactory->setHttpClient($httpClient);
 
// Setup the credentials for the requests
$keyforparamid = 'OAUTH_GOOGLE'.($keyforprovider ? '-'.$keyforprovider : '').'_ID';
$keyforparamsecret = 'OAUTH_GOOGLE'.($keyforprovider ? '-'.$keyforprovider : '').'_SECRET';
$credentials = new Credentials(
  getDolGlobalString($keyforparamid),
  getDolGlobalString($keyforparamsecret),
  $currentUri->getAbsoluteUri()
);
 
$state = GETPOST('state');
$statewithscopeonly = '';
$statewithanticsrfonly = '';
 
$requestedpermissionsarray = array();
if ($state) {
  // 'state' parameter is standard to store a hash value and can be used to retrieve some parameters back
  $statewithscopeonly = preg_replace('/\-.*$/', '', $state);
  $requestedpermissionsarray = explode(',', $statewithscopeonly); // Example: 'userinfo_email,userinfo_profile,openid,email,profile,cloud_print'.
  $statewithanticsrfonly = preg_replace('/^.*\-/', '', $state);
}
 
if ($action != 'delete' && (empty($statewithscopeonly) || empty($requestedpermissionsarray))) {
  setEventMessages($langs->trans('ScopeUndefined'), null, 'errors');
  header('Location: '.$backtourl);
  exit();
}
 
//var_dump($requestedpermissionsarray);exit;
 
 
// Dolibarr storage
$storage = new DoliStorage($db, $conf, $keyforprovider);
 
// Instantiate the Api service using the credentials, http client and storage mechanism for the token
// $requestedpermissionsarray contains list of scopes.
// Conversion into URL is done by Reflection on constant with name SCOPE_scope_in_uppercase
$apiService = $serviceFactory->createService('Google', $credentials, $storage, $requestedpermissionsarray);
 
// access type needed to have oauth provider refreshing token
// also note that a refresh token is sent only after a prompt
$apiService->setAccessType('offline');
 
 
$langs->load("oauth");
 
if (!getDolGlobalString($keyforparamid)) {
  accessforbidden('Setup of service is not complete. Customer ID is missing');
}
if (!getDolGlobalString($keyforparamsecret)) {
  accessforbidden('Setup of service is not complete. Secret key is missing');
}
 
 
/*
 * Actions
 */
 
 
if ($action == 'delete') {
  $storage->clearToken('Google');
 
  setEventMessages($langs->trans('TokenDeleted'), null, 'mesgs');
 
  header('Location: '.$backtourl);
  exit();
}
 
if (GETPOST('code')) {     // We are coming from oauth provider page.
  dol_syslog("We are coming from the oauth provider page keyforprovider=".$keyforprovider);
 
  // We must validate that the $state is the same than the one into $_SESSION['oauthstateanticsrf'], return error if not.
  if (isset($_SESSION['oauthstateanticsrf']) && $state != $_SESSION['oauthstateanticsrf']) {
    print 'Value for state = '.dol_escape_htmltag($state).' differs from value in $_SESSION["oauthstateanticsrf"]. Code is refused.';
    unset($_SESSION['oauthstateanticsrf']);
  } else {
    // This was a callback request from service, get the token
    try {
      //var_dump($_GET['code']);
      //var_dump($state);
      //var_dump($apiService);      // OAuth\OAuth2\Service\Google
 
      // This request the token
      // Result is stored into object managed by class DoliStorage into includes/OAuth/Common/Storage/DoliStorage.php, so into table llx_oauth_token
      $token = $apiService->requestAccessToken(GETPOST('code'), $state);
 
      // Note: The extraparams has the 'id_token' than contains a lot of information about the user.
      $extraparams = $token->getExtraParams();
      $jwt = explode('.', $extraparams['id_token']);
 
      // Extract the middle part, base64 decode, then json_decode it
      if (!empty($jwt[1])) {
        $userinfo = json_decode(base64_decode($jwt[1]), true);
 
        // TODO
        // We should make the 5 steps of validation of id_token
        // Verify that the ID token is properly signed by the issuer. Google-issued tokens are signed using one of the certificates found at the URI specified in the jwks_uri metadata value of the Discovery document.
        // Verify that the value of the iss claim in the ID token is equal to https://accounts.google.com or accounts.google.com.
        // Verify that the value of the aud claim in the ID token is equal to your app's client ID.
        // Verify that the expiry time (exp claim) of the ID token has not passed.
        // If you specified a hd parameter value in the request, verify that the ID token has a hd claim that matches an accepted G Suite hosted domain.
 
        /*
        $useremailuniq = $userinfo['sub'];
        $useremail = $userinfo['email'];
        $useremailverified = $userinfo['email_verified'];
        $username = $userinfo['name'];
        $userfamilyname = $userinfo['family_name'];
        $usergivenname = $userinfo['given_name'];
        $hd = $userinfo['hd'];
        */
      }
 
      setEventMessages($langs->trans('NewTokenStored'), null, 'mesgs');
 
      $backtourl = $_SESSION["backtourlsavedbeforeoauthjump"];
      unset($_SESSION["backtourlsavedbeforeoauthjump"]);
 
      header('Location: '.$backtourl);
      exit();
    } catch (Exception $e) {
      print $e->getMessage();
    }
  }
} else {
  // If we enter this page without 'code' parameter, we arrive here. this is the case when we want to get the redirect
  // to the OAuth provider login page.
  $_SESSION["backtourlsavedbeforeoauthjump"] = $backtourl;
  $_SESSION["oauthkeyforproviderbeforeoauthjump"] = $keyforprovider;
  $_SESSION['oauthstateanticsrf'] = $state;
 
  if (!preg_match('/^forlogin/', $state)) {
    $apiService->setApprouvalPrompt('force');
  }
 
  // This may create record into oauth_state before the header redirect.
  // Creation of record with state in this tables depend on the Provider used (see its constructor).
  if ($state) {
    $url = $apiService->getAuthorizationUri(array('state' => $state));
  } else {
    $url = $apiService->getAuthorizationUri(); // Parameter state will be randomly generated
  }
 
  // Add more param
  $url .= '&nonce='.bin2hex(random_bytes(64/8));
  // TODO Add param hd and/or login_hint
  if (!preg_match('/^forlogin/', $state)) {
    //$url .= 'hd=xxx';
  }
 
  // we go on oauth provider authorization page
  header('Location: '.$url);
  exit();
}
 
 
/*
 * View
 */
 
// No view at all, just actions, so we never reach this line.
 
$db->close();