auth_proxy.go 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. package middleware
  2. import (
  3. "fmt"
  4. "net"
  5. "net/mail"
  6. "strings"
  7. "time"
  8. "github.com/grafana/grafana/pkg/bus"
  9. "github.com/grafana/grafana/pkg/log"
  10. "github.com/grafana/grafana/pkg/login"
  11. m "github.com/grafana/grafana/pkg/models"
  12. "github.com/grafana/grafana/pkg/services/session"
  13. "github.com/grafana/grafana/pkg/setting"
  14. )
  15. var AUTH_PROXY_SESSION_VAR = "authProxyHeaderValue"
  16. func initContextWithAuthProxy(ctx *m.ReqContext, orgID int64) bool {
  17. if !setting.AuthProxyEnabled {
  18. return false
  19. }
  20. proxyHeaderValue := ctx.Req.Header.Get(setting.AuthProxyHeaderName)
  21. if len(proxyHeaderValue) == 0 {
  22. return false
  23. }
  24. // if auth proxy ip(s) defined, check if request comes from one of those
  25. if err := checkAuthenticationProxy(ctx.Req.RemoteAddr, proxyHeaderValue); err != nil {
  26. ctx.Handle(407, "Proxy authentication required", err)
  27. return true
  28. }
  29. // initialize session
  30. if err := ctx.Session.Start(ctx.Context); err != nil {
  31. log.Error(3, "Failed to start session", err)
  32. return false
  33. }
  34. query := &m.GetSignedInUserQuery{OrgId: orgID}
  35. // if this session has already been authenticated by authProxy just load the user
  36. sessProxyValue := ctx.Session.Get(AUTH_PROXY_SESSION_VAR)
  37. if sessProxyValue != nil && sessProxyValue.(string) == proxyHeaderValue && getRequestUserId(ctx) > 0 {
  38. query.UserId = getRequestUserId(ctx)
  39. if err := bus.Dispatch(query); err != nil {
  40. ctx.Handle(500, "Failed to find user", err)
  41. return true
  42. }
  43. } else {
  44. extUser := &m.ExternalUserInfo{
  45. AuthModule: "authproxy",
  46. AuthId: proxyHeaderValue,
  47. }
  48. if setting.AuthProxyHeaderProperty == "username" {
  49. extUser.Login = proxyHeaderValue
  50. // only set Email if it can be parsed as an email address
  51. emailAddr, emailErr := mail.ParseAddress(proxyHeaderValue)
  52. if emailErr == nil {
  53. extUser.Email = emailAddr.Address
  54. }
  55. } else if setting.AuthProxyHeaderProperty == "email" {
  56. extUser.Email = proxyHeaderValue
  57. extUser.Login = proxyHeaderValue
  58. } else {
  59. ctx.Handle(500, "Auth proxy header property invalid", nil)
  60. return true
  61. }
  62. // add/update user in grafana
  63. cmd := &m.UpsertUserCommand{
  64. ReqContext: ctx,
  65. ExternalUser: extUser,
  66. SignupAllowed: setting.AuthProxyAutoSignUp,
  67. }
  68. err := bus.Dispatch(cmd)
  69. if err != nil {
  70. ctx.Handle(500, "Failed to login as user specified in auth proxy header", err)
  71. return true
  72. }
  73. query.UserId = cmd.Result.Id
  74. if err := bus.Dispatch(query); err != nil {
  75. ctx.Handle(500, "Failed to find user", err)
  76. return true
  77. }
  78. // Make sure that we cannot share a session between different users!
  79. if getRequestUserId(ctx) > 0 && getRequestUserId(ctx) != query.Result.UserId {
  80. // remove session
  81. if err := ctx.Session.Destory(ctx.Context); err != nil {
  82. log.Error(3, "Failed to destroy session, err")
  83. }
  84. // initialize a new session
  85. if err := ctx.Session.Start(ctx.Context); err != nil {
  86. log.Error(3, "Failed to start session", err)
  87. }
  88. }
  89. ctx.Session.Set(AUTH_PROXY_SESSION_VAR, proxyHeaderValue)
  90. }
  91. // When ldap is enabled, sync userinfo and org roles
  92. if err := syncGrafanaUserWithLdapUser(ctx, query); err != nil {
  93. if err == login.ErrInvalidCredentials {
  94. ctx.Handle(500, "Unable to authenticate user", err)
  95. return false
  96. }
  97. ctx.Handle(500, "Failed to sync user", err)
  98. return false
  99. }
  100. ctx.SignedInUser = query.Result
  101. ctx.IsSignedIn = true
  102. ctx.Session.Set(session.SESS_KEY_USERID, ctx.UserId)
  103. return true
  104. }
  105. var syncGrafanaUserWithLdapUser = func(ctx *m.ReqContext, query *m.GetSignedInUserQuery) error {
  106. if !setting.LdapEnabled {
  107. return nil
  108. }
  109. expireEpoch := time.Now().Add(time.Duration(-setting.AuthProxyLdapSyncTtl) * time.Minute).Unix()
  110. var lastLdapSync int64
  111. if lastLdapSyncInSession := ctx.Session.Get(session.SESS_KEY_LASTLDAPSYNC); lastLdapSyncInSession != nil {
  112. lastLdapSync = lastLdapSyncInSession.(int64)
  113. }
  114. if lastLdapSync < expireEpoch {
  115. ldapCfg := login.LdapCfg
  116. for _, server := range ldapCfg.Servers {
  117. author := login.NewLdapAuthenticator(server)
  118. if err := author.SyncSignedInUser(ctx, query.Result); err != nil {
  119. return err
  120. }
  121. }
  122. ctx.Session.Set(session.SESS_KEY_LASTLDAPSYNC, time.Now().Unix())
  123. }
  124. return nil
  125. }
  126. func checkAuthenticationProxy(remoteAddr string, proxyHeaderValue string) error {
  127. if len(strings.TrimSpace(setting.AuthProxyWhitelist)) == 0 {
  128. return nil
  129. }
  130. proxies := strings.Split(setting.AuthProxyWhitelist, ",")
  131. sourceIP, _, err := net.SplitHostPort(remoteAddr)
  132. if err != nil {
  133. return err
  134. }
  135. // Compare allowed IP addresses to actual address
  136. for _, proxyIP := range proxies {
  137. if sourceIP == strings.TrimSpace(proxyIP) {
  138. return nil
  139. }
  140. }
  141. return fmt.Errorf("Request for user (%s) from %s is not from the authentication proxy", proxyHeaderValue, sourceIP)
  142. }