auth_proxy.go 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. package middleware
  2. import (
  3. "fmt"
  4. "net"
  5. "net/mail"
  6. "reflect"
  7. "strings"
  8. "time"
  9. "github.com/grafana/grafana/pkg/bus"
  10. "github.com/grafana/grafana/pkg/log"
  11. "github.com/grafana/grafana/pkg/login"
  12. m "github.com/grafana/grafana/pkg/models"
  13. "github.com/grafana/grafana/pkg/services/session"
  14. "github.com/grafana/grafana/pkg/setting"
  15. )
  16. var (
  17. AUTH_PROXY_SESSION_VAR = "authProxyHeaderValue"
  18. )
  19. func initContextWithAuthProxy(ctx *m.ReqContext, orgID int64) bool {
  20. if !setting.AuthProxyEnabled {
  21. return false
  22. }
  23. proxyHeaderValue := ctx.Req.Header.Get(setting.AuthProxyHeaderName)
  24. if len(proxyHeaderValue) == 0 {
  25. return false
  26. }
  27. // if auth proxy ip(s) defined, check if request comes from one of those
  28. if err := checkAuthenticationProxy(ctx.Req.RemoteAddr, proxyHeaderValue); err != nil {
  29. ctx.Handle(407, "Proxy authentication required", err)
  30. return true
  31. }
  32. // initialize session
  33. if err := ctx.Session.Start(ctx.Context); err != nil {
  34. log.Error(3, "Failed to start session. error %v", err)
  35. return false
  36. }
  37. query := &m.GetSignedInUserQuery{OrgId: orgID}
  38. // if this session has already been authenticated by authProxy just load the user
  39. sessProxyValue := ctx.Session.Get(AUTH_PROXY_SESSION_VAR)
  40. if sessProxyValue != nil && sessProxyValue.(string) == proxyHeaderValue && getRequestUserId(ctx) > 0 {
  41. // if we're using ldap, sync user periodically
  42. if setting.LdapEnabled {
  43. syncQuery := &m.LoginUserQuery{
  44. ReqContext: ctx,
  45. Username: proxyHeaderValue,
  46. }
  47. if err := syncGrafanaUserWithLdapUser(syncQuery); err != nil {
  48. if err == login.ErrInvalidCredentials {
  49. ctx.Handle(500, "Unable to authenticate user", err)
  50. return false
  51. }
  52. ctx.Handle(500, "Failed to sync user", err)
  53. return false
  54. }
  55. }
  56. query.UserId = getRequestUserId(ctx)
  57. // if we're using ldap, pass authproxy login name to ldap user sync
  58. } else if setting.LdapEnabled {
  59. ctx.Session.Delete(session.SESS_KEY_LASTLDAPSYNC) //makes sure we always sync with ldap if session if we only have last sync info in session but not user.
  60. syncQuery := &m.LoginUserQuery{
  61. ReqContext: ctx,
  62. Username: proxyHeaderValue,
  63. }
  64. if err := syncGrafanaUserWithLdapUser(syncQuery); err != nil {
  65. if err == login.ErrInvalidCredentials {
  66. ctx.Handle(500, "Unable to authenticate user", err)
  67. return false
  68. }
  69. ctx.Handle(500, "Failed to sync user", err)
  70. return false
  71. }
  72. if syncQuery.User == nil {
  73. ctx.Handle(500, "Failed to sync user", nil)
  74. return false
  75. }
  76. query.UserId = syncQuery.User.Id
  77. // no ldap, just use the info we have
  78. } else {
  79. extUser := &m.ExternalUserInfo{
  80. AuthModule: "authproxy",
  81. AuthId: proxyHeaderValue,
  82. }
  83. if setting.AuthProxyHeaderProperty == "username" {
  84. extUser.Login = proxyHeaderValue
  85. // only set Email if it can be parsed as an email address
  86. emailAddr, emailErr := mail.ParseAddress(proxyHeaderValue)
  87. if emailErr == nil {
  88. extUser.Email = emailAddr.Address
  89. }
  90. } else if setting.AuthProxyHeaderProperty == "email" {
  91. extUser.Email = proxyHeaderValue
  92. extUser.Login = proxyHeaderValue
  93. } else {
  94. ctx.Handle(500, "Auth proxy header property invalid", nil)
  95. return true
  96. }
  97. for _, field := range []string{"Name", "Email", "Login"} {
  98. if setting.AuthProxyHeaders[field] == "" {
  99. continue
  100. }
  101. if val := ctx.Req.Header.Get(setting.AuthProxyHeaders[field]); val != "" {
  102. reflect.ValueOf(extUser).Elem().FieldByName(field).SetString(val)
  103. }
  104. }
  105. // add/update user in grafana
  106. cmd := &m.UpsertUserCommand{
  107. ReqContext: ctx,
  108. ExternalUser: extUser,
  109. SignupAllowed: setting.AuthProxyAutoSignUp,
  110. }
  111. err := bus.Dispatch(cmd)
  112. if err != nil {
  113. ctx.Handle(500, "Failed to login as user specified in auth proxy header", err)
  114. return true
  115. }
  116. query.UserId = cmd.Result.Id
  117. }
  118. if err := bus.Dispatch(query); err != nil {
  119. ctx.Handle(500, "Failed to find user", err)
  120. return true
  121. }
  122. // Make sure that we cannot share a session between different users!
  123. if getRequestUserId(ctx) > 0 && getRequestUserId(ctx) != query.Result.UserId {
  124. // remove session
  125. if err := ctx.Session.Destory(ctx.Context); err != nil {
  126. log.Error(3, "Failed to destroy session. error: %v", err)
  127. }
  128. // initialize a new session
  129. if err := ctx.Session.Start(ctx.Context); err != nil {
  130. log.Error(3, "Failed to start session. error: %v", err)
  131. }
  132. }
  133. ctx.Session.Set(AUTH_PROXY_SESSION_VAR, proxyHeaderValue)
  134. ctx.SignedInUser = query.Result
  135. ctx.IsSignedIn = true
  136. ctx.Session.Set(session.SESS_KEY_USERID, ctx.UserId)
  137. if err := ctx.Session.Release(); err != nil {
  138. ctx.Logger.Error("failed to save session data", "error", err)
  139. }
  140. return true
  141. }
  142. var syncGrafanaUserWithLdapUser = func(query *m.LoginUserQuery) error {
  143. expireEpoch := time.Now().Add(time.Duration(-setting.AuthProxyLdapSyncTtl) * time.Minute).Unix()
  144. var lastLdapSync int64
  145. if lastLdapSyncInSession := query.ReqContext.Session.Get(session.SESS_KEY_LASTLDAPSYNC); lastLdapSyncInSession != nil {
  146. lastLdapSync = lastLdapSyncInSession.(int64)
  147. }
  148. if lastLdapSync < expireEpoch {
  149. ldapCfg := login.LdapCfg
  150. if len(ldapCfg.Servers) < 1 {
  151. return fmt.Errorf("No LDAP servers available")
  152. }
  153. for _, server := range ldapCfg.Servers {
  154. author := login.NewLdapAuthenticator(server)
  155. if err := author.SyncUser(query); err != nil {
  156. return err
  157. }
  158. }
  159. query.ReqContext.Session.Set(session.SESS_KEY_LASTLDAPSYNC, time.Now().Unix())
  160. }
  161. return nil
  162. }
  163. func getRequestUserId(c *m.ReqContext) int64 {
  164. userID := c.Session.Get(session.SESS_KEY_USERID)
  165. if userID != nil {
  166. return userID.(int64)
  167. }
  168. return 0
  169. }
  170. func checkAuthenticationProxy(remoteAddr string, proxyHeaderValue string) error {
  171. if len(strings.TrimSpace(setting.AuthProxyWhitelist)) == 0 {
  172. return nil
  173. }
  174. proxies := strings.Split(setting.AuthProxyWhitelist, ",")
  175. var proxyObjs []*net.IPNet
  176. for _, proxy := range proxies {
  177. proxyObjs = append(proxyObjs, coerceProxyAddress(proxy))
  178. }
  179. sourceIP, _, _ := net.SplitHostPort(remoteAddr)
  180. sourceObj := net.ParseIP(sourceIP)
  181. for _, proxyObj := range proxyObjs {
  182. if proxyObj.Contains(sourceObj) {
  183. return nil
  184. }
  185. }
  186. return fmt.Errorf("Request for user (%s) from %s is not from the authentication proxy", proxyHeaderValue, sourceIP)
  187. }
  188. func coerceProxyAddress(proxyAddr string) *net.IPNet {
  189. proxyAddr = strings.TrimSpace(proxyAddr)
  190. if !strings.Contains(proxyAddr, "/") {
  191. proxyAddr = strings.Join([]string{proxyAddr, "32"}, "/")
  192. }
  193. _, network, err := net.ParseCIDR(proxyAddr)
  194. if err != nil {
  195. fmt.Println(err)
  196. }
  197. return network
  198. }