GitHubSecuritySettingContents.tsx 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. /* eslint-disable react/no-danger */
  2. import React, { useCallback, useEffect } from 'react';
  3. import { pathUtils } from '@growi/core/dist/utils';
  4. import { useTranslation } from 'next-i18next';
  5. import { useForm } from 'react-hook-form';
  6. import urljoin from 'url-join';
  7. import AdminGeneralSecurityContainer from '~/client/services/AdminGeneralSecurityContainer';
  8. import AdminGitHubSecurityContainer from '~/client/services/AdminGitHubSecurityContainer';
  9. import { toastSuccess, toastError } from '~/client/util/toastr';
  10. import { useSiteUrlWithEmptyValueWarn } from '~/states/global';
  11. import { withUnstatedContainers } from '../../UnstatedUtils';
  12. type Props = {
  13. adminGeneralSecurityContainer: AdminGeneralSecurityContainer
  14. adminGitHubSecurityContainer: AdminGitHubSecurityContainer
  15. };
  16. const GitHubSecurityManagementContents = (props: Props) => {
  17. const {
  18. adminGeneralSecurityContainer, adminGitHubSecurityContainer,
  19. } = props;
  20. const { t } = useTranslation('admin');
  21. const siteUrl = useSiteUrlWithEmptyValueWarn();
  22. const { isGitHubEnabled } = adminGeneralSecurityContainer.state;
  23. const { githubClientId, githubClientSecret, retrieveError } = adminGitHubSecurityContainer.state;
  24. const gitHubCallbackUrl = urljoin(pathUtils.removeTrailingSlash(siteUrl), '/passport/github/callback');
  25. const { register, handleSubmit, reset } = useForm();
  26. // Sync form with container state
  27. useEffect(() => {
  28. reset({
  29. githubClientId,
  30. githubClientSecret,
  31. });
  32. }, [reset, githubClientId, githubClientSecret]);
  33. const onClickSubmit = useCallback(async(data) => {
  34. try {
  35. await adminGitHubSecurityContainer.changeGitHubClientId(data.githubClientId ?? '');
  36. await adminGitHubSecurityContainer.changeGitHubClientSecret(data.githubClientSecret ?? '');
  37. await adminGitHubSecurityContainer.updateGitHubSetting();
  38. await adminGeneralSecurityContainer.retrieveSetupStratedies();
  39. toastSuccess(t('security_settings.OAuth.GitHub.updated_github'));
  40. }
  41. catch (err) {
  42. toastError(err);
  43. }
  44. }, [adminGitHubSecurityContainer, adminGeneralSecurityContainer, t]);
  45. return (
  46. <form onSubmit={handleSubmit(onClickSubmit)}>
  47. <React.Fragment>
  48. <h2 className="alert-anchor border-bottom">
  49. {t('security_settings.OAuth.GitHub.name')}
  50. </h2>
  51. {retrieveError != null && (
  52. <div className="alert alert-danger">
  53. <p>{t('Error occurred')} : {retrieveError}</p>
  54. </div>
  55. )}
  56. <div className="row my-4">
  57. <div className="col-6 offset-3">
  58. <div className="form-check form-switch form-check-success">
  59. <input
  60. id="isGitHubEnabled"
  61. className="form-check-input"
  62. type="checkbox"
  63. checked={adminGeneralSecurityContainer.state.isGitHubEnabled || false}
  64. onChange={() => { adminGeneralSecurityContainer.switchIsGitHubOAuthEnabled() }}
  65. />
  66. <label className="form-label form-check-label" htmlFor="isGitHubEnabled">
  67. {t('security_settings.OAuth.GitHub.enable_github')}
  68. </label>
  69. </div>
  70. {(!adminGeneralSecurityContainer.state.setupStrategies.includes('github') && isGitHubEnabled)
  71. && <div className="badge text-bg-warning">{t('security_settings.setup_is_not_yet_complete')}</div>}
  72. </div>
  73. </div>
  74. <div className="row mb-4">
  75. <label className="form-label col-12 col-md-3 text-start text-md-end py-2">{t('security_settings.callback_URL')}</label>
  76. <div className="col-12 col-md-6">
  77. <input
  78. className="form-control"
  79. type="text"
  80. value={gitHubCallbackUrl}
  81. readOnly
  82. />
  83. <p className="form-text text-muted small">{t('security_settings.desc_of_callback_URL', { AuthName: 'OAuth' })}</p>
  84. {(siteUrl == null || siteUrl === '') && (
  85. <div className="alert alert-danger">
  86. <span className="material-symbols-outlined">error</span>
  87. <span // eslint-disable-next-line max-len
  88. 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' }) }}
  89. />
  90. </div>
  91. )}
  92. </div>
  93. </div>
  94. {isGitHubEnabled && (
  95. <React.Fragment>
  96. <h3 className="border-bottom mb-4">{t('security_settings.configuration')}</h3>
  97. <div className="row mb-4">
  98. <label htmlFor="githubClientId" className="col-3 text-end py-2 form-label">{t('security_settings.clientID')}</label>
  99. <div className="col-6">
  100. <input
  101. className="form-control"
  102. type="text"
  103. {...register('githubClientId')}
  104. />
  105. <p className="form-text text-muted">
  106. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_GITHUB_CLIENT_ID' }) }} />
  107. </p>
  108. </div>
  109. </div>
  110. <div className="row mb-3">
  111. <label htmlFor="githubClientSecret" className="col-3 text-end py-2 form-label">{t('security_settings.client_secret')}</label>
  112. <div className="col-6">
  113. <input
  114. className="form-control"
  115. type="text"
  116. {...register('githubClientSecret')}
  117. />
  118. <p className="form-text text-muted">
  119. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_GITHUB_CLIENT_SECRET' }) }} />
  120. </p>
  121. </div>
  122. </div>
  123. <div className="row mb-3">
  124. <div className="offset-3 col-6 text-start">
  125. <div className="form-check form-check-success">
  126. <input
  127. id="bindByUserNameGitHub"
  128. className="form-check-input"
  129. type="checkbox"
  130. checked={adminGitHubSecurityContainer.state.isSameUsernameTreatedAsIdenticalUser || false}
  131. onChange={() => { adminGitHubSecurityContainer.switchIsSameUsernameTreatedAsIdenticalUser() }}
  132. />
  133. <label
  134. className="form-check-label"
  135. htmlFor="bindByUserNameGitHub"
  136. dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical') }}
  137. />
  138. </div>
  139. <p className="form-text text-muted">
  140. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical_warn') }} />
  141. </p>
  142. </div>
  143. </div>
  144. <div className="row mb-4">
  145. <div className="offset-3 col-5">
  146. <button type="submit" className="btn btn-primary" disabled={retrieveError != null}>
  147. {t('Update')}
  148. </button>
  149. </div>
  150. </div>
  151. </React.Fragment>
  152. )}
  153. <hr />
  154. <div style={{ minHeight: '300px' }}>
  155. <h4>
  156. <span className="material-symbols-outlined" aria-hidden="true">help</span>
  157. <a href="#collapseHelpForGitHubOauth" data-bs-toggle="collapse"> {t('security_settings.OAuth.how_to.github')}</a>
  158. </h4>
  159. <div className="card custom-card bg-body-tertiary">
  160. <ol id="collapseHelpForGitHubOauth" className="collapse mb-0">
  161. {/* eslint-disable-next-line max-len */}
  162. <li dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.GitHub.register_1', { link: '<a href="https://github.com/settings/developers" target=_blank>GitHub Developer Settings</a>' }) }} />
  163. <li dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.GitHub.register_2', { url: gitHubCallbackUrl }) }} />
  164. <li dangerouslySetInnerHTML={{ __html: t('security_settings.OAuth.GitHub.register_3') }} />
  165. </ol>
  166. </div>
  167. </div>
  168. </React.Fragment>
  169. </form>
  170. );
  171. };
  172. /**
  173. * Wrapper component for using unstated
  174. */
  175. const GitHubSecurityManagementContentsWrapper = withUnstatedContainers(GitHubSecurityManagementContents, [
  176. AdminGeneralSecurityContainer,
  177. AdminGitHubSecurityContainer,
  178. ]);
  179. export default GitHubSecurityManagementContentsWrapper;