social.go 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. package social
  2. import (
  3. "net/http"
  4. "strings"
  5. "context"
  6. "golang.org/x/oauth2"
  7. "github.com/grafana/grafana/pkg/log"
  8. "github.com/grafana/grafana/pkg/setting"
  9. "github.com/grafana/grafana/pkg/util"
  10. )
  11. type BasicUserInfo struct {
  12. Id string
  13. Name string
  14. Email string
  15. Login string
  16. Company string
  17. Role string
  18. }
  19. type SocialConnector interface {
  20. Type() int
  21. UserInfo(client *http.Client, token *oauth2.Token) (*BasicUserInfo, error)
  22. IsEmailAllowed(email string) bool
  23. IsSignupAllowed() bool
  24. AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string
  25. Exchange(ctx context.Context, code string) (*oauth2.Token, error)
  26. Client(ctx context.Context, t *oauth2.Token) *http.Client
  27. }
  28. type SocialBase struct {
  29. *oauth2.Config
  30. log log.Logger
  31. }
  32. type Error struct {
  33. s string
  34. }
  35. func (e *Error) Error() string {
  36. return e.s
  37. }
  38. const (
  39. grafanaCom = "grafana_com"
  40. )
  41. var (
  42. SocialBaseUrl = "/login/"
  43. SocialMap = make(map[string]SocialConnector)
  44. allOauthes = []string{"github", "gitlab", "google", "generic_oauth", "grafananet", grafanaCom}
  45. )
  46. func NewOAuthService() {
  47. setting.OAuthService = &setting.OAuther{}
  48. setting.OAuthService.OAuthInfos = make(map[string]*setting.OAuthInfo)
  49. for _, name := range allOauthes {
  50. sec := setting.Raw.Section("auth." + name)
  51. info := &setting.OAuthInfo{
  52. ClientId: sec.Key("client_id").String(),
  53. ClientSecret: sec.Key("client_secret").String(),
  54. Scopes: util.SplitString(sec.Key("scopes").String()),
  55. AuthUrl: sec.Key("auth_url").String(),
  56. TokenUrl: sec.Key("token_url").String(),
  57. ApiUrl: sec.Key("api_url").String(),
  58. Enabled: sec.Key("enabled").MustBool(),
  59. EmailAttributeName: sec.Key("email_attribute_name").String(),
  60. AllowedDomains: util.SplitString(sec.Key("allowed_domains").String()),
  61. HostedDomain: sec.Key("hosted_domain").String(),
  62. AllowSignup: sec.Key("allow_sign_up").MustBool(),
  63. Name: sec.Key("name").MustString(name),
  64. TlsClientCert: sec.Key("tls_client_cert").String(),
  65. TlsClientKey: sec.Key("tls_client_key").String(),
  66. TlsClientCa: sec.Key("tls_client_ca").String(),
  67. TlsSkipVerify: sec.Key("tls_skip_verify_insecure").MustBool(),
  68. SendClientCredentialsViaPost: sec.Key("send_client_credentials_via_post").MustBool(),
  69. }
  70. if !info.Enabled {
  71. continue
  72. }
  73. // handle the clients that do not properly support Basic auth headers and require passing client_id/client_secret via POST payload
  74. if info.SendClientCredentialsViaPost {
  75. oauth2.RegisterBrokenAuthHeaderProvider(info.TokenUrl)
  76. }
  77. if name == "grafananet" {
  78. name = grafanaCom
  79. }
  80. setting.OAuthService.OAuthInfos[name] = info
  81. config := oauth2.Config{
  82. ClientID: info.ClientId,
  83. ClientSecret: info.ClientSecret,
  84. Endpoint: oauth2.Endpoint{
  85. AuthURL: info.AuthUrl,
  86. TokenURL: info.TokenUrl,
  87. },
  88. RedirectURL: strings.TrimSuffix(setting.AppUrl, "/") + SocialBaseUrl + name,
  89. Scopes: info.Scopes,
  90. }
  91. logger := log.New("oauth." + name)
  92. // GitHub.
  93. if name == "github" {
  94. SocialMap["github"] = &SocialGithub{
  95. SocialBase: &SocialBase{
  96. Config: &config,
  97. log: logger,
  98. },
  99. allowedDomains: info.AllowedDomains,
  100. apiUrl: info.ApiUrl,
  101. allowSignup: info.AllowSignup,
  102. teamIds: sec.Key("team_ids").Ints(","),
  103. allowedOrganizations: util.SplitString(sec.Key("allowed_organizations").String()),
  104. }
  105. }
  106. // GitLab.
  107. if name == "gitlab" {
  108. SocialMap["gitlab"] = &SocialGitlab{
  109. SocialBase: &SocialBase{
  110. Config: &config,
  111. log: logger,
  112. },
  113. allowedDomains: info.AllowedDomains,
  114. apiUrl: info.ApiUrl,
  115. allowSignup: info.AllowSignup,
  116. allowedGroups: util.SplitString(sec.Key("allowed_groups").String()),
  117. }
  118. }
  119. // Google.
  120. if name == "google" {
  121. SocialMap["google"] = &SocialGoogle{
  122. SocialBase: &SocialBase{
  123. Config: &config,
  124. log: logger,
  125. },
  126. allowedDomains: info.AllowedDomains,
  127. hostedDomain: info.HostedDomain,
  128. apiUrl: info.ApiUrl,
  129. allowSignup: info.AllowSignup,
  130. }
  131. }
  132. // Generic - Uses the same scheme as Github.
  133. if name == "generic_oauth" {
  134. SocialMap["generic_oauth"] = &SocialGenericOAuth{
  135. SocialBase: &SocialBase{
  136. Config: &config,
  137. log: logger,
  138. },
  139. allowedDomains: info.AllowedDomains,
  140. apiUrl: info.ApiUrl,
  141. allowSignup: info.AllowSignup,
  142. emailAttributeName: info.EmailAttributeName,
  143. teamIds: sec.Key("team_ids").Ints(","),
  144. allowedOrganizations: util.SplitString(sec.Key("allowed_organizations").String()),
  145. }
  146. }
  147. if name == grafanaCom {
  148. config = oauth2.Config{
  149. ClientID: info.ClientId,
  150. ClientSecret: info.ClientSecret,
  151. Endpoint: oauth2.Endpoint{
  152. AuthURL: setting.GrafanaComUrl + "/oauth2/authorize",
  153. TokenURL: setting.GrafanaComUrl + "/api/oauth2/token",
  154. },
  155. RedirectURL: strings.TrimSuffix(setting.AppUrl, "/") + SocialBaseUrl + name,
  156. Scopes: info.Scopes,
  157. }
  158. SocialMap[grafanaCom] = &SocialGrafanaCom{
  159. SocialBase: &SocialBase{
  160. Config: &config,
  161. log: logger,
  162. },
  163. url: setting.GrafanaComUrl,
  164. allowSignup: info.AllowSignup,
  165. allowedOrganizations: util.SplitString(sec.Key("allowed_organizations").String()),
  166. }
  167. }
  168. }
  169. }
  170. // GetOAuthProviders returns available oauth providers and if they're enabled or not
  171. var GetOAuthProviders = func(cfg *setting.Cfg) map[string]bool {
  172. result := map[string]bool{}
  173. if cfg == nil || cfg.Raw == nil {
  174. return result
  175. }
  176. for _, name := range allOauthes {
  177. if name == "grafananet" {
  178. name = grafanaCom
  179. }
  180. sec := cfg.Raw.Section("auth." + name)
  181. if sec == nil {
  182. continue
  183. }
  184. result[name] = sec.Key("enabled").MustBool()
  185. }
  186. return result
  187. }