2
0

GitHubSecuritySettingContents.jsx 8.7 KB

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