dolibarr 18.0.7
api_access.class.php
1<?php
2/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
3 * Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2023 Ferran Marcet <fmarcet@2byte.es>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20// Create the autoloader for Luracast
21require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/AutoLoader.php';
22call_user_func(function () {
23 $loader = Luracast\Restler\AutoLoader::instance();
24 spl_autoload_register($loader);
25 return $loader;
26});
27
28require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/iAuthenticate.php';
29require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/iUseAuthentication.php';
30require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/Resources.php';
31require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/Defaults.php';
32require_once DOL_DOCUMENT_ROOT.'/includes/restler/framework/Luracast/Restler/RestException.php';
33use Luracast\Restler\iAuthenticate;
34use Luracast\Restler\iUseAuthentication;
35use Luracast\Restler\Resources;
36use Luracast\Restler\Defaults;
37use Luracast\Restler\RestException;
38
43class DolibarrApiAccess implements iAuthenticate
44{
45 const REALM = 'Restricted Dolibarr API';
46
50 public static $requires = array('user', 'external', 'admin');
51
55 public static $role = 'user';
56
60 public static $user = '';
61
62
66 public function __construct()
67 {
68 global $db;
69 $this->db = $db;
70 }
71
72 // phpcs:disable PEAR.NamingConventions.ValidFunctionName
81 public function __isAllowed()
82 {
83 // phpcs:enable
84 global $conf, $db, $langs, $mysoc, $user;
85
86 $login = '';
87 $stored_key = '';
88
89 $userClass = Defaults::$userIdentifierClass;
90
91 /*foreach ($_SERVER as $key => $val)
92 {
93 dol_syslog($key.' - '.$val);
94 }*/
95
96 // api key can be provided in url with parameter api_key=xxx or ni header with header DOLAPIKEY:xxx
97 $api_key = '';
98 if (isset($_GET['api_key'])) { // For backward compatibility
99 // TODO Add option to disable use of api key on url. Return errors if used.
100 $api_key = $_GET['api_key'];
101 }
102 if (isset($_GET['DOLAPIKEY'])) {
103 // TODO Add option to disable use of api key on url. Return errors if used.
104 $api_key = $_GET['DOLAPIKEY']; // With GET method
105 }
106 if (isset($_SERVER['HTTP_DOLAPIKEY'])) { // Param DOLAPIKEY in header can be read with HTTP_DOLAPIKEY
107 $api_key = $_SERVER['HTTP_DOLAPIKEY']; // With header method (recommanded)
108 }
109 if (preg_match('/^dolcrypt:/i', $api_key)) {
110 throw new RestException(503, 'Bad value for the API key. An API key should not start with dolcrypt:');
111 }
112
113 if ($api_key) {
114 $userentity = 0;
115
116 $sql = "SELECT u.login, u.datec, u.api_key,";
117 $sql .= " u.tms as date_modification, u.entity";
118 $sql .= " FROM ".MAIN_DB_PREFIX."user as u";
119 $sql .= " WHERE u.api_key = '".$this->db->escape($api_key)."' OR u.api_key = '".$this->db->escape(dolEncrypt($api_key, '', '', 'dolibarr'))."'";
120
121 $result = $this->db->query($sql);
122 if ($result) {
123 $nbrows = $this->db->num_rows($result);
124 if ($nbrows == 1) {
125 $obj = $this->db->fetch_object($result);
126 $login = $obj->login;
127 $stored_key = dolDecrypt($obj->api_key);
128 $userentity = $obj->entity;
129
130 if (!defined("DOLENTITY") && $conf->entity != ($obj->entity ? $obj->entity : 1)) { // If API was not forced with HTTP_DOLENTITY, and user is on another entity, so we reset entity to entity of user
131 $conf->entity = ($obj->entity ? $obj->entity : 1);
132 // We must also reload global conf to get params from the entity
133 dol_syslog("Entity was not set on http header with HTTP_DOLAPIENTITY (recommanded for performance purpose), so we switch now on entity of user (".$conf->entity.") and we have to reload configuration.", LOG_WARNING);
134 $conf->setValues($this->db);
135
136 // set global mysoc after setting conf entity (the entity can be changed with the user logged)
137 // see master.inc.php
138 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
139
140 $fmysoc = new Societe($db);
141 $fmysoc->setMysoc($conf);
142
143 // We set some specific default values according to country
144 if ($fmysoc->country_code == 'DE' && !isset($conf->global->MAIN_INVERT_SENDER_RECIPIENT)) {
145 // For DE, we need to invert our address with customer address
146 $conf->global->MAIN_INVERT_SENDER_RECIPIENT = 1;
147 }
148 if ($fmysoc->country_code == 'FR' && !isset($conf->global->INVOICE_CATEGORY_OF_OPERATION)) {
149 // For FR, default value of option to show category of operations is on by default. Decret n°2099-1299 2022-10-07
150 $conf->global->INVOICE_CATEGORY_OF_OPERATION = 1;
151 }
152 if ($fmysoc->country_code == 'FR' && !isset($conf->global->INVOICE_DISABLE_REPLACEMENT)) {
153 // For FR, the replacement invoice type is not allowed.
154 // From an accounting point of view, this creates holes in the numbering of the invoice.
155 // This is very problematic during a fiscal control.
156 $conf->global->INVOICE_DISABLE_REPLACEMENT = 1;
157 }
158 if ($fmysoc->country_code == 'GR' && !isset($conf->global->INVOICE_DISABLE_REPLACEMENT)) {
159 // The replacement invoice type is not allowed in Greece.
160 $conf->global->INVOICE_DISABLE_REPLACEMENT = 1;
161 }
162 if ($fmysoc->country_code == 'GR' && !isset($conf->global->INVOICE_DISABLE_DEPOSIT)) {
163 // The deposit invoice type is not allowed in Greece.
164 $conf->global->INVOICE_DISABLE_DEPOSIT = 1;
165 }
166
167 if (($fmysoc->localtax1_assuj || $fmysoc->localtax2_assuj) && !isset($conf->global->MAIN_NO_INPUT_PRICE_WITH_TAX)) {
168 // For countries using the 2nd or 3rd tax, we disable input/edit of lines using the price including tax (because 2nb and 3rd tax not yet taken into account).
169 // Work In Progress to support all taxes into unit price entry when MAIN_UNIT_PRICE_WITH_TAX_IS_FOR_ALL_TAXES is set.
170 $conf->global->MAIN_NO_INPUT_PRICE_WITH_TAX = 1;
171 }
172 // Set also the global variable $mysoc
173 $mysoc = $fmysoc;
174
175 // Reload langs
176 $langcode = (empty($conf->global->MAIN_LANG_DEFAULT) ? 'auto' : $conf->global->MAIN_LANG_DEFAULT);
177 if (!empty($user->conf->MAIN_LANG_DEFAULT)) {
178 $langcode = $user->conf->MAIN_LANG_DEFAULT;
179 }
180 if ($langs->getDefaultLang() != $langcode) {
181 $langs->setDefaultLang($langcode);
182 $langs->tab_translate = array();
183 $langs->loadLangs(array('main'));
184 }
185 }
186 } elseif ($nbrows > 1) {
187 throw new RestException(503, 'Error when fetching user api_key : More than 1 user with this apikey');
188 }
189 } else {
190 throw new RestException(503, 'Error when fetching user api_key :'.$this->db->error_msg);
191 }
192
193 if ($login && $stored_key != $api_key) { // This should not happen since we did a search on api_key
194 $userClass::setCacheIdentifier($api_key);
195 return false;
196 }
197
198 $genericmessageerroruser = 'Error user not valid (not found with api key or bad status or bad validity dates) (conf->entity='.$conf->entity.')';
199
200 if (!$login) {
201 dol_syslog("functions_isallowed::check_user_api_key Authentication KO for api key: Error when searching login user from api key", LOG_NOTICE);
202 sleep(1); // Anti brut force protection. Must be same delay when user and password are not valid.
203 throw new RestException(401, $genericmessageerroruser);
204 }
205
206 $fuser = new User($this->db);
207 $result = $fuser->fetch('', $login, '', 0, (empty($userentity) ? -1 : $conf->entity)); // If user is not entity 0, we search in working entity $conf->entity (that may have been forced to a different value than user entity)
208 if ($result <= 0) {
209 dol_syslog("functions_isallowed::check_user_api_key Authentication KO for '".$login."': Failed to fetch on entity", LOG_NOTICE);
210 sleep(1); // Anti brut force protection. Must be same delay when user and password are not valid.
211 throw new RestException(401, $genericmessageerroruser);
212 }
213
214 // Check if user status is enabled
215 if ($fuser->statut != $fuser::STATUS_ENABLED) {
216 // Status is disabled
217 dol_syslog("functions_isallowed::check_user_api_key Authentication KO for '".$login."': The user has been disabled", LOG_NOTICE);
218 sleep(1); // Anti brut force protection. Must be same delay when user and password are not valid.
219 throw new RestException(401, $genericmessageerroruser);
220 }
221
222 // Check if session was unvalidated by a password change
223 if (($fuser->flagdelsessionsbefore && !empty($_SESSION["dol_logindate"]) && $fuser->flagdelsessionsbefore > $_SESSION["dol_logindate"])) {
224 // Session is no more valid
225 dol_syslog("functions_isallowed::check_user_api_key Authentication KO for '".$login."': The user has a date for session invalidation = ".$fuser->flagdelsessionsbefore." and a session date = ".$_SESSION["dol_logindate"].". We must invalidate its sessions.");
226 sleep(1); // Anti brut force protection. Must be same delay when user and password are not valid.
227 throw new RestException(401, $genericmessageerroruser);
228 }
229
230 // Check date validity
231 if ($fuser->isNotIntoValidityDateRange()) {
232 // User validity dates are no more valid
233 dol_syslog("functions_isallowed::check_user_api_key Authentication KO for '".$login."': The user login has a validity between [".$fuser->datestartvalidity." and ".$fuser->dateendvalidity."], curren date is ".dol_now());
234 sleep(1); // Anti brut force protection. Must be same delay when user and password are not valid.
235 throw new RestException(401, $genericmessageerroruser);
236 }
237
238 // User seems valid
239 $fuser->getrights();
240
241 // Set the property $user to the $user of API
242 static::$user = $fuser;
243
244 // Set also the global variable $user to the $user of API
245 $user = $fuser;
246
247 if ($fuser->socid) {
248 static::$role = 'external';
249 }
250
251 if ($fuser->admin) {
252 static::$role = 'admin';
253 }
254 } else {
255 throw new RestException(401, "Failed to login to API. No parameter 'HTTP_DOLAPIKEY' on HTTP header (and no parameter DOLAPIKEY in URL).");
256 }
257
258 $userClass::setCacheIdentifier(static::$role);
259 Resources::$accessControlFunction = 'DolibarrApiAccess::verifyAccess';
260 $requirefortest = static::$requires;
261 if (!is_array($requirefortest)) {
262 $requirefortest = explode(',', $requirefortest);
263 }
264 return in_array(static::$role, (array) $requirefortest) || static::$role == 'admin';
265 }
266
267 // phpcs:disable PEAR.NamingConventions.ValidFunctionName
272 {
273 // phpcs:enable
274 return '';
275 }
276
285 public static function verifyAccess(array $m)
286 {
287 $requires = isset($m['class']['DolibarrApiAccess']['properties']['requires'])
288 ? $m['class']['DolibarrApiAccess']['properties']['requires']
289 : false;
290
291
292 return $requires
293 ? static::$role == 'admin' || in_array(static::$role, (array) $requires)
294 : true;
295 }
296}
Dolibarr API access class.
__construct()
Constructor.
__isAllowed()
Check access.
static verifyAccess(array $m)
Verify access.
Class to manage third parties objects (customers, suppliers, prospects...)
Class to manage Dolibarr users.
dol_now($mode='auto')
Return date for now.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
dolEncrypt($chain, $key='', $ciphering='AES-256-CTR', $forceseed='')
Encode a string with a symetric encryption.
dolDecrypt($chain, $key='')
Decode a string with a symetric encryption.