Skip to content

Commit 307c5eb

Browse files
[DOC] Update documentation
Signed-off-by: Clément Dufaure <[email protected]>
1 parent 116c5c5 commit 307c5eb

File tree

6 files changed

+26
-35
lines changed

6 files changed

+26
-35
lines changed

README.en.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This [Keycloak](https://www.keycloak.org) plugin adds an identity provider allow
2121

2222
* Signature verification (based on client-secret)
2323
* User account warranty level (eIDAS) required on authorization request (cf [communication FranceConnect](https://dev.entrouvert.org/issues/34448))
24-
* Login themes with FranceConnect buttons (fc-theme and iron-theme)
24+
* Login themes with FranceConnect buttons (fc-ac-theme)
2525
* Better management for logout (https://issues.jboss.org/browse/KEYCLOAK-7209)
2626

2727
## Compatibility
@@ -47,15 +47,9 @@ If you are already using an older version of the plugin, it's better to delete y
4747
The plugin installation is simple and can be done without a Keycloak server restart.
4848

4949
* Download the latest release from the [releases page](https://github.com/InseeFr/Keycloak-FranceConnect/releases)
50-
* Copy the JAR file into the `standalone/deployments` directory in your Keycloak server's root
50+
* Copy the JAR file into the `providers` directory in your Keycloak server's root
5151
* Restart Keycloak (optional, hot deployment should work)
5252

53-
You can also clone the Github Repository and install the plugin locally with the following command:
54-
55-
```
56-
$ mvn clean install wildfly:deploy
57-
```
58-
5953
## How to use it
6054

6155
### Environments
@@ -74,20 +68,19 @@ Each offering is available in both INTEGRATION and PRODUCTION, resulting in the
7468

7569
### Requirements
7670

77-
You must have a [France Connect account](https://franceconnect.gouv.fr/partenaires) to retrieve plugin configuration information (clientId, clientSecret, authorized redirect uri, ...)
71+
The official documentation can be found [here](https://docs.partenaires.franceconnect.gouv.fr/fs/).
7872

79-
There are 2 environments, `Integration` and `Production`. The request for an Integration account is made by email to the France Connect support team.
73+
You need to obtain a client_id and client_secret and to configure redirect URIs. There isn't a standard testing configuration, but you can easily request a sandbox configuration.
8074

81-
France Connect account can be managed at https://partenaires.franceconnect.gouv.fr
8275

8376
### Configuration
8477

8578
Once the installation is complete, the `France Connect Particulier` identity provider appears. Once selected, you can see the following configuration page:
8679

8780
![keycloak-fc-conf-provider](/assets/keycloak-fc-conf-provider.png)
8881

89-
Choose the France Connect environment, enter your clientId, clientSecret, requested [scopes](https://partenaires.franceconnect.gouv.fr/fcp/fournisseur-service#identite-pivot), the eIDAS authentication level.
90-
The configured alias (`france-connect-particulier`) is used by `fc-theme` and `iron-theme` themes. You can rename this alias if you don't use one of theses themes.
82+
Choose the France Connect environment, enter your clientId, clientSecret, requested [scopes](https://docs.partenaires.franceconnect.gouv.fr/fs/fs-technique/fs-technique-scope-fc/), the eIDAS authentication level.
83+
The configured alias (`france-connect-particulier`) is used by `fc-ac-theme` themes. You can rename this alias if you don't use one of theses themes.
9184

9285
You will also find the redirect uri you will need to enter on the France Connect partner portal:
9386
* endpoint: `https://<keycloak-url>/auth/realms/<realm>/broker/franceconnect-particulier/endpoint`

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
- [Comment contribuer](#comment-contribuer)
2424

2525

26-
Cette extension pour [Keycloak](https://www.keycloak.org) ajoute un fournisseur d'identité permettant d'utiliser les services proposés par [France Connect](https://franceconnect.gouv.fr/).
26+
Cette extension pour [Keycloak](https://www.keycloak.org) ajoute un fournisseur d'identité permettant d'utiliser les services proposés par [France Connect](https://franceconnect.gouv.fr/) et [Proconnect](https://www.proconnect.gouv.fr/).
2727

2828
[![CI Badge](https://github.com/InseeFr/Keycloak-FranceConnect/actions/workflows/ci.yml/badge.svg)](https://github.com/InseeFr/Keycloak-FranceConnect/actions/workflows/ci.yml)
2929

@@ -34,7 +34,7 @@ Pour toutes questions sur l'utilisation de cette extension, n'hésitez pas à ou
3434

3535
* Vérification de signature (basée sur le client-secret)
3636
* Gestion du niveau d'authentification (eIDAS) dans la demande d'autorisation (cf [communication FranceConnect](https://dev.entrouvert.org/issues/34448))
37-
* Thèmes de connexion permettant l'affichage des boutons France Connect (fc-theme et iron-theme)
37+
* Thèmes de connexion permettant l'affichage des boutons France Connect (fc-ac-theme)
3838
* Meilleure gestion du logout (contourne https://issues.jboss.org/browse/KEYCLOAK-7209)
3939
* Provider pour [AgentConnect](https://agentconnect.gouv.fr/)
4040
* Gestion de FranceConnect+ (niveau EIDAS2 et EIDAS3)
@@ -63,15 +63,9 @@ Si vous utilisez déjà une ancienne version de l'extension, il est préférable
6363
L'installation de l'extension est simple et peut-être réalisée sans redémarrage de Keycloak.
6464

6565
* Téléchargez la dernière version de l'extension à partir de la page de [release](https://github.com/InseeFr/Keycloak-FranceConnect/releases)
66-
* Copiez le fichier JAR dans le dossier `standalone/deployments` de votre serveur Keycloak
66+
* Copiez le fichier JAR dans le dossier `providers` de votre serveur Keycloak
6767
* Redémarrez Keycloak (optionnel, le déploiement à chaud devrait fonctionner)
6868

69-
Vous pouvez également cloner le repository Github et effectuer une installation locale avec la commande :
70-
71-
```
72-
$ mvn clean install wildfly:deploy
73-
```
74-
7569
## Utilisation
7670

7771
### France Connect
@@ -93,20 +87,18 @@ Chaque offre est proposée en `INTEGRATION` et en `PRODUCTION`, ce qui donne don
9387

9488
#### Prérequis
9589

96-
Vous devez créer un [compte France Connect](https://franceconnect.gouv.fr/partenaires) afin de récupérer les informations nécessaires à la configuration de cette extension (clientId, clientSecret, configuration de l'url de redirection autorisée, ...).
90+
La documentation de fournisseur de service FranceConnect est décrite [ici](https://docs.partenaires.franceconnect.gouv.fr/fs/).
9791

98-
Il existe 2 environnements de connexion, `Integration` et `Production`. La demande d'un compte permettant l'accès à l'environnement d'Intégration s'effectue par email au service support de France Connect.
99-
100-
Le compte partenaire France Connect est configurable via https://partenaires.franceconnect.gouv.fr
92+
Vous devez récupérer un couple client_id et client_secret et configurer les urls de redirection adéquates. Il n'y a pas de configuration commune de test, mais il est aisée de demande sa configuration "bac à sable".
10193

10294
#### Configuration
10395

10496
Suite à l'installation de l'extension, le fournisseur d'identité `France Connect Particulier` est apparu. Une fois ce dernier selectionné, vous arrivez sur la page de configuration suivante :
10597

10698
![keycloak-fc-conf-provider](/assets/keycloak-fc-conf-provider.png)
10799

108-
Sélectionnez l'environnement désiré, entrez votre clientId, clientSecret, [les scopes](https://partenaires.franceconnect.gouv.fr/fcp/fournisseur-service#identite-pivot) que vous souhaitez demander, le niveau d'authentification eIDAS.
109-
L'alias configuré par défaut (`france-connect-particulier`) est utilisé par les thèmes `fc-theme` et `iron-theme`. Vous pouvez donc modifier le nom de l'alias si vous n'utilisez pas un de ces thèmes.
100+
Sélectionnez l'environnement désiré, entrez votre clientId, clientSecret, [les scopes](https://docs.partenaires.franceconnect.gouv.fr/fs/fs-technique/fs-technique-scope-fc/) que vous souhaitez demander, le niveau d'authentification eIDAS.
101+
L'alias configuré par défaut (`france-connect-particulier`) est utilisé par les thèmes `fc-ac-theme`. Vous pouvez donc modifier le nom de l'alias si vous n'utilisez pas un de ces thèmes.
110102

111103
Vous trouverez également l'url de redirection qu'il faudra enregistrer sur le portail Partenaire de France Connect :
112104
* endpoint : `https://<keycloak-url>/auth/realms/<realm>/broker/franceconnect-particulier/endpoint`
@@ -173,22 +165,23 @@ Chiffrement de l'id_token (A256GCM / -) | A256GCM
173165
Adresse de la clé de chiffrement (pour ouverture des flux) | https://*<KEYCLOAK_SERVER>*/auth/realms/*<KEYCLOAK_REALM>*/protocol/openid-connect/certs
174166

175167
L'implémentation permettant de déchiffrer les jetons échangés s'appuie sur le travail de l'équipe keycloak autour de FAPI, cela implique que cette extension supporte uniquement Keycloak en verison supérieure à 15.
176-
### Agent Connect
177168

178-
La version 3.0 de cette extension ajoute le support pour AgentConnect pour l'authentification des agents de la fonction publique d'Etat : https://github.com/france-connect/Documentation-AgentConnect.
169+
### ProConnect
170+
171+
La version 3.0 de cette extension ajoute le support pour ProConnect (anciennement AgentConnect) pour l'authentification des agents de la fonction publique d'Etat et des comptes professionnels.
179172
#### Prérequis
180173

181-
De la même façon que pour France Connect il vous faudra demander la création d'un compte sur agent connect.
174+
De la même façon que pour France Connect il vous faudra demander la création d'un compte sur agent connect via https://partenaires.proconnect.gouv.fr/.
182175

183-
Il existe 2 environnements de connexion, `Integration` et `Production`. La demande d'un compte permettant l'accès à l'environnement d'Intégration s'effectue par email au service support d'Agent Connect.
176+
Il existe 2 environnements de connexion, `Integration` et `Production`, chacun décliné pour une exposition Internet ou RIE.
184177

185178
#### Configuration
186179

187180
Suite à l'installation de l'extension, le fournisseur d'identité `Agent Connect` est apparu. Une fois ce dernier selectionné, vous arrivez sur la page de configuration suivante :
188181

189-
![keycloak-fc-conf-provider](/assets/keycloak-fc-conf-provider.png)
182+
![keycloak-fc-conf-provider](/assets/keycloak-ac-conf-provider.png)
190183

191-
Sélectionnez l'environnement désiré, entrez votre clientId, clientSecret, [les scopes](https://github.com/france-connect/Documentation-AgentConnect/blob/main/doc-fs.md#les-donn%C3%A9es-agent) que vous souhaitez demander, le niveau d'authentification eIDAS.
184+
Sélectionnez l'environnement désiré, entrez votre clientId, clientSecret, [les scopes](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/scope-claims) que vous souhaitez demander, le niveau d'authentification eIDAS.
192185
L'alias configuré par défaut (`agentconnect`) est utilisé par le thèmes `ac-theme`. Vous pouvez donc modifier le nom de l'alias si vous n'utilisez pas un de ces thèmes.
193186

194187
Vous trouverez également l'url de redirection qu'il faudra enregistrer sur le portail Partenaire de France Connect :
@@ -197,14 +190,19 @@ Vous trouverez également l'url de redirection qu'il faudra enregistrer sur le p
197190

198191
##### Mappers
199192

200-
Une fois la configuration validée, vous pouvez ajouter des mappers afin de récupérer les attributs à partir [des claims fournis par France Connect](https://github.com/france-connect/Documentation-AgentConnect/blob/main/doc-fs.md#les-donn%C3%A9es-agent).
193+
Une fois la configuration validée, vous pouvez ajouter des mappers afin de récupérer les attributs à partir [des claims fournis par ProConnect](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/scope-claims).
201194
Les principaux mappers sont ajoutés automatiquement lors de la création du fournisseur d'identité.
202195

203196
Exemples de mappers :
204197
* Name : `lastName`, Mapper Type : `Attribute Importer`, Claim : `family_name`, User Attribute Name : `lastName`
205198
* Name : `firstName`, Mapper Type : `Attribute Importer`, Claim : `given_name`, User Attribute Name : `firstName`
206199
* Name : `email`, Mapper Type : `Attribute Importer`, Claim : `email`, User Attribute Name : `email`
207200

201+
##### Remarque transition AgentConnect -> ProConnect
202+
203+
Pour éviter les effets de bord, l'essentiel des configurations internes (noms de menu, alias, nom des classes, ...) a conservé le nommage "AgentConnect". Cela étant la compatibilité avec ProConnect est bien prise en charge par l'extension.
204+
205+
Cette situation est pour le moment cohérente avec le maintien des adresses historiques du service d'authentification en https://auth.agentconnect.gouv.fr/ .
208206

209207
### Thème
210208

75.1 KB
Loading
23 KB
Loading

assets/keycloak-fc-theme-admin.png

-42.2 KB
Binary file not shown.

assets/keys-provider-fc+.png

22.3 KB
Loading

0 commit comments

Comments
 (0)