SamlSecuritySettingContents.jsx 24 KB

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