Fork to maintain patches against the official gitea for https://code.ceondo.com https://github.com/go-gitea/gitea

oauth2.go 4.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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 models
  5. import (
  6. "sort"
  7. "code.gitea.io/gitea/modules/auth/oauth2"
  8. )
  9. // OAuth2Provider describes the display values of a single OAuth2 provider
  10. type OAuth2Provider struct {
  11. Name string
  12. DisplayName string
  13. Image string
  14. CustomURLMapping *oauth2.CustomURLMapping
  15. }
  16. // OAuth2Providers contains the map of registered OAuth2 providers in Gitea (based on goth)
  17. // key is used to map the OAuth2Provider with the goth provider type (also in LoginSource.OAuth2Config.Provider)
  18. // value is used to store display data
  19. var OAuth2Providers = map[string]OAuth2Provider{
  20. "bitbucket": {Name: "bitbucket", DisplayName: "Bitbucket", Image: "/img/auth/bitbucket.png"},
  21. "dropbox": {Name: "dropbox", DisplayName: "Dropbox", Image: "/img/auth/dropbox.png"},
  22. "facebook": {Name: "facebook", DisplayName: "Facebook", Image: "/img/auth/facebook.png"},
  23. "github": {Name: "github", DisplayName: "GitHub", Image: "/img/auth/github.png",
  24. CustomURLMapping: &oauth2.CustomURLMapping{
  25. TokenURL: oauth2.GetDefaultTokenURL("github"),
  26. AuthURL: oauth2.GetDefaultAuthURL("github"),
  27. ProfileURL: oauth2.GetDefaultProfileURL("github"),
  28. EmailURL: oauth2.GetDefaultEmailURL("github"),
  29. },
  30. },
  31. "gitlab": {Name: "gitlab", DisplayName: "GitLab", Image: "/img/auth/gitlab.png",
  32. CustomURLMapping: &oauth2.CustomURLMapping{
  33. TokenURL: oauth2.GetDefaultTokenURL("gitlab"),
  34. AuthURL: oauth2.GetDefaultAuthURL("gitlab"),
  35. ProfileURL: oauth2.GetDefaultProfileURL("gitlab"),
  36. },
  37. },
  38. "gplus": {Name: "gplus", DisplayName: "Google+", Image: "/img/auth/google_plus.png"},
  39. "openidConnect": {Name: "openidConnect", DisplayName: "OpenID Connect", Image: "/img/auth/openid_connect.png"},
  40. "twitter": {Name: "twitter", DisplayName: "Twitter", Image: "/img/auth/twitter.png"},
  41. }
  42. // OAuth2DefaultCustomURLMappings contains the map of default URL's for OAuth2 providers that are allowed to have custom urls
  43. // key is used to map the OAuth2Provider
  44. // value is the mapping as defined for the OAuth2Provider
  45. var OAuth2DefaultCustomURLMappings = map[string]*oauth2.CustomURLMapping{
  46. "github": OAuth2Providers["github"].CustomURLMapping,
  47. "gitlab": OAuth2Providers["gitlab"].CustomURLMapping,
  48. }
  49. // GetActiveOAuth2ProviderLoginSources returns all actived LoginOAuth2 sources
  50. func GetActiveOAuth2ProviderLoginSources() ([]*LoginSource, error) {
  51. sources := make([]*LoginSource, 0, 1)
  52. if err := x.Where("is_actived = ? and type = ?", true, LoginOAuth2).Find(&sources); err != nil {
  53. return nil, err
  54. }
  55. return sources, nil
  56. }
  57. // GetActiveOAuth2LoginSourceByName returns a OAuth2 LoginSource based on the given name
  58. func GetActiveOAuth2LoginSourceByName(name string) (*LoginSource, error) {
  59. loginSource := new(LoginSource)
  60. has, err := x.Where("name = ? and type = ? and is_actived = ?", name, LoginOAuth2, true).Get(loginSource)
  61. if !has || err != nil {
  62. return nil, err
  63. }
  64. return loginSource, nil
  65. }
  66. // GetActiveOAuth2Providers returns the map of configured active OAuth2 providers
  67. // key is used as technical name (like in the callbackURL)
  68. // values to display
  69. func GetActiveOAuth2Providers() ([]string, map[string]OAuth2Provider, error) {
  70. // Maybe also separate used and unused providers so we can force the registration of only 1 active provider for each type
  71. loginSources, err := GetActiveOAuth2ProviderLoginSources()
  72. if err != nil {
  73. return nil, nil, err
  74. }
  75. var orderedKeys []string
  76. providers := make(map[string]OAuth2Provider)
  77. for _, source := range loginSources {
  78. providers[source.Name] = OAuth2Providers[source.OAuth2().Provider]
  79. orderedKeys = append(orderedKeys, source.Name)
  80. }
  81. sort.Strings(orderedKeys)
  82. return orderedKeys, providers, nil
  83. }
  84. // InitOAuth2 initialize the OAuth2 lib and register all active OAuth2 providers in the library
  85. func InitOAuth2() {
  86. oauth2.Init()
  87. loginSources, _ := GetActiveOAuth2ProviderLoginSources()
  88. for _, source := range loginSources {
  89. oAuth2Config := source.OAuth2()
  90. oauth2.RegisterProvider(source.Name, oAuth2Config.Provider, oAuth2Config.ClientID, oAuth2Config.ClientSecret, oAuth2Config.OpenIDConnectAutoDiscoveryURL, oAuth2Config.CustomURLMapping)
  91. }
  92. }
  93. // wrapOpenIDConnectInitializeError is used to wrap the error but this cannot be done in modules/auth/oauth2
  94. // inside oauth2: import cycle not allowed models -> modules/auth/oauth2 -> models
  95. func wrapOpenIDConnectInitializeError(err error, providerName string, oAuth2Config *OAuth2Config) error {
  96. if err != nil && "openidConnect" == oAuth2Config.Provider {
  97. err = ErrOpenIDConnectInitialize{ProviderName: providerName, OpenIDConnectAutoDiscoveryURL: oAuth2Config.OpenIDConnectAutoDiscoveryURL, Cause: err}
  98. }
  99. return err
  100. }