dolibarr 20.0.0
microsoft_oauthcallback.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2022 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2015 Frederic France <frederic.france@free.fr>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <https://www.gnu.org/licenses/>.
17 */
18
25// Load Dolibarr environment
26require '../../../main.inc.php';
27require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
28use OAuth\Common\Storage\DoliStorage;
29use OAuth\Common\Consumer\Credentials;
30
31// Define $urlwithroot
32$urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
33$urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
34//$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
35
36
37$action = GETPOST('action', 'aZ09');
38$backtourl = GETPOST('backtourl', 'alpha');
39$keyforprovider = GETPOST('keyforprovider', 'aZ09');
40if (empty($keyforprovider) && !empty($_SESSION["oauthkeyforproviderbeforeoauthjump"]) && (GETPOST('code') || $action == 'delete')) {
41 $keyforprovider = $_SESSION["oauthkeyforproviderbeforeoauthjump"];
42}
43$genericstring = 'MICROSOFT';
44
48$uriFactory = new \OAuth\Common\Http\Uri\UriFactory();
49//$currentUri = $uriFactory->createFromSuperGlobalArray($_SERVER);
50//$currentUri->setQuery('');
51$currentUri = $uriFactory->createFromAbsolute($urlwithroot.'/core/modules/oauth/microsoft_oauthcallback.php');
52
53
59$serviceFactory = new \OAuth\ServiceFactory();
60$httpClient = new \OAuth\Common\Http\Client\CurlClient();
61// TODO Set options for proxy and timeout
62// $params=array('CURLXXX'=>value, ...)
63//$httpClient->setCurlParameters($params);
64$serviceFactory->setHttpClient($httpClient);
65
66// Setup the credentials for the requests
67$keyforparamid = 'OAUTH_'.$genericstring.($keyforprovider ? '-'.$keyforprovider : '').'_ID';
68$keyforparamsecret = 'OAUTH_'.$genericstring.($keyforprovider ? '-'.$keyforprovider : '').'_SECRET';
69$keyforparamtenant = 'OAUTH_'.$genericstring.($keyforprovider ? '-'.$keyforprovider : '').'_TENANT';
70
71// Dolibarr storage
72$storage = new DoliStorage($db, $conf, $keyforprovider, getDolGlobalString($keyforparamtenant));
73
74$credentials = new Credentials(
75 getDolGlobalString($keyforparamid),
76 getDolGlobalString($keyforparamsecret),
77 $currentUri->getAbsoluteUri()
78);
79
80$state = GETPOST('state');
81
82$requestedpermissionsarray = array();
83if ($state) {
84 $requestedpermissionsarray = explode(',', $state); // Example: 'user'. 'state' parameter is standard to retrieve some parameters back
85}
86if ($action != 'delete' && empty($requestedpermissionsarray)) {
87 print 'Error, parameter state is not defined';
88 exit;
89}
90//var_dump($requestedpermissionsarray);exit;
91
92// Instantiate the Api service using the credentials, http client and storage mechanism for the token
93// ucfirst(strtolower($genericstring)) must be the name of a class into OAuth/OAuth2/Services/Xxxx
94// $requestedpermissionsarray contains list of scopes.
95// Conversion into URL is done by Reflection on constant with name SCOPE_scope_in_uppercase
96try {
97 $nameofservice = ucfirst(strtolower($genericstring));
98 $apiService = $serviceFactory->createService($nameofservice, $credentials, $storage, $requestedpermissionsarray);
99} catch (Exception $e) {
100 print $e->getMessage();
101 exit;
102}
103/*
104var_dump($genericstring.($keyforprovider ? '-'.$keyforprovider : ''));
105var_dump($credentials);
106var_dump($storage);
107var_dump($requestedpermissionsarray);
108*/
109
110if (empty($apiService)) {
111 print 'Error, failed to create serviceFactory';
112 exit;
113}
114
115// access type needed to have oauth provider refreshing token
116//$apiService->setAccessType('offline');
117
118$langs->load("oauth");
119
120if (!getDolGlobalString($keyforparamid)) {
121 accessforbidden('Setup of service is not complete. Customer ID is missing');
122}
123if (!getDolGlobalString($keyforparamsecret)) {
124 accessforbidden('Setup of service is not complete. Secret key is missing');
125}
126if (!getDolGlobalString($keyforparamtenant)) {
127 accessforbidden('Setup of service is not complete. Tenant/Annuary ID key is missing');
128}
129
130
131/*
132 * Actions
133 */
134
135if ($action == 'delete') {
136 $storage->clearToken($genericstring);
137
138 setEventMessages($langs->trans('TokenDeleted'), null, 'mesgs');
139
140 if (empty($backtourl)) {
141 $backtourl = DOL_URL_ROOT.'/';
142 }
143
144 header('Location: '.$backtourl);
145 exit();
146}
147
148//dol_syslog("GET=".join(',', $_GET));
149
150
151if (GETPOST('code') || GETPOST('error')) { // We are coming from oauth provider page
152 // We should have
153 //$_GET=array('code' => string 'aaaaaaaaaaaaaa' (length=20), 'state' => string 'user,public_repo' (length=16))
154
155 dol_syslog(basename(__FILE__)." We are coming from the oauth provider page code=".dol_trunc(GETPOST('code'), 5)." error=".GETPOST('error'));
156
157 // This was a callback request from service, get the token
158 try {
159 //var_dump($state);
160 //var_dump($apiService); // OAuth\OAuth2\Service\Microsoft
161
162 if (GETPOST('error')) {
163 setEventMessages(GETPOST('error').' '.GETPOST('error_description'), null, 'errors');
164 } else {
165 //print GETPOST('code');exit;
166
167 //$token = $apiService->requestAccessToken(GETPOST('code'), $state);
168 $token = $apiService->requestAccessToken(GETPOST('code'));
169 // Microsoft is a service that does not need state to be stored as second parameter of requestAccessToken
170
171 //print $token->getAccessToken().'<br><br>';
172 //print $token->getExtraParams()['id_token'].'<br><br>';
173 //print $token->getRefreshToken().'<br>';exit;
174
175 setEventMessages($langs->trans('NewTokenStored'), null, 'mesgs'); // Stored into object managed by class DoliStorage so into table oauth_token
176 }
177
178 $backtourl = $_SESSION["backtourlsavedbeforeoauthjump"];
179 unset($_SESSION["backtourlsavedbeforeoauthjump"]);
180
181 header('Location: '.$backtourl);
182 exit();
183 } catch (Exception $e) {
184 print $e->getMessage();
185 }
186} else {
187 // If we enter this page without 'code' parameter, we arrive here. This is the case when we want to get the redirect
188 // to the OAuth provider login page.
189 $_SESSION["backtourlsavedbeforeoauthjump"] = $backtourl;
190 $_SESSION["oauthkeyforproviderbeforeoauthjump"] = $keyforprovider;
191 $_SESSION['oauthstateanticsrf'] = $state;
192
193 //if (!preg_match('/^forlogin/', $state)) {
194 // $apiService->setApprouvalPrompt('auto');
195 //}
196
197 // This may create record into oauth_state before the header redirect.
198 // Creation of record with state in this tables depend on the Provider used (see its constructor).
199 if ($state) {
200 $url = $apiService->getAuthorizationUri(array('state' => $state));
201 } else {
202 $url = $apiService->getAuthorizationUri(); // Parameter state will be randomly generated
203 }
204
205 // Show url to get authorization
206 //var_dump((string) $url);exit;
207 dol_syslog("Redirect to url=".$url);
208
209 // we go on oauth provider authorization page
210 header('Location: '.$url);
211 exit();
212}
213
214
215/*
216 * View
217 */
218
219// No view at all, just actions
220
221$db->close();
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0)
Set event messages in dol_events session object.
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '…' if string larger than length.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
$uriFactory
Create a new instance of the URI class with the current URI, stripping the query string.
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.