API OpenFlyers - Revision history

Claratte: /* Générer des certificats */

2025-10-24T17:09:57Z

Générer des certificats

← Older revision		Revision as of 17:09, 24 October 2025
Line 1,668:		Line 1,668:
	La procédure est la suivante :		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]].		*[[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~~.		*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et '''remplir les champs vides'''.

	;Fichier de configuration OpenSSL - sign_cert.conf		;Fichier de configuration OpenSSL - sign_cert.conf

Claratte: /* Générer des certificats */

2025-10-24T16:42:20Z

Générer des certificats

← Older revision		Revision as of 16:42, 24 October 2025
Line 1,712:		Line 1,712:
	Exécuter les commandes suivantes :		Exécuter les commandes suivantes :
	*<syntaxhighlight lang="bash">openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</syntaxhighlight>		*<syntaxhighlight lang="bash">openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</syntaxhighlight>
	*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</~~bash~~>		*<syntaxhighlight lang="bash">openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</syntaxhighlight>

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

Claratte: /* Générer des certificats */

2025-10-24T16:41:58Z

Générer des certificats

← Older revision		Revision as of 16:41, 24 October 2025
Line 1,711:		Line 1,711:

	Exécuter les commandes suivantes :		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~~>		*<syntaxhighlight lang="bash">openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</syntaxhighlight>
	*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>		*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:34:05Z

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

← Older revision		Revision as of 12:34, 23 April 2025
Line 1,454:		Line 1,454:
	La réponse est un fichier CSV retourné dans un conteneur JSON.		La réponse est un fichier CSV retourné dans un conteneur JSON.

	le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.		Le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.

	Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].		Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:33:47Z

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

← Older revision		Revision as of 12:33, 23 April 2025
Line 1,458:		Line 1,458:
	Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].		Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

	Exemple avec le rapport [[[[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.		Exemple avec le rapport [[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.

	===Récupérer les rapports personnalisés===		===Récupérer les rapports personnalisés===

Claratte: /* Récupérer les rapports génériques */

2025-04-23T12:33:30Z

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

← Older revision		Revision as of 12:33, 23 April 2025
Line 1,453:		Line 1,453:

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

			le report_id se trouve dans la [[Bibliothèque-des-rapports#Présentation\|bibliothèque des rapports]] dans la 1ère colonne de la ligne du rapport concerné.

			Pour identifier les paramètres à transmettre dans "replacementList", il faut retrouver le rapport [[OF-doc-en:Export-generator-4\|dans la version anglaise de la documentation]].

			Exemple avec le rapport [[[[OF-doc-en:Accounting-exports#Balances-of-resource-accounts\|"Balances of resource accounts"]] : le chapitre indique que les paramètres/variables nécessaires sont ''accountingId'' et ''endDate''.

	===Récupérer les rapports personnalisés===		===Récupérer les rapports personnalisés===

Claratte at 21:39, 13 February 2025

2025-02-13T21:39:41Z

Show changes

Lhenry: /* Script client : Authorization Code */

2025-02-13T18:22:20Z

Script client : Authorization Code

← Older revision		Revision as of 18:22, 13 February 2025
Line 260:		Line 260:

	Fichier de configuration ''config.authcode.json'' :		Fichier de configuration ''config.authcode.json'' :
	<javascript>{		<syntaxhighlight lang="javascript">{
	"client_id": "",		"client_id": "",
	"client_secret": "",		"client_secret": "",
Line 272:		Line 272:
	"auth_cacert": "/path/to/ca.crt",		"auth_cacert": "/path/to/ca.crt",
	"sign_cert_server": "/path/to/server/sign_cert_server.crt"		"sign_cert_server": "/path/to/server/sign_cert_server.crt"
	}</~~javascript~~>		}</syntaxhighlight>
	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.		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 '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
Line 280:		Line 280:

	Script PHP :		Script PHP :
	<php><?php		<syntaxhighlight lang="php"><?php
	$localTokenFile = 'token.json';		$localTokenFile = 'token.json';
	// create token file if it does not exist		// create token file if it does not exist
Line 769:		Line 769:
	}		}
	die();		die();
	}</~~php~~>		}</syntaxhighlight>

	;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.		;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.

Lhenry: /* Générer les codes pour PKCE */

2025-02-13T18:21:32Z

Générer les codes pour PKCE

← Older revision		Revision as of 18:21, 13 February 2025
Line 180:		Line 180:

	;Générer le ''code_verifier''		;Générer le ''code_verifier''
	<php>function generateCodeVerifier($length = 128): string		<syntaxhighlight lang="php">function generateCodeVerifier($length = 128): string
	{		{
	$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';		$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
Line 191:		Line 191:

	return $outputCode;		return $outputCode;
	}</~~php~~>		}</syntaxhighlight>

	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.		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''		;Générer le ''code_challenge''
	<php>function computeCodeChallenge(string $codeVerifier): string		<syntaxhighlight lang="php">function computeCodeChallenge(string $codeVerifier): string
	{		{
	return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');		return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
	}</~~php~~>		}</syntaxhighlight>

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


	===Demande d'autorisation===		===Demande d'autorisation===

Lhenry: /* Signature */

2025-02-13T18:20:28Z

Signature

← Older revision		Revision as of 18:20, 13 February 2025
Line 87:		Line 87:

	;Exemple en php		;Exemple en php
	<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string		<syntaxhighlight lang="php">function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
	{		{
	// generating the signing string and header list		// generating the signing string and header list
Line 109:		Line 109:
	// compiling the header line		// compiling the header line
	return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";		return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
	}</~~php~~>		}</syntaxhighlight>
	Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.		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 :		La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
	<php>[		<syntaxhighlight lang="php">[
	$headerName => $headerValue,		$headerName => $headerValue,
	...		...
	]</~~php~~>		]</syntaxhighlight>

	'''À 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.		'''À 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.