SamlSecuritySettingContents.jsx 23 KB

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