You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en.md
+6-13Lines changed: 6 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ This [Keycloak](https://www.keycloak.org) plugin adds an identity provider allow
21
21
22
22
* Signature verification (based on client-secret)
23
23
* 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)
25
25
* Better management for logout (https://issues.jboss.org/browse/KEYCLOAK-7209)
26
26
27
27
## Compatibility
@@ -47,15 +47,9 @@ If you are already using an older version of the plugin, it's better to delete y
47
47
The plugin installation is simple and can be done without a Keycloak server restart.
48
48
49
49
* 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
51
51
* Restart Keycloak (optional, hot deployment should work)
52
52
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
-
59
53
## How to use it
60
54
61
55
### Environments
@@ -74,20 +68,19 @@ Each offering is available in both INTEGRATION and PRODUCTION, resulting in the
74
68
75
69
### Requirements
76
70
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/).
78
72
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.
80
74
81
-
France Connect account can be managed at https://partenaires.franceconnect.gouv.fr
82
75
83
76
### Configuration
84
77
85
78
Once the installation is complete, the `France Connect Particulier` identity provider appears. Once selected, you can see the following configuration page:
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.
91
84
92
85
You will also find the redirect uri you will need to enter on the France Connect partner portal:
Copy file name to clipboardExpand all lines: README.md
+20-22Lines changed: 20 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@
23
23
-[Comment contribuer](#comment-contribuer)
24
24
25
25
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/).
@@ -34,7 +34,7 @@ Pour toutes questions sur l'utilisation de cette extension, n'hésitez pas à ou
34
34
35
35
* Vérification de signature (basée sur le client-secret)
36
36
* 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)
38
38
* Meilleure gestion du logout (contourne https://issues.jboss.org/browse/KEYCLOAK-7209)
39
39
* Provider pour [AgentConnect](https://agentconnect.gouv.fr/)
40
40
* 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
63
63
L'installation de l'extension est simple et peut-être réalisée sans redémarrage de Keycloak.
64
64
65
65
* 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
67
67
* Redémarrez Keycloak (optionnel, le déploiement à chaud devrait fonctionner)
68
68
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
-
75
69
## Utilisation
76
70
77
71
### France Connect
@@ -93,20 +87,18 @@ Chaque offre est proposée en `INTEGRATION` et en `PRODUCTION`, ce qui donne don
93
87
94
88
#### Prérequis
95
89
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/).
97
91
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".
101
93
102
94
#### Configuration
103
95
104
96
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 :
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.
110
102
111
103
Vous trouverez également l'url de redirection qu'il faudra enregistrer sur le portail Partenaire de France Connect :
Adresse de la clé de chiffrement (pour ouverture des flux) | https://*<KEYCLOAK_SERVER>*/auth/realms/*<KEYCLOAK_REALM>*/protocol/openid-connect/certs
174
166
175
167
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
177
168
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.
179
172
#### Prérequis
180
173
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/.
182
175
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.
184
177
185
178
#### Configuration
186
179
187
180
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 :
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.
192
185
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.
193
186
194
187
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
197
190
198
191
##### Mappers
199
192
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).
201
194
Les principaux mappers sont ajoutés automatiquement lors de la création du fournisseur d'identité.
202
195
203
196
Exemples de mappers :
204
197
* Name : `lastName`, Mapper Type : `Attribute Importer`, Claim : `family_name`, User Attribute Name : `lastName`
205
198
* Name : `firstName`, Mapper Type : `Attribute Importer`, Claim : `given_name`, User Attribute Name : `firstName`
206
199
* Name : `email`, Mapper Type : `Attribute Importer`, Claim : `email`, User Attribute Name : `email`
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/ .
0 commit comments