Wiki source code of Authentification par Custom Header
Last modified by Aurelie Bertrand on 2026/01/12 16:46
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{ddtoc/}} | ||
| 2 | |||
| 3 | |||
| 4 | ---- | ||
| 5 | |||
| 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. | ||
| 8 | |||
| 9 | This document describes the file to modify to enable this authentication. | ||
| 10 | |||
| 11 | = Configuration of DigDash applications = | ||
| 12 | |||
| 13 | (% class="wikigeneratedid" id="Hdigdash.properties" %) | ||
| 14 | All DigDash Enterprise applications are configured via a single file: **digdash.properties**. | ||
| 15 | |||
| 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"]] | ||
| 17 | |||
| 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. | ||
| 19 | |||
| 20 | == Server (ddenterpriseapi.war) == | ||
| 21 | |||
| 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 :** | ||
| 23 | |||
| 24 | {{code language="properties" cssClass="notranslate"}} | ||
| 25 | ddenterpriseapi.authMethod=Custom | ||
| 26 | {{/code}} | ||
| 27 | |||
| 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**:** | ||
| 29 | |||
| 30 | {{code language="properties" cssClass="notranslate"}} | ||
| 31 | ddenterpriseapi.Custom_idParameter=sm_universalid | ||
| 32 | {{/code}} | ||
| 33 | |||
| 34 | |||
| 35 | |||
| 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 | |||
| 39 | {{code language="properties" cssClass="notranslate"}} | ||
| 40 | ddenterpriseapi.sharedPasswd=SecretPwdToChange | ||
| 41 | {{/code}} | ||
| 42 | |||
| 43 | (% class="box warningmessage" %) | ||
| 44 | ((( | ||
| 45 | The password specified must be identical to the one you set in the other applications. | ||
| 46 | ))) | ||
| 47 | |||
| 48 | == Dashboard (digdash_dashboard.war) == | ||
| 49 | |||
| 50 | (% id="cke_bm_415S" style="display:none" %)Find (%%)the definition of the **authMethod** parameter and change its value to **Custom :** | ||
| 51 | |||
| 52 | {{code language="properties" cssClass="notranslate"}} | ||
| 53 | digdash_dashboard.authMethod=Custom | ||
| 54 | {{/code}} | ||
| 55 | |||
| 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**:** | ||
| 57 | |||
| 58 | {{code language="properties" cssClass="notranslate"}} | ||
| 59 | digdash_dashboard.Custom_idParameter=sm_universalid | ||
| 60 | {{/code}} | ||
| 61 | |||
| 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). | ||
| 64 | |||
| 65 | {{code language="properties" cssClass="notranslate"}} | ||
| 66 | digdash_dashboard.sharedPasswd=SecretPwdToChange | ||
| 67 | {{/code}} | ||
| 68 | |||
| 69 | (% class="box warningmessage" %) | ||
| 70 | ((( | ||
| 71 | The password specified must be identical to the one you set in the other applications. | ||
| 72 | ))) | ||
| 73 | |||
| 74 | (% class="wikigeneratedid" id="HParamE8tresrecommandE9spourleloginautomatiquedutableaudebord" %) | ||
| 75 | __Recommended settings for automatic dashboard login__: | ||
| 76 | |||
| 77 | It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode. | ||
| 78 | |||
| 79 | Specify (and force) the DigDash Enterprise domain: | ||
| 80 | |||
| 81 | {{code language="properties" cssClass="notranslate"}} | ||
| 82 | digdash_dashboard.DOMAIN=ddenterpriseapi | ||
| 83 | digdash_dashboard.FORCEDOMAIN=true | ||
| 84 | |||
| 85 | {{/code}} | ||
| 86 | |||
| 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: | ||
| 90 | |||
| 91 | {{code language="properties" cssClass="notranslate"}} | ||
| 92 | digdash_dashboard.SERVERURL=http://localhost:8080 | ||
| 93 | digdash_dashboard.FORCESERVERURL=true | ||
| 94 | {{/code}} | ||
| 95 | |||
| 96 | Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page: | ||
| 97 | |||
| 98 | {{code language="properties" cssClass="notranslate"}} | ||
| 99 | digdash_dashboard.urlLogout=/adminconsole | ||
| 100 | {{/code}} | ||
| 101 | |||
| 102 | |||
| 103 | (% class="box warningmessage" %) | ||
| 104 | ((( | ||
| 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. | ||
| 107 | ))) | ||
| 108 | |||
| 109 | See the documentation [[Advanced system settings>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]] documentation for more details on these settings. | ||
| 110 | |||
| 111 | == Studio (studio.war) == | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | Find the definition of the **authMethod** parameter and change its value to **Custom :** | ||
| 118 | |||
| 119 | {{code language="properties" cssClass="notranslate"}} | ||
| 120 | studio.authMethod=Custom | ||
| 121 | {{/code}} | ||
| 122 | |||
| 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**:** | ||
| 124 | |||
| 125 | {{code language="properties" cssClass="notranslate"}} | ||
| 126 | studio.Custom_idParameter=sm_universalid | ||
| 127 | {{/code}} | ||
| 128 | |||
| 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). | ||
| 131 | |||
| 132 | {{code language="properties" cssClass="notranslate"}} | ||
| 133 | studio.sharedPasswd=SecretPwdToChange | ||
| 134 | {{/code}} | ||
| 135 | |||
| 136 | (% class="box warningmessage" %) | ||
| 137 | ((( | ||
| 138 | The password specified must be identical to the one you set in the other applications. | ||
| 139 | ))) | ||
| 140 | |||
| 141 | |||
| 142 | __Recommended settings for automatic Studio login__: | ||
| 143 | |||
| 144 | It is recommended that you configure the following settings when deploying in Integrated Windows Security (Waffle) mode. | ||
| 145 | |||
| 146 | Specify (and force) the DigDash Enterprise domain: | ||
| 147 | |||
| 148 | {{code language="properties" cssClass="notranslate"}} | ||
| 149 | studio.FORCEDOMAIN=true | ||
| 150 | studio.DOMAIN=ddenterpriseapi | ||
| 151 | {{/code}} | ||
| 152 | |||
| 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: | ||
| 156 | |||
| 157 | {{code language="properties" cssClass="notranslate"}} | ||
| 158 | studio.FORCESERVERURL=true | ||
| 159 | studio.SERVERURL=http://localhost:8080 | ||
| 160 | {{/code}} | ||
| 161 | |||
| 162 | Specify a logout URL so that the user can log out of DigDash Enterprise and, for example, return to an Intranet page: | ||
| 163 | |||
| 164 | {{code language="properties" cssClass="notranslate"}} | ||
| 165 | studio.urlLogout=/adminconsole | ||
| 166 | {{/code}} | ||
| 167 | |||
| 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" %) ) |