SamlSecuritySetting.jsx 23 KB

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