THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

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.

133 lines
5.3KB

  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.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. "discord": {Name: "discord", DisplayName: "Discord", Image: "/img/auth/discord.png"},
  42. "gitea": {Name: "gitea", DisplayName: "Gitea", Image: "/img/auth/gitea.png",
  43. CustomURLMapping: &oauth2.CustomURLMapping{
  44. TokenURL: oauth2.GetDefaultTokenURL("gitea"),
  45. AuthURL: oauth2.GetDefaultAuthURL("gitea"),
  46. ProfileURL: oauth2.GetDefaultProfileURL("gitea"),
  47. },
  48. },
  49. }
  50. // OAuth2DefaultCustomURLMappings contains the map of default URL's for OAuth2 providers that are allowed to have custom urls
  51. // key is used to map the OAuth2Provider
  52. // value is the mapping as defined for the OAuth2Provider
  53. var OAuth2DefaultCustomURLMappings = map[string]*oauth2.CustomURLMapping{
  54. "github": OAuth2Providers["github"].CustomURLMapping,
  55. "gitlab": OAuth2Providers["gitlab"].CustomURLMapping,
  56. "gitea": OAuth2Providers["gitea"].CustomURLMapping,
  57. }
  58. // GetActiveOAuth2ProviderLoginSources returns all actived LoginOAuth2 sources
  59. func GetActiveOAuth2ProviderLoginSources() ([]*LoginSource, error) {
  60. sources := make([]*LoginSource, 0, 1)
  61. if err := x.Where("is_actived = ? and type = ?", true, LoginOAuth2).Find(&sources); err != nil {
  62. return nil, err
  63. }
  64. return sources, nil
  65. }
  66. // GetActiveOAuth2LoginSourceByName returns a OAuth2 LoginSource based on the given name
  67. func GetActiveOAuth2LoginSourceByName(name string) (*LoginSource, error) {
  68. loginSource := new(LoginSource)
  69. has, err := x.Where("name = ? and type = ? and is_actived = ?", name, LoginOAuth2, true).Get(loginSource)
  70. if !has || err != nil {
  71. return nil, err
  72. }
  73. return loginSource, nil
  74. }
  75. // GetActiveOAuth2Providers returns the map of configured active OAuth2 providers
  76. // key is used as technical name (like in the callbackURL)
  77. // values to display
  78. func GetActiveOAuth2Providers() ([]string, map[string]OAuth2Provider, error) {
  79. // Maybe also separate used and unused providers so we can force the registration of only 1 active provider for each type
  80. loginSources, err := GetActiveOAuth2ProviderLoginSources()
  81. if err != nil {
  82. return nil, nil, err
  83. }
  84. var orderedKeys []string
  85. providers := make(map[string]OAuth2Provider)
  86. for _, source := range loginSources {
  87. providers[source.Name] = OAuth2Providers[source.OAuth2().Provider]
  88. orderedKeys = append(orderedKeys, source.Name)
  89. }
  90. sort.Strings(orderedKeys)
  91. return orderedKeys, providers, nil
  92. }
  93. // InitOAuth2 initialize the OAuth2 lib and register all active OAuth2 providers in the library
  94. func InitOAuth2() error {
  95. if err := oauth2.Init(x); err != nil {
  96. return err
  97. }
  98. loginSources, _ := GetActiveOAuth2ProviderLoginSources()
  99. for _, source := range loginSources {
  100. oAuth2Config := source.OAuth2()
  101. err := oauth2.RegisterProvider(source.Name, oAuth2Config.Provider, oAuth2Config.ClientID, oAuth2Config.ClientSecret, oAuth2Config.OpenIDConnectAutoDiscoveryURL, oAuth2Config.CustomURLMapping)
  102. if err != nil {
  103. return err
  104. }
  105. }
  106. return nil
  107. }
  108. // wrapOpenIDConnectInitializeError is used to wrap the error but this cannot be done in modules/auth/oauth2
  109. // inside oauth2: import cycle not allowed models -> modules/auth/oauth2 -> models
  110. func wrapOpenIDConnectInitializeError(err error, providerName string, oAuth2Config *OAuth2Config) error {
  111. if err != nil && "openidConnect" == oAuth2Config.Provider {
  112. err = ErrOpenIDConnectInitialize{ProviderName: providerName, OpenIDConnectAutoDiscoveryURL: oAuth2Config.OpenIDConnectAutoDiscoveryURL, Cause: err}
  113. }
  114. return err
  115. }