API OpenFlyers: Difference between revisions

From Documentation de la solution web de gestion OpenFlyers
Jump to navigation Jump to search
imported>Gobin
m (Text replacement - "Fichier:" to "File:")
 
(152 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=Présentation=
=Présentation=
L'objet de cette page est de décrire :
L'objet de cette page est de décrire l'API OpenFlyers.
*l'[[#Ancien-module-d'identification-checkIdent.php|ancien module de vérification d'un couple identifiant/mot de passe basé sur le script checkIdent.php]]
*Le [[#OAuth2|nouveau module d'identification]] basé sur le protocole OAuth2.
L'ancien module checkIdent.php est prévu être désactivé au 31/12/2021.


=Ancien module d'identification checkIdent.php=
;Description de l'API
Ce chapitre explique comment vérifier qu'un couple identifiant/mot de passe envoyé, par vos propres scripts, est conforme à la base de données d'OpenFlyers.
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs, dûment [[#Enregistrer-un-client|enregistrés]], de mettre en œuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] ou des rapports personnalisés sous la forme de fichiers CSV.


Le script retourne une valeur indiquant si la connexion, avec des identifiants données, a réussi et son état. Un cookie OpenFlyers est aussi retourné, permettant de gérer une session utilisateur sur votre site, en utilisant le compte utilisateur OpenFlyers de l'utilisateur connecté.
OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
*[[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
*[[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.


;Comment ça marche
Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
Si votre plateforme OpenFlyers se situe sur le lien https://openflyers.com/nom-plateforme/, envoyez simplement une requête POST sur le lien https://openflyers.com/nom-plateforme/checkIdent.php avec comme paramètres les variables '''login''' et '''rawPassword'''.
*une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
*un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
*toute ressource nécessitant un accès restreint.


'''Attention:''' Le mot de passe nécessite d'être chiffré en MD5 (cf. la ligne $postData dans le script PHP).
OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
*les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
*les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.


;Valeurs de retour possibles
OAuth2 dispose de ''scopes''. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une [[#Liste des scopes disponibles|liste de scopes]] utilisables à travers l'API.
Le script retourne un chiffre parmi les suivant :
*0 : OK
*1 : OK mais plusieurs profils disponibles. OpenFlyers sélectionne automatiquement le meilleur profil.
*2 : Expiré mais autorisé
*3 : Expiré mais autorisé, avec un profil expiré
*4 : Abonnement expiré, refusé
*5 : Mauvais identifiants, refusé
*6 : IP ou identifiants bloqués, refusé
*7 : Aucun identifiant donné, ils sont demandés
*8 : Authentification réussie mais avec des contrats non signés, bloquant tant qu'il reste des contrats à signer. Pour signer les contrats se connecter sur la plateforme OpenFlyers avec le compte bloqué puis signer les contrats à la connexion.
*9 : L'abonnement à la plateforme est périmé, le couple identifiant/mot de passe n'est pas vérifié, accès refusé


Nous vous recommandons de considérer un code de retour entre 0 et 2 comme bon et mauvais entre 3 et 8.
Deux protocoles de sécurité sont présents dans l'API OpenFlyers :
*[[#Authentification-TLS-Mutuelle-(mTLS)|mTLS]] : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
*[[#HTTP-Signature|HTTP-Signature]] : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.


'''Attention:''' Vous devez filtrer les identifiants de connexion libres (sans droits) puisque pour OpenFlyers, ils correspondent à des accès autorisés !!!
;Premiers pas - Client de démonstration
Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.


;JavaScript
L'utilisation de ce client de démonstration est décrite dans la procédure [[#Utiliser-le-client|Utiliser le client]] de cette page.
Si vous utilisez votre propre formulaire d'authentification, utilisez la fonction javascript submit_pwd() située dans \javascript\submitPwd.js .


;Exemple de code PHP
Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php
Voici un exemple de code PHP permettant d'envoyer une requête POST :
<php>// PHP 5.6 is required
// OpenSSL 1.0.1 is required
function httpPostRequest($host, $path, $postData) {
    $result= "";
   
    $request = "POST $path HTTP/1.1\n".
    "Host: $host\n".
    (isset($referer) ? "Referer: $referer\n" : "").
    "Content-type: Application/x-www-form-urlencoded\n".
    "Content-length: ".strlen($postData)."\n".
    "Connection: close\n\n".
    $postData."\n";
   
    // Some debug informations:
    print("<pre>Request:\n".htmlentities($request)."</pre>");
   
    if ($fp = fsockopen($host, 443, $errno, $errstr, 3)) {
        // Set cryptology method
        // @link http://php.net/manual/en/function.stream-socket-enable-crypto.php
        if (!defined('STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT')) {
            die('STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT IS REQUIRED');
        }
        $cryptoMethod = STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
        // Activate encryption while authenticating
        stream_socket_enable_crypto($fp, true, $cryptoMethod);
        if (fputs($fp, $request)) {
            while(! feof($fp)) {
                $result.= fgets($fp, 128);
            }
            // Deactivate encryption once authenticating done
            stream_socket_enable_crypto($fp, false);
            fclose($fp);
            //print($result);
            return $result;
        }
    }
}


$postData  = 'login=jbond&rawPassword='.md5('007');
Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip
$rawContent = httpPostRequest('openflyers.com','https://openflyers.com/plateform-name/checkIdent.php',$postData);


list($header, $content) = explode("\r\n\r\n", $rawContent, 2);
L'utilisation du code source est décrite dans la procédure [[#Créer-un-client-à-partir-du-code-source|Créer un client à partir du code source]].
list($byteQty, $realContent, $dummy) = explode("\r\n", $content, 3);


// the answer is in $realContent</php>
=Définitions=
==Authentification TLS Mutuelle (mTLS)==
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).


=OAuth2=
OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs de mettre en oeuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] sous la forme de fichiers CSV.


OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
;Envoyer un certificat client
* [[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
* [[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.
<php>curl_setopt_array($request, [
    CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
    CURLOPT_CAINFO    => $caCertificatePath,
    CURLOPT_SSLCERT    => $certificatePath,
    CURLOPT_SSLKEY    => $keyPath
]);</php>


Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.
* une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
* un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
* toute ressource nécessitant un accès restreint.


OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
==HTTP Signature==
* les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.
* les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.


==Préparation==
La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.
===Enregistrer un client===
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :


;Pour le mécanisme d'authentification Client Credentials
HTTP Signature utilise deux en-têtes HTTP :
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil permet de gérer les droits du client OAuth2.
*Signature : contient la signature et ses métadonnées.
**''Choisir un nom explicite, par exemple "Client OAuth rapports".''
*Digest : contient le corps du message haché.


*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
===Digest===
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans '''Généralités admin''' (colonne '''Associé aux clients OAuth2''').
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>
**Sélectionner les rapports accessibles par le profil précédemment créé.


*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.


;Pour le mécanisme d'authentification Authorization Code
Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.
*Se rendre dans le menu '''Profil''' depuis le panneau d'administration.
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.


Une fois les opérations précédentes exécutées,
;Exemple en php
*Créer un nouveau client OAuth2 à partir du menu '''Imports''' dans le panneau d'administration.
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>
**Choisir un nom pour le client.
**Sélectionner le mécanisme d'autorisation utilisé par le client :
***Pour utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs, choisir ''Authorization Code''. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
***Pour utiliser OAuth2 dans un contexte d'automatisme, choisir ''Client Credentials''.
**Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
**Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
**[[#Génération-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
***Le premier est utilisé pour l'authentification mutuelle avec mTLS.
***Le second est utilisé pour la signature des en-têtes HTTP.
;Un couple ID/passphrase est généré. La passphrase n'est communiquée qu'une seule fois. Elle doit être sauvegardée en lieu sûr et rester confidentielle.


'''À noter''' : les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
===Signature===
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>


Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables. Pour ajouter le certificat CA au Trust Store du système,
Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.


* Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.
* Sous Windows,
** Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
** Cliquer sur '''Installer un certificat...'''
** Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''


===Générer des certificats===
La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.


Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).
Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :


La procédure est la suivante :
<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>
*Se connecter au serveur qui devra utiliser l'API.
*Naviguer dans le répertoire dans lequel les fichiers doivent être créés.
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.


;Fichier de configuration OpenSSL - sign_cert.conf
La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>
<pre>[req]
default_bits      = 4096                    # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key        = no                      # chiffrer la clé générée
distinguished_name = req_distinguished_name  # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                  # pointe vers la catégorie spécifiée pour les extensions x509
prompt            = no


[req_distinguished_name]
;Exemple en php
C                  =                          # code à deux chiffres du pays (ex: FR)
<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
ST                =                         # région/état (ex: Gironde)
{
L                  =                         # ville (ex: Bordeaux)
    // generating the signing string and header list
O                  =                         # organisation (ex: OpenFlyers)
    $headers        = '';
OU                =                         # unité organisationelle (ex: IT)
    $signatureString = '';
CN                =                         # nom de domaine (ex: openflyers.com)
    foreach ($headersToSign as $key => $value) {
        $normalizedHeaderKey = trim(strtolower($key));
        $headers            .= $normalizedHeaderKey . ' ';
        $signatureString    .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
    }


[v3_req]
    // trim extra whitespace
keyUsage          = digitalSignature        # pour quelles opérations la clé peut-elle être utilisée</pre>
    $headers        = trim($headers);
    $signatureString = trim($signatureString);


;Fichier de configuration OpenSSL - auth_cert.conf
    // signing the signing string
<pre>[req]
    $signature = '';
default_bits      = 4096                    # taille par défaut des nouvelles clés, peut être surchargé dans la commande
    openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
encrypt_key        = no                      # chiffrer la clé générée
    $signature = base64_encode($signature);
distinguished_name = req_distinguished_name  # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                  # pointe vers la catégorie spécifiée pour les extensions x509
prompt            = no


[req_distinguished_name]
    // compiling the header line
C                  =                         # code à deux chiffres du pays (ex: FR)
    return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
ST                =                         # région/état (ex: Gironde)
}</php>
L                  =                         # ville (ex: Bordeaux)
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.  
O                  =                         # organisation (ex: OpenFlyers)
OU                =                          # unité organisationelle (ex: IT)
CN                =                          # nom de domaine (ex: openflyers.com)


[v3_req]
La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
extendedKeyUsage  = clientAuth              # pour quelles opérations la clé peut-elle être utilisée</pre>
<php>[
    $headerName => $headerValue,
    ...
]</php>


'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.


Exécuter les commandes suivantes :
=Client OAuth2=
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>


Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.  
Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.


Une fois ces CSR obtenus :
Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[#Script-client-:-authorization-code|''authorization_code'']] et [[#Script-client-:-client-credentials|''client_credentials'']]
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrement-du-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.


==Authentification TLS Mutuelle (mTLS)==
==Authorization Code==
 
Ce flux OAuth2 se déroule en plusieurs étapes :
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
*Le navigateur de l'utilisateur est redirigé vers l'URL fourni durant la demande ou durant l'enregistrement du client.
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.


OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.


;Envoyer un certificat client
    +-----------+                  +------+                +-----------+                  +-------------+                  +-----------+
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
    |Utilisateur|                  |Client|                |Navigateur |                  |  Serveur  |                  |  Serveur  |
<php>curl_setopt_array($request, [
    +-----+-----+                  +--+---+                +-----+-----+                  |Autorisation |                  | Ressources|
    CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
          |                            |                          |                        +------+------+                  +-----+-----+
    CURLOPT_CAINFO    => $caCertificatePath,
          |                            |                          |                              |                              |
    CURLOPT_SSLCERT    => $certificatePath,
          |                            |                  Demande|d'autorisation                |                              |
    CURLOPT_SSLKEY    => $keyPath
          |                            +------------------------->+------------------------------>|                              |
]);</php>
          |                            |                          |                              |                              |
 
          |                            |Authentification + Formulaire d'autorisation              |                              |
'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.
          |<---------------------------+--------------------------+<------------------------------+                              |
          |                            |                          |                              |                              |
          |                            |      Autorisation        |                              |                              |
          +----------------------------+------------------------->+------------------------------>|                              |
          |                            |                          |                              |                              |
          |                            |                      Code|d'autorisation                |                              |
          |                            |<-------------------------+<------------------------------+                              |
          |                            |                          |                              |                              |
          |                            |                Demande de|token                          |                              |
          |                            +--------------------------+------------------------------>|                              |
          |                            |                          |                              |                              |
          |                            |                Access (+|Refresh) token                |                              |
          |                            |<-------------------------+-------------------------------+                              |
          |                            |                          |                              |                              |
          |                            |                          |      Requête vers API        |                              |
          |                            +--------------------------+-------------------------------+------------------------------>|
          |                            |                          |                              |                              |
          |                            |                          |                              |                              |
          |                            |                          |                              |<------------------------------+
          |                            |                          |                              |  Vérification d'autorisation  |
          |                            |                          |                              +------------------------------>|
          |                            |                          |                              |                              |
          |                            |                          |      Données/Réponse          |                              |
          |                            |<-------------------------+-------------------------------+-------------------------------+
          |                            |                          |                              |                              |


==HTTP Signature==


HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.


La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.
===Générer les codes pour PKCE===
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.


HTTP Signature utilise deux en-têtes HTTP :
;Générer le ''code_verifier''
*Signature : contient la signature et ses métadonnées.
<php>function generateCodeVerifier($length = 128): string
*Digest : contient le corps du message haché.
{
    $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
    $outputCode = '';


===Digest===
    for ($i = 0; $i < $length; $i++) {
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>
        $index      = random_int(0, strlen($characters) - 1);
        $outputCode .= $characters[$index];
    }


Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>
    return $outputCode;
}</php>


Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.
Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.


;Exemple en php
;Générer le ''code_challenge''
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>
<php>function computeCodeChallenge(string $codeVerifier): string
{
    return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}</php>


===Signature===
Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>


Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.


L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.
===Demande d'autorisation===
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.


La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>
Envoyer également les paramètres suivants :
 
{| class="wikitable"
Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :
!Nom!!Type!!Description
 
|-
<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
 
|-
La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
 
|-
;Exemple en php
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
|-
{
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
    // generating the signing string and header list
|-
    $headers        = '';
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
    $signatureString = '';
|-
    foreach ($headersToSign as $key => $value) {
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
        $normalizedHeaderKey = trim(strtolower($key));
|-
        $headers            .= $normalizedHeaderKey . ' ';
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
        $signatureString    .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
|}
    }
 
===Demande de jeton d'accès===
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.


    // trim extra whitespace
Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.
    $headers        = trim($headers);
    $signatureString = trim($signatureString);


    // signing the signing string
Les paramètres suivants sont également nécessaires :
    $signature = '';
{| class="wikitable"
    openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
!Nom!!Type!!Description
    $signature = base64_encode($signature);
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}


    // compiling the header line
Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
    return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
<javascript>{
}</php>
  "token_type": "Bearer",
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
  "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>


La variable ''$headersToSign'' est un tableau formaté de la manière suivante :  
===Script client : Authorization Code===
<php>[
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).
    $headerName => $headerValue,
    ...
]</php>


'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.
Fichier de configuration ''config.authcode.json'' :
<javascript>{
  "client_id": "",
  "client_secret": "",
  "authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
  "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
  "auth_cert": "/path/to/client/auth_cert.crt",
  "auth_key": "/path/to/client/auth.key",
  "sign_cert": "/path/to/client/sign_cert.crt",
  "sign_key": "/path/to/client/sign.key",
  "auth_cacert": "/path/to/ca.crt",
  "sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/AuthCodeDemo/</code>.


==Client OAuth2==
Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.


Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.
Script PHP :
<php><?php
$localTokenFile    = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
    file_put_contents($localTokenFile, '');


Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[Contrôle-d'identification-par-OpenFlyers-pour-un-logiciel-tiers#Script-client-:-authorization-code|''authorization_code'']] et [[Contrôle-d'identification-par-OpenFlyers-pour-un-logiciel-tiers#Script-client-:-client-credentials|''client_credentials'']]
$config                = json_decode(file_get_contents('config.authcode.json'), true);
$localToken            = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config']     = $config;


===Authorization Code===
// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
Ce flux OAuth2 se déroule en plusieurs étapes :
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
$port    = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
*Le navigateur de l'utilisateur est redirigé vers l'URL fourni durant la demande ou durant l'enregistrement du client.
    || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.


$baseURL            = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog          = 'error_log.log';
$responseLog        = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;


    +-----------+                  +------+                +-----------+                  +-------------+                  +-----------+
//Session cookies are used to store information necessary for the authorization code flow
    |Utilisateur|                  |Client|                |Navigateur |                  |  Serveur  |                  |  Serveur  |
session_start();
    +-----+-----+                  +--+---+                +-----+-----+                  |Autorisation |                  | Ressources|
 
          |                            |                          |                        +------+------+                  +-----+-----+
/**
          |                            |                          |                              |                              |
* This function is used to make api calls to the Authorization Server and the Resource Server
          |                            |                  Demande|d'autorisation                |                              |
*
          |                            +------------------------->+------------------------------>|                              |
* @param      $url
          |                            |                          |                              |                              |
* @param      $post
          |                            |Authentification + Formulaire d'autorisation              |                              |
* @param array $headers
          |<---------------------------+--------------------------+<------------------------------+                              |
*
          |                            |                          |                              |                              |
* @return mixed
          |                            |      Autorisation        |                              |                              |
*/
          +----------------------------+------------------------->+------------------------------>|                              |
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
          |                            |                          |                              |                              |
{
          |                            |                      Code|d'autorisation                |                              |
    $ch = curl_init($url);
          |                            |<-------------------------+<------------------------------+                              |
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          |                            |                          |                              |                              |
    curl_setopt($ch, CURLOPT_HEADER, true);
          |                            |                Demande de|token                         |                              |
          |                            +--------------------------+------------------------------>|                              |
          |                            |                          |                              |                              |
          |                            |                Access (+|Refresh) token                |                              |
          |                            |<-------------------------+-------------------------------+                              |
          |                            |                          |                              |                              |
          |                            |                          |      Requête vers API        |                              |
          |                            +--------------------------+-------------------------------+------------------------------>|
          |                            |                          |                              |                              |
          |                            |                          |                              |                              |
          |                            |                          |                              |<------------------------------+
          |                            |                          |                              |  Vérification d'autorisation  |
          |                            |                          |                              +------------------------------>|
          |                            |                          |                              |                              |
          |                            |                          |      Données/Réponse          |                              |
          |                            |<-------------------------+-------------------------------+-------------------------------+
          |                            |                          |                              |                              |


    $method = 'get';


    if ($post) {
        $method  = 'post';
        $postData = http_build_query($post);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);


====Générer les codes pour PKCE====
        $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
        $headersToSign['digest']      = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.
 
;Générer le ''code_verifier''
<php>function generateCodeVerifier($length = 128): string
{
    $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
    $outputCode = '';
 
    for ($i = 0; $i < $length; $i++) {
        $index      = random_int(0, strlen($characters) - 1);
        $outputCode .= $characters[$index];
     }
     }


     return $outputCode;
     $urlComponents = parse_url($url);
}</php>


Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.
    $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
    $headersToSign['Host']            = $urlComponents['host'];
    $headersToSign['Date']            = gmdate('D, j M Y H:i:s T');


;Générer le ''code_challenge''
    // generating the signature header
<php>function computeCodeChallenge(string $codeVerifier): string
    $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
{
     $privateKey          = file_get_contents($GLOBALS['config']['sign_key']);
     return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
    $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);
}</php>


Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.
    $headers['Accept']    = 'application/json';
    $headers['User-Agent'] = $GLOBALS['baseURL'];
    unset($headersToSign['(request-target)']);
    $headers              += $headersToSign;


    if ($token) {
        $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
    }


====Demande d'autorisation====
    // formatting the headers
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>.
    $httpFormattedHeaders = [];
    foreach ($headers as $key => $value) {
        $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
    }


Envoyer également les paramètres suivants :
    curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
{| class="wikitable"
    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
|-
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
|-
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
|-
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
|-
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
|}


====Demande de jeton d'accès====
    // for development environment only
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
    //curl_setopt($ch, CURLOPT_VERBOSE, true);


Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>
    // defining TLS client certificates for Mutual TLS
 
    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
Les paramètres suivants sont également nécessaires :
    curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
{| class="wikitable"
    curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
!Nom!!Type!!Description
    curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}


Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
    $response = curl_exec($ch);
<javascript>{
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
  "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>


====Script client : Authorization Code====
    // logging errors and responses
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).
    errorLog(true, $response, $ch);


Fichier de configuration ''config.authcode.json'' :
    curl_close($ch);
<javascript>{
  "client_id": "",
  "client_secret": "",
  "authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
  "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
  "auth_cert": "/path/to/client/auth_cert.crt",
  "auth_key": "/path/to/client/auth.key",
  "sign_cert": "/path/to/client/sign_cert.crt",
  "sign_key": "/path/to/client/sign.key",
  "auth_cacert": "/path/to/ca.crt",
  "sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>


Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.
    // in case an authentication request is executed
 
    if ($auth) {
Script PHP :
        // required when a refresh token request is issued
<php><?php
        // because there is only one header in the response
$localTokenFile    = 'token.json';
        // while there are two for regular auth requests
// create token file if it does not exist
        if (!$refresh) {
if (!file_exists($localTokenFile))
            list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
    file_put_contents($localTokenFile, '');
            if (!$responseBody) {
                list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
            }
        } else {
            list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
        }


$config                = json_decode(file_get_contents('config.authcode.json'), true);
        $responseHeadersDigest = '';
$localToken            = json_decode(file_get_contents($localTokenFile), true);
        $responseHeadersSignature = '';
$GLOBALS['config']      = $config;
        // extracting digest and signature from headers
        $responseHeadersArray = explode("\r\n", $secondResponseHeaders);
        $responseProtocol = array_shift($responseHeadersArray);


// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
        foreach ($responseHeadersArray as $value) {
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
            list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$port    = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
            $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
    || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];
        }


$baseURL            = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
        $responseDigestAlgo = '';
$errorLog          = 'error_log.log';
        $responseDigestKey = '';
$responseLog        = 'response_log.log';
        foreach ($responseHeaders as $key => $value) {
$GLOBALS['baseURL'] = $baseURL;
            if ($key === "digest") {
                $responseHeadersDigest = $value;
                // stripping SHA algorithm for later comparison
                list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
            } else if ($key === "signature")
                $responseHeadersSignature = $value;
        }


//Session cookies are used to store information necessary for the authorization code flow
        // calculating response digest
session_start();
        $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));


/**
        // checking digest validity
* This function is used to make api calls to the RS
        if ($responseDigest !== $responseDigestKey) {
*
            errorLog(false, false, "Digests are not the same");
* @param      $url
            die();
* @param      $post
        }
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
{
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HEADER, true);


    $method = 'get';
        // extracting variables from signature header
        $signatureArray = explode(",", $responseHeadersSignature);
        foreach ($signatureArray as $value) {
            list($signatureKey, $signatureValue) = explode("=", $value, 2);
            $signature[$signatureKey] = trim($signatureValue, '"');
        }


    if ($post) {
        // generating siging string
         $method  = 'post';
        $signingStringArray = explode(" ", $signature['headers']);
         $postData = http_build_query($post);
         $signingString = '';
        curl_setopt($ch, CURLOPT_POST, true);
         foreach ($signingStringArray as $value) {
        curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
            $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
        }


         $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
         // trimming last '\n' character
         $headersToSign['digest']      = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
         $signingString = trim($signingString);
    }


    $urlComponents = parse_url($url);
        // decoding signature
        $decodedSignature = base64_decode($signature['signature']);


    $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
        // verifying signature
    $headersToSign['Host']             = $urlComponents['host'];
        $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');
    $headersToSign['Date']            = gmdate('D, j M Y H:i:s T');


    // generating the signature header
        if (!$signatureVerify) {
    $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
            errorLog(false, false, "Signature is not correct");
    $privateKey          = file_get_contents($GLOBALS['config']['sign_key']);
            while (($err = openssl_error_string()))
    $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);
                errorLog(false, false, $err);
            die();
        }


    $headers['Accept']    = 'application/json';
        return json_decode($responseBody, true);
    $headers['User-Agent'] = $GLOBALS['baseURL'];
    unset($headersToSign['(request-target)']);
    $headers              += $headersToSign;
 
    if ($token) {
        $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
     }
     }


     // formatting the headers
     return $response;
    $httpFormattedHeaders = [];
}
    foreach ($headers as $key => $value) {
        $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
    }


    curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
/**
    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
* This function logs curl responses and errors in text files
 
*
     // for development environment only
* @param mixed $response the response
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
* @param mixed $request  the request handle, used to get errors
     //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
*/
     //curl_setopt($ch, CURLOPT_VERBOSE, true);
function errorLog($curl, $response, $request = false)
{
     $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
     global $errorLog;
     global $responseLog;


     // defining TLS client certificates for Mutual TLS
     if ($response === false) {
    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
        if ($curl)
    curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
            file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
    curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
        else
     curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);
            file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
     } else {
        file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
    }
}


     $response = curl_exec($ch);
/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array  $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate  the certificate linked to the used private key
* @param string $privateKey    the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
    // generating the signing string and header list
    $headers        = '';
    $signatureString = '';
    foreach ($headersToSign as $key => $value) {
        $normalizedHeaderKey = trim(strtolower($key));
        $headers            .= $normalizedHeaderKey . ' ';
        $signatureString    .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
    }
    $headers        = trim($headers);
     $signatureString = trim($signatureString);


     // logging errors and responses
     // signing the signing string
     errorLog(true, $response, $ch);
     $signature = '';
    openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
    $signature = base64_encode($signature);


     curl_close($ch);
     // compiling the header line
    return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}


    // in case an authentication request is executed
/**
    if ($auth) {
* This function takes a code_verifier and outputs the corresponding code_challenge
        // required when a refresh token request is issued
*
        // because there is only one header in the response
* @param string $codeVerifier the generated code_verifier
        // while there are two for regular auth requests
*
        if (!$refresh) {
* @return string the computed code_challenge
            list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
*/
            if (!$responseBody) {
function computeCodeChallenge(string $codeVerifier): string
                list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
{
            }
    return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
        } else {
}
            list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
        }


        $responseHeadersDigest = '';
/**
        $responseHeadersSignature = '';
* This function takes an optional string length and outputs a random code_verifier string
        // extracting digest and signature from headers
*
        $responseHeadersArray = explode("\r\n", $secondResponseHeaders);
* @param int $length the length of the output code_verifier. Default = 128
        $responseProtocol = array_shift($responseHeadersArray);
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
    $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
    $outputCode = '';


        foreach ($responseHeadersArray as $value) {
    for ($i = 0; $i < $length; $i++) {
            list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
        $index      = random_int(0, strlen($characters) - 1);
            $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
        $outputCode .= $characters[$index];
        }
    }


        $responseDigestAlgo = '';
    return $outputCode;
        $responseDigestKey = '';
}
        foreach ($responseHeaders as $key => $value) {
            if ($key === "digest") {
                $responseHeadersDigest = $value;
                // stripping SHA algorithm for later comparison
                list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
            } else if ($key === "signature")
                $responseHeadersSignature = $value;
        }


        // calculating response digest
/**
        $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));
* This function calculates the entropy of a given string
 
*
        // checking digest validity
* @param string $string  the string for which to calculate the entropy
        if ($responseDigest !== $responseDigestKey) {
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
            errorLog(false, false, "Digests are not the same");
*
            die();
* @return float|int
        }
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
    $chars = str_split($charset);
    $probs = [];


        // extracting variables from signature header
    foreach ($chars as $char) {
        $signatureArray = explode(",", $responseHeadersSignature);
        $probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
        foreach ($signatureArray as $value) {
    }
            list($signatureKey, $signatureValue) = explode("=", $value, 2);
            $signature[$signatureKey] = trim($signatureValue, '"');
        }


        // generating siging string
    $sum = 0.0;
        $signingStringArray = explode(" ", $signature['headers']);
    foreach ($probs as $prob) {
        $signingString = '';
        $sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
        foreach ($signingStringArray as $value) {
    }
            $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
        }


        // trimming last '\n' character
     return -$sum;
        $signingString = trim($signingString);
 
        // decoding signature
        $decodedSignature = base64_decode($signature['signature']);
 
        // verifying signature
        $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');
 
        if (!$signatureVerify) {
            errorLog(false, false, "Signature is not correct");
            while (($err = openssl_error_string()))
                errorLog(false, false, $err);
            die();
        }
 
        return json_decode($responseBody, true);
    }
 
     return $response;
}
}


/**
/**
  * This function logs curl responses and errors in text files
  * This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
  *
  *
  * @param mixed $response the response
  * @return float|int
* @param mixed $request  the request handle, used to get errors
  */
  */
function errorLog($curl, $response, $request = false)
function idealEntropy(int $length = 128)
{
{
     $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
     $prob = 1.0 / $length;
    global $errorLog;
    global $responseLog;


     if ($response === false) {
     return -1.0 * $length * $prob * log($prob, 2);
        if ($curl)
            file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
        else
            file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
    } else {
        file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
    }
}
}


/**
/**
  * This function generates the full signature header line from a set of headers, a certificate and the linked private key
  * This function is used to initiate the authentication code flow.
  *
  *
  * @param array  $headersToSign the headers to sign, in the $key => $value format
  * @param string $clientID    the client's ID
  * @param string $certificate  the certificate linked to the used private key
  * @param string $redirectURL  the URL where to redirect after auth
  * @param string $privateKey    the private key used to sign the headers
  * @param string $authorizeURL the target URL to request authorization
  *
  *
  * @return string the full signature header line
  * @throws Exception
  */
  */
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
{
     // generating the signing string and header list
     global $localTokenFile;
    $headers        = '';
     file_put_contents($localTokenFile, '');
     $signatureString = '';
    foreach ($headersToSign as $key => $value) {
        $normalizedHeaderKey = trim(strtolower($key));
        $headers            .= $normalizedHeaderKey . ' ';
        $signatureString    .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
    }
    $headers        = trim($headers);
    $signatureString = trim($signatureString);


     // signing the signing string
     // This unguessable string is used to prevent csrf attacks
     $signature = '';
     $_SESSION['state'] = bin2hex(random_bytes(16));
    openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
    $signature = base64_encode($signature);


     // compiling the header line
     // Generate code_verifier and code_challenge for PKCE   
     return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
    $_SESSION['code_verifier']  = generateCodeVerifier();
    $_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);
 
    // required parameters for the redirection, redirect_uri is where the browser should be redirected
    // when the user grants (or denies) access, scope are the authorizations (rights) requested
     $params = [
        'response_type'        => 'code',
        'client_id'            => $clientID,
        'redirect_uri'          => $redirectURL,
        'scope'                => 'default.login',
        'state'                => $_SESSION['state'],
        'code_challenge'        => $_SESSION['code_challenge'],
        'code_challenge_method' => 'S256'
    ];
 
    // redirecting the browser to the AS authorization endpoint to obtain the authorization code
    header('Location: ' . $authorizeURL . '?' . http_build_query($params));
}
}


/**
/**
  * This function takes a code_verifier and outputs the corresponding code_challenge
  * This function deletes the access token from the session
  *
  *
  * @param string $codeVerifier the generated code_verifier
  * @param string $baseURL
*
* @return string the computed code_challenge
  */
  */
function computeCodeChallenge(string $codeVerifier): string
function logout(string $baseURL): void
{
{
     return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
     global $localTokenFile;
    file_put_contents($localTokenFile, '');
 
    header('Location: ' . $baseURL);
}
}


/**
function displayMenuLoggedIn(): void
* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
{
     $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
     echo '<h2><a href="/">Home</a></h2>';
     $outputCode = '';
     echo '<h3>Logged In</h3>';


     for ($i = 0; $i < $length; $i++) {
     echo '<form id="view_repos" method="post">';
        $index      = random_int(0, strlen($characters) - 1);
    echo '<input type="hidden" id="action" name="action" value="view">';
        $outputCode .= $characters[$index];
    echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
     }
     echo '</form>';


     return $outputCode;
     echo '<form id="logout" method="post">';
    echo '<input type="hidden" id="action" name="action" value="logout">';
    echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
    echo '</form>';
}
}


/**
function displayMenuLoggedOut(): void
* This function calculates the entropy of a given string
*
* @param string $string  the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
{
     $chars = str_split($charset);
     echo '<h2><a href="/">Home</a></h2>';
     $probs = [];
    echo '<h3>Not logged in</h3>';
    echo '<form id="login" method="post">';
    echo '<input type="hidden" id="action" name="action" value="login">';
    echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
     echo '</form>';
}


    foreach ($chars as $char) {
// display client "home" page
        $probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
if (!isset($_POST['action'])) {
    if (!empty($localToken['access_token'])) {
        displayMenuLoggedIn();
    } else {
        displayMenuLoggedOut();
     }
     }
    $sum = 0.0;
    foreach ($probs as $prob) {
        $sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
    }
    return -$sum;
}
}


/**
if (isset($_POST['action'])) {
* This function calculates the ideal (maximum) entropy for a string of a given length
    // Building query array for resource dumping
*
    $repoQueryParameters = [
* @param int $length length of the string. Default = 128
        'resource_type' => 'user_information',
*
        'client_id' => $config['client_id']
* @return float|int
    ];
*/
    switch ($_POST['action']) {
function idealEntropy(int $length = 128)
        case 'login':
{
            login($config['client_id'], $baseURL, $config['authorize_uri']);
    $prob = 1.0 / $length;
            break;
        case 'logout':
            logout($baseURL);
            break;
        case 'view':
            // call to the resource server to retreive user information
            $resources = apiRequest(
                $config['resource_uri'],
                $repoQueryParameters,
                $localToken,
                false
            );
 
            // Separating headers from body
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);


    return -1.0 * $length * $prob * log($prob, 2);
            $resourceHeaders = explode("\r\n", $resourceHeader);
}
            $firstHeaderLine = array_shift($resourceHeaders);


/**
            // Displaying user information
* This function is used to initiate the authentication code flow.
            echo '<pre>';
*
            echo $resourceBody;
* @param string $clientID    the client's ID
            echo '</pre>';
* @param string $redirectURL  the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
    global $localTokenFile;
    file_put_contents($localTokenFile, '');


    // This unguessable string is used to prevent csrf attacks
            // Automatic refreshing token once access token is expired
    $_SESSION['state'] = bin2hex(random_bytes(16));
            if (strpos($firstHeaderLine, "401")) {
 
                $errorBody = json_decode($resourceBody, true);
    // Generate code_verifier and code_challenge for PKCE   
                if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
    $_SESSION['code_verifier']  = generateCodeVerifier();
                    if ($errorBody['hint'] == 'Access token could not be verified') {
    $_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);
                        $token = apiRequest(
 
                            $config['token_uri'],
    // required parameters for the redirection, redirect_uri is where the browser should be redirected
                            [
    // when the user grants (or denies) access, scope are the authorizations (rights) requested
                                'grant_type'   => 'refresh_token',
    $params = [
                                'refresh_token' => $localToken['refresh_token'],
        'response_type'         => 'code',
                                'client_id'     => $config['client_id'],
        'client_id'            => $clientID,
                                'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
        'redirect_uri'         => $redirectURL,
                            ],
        'scope'                 => 'default.login',
                            false,
        'state'                 => $_SESSION['state'],
                            true,
        'code_challenge'       => $_SESSION['code_challenge'],
                            true
        'code_challenge_method' => 'S256'
                        );
    ];


    // redirecting the browser to the AS authorization endpoint to obtain the authorization code
                        // We store the access token in the session so the user is "connected"
    header('Location: ' . $authorizeURL . '?' . http_build_query($params));
                        // Only if the request has been successfully executed
}
                        if (isset($token['access_token'])) {
                            file_put_contents($localTokenFile, json_encode($token, true));


/**
                            // Redirecting the user's browser to the "home" page
* This function deletes the access token from the session
                            header('Location: ' . $baseURL);
*
                        }
* @param string $baseURL
                    }
*/
                }
function logout(string $baseURL): void
            }
{
            break;
    global $localTokenFile;
    }
    file_put_contents($localTokenFile, '');
 
    header('Location: ' . $baseURL);
}
}


function displayMenuLoggedIn(): void
// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
{
// the browser will get back here with a "code" parameter in the query string
     echo '<h2><a href="/">Home</a></h2>';
if (isset($_GET['code'])) {
    echo '<h3>Logged In</h3>';
     // The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
    // to detect if the oauth flow has been tampered with
    if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
        header('Location: ' . $baseURL . '?error=invalid_state');
        die();
    }


     echo '<form id="view_repos" method="post">';
     // We communicate directly with the AS to exchange the code received against an access token.
     echo '<input type="hidden" id="action" name="action" value="view">';
    // The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
    echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
    $token = apiRequest(
    echo '</form>';
        $config['token_uri'],
        [
            'grant_type'    => 'authorization_code',
            'client_id'     => $config['client_id'],
            'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
            'redirect_uri'  => $baseURL,
            'code'          => $_GET['code'],
            'code_verifier' => $_SESSION['code_verifier']
        ]
    );


     echo '<form id="logout" method="post">';
     // We store the access token in the session so the user is "connected"
     echo '<input type="hidden" id="action" name="action" value="logout">';
     // Only if the request has been successfully executed
     echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
     if (isset($token['access_token'])) {
    echo '</form>';
        file_put_contents($localTokenFile, json_encode($token, true));
}


function displayMenuLoggedOut(): void
        // Redirecting the user's browser to the "home" page
{
        header('Location: ' . $baseURL);
    echo '<h2><a href="/">Home</a></h2>';
    echo '<h3>Not logged in</h3>';
    echo '<form id="login" method="post">';
    echo '<input type="hidden" id="action" name="action" value="login">';
    echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
    echo '</form>';
}
 
// display client "home" page
if (!isset($_POST['action'])) {
    if (!empty($localToken['access_token'])) {
        displayMenuLoggedIn();
     } else {
     } else {
         displayMenuLoggedOut();
         echo $token;
     }
     }
}
    die();
}</php>


if (isset($_POST['action'])) {
;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.
    // Building query array
    $repoQueryParameters = [
        'resource_type' => 'user_information',
        'client_id' => $config['client_id']
    ];
    switch ($_POST['action']) {
        case 'login':
            login($config['client_id'], $baseURL, $config['authorize_uri']);
            break;
        case 'logout':
            logout($baseURL);
            break;
        case 'view':
            // call to the resource server
            $resources = apiRequest(
                $config['resource_uri'],
                $repoQueryParameters,
                $localToken,
                false
            );


            // Separating headers from body
==Client Credentials==
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.


            $resourceHeaders = explode("\r\n", $resourceHeader);
            $firstHeaderLine = array_shift($resourceHeaders);


            // Displaying requested content
    +------+                      +-------------+                  +-----------+
            echo '<pre>';
    |Client|                      |  Serveur  |                  |  Serveur  |
            echo $resourceBody;
    +--+---+                      |Autorisation |                  | Ressources|
            echo '</pre>';
      |                          +------+------+                  +-----+-----+
 
      |        Authentification          |                              |
            // Automatic refreshing token once access token is expired
      |        + Demande token         |                              |
            if (strpos($firstHeaderLine, "401")) {
      +--------------------------------->|                              |
                $errorBody = json_decode($resourceBody, true);
      |                                  |                              |
                if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
      |          Access token           |                              |
                    if ($errorBody['hint'] == 'Access token could not be verified') {
      |<---------------------------------+                              |
                        $token = apiRequest(
      |                                  |                              |
                            $config['token_uri'],
      |                      Requête vers|API                            |
                            [
      +----------------------------------+------------------------------>|
                                'grant_type'    => 'refresh_token',
      |                                  |                              |
                                'refresh_token' => $localToken['refresh_token'],
      |                                  |                              |
                                'client_id'    => $config['client_id'],
      |                                  |<------------------------------+
                                'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
      |                                  |  Vérification d'autorisation  |
                            ],
      |                                  +------------------------------>|
                            false,
      |                                  |                              |
                            true,
      |                        Données /|Réponse                        |
                            true
      |<---------------------------------+-------------------------------+
                        );
      |                                  |                              |
 


                        // We store the access token in the session so the user is "connected"
                        // Only if the request has been successfully executed
                        if (isset($token['access_token'])) {
                            file_put_contents($localTokenFile, json_encode($token, true));


                            // Redirecting the user's browser to the "home" page
===Demande de jeton d'accès===
                            header('Location: ' . $baseURL);
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.
                        }
                    }
                }
            }
            break;
    }
}


// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
Les paramètres suivants sont nécessaires :
// the browser will get back here with a "code" parameter in the query string
{| class="wikitable"
if (isset($_GET['code'])) {
!Nom!!Type!!Description
    // The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
|-
    // to detect if the oauth flow has been tampered with
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
    if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
|-
        header('Location: ' . $baseURL . '?error=invalid_state');
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
        die();
|-
    }
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
|}


    // We communicate directly with the AS to exchange the code received against an access token.
;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.
    // The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
    $token = apiRequest(
        $config['token_uri'],
        [
            'grant_type'   => 'authorization_code',
            'client_id'    => $config['client_id'],
            'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
            'redirect_uri'  => $baseURL,
            'code'          => $_GET['code'],
            'code_verifier' => $_SESSION['code_verifier']
        ]
    );


    // We store the access token in the session so the user is "connected"
Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
    // Only if the request has been successfully executed
<javascript>{
    if (isset($token['access_token'])) {
  "token_type": "Bearer",
        file_put_contents($localTokenFile, json_encode($token, true));
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>


        // Redirecting the user's browser to the "home" page
===Script client : Client Credentials===
        header('Location: ' . $baseURL);
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).
    } else {
        echo $token;
    }
    die();
}</php>


;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.
Fichier de configuration ''config.clientcred.json'' :
 
<javascript>{
===Client Credentials===
  "client_id": "",
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
  "client_secret": "",
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
  "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
  "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.
  "revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
  "auth_cert": "/path/to/client/auth_cert.crt",
  "auth_key": "/path/to/client/auth.key",
  "sign_cert": "/path/to/client/sign_cert.crt",
  "sign_key": "/path/to/client/sign.key",
  "auth_cacert": "/path/to/ca.crt",
  "sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/ClientCredDemo/</code>.


Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.
Script php :
<php><?php
$localTokenFile    = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
    file_put_contents($localTokenFile, '');


    +------+                      +-------------+                  +-----------+
$config                = json_decode(file_get_contents('config.clientcred.json'), true);
    |Client|                      |  Serveur  |                  |  Serveur  |
$localToken            = json_decode(file_get_contents($localTokenFile), true);
    +--+---+                      |Autorisation |                  | Ressources|
$GLOBALS['config']      = $config;
      |                          +------+------+                  +-----+-----+
      |        Authentification          |                              |
      |        + Demande token          |                              |
      +--------------------------------->|                              |
      |                                  |                              |
      |          Access token            |                              |
      |<---------------------------------+                              |
      |                                  |                              |
      |                      Requête vers|API                            |
      +----------------------------------+------------------------------>|
      |                                  |                              |
      |                                  |                              |
      |                                  |<------------------------------+
      |                                  |  Vérification d'autorisation  |
      |                                  +------------------------------>|
      |                                  |                              |
      |                        Données /|Réponse                        |
      |<---------------------------------+-------------------------------+
      |                                  |                              |


// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port    = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
    || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];


$baseURL            = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog          = 'error_log.log';
$responseLog        = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;


====Demande de jeton d'accès====
$replacementListItems = [
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>
    1 => "year",
 
    2 => "validityTypeId",
Les paramètres suivants sont nécessaires :
    3 => "icao",
{| class="wikitable"
    4 => "profileId",
!Nom!!Type!!Description
    7 => "accountingId",
|-
    8 => "paymentType",
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
    9 => "startDate",
|-
    10 => "endDate",
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
    11 => "occupiedSeat",
|-
    12 => "date",
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
    13 => "activityTypeId",
|-
    14 => "age",
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
    15 => "resourceId",
|}
    16 => "personId",
 
    17 => "accountId",
;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.
    20 => "rightPlacePersonId",
    21 => "month",
    22 => "numberMonth",
    23 => "oneValidityTypeId",
];


Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
//Session cookies are used to store information necessary for the authorization code flow
<javascript>{
session_start();
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>


====Script client : Client Credentials====
/**
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).
* This function is used to make api calls to the RS
 
*
Fichier de configuration ''config.clientcred.json'' :
* @param      $url
<javascript>{
* @param      $post
  "client_id": "",
* @param array $headers
  "client_secret": "",
*
  "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
* @return mixed
  "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resource.php",
*/
  "auth_cert": "/path/to/client/auth_cert.crt",
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
  "auth_key": "/path/to/client/auth.key",
{
  "sign_cert": "/path/to/client/sign_cert.crt",
    $ch = curl_init($url);
  "sign_key": "/path/to/client/sign.key",
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  "auth_cacert": "/path/to/ca.crt",
    curl_setopt($ch, CURLOPT_HEADER, true);
  "sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>


Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.
    $method = 'get';


Script php :
    if ($post) {
<php><?php
        $method  = 'post';
$localTokenFile    = 'token.json';
        $postData = http_build_query($post);
// create token file if it does not exist
        curl_setopt($ch, CURLOPT_POST, true);
if (!file_exists($localTokenFile))
        curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
    file_put_contents($localTokenFile, '');


$config                = json_decode(file_get_contents('config.clientcred.json'), true);
        $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$localToken            = json_decode(file_get_contents($localTokenFile), true);
        $headersToSign['digest']      = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
$GLOBALS['config']      = $config;
    }


// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
     $urlComponents = parse_url($url);
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port     = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
    || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];


$baseURL            = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
    $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$errorLog          = 'error_log.log';
    $headersToSign['Host']            = $urlComponents['host'];
$responseLog        = 'response_log.log';
    $headersToSign['Date']             = gmdate('D, j M Y H:i:s T');
$GLOBALS['baseURL'] = $baseURL;


$replacementListItems = [
     // generating the signature header
     1 => "year",
     $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
     2 => "validityTypeId",
     $privateKey          = file_get_contents($GLOBALS['config']['sign_key']);
     3 => "icao",
     $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);
     4 => "profileId",
    7 => "accountingId",
    8 => "paymentType",
    9 => "startDate",
    10 => "endDate",
    11 => "occupiedSeat",
    12 => "date",
    13 => "activityTypeId",
    14 => "age",
    15 => "resourceId",
    16 => "personId",
    17 => "accountId",
    20 => "rightPlacePersonId",
    21 => "month",
    22 => "numberMonth",
    23 => "oneValidityTypeId",
];


//Session cookies are used to store information necessary for the authorization code flow
    $headers['Accept']    = 'application/json';
session_start();
    $headers['User-Agent'] = $GLOBALS['baseURL'];
    unset($headersToSign['(request-target)']);
    $headers              += $headersToSign;


/**
    if ($token) {
* This function is used to make api calls to the RS
        $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
*
     }
* @param      $url
* @param      $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
{
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
     curl_setopt($ch, CURLOPT_HEADER, true);


     $method = 'get';
    // formatting the headers
     $httpFormattedHeaders = [];
    foreach ($headers as $key => $value) {
        $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
    }


     if ($post) {
     curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
        $method  = 'post';
    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
        $postData = http_build_query($post);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);


        $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
    // for development environment only
        $headersToSign['digest']      = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    }
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
    //curl_setopt($ch, CURLOPT_VERBOSE, true);


     $urlComponents = parse_url($url);
     // defining TLS client certificates for Mutual TLS
    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
    curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
    curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
    curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);


     $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
     $response = curl_exec($ch);
    $headersToSign['Host']            = $urlComponents['host'];
    $headersToSign['Date']            = gmdate('D, j M Y H:i:s T');


     // generating the signature header
     // logging errors and responses
     $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
     errorLog(true, $response, $ch);
    $privateKey          = file_get_contents($GLOBALS['config']['sign_key']);
    $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);


     $headers['Accept']    = 'application/json';
     curl_close($ch);
    $headers['User-Agent'] = $GLOBALS['baseURL'];
    unset($headersToSign['(request-target)']);
    $headers              += $headersToSign;


     if ($token) {
    // in case an authentication request is executed
         $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
     if ($auth) {
    }
         list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);


    // formatting the headers
        $responseHeadersDigest = '';
    $httpFormattedHeaders = [];
        $responseHeadersSignature = '';
    foreach ($headers as $key => $value) {
        // extracting digest and signature from headers
         $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
        $responseHeadersArray = explode("\r\n", $responseHeader);
    }
         $responseProtocol = array_shift($responseHeadersArray);


    curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
        foreach ($responseHeadersArray as $value) {
    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
            list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
            $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
        }


    // for development environment only
        $responseDigestAlgo = '';
    //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        $responseDigestKey = '';
    //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        foreach ($responseHeaders as $key => $value) {
    //curl_setopt($ch, CURLOPT_VERBOSE, true);
            if ($key === "digest") {
                $responseHeadersDigest = $value;
                // stripping SHA algorithm for later comparison
                list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
            } else if ($key === "signature")
                $responseHeadersSignature = $value;
        }


    // defining TLS client certificates for Mutual TLS
        // calculating response digest
    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
        $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));
    curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
    curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
    curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);


    $response = curl_exec($ch);
        // checking digest validity
 
        if ($responseDigest !== $responseDigestKey) {
    // logging errors and responses
            errorLog(false, false, "Digests are not the same");
    errorLog(true, $response, $ch);
            die();
        }


    curl_close($ch);
        // extracting variables from signature header
        $signatureArray = explode(",", $responseHeadersSignature);
        foreach ($signatureArray as $value) {
            list($signatureKey, $signatureValue) = explode("=", $value, 2);
            $signature[$signatureKey] = trim($signatureValue, '"');
        }


    // in case an authentication request is executed
        // generating siging string
    if ($auth) {
        $signingStringArray = explode(" ", $signature['headers']);
         list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);
        $signingString = '';
         foreach ($signingStringArray as $value) {
            $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
        }


         $responseHeadersDigest = '';
         // trimming last '\n' character
         $responseHeadersSignature = '';
         $signingString = trim($signingString);
         // extracting digest and signature from headers
 
        $responseHeadersArray = explode("\r\n", $responseHeader);
         // decoding signature
         $responseProtocol = array_shift($responseHeadersArray);
         $decodedSignature = base64_decode($signature['signature']);


         foreach ($responseHeadersArray as $value) {
         // verifying signature
            list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
        $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');
            $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
        }


         $responseDigestAlgo = '';
         if (!$signatureVerify) {
        $responseDigestKey = '';
             errorLog(false, false, "Signature is not correct");
        foreach ($responseHeaders as $key => $value) {
            while (($err = openssl_error_string()))
             if ($key === "digest") {
                 errorLog(false, false, $err);
                $responseHeadersDigest = $value;
             die();
                 // stripping SHA algorithm for later comparison
                list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
             } else if ($key === "signature")
                $responseHeadersSignature = $value;
         }
         }


         // calculating response digest
         return json_decode($responseBody, true);
        $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));
    }


        // checking digest validity
    return $response;
        if ($responseDigest !== $responseDigestKey) {
}
            errorLog(false, false, "Digests are not the same");
            die();
        }


        // extracting variables from signature header
/**
        $signatureArray = explode(",", $responseHeadersSignature);
* This function logs curl responses and errors in text files
        foreach ($signatureArray as $value) {
*
            list($signatureKey, $signatureValue) = explode("=", $value, 2);
* @param mixed $response the response
            $signature[$signatureKey] = trim($signatureValue, '"');
* @param mixed $request  the request handle, used to get errors
        }
*/
 
function errorLog($curl, $response, $request = false)
        // generating siging string
{
        $signingStringArray = explode(" ", $signature['headers']);
    $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
        $signingString = '';
    global $errorLog;
        foreach ($signingStringArray as $value) {
    global $responseLog;
            $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
        }


         // trimming last '\n' character
    if ($response === false) {
         $signingString = trim($signingString);
         if ($curl)
            file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
         else
            file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
    } else {
        file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
    }
}


        // decoding signature
/**
        $decodedSignature = base64_decode($signature['signature']);
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
 
*
        // verifying signature
* @param array  $headersToSign the headers to sign, in the $key => $value format
        $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');
* @param string $certificate  the certificate linked to the used private key
 
  * @param string $privateKey    the private key used to sign the headers
        if (!$signatureVerify) {
            errorLog(false, false, "Signature is not correct");
            while (($err = openssl_error_string()))
                errorLog(false, false, $err);
            die();
        }
 
        return json_decode($responseBody, true);
    }
 
    return $response;
}
 
/**
  * This function logs curl responses and errors in text files
  *
  *
  * @param mixed $response the response
  * @return string the full signature header line
* @param mixed $request  the request handle, used to get errors
  */
  */
function errorLog($curl, $response, $request = false)
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
{
    $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
     // generating the signing string and header list
    global $errorLog;
    global $responseLog;
 
    if ($response === false) {
        if ($curl)
            file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
        else
            file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
    } else {
        file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
    }
}
 
/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array  $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate  the certificate linked to the used private key
* @param string $privateKey    the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
     // generating the signing string and header list
     $headers        = '';
     $headers        = '';
     $signatureString = '';
     $signatureString = '';
Line 1,358: Line 1,198:
                 $localToken,
                 $localToken,
                 false
                 false
             );
             );
 
            // Separating headers from body
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
 
            $resourceHeaders = explode("\r\n", $resourceHeader);
            $firstHeaderLine = array_shift($resourceHeaders);
 
            // Building form for download CSV button
            echo '<form method="post">';
            foreach ($_POST as $key => $value) {
                if ($key == "action") {
                    $value = "download";
                }
                echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
            }
            if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
                echo '<button>Download as CSV</button>';
            }
            echo '</form>';
 
            // Displaying requested content
            echo '<pre>';
            echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
            echo '</pre>';
            break;
        case 'download':
            // call to the resource server
            $resources = apiRequest(
                $config['resource_uri'],
                $repoQueryParameters,
                $localToken,
                false
            );
 
            // Separating headers from body
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
            $resourceHeaders = explode("\r\n", $resourceHeader);
            array_shift($resourceHeaders);
 
            // Dumping headers to insert them in current page
            foreach ($resourceHeaders as $key => $value) {
                header($value);
            }
            echo json_decode($resourceBody);
            break;
    }
}</php>
 
;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.
 
==Refresh Token==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.
 
Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources
 
    +------+                      +-------------+                  +-----------+
    |Client|                      |  Serveur  |                  |  Serveur  |
    +--+---+                      |Autorisation |                  | Ressources|
      |                          +------+------+                  +-----+-----+
      |        Authentification          |                              |
      |        + Refresh Token          |                              |
      +--------------------------------->|                              |
      |                                  |                              |
      |    Access (+ Refresh) token      |                              |
      |<---------------------------------+                              |
      |                                  |                              |
      |                      Requête vers|API                            |
      +----------------------------------+------------------------------>|
      |                                  |                              |
      |                                  |                              |
      |                                  |<------------------------------+
      |                                  |  Vérification d'autorisation  |
      |                                  +------------------------------>|
      |                                  |                              |
      |                        Données /|Réponse                        |
      |<---------------------------------+-------------------------------+
      |                                  |                              |
 
===Demande de renouvellement d'un jeton===
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.
 
Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}
 
Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
<javascript>{
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
  "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>
 
==Liste des scopes disponibles==
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|}
==Prolonger la durée de vie de la session du client de démonstration==
La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).
 
Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
$oauth2DemoSessionLifeTime = time() + (86400 * 30);
session_set_cookie_params($oauth2DemoSessionLifeTime);</php>
 
NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.
 
==Révocation de token==
Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.
 
Envoyer également le paramètre suivant:
{| class="wikitable"
!Nom!!Type!!Description
|-
|access_token||string||Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)
|}
<php> apiRequest(
                $config['revoke_uri'],
                ['access_token' => $_SESSION['auth_token']['access_token']],
                null,
                false
            );</php>
 
La demande de révocation se fait quand l'utilisateur clique sur le bouton '''Se déconnecter''' pour l'un des deux Clients '''Authorization Code''' et '''Client Credentials'''.
 
Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.
 
==Utiliser l'API==
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu  : <code>Authorization: <token_type> <access_token></code>.
 
===Récupérer les informations de l'utilisateur connecté===
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :
 
{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}
 
Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=
 
{
    "resource_type":"user_information",
    "client_id":"d2615fe2020ec476"
}</javascript>
 
La réponse est retournée dans un conteneur JSON.
 
===Récupérer les rapports génériques===
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :
 
{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}
 
Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=
 
{
    "resource_type":"generic_report",
    "client_id":"d2615fe2020ec476",
    "report_id":135,
    "replacementList":{
        "year":2018
    }
}</javascript>
 
La réponse est un fichier CSV retourné dans un conteneur JSON.
 
===Récupérer les rapports personnalisés===
Ce type de ressource est nommé '''report'''. Cette ressource n'est accessible qu'avec le scope '''reports.readonly'''. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :
 
{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}
 
Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=
 
{
    "resource_type":"report",
    "client_id":"d2615fe2020ec476",
    "report_id":1,
    "replacementList":{
        "year":2020
    }
}</javascript>
 
La réponse est un fichier CSV retourné dans un conteneur JSON.
 
=Procédures=
==Créer un client à partir du code source==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php
 
;Télécharger Le code source du client de démonstration :
 
Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip
 
Le code source est structuré de la manière suivante :
 
[[File:Oauth2 src demo folder.png|800px]]
 
* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
* Le dossier '''img''' contient les images affichées sur la page web.
* Le dossier '''ssl''' est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
* Le fichier '''ClientDemo.php''' contient la classe '''ClientDemo'''. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
* Le fichier '''index.php''' est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe '''ClientDemo''' et exécute les méthodes dans l'ordre.
 
Le dossier '''ssl''' doit respecter la structure suivante :
 
[[File:Oauth2 demo tree.png]]
 
;[[#Générer des certificats|Générer les certificats]] :
Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.
 
;[[#Enregistrer un client|Enregistrer les clients]] :
 
*Deux clients doivent être créés :
**Le premier pour le mécanisme d'autorisation '''Authorization Code''',
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.
 
[[File:Oauth2 demo manage.png|800px]]
 
*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.
 
*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
  "client_id": "XXXXXXXXXXXXXXXX",
  "client_secret": "XXXXXXXXXXXXXXXX",
  "authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
  "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
  "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
  "auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
  "auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
  "sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
  "sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
  "auth_cacert": "path_to_client/ssl/ca.crt",
  "sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>
 
*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.
 
 
*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
  "client_id": "XXXXXXXXXXXXXXXX",
  "client_secret": "XXXXXXXXXXXXXXXX",
  "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
  "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
  "auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
  "auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
  "sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
  "sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
  "auth_cacert": "path_to_client/ssl/ca.crt",
  "sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>
 
*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.
 
 
*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.
 
 
'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.
 
==Enregistrer un client==
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :
 
 
;Pour le mécanisme d'authentification Client Credentials
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".
 
*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet '''Admin''' (colonne '''Associé aux clients OAuth2''').
**Sélectionner les rapports accessibles par le profil précédemment créé.
 
*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.
 
 
;Pour le mécanisme d'authentification Authorization Code
*Aller dans '''Admin > Utilisateurs > Profils'''
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.
 
 
;Créer un nouveau client OAuth2
*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
[[File:Oauth2 manage.png|800px]]
*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
[[File:Oauth2 client creation.png|800px]]
*Choisir un nom pour le client.
*Sélectionner le mécanisme d'autorisation utilisé par le client :
**'''Authorization Code''': permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
**'''Client Credentials''': permet d'utiliser OAuth2 dans un contexte d'automatisme.
*Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
*Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
*[[#Générer-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
**'''Certificate Signing Request pour le certificat d'authentification''' est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).
 
[[File:PublicKeysCopyScreen.png|900px]]
 
 
*Cliquer sur '''Enregistrer'''.
 
NB: La validité des certificats générés s'étend sur une période de '''3 années'''.
 
 
;Sauvegarder le couple ID/passphrase
Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
[[File:Oauth2 client created.png]]
 
[[File:ConfigCredJsonScreen.png|600px]]
 
 
;Télécharger les certificats crt
Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
[[File:Oauth2 client certificates.png]]
 
;Téléchargez les certificats du serveur.
*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
[[File:DownloadServerCertifScreen.png|900px]]
*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
**Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
**Sous Windows,
***Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
***Cliquer sur '''Installer un certificat...'''
***Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''
 
==Générer des certificats==
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.
 
Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).
 
La procédure est la suivante :
*[[OpenSSL#Installer-OpenSSL-dans-un-environnement-Windows|Télécharger OpenSSL pour Windows]] ou [[OpenSSL#Utiliser-Openssl-d'Apache-sous-WAMP|utiliser Openssl d'Apache sous WAMP]].
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.
 
;Fichier de configuration OpenSSL - sign_cert.conf
<pre>[req]
default_bits      = 4096                    # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key        = no                      # chiffrer la clé générée
distinguished_name = req_distinguished_name  # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                  # pointe vers la catégorie spécifiée pour les extensions x509
prompt            = no
 
[req_distinguished_name]
C                  =                          # code à deux chiffres du pays (ex: FR)
ST                =                          # région/état (ex: Gironde)
L                  =                          # ville (ex: Bordeaux)
O                  =                          # organisation (ex: OpenFlyers)
OU                =                          # unité organisationelle (ex: IT)
CN                =                          # nom de domaine (ex: openflyers.com)
 
[v3_req]
keyUsage          = digitalSignature        # pour quelles opérations la clé peut-elle être utilisée</pre>
 
;Fichier de configuration OpenSSL - auth_cert.conf
<pre>[req]
default_bits      = 4096                    # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key        = no                      # chiffrer la clé générée
distinguished_name = req_distinguished_name  # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                  # pointe vers la catégorie spécifiée pour les extensions x509
prompt            = no
 
[req_distinguished_name]
C                  =                          # code à deux chiffres du pays (ex: FR)
ST                =                          # région/état (ex: Gironde)
L                  =                          # ville (ex: Bordeaux)
O                  =                          # organisation (ex: OpenFlyers)
OU                =                          # unité organisationelle (ex: IT)
CN                =                          # nom de domaine (ex: openflyers.com)
 
[v3_req]
extendedKeyUsage  = clientAuth              # pour quelles opérations la clé peut-elle être utilisée</pre>
 
 
Exécuter les commandes suivantes :
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>
 
Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.
 
Une fois ces CSR obtenus :
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrer-un-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.
 
==Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé==
;Note
La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous '''Windows'''.
 
;Prérequis
*Posséder les accès FTP :
**Hôte : XXXXXXXXXXXXXXXXXX
**Login : XXXXXXXX
**Mot de passe :  XXXXXXXX
**Port : XX (par exemple 21)
*Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip
 
;Procédure
*[[#Générer des certificats|Générer les certificats]] en local.
*Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
*[[#Enregistrer un client|Enregistrer les deux clients]] :
**Le premier pour le mécanisme d'autorisation '''Authorization Code'''.
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.
 
[[File:Oauth2 demo manage.png|800px]]
 
*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
*Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion.
*Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.
 
*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
  "client_id": "XXXXXXXXXXXXXXXX",
  "client_secret": "XXXXXXXXXXXXXXXX",
  "authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
  "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
  "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
  "auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
  "auth_key": "./ssl/AuthCodeDemo/auth.key",
  "sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
  "sign_key": "./ssl/AuthCodeDemo/sign.key",
  "auth_cacert": "./ssl/ca.crt",
  "sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>
 
 
*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
  "client_id": "XXXXXXXXXXXXXXXX",
  "client_secret": "XXXXXXXXXXXXXXXX",
  "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
  "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
  "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
  "auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
  "auth_key": "./ssl/ClientCredDemo/auth.key",
  "sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
  "sign_key": "./ssl/ClientCredDemo/sign.key",
  "auth_cacert": "./ssl/ca.crt",
  "sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>


            // Separating headers from body
*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.


            $resourceHeaders = explode("\r\n", $resourceHeader);
*Transférer le fichier "oauth-demo" vers le serveur mutualisé :
            $firstHeaderLine = array_shift($resourceHeaders);
**Télécharger [http://filezilla-project.org/download.php?type=client FileZilla].
 
**Lancer FileZilla.
            // Building form for download CSV button
**Entrer l'URl du serveur mutualisé dans le champ '''Hôte'''.
            echo '<form method="post">';
**Entrer le login dans le champ '''Nom d'utilisateur'''.
            foreach ($_POST as $key => $value) {
**Entrer le mot de passe dans le champ '''Mot de passe'''.
                if ($key == "action") {
**Entrer le port dans le champ '''Port'''.
                    $value = "download";
**Cliquer sur le bouton Connexion.
                }
**Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
                echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
            }
**Glisser et déposer le oauth-demo à l'emplacement choisi.
            if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
[[File:Transfer OauthDemo To Shared Server.png|800px]]
                echo '<button>Download as CSV</button>';
*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
            }
*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.
            echo '</form>';


            // Displaying requested content
*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.
            echo '<pre>';
            echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
            echo '</pre>';
            break;
        case 'download':
            // call to the resource server
            $resources = apiRequest(
                $config['resource_uri'],
                $repoQueryParameters,
                $localToken,
                false
            );


            // Separating headers from body
            list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
            $resourceHeaders = explode("\r\n", $resourceHeader);
            array_shift($resourceHeaders);


            // Dumping headers to insert them in current page
'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.
            foreach ($resourceHeaders as $key => $value) {
                header($value);
            }
            echo json_decode($resourceBody);
            break;
    }
}</php>


;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.
==Récupérer les données d'un utilisateur==
*Cliquer sur le bouton '''Récupérer les informations utilisateur''', l'identifiant de l'utilisateur s'affiche.
*Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en [[Gestion-des-rapports#Ajouter-un-rapport|créant de nouveaux rapports personnalisés]]


===Refresh Token===
==Utiliser le client==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php


Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
Le client de démonstration se présente de la manière suivante.
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources


    +------+                      +-------------+                  +-----------+
[[File:Oauth2-client-demo.png]]
    |Client|                      |  Serveur  |                  |  Serveur  |
    +--+---+                      |Autorisation |                  | Ressources|
      |                          +------+------+                  +-----+-----+
      |        Authentification          |                              |
      |        + Refresh Token          |                              |
      +--------------------------------->|                              |
      |                                  |                              |
      |    Access (+ Refresh) token      |                              |
      |<---------------------------------+                              |
      |                                  |                              |
      |                      Requête vers|API                            |
      +----------------------------------+------------------------------>|
      |                                  |                              |
      |                                  |                              |
      |                                  |<------------------------------+
      |                                  |  Vérification d'autorisation  |
      |                                  +------------------------------>|
      |                                  |                              |
      |                        Données /|Réponse                        |
      |<---------------------------------+-------------------------------+
      |                                  |                              |


====Demande de renouvellement d'un jeton====
La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>


Les paramètres suivants sont nécessaires :
;Le mécanisme '''Authorization Code'''
{| class="wikitable"
*Cliquer sur le bouton '''Se connecter''' (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
!Nom!!Type!!Description
*Renseigner les identifiants de l'administrateur pour s'y connecter.
|-
*Nom d'utilisateur : '''admini'''.
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
*Mot de passe : '''azerty'''.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}


Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
Une fois les informations saisies, la page suivante est affichée.
<javascript>{
  "token_type": "Bearer",
  "expires_in": 3600,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
  "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>


===Liste des scopes disponibles===
[[File:Oauth authorize demo.png]]
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule (pas encore implémenté). Ce scope est recommandé pour '''Client Credentials'''.
|}


===Utiliser l'API===
*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu  : <code>Authorization: <token_type> <access_token></code>.


====Récupérer les informations de l'utilisateur connecté====
La première colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un nouveau bouton '''Récupèrer les informations utilisateurs''' qui permet de récupérer les informations de l'utilisateur connecté.
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. La requête POST est construite de la manière suivante :


{| class="wikitable"
;Le mécanisme '''Client Credentials'''
!Nom!!Type!!Description
*Cliquer sur le bouton de connexion '''Se connecter''': contrairement à celui du mécanisme '''Authorization Code''', ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}


Un exemple de requête complète au format JSON :
Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un menu déroulant '''Rapport à récupèrer''' et un nouveau bouton '''Récupèrer le rapport''' qui permet de récupérer les rapports génériques et personnalisés.
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=


{
    "resource_type":"user_information",
    "client_id":"d2615fe2020ec476"
}</javascript>


====Récupérer les rapports génériques====
Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :


{| class="wikitable"
[[File:Oauth2 connected demo.png]]
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}


Un exemple de requête complète au format JSON :
=Troubleshooting=
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
==500 Internal Server Error en récupérant le rapport==
Content-Type: application/x-www-form-urlencoded
La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=


{
==Erreur "File not found."==
    "resource_type":"generic_report",
Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.
    "client_id":"d2615fe2020ec476",
    "report_id":135,
    "replacementList":{
        "year":2018
    }
}</javascript>


====Récupérer les rapports personnalisés====
==int_rsa_verify : longueur de signature incorrecte==
;Cette ressource n'est pas encore implémentée à l'heure actuelle.
Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2.
La solution est :


=Plugin d'authentification Joomla=
*D'essayer depuis le début l'étape de [[#Générer-des-certificats|génération]] et de [[#Enregistrer-un-client|configuration des certificats]] avec jsut la modification du client existant.
Si vous avez un site Joomla et que vous désirer de permettre aux utilisateurs OpenFlyers de se connecter à votre espace restreint Joomla, vous devriez ajouter ce plugin de manière à avoir une unique base de données de comptes utilisateurs : celle d'OpenFlyers.


Vous n'avez pas besoin de mettre à jour votre base de données Joomla, ce plugin interroge directement OpenFlyers grâce au script PHP CheckIdent.php.
;Si cela ne fonctionne pas:


*[[Media:Joomla_authentication_plugin.zip|Joomla plugin for OpenFlyers]]
*Essayez de créer [[#Enregistrer-un-client|un nouveau client]] et refaites la configuration des certificats.

Latest revision as of 17:27, 2 October 2024

Présentation

L'objet de cette page est de décrire l'API OpenFlyers.

Description de l'API

OpenFlyers possède une API basée sur OAuth2 qui permet à des serveurs extérieurs, dûment enregistrés, de mettre en œuvre un processus d'authentification unique (SSO) et/ou de récupération des résultats des requêtes SQL de la bibliothèque des rapports ou des rapports personnalisés sous la forme de fichiers CSV.

OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :

  • Authorization Code basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'authentification unique (SSO),
  • Client Credentials basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.

Dans les chapitres qui suivent, le terme ressource fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :

  • une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
  • un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
  • toute ressource nécessitant un accès restreint.

OpenFlyers définit plusieurs types de ressources :

OAuth2 dispose de scopes. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une liste de scopes utilisables à travers l'API.

Deux protocoles de sécurité sont présents dans l'API OpenFlyers :

  • mTLS : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
  • HTTP-Signature : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.
Premiers pas - Client de démonstration

Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.

L'utilisation de ce client de démonstration est décrite dans la procédure Utiliser le client de cette page.

Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

L'utilisation du code source est décrite dans la procédure Créer un client à partir du code source.

Définitions

Authentification TLS Mutuelle (mTLS)

En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou mTLS).

OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.

Envoyer un certificat client

Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion : <php>curl_setopt_array($request, [ 

   CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
   CURLOPT_CAINFO     => $caCertificatePath,
   CURLOPT_SSLCERT    => $certificatePath,
   CURLOPT_SSLKEY     => $keyPath

]);</php>

À noter : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.

HTTP Signature

HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.

La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.

HTTP Signature utilise deux en-têtes HTTP :

  • Signature : contient la signature et ses métadonnées.
  • Digest : contient le corps du message haché.

Digest

Le digest est calculé comme ceci : digest = base64encode(sha256(corps du message))

Et l'en-tête est structuré de la manière suivante : Digest: SHA-256=<digest>

Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.

Exemple en php

<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>

Signature

L'en-tête HTTP de signature est structuré de la manière suivante : Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"

Le champ keyId correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.

L'algorithme algo correspond à celui utilisé pour générer la signature, exemple : rsa-sha256.

La valeur de signed_headers correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : date digest (request-target)

Pour générer la signature, une chaîne de caractères appelée signing string contenant les en-têtes au format lowercase_header_name: value séparés par une nouvelle ligne au format LF (\n) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" : 

(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT

La signature est ensuite générée comme ceci : base64encode(algo(signing string))

Exemple en php

<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string { 

   // generating the signing string and header list
   $headers         = ;
   $signatureString = ;
   foreach ($headersToSign as $key => $value) {
       $normalizedHeaderKey = trim(strtolower($key));
       $headers             .= $normalizedHeaderKey . ' ';
       $signatureString     .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
   }

   // trim extra whitespace
   $headers         = trim($headers);
   $signatureString = trim($signatureString);

   // signing the signing string
   $signature = ;
   openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
   $signature = base64_encode($signature);

   // compiling the header line
   return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";

}</php> Les variables $certificateFingerprint et $privateKey correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

La variable $headersToSign est un tableau formaté de la manière suivante : <php>[ 

   $headerName => $headerValue,
   ...

]</php>

À noter : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

Client OAuth2

Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.

Plusieurs bibliothèques simplifiant la création d'un client sont disponibles.

Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes authorization_code et client_credentials

Authorization Code

Ce flux OAuth2 se déroule en plusieurs étapes :

  • Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
  • Le navigateur de l'utilisateur est redirigé vers l'URL fourni durant la demande ou durant l'enregistrement du client.
  • Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
  • Le client peut utiliser ce code d'accès :
    • Comme preuve d'authentification pour une solution SSO (Single Sign-On).
    • Pour accéder à des données sur le serveur distant en utilisant l'API.


   +-----------+                   +------+                +-----------+                  +-------------+                  +-----------+
   |Utilisateur|                   |Client|                |Navigateur |                  |   Serveur   |                  |  Serveur  |
   +-----+-----+                   +--+---+                +-----+-----+                  |Autorisation |                  | Ressources|
         |                            |                          |                        +------+------+                  +-----+-----+
         |                            |                          |                               |                               |
         |                            |                   Demande|d'autorisation                 |                               |
         |                            +------------------------->+------------------------------>|                               |
         |                            |                          |                               |                               |
         |                            |Authentification + Formulaire d'autorisation              |                               |
         |<---------------------------+--------------------------+<------------------------------+                               |
         |                            |                          |                               |                               |
         |                            |      Autorisation        |                               |                               |
         +----------------------------+------------------------->+------------------------------>|                               |
         |                            |                          |                               |                               |
         |                            |                      Code|d'autorisation                 |                               |
         |                            |<-------------------------+<------------------------------+                               |
         |                            |                          |                               |                               |
         |                            |                Demande de|token                          |                               |
         |                            +--------------------------+------------------------------>|                               |
         |                            |                          |                               |                               |
         |                            |                 Access (+|Refresh) token                 |                               |
         |                            |<-------------------------+-------------------------------+                               |
         |                            |                          |                               |                               |
         |                            |                          |       Requête vers API        |                               |
         |                            +--------------------------+-------------------------------+------------------------------>|
         |                            |                          |                               |                               |
         |                            |                          |                               |                               |
         |                            |                          |                               |<------------------------------+
         |                            |                          |                               |  Vérification d'autorisation  |
         |                            |                          |                               +------------------------------>|
         |                            |                          |                               |                               |
         |                            |                          |      Données/Réponse          |                               |
         |                            |<-------------------------+-------------------------------+-------------------------------+
         |                            |                          |                               |                               |


Générer les codes pour PKCE

Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :

  • Un code_verifier échangé pendant la demande de jeton d'accès.
  • Un code_challenge dérivé du code_verifier et échangé pendant la demande d'autorisation.
Générer le code_verifier

<php>function generateCodeVerifier($length = 128): string { 

   $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
   $outputCode = ;

   for ($i = 0; $i < $length; $i++) {
       $index      = random_int(0, strlen($characters) - 1);
       $outputCode .= $characters[$index];
   }

   return $outputCode;

}</php>

Cette fonction permet de générer un code_verifier avec une longueur donnée. Le code_verifier doit avoir une longueur entre 43 et 128 caractères.

Générer le code_challenge

<php>function computeCodeChallenge(string $codeVerifier): string { 

   return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');

}</php>

Cette fonction génère le code_challenge à partir du code_verifier fourni.


Demande d'autorisation

Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée.

Envoyer également les paramètres suivants :

Nom Type Description
client_id string L'identifiant unique reçu pendant l'enregistrement du client.
response_type string Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
redirect_uri string L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
scope string Liste des droits demandés par le client, séparés par des espaces.
state string Chaîne de caractère aléatoire utilisée pour éviter les attaques CSRF. Fortement recommandé.
code_challenge string Code nécessaire pour le fonctionnement de l'extension PKCE.
code_challenge_method string Méthode utilisée pour générer le code_challenge. Ici, la valeur est "S256".

Demande de jeton d'accès

Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : code est fourni, ainsi que le paramètre state fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.

Si le paramètre state a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.

Echanger ce code contre un jeton d'accès via l'URL : POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée.

Les paramètres suivants sont également nécessaires :

Nom Type Description
client_id string L'identifiant unique reçu pendant l'enregistrement du client.
client_secret string La passphrase reçue pendant l'enregistrement du client.
code string Le code temporaire reçu dans la réponse à la demande d'autorisation.
grant_type string Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être authorization_code
redirect_uri string L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
code_verifier string Le code_verifier utilisé pour générer le code_challenge de la demande d'autorisation.

Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON. <javascript>{ 

 "token_type": "Bearer",
 "expires_in": 3600,
 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
 "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"

}</javascript>

Script client : Authorization Code

Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).

Fichier de configuration config.authcode.json : <javascript>{ 

 "client_id": "",
 "client_secret": "",
 "authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
 "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
 "auth_cert": "/path/to/client/auth_cert.crt",
 "auth_key": "/path/to/client/auth.key",
 "sign_cert": "/path/to/client/sign_cert.crt",
 "sign_key": "/path/to/client/sign.key",
 "auth_cacert": "/path/to/ca.crt",
 "sign_cert_server": "/path/to/server/sign_cert_server.crt"

}</javascript> Où /path/to/client/ est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.

  • Exemple sur windows: C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/.
  • Exemple sur un serveur Linux debian: ./ssl/AuthCodeDemo/.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script PHP : <php><?php $localTokenFile = 'token.json'; // create token file if it does not exist if (!file_exists($localTokenFile)) 

   file_put_contents($localTokenFile, );

$config = json_decode(file_get_contents('config.authcode.json'), true); $localToken = json_decode(file_get_contents($localTokenFile), true); $GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; $port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443) 

   || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ?  : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF']; $errorLog = 'error_log.log'; $responseLog = 'response_log.log'; $GLOBALS['baseURL'] = $baseURL;

//Session cookies are used to store information necessary for the authorization code flow session_start();

/** 

* This function is used to make api calls to the Authorization Server and the Resource Server
*
* @param       $url
* @param       $post
* @param array $headers
*
* @return mixed
*/

function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array()) { 

   $ch = curl_init($url);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   curl_setopt($ch, CURLOPT_HEADER, true);

   $method = 'get';

   if ($post) {
       $method   = 'post';
       $postData = http_build_query($post);
       curl_setopt($ch, CURLOPT_POST, true);
       curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

       $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
       $headersToSign['digest']       = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
   }

   $urlComponents = parse_url($url);

   $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
   $headersToSign['Host']             = $urlComponents['host'];
   $headersToSign['Date']             = gmdate('D, j M Y H:i:s T');

   // generating the signature header
   $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
   $privateKey           = file_get_contents($GLOBALS['config']['sign_key']);
   $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

   $headers['Accept']     = 'application/json';
   $headers['User-Agent'] = $GLOBALS['baseURL'];
   unset($headersToSign['(request-target)']);
   $headers               += $headersToSign;

   if ($token) {
       $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
   }

   // formatting the headers
   $httpFormattedHeaders = [];
   foreach ($headers as $key => $value) {
       $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
   }

   curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
   curl_setopt($ch, CURLINFO_HEADER_OUT, true);

   // for development environment only
   //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
   //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
   //curl_setopt($ch, CURLOPT_VERBOSE, true);

   // defining TLS client certificates for Mutual TLS
   curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
   curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
   curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
   curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

   $response = curl_exec($ch);

   // logging errors and responses
   errorLog(true, $response, $ch);

   curl_close($ch);

   // in case an authentication request is executed
   if ($auth) {
       // required when a refresh token request is issued
       // because there is only one header in the response
       // while there are two for regular auth requests
       if (!$refresh) {
           list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
           if (!$responseBody) {
               list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
           }
       } else {
           list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
       }

       $responseHeadersDigest = ;
       $responseHeadersSignature = ;
       // extracting digest and signature from headers
       $responseHeadersArray = explode("\r\n", $secondResponseHeaders);
       $responseProtocol = array_shift($responseHeadersArray);

       foreach ($responseHeadersArray as $value) {
           list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
           $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
       }

       $responseDigestAlgo = ;
       $responseDigestKey = ;
       foreach ($responseHeaders as $key => $value) {
           if ($key === "digest") {
               $responseHeadersDigest = $value;
               // stripping SHA algorithm for later comparison
               list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
           } else if ($key === "signature")
               $responseHeadersSignature = $value;
       }

       // calculating response digest
       $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

       // checking digest validity
       if ($responseDigest !== $responseDigestKey) {
           errorLog(false, false, "Digests are not the same");
           die();
       }

       // extracting variables from signature header
       $signatureArray = explode(",", $responseHeadersSignature);
       foreach ($signatureArray as $value) {
           list($signatureKey, $signatureValue) = explode("=", $value, 2);
           $signature[$signatureKey] = trim($signatureValue, '"');
       }

       // generating siging string
       $signingStringArray = explode(" ", $signature['headers']);
       $signingString = ;
       foreach ($signingStringArray as $value) {
           $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
       }

       // trimming last '\n' character
       $signingString = trim($signingString);

       // decoding signature
       $decodedSignature = base64_decode($signature['signature']);

       // verifying signature
       $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

       if (!$signatureVerify) {
           errorLog(false, false, "Signature is not correct");
           while (($err = openssl_error_string()))
               errorLog(false, false, $err);
           die();
       }

       return json_decode($responseBody, true);
   }

   return $response;

}

/** 

* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request  the request handle, used to get errors
*/

function errorLog($curl, $response, $request = false) { 

   $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
   global $errorLog;
   global $responseLog;

   if ($response === false) {
       if ($curl)
           file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
       else
           file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
   } else {
       file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
   }

}

/** 

* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array  $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate   the certificate linked to the used private key
* @param string $privateKey    the private key used to sign the headers
*
* @return string the full signature header line
*/

function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string { 

   // generating the signing string and header list
   $headers         = ;
   $signatureString = ;
   foreach ($headersToSign as $key => $value) {
       $normalizedHeaderKey = trim(strtolower($key));
       $headers             .= $normalizedHeaderKey . ' ';
       $signatureString     .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
   }
   $headers         = trim($headers);
   $signatureString = trim($signatureString);

   // signing the signing string
   $signature = ;
   openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
   $signature = base64_encode($signature);

   // compiling the header line
   return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";

}

/** 

* This function takes a code_verifier and outputs the corresponding code_challenge
*
* @param string $codeVerifier the generated code_verifier
*
* @return string the computed code_challenge
*/

function computeCodeChallenge(string $codeVerifier): string { 

   return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');

}

/** 

* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/

function generateCodeVerifier($length = 128): string { 

   $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
   $outputCode = ;

   for ($i = 0; $i < $length; $i++) {
       $index      = random_int(0, strlen($characters) - 1);
       $outputCode .= $characters[$index];
   }

   return $outputCode;

}

/** 

* This function calculates the entropy of a given string
*
* @param string $string  the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/

function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~') { 

   $chars = str_split($charset);
   $probs = [];

   foreach ($chars as $char) {
       $probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
   }

   $sum = 0.0;
   foreach ($probs as $prob) {
       $sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
   }

   return -$sum;

}

/** 

* This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
*
* @return float|int
*/

function idealEntropy(int $length = 128) { 

   $prob = 1.0 / $length;

   return -1.0 * $length * $prob * log($prob, 2);

}

/** 

* This function is used to initiate the authentication code flow.
*
* @param string $clientID     the client's ID
* @param string $redirectURL  the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/

function login(string $clientID, string $redirectURL, string $authorizeURL): void { 

   global $localTokenFile;
   file_put_contents($localTokenFile, );

   // This unguessable string is used to prevent csrf attacks
   $_SESSION['state'] = bin2hex(random_bytes(16));

   // Generate code_verifier and code_challenge for PKCE    
   $_SESSION['code_verifier']  = generateCodeVerifier();
   $_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);

   // required parameters for the redirection, redirect_uri is where the browser should be redirected
   // when the user grants (or denies) access, scope are the authorizations (rights) requested
   $params = [
       'response_type'         => 'code',
       'client_id'             => $clientID,
       'redirect_uri'          => $redirectURL,
       'scope'                 => 'default.login',
       'state'                 => $_SESSION['state'],
       'code_challenge'        => $_SESSION['code_challenge'],
       'code_challenge_method' => 'S256'
   ];

   // redirecting the browser to the AS authorization endpoint to obtain the authorization code
   header('Location: ' . $authorizeURL . '?' . http_build_query($params));

}

/** 

* This function deletes the access token from the session
*
* @param string $baseURL
*/

function logout(string $baseURL): void { 

   global $localTokenFile;
   file_put_contents($localTokenFile, );

   header('Location: ' . $baseURL);

}

function displayMenuLoggedIn(): void {

echo '

<a href="/">Home</a>

'; echo '

Logged In

'; 

   echo '<form id="view_repos" method="post">';
   echo '<input type="hidden" id="action" name="action" value="view">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a>

'; 

   echo '</form>';

   echo '<form id="logout" method="post">';
   echo '<input type="hidden" id="action" name="action" value="logout">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a>

'; 

   echo '</form>';

}

function displayMenuLoggedOut(): void {

echo '

<a href="/">Home</a>

'; echo '

Not logged in

'; 

   echo '<form id="login" method="post">';
   echo '<input type="hidden" id="action" name="action" value="login">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a>

'; 

   echo '</form>';

}

// display client "home" page if (!isset($_POST['action'])) { 

   if (!empty($localToken['access_token'])) {
       displayMenuLoggedIn();
   } else {
       displayMenuLoggedOut();
   }

}

if (isset($_POST['action'])) { 

   // Building query array for resource dumping
   $repoQueryParameters = [
       'resource_type' => 'user_information',
       'client_id' => $config['client_id']
   ];
   switch ($_POST['action']) {
       case 'login':
           login($config['client_id'], $baseURL, $config['authorize_uri']);
           break;
       case 'logout':
           logout($baseURL);
           break;
       case 'view':
           // call to the resource server to retreive user information
           $resources = apiRequest(
               $config['resource_uri'],
               $repoQueryParameters,
               $localToken,
               false
           );

           // Separating headers from body
           list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

           $resourceHeaders = explode("\r\n", $resourceHeader);
           $firstHeaderLine = array_shift($resourceHeaders);

           // Displaying user information

echo '

';
            echo $resourceBody;
            echo '

'; 

           // Automatic refreshing token once access token is expired
           if (strpos($firstHeaderLine, "401")) {
               $errorBody = json_decode($resourceBody, true);
               if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
                   if ($errorBody['hint'] == 'Access token could not be verified') {
                       $token = apiRequest(
                           $config['token_uri'],
                           [
                               'grant_type'    => 'refresh_token',
                               'refresh_token' => $localToken['refresh_token'],
                               'client_id'     => $config['client_id'],
                               'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
                           ],
                           false,
                           true,
                           true
                       );

                       // We store the access token in the session so the user is "connected"
                       // Only if the request has been successfully executed
                       if (isset($token['access_token'])) {
                           file_put_contents($localTokenFile, json_encode($token, true));

                           // Redirecting the user's browser to the "home" page
                           header('Location: ' . $baseURL);
                       }
                   }
               }
           }
           break;
   }

}

// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted, // the browser will get back here with a "code" parameter in the query string if (isset($_GET['code'])) { 

   // The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
   // to detect if the oauth flow has been tampered with
   if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
       header('Location: ' . $baseURL . '?error=invalid_state');
       die();
   }

   // We communicate directly with the AS to exchange the code received against an access token.
   // The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
   $token = apiRequest(
       $config['token_uri'],
       [
           'grant_type'    => 'authorization_code',
           'client_id'     => $config['client_id'],
           'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
           'redirect_uri'  => $baseURL,
           'code'          => $_GET['code'],
           'code_verifier' => $_SESSION['code_verifier']
       ]
   );

   // We store the access token in the session so the user is "connected"
   // Only if the request has been successfully executed
   if (isset($token['access_token'])) {
       file_put_contents($localTokenFile, json_encode($token, true));

       // Redirecting the user's browser to the "home" page
       header('Location: ' . $baseURL);
   } else {
       echo $token;
   }
   die();

}</php>

Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

Client Credentials

Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :

  • Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
  • Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
  • Le client utilise ce jeton d'accès pour accéder à des données via l'API.


   +------+                       +-------------+                  +-----------+
   |Client|                       |   Serveur   |                  |  Serveur  |
   +--+---+                       |Autorisation |                  | Ressources|
      |                           +------+------+                  +-----+-----+
      |        Authentification          |                               |
      |         + Demande token          |                               |
      +--------------------------------->|                               |
      |                                  |                               |
      |          Access token            |                               |
      |<---------------------------------+                               |
      |                                  |                               |
      |                      Requête vers|API                            |
      +----------------------------------+------------------------------>|
      |                                  |                               |
      |                                  |                               |
      |                                  |<------------------------------+
      |                                  |  Vérification d'autorisation  |
      |                                  +------------------------------>|
      |                                  |                               |
      |                         Données /|Réponse                        |
      |<---------------------------------+-------------------------------+
      |                                  |                               |


Demande de jeton d'accès

Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :

Nom Type Description
client_id string L'identifiant unique reçu pendant l'enregistrement du client.
client_secret string La passphrase reçue pendant l'enregistrement du client.
grant_type string Le mécanisme d'autorisation utilisé. Ici, la valeur doit être client_credentials.
scope string Liste des droits demandés par le client, séparé par des espaces.
Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.

Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON. <javascript>{ 

 "token_type": "Bearer",
 "expires_in": 3600,
 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"

}</javascript>

Script client : Client Credentials

Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).

Fichier de configuration config.clientcred.json : <javascript>{ 

 "client_id": "",
 "client_secret": "",
 "token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
 "revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
 "auth_cert": "/path/to/client/auth_cert.crt",
 "auth_key": "/path/to/client/auth.key",
 "sign_cert": "/path/to/client/sign_cert.crt",
 "sign_key": "/path/to/client/sign.key",
 "auth_cacert": "/path/to/ca.crt",
 "sign_cert_server": "/path/to/server/sign_cert_server.crt"

}</javascript> Où /path/to/client/ est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.

  • Exemple sur windows: C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/.
  • Exemple sur un serveur Linux debian: ./ssl/ClientCredDemo/.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script php : <php><?php $localTokenFile = 'token.json'; // create token file if it does not exist if (!file_exists($localTokenFile)) 

   file_put_contents($localTokenFile, );

$config = json_decode(file_get_contents('config.clientcred.json'), true); $localToken = json_decode(file_get_contents($localTokenFile), true); $GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; $port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443) 

   || ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ?  : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF']; $errorLog = 'error_log.log'; $responseLog = 'response_log.log'; $GLOBALS['baseURL'] = $baseURL;

$replacementListItems = [ 

   1 => "year",
   2 => "validityTypeId",
   3 => "icao",
   4 => "profileId",
   7 => "accountingId",
   8 => "paymentType",
   9 => "startDate",
   10 => "endDate",
   11 => "occupiedSeat",
   12 => "date",
   13 => "activityTypeId",
   14 => "age",
   15 => "resourceId",
   16 => "personId",
   17 => "accountId",
   20 => "rightPlacePersonId",
   21 => "month",
   22 => "numberMonth",
   23 => "oneValidityTypeId",

];

//Session cookies are used to store information necessary for the authorization code flow session_start();

/** 

* This function is used to make api calls to the RS
*
* @param       $url
* @param       $post
* @param array $headers
*
* @return mixed
*/

function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array()) { 

   $ch = curl_init($url);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   curl_setopt($ch, CURLOPT_HEADER, true);

   $method = 'get';

   if ($post) {
       $method   = 'post';
       $postData = http_build_query($post);
       curl_setopt($ch, CURLOPT_POST, true);
       curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

       $headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
       $headersToSign['digest']       = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
   }

   $urlComponents = parse_url($url);

   $headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
   $headersToSign['Host']             = $urlComponents['host'];
   $headersToSign['Date']             = gmdate('D, j M Y H:i:s T');

   // generating the signature header
   $keyId                = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
   $privateKey           = file_get_contents($GLOBALS['config']['sign_key']);
   $headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

   $headers['Accept']     = 'application/json';
   $headers['User-Agent'] = $GLOBALS['baseURL'];
   unset($headersToSign['(request-target)']);
   $headers               += $headersToSign;

   if ($token) {
       $headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
   }

   // formatting the headers
   $httpFormattedHeaders = [];
   foreach ($headers as $key => $value) {
       $httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
   }

   curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
   curl_setopt($ch, CURLINFO_HEADER_OUT, true);

   // for development environment only
   //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
   //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
   //curl_setopt($ch, CURLOPT_VERBOSE, true);

   // defining TLS client certificates for Mutual TLS
   curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
   curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
   curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
   curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

   $response = curl_exec($ch);

   // logging errors and responses
   errorLog(true, $response, $ch);

   curl_close($ch);

   // in case an authentication request is executed
   if ($auth) {
       list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);

       $responseHeadersDigest = ;
       $responseHeadersSignature = ;
       // extracting digest and signature from headers
       $responseHeadersArray = explode("\r\n", $responseHeader);
       $responseProtocol = array_shift($responseHeadersArray);

       foreach ($responseHeadersArray as $value) {
           list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
           $responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
       }

       $responseDigestAlgo = ;
       $responseDigestKey = ;
       foreach ($responseHeaders as $key => $value) {
           if ($key === "digest") {
               $responseHeadersDigest = $value;
               // stripping SHA algorithm for later comparison
               list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
           } else if ($key === "signature")
               $responseHeadersSignature = $value;
       }

       // calculating response digest
       $responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

       // checking digest validity
       if ($responseDigest !== $responseDigestKey) {
           errorLog(false, false, "Digests are not the same");
           die();
       }

       // extracting variables from signature header
       $signatureArray = explode(",", $responseHeadersSignature);
       foreach ($signatureArray as $value) {
           list($signatureKey, $signatureValue) = explode("=", $value, 2);
           $signature[$signatureKey] = trim($signatureValue, '"');
       }

       // generating siging string
       $signingStringArray = explode(" ", $signature['headers']);
       $signingString = ;
       foreach ($signingStringArray as $value) {
           $signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
       }

       // trimming last '\n' character
       $signingString = trim($signingString);

       // decoding signature
       $decodedSignature = base64_decode($signature['signature']);

       // verifying signature
       $signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

       if (!$signatureVerify) {
           errorLog(false, false, "Signature is not correct");
           while (($err = openssl_error_string()))
               errorLog(false, false, $err);
           die();
       }

       return json_decode($responseBody, true);
   }

   return $response;

}

/** 

* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request  the request handle, used to get errors
*/

function errorLog($curl, $response, $request = false) { 

   $timestamp = '[' . date('Y-m-d H:i:s') . ']:';
   global $errorLog;
   global $responseLog;

   if ($response === false) {
       if ($curl)
           file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
       else
           file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
   } else {
       file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
   }

}

/** 

* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array  $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate   the certificate linked to the used private key
* @param string $privateKey    the private key used to sign the headers
*
* @return string the full signature header line
*/

function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string { 

   // generating the signing string and header list
   $headers         = ;
   $signatureString = ;
   foreach ($headersToSign as $key => $value) {
       $normalizedHeaderKey = trim(strtolower($key));
       $headers             .= $normalizedHeaderKey . ' ';
       $signatureString     .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
   }
   $headers         = trim($headers);
   $signatureString = trim($signatureString);

   // signing the signing string
   $signature = ;
   openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
   $signature = base64_encode($signature);

   // compiling the header line
   return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";

}

/** 

* This function deletes the access token from the session
*
* @param string $baseURL
*/

function logout(string $baseURL): void { 

   global $localTokenFile;
   file_put_contents($localTokenFile, );

   header('Location: ' . $baseURL);

}

function displayMenuLoggedIn(): void { 

   global $replacementListItems;

echo '

<a href="/">Home</a>

'; echo '

Logged In

'; 

   echo '<form id="view_repos" method="post">';
   echo '<label for="report_id">Report ID: </label>';
   echo '<input type="number" id="report_id" name="report_id">

';
   foreach ($replacementListItems as $value) {
       echo '<label for="' . $value . '">' . $value . ': </label>';
       echo '<input type="text" id="' . $value . '" name="' . $value . '">

';
   }
   echo '<input type="hidden" id="action" name="action" value="view">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a>

'; 

   echo '</form>';

   echo '<form id="logout" method="post">';
   echo '<input type="hidden" id="action" name="action" value="logout">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a>

'; 

   echo '</form>';

}

function displayMenuLoggedOut(): void {

echo '

<a href="/">Home</a>

'; echo '

Not logged in

'; 

   echo '<form id="login" method="post">';
   echo '<input type="hidden" id="action" name="action" value="login">';

echo '

<a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a>

'; 

   echo '</form>';

}

// display client "home" page if (!isset($_POST['action'])) { 

   if (!empty($localToken['access_token'])) {
       displayMenuLoggedIn();
   } else {
       displayMenuLoggedOut();
   }

}

if (isset($_POST['action'])) { 

   $replacementList = [];
   // Building replacement list
   foreach ($replacementListItems as $key => $value) {
       $replacementList[$value] = (isset($_POST[$value]) && strlen($_POST[$value]) > 0) ? $_POST[$value] : null;
   }
   // Building query array
   $repoQueryParameters = [
       'resource_type' => 'generic_report',
       'client_id' => $config['client_id'],
       'report_id' => (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0) ? $_POST['report_id'] : null,
       'replacementList' => $replacementList
   ];
   switch ($_POST['action']) {
       case 'login':
           $token = apiRequest(
               $config['token_uri'],
               [
                   'grant_type'    => 'client_credentials',
                   'client_id'     => $config['client_id'],
                   'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
                   'scope'         => 'genericreports.readonly reports.readonly'
               ]
           );
           // We store the access token in the session so the user is "connected"
           // Only if the request has been successfully executed
           if (isset($token['access_token'])) {
               file_put_contents($localTokenFile, json_encode($token, true));

               // Redirecting the user's browser to the "home" page
               header('Location: ' . $baseURL);
           } else {
               echo $token;
           }
           break;
       case 'logout':
           logout($baseURL);
           break;
       case 'view':
           // call to the resource server
           $resources = apiRequest(
               $config['resource_uri'],
               $repoQueryParameters,
               $localToken,
               false
           );

           // Separating headers from body
           list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

           $resourceHeaders = explode("\r\n", $resourceHeader);
           $firstHeaderLine = array_shift($resourceHeaders);

           // Building form for download CSV button
           echo '<form method="post">';
           foreach ($_POST as $key => $value) {
               if ($key == "action") {
                   $value = "download";
               }
               echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
           }
           if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
               echo '<button>Download as CSV</button>';
           }
           echo '</form>';

           // Displaying requested content

echo '

';
            echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
            echo '

'; 

           break;
       case 'download':
           // call to the resource server
           $resources = apiRequest(
               $config['resource_uri'],
               $repoQueryParameters,
               $localToken,
               false
           );

           // Separating headers from body
           list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
           $resourceHeaders = explode("\r\n", $resourceHeader);
           array_shift($resourceHeaders);

           // Dumping headers to insert them in current page
           foreach ($resourceHeaders as $key => $value) {
               header($value);
           }
           echo json_decode($resourceBody);
           break;
   }

}</php>

Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

Refresh Token

Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec Authorization Code. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.

Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :

  • Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
  • Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
  • Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources
   +------+                       +-------------+                  +-----------+
   |Client|                       |   Serveur   |                  |  Serveur  |
   +--+---+                       |Autorisation |                  | Ressources|
      |                           +------+------+                  +-----+-----+
      |        Authentification          |                               |
      |         + Refresh Token          |                               |
      +--------------------------------->|                               |
      |                                  |                               |
      |    Access (+ Refresh) token      |                               |
      |<---------------------------------+                               |
      |                                  |                               |
      |                      Requête vers|API                            |
      +----------------------------------+------------------------------>|
      |                                  |                               |
      |                                  |                               |
      |                                  |<------------------------------+
      |                                  |  Vérification d'autorisation  |
      |                                  +------------------------------>|
      |                                  |                               |
      |                         Données /|Réponse                        |
      |<---------------------------------+-------------------------------+
      |                                  |                               |

Demande de renouvellement d'un jeton

Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :

Nom Type Description
client_id string L'identifiant client_id reçu pendant l'enregistrement du client.
client_secret string La passphrase client_secret reçue pendant l'enregistrement du client.
grant_type string Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
scope string (OPTIONNEL) Liste des droits demandés par le client, séparés par des espaces.

Si la requête est correcte, un jeton d'accès access_token est fourni en réponse dans un objet au format JSON. <javascript>{ 

 "token_type": "Bearer",
 "expires_in": 3600,
 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
 "refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"

}</javascript>

Liste des scopes disponibles

Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :

Nom Description
default.login Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour Authorization Code.
genericreports.readonly Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour Client Credentials.
reports.readonly Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour Client Credentials.

Prolonger la durée de vie de la session du client de démonstration

La session du client de démonstration est initiée avec la méthode PHP session_start. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP session_set_cookie_params. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session. <php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days $oauth2DemoSessionLifeTime = time() + (86400 * 30); session_set_cookie_params($oauth2DemoSessionLifeTime);</php>

NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.

Révocation de token

Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée.

Envoyer également le paramètre suivant:

Nom Type Description
access_token string Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)

<php> apiRequest( 

               $config['revoke_uri'],
               ['access_token' => $_SESSION['auth_token']['access_token']],
               null,
               false
           );</php>

La demande de révocation se fait quand l'utilisateur clique sur le bouton Se déconnecter pour l'un des deux Clients Authorization Code et Client Credentials.

Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.

Utiliser l'API

Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : https://openflyers.com/nom-de-plateforme/oauth/resources.php. Remplacer nom-de-plateforme par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'avec le scope qui lui est associé. Le jeton d'accès doit être renseigné dans l'en-tête HTTP Authorization en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu  : Authorization: <token_type> <access_token>.

Récupérer les informations de l'utilisateur connecté

Ce type de ressource est nommé user_information. Cette ressource n'est accessible qu'avec le scope default.login. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :

Nom Type Description
resource_type string Le type de ressource demandé, ici, ce champ correspond à user_information.
client_id string L'identifiant unique reçu pendant l'enregistrement du client.

Un exemple de requête complète au format JSON : <javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1 Content-Type: application/x-www-form-urlencoded Host: openflyers.com Date: Wed, 04 Aug 2021 13:57:51 GMT Accept: application/json User-Agent: curl/7.64.1 Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU Signature: keyId="58c450d937953829c8cca3613001f865a918da07", 

          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="

Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{ 

   "resource_type":"user_information",
   "client_id":"d2615fe2020ec476"

}</javascript>

La réponse est retournée dans un conteneur JSON.

Récupérer les rapports génériques

Ce type de ressource est nommé generic_report. Cette ressource n'est accessible qu'avec le scope genericreports.readonly. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

Nom Type Description
resource_type string Le type de ressource demandé, ici, ce champ correspond à generic_report.
client_id string L'identifiant unique reçu pendant l'enregistrement du client.
report_id int Identifiant du rapport souhaité.
replacementList array Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.

Un exemple de requête complète au format JSON : <javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1 Content-Type: application/x-www-form-urlencoded Host: openflyers.com Date: Wed, 04 Aug 2021 13:57:51 GMT Accept: application/json User-Agent: curl/7.64.1 Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU Signature: keyId="58c450d937953829c8cca3613001f865a918da07", 

          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="

Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{ 

   "resource_type":"generic_report",
   "client_id":"d2615fe2020ec476",
   "report_id":135,
   "replacementList":{
       "year":2018
   }

}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

Récupérer les rapports personnalisés

Ce type de ressource est nommé report. Cette ressource n'est accessible qu'avec le scope reports.readonly. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

Nom Type Description
resource_type string Le type de ressource demandé, ici, ce champ correspond à report.
client_id string L'identifiant unique reçu pendant l'enregistrement du client.
report_id int Identifiant du rapport souhaité.
replacementList array Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.

Un exemple de requête complète au format JSON : <javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1 Content-Type: application/x-www-form-urlencoded Host: openflyers.com Date: Wed, 04 Aug 2021 13:57:51 GMT Accept: application/json User-Agent: curl/7.64.1 Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU Signature: keyId="58c450d937953829c8cca3613001f865a918da07", 

          algorithm="rsa-sha256",
          headers="host content-type digest",
          signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="

Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{ 

   "resource_type":"report",
   "client_id":"d2615fe2020ec476",
   "report_id":1,
   "replacementList":{
       "year":2020
   }

}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

Procédures

Créer un client à partir du code source

Prérequis

Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Télécharger Le code source du client de démonstration

Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

Le code source est structuré de la manière suivante :

Oauth2 src demo folder.png

  • Le dossier css contient tout le matériel nécessaire à la stylisation de la page web.
  • Le dossier img contient les images affichées sur la page web.
  • Le dossier ssl est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
  • Le fichier ClientDemo.php contient la classe ClientDemo. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
  • Le fichier index.php est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe ClientDemo et exécute les méthodes dans l'ordre.

Le dossier ssl doit respecter la structure suivante :

Oauth2 demo tree.png

Générer les certificats

Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.

Enregistrer les clients
  • Deux clients doivent être créés :
    • Le premier pour le mécanisme d'autorisation Authorization Code,
    • Le second pour le mécanisme d'autorisation Client Credentials.

Oauth2 demo manage.png

  • Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton Télécharger le certificat CA de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton Télécharger le certificat de signature du serveur de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier ssl.
  • Télécharger les deux certificats Certificat d'authentification et Certificat de signature du client Authorization Code et les placer dans le répertoire ssl/AuthCodeDemo.
  • Modifier le fichier ssl/AuthCodeDemo/config.authcode.json en le remplissant de la manière suivante.

<php>{ 

 "client_id": "XXXXXXXXXXXXXXXX",
 "client_secret": "XXXXXXXXXXXXXXXX",
 "authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
 "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
 "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
 "auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
 "auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
 "sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
 "sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
 "auth_cacert": "path_to_client/ssl/ca.crt",
 "sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"

}</php>

  • Remplacer les XXXXXXXXXXXXXXXX des champs client_id et client_secret par les valeurs obtenues lors de l'enregistrement du client.
  • Remplacer mastructure par le nom de la structure sur laquelle la démo est testée.
  • Remplacer path_to_client/ par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
    • Exemple sur windows: C:/wamp64/www/4.0/oauth-demo/.
    • Exemple sur un serveur Linux debian: ./.


  • Télécharger les deux certificats Certificat d'authentification et Certificat de signature du client Client Credentials et les placer dans le répertoire ssl/ClientCredDemo.
  • Modifier le fichier ssl/ClientCredDemo/config.clientcred.json en le remplissant de la manière suivante.

<php>{ 

 "client_id": "XXXXXXXXXXXXXXXX",
 "client_secret": "XXXXXXXXXXXXXXXX",
 "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
 "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
 "auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
 "auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
 "sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
 "sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
 "auth_cacert": "path_to_client/ssl/ca.crt",
 "sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"

}</php>

  • Remplacer les XXXXXXXXXXXXXXXX des champs client_id et client_secret par les valeurs obtenues lors de l'enregistrement du client.
  • Remplacer mastructure par le nom de la structure sur laquelle la démo est testée.
  • Remplacer path_to_client/ par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
    • Exemple sur windows: C:/wamp64/www/4.0/oauth-demo/.
    • Exemple sur un serveur Linux debian: ./.



NB: Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

Enregistrer un client

Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :


Pour le mécanisme d'authentification Client Credentials
  • Créer un nouveau profil. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".
  • Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
    • Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet Admin (colonne Associé aux clients OAuth2).
    • Sélectionner les rapports accessibles par le profil précédemment créé.
  • Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
    • Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")
    • Attention : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.


Pour le mécanisme d'authentification Authorization Code
  • Aller dans Admin > Utilisateurs > Profils
  • Dans l'onglet Généralités, cocher la case relative à la colonne Connexion depuis l'extérieur (OAuth2) pour le profil souhaité.


Créer un nouveau client OAuth2
  • Aller dans Admin > Transferts > Exports > API OAuth2

Oauth2 manage.png

  • Cliquer sur le bouton Ajouter + ou Ajouter un client

Oauth2 client creation.png

  • Choisir un nom pour le client.
  • Sélectionner le mécanisme d'autorisation utilisé par le client :
    • Authorization Code: permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (Refresh Token).
    • Client Credentials: permet d'utiliser OAuth2 dans un contexte d'automatisme.
  • Saisir l'URI de redirection vers le client pour le mécanisme Authorization Code.
  • Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme Client Credentials.
  • Générer deux CSR afin d'obtenir deux certificats signés et les saisir :
    • Certificate Signing Request pour le certificat d'authentification est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
    • Certificate Signing Request pour le certificat de signature est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

PublicKeysCopyScreen.png


  • Cliquer sur Enregistrer.

NB: La validité des certificats générés s'étend sur une période de 3 années.


Sauvegarder le couple ID/passphrase

Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles, et Mettre ces identifiants dans le fichier config.clientcred.json. Oauth2 client created.png

ConfigCredJsonScreen.png


Télécharger les certificats crt

Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets Certificat d'authentification et Certificat de signature et les mettre dans le dossier /ssl du client OAuth2. Oauth2 client certificates.png

Téléchargez les certificats du serveur.
  • Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.

DownloadServerCertifScreen.png

  • Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
  • Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
    • Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier /usr/local/share/ca-certificates et exécuter la commande sudo update-ca-certificates
    • Sous Windows,
      • Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
      • Cliquer sur Installer un certificat...
      • Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur Suivant puis Suivant et enfin Terminer

Générer des certificats

L'API OAuth2 implémente HTTP Signature et l'authentification TLS mutuelle. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.

Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).

La procédure est la suivante :

Fichier de configuration OpenSSL - sign_cert.conf
[req]
default_bits       = 4096                     # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key        = no                       # chiffrer la clé générée
distinguished_name = req_distinguished_name   # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                   # pointe vers la catégorie spécifiée pour les extensions x509
prompt             = no

[req_distinguished_name]
C                  =                          # code à deux chiffres du pays (ex: FR)
ST                 =                          # région/état (ex: Gironde)
L                  =                          # ville (ex: Bordeaux)
O                  =                          # organisation (ex: OpenFlyers)
OU                 =                          # unité organisationelle (ex: IT)
CN                 =                          # nom de domaine (ex: openflyers.com)

[v3_req]
keyUsage           = digitalSignature         # pour quelles opérations la clé peut-elle être utilisée
Fichier de configuration OpenSSL - auth_cert.conf
[req]
default_bits       = 4096                     # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key        = no                       # chiffrer la clé générée
distinguished_name = req_distinguished_name   # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions    = v3_req                   # pointe vers la catégorie spécifiée pour les extensions x509
prompt             = no

[req_distinguished_name]
C                  =                          # code à deux chiffres du pays (ex: FR)
ST                 =                          # région/état (ex: Gironde)
L                  =                          # ville (ex: Bordeaux)
O                  =                          # organisation (ex: OpenFlyers)
OU                 =                          # unité organisationelle (ex: IT)
CN                 =                          # nom de domaine (ex: openflyers.com)

[v3_req]
extendedKeyUsage   = clientAuth               # pour quelles opérations la clé peut-elle être utilisée


Exécuter les commandes suivantes :

  • <bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
  • <bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.

Une fois ces CSR obtenus :

  • Les renseigner dans les champs prévus à cet effet lors de la création d'un client et télécharger les certificats signés depuis l'interface une fois le client créé.
  • Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.

Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé

Note

La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous Windows.

Prérequis
  • Posséder les accès FTP :
    • Hôte : XXXXXXXXXXXXXXXXXX
    • Login : XXXXXXXX
    • Mot de passe : XXXXXXXX
    • Port : XX (par exemple 21)
  • Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip
Procédure
  • Générer les certificats en local.
  • Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
  • Enregistrer les deux clients :
    • Le premier pour le mécanisme d'autorisation Authorization Code.
    • Le second pour le mécanisme d'autorisation Client Credentials.

Oauth2 demo manage.png

  • Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton Télécharger le certificat CA de la page de gestion.
  • Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton Télécharger le certificat de signature du serveur de la page de gestion.
  • Placer les deux certificats téléchargés à la racine du dossier ssl.
  • Télécharger les deux certificats Certificat d'authentification et Certificat de signature du client Authorization Code et les placer dans le répertoire ssl/AuthCodeDemo.
  • Modifier le fichier ssl/AuthCodeDemo/config.authcode.json en le remplissant de la manière suivante.

<php>{ 

 "client_id": "XXXXXXXXXXXXXXXX",
 "client_secret": "XXXXXXXXXXXXXXXX",
 "authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
 "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
 "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
 "auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
 "auth_key": "./ssl/AuthCodeDemo/auth.key",
 "sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
 "sign_key": "./ssl/AuthCodeDemo/sign.key",
 "auth_cacert": "./ssl/ca.crt",
 "sign_cert_server": "./ssl/sign_cert_server.crt"

}</php>


  • Télécharger les deux certificats Certificat d'authentification et Certificat de signature du client Client Credentials et les placer dans le répertoire ssl/ClientCredDemo.
  • Modifier le fichier ssl/ClientCredDemo/config.clientcred.json en le remplissant de la manière suivante.

<php>{ 

 "client_id": "XXXXXXXXXXXXXXXX",
 "client_secret": "XXXXXXXXXXXXXXXX",
 "token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
 "resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
 "revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
 "auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
 "auth_key": "./ssl/ClientCredDemo/auth.key",
 "sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
 "sign_key": "./ssl/ClientCredDemo/sign.key",
 "auth_cacert": "./ssl/ca.crt",
 "sign_cert_server": "./ssl/sign_cert_server.crt"

}</php>

  • Remplacer les XXXXXXXXXXXXXXXX des champs client_id et client_secret par les valeurs obtenues lors de l'enregistrement du client.
  • Remplacer mastructure par le nom de la structure sur laquelle la démo est testée.
  • Transférer le fichier "oauth-demo" vers le serveur mutualisé :
    • Télécharger FileZilla.
    • Lancer FileZilla.
    • Entrer l'URl du serveur mutualisé dans le champ Hôte.
    • Entrer le login dans le champ Nom d'utilisateur.
    • Entrer le mot de passe dans le champ Mot de passe.
    • Entrer le port dans le champ Port.
    • Cliquer sur le bouton Connexion.
    • Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
    • Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet Site distant à droite.
    • Glisser et déposer le oauth-demo à l'emplacement choisi.

Transfer OauthDemo To Shared Server.png

  • Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
  • Modifier la valeur URI de redirection vers le client du client AuthCodeDemo précédemment créé en remplaçant l'ancienne URL par la nouvelle.


NB: Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

Récupérer les données d'un utilisateur

  • Cliquer sur le bouton Récupérer les informations utilisateur, l'identifiant de l'utilisateur s'affiche.
  • Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en créant de nouveaux rapports personnalisés

Utiliser le client

Prérequis

Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le client de démonstration se présente de la manière suivante.

Oauth2 client demo.png

La démonstration est composée de deux colonnes. La première, nommée Authorization Code correspond au mécanisme d'autorisation du même nom. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée Client Credentials correspond elle aussi au mécanisme d'autorisation du même nom. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.

Le mécanisme Authorization Code
  • Cliquer sur le bouton Se connecter (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
  • Renseigner les identifiants de l'administrateur pour s'y connecter.
  • Nom d'utilisateur : admini.
  • Mot de passe : azerty.

Une fois les informations saisies, la page suivante est affichée.

Oauth authorize demo.png

  • Cliquer sur le bouton Autoriser l'application pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).

La première colonne doit afficher l'état de connexion Connecté ainsi qu'un nouveau bouton Récupèrer les informations utilisateurs qui permet de récupérer les informations de l'utilisateur connecté.

Le mécanisme Client Credentials
  • Cliquer sur le bouton de connexion Se connecter: contrairement à celui du mécanisme Authorization Code, ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.

Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion Connecté ainsi qu'un menu déroulant Rapport à récupèrer et un nouveau bouton Récupèrer le rapport qui permet de récupérer les rapports génériques et personnalisés.


Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

Oauth2 connected demo.png

Troubleshooting

500 Internal Server Error en récupérant le rapport

La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".

Erreur "File not found."

Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.

int_rsa_verify : longueur de signature incorrecte

Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2. La solution est :

Si cela ne fonctionne pas
Retrieved from "https://doc4-fr.openflyers.com/index.php?title=API-OpenFlyers&oldid=12876"