GitHubSecuritySettingContents.jsx 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  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="form-group row">
  45. <div className="col-6 offset-3">
  46. <div className="custom-control custom-switch custom-checkbox-success">
  47. <input
  48. id="isGitHubEnabled"
  49. className="custom-control-input"
  50. type="checkbox"
  51. checked={adminGeneralSecurityContainer.state.isGitHubEnabled || false}
  52. onChange={() => { adminGeneralSecurityContainer.switchIsGitHubOAuthEnabled() }}
  53. />
  54. <label className="custom-control-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 badge-warning">{t('security_settings.setup_is_not_yet_complete')}</div>}
  60. </div>
  61. </div>
  62. <div className="row mb-5">
  63. <label className="col-12 col-md-3 text-left text-md-right 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. <i
  75. className="icon-exclamation"
  76. // eslint-disable-next-line max-len
  77. 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' }) }}
  78. />
  79. </div>
  80. )}
  81. </div>
  82. </div>
  83. {isGitHubEnabled && (
  84. <React.Fragment>
  85. <h3 className="border-bottom">{t('security_settings.configuration')}</h3>
  86. <div className="row mb-5">
  87. <label htmlFor="githubClientId" className="col-3 text-right py-2">{t('security_settings.clientID')}</label>
  88. <div className="col-6">
  89. <input
  90. className="form-control"
  91. type="text"
  92. name="githubClientId"
  93. value={adminGitHubSecurityContainer.state.githubClientId || ''}
  94. onChange={e => adminGitHubSecurityContainer.changeGitHubClientId(e.target.value)}
  95. />
  96. <p className="form-text text-muted">
  97. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_GITHUB_CLIENT_ID' }) }} />
  98. </p>
  99. </div>
  100. </div>
  101. <div className="row mb-5">
  102. <label htmlFor="githubClientSecret" className="col-3 text-right py-2">{t('security_settings.client_secret')}</label>
  103. <div className="col-6">
  104. <input
  105. className="form-control"
  106. type="text"
  107. name="githubClientSecret"
  108. defaultValue={adminGitHubSecurityContainer.state.githubClientSecret || ''}
  109. onChange={e => adminGitHubSecurityContainer.changeGitHubClientSecret(e.target.value)}
  110. />
  111. <p className="form-text text-muted">
  112. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Use env var if empty', { env: 'OAUTH_GITHUB_CLIENT_SECRET' }) }} />
  113. </p>
  114. </div>
  115. </div>
  116. <div className="row mb-5">
  117. <div className="offset-3 col-6 text-left">
  118. <div className="custom-control custom-checkbox custom-checkbox-success">
  119. <input
  120. id="bindByUserNameGitHub"
  121. className="custom-control-input"
  122. type="checkbox"
  123. checked={adminGitHubSecurityContainer.state.isSameUsernameTreatedAsIdenticalUser || false}
  124. onChange={() => { adminGitHubSecurityContainer.switchIsSameUsernameTreatedAsIdenticalUser() }}
  125. />
  126. <label
  127. className="custom-control-label"
  128. htmlFor="bindByUserNameGitHub"
  129. dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical') }}
  130. />
  131. </div>
  132. <p className="form-text text-muted">
  133. <small dangerouslySetInnerHTML={{ __html: t('security_settings.Treat email matching as identical_warn') }} />
  134. </p>
  135. </div>
  136. </div>
  137. <div className="row my-3">
  138. <div className="offset-3 col-5">
  139. <div className="btn btn-primary" disabled={adminGitHubSecurityContainer.state.retrieveError != null} onClick={this.onClickSubmit}>
  140. {t('Update')}
  141. </div>
  142. </div>
  143. </div>
  144. </React.Fragment>
  145. )}
  146. <hr />
  147. <div style={{ minHeight: '300px' }}>
  148. <h4>
  149. <i className="icon-question" aria-hidden="true"></i>
  150. <a href="#collapseHelpForGitHubOauth" data-toggle="collapse"> {t('security_settings.OAuth.how_to.github')}</a>
  151. </h4>
  152. <ol id="collapseHelpForGitHubOauth" className="collapse">
  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. </React.Fragment>
  160. );
  161. }
  162. }
  163. const GitHubSecurityManagementContentsFC = (props) => {
  164. const { t } = useTranslation('admin');
  165. const { data: siteUrl } = useSiteUrl();
  166. return <GitHubSecurityManagementContents t={t} siteUrl={siteUrl} {...props} />;
  167. };
  168. /**
  169. * Wrapper component for using unstated
  170. */
  171. const GitHubSecurityManagementContentsWrapper = withUnstatedContainers(GitHubSecurityManagementContentsFC, [
  172. AdminGeneralSecurityContainer,
  173. AdminGitHubSecurityContainer,
  174. ]);
  175. GitHubSecurityManagementContents.propTypes = {
  176. t: PropTypes.func.isRequired, // i18next
  177. adminGeneralSecurityContainer: PropTypes.instanceOf(AdminGeneralSecurityContainer).isRequired,
  178. adminGitHubSecurityContainer: PropTypes.instanceOf(AdminGitHubSecurityContainer).isRequired,
  179. };
  180. export default GitHubSecurityManagementContentsWrapper;