SamlSecuritySettingContents.jsx 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  1. /* eslint-disable react/no-danger */
  2. import React from 'react';
  3. import PropTypes from 'prop-types';
  4. import { withTranslation } from 'react-i18next';
  5. import { withUnstatedContainers } from '../../UnstatedUtils';
  6. import { toastSuccess, toastError } from '~/client/util/apiNotification';
  7. import AppContainer from '~/client/services/AppContainer';
  8. import AdminGeneralSecurityContainer from '~/client/services/AdminGeneralSecurityContainer';
  9. import AdminSamlSecurityContainer from '~/client/services/AdminSamlSecurityContainer';
  10. class SamlSecurityManagementContents extends React.Component {
  11. constructor(props) {
  12. super(props);
  13. this.onClickSubmit = this.onClickSubmit.bind(this);
  14. }
  15. async onClickSubmit() {
  16. const { t, adminSamlSecurityContainer, adminGeneralSecurityContainer } = this.props;
  17. try {
  18. await adminSamlSecurityContainer.updateSamlSetting();
  19. await adminGeneralSecurityContainer.retrieveSetupStratedies();
  20. toastSuccess(t('security_setting.SAML.updated_saml'));
  21. }
  22. catch (err) {
  23. toastError(err);
  24. }
  25. }
  26. render() {
  27. const { t, adminGeneralSecurityContainer, adminSamlSecurityContainer } = this.props;
  28. const { useOnlyEnvVars } = adminSamlSecurityContainer.state;
  29. const { isSamlEnabled } = adminGeneralSecurityContainer.state;
  30. return (
  31. <React.Fragment>
  32. <h2 className="alert-anchor border-bottom">
  33. {t('security_setting.SAML.name')}
  34. </h2>
  35. {useOnlyEnvVars && (
  36. <p
  37. className="alert alert-info"
  38. dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.note for the only env option', { env: 'SAML_USES_ONLY_ENV_VARS_FOR_SOME_OPTIONS' }) }}
  39. />
  40. )}
  41. <div className="row form-group mb-5">
  42. <div className="col-6 offset-3">
  43. <div className="custom-control custom-switch custom-checkbox-success">
  44. <input
  45. id="isSamlEnabled"
  46. className="custom-control-input"
  47. type="checkbox"
  48. checked={adminGeneralSecurityContainer.state.isSamlEnabled}
  49. onChange={() => { adminGeneralSecurityContainer.switchIsSamlEnabled() }}
  50. disabled={adminSamlSecurityContainer.state.useOnlyEnvVars}
  51. />
  52. <label className="custom-control-label" htmlFor="isSamlEnabled">
  53. {t('security_setting.SAML.enable_saml')}
  54. </label>
  55. </div>
  56. {(!adminGeneralSecurityContainer.state.setupStrategies.includes('saml') && isSamlEnabled)
  57. && <div className="badge badge-warning">{t('security_setting.setup_is_not_yet_complete')}</div>}
  58. </div>
  59. </div>
  60. <div className="row form-group mb-5">
  61. <label className="text-left text-md-right col-md-3 col-form-label">{t('security_setting.callback_URL')}</label>
  62. <div className="col-md-6">
  63. <input
  64. className="form-control"
  65. type="text"
  66. defaultValue={adminSamlSecurityContainer.state.callbackUrl}
  67. readOnly
  68. />
  69. <p className="form-text text-muted small">{t('security_setting.desc_of_callback_URL', { AuthName: 'SAML Identity' })}</p>
  70. {!adminGeneralSecurityContainer.state.appSiteUrl && (
  71. <div className="alert alert-danger">
  72. <i
  73. className="icon-exclamation"
  74. // eslint-disable-next-line max-len
  75. dangerouslySetInnerHTML={{ __html: t('security_setting.alert_siteUrl_is_not_set', { link: `<a href="/admin/app">${t('App Settings')}<i class="icon-login"></i></a>` }) }}
  76. />
  77. </div>
  78. )}
  79. </div>
  80. </div>
  81. {isSamlEnabled && (
  82. <React.Fragment>
  83. {(adminSamlSecurityContainer.state.missingMandatoryConfigKeys.length !== 0) && (
  84. <div className="alert alert-danger">
  85. {t('security_setting.missing mandatory configs')}
  86. <ul>
  87. {adminSamlSecurityContainer.state.missingMandatoryConfigKeys.map((configKey) => {
  88. const key = configKey.replace('security:passport-saml:', '');
  89. return <li key={configKey}>{t(`security_setting.form_item_name.${key}`)}</li>;
  90. })}
  91. </ul>
  92. </div>
  93. )}
  94. <h3 className="alert-anchor border-bottom">
  95. Basic Settings
  96. </h3>
  97. <table className={`table settings-table ${adminSamlSecurityContainer.state.useOnlyEnvVars && 'use-only-env-vars'}`}>
  98. <colgroup>
  99. <col className="item-name" />
  100. <col className="from-db" />
  101. <col className="from-env-vars" />
  102. </colgroup>
  103. <thead>
  104. <tr><th></th><th>Database</th><th>Environment variables</th></tr>
  105. </thead>
  106. <tbody>
  107. <tr>
  108. <th>{t('security_setting.form_item_name.entryPoint')}</th>
  109. <td>
  110. <input
  111. className="form-control"
  112. type="text"
  113. name="samlEntryPoint"
  114. readOnly={useOnlyEnvVars}
  115. defaultValue={adminSamlSecurityContainer.state.samlEntryPoint}
  116. onChange={e => adminSamlSecurityContainer.changeSamlEntryPoint(e.target.value)}
  117. />
  118. </td>
  119. <td>
  120. <input
  121. className="form-control"
  122. type="text"
  123. value={adminSamlSecurityContainer.state.envEntryPoint || ''}
  124. readOnly
  125. />
  126. <p className="form-text text-muted">
  127. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ENTRY_POINT' }) }} />
  128. </p>
  129. </td>
  130. </tr>
  131. <tr>
  132. <th>{t('security_setting.form_item_name.issuer')}</th>
  133. <td>
  134. <input
  135. className="form-control"
  136. type="text"
  137. name="samlEnvVarissuer"
  138. readOnly={useOnlyEnvVars}
  139. defaultValue={adminSamlSecurityContainer.state.samlIssuer}
  140. onChange={e => adminSamlSecurityContainer.changeSamlIssuer(e.target.value)}
  141. />
  142. </td>
  143. <td>
  144. <input
  145. className="form-control"
  146. type="text"
  147. value={adminSamlSecurityContainer.state.envIssuer || ''}
  148. readOnly
  149. />
  150. <p className="form-text text-muted">
  151. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ISSUER' }) }} />
  152. </p>
  153. </td>
  154. </tr>
  155. <tr>
  156. <th>{t('security_setting.form_item_name.cert')}</th>
  157. <td>
  158. <textarea
  159. className="form-control form-control-sm"
  160. type="text"
  161. rows="5"
  162. name="samlCert"
  163. readOnly={useOnlyEnvVars}
  164. defaultValue={adminSamlSecurityContainer.state.samlCert}
  165. onChange={e => adminSamlSecurityContainer.changeSamlCert(e.target.value)}
  166. />
  167. <p>
  168. <small>
  169. {t('security_setting.SAML.cert_detail')}
  170. </small>
  171. </p>
  172. <div>
  173. <small>
  174. e.g.
  175. <pre className="well card">{`-----BEGIN CERTIFICATE-----
  176. MIICBzCCAXACCQD4US7+0A/b/zANBgkqhkiG9w0BAQsFADBIMQswCQYDVQQGEwJK
  177. UDEOMAwGA1UECAwFVG9reW8xFTATBgNVBAoMDFdFU0VFSywgSW5jLjESMBAGA1UE
  178. ...
  179. crmVwBzbloUO2l6k1ibwD2WVwpdxMKIF5z58HfKAvxZAzCHE7kMEZr1ge30WRXQA
  180. pWVdnzS1VCO8fKsJ7YYIr+JmHvseph3kFUOI5RqkCcMZlKUv83aUThsTHw==
  181. -----END CERTIFICATE-----
  182. `}
  183. </pre>
  184. </small>
  185. </div>
  186. </td>
  187. <td>
  188. <textarea
  189. className="form-control form-control-sm"
  190. type="text"
  191. rows="5"
  192. readOnly
  193. value={adminSamlSecurityContainer.state.envCert || ''}
  194. />
  195. <p className="form-text text-muted">
  196. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_CERT' }) }} />
  197. </p>
  198. </td>
  199. </tr>
  200. </tbody>
  201. </table>
  202. <h3 className="alert-anchor border-bottom">
  203. Attribute Mapping
  204. </h3>
  205. <table className={`table settings-table ${adminSamlSecurityContainer.state.useOnlyEnvVars && 'use-only-env-vars'}`}>
  206. <colgroup>
  207. <col className="item-name" />
  208. <col className="from-db" />
  209. <col className="from-env-vars" />
  210. </colgroup>
  211. <thead>
  212. <tr><th></th><th>Database</th><th>Environment variables</th></tr>
  213. </thead>
  214. <tbody>
  215. <tr>
  216. <th>{t('security_setting.form_item_name.attrMapId')}</th>
  217. <td>
  218. <input
  219. className="form-control"
  220. type="text"
  221. readOnly={useOnlyEnvVars}
  222. defaultValue={adminSamlSecurityContainer.state.samlAttrMapId}
  223. onChange={e => adminSamlSecurityContainer.changeSamlAttrMapId(e.target.value)}
  224. />
  225. <p className="form-text text-muted">
  226. <small>
  227. {t('security_setting.SAML.id_detail')}
  228. </small>
  229. </p>
  230. </td>
  231. <td>
  232. <input
  233. className="form-control"
  234. type="text"
  235. value={adminSamlSecurityContainer.state.envAttrMapId || ''}
  236. readOnly
  237. />
  238. <p className="form-text text-muted">
  239. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ATTR_MAPPING_ID' }) }} />
  240. </p>
  241. </td>
  242. </tr>
  243. <tr>
  244. <th>{t('security_setting.form_item_name.attrMapUsername')}</th>
  245. <td>
  246. <input
  247. className="form-control"
  248. type="text"
  249. readOnly={useOnlyEnvVars}
  250. defaultValue={adminSamlSecurityContainer.state.samlAttrMapUsername}
  251. onChange={e => adminSamlSecurityContainer.changeSamlAttrMapUserName(e.target.value)}
  252. />
  253. <p className="form-text text-muted">
  254. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.username_detail') }} />
  255. </p>
  256. </td>
  257. <td>
  258. <input
  259. className="form-control"
  260. type="text"
  261. value={adminSamlSecurityContainer.state.envAttrMapUsername || ''}
  262. readOnly
  263. />
  264. <p className="form-text text-muted">
  265. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ATTR_MAPPING_USERNAME' }) }} />
  266. </p>
  267. </td>
  268. </tr>
  269. <tr>
  270. <th>{t('security_setting.form_item_name.attrMapMail')}</th>
  271. <td>
  272. <input
  273. className="form-control"
  274. type="text"
  275. readOnly={useOnlyEnvVars}
  276. defaultValue={adminSamlSecurityContainer.state.samlAttrMapMail}
  277. onChange={e => adminSamlSecurityContainer.changeSamlAttrMapMail(e.target.value)}
  278. />
  279. <p className="form-text text-muted">
  280. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.mapping_detail', { target: 'Email' }) }} />
  281. </p>
  282. </td>
  283. <td>
  284. <input
  285. className="form-control"
  286. type="text"
  287. value={adminSamlSecurityContainer.state.envAttrMapMail || ''}
  288. readOnly
  289. />
  290. <p className="form-text text-muted">
  291. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ATTR_MAPPING_MAIL' }) }} />
  292. </p>
  293. </td>
  294. </tr>
  295. <tr>
  296. <th>{t('security_setting.form_item_name.attrMapFirstName')}</th>
  297. <td>
  298. <input
  299. className="form-control"
  300. type="text"
  301. readOnly={useOnlyEnvVars}
  302. defaultValue={adminSamlSecurityContainer.state.samlAttrMapFirstName}
  303. onChange={e => adminSamlSecurityContainer.changeSamlAttrMapFirstName(e.target.value)}
  304. />
  305. <p className="form-text text-muted">
  306. {/* eslint-disable-next-line max-len */}
  307. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.mapping_detail', { target: t('security_setting.form_item_name.attrMapFirstName') }) }} />
  308. </p>
  309. </td>
  310. <td>
  311. <input
  312. className="form-control"
  313. type="text"
  314. value={adminSamlSecurityContainer.state.envAttrMapFirstName || ''}
  315. readOnly
  316. />
  317. <p className="form-text text-muted">
  318. <small>
  319. <span dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ATTR_MAPPING_FIRST_NAME' }) }} />
  320. <br />
  321. <span dangerouslySetInnerHTML={{ __html: t('security_setting.Use default if both are empty', { target: 'firstName' }) }} />
  322. </small>
  323. </p>
  324. </td>
  325. </tr>
  326. <tr>
  327. <th>{t('security_setting.form_item_name.attrMapLastName')}</th>
  328. <td>
  329. <input
  330. className="form-control"
  331. type="text"
  332. readOnly={useOnlyEnvVars}
  333. defaultValue={adminSamlSecurityContainer.state.samlAttrMapLastName}
  334. onChange={e => adminSamlSecurityContainer.changeSamlAttrMapLastName(e.target.value)}
  335. />
  336. <p className="form-text text-muted">
  337. {/* eslint-disable-next-line max-len */}
  338. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.mapping_detail', { target: t('security_setting.form_item_name.attrMapLastName') }) }} />
  339. </p>
  340. </td>
  341. <td>
  342. <input
  343. className="form-control"
  344. type="text"
  345. value={adminSamlSecurityContainer.state.envAttrMapLastName || ''}
  346. readOnly
  347. />
  348. <p className="form-text text-muted">
  349. <small>
  350. <span dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ATTR_MAPPING_LAST_NAME' }) }} />
  351. <br />
  352. <span dangerouslySetInnerHTML={{ __html: t('security_setting.Use default if both are empty', { target: 'lastName' }) }} />
  353. </small>
  354. </p>
  355. </td>
  356. </tr>
  357. </tbody>
  358. </table>
  359. <h3 className="alert-anchor border-bottom">
  360. Attribute Mapping Options
  361. </h3>
  362. <div className="row form-group mb-5">
  363. <div className="offset-md-3 col-md-6 text-left">
  364. <div className="custom-control custom-checkbox custom-checkbox-success">
  365. <input
  366. id="bindByUserName-SAML"
  367. className="custom-control-input"
  368. type="checkbox"
  369. checked={adminSamlSecurityContainer.state.isSameUsernameTreatedAsIdenticalUser || false}
  370. onChange={() => { adminSamlSecurityContainer.switchIsSameUsernameTreatedAsIdenticalUser() }}
  371. />
  372. <label
  373. className="custom-control-label"
  374. htmlFor="bindByUserName-SAML"
  375. dangerouslySetInnerHTML={{ __html: t('security_setting.Treat username matching as identical') }}
  376. />
  377. </div>
  378. <p className="form-text text-muted">
  379. <small dangerouslySetInnerHTML={{ __html: t('security_setting.Treat username matching as identical_warn') }} />
  380. </p>
  381. </div>
  382. </div>
  383. <div className="row form-group mb-5">
  384. <div className="offset-md-3 col-md-6 text-left">
  385. <div className="custom-control custom-checkbox custom-checkbox-success">
  386. <input
  387. id="bindByEmail-SAML"
  388. className="custom-control-input"
  389. type="checkbox"
  390. checked={adminSamlSecurityContainer.state.isSameEmailTreatedAsIdenticalUser || false}
  391. onChange={() => { adminSamlSecurityContainer.switchIsSameEmailTreatedAsIdenticalUser() }}
  392. />
  393. <label
  394. className="custom-control-label"
  395. htmlFor="bindByEmail-SAML"
  396. dangerouslySetInnerHTML={{ __html: t('security_setting.Treat email matching as identical') }}
  397. />
  398. </div>
  399. <p className="form-text text-muted">
  400. <small dangerouslySetInnerHTML={{ __html: t('security_setting.Treat email matching as identical_warn') }} />
  401. </p>
  402. </div>
  403. </div>
  404. <h3 className="alert-anchor border-bottom">
  405. Attribute-based Login Control
  406. </h3>
  407. <p className="form-text text-muted">
  408. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.attr_based_login_control_detail') }} />
  409. </p>
  410. <table className={`table settings-table ${useOnlyEnvVars && 'use-only-env-vars'}`}>
  411. <colgroup>
  412. <col className="item-name" />
  413. <col className="from-db" />
  414. <col className="from-env-vars" />
  415. </colgroup>
  416. <thead>
  417. <tr><th></th><th>Database</th><th>Environment variables</th></tr>
  418. </thead>
  419. <tbody>
  420. <tr>
  421. <th>
  422. { t('security_setting.form_item_name.ABLCRule') }
  423. </th>
  424. <td>
  425. <input
  426. className="form-control"
  427. type="text"
  428. defaultValue={adminSamlSecurityContainer.state.samlABLCRule || ''}
  429. onChange={(e) => { adminSamlSecurityContainer.changeSamlABLCRule(e.target.value) }}
  430. readOnly={useOnlyEnvVars}
  431. />
  432. <p className="form-text text-muted">
  433. <small>
  434. <span dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.attr_based_login_control_rule_detail') }} />
  435. <span dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.attr_based_login_control_rule_example') }} />
  436. </small>
  437. </p>
  438. </td>
  439. <td>
  440. <input
  441. className="form-control"
  442. type="text"
  443. value={adminSamlSecurityContainer.state.envABLCRule || ''}
  444. readOnly
  445. />
  446. <p className="form-text text-muted">
  447. <small dangerouslySetInnerHTML={{ __html: t('security_setting.SAML.Use env var if empty', { env: 'SAML_ABLC_RULE' }) }} />
  448. </p>
  449. </td>
  450. </tr>
  451. </tbody>
  452. </table>
  453. <div className="row my-3">
  454. <div className="offset-3 col-5">
  455. <button
  456. type="button"
  457. className="btn btn-primary"
  458. disabled={adminSamlSecurityContainer.state.retrieveError != null}
  459. onClick={this.onClickSubmit}
  460. >
  461. {t('Update')}
  462. </button>
  463. </div>
  464. </div>
  465. </React.Fragment>
  466. )}
  467. </React.Fragment>
  468. );
  469. }
  470. }
  471. SamlSecurityManagementContents.propTypes = {
  472. t: PropTypes.func.isRequired, // i18next
  473. appContainer: PropTypes.instanceOf(AppContainer).isRequired,
  474. adminGeneralSecurityContainer: PropTypes.instanceOf(AdminGeneralSecurityContainer).isRequired,
  475. adminSamlSecurityContainer: PropTypes.instanceOf(AdminSamlSecurityContainer).isRequired,
  476. };
  477. const SamlSecurityManagementContentsWrapper = withUnstatedContainers(SamlSecurityManagementContents, [
  478. AppContainer,
  479. AdminGeneralSecurityContainer,
  480. AdminSamlSecurityContainer,
  481. ]);
  482. export default withTranslation()(SamlSecurityManagementContentsWrapper);