Wiki source code of Authentification par Custom Header
Last modified by Aurelie Bertrand on 2026/01/12 16:46
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
6.1 | 1 | {{ddtoc/}} |
| 2 | |||
| 3 | |||
| |
2.1 | 4 | ---- |
| 5 | |||
| |
11.1 | 6 | This document describes how to set up the authentication method passing a custom header in requests to DigDash Enterprise. |
| 7 | The value of the custom header will be the remote user. | ||
| |
2.1 | 8 | |
| |
11.1 | 9 | This document describes the file to modify to enable this authentication. |
| |
2.1 | 10 | |
| |
11.1 | 11 | = Configuration of DigDash applications = |
| |
2.1 | 12 | |
| |
3.1 | 13 | (% class="wikigeneratedid" id="Hdigdash.properties" %) |
| |
11.1 | 14 | All DigDash Enterprise applications are configured via a single file: **digdash.properties**. |
| |
2.1 | 15 | |
| |
11.1 | 16 | The use of this file is described here: [[Externalization of parameters in a //properties// file>>doc:Digdash.deployment.configuration.advanced_system_guide.other_advanced_parameters.WebHome||anchor="externalisation"]] |
| |
2.1 | 17 | |
| |
11.1 | 18 | In everything that follows, the default application names will be used. If you have renamed certain war files you will need to modify the digdash.properties file accordingly. |
| |
2.1 | 19 | |
| |
11.1 | 20 | == Server (ddenterpriseapi.war) == |
| |
2.1 | 21 | |
| |
11.1 | 22 | Find the definition of the **authMethod** parameter (uncomment the line by deleting the **#** character at the beginning of the line) and change its value to **Custom :** |
| |
2.1 | 23 | |
| |
8.1 | 24 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 25 | ddenterpriseapi.authMethod=Custom |
| 26 | {{/code}} | ||
| |
2.1 | 27 | |
| |
11.1 | 28 | (% id="cke_bm_482S" style="display:none" %)Look for (%%)the definition of the **Custom_idParameter **parameter and change its value according to the name of your header**:** |
| |
2.1 | 29 | |
| |
8.1 | 30 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 31 | ddenterpriseapi.Custom_idParameter=sm_universalid |
| |
2.1 | 32 | {{/code}} |
| 33 | |||
| 34 | |||
| 35 | |||
| |
11.1 | 36 | (% id="cke_bm_808S" style="display:none" %)Find (%%)the definition of the **digdash_dashboard.sharedPasswd** parameter. |
| 37 | Change the password value (all applications using this same parameter must use the same value). | ||
| 38 | |||
| |
8.1 | 39 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 40 | ddenterpriseapi.sharedPasswd=SecretPwdToChange |
| |
2.1 | 41 | {{/code}} |
| 42 | |||
| 43 | (% class="box warningmessage" %) | ||
| 44 | ((( | ||
| |
11.1 | 45 | The password specified must be identical to the one you set in the other applications. |
| |
2.1 | 46 | ))) |
| 47 | |||
| |
11.1 | 48 | == Dashboard (digdash_dashboard.war) == |
| |
2.1 | 49 | |
| |
11.1 | 50 | (% id="cke_bm_415S" style="display:none" %)Find (%%)the definition of the **authMethod** parameter and change its value to **Custom :** |
| |
2.1 | 51 | |
| |
8.1 | 52 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 53 | digdash_dashboard.authMethod=Custom |
| 54 | {{/code}} | ||
| |
2.1 | 55 | |
| |
11.1 | 56 | (% id="cke_bm_814S" style="display:none" %)Look for (%%)the definition of the **Custom_idParameter **parameter and change its value according to the name of your header**:** |
| |
2.1 | 57 | |
| |
8.1 | 58 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 59 | digdash_dashboard.Custom_idParameter=sm_universalid |
| |
2.1 | 60 | {{/code}} |
| 61 | |||
| |
11.1 | 62 | (% id="cke_bm_553S" style="display:none" %)Look for (%%)the definition of the **digdash_dashboard.sharedPasswd** parameter. |
| 63 | Change the password value (all applications using this same parameter must use the same value). | ||
| |
2.1 | 64 | |
| |
8.1 | 65 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 66 | digdash_dashboard.sharedPasswd=SecretPwdToChange |
| 67 | {{/code}} | ||
| 68 | |||
| 69 | (% class="box warningmessage" %) | ||
| 70 | ((( | ||
| |
11.1 | 71 | The password specified must be identical to the one you set in the other applications. |
| |
2.1 | 72 | ))) |
| 73 | |||
| 74 | (% class="wikigeneratedid" id="HParamE8tresrecommandE9spourleloginautomatiquedutableaudebord" %) | ||
| |
11.1 | 75 | __Recommended settings for automatic dashboard login__: |
| |
2.1 | 76 | |
| |
11.1 | 77 | It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode. |
| |
2.1 | 78 | |
| |
11.1 | 79 | Specify (and force) the DigDash Enterprise domain: |
| |
2.1 | 80 | |
| |
8.1 | 81 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 82 | digdash_dashboard.DOMAIN=ddenterpriseapi |
| 83 | digdash_dashboard.FORCEDOMAIN=true | ||
| 84 | |||
| 85 | {{/code}} | ||
| 86 | |||
| |
11.1 | 87 | Specify (and force) the server URL of the DigDash Enterprise domain. |
| 88 | Use the //localhost// address if the ddenterpriseapi web application is installed on the same Tomcat as the digdash_dashboard web application. | ||
| 89 | Adapt the port if necessary: | ||
| |
2.1 | 90 | |
| |
8.1 | 91 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 92 | digdash_dashboard.SERVERURL=http://localhost:8080 |
| 93 | digdash_dashboard.FORCESERVERURL=true | ||
| 94 | {{/code}} | ||
| 95 | |||
| |
11.1 | 96 | Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page: |
| |
2.1 | 97 | |
| |
8.1 | 98 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 99 | digdash_dashboard.urlLogout=/adminconsole |
| 100 | {{/code}} | ||
| 101 | |||
| 102 | |||
| 103 | (% class="box warningmessage" %) | ||
| 104 | ((( | ||
| |
11.1 | 105 | By default, logging out of the dashboard returns to the dashboard login page. This page does not exist in the SSO context. |
| 106 | It is important to specify a return URL in the event of disconnection. | ||
| |
2.1 | 107 | ))) |
| 108 | |||
| |
11.1 | 109 | See the documentation [[Advanced system settings>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] documentation for more details on these settings. |
| |
2.1 | 110 | |
| |
9.1 | 111 | == Studio (studio.war) == |
| |
2.1 | 112 | |
| 113 | |||
| 114 | |||
| |
3.1 | 115 | |
| |
11.1 | 116 | |
| 117 | Find the definition of the **authMethod** parameter and change its value to **Custom :** | ||
| 118 | |||
| |
8.1 | 119 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 120 | studio.authMethod=Custom |
| |
2.1 | 121 | {{/code}} |
| 122 | |||
| |
11.1 | 123 | (% id="cke_bm_814S" style="display:none" %)Look for (%%)the definition of the **Custom_idParameter **parameter and change its value according to the name of your header**:** |
| |
3.1 | 124 | |
| |
8.1 | 125 | {{code language="properties" cssClass="notranslate"}} |
| |
3.1 | 126 | studio.Custom_idParameter=sm_universalid |
| 127 | {{/code}} | ||
| 128 | |||
| |
11.1 | 129 | (% id="cke_bm_553S" style="display:none" %)Look for (%%)the definition of the **digdash_dashboard.sharedPasswd** parameter. |
| 130 | Change the password value (all applications using this same parameter must use the same value). | ||
| |
2.1 | 131 | |
| |
8.1 | 132 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 133 | studio.sharedPasswd=SecretPwdToChange |
| 134 | {{/code}} | ||
| 135 | |||
| 136 | (% class="box warningmessage" %) | ||
| 137 | ((( | ||
| |
11.1 | 138 | The password specified must be identical to the one you set in the other applications. |
| |
2.1 | 139 | ))) |
| 140 | |||
| 141 | |||
| |
11.1 | 142 | __Recommended settings for automatic Studio login__: |
| |
2.1 | 143 | |
| |
11.1 | 144 | It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode. |
| |
2.1 | 145 | |
| |
11.1 | 146 | Specify (and force) the DigDash Enterprise domain: |
| |
2.1 | 147 | |
| |
8.1 | 148 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 149 | studio.FORCEDOMAIN=true |
| 150 | studio.DOMAIN=ddenterpriseapi | ||
| 151 | {{/code}} | ||
| 152 | |||
| |
11.1 | 153 | Specify (and force) the server URL of the DigDash Enterprise domain. |
| 154 | Use the **//localhost//** address if the **ddenterpriseapi** web application is installed on the same Tomcat as the **studio** application. | ||
| 155 | Adapt the port if necessary: | ||
| |
2.1 | 156 | |
| |
8.1 | 157 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 158 | studio.FORCESERVERURL=true |
| 159 | studio.SERVERURL=http://localhost:8080 | ||
| 160 | {{/code}} | ||
| 161 | |||
| |
11.1 | 162 | Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page: |
| |
2.1 | 163 | |
| |
8.1 | 164 | {{code language="properties" cssClass="notranslate"}} |
| |
2.1 | 165 | studio.urlLogout=/adminconsole |
| 166 | {{/code}} | ||
| 167 | |||
| |
11.1 | 168 | By default logging out of the Studio returns to the Studio login page. This page does not exist in the SSO context. |
| 169 | It is important to specify a return URL in the event of disconnection.sktop Studio (adminconsole.war(% id="cke_bm_492S" style="display:none" %) ) |