Modifié par Aurelie Bertrand le 2025/02/17 17:16
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é à **/etc/tomcat9/** sous Linux et **C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf **sous Windows
14 *** Le sous-dossier lib : librairies et fichier de configuration des logs à placer dans :
15 **** sous Linux : **/usr/share/tomcat9/lib/**
16 **** sous Windows : **C:\Program Files\Apache Software Foundation\Tomcat 9.0\lib**
17 *** Le sous-dossier webapps : le point d’entrée DigDash (endpoint) dans un .war à placer dans:
18 **** sous Linux : **/home/digdash/webapps/default**
19 **** sous Windows : **E:/digdash/webapps/default**
20 * Les manipulations suivantes sont à réaliser le serveur DigDash **stoppé**.
21 * L’utilisateur à authentifier doit exister à la fois chez l’OP et dans le LDAP DigDash.
22
23 (% class="box warningmessage" %)
24 (((
25 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.
26 )))
27
28 = Configuration du serveur DigDash =
29
30 == Copie des librairies ==
31
32 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 :
33
34 (% class="box" %)
35 (((
36 * sous Linux : **/usr/share/tomcat9/lib/**
37 * sous Windows : **C:\Program Files\Apache Software Foundation\Tomcat 9.0\lib**
38 )))
39
40 Fichiers à copier :
41
42 |oidc-valve.jar|log4j-api-2.19.0.jar
43 |slf4j-api-2.0.6.jar|log4j-1.2-api-2.19.0.jar
44 |log4j-slf4j-impl-2.19.0.jar|log4j2.properties
45 |log4j-core-2.19.0.jar|
46
47 == Ajout de la valve d’authentification OpenID Connect ==
48
49 Activez la valve d’authentification OpenID Connect dans le fichier **server.xml** situé dans le dossier :
50
51 (% class="box" %)
52 (((
53 * sous Linux : **/etc/tomcat9/**
54 * sous Windows : **C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf**
55 )))
56
57 Pour cela, cherchez l’élément **<Host ...>** dans le fichier, décommentez ou y rajoutez l’élément **<Valve ...>** ci-dessous :
58
59 (((
60 {{code cssClass="notranslate" language="xml"}}
61 <Valve
62 className="org.bsworks.catalina.authenticator.oidc.OpenIDConnectSSOValve"
63 allowAddr="localhost,127.0.0.*,0:0:0:0:0:0:0:1"
64 fallbackAuth="ldap"
65 sharedPasswd="secret"
66 redirect_url="https://localhost:8443/digdash_oidc_endpoint/oidcendpoint"
67 providers="[
68 {
69 name: OpenID Provider name,
70 issuer: issuer,
71 clientId: clientId,
72 clientSecret: clientSecret
73 }
74 ]"
75 usernameClaim="email"
76 additionalScopes="email"
77 cookieTimeOut="-1"
78 ></Valve>
79 {{/code}}
80
81 La valeur de l'attribut className est invariable.
82 Les valeurs des attributs allowAddr, sharedPasswd, redirect_url, providers, usernameClaim, additionalScopes sont variables selon l'installation.
83
84 (% class="box infomessage" %)
85 (((
86 💡 L'attribut **cookieTimeOut** est facultatif et peut prendre différentes valeurs comme décrit ci-dessous.
87 Cependant, il est recommandé d'utiliser //cookieTimeOut="-1"  .//
88 )))
89 )))
90
91 |(% style="width:216px" %)**Attributs**|(% style="width:1204px" %)**Description**
92 |(% 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.
93 |(% style="color:#27ae60; width:216px" %)(% style="color:#000000" %)allowAddr //(obligatoire)//   (%%) |(% style="width:1204px" %)Adresse IP du serveur.
94 |(% style="color:#27ae60; width:216px" %)(% style="color:#000000" %)fallbackAuth //(obligatoire)//|(% style="width:1204px" %)La méthode d'authentification de repli.
95 |(% style="width:216px" %)sharedPasswd //(obligatoire)//     |(% style="width:1204px" %)Le mot de passe partagé et vérifié à l’authentification (voir point II.5)
96 |(% style="width:216px" %)redirect_url //(obligatoire)//     |(% style="width:1204px" %)(((
97 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}}}
98
99 {{{ou}}}
100 La valeur peut être "{{{/digdash_oidc_endpoint/oidcendpoint}}}" ; dans ce cas là, l'adresse DigDash sera calculée selon l'adresse courante.
101 )))
102 |(% style="width:216px" %)cookieTimeOut //(facultatif)//     |(% style="width:1204px" %)(((
103 Facultatif, il s’agit du temps (en secondes) au bout duquel le cookie SSO expirera. Vaut 1800 secondes (30 minutes) par défaut .
104 Sinon, le cookie expirera après le nombre de secondes mentionné.
105
106 La mention d'une valeur négative signifie que le cookie expirera à la fermeture du navigateur.
107 La mention d'une valeur égale à 0 signifie que le cookie sera directement supprimé (non recommandé).
108
109 Exemple : cookieTimeOut="3600" (1 heure)
110 )))
111 |(% 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.
112 |(% style="width:216px" %)providers //(obligatoire)//     |(% style="width:1204px" %)(((
113 Valeur de forme tableau d’objets en JSON. Chaque élément correspond à un OpenID Provider utilisé par l’application.
114
115 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 :
116
117 - **issuer **//(obligatoire) //: Il s’agit d’une URL unique pour identifier l’OP.    
118
119 - **name** //(facultatif) //: Un nom associé à l’OP ; l’issuer sinon par défaut.
120
121 (((
122 - **clientId **//(obligatoire) : //Le client ID associé à l’application chez l’OP.
123
124 - **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.
125
126 - **usernameClaim **//(facultatif) : //L’attribut user Identifier réclamé par le RP et renvoyé par l’OP pour identifier l’utilisateur qui s’authentifie.
127
128 - **additionalScopes **//(facultatif) //: Les scopes additionnels au scope ‘openid’ séparés par des espaces.
129 )))
130 )))
131 |(% 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.
132 |(% 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.
133 |(% 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.
134 |(% style="width:216px" %)ldapForPaths //(facultatif)//     |(% style="width:1204px" %)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/.*"
135 |excludedPaths// (facultatif)// |Il s’agit des expressions régulières des chemins dont les ressources sont autorisées à passer la valve, passant ainsi en mode d’authentification LDAP. Exemple : "/.*"
136
137 == Ajout du .war correspondant au point d’entrée du Relying Party ==
138
139 Ajoutez l’archive **digdash_oidc_endpoint.war** du dossier **<install DD>/add-ons/valve_openidconnect/apache-tomcat/webapps** dans le dossier :
140
141 (% class="box" %)
142 (((
143 * sous Linux : **/home/digdash/webapps/default**
144 * sous Windows : **E:/digdash/webapps/default**
145 )))
146
147 (% class="box infomessage" %)
148 (((
149 Il s’agit du point d’entrée (endpoint) du RP accédé par l’OP.
150 )))
151
152 == Ajout des contraintes de sécurité ==
153
154 Décommentez ou ajoutez les contraintes de sécurité au fichier **web.xml** situé dans le dossier :
155
156 (% class="box" %)
157 (((
158 * sous Linux : **/etc/tomcat9/**
159 * sous Windows : **C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf**
160 )))
161
162 {{code language="xml" cssClass="notranslate"}}
163 <web-app ...>
164 ...
165 <security-role>
166 <role-name>CUSTOM</role-name>
167 </security-role>
168
169 <security-constraint>
170 <display-name>CUSTOM Security Constraint</display-name>
171 <web-resource-collection>
172 <web-resource-name>Protected Area</web-resource-name>
173 <url-pattern>/*</url-pattern>
174 </web-resource-collection>
175
176 <auth-constraint>
177 <role-name>CUSTOM</role-name>
178 </auth-constraint>
179 </security-constraint>
180
181 <security-constraint>
182 <web-resource-collection>
183 <web-resource-name>Non-Protected Area</web-resource-name>
184 <url-pattern>/vjdbc</url-pattern>
185 </web-resource-collection>
186 </security-constraint>
187 ...
188 </web-app>
189 {{/code}}
190
191 (((
192
193 )))
194
195 = Configuration des applications =
196
197 Pour cela, modifiez le fichier **digdash.properties** dans **<install DD> **ou** /etc/digdash** (sous Linux) ou dans le dossier que vous auriez configuré.
198
199
200 == Configuration du Serveur (ddenterprise.war) ==
201
202 Dans le fichier **digdash.properties** :
203
204 Dans l'encadré //ddenterpriseapi.war//, recherchez et décommentez les lignes suivantes avec les valeurs indiquées :
205
206 {{code language="properties" cssClass="notranslate"}}
207 ddenterpriseapi.authMethod=External
208 {{/code}}
209
210
211 == Configuration du Tableau de bord (digdash_dashboard.war) ==
212
213 Dans le fichier **digdash.properties** :
214
215 Dans l'encadré //digdash_dashbord.war//, recherchez et décommentez les lignes suivantes avec les valeurs indiquées :
216
217 {{code language="properties" cssClass="notranslate"}}
218 digdash_dashboard.SERVERURL=http://localhost:8080
219 digdash_dashboard.DOMAIN=ddenterpriseapi
220 digdash_dashboard.FORCEDOMAIN=true
221 digdash_dashboard.FORCESERVERURL=true
222 digdash_dashboard.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 //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.
228 )))
229
230 == Configuration du Studio (studio.war) ==
231
232 Dans le fichier **digdash.properties** :
233
234 Dans l'encadré //studio.war//, recherchez et décommentez les lignes suivantes avec les valeurs indiquées :
235
236 {{code cssClass="notranslate" language="properties"}}
237 studio.SERVERURL=http://localhost:8080
238 studio.DOMAIN=ddenterpriseapi
239 studio.FORCEDOMAIN=true
240 studio.FORCESERVERURL=true
241 studio.PUBLICSERVERURL=<votre adresse URL publique en HTTPS>
242 studio.sharedPasswd=<la valeur de l'attribut sharedPasswd dans l'élément Valve>
243 {{/code}}
244
245 (% class="box infomessage" %)
246 (((
247 Le paramètre //studio.PUBLICSERVERURL// est optionnel dans le cadre de l'installation d'un SSO.
248
249 La valeur d’exemple pour ce paramètre 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.
250 )))
251
252 = Configuration de l’OpenID Provider =
253
254 L’OP devra enregistrer DigDash en tant que RP dans sa liste de RP pour que DigDash puisse tirer profit de l’Authentification unique.
255
256 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
257
258 (% class="box infomessage" %)
259 (((
260 https:~/~/<adresse du serveur DigDash>:<port>/digdash_oidc_endpoint/oidcendpoint
261 )))
262
263 = Niveau de Logs =
264
265 Vous pouvez personnaliser le niveau de log pour la valve d’authentification.
266
267 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.
268
269 log4j.logger.org.bsworks=**ERROR**, stdout
270 devient
271 log4j.logger.org.bsworks=**DEBUG**, stdout
272
273 = Cohabitation OpenID Connect et LDAP DigDash (facultatif) =
274
275 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.
276
277 == Configuration préalable ==
278
279 Dans le fichier **digdash.properties** :
280
281 Dans l'encadré //studio.war//, recherchez et décommentez les lignes suivantes avec les valeurs indiquées :
282
283 {{code language="properties" cssClass="notranslate"}}
284 studio.allowLoginForm=true
285 {{/code}}
286
287 Dans l'encadré //digdash_dashbord.war//, recherchez et décommentez les lignes suivantes avec les valeurs indiquées :
288
289 {{code language="properties" cssClass="notranslate"}}
290 digdash_dashboard.allowLoginForm=true
291 {{/code}}
292
293 == Activation du mode LDAP DigDash ==
294
295 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**(%%).
296
297 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 :
298
299 (% class="box" %)
300 (((
301 https:~/~/<host>:<port>/digdash_dashboard/index.html?**loginForm**=(% style="color:#27ae60" %)**true**
302 )))
303
304 (% class="box warningmessage" %)
305 (((
306 (% 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.
307 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.
308 )))
309
310 == Ré-activation du mode OpenID Connect ==
311
312 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**(%%).
313 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 :
314
315 (% class="box" %)
316 (((
317 https:~/~/<host>:<port>/digdash_dashboard/index.html?**loginForm**=(% style="color:#c0392b" %)**false**
318 )))
319
320 La note d'avertissement précédente est également à prendre en compte dans ce cas.
321
322
323 {{warning}}
324 Pour passer d'un mode d'authentification à l'autre, il est fortement conseillé de suivre l'une des règles suivantes :
325
326 * se déconnecter de l'utilisateur courant dans le cadre d'une utilisation d'une même session navigateur
327 * utiliser une session navigateur différente (soit en navigation privée sur un même navigateur ou basculer sur un navigateur différent)
328 {{/warning}}
329
330 = Lexique =
331
332 Nous appellerons dans ce document :
333
334 * **Endpoint **: Point d’entrée
335 * **OP **: OpenID Provider ou le Fournisseur d’identités
336 * **RP **: Relying Party ou le Fournisseur de services (DigDash)
337 * **SSO **: Single Sign On ou Authentification unique ; OpenIDConnect est une méthode SSO
338
339 = Références =
340
341 https://www.oasis-open.org
342
343 //DigDash utilise la librairie OpenSource tomcat8-oidcauth de Boyle Software, Inc. pour supporter la méthode d’authentification OpenID Connect.//
344
345 https://www.boylesoftware.com/
346
347 https://github.com/boylesoftware/tomcat8-oidcauth