New : API key authentication

One key is stored by user when login API method is called. Each API request must have api_key parameter
This commit is contained in:
jfefe 2015-05-02 23:54:35 +02:00
parent 8027759304
commit fa494369b8
4 changed files with 75 additions and 27 deletions

View File

@ -18,6 +18,7 @@
use Luracast\Restler\Restler; use Luracast\Restler\Restler;
use Luracast\Restler\RestException; use Luracast\Restler\RestException;
require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
/** /**
* Class for API * Class for API
@ -84,20 +85,25 @@ class DolibarrApi {
*/ */
class DolibarrApiInit extends DolibarrApi { class DolibarrApiInit extends DolibarrApi {
function __construct() { function __construct() {
global $db;
$this->db = $db;
} }
/** /**
* Log user with login and password * Login
*
* Log user with username and password
* @todo : to finish! * @todo : to finish!
* *
* @param string $login * @param string $login Username
* @param string $password * @param string $password User password
* @param int $entity * @param int $entity User entity
* @throws RestException * @throws RestException
*/ */
public function login($login, $password, $entity = '') { public function login($login, $password, $entity = 0) {
// Authentication mode // Authentication mode
if (empty($dolibarr_main_authentication)) if (empty($dolibarr_main_authentication))
@ -114,10 +120,27 @@ class DolibarrApiInit extends DolibarrApi {
{ {
throw new RestException(403, 'Access denied'); throw new RestException(403, 'Access denied');
} }
// Generate token for user
$token = dol_hash($login.uniqid().$conf->global->MAIN_API_KEY,1);
// We store API token into database
$sql = "UPDATE ".MAIN_DB_PREFIX."user";
$sql.= " SET api_key = '".$this->db->escape($token)."'";
$sql.= " WHERE login = '".$this->db->escape($login)."'";
dol_syslog(get_class($this)."::login", LOG_DEBUG); // No log
$result = $this->db->query($sql);
if (!$result)
{
throw new RestException(500, 'Error when updating user :'.$this->db->error_msg);
}
//return token
return array( return array(
'success' => array( 'success' => array(
'code' => 200, 'code' => 200,
'token' => $token,
'message' => 'Welcome ' . $login 'message' => 'Welcome ' . $login
) )
); );
@ -127,7 +150,7 @@ class DolibarrApiInit extends DolibarrApi {
* @access protected * @access protected
* @class DolibarrApiAccess {@requires admin} * @class DolibarrApiAccess {@requires admin}
*/ */
public function status() { function status() {
require_once DOL_DOCUMENT_ROOT . '/core/lib/functions.lib.php'; require_once DOL_DOCUMENT_ROOT . '/core/lib/functions.lib.php';
return array( return array(
'success' => array( 'success' => array(

View File

@ -14,49 +14,73 @@ require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
class DolibarrApiAccess implements iAuthenticate class DolibarrApiAccess implements iAuthenticate
{ {
const REALM = 'Restricted Dolibarr API'; const REALM = 'Restricted Dolibarr API';
const TEST_KEY = 'changeme';
/** /**
* * @var string $requires role required by API method user / external / admin
* @var string $role user / external / admin
* @var string $requires
*/ */
public static $requires = 'user'; public static $requires = 'user';
/**
* @var string $role user role
*/
public static $role = 'user'; public static $role = 'user';
/**
* Check access
*
* @return boolean
*/
public function __isAllowed() public function __isAllowed()
{ {
global $db;
//@todo hardcoded api_key=>role for brevity //@todo hardcoded api_key=>role for brevity
// //
$roles = array('123' => 'user', '456' => 'external', '789' => 'admin'); $stored_key = '';
$userClass = Defaults::$userIdentifierClass; $userClass = Defaults::$userIdentifierClass;
// for dev @todo : remove this! // for dev @todo : remove this!
static::$role = 'user'; static::$role = 'user';
if( isset($_GET['test_key'])) { if (isset($_GET['api_key'])) {
if( ! $_GET['test_key'] == DolibarrApiAccess::TEST_KEY) {
$userClass::setCacheIdentifier($_GET['test_key']);
return false;
}
}
elseif (isset($_GET['api_key'])) {
// @todo : check from database // @todo : check from database
if (!array_key_exists($_GET['api_key'], $roles)) { $sql = "SELECT u.login, u.datec, u.api_key, ";
$sql.= " u.tms as date_modification, u.entity";
$sql.= " FROM ".MAIN_DB_PREFIX."user as u";
$sql.= " WHERE u.api_key = '".$db->escape($_GET['api_key'])."'";
$result=$db->query($sql);
if ($result)
{
if ($db->num_rows($result))
{
$obj = $db->fetch_object($result);
$login = $obj->login;
$stored_key = $obj->api_key;
}
}
if ( $stored_key != $_GET['api_key']) {
$userClass::setCacheIdentifier($_GET['api_key']); $userClass::setCacheIdentifier($_GET['api_key']);
return false; return false;
} }
static::$role = $roles[$_GET['api_key']];
$fuser = new User($db);
$result = $fuser->fetch('',$login);
if($fuser->societe_id)
static::$role = 'external';
if($fuser->admin)
static::$role = 'admin';
} }
else else
{ {
return false; return false;
} }
$userClass::setCacheIdentifier(static::$role); $userClass::setCacheIdentifier(static::$role);
Resources::$accessControlFunction = 'DolibarrApiAccess::verifyAccess'; Resources::$accessControlFunction = 'DolibarrApiAccess::verifyAccess';
return static::$requires == static::$role || static::$role == 'admin'; return static::$requires == static::$role || static::$role == 'admin';
@ -64,7 +88,7 @@ class DolibarrApiAccess implements iAuthenticate
public function __getWWWAuthenticateString() public function __getWWWAuthenticateString()
{ {
return 'Query name="api_key"'; return '';
} }
/** /**

View File

@ -46,7 +46,7 @@
discoveryUrl:"../resources.json", discoveryUrl:"../resources.json",
apiKey:"", apiKey:"",
dom_id:"swagger-ui-container", dom_id:"swagger-ui-container",
supportHeaderParams: false, supportHeaderParams: true,
supportedSubmitMethods: ['get', 'post', 'put', 'patch', 'delete'], supportedSubmitMethods: ['get', 'post', 'put', 'patch', 'delete'],
onComplete: function(swaggerApi, swaggerUi){ onComplete: function(swaggerApi, swaggerUi){
if(console) { if(console) {

View File

@ -23,6 +23,7 @@
* API class for thirdparty object * API class for thirdparty object
* *
* @smart-auto-routing false * @smart-auto-routing false
* @access protected
* *
*/ */
class ThirdpartyApi extends DolibarrApi { class ThirdpartyApi extends DolibarrApi {