SamlSecuritySetting.jsx 22 KB

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