You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.2 KiB

Oauth2 consumer (#679) * initial stuff for oauth2 login, fails on: * login button on the signIn page to start the OAuth2 flow and a callback for each provider Only GitHub is implemented for now * show login button only when the OAuth2 consumer is configured (and activated) * create macaron group for oauth2 urls * prevent net/http in modules (other then oauth2) * use a new data sessions oauth2 folder for storing the oauth2 session data * add missing 2FA when this is enabled on the user * add password option for OAuth2 user , for use with git over http and login to the GUI * add tip for registering a GitHub OAuth application * at startup of Gitea register all configured providers and also on adding/deleting of new providers * custom handling of errors in oauth2 request init + show better tip * add ExternalLoginUser model and migration script to add it to database * link a external account to an existing account (still need to handle wrong login and signup) and remove if user is removed * remove the linked external account from the user his settings * if user is unknown we allow him to register a new account or link it to some existing account * sign up with button on signin page (als change OAuth2Provider structure so we can store basic stuff about providers) * from gorilla/sessions docs: "Important Note: If you aren't using gorilla/mux, you need to wrap your handlers with context.ClearHandler as or else you will leak memory!" (we're using gorilla/sessions for storing oauth2 sessions) * use updated goth lib that now supports getting the OAuth2 user if the AccessToken is still valid instead of re-authenticating (prevent flooding the OAuth2 provider)
7 years ago
  1. // Copyright 2017 The Gitea Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package oauth2
  5. import (
  6. "code.gitea.io/gitea/modules/setting"
  7. "code.gitea.io/gitea/modules/log"
  8. "github.com/gorilla/sessions"
  9. "github.com/markbates/goth"
  10. "github.com/markbates/goth/gothic"
  11. "net/http"
  12. "os"
  13. "github.com/satori/go.uuid"
  14. "path/filepath"
  15. "github.com/markbates/goth/providers/github"
  16. )
  17. var (
  18. sessionUsersStoreKey = "gitea-oauth2-sessions"
  19. providerHeaderKey = "gitea-oauth2-provider"
  20. )
  21. // Init initialize the setup of the OAuth2 library
  22. func Init() {
  23. sessionDir := filepath.Join(setting.AppDataPath, "sessions", "oauth2")
  24. if err := os.MkdirAll(sessionDir, 0700); err != nil {
  25. log.Fatal(4, "Fail to create dir %s: %v", sessionDir, err)
  26. }
  27. gothic.Store = sessions.NewFilesystemStore(sessionDir, []byte(sessionUsersStoreKey))
  28. gothic.SetState = func(req *http.Request) string {
  29. return uuid.NewV4().String()
  30. }
  31. gothic.GetProviderName = func(req *http.Request) (string, error) {
  32. return req.Header.Get(providerHeaderKey), nil
  33. }
  34. }
  35. // Auth OAuth2 auth service
  36. func Auth(provider string, request *http.Request, response http.ResponseWriter) error {
  37. // not sure if goth is thread safe (?) when using multiple providers
  38. request.Header.Set(providerHeaderKey, provider)
  39. // don't use the default gothic begin handler to prevent issues when some error occurs
  40. // normally the gothic library will write some custom stuff to the response instead of our own nice error page
  41. //gothic.BeginAuthHandler(response, request)
  42. url, err := gothic.GetAuthURL(response, request)
  43. if err == nil {
  44. http.Redirect(response, request, url, http.StatusTemporaryRedirect)
  45. }
  46. return err
  47. }
  48. // ProviderCallback handles OAuth callback, resolve to a goth user and send back to original url
  49. // this will trigger a new authentication request, but because we save it in the session we can use that
  50. func ProviderCallback(provider string, request *http.Request, response http.ResponseWriter) (goth.User, error) {
  51. // not sure if goth is thread safe (?) when using multiple providers
  52. request.Header.Set(providerHeaderKey, provider)
  53. user, err := gothic.CompleteUserAuth(response, request)
  54. if err != nil {
  55. return user, err
  56. }
  57. return user, nil
  58. }
  59. // RegisterProvider register a OAuth2 provider in goth lib
  60. func RegisterProvider(providerName, providerType, clientID, clientSecret string) {
  61. provider := createProvider(providerName, providerType, clientID, clientSecret)
  62. if provider != nil {
  63. goth.UseProviders(provider)
  64. }
  65. }
  66. // RemoveProvider removes the given OAuth2 provider from the goth lib
  67. func RemoveProvider(providerName string) {
  68. delete(goth.GetProviders(), providerName)
  69. }
  70. // used to create different types of goth providers
  71. func createProvider(providerName, providerType, clientID, clientSecret string) goth.Provider {
  72. callbackURL := setting.AppURL + "user/oauth2/" + providerName + "/callback"
  73. var provider goth.Provider
  74. switch providerType {
  75. case "github":
  76. provider = github.New(clientID, clientSecret, callbackURL, "user:email")
  77. }
  78. // always set the name if provider is created so we can support multiple setups of 1 provider
  79. if provider != nil {
  80. provider.SetName(providerName)
  81. }
  82. return provider
  83. }