Homec4science
Diffusion Tequila PHP client (remarkup-fixup) Browse

tequila-php-client/tequila.php
9c742546ca26remarkup-fixup

Last Change
Raw File

tequila.php
View Options

<?php
/**
* Tequila authentication
*
* @package auth_tequila
* @copyright 2004-2021 EPFL <https://www.epfl.ch/>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/*========================================================================
PHP client for Tequila, v. 2.0.4 (Tue Nov 14 10:47:18 CET 2006)
(C) 2004, Lionel Clavien [lionel dot clavien AT epfl dot ch]
This code is released under the GNU GPL v2 terms (see LICENCE file).
Changelog:
0.1.0, 2004-06-27: Creation
0.1.1, 2004-08-29: Changed RSA authentication method to use the new
server certificate in lieu of the server public key
[openssl bug ?]
0.1.2, 2004-09-04: Configuration options put in tequila_config.inc.php
......
2.0.3 : I forgot.
2.0.4 : Fix problem with cookie. Now it is a session cookie.
2.0.5 : Fix ERROR_SESSION_FILE (replace with ERROR_SESSION_FILE_FORMAT).
Fix bug in fetchAttributes().
3.0.0 : Big rewrite.
Fix session time out
use PHP sessions
hide key attribute in urlaccess.
3.0.1 : Fix INFO_PATH & QUERY_STRING test.
3.0.2 : 2011-08-05 : Include comments from Lucien Chaboudez
Define MIN_SESSION_TIMEOUT
Delete cookie with explicit root path
3.0.3 : 2012-04-12 : Patch from Lucien Chaboudez
LoadSession :Check if all the wanted attributes are present
in the $_SESSION.
TODO:
- implement more documented features (allows, ?)
========================================================================*/
require __DIR__ . '/vendor/autoload.php';
require_once "exception.php";
require_once 'language.php';
// Start output buffering, for the authentication redirection to work...
ob_start();
class TequilaClient {
// maybe move to configuration file?
const TEQUILA_BIN = "/cgi-bin/tequila";
const COOKIE_NAME = "TequilaPHP";
const COOKIE_LIFE = 0;
const BODY_GLUE = "+";
const SERVER_ENDPOINTS = ["createrequest", "fetchattributes", "getconfig", "logout"];
private string $serverURL;
private int $timeout;
private string $logoutURL;
private int $language;
private string $applicationURL;
private string $applicationName;
// one time stuff
private array $wantedAttributes;
private array $filters;
private array $authorised;
private array $allowedRequestHosts;
function __construct(string $server, int $timeout, string $applicationName, string $applicationURL = "", int $language = ENGLISH) {
$this->serverURL = $server . TequilaClient::TEQUILA_BIN;
$this->timeout = $timeout;
$this->language = $language;
$this->applicationURL = $applicationURL;
$this->applicationName = $applicationName;
// if no application URL was specified, we try to generate it
if (empty($this->applicationURL)) {
$protocol = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on' ? "https://" : "http://";
$this->applicationURL = $protocol . $_SERVER['SERVER_NAME'] . ":" . $_SERVER['SERVER_PORT'] . $_SERVER['PHP_SELF'];
if (isset($_SERVER['PATH_INFO']))
$this->applicationURL .= $_SERVER['PATH_INFO'];
if (isset($_SERVER['QUERY_STRING']))
$this->applicationURL .= "?" . $_SERVER['QUERY_STRING'];
}
}
public function authenticate(array $wantedAttributes = array(), $filters = "", $authorised = "") {
session_start();
if ($this->preExistingSession($wantedAttributes)) return;
// check if a session creation was already started
if (!empty($_COOKIE[TequilaClient::COOKIE_NAME])) {
$attributes = $this->fetchAttributes($_COOKIE[TequilaClient::COOKIE_NAME]);
if (!empty($attributes)) {
$this->createSession($attributes);
return;
}
}
$key = $this->createRequest($wantedAttributes, $filters, $authorised);
setcookie(TequilaClient::COOKIE_NAME, $key, array(
'expires' => TequilaClient::COOKIE_LIFE,
// 'httponly' => true,
// "secure" => true,
));
header('Location: ' . $this->serverAuthenticationURL($key));
}
public function logout() {}
private function createRequest(array $wantedAttributes = array(), string $filters = "", string $authorised = "") : string {
$body = array();
$body["urlaccess"] = $this->applicationURL;
$body["dontappendkey"] = "1";
$body["language"] = $this->language;
$body["service"] = $this->applicationName;
$body["request"] = implode(TequilaClient::BODY_GLUE, $wantedAttributes);
$body["require"] = $filters;
$body["allows"] = $authorised;
$res = $this->contactServer('createrequest', $body);
// return the key
return substr(trim($res), 4);
}
private function fetchAttributes(string $key) : array {
$body = array();
$body["key"] = $key;
if (!empty($this->allowedRequestHosts))
$body["allowedrequesthosts"] = implode("|", $this->allowedRequestHosts);
$res = $this->contactServer('fetchattributes', $body);
$result = array();
$attributes = explode("\n", $res);
foreach ($attributes as $attribute) {
$attribute = trim($attribute);
if (!$attribute) continue;
list($key, $val) = explode("=", $attribute, 2);
$result [$key] = $val;
}
return $result;
}
private function contactServer($endpoint, $fields = array()) : string {
// check if it's a valid endpoint
if (!in_array($endpoint, TequilaClient::SERVER_ENDPOINTS)) {
error_log('auth_tequila: Trying to access unknown endpoint: ' . $endpoint);
// throw exception?
}
try {
$client = new GuzzleHttp\Client(['base_uri' => $this->serverURL . "/"]);
$response = $client->post($endpoint, [
"form_params" => $fields,
]);
if ($response->getStatusCode() != "200") {
error_log('auth_tequila: Tequila returned unexpected HTTP code: ' . $code);
echo("here");
// throw exception?
}
return $response->getBody();
} catch (GuzzleHttp\Exception\RequestException | GuzzleHttp\Exception\ConnectException $e) {
if ($e->hasResponse()) {
echo("exception");
$response = $e->getResponse();
echo("<pre>");
print_r($response->getStatusCode()); // HTTP status code;
print_r($response->getReasonPhrase()); // Response message;
echo("</pre>");
}
}
}
private function serverAuthenticationURL(string $key) : string {
return "{$this->serverURL}/requestauth?requestkey=$key";
}
private function preExistingSession($wantedAttributes) : bool {
if (empty($_SESSION)) return false;
// check if the session hasn't expired
if ((time() - $_SESSION["creation"]) > $this->timeout) return false;
return true;
}
private function createSession(array $attributes) {
$_SESSION["creation"] = time();
foreach ($attributes as $key => $val)
$_SESSION[$key] = $val;
}
}
c4science · Help