Modifié par Aurelie Bertrand le 2024/04/11 17:24
Afficher les derniers auteurs
1 {{ddtoc/}}
2
3 ----
4
5 (% class="wikigeneratedid" %)
6 Ce document décrit la mise en place d’une valve d’authentification OpenID Connect pour DigDash.
7
8 = Prérequis =
9
10 * Les acronymes utilisés par la suite sont référencés dans le lexique, à la fin de ce document.
11 * Avoir configuré le serveur DigDash avec un connecteur SSL/TLS (HTTPS) (cette méthode d'authentification requiert des échanges sécurisés).
12 * Disposer du dossier **<Install DD>/add-ons/valve_openidconnect** contenant tous les fichiers nécessaires à la mise en place de la valve d’authentification OpenID Connect dans le serveur Tomcat de DigDash. Le placement de ces fichiers est décrit dans ce document.
13 ** Le dossier apache-tomcat : transposé à **<Install DD>/apache-tomcat**
14 *** Le sous-dossier lib : librairies et fichier de configuration des logs à placer dans **<InstallDD>/apache-tomcat/lib**
15 *** Le sous-dossier webapps : le point d’entrée DigDash (endpoint) dans un .war à placer dans **<Install DD>/apache-tomcat/webapps**
16 * Les manipulations suivantes sont à réaliser le serveur DigDash **stoppé**.
17 * L’utilisateur à authentifier doit exister à la fois chez l’OP et dans le LDAP DigDash.
18
19 (% class="box warningmessage" %)
20 (((
21 Il est conseillé d’avoir au moins un utilisateur ayant les droits d’ajout d’utilisateurs DigDash dans le LDAP DigDash avant d’installer la valve OpenID Connect, ceci afin d’éviter les échecs d’authentification SSO dès les premières connexions pour cause d’absence de tel utilisateur dans le LDAP.
22 )))
23
24 = Configuration du serveur DigDash =
25
26 == Copie des librairies ==
27
28 Copiez les librairies ainsi que le fichier de configuration des logs du dossier **<install DD>/add-ons/valve_openidconnect/apache-tomcat/lib** dans le dossier :
29
30 (% class="box" %)
31 (((
32 <Install DD>/apache-tomcat/lib
33 )))
34
35 Fichiers à copier :
36
37 |oidc-valve.jar|slf4j-log4j12-1.7.7.jar
38 |slf4j-api-1.7.12.jar|log4j.properties
39 |log4j-1.2.15.jar|
40
41 == Ajout de la valve d’authentification OpenID Connect ==
42
43 Activez la valve d’authentification OpenID Connect dans le fichier **server.xml** situé dans le dossier :
44
45 {{code language="MS-DOS" cssClass="notranslate"}}
46 <digdash_installation>/apache-tomcat/conf
47 {{/code}}
48
49 Pour cela, chercher l’élément **<Host ...>** dans le fichier, décommenter ou y rajouter l’élément **<Valve ...>** ci-dessous :
50
51 (((
52 {{code language="xml" cssClass="notranslate"}}
53 <Valve className="org.bsworks.catalina.authenticator.oidc.OpenIDConnectSSOValve"
54 allowAddr="localhost, 127.0.0.*,0:0:0:0:0:0:0:1"
55 sharedPasswd="secret"
56 redirect_url="https://localhost:8443/digdash_oidc_endpoint/oidcendpoint"
57 providers="[
58 {
59 name: OpenID Provider name,
60 issuer: issuer,
61 clientId: clientId,
62 clientSecret: clientSecret
63 }
64 ]"
65 usernameClaim="email"
66 additionalScopes="email" ></Valve>
67 {{/code}}
68
69 La valeur de l'attribut className est invariable.
70 Les valeurs des attributs allowAddr, sharedPasswd, redirect_url, providers, usernameClaim, additionalScopes sont variables selon l'installation.
71 )))
72
73 |(% style="width:216px" %)**Attributs**|(% style="width:1204px" %)**Description**
74 |(% style="color:#c0392b; width:216px" %)className //(obligatoire)//     |(% style="width:1204px" %)Nom de la classe Java, implémentant l'interface org.apache.catalina.Valve, à utiliser comme Valve ici. Cet attribut est obligatoire, car il permet de sélectionner la Valve à utiliser. Il existe en effet plusieurs implémentations fournies par Tomcat.
75 |(% style="color:#27ae60; width:216px" %)(% style="color:#000000" %)allowAddr //(obligatoire)//   (%%) |(% style="width:1204px" %)Adresse IP du serveur.
76 |(% style="color:#27ae60; width:216px" %)(% style="color:#000000" %)fallbackAuth //(obligatoire)//|(% style="width:1204px" %)La méthode d'authentification de repli
77 |(% style="width:216px" %)sharedPasswd //(obligatoire)//     |(% style="width:1204px" %)Le mot de passe partagé et vérifié à l’authentification (voir point II.5)
78 |(% style="width:216px" %)redirect_url //(obligatoire)//     |(% style="width:1204px" %)(((
79 Il s'agit du chemin de l’application vers lequel les utilisateurs seront redirigés après s'être authentifiés avec l’OP. Pour DigDash, l’URL sera {{{https://<adresse DigDash>:<port>/digdash_oidc_endpoint/oidcendpoint}}}
80
81 {{{ou}}}
82 La valeur peut être "{{{/digdash_oidc_endpoint/oidcendpoint}}}" ; dans ce cas là, l'adresse DigDash sera calculée selon l'adresse courante.
83 )))
84 |(% style="width:216px" %)cookieTimeOut //(facultatif)//     |(% style="width:1204px" %)(((
85 Facultatif, il s’agit du temps (en secondes) au bout duquel le cookie SSO expirera. Vaut 1800 secondes (30 minutes) par défaut .
86 Sinon, le cookie expirera après le nombre de secondes mentionné.
87
88 La mention d'une valeur négative signifie que le cookie expirera à la fermeture du navigateur.
89 La mention d'une valeur égale à 0 signifie que le cookie sera directement supprimé (non recommandé).
90
91 Exemple : cookieTimeOut="3600" (1 heure)
92 )))
93 |(% style="width:216px" %)print_debug //(facultatif)//     |(% style="width:1204px" %)Facultatif, vaut false par défaut, sinon, ajouter print_debug="true" pour des traces plus verbeuses.
94 |(% style="width:216px" %)providers //(obligatoire)//     |(% style="width:1204px" %)(((
95 Valeur de forme tableau d’objets en JSON. Chaque élément correspond à un OpenID Provider utilisé par l’application.
96
97 La syntaxe diffère du format standard JSON dans le sens où les doubles quotes ne sont pas utilisées pour les noms des propriétés et de leur valeur (de sorte à rendre le format plus XMLien). Une valeur peut être entourée par des simples quotes si celle-ci contient des séparateurs tels qu’une virgule, des accolades ou des espaces. Chaque objet représentant un OP comporte les propriétés suivantes :
98
99 - **issuer **//(obligatoire) //: Il s’agit d’une URL unique pour identifier l’OP.    
100
101 - **name** //(facultatif) //: Un nom associé à l’OP ; l’issuer sinon par défaut.
102
103 (((
104 - **clientId **//(obligatoire) : //Le client ID associé à l’application chez l’OP.
105
106 - **clientSecret **//(facultatif) //: Le client Secret. Notez que la plupart des OPs requièrent un client Secret, notamment pour les appels aux points d’entrées de l’OP. Néanmoins, certains OPs supportent des clients publiques, d’où l’absence de client Secret.
107
108 - **usernameClaim **//(facultatif) : //L’attribut user Identifier réclamé par le RP et renvoyé par l’OP pour identifier l’utilisateur qui s’authentifie.
109
110 - **additionalScopes **//(facultatif) //: Les scopes additionnels au scope ‘openid’ séparés par des espaces.
111 )))
112 )))
113 |(% style="width:216px" %)usernameClaim //(facultatif)//     |(% style="width:1204px" %)Le user Identifier par défaut utilisé par tous les OPs qui n’en spécifient pas un dans les propriétés propres de l’OP.
114 |(% style="width:216px" %)additionalScopes (//facultatif)//     |(% style="width:1204px" %)Les scopes additionnels par défaut utilisés par tous les OPs qui n’en spécifient pas un dans les propriétés propres de l’OP.
115 |(% style="width:216px" %)httpConnectTimeout //(facultatif)//     |(% style="width:1204px" %)Timeout en millisecondes pour l’établissement de la connexion vers l’OP. 5000 ms (5 secondes) par défaut.
116 |(% style="width:216px" %)ldapForPaths //(facultatif)//     |(% style="width:1204px" %)Facultatif, il s’agit des expressions régulières des URLs dont les ressources sont autorisées à passer la valve, passant ainsi en mode d’authentification LDAP. Exemple : "https:~/~/localhost:8443/digdash_dashboard/.*"
117
118 == Ajout du .war correspondant au point d’entrée du Relying Party ==
119
120 Ajoutez l’archive **digdash_oidc_endpoint.war** du dossier **<install DD>/add-ons/valve_openidconnect/apache-tomcat/webapps** dans le dossier :
121
122 (% class="box" %)
123 (((
124 <digdash_installation>/apache-tomcat/webapps
125 )))
126
127 (% class="box infomessage" %)
128 (((
129 Il s’agit du point d’entrée (endpoint) du RP accédé par l’OP.
130 )))
131
132 == Ajout des contraintes de sécurité ==
133
134 Décommentez ou ajoutez les contraintes de sécurité au fichier **web.xml** situé dans le dossier :
135
136 (% class="box" %)
137 (((
138 <Install DD>/apache-tomcat/conf
139 )))
140
141 {{code language="xml" cssClass="notranslate"}}
142 <web-app ...>
143 ...
144 <security-role>
145 <role-name>CUSTOM</role-name>
146 </security-role>
147
148 <security-constraint>
149 <display-name>CUSTOM Security Constraint</display-name>
150 <web-resource-collection>
151 <web-resource-name>Protected Area</web-resource-name>
152 <url-pattern>/*</url-pattern>
153 </web-resource-collection>
154
155 <auth-constraint>
156 <role-name>CUSTOM</role-name>
157 </auth-constraint>
158 </security-constraint>
159
160 <security-constraint>
161 <web-resource-collection>
162 <web-resource-name>Non-Protected Area</web-resource-name>
163 <url-pattern>/vjdbc</url-pattern>
164 </web-resource-collection>
165 </security-constraint>
166 ...
167 </web-app>
168 {{/code}}
169
170 (((
171
172 )))
173
174 = Configuration des applications =
175
176 Pour cela, modifiez le fichier **digdash.properties** dans **<install DD> **ou** /etc/digdash** ou dans le dossier que vous auriez configuré dans setenv.bat/setenv.sh.
177
178
179 == Configuration du Serveur (ddenterprise.war) ==
180
181 Dans le fichier **digdash.properties** :
182
183 Dans l'encadré //ddenterpriseapi.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
184
185 {{code language="properties" cssClass="notranslate"}}
186 ddenterpriseapi.authMethod=External
187 {{/code}}
188
189
190 == Configuration du Tableau de bord (digdash_dashboard.war) ==
191
192 Dans le fichier **digdash.properties** :
193
194 Dans l'encadré //digdash_dashbord.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
195
196 {{code language="properties" cssClass="notranslate"}}
197 digdash_dashboard.SERVERURL=http://localhost:8080
198 digdash_dashboard.DOMAIN=ddenterpriseapi
199 digdash_dashboard.FORCEDOMAIN=true
200 digdash_dashboard.FORCESERVERURL=true
201 digdash_dashboard.sharedPasswd=<la valeur de l'attribut sharedPasswd dans l'élément Valve>
202 {{/code}}
203
204 (% class="box infomessage" %)
205 (((
206 La valeur d’exemple pour le paramètre //digdash_dashboard.SERVERURL// fera quasiment toujours référence à localhost, lorsque le tableau de bord et le serveur sont placés dans le même serveur Tomcat, ce qui représente quasiment 99.9 % des usages. Il faudra naturellement faire référence à l’adresse du serveur externe si ces deux éléments sont placés sur des serveurs différents.
207 )))
208
209
210 == Configuration du Web Studio (studio.war) ==
211
212 Dans le fichier **digdash.properties** :
213
214 Dans l'encadré //studio.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
215
216 {{code language="properties" cssClass="notranslate"}}
217 studio.SERVERURL=http://localhost:8080
218 studio.DOMAIN=ddenterpriseapi
219 studio.FORCEDOMAIN=true
220 studio.FORCESERVERURL=true
221 studio.PUBLICSERVERURL=<votre adresse URL publique en HTTPS>
222 studio.sharedPasswd=<la valeur de l'attribut sharedPasswd dans l'élément Valve>
223 {{/code}}
224
225 (% class="box infomessage" %)
226 (((
227 La valeur d’exemple pour le paramètre //studio.SERVERURL// fera quasiment toujours référence à localhost, lorsque le Studio et le serveur sont placés dans le même serveur Tomcat, ce qui représente quasiment 99.9 % des usages. Il faudra naturellement faire référence à l’adresse du serveur externe si ces deux éléments sont placés sur des serveurs différents.
228 )))
229
230
231
232 == Configuration du Desktop Studio (adminconsole.war) ==
233
234 Dans le fichier **digdash.properties** :
235
236 Dans l'encadré //adminconsole.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
237
238 {{code language="properties" cssClass="notranslate"}}
239 adminconsole.server_domain_list=ddenterpriseapi
240 adminconsole.ddserver=<votre adresse URL publique en HTTPS>
241 adminconsole.serverDomain=ddenterpriseapi
242 adminconsole.domain=ddenterpriseapi
243 adminconsole.authMode=External
244 adminconsole.forceServerDomain=true
245 {{/code}}
246
247
248 = Configuration de l’OpenID Provider =
249
250 L’OP devra enregistrer DigDash en tant que RP dans sa liste de RP pour que DigDash puisse tirer profit de l’Authentification unique.
251
252 Aussi, l’OP devra renseigner l’URL de callback pour identifier le point d’entrée de l’application DigDash. L’URL sera de la forme
253
254 (% class="box infomessage" %)
255 (((
256 https:~/~/<adresse du serveur DigDash>:<port>/digdash_oidc_endpoint/oidcendpoint
257 )))
258
259
260 = Niveau de Logs =
261
262 Vous pouvez personnaliser le niveau de log pour la valve d’authentification.
263
264 Par défaut, seules les erreurs sont loguées. Si toutefois vous voulez avoir plus de détails sur le déroulé des actions et échanges entre les différentes entités, vous pouvez affecter la valeur ‘DEBUG’ au lieu de ‘ERROR’ dans le fichier log4j.properties qui a été importé dans le dossier lib de Tomcat.
265
266 log4j.logger.org.bsworks=**ERROR**, stdout
267 devient
268 log4j.logger.org.bsworks=**DEBUG**, stdout
269
270 = Cohabitation OpenID Connect et LDAP DigDash (facultatif) =
271
272 (% class="box infomessage" %)
273 (((
274 Cette fonctionnalité n'est disponible qu'à partir de la version patchée 2021R1_p2203XX.
275 )))
276
277 Il est possible de faire cohabiter l'authentification directe via l'annuaire LDAP DigDash alors que la méthode OpenID Connect est mise en place sur votre serveur DigDash.
278
279 == Configuration préalable ==
280
281 Dans le fichier **digdash.properties** :
282
283 Dans l'encadré //studio.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
284
285 {{code language="properties" cssClass="notranslate"}}
286 studio.allowLoginForm=true
287 {{/code}}
288
289 Dans l'encadré //digdash_dashbord.war//, rechercher et décommenter les lignes suivantes avec les valeurs indiquées :
290
291 {{code language="properties" cssClass="notranslate"}}
292 digdash_dashboard.allowLoginForm=true
293 {{/code}}
294
295
296 == Activation du mode LDAP DigDash ==
297
298 Pour activer le mode d'authentification en mode LDAP DigDash, il suffit de rajouter dans l'URL le paramètre **loginForm **avec la valeur (% style="color:#27ae60" %)**true**(%%).
299
300 Ainsi, s'il y a besoin de s'authentifier au tableau de bord directement à l'aide de vos identifiants LDAP DigDash alors que du OpenIDConnect est déjà installé, l'URL à utiliser sera de la forme :
301
302 (% class="box" %)
303 (((
304 https:~/~/<host>:<port>/digdash_dashboard/index.html?**loginForm**=(% style="color:#27ae60" %)**true**
305 )))
306
307 (% class="box warningmessage" %)
308 (((
309 (% style="color:#e67e22" %)**Attention **(%%): de manière générale, le paramètre loginForm ainsi que sa valeur seront à mentionner sur chaque domaine indépendamment les uns des autres (ddenterpriseapi pour le serveur, digdash_dashboard pour le tableau de bord, studio pour le studio web) pour s'authentifier via le LDAP.
310 Ainsi, activer le paramètre loginForm sur le tableau de bord (domaine digdash_dashbord) ne l'activera pas automatiquement sur le Studio Web (domaine studio) par exemple.
311 )))
312
313 == Ré-activation du mode OpenID Connect ==
314
315 Pour désactiver le mode LDAP DigDash et ainsi retourner à un état où c'est l'authentification SSO OpenID Connect qui est prise en compte, il suffit de mentionner le paramètre **loginForm **avec la valeur (% style="color:#c0392b" %)**false**(%%).
316 Ainsi, s'il y a besoin de s'authentifier au tableau de bord via OpenID Connect alors qu'une authentification directe via le LDAP DigDash a précédemment eu lieu, l'URL à utiliser sera de la forme :
317
318 (% class="box" %)
319 (((
320 https:~/~/<host>:<port>/digdash_dashboard/index.html?**loginForm**=(% style="color:#c0392b" %)**false**
321 )))
322
323 La note d'avertissement précédente est également à prendre en compte dans ce cas.
324
325
326 {{warning}}
327 Pour passer d'un mode d'authentification à l'autre, il est fortement conseillé de suivre l'une des règles suivantes :
328
329 * se déconnecter de l'utilisateur courant dans le cadre d'une utilisation d'une même session navigateur
330 * utiliser une session navigateur différente (soit en navigation privée sur un même navigateur ou basculer sur un navigateur différent)
331 {{/warning}}
332
333 = Lexique =
334
335 Nous appellerons dans ce document :
336
337 * **Endpoint **: Point d’entrée
338 * **OP **: OpenID Provider ou le Fournisseur d’identités
339 * **RP **: Relying Party ou le Fournisseur de services (DigDash)
340 * **SSO **: Single Sign On ou Authentification unique ; OpenIDConnect est une méthode SSO
341
342 = Références =
343
344 https://www.oasis-open.org
345
346 //DigDash utilise la librairie OpenSource tomcat8-oidcauth de Boyle Software, Inc. pour supporter la méthode d’authentification OpenID Connect.//
347
348 https://www.boylesoftware.com/
349
350 https://github.com/boylesoftware/tomcat8-oidcauth