2
0

OidcSecuritySettingContents.tsx 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  1. import React, { useEffect, useCallback } from 'react';
  2. import { pathUtils } from '@growi/core/dist/utils';
  3. import { useTranslation } from 'next-i18next';
  4. import { useForm } from 'react-hook-form';
  5. import urljoin from 'url-join';
  6. import AdminGeneralSecurityContainer from '~/client/services/AdminGeneralSecurityContainer';
  7. import AdminOidcSecurityContainer from '~/client/services/AdminOidcSecurityContainer';
  8. import { toastSuccess, toastError } from '~/client/util/toastr';
  9. import { useSiteUrl } from '~/stores-universal/context';
  10. import { withUnstatedContainers } from '../../UnstatedUtils';
  11. type Props = {
  12. adminGeneralSecurityContainer: AdminGeneralSecurityContainer;
  13. adminOidcSecurityContainer: AdminOidcSecurityContainer;
  14. };
  15. const OidcSecurityManagementContents = (props: Props) => {
  16. const { t } = useTranslation('admin');
  17. const { data: siteUrl } = useSiteUrl();
  18. const {
  19. adminGeneralSecurityContainer, adminOidcSecurityContainer,
  20. } = props;
  21. const { isOidcEnabled } = adminGeneralSecurityContainer.state;
  22. const {
  23. oidcProviderName, oidcIssuerHost, oidcClientId, oidcClientSecret,
  24. oidcAuthorizationEndpoint, oidcTokenEndpoint, oidcRevocationEndpoint, oidcIntrospectionEndpoint,
  25. oidcUserInfoEndpoint, oidcEndSessionEndpoint, oidcRegistrationEndpoint, oidcJWKSUri,
  26. oidcAttrMapId, oidcAttrMapUserName, oidcAttrMapName, oidcAttrMapEmail,
  27. } = adminOidcSecurityContainer.state;
  28. const oidcCallbackUrl = urljoin(
  29. siteUrl == null ? '' : pathUtils.removeTrailingSlash(siteUrl),
  30. '/passport/oidc/callback',
  31. );
  32. const { register, handleSubmit, reset } = useForm();
  33. useEffect(() => {
  34. reset({
  35. oidcProviderName,
  36. oidcIssuerHost,
  37. oidcClientId,
  38. oidcClientSecret,
  39. oidcAuthorizationEndpoint,
  40. oidcTokenEndpoint,
  41. oidcRevocationEndpoint,
  42. oidcIntrospectionEndpoint,
  43. oidcUserInfoEndpoint,
  44. oidcEndSessionEndpoint,
  45. oidcRegistrationEndpoint,
  46. oidcJWKSUri,
  47. oidcAttrMapId,
  48. oidcAttrMapUserName,
  49. oidcAttrMapName,
  50. oidcAttrMapEmail,
  51. });
  52. }, [
  53. reset, oidcProviderName, oidcIssuerHost, oidcClientId, oidcClientSecret,
  54. oidcAuthorizationEndpoint, oidcTokenEndpoint, oidcRevocationEndpoint, oidcIntrospectionEndpoint,
  55. oidcUserInfoEndpoint, oidcEndSessionEndpoint, oidcRegistrationEndpoint, oidcJWKSUri,
  56. oidcAttrMapId, oidcAttrMapUserName, oidcAttrMapName, oidcAttrMapEmail,
  57. ]);
  58. const onSubmit = useCallback(async(data) => {
  59. try {
  60. await adminOidcSecurityContainer.updateOidcSetting({
  61. oidcProviderName: data.oidcProviderName,
  62. oidcIssuerHost: data.oidcIssuerHost,
  63. oidcClientId: data.oidcClientId,
  64. oidcClientSecret: data.oidcClientSecret,
  65. oidcAuthorizationEndpoint: data.oidcAuthorizationEndpoint,
  66. oidcTokenEndpoint: data.oidcTokenEndpoint,
  67. oidcRevocationEndpoint: data.oidcRevocationEndpoint,
  68. oidcIntrospectionEndpoint: data.oidcIntrospectionEndpoint,
  69. oidcUserInfoEndpoint: data.oidcUserInfoEndpoint,
  70. oidcEndSessionEndpoint: data.oidcEndSessionEndpoint,
  71. oidcRegistrationEndpoint: data.oidcRegistrationEndpoint,
  72. oidcJWKSUri: data.oidcJWKSUri,
  73. oidcAttrMapId: data.oidcAttrMapId,
  74. oidcAttrMapUserName: data.oidcAttrMapUserName,
  75. oidcAttrMapName: data.oidcAttrMapName,
  76. oidcAttrMapEmail: data.oidcAttrMapEmail,
  77. isSameUsernameTreatedAsIdenticalUser: adminOidcSecurityContainer.state.isSameUsernameTreatedAsIdenticalUser,
  78. isSameEmailTreatedAsIdenticalUser: adminOidcSecurityContainer.state.isSameEmailTreatedAsIdenticalUser,
  79. });
  80. await adminGeneralSecurityContainer.retrieveSetupStratedies();
  81. toastSuccess(t('security_settings.OAuth.OIDC.updated_oidc'));
  82. }
  83. catch (err) {
  84. toastError(err);
  85. }
  86. }, [t, adminOidcSecurityContainer, adminGeneralSecurityContainer]);
  87. return (
  88. <>
  89. <h2 className="alert-anchor border-bottom">
  90. {t('security_settings.OAuth.OIDC.name')}
  91. </h2>
  92. <div className="row my-4">
  93. <div className="offset-3 col-6">
  94. <div className="form-check form-switch form-check-success">
  95. <input
  96. id="isOidcEnabled"
  97. className="form-check-input"
  98. type="checkbox"
  99. checked={adminGeneralSecurityContainer.state.isOidcEnabled}
  100. onChange={() => { adminGeneralSecurityContainer.switchIsOidcEnabled() }}
  101. />
  102. <label className="form-label form-check-label" htmlFor="isOidcEnabled">
  103. {t('security_settings.OAuth.enable_oidc')}
  104. </label>
  105. </div>
  106. {(!adminGeneralSecurityContainer.state.setupStrategies.includes('oidc') && isOidcEnabled)
  107. && <div className="badge text-bg-warning">{t('security_settings.setup_is_not_yet_complete')}</div>}
  108. </div>
  109. </div>
  110. <div className="row mb-5">
  111. <label className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.callback_URL')}</label>
  112. <div className="col-md-6">
  113. <input
  114. className="form-control"
  115. type="text"
  116. value={oidcCallbackUrl}
  117. readOnly
  118. />
  119. <p className="form-text text-muted small">{t('security_settings.desc_of_callback_URL', { AuthName: 'OAuth' })}</p>
  120. {(siteUrl == null || siteUrl === '') && (
  121. <div className="alert alert-danger">
  122. <span className="material-symbols-outlined">error</span>
  123. <span
  124. // eslint-disable-next-line max-len
  125. dangerouslySetInnerHTML={{ __html: t('alert.siteUrl_is_not_set', { link: `<a href="/admin/app">${t('headers.app_settings', { ns: 'commons' })}<span class="material-symbols-outlined">login</span></a>`, ns: 'commons' }) }}
  126. />
  127. </div>
  128. )}
  129. </div>
  130. </div>
  131. {isOidcEnabled && (
  132. <form onSubmit={handleSubmit(onSubmit)}>
  133. <h3 className="border-bottom mb-4">{t('security_settings.configuration')}</h3>
  134. <div className="row mb-4">
  135. <label htmlFor="oidcProviderName" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.providerName')}</label>
  136. <div className="col-md-6">
  137. <input
  138. className="form-control"
  139. type="text"
  140. {...register('oidcProviderName')}
  141. />
  142. </div>
  143. </div>
  144. <div className="row mb-4">
  145. <label htmlFor="oidcIssuerHost" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.issuerHost')}</label>
  146. <div className="col-md-6">
  147. <input
  148. className="form-control"
  149. type="text"
  150. {...register('oidcIssuerHost')}
  151. />
  152. <p className="form-text text-muted">
  153. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_OIDC_ISSUER_HOST' }) }} />
  154. </p>
  155. </div>
  156. </div>
  157. <div className="row mb-4">
  158. <label htmlFor="oidcClientId" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.clientID')}</label>
  159. <div className="col-md-6">
  160. <input
  161. className="form-control"
  162. type="text"
  163. {...register('oidcClientId')}
  164. />
  165. <p className="form-text text-muted">
  166. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_OIDC_CLIENT_ID' }) }} />
  167. </p>
  168. </div>
  169. </div>
  170. <div className="row mb-4">
  171. <label htmlFor="oidcClientSecret" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.client_secret')}</label>
  172. <div className="col-md-6">
  173. <input
  174. className="form-control"
  175. type="text"
  176. {...register('oidcClientSecret')}
  177. />
  178. <p className="form-text text-muted">
  179. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_OIDC_CLIENT_SECRET' }) }} />
  180. </p>
  181. </div>
  182. </div>
  183. <div className="row mb-4">
  184. <label htmlFor="oidcAuthorizationEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  185. {t('security_settings.authorization_endpoint')}
  186. </label>
  187. <div className="col-md-6">
  188. <input
  189. className="form-control"
  190. type="text"
  191. {...register('oidcAuthorizationEndpoint')}
  192. />
  193. <p className="form-text text-muted">
  194. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  195. </p>
  196. </div>
  197. </div>
  198. <div className="row mb-4">
  199. <label htmlFor="oidcTokenEndpoint" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.token_endpoint')}</label>
  200. <div className="col-md-6">
  201. <input
  202. className="form-control"
  203. type="text"
  204. {...register('oidcTokenEndpoint')}
  205. />
  206. <p className="form-text text-muted">
  207. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  208. </p>
  209. </div>
  210. </div>
  211. <div className="row mb-4">
  212. <label htmlFor="oidcRevocationEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  213. {t('security_settings.revocation_endpoint')}
  214. </label>
  215. <div className="col-md-6">
  216. <input
  217. className="form-control"
  218. type="text"
  219. {...register('oidcRevocationEndpoint')}
  220. />
  221. <p className="form-text text-muted">
  222. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  223. </p>
  224. </div>
  225. </div>
  226. <div className="row mb-4">
  227. <label htmlFor="oidcIntrospectionEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  228. {t('security_settings.introspection_endpoint')}
  229. </label>
  230. <div className="col-md-6">
  231. <input
  232. className="form-control"
  233. type="text"
  234. {...register('oidcIntrospectionEndpoint')}
  235. />
  236. <p className="form-text text-muted">
  237. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  238. </p>
  239. </div>
  240. </div>
  241. <div className="row mb-4">
  242. <label htmlFor="oidcUserInfoEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  243. {t('security_settings.userinfo_endpoint')}
  244. </label>
  245. <div className="col-md-6">
  246. <input
  247. className="form-control"
  248. type="text"
  249. {...register('oidcUserInfoEndpoint')}
  250. />
  251. <p className="form-text text-muted">
  252. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  253. </p>
  254. </div>
  255. </div>
  256. <div className="row mb-4">
  257. <label htmlFor="oidcEndSessionEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  258. {t('security_settings.end_session_endpoint')}
  259. </label>
  260. <div className="col-md-6">
  261. <input
  262. className="form-control"
  263. type="text"
  264. {...register('oidcEndSessionEndpoint')}
  265. />
  266. <p className="form-text text-muted">
  267. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  268. </p>
  269. </div>
  270. </div>
  271. <div className="row mb-4">
  272. <label htmlFor="oidcRegistrationEndpoint" className="text-start text-md-end col-md-3 col-form-label">
  273. {t('security_settings.registration_endpoint')}
  274. </label>
  275. <div className="col-md-6">
  276. <input
  277. className="form-control"
  278. type="text"
  279. {...register('oidcRegistrationEndpoint')}
  280. />
  281. <p className="form-text text-muted">
  282. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  283. </p>
  284. </div>
  285. </div>
  286. <div className="row mb-4">
  287. <label htmlFor="oidcJWKSUri" className="text-start text-md-end col-md-3 col-form-label">{t('security_settings.jwks_uri')}</label>
  288. <div className="col-md-6">
  289. <input
  290. className="form-control"
  291. type="text"
  292. {...register('oidcJWKSUri')}
  293. />
  294. <p className="form-text text-muted">
  295. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.Use discovered URL if empty') }} />
  296. </p>
  297. </div>
  298. </div>
  299. <h3 className="alert-anchor border-bottom mb-4">
  300. Attribute Mapping ({t('optional')})
  301. </h3>
  302. <div className="row mb-4">
  303. <label htmlFor="oidcAttrMapId" className="text-start text-md-end col-md-3 col-form-label">Identifier</label>
  304. <div className="col-md-6">
  305. <input
  306. className="form-control"
  307. type="text"
  308. {...register('oidcAttrMapId')}
  309. />
  310. <p className="form-text text-muted">
  311. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.id_detail') }} />
  312. </p>
  313. </div>
  314. </div>
  315. <div className="row mb-4">
  316. <label htmlFor="oidcAttrMapUserName" className="text-start text-md-end col-md-3 col-form-label">{t('username')}</label>
  317. <div className="col-md-6">
  318. <input
  319. className="form-control"
  320. type="text"
  321. {...register('oidcAttrMapUserName')}
  322. />
  323. <p className="form-text text-muted">
  324. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.username_detail') }} />
  325. </p>
  326. </div>
  327. </div>
  328. <div className="row mb-4">
  329. <label htmlFor="oidcAttrMapName" className="text-start text-md-end col-md-3 col-form-label">{t('Name')}</label>
  330. <div className="col-md-6">
  331. <input
  332. className="form-control"
  333. type="text"
  334. {...register('oidcAttrMapName')}
  335. />
  336. <p className="form-text text-muted">
  337. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.name_detail') }} />
  338. </p>
  339. </div>
  340. </div>
  341. <div className="row mb-4">
  342. <label htmlFor="oidcAttrMapEmail" className="text-start text-md-end col-md-3 col-form-label">{t('Email')}</label>
  343. <div className="col-md-6">
  344. <input
  345. className="form-control"
  346. type="text"
  347. {...register('oidcAttrMapEmail')}
  348. />
  349. <p className="form-text text-muted">
  350. <small dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.mapping_detail', { target: t('Email') }) }} />
  351. </p>
  352. </div>
  353. </div>
  354. <div className="row mb-4">
  355. <label className="form-label text-start text-md-end col-md-3 col-form-label">{t('security_settings.callback_URL')}</label>
  356. <div className="col-md-6">
  357. <input
  358. className="form-control"
  359. type="text"
  360. defaultValue={oidcCallbackUrl}
  361. readOnly
  362. />
  363. <p className="form-text text-muted small">{t('security_settings.desc_of_callback_URL', { AuthName: 'OAuth' })}</p>
  364. {(siteUrl == null || siteUrl === '') && (
  365. <div className="alert alert-danger">
  366. <span className="material-symbols-outlined">error</span>
  367. <span
  368. // eslint-disable-next-line max-len
  369. dangerouslySetInnerHTML={{ __html: t('alert.siteUrl_is_not_set', { link: `<a href="/admin/app">${t('headers.app_settings', { ns: 'commons' })}<span class="material-symbols-outlined">login</span></a>`, ns: 'commons' }) }}
  370. />
  371. </div>
  372. )}
  373. </div>
  374. </div>
  375. <div className="row mb-4">
  376. <div className="offset-md-3 col-md-6">
  377. <div className="form-check form-check-success">
  378. <input
  379. id="bindByUserName-oidc"
  380. className="form-check-input"
  381. type="checkbox"
  382. checked={adminOidcSecurityContainer.state.isSameUsernameTreatedAsIdenticalUser}
  383. onChange={() => { adminOidcSecurityContainer.switchIsSameUsernameTreatedAsIdenticalUser() }}
  384. />
  385. <label
  386. className="form-label form-check-label"
  387. htmlFor="bindByUserName-oidc"
  388. dangerouslySetInnerHTML={{ __html: t('security_settings.Treat username matching as identical') }}
  389. />
  390. </div>
  391. <p className="form-text text-muted">
  392. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Treat username matching as identical_warn') }} />
  393. </p>
  394. </div>
  395. </div>
  396. <div className="row mb-4">
  397. <div className="offset-md-3 col-md-6">
  398. <div className="form-check form-check-success">
  399. <input
  400. id="bindByEmail-oidc"
  401. className="form-check-input"
  402. type="checkbox"
  403. checked={adminOidcSecurityContainer.state.isSameEmailTreatedAsIdenticalUser || false}
  404. onChange={() => { adminOidcSecurityContainer.switchIsSameEmailTreatedAsIdenticalUser() }}
  405. />
  406. <label
  407. className="form-label form-check-label"
  408. htmlFor="bindByEmail-oidc"
  409. dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical') }}
  410. />
  411. </div>
  412. <p className="form-text text-muted">
  413. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical_warn') }} />
  414. </p>
  415. </div>
  416. </div>
  417. <div className="row my-3">
  418. <div className="offset-3 col-5">
  419. <button
  420. type="submit"
  421. className="btn btn-primary"
  422. disabled={adminOidcSecurityContainer.state.retrieveError != null}
  423. >
  424. {t('Update')}
  425. </button>
  426. </div>
  427. </div>
  428. </form>
  429. )}
  430. <hr />
  431. <div style={{ minHeight: '300px' }}>
  432. <h4>
  433. <span className="material-symbols-outlined" aria-hidden="true">help</span>
  434. <a href="#collapseHelpForOidcOauth" data-bs-toggle="collapse"> {t('security_settings.OAuth.how_to.oidc')}</a>
  435. </h4>
  436. <div className=" card custom-card bg-body-tertiary">
  437. <ol id="collapseHelpForOidcOauth" className="collapse mb-0">
  438. <li>{t('security_settings.OAuth.OIDC.register_1')}</li>
  439. <li dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.OIDC.register_2', { url: oidcCallbackUrl }) }} />
  440. <li>{t('security_settings.OAuth.OIDC.register_3')}</li>
  441. </ol>
  442. </div>
  443. </div>
  444. </>
  445. );
  446. };
  447. const OidcSecurityManagementContentsWrapper = withUnstatedContainers(OidcSecurityManagementContents, [
  448. AdminGeneralSecurityContainer,
  449. AdminOidcSecurityContainer,
  450. ]);
  451. export default OidcSecurityManagementContentsWrapper;