login.go 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. package api
  2. import (
  3. "encoding/hex"
  4. "net/http"
  5. "net/url"
  6. "github.com/grafana/grafana/pkg/api/dtos"
  7. "github.com/grafana/grafana/pkg/bus"
  8. "github.com/grafana/grafana/pkg/infra/log"
  9. "github.com/grafana/grafana/pkg/infra/metrics"
  10. "github.com/grafana/grafana/pkg/login"
  11. "github.com/grafana/grafana/pkg/middleware"
  12. "github.com/grafana/grafana/pkg/models"
  13. "github.com/grafana/grafana/pkg/setting"
  14. "github.com/grafana/grafana/pkg/util"
  15. )
  16. const (
  17. ViewIndex = "index"
  18. LoginErrorCookieName = "login_error"
  19. )
  20. var setIndexViewData = (*HTTPServer).setIndexViewData
  21. var getViewIndex = func() string {
  22. return ViewIndex
  23. }
  24. func (hs *HTTPServer) LoginView(c *models.ReqContext) {
  25. viewData, err := setIndexViewData(hs, c)
  26. if err != nil {
  27. c.Handle(500, "Failed to get settings", err)
  28. return
  29. }
  30. enabledOAuths := make(map[string]interface{})
  31. for key, oauth := range setting.OAuthService.OAuthInfos {
  32. enabledOAuths[key] = map[string]string{"name": oauth.Name}
  33. }
  34. viewData.Settings["oauth"] = enabledOAuths
  35. viewData.Settings["disableUserSignUp"] = !setting.AllowUserSignUp
  36. viewData.Settings["loginHint"] = setting.LoginHint
  37. viewData.Settings["passwordHint"] = setting.PasswordHint
  38. viewData.Settings["disableLoginForm"] = setting.DisableLoginForm
  39. viewData.Settings["samlEnabled"] = setting.IsEnterprise && hs.Cfg.SAMLEnabled
  40. if loginError, ok := tryGetEncryptedCookie(c, LoginErrorCookieName); ok {
  41. //this cookie is only set whenever an OAuth login fails
  42. //therefore the loginError should be passed to the view data
  43. //and the view should return immediately before attempting
  44. //to login again via OAuth and enter to a redirect loop
  45. deleteCookie(c, LoginErrorCookieName)
  46. viewData.Settings["loginError"] = loginError
  47. c.HTML(200, getViewIndex(), viewData)
  48. return
  49. }
  50. if tryOAuthAutoLogin(c) {
  51. return
  52. }
  53. if !c.IsSignedIn {
  54. c.HTML(200, ViewIndex, viewData)
  55. return
  56. }
  57. if redirectTo, _ := url.QueryUnescape(c.GetCookie("redirect_to")); len(redirectTo) > 0 {
  58. c.SetCookie("redirect_to", "", -1, setting.AppSubUrl+"/")
  59. c.Redirect(redirectTo)
  60. return
  61. }
  62. c.Redirect(setting.AppSubUrl + "/")
  63. }
  64. func tryOAuthAutoLogin(c *models.ReqContext) bool {
  65. if !setting.OAuthAutoLogin {
  66. return false
  67. }
  68. oauthInfos := setting.OAuthService.OAuthInfos
  69. if len(oauthInfos) != 1 {
  70. log.Warn("Skipping OAuth auto login because multiple OAuth providers are configured")
  71. return false
  72. }
  73. for key := range setting.OAuthService.OAuthInfos {
  74. redirectUrl := setting.AppSubUrl + "/login/" + key
  75. log.Info("OAuth auto login enabled. Redirecting to " + redirectUrl)
  76. c.Redirect(redirectUrl, 307)
  77. return true
  78. }
  79. return false
  80. }
  81. func (hs *HTTPServer) LoginAPIPing(c *models.ReqContext) Response {
  82. if c.IsSignedIn || c.IsAnonymous {
  83. return JSON(200, "Logged in")
  84. }
  85. return Error(401, "Unauthorized", nil)
  86. }
  87. func (hs *HTTPServer) LoginPost(c *models.ReqContext, cmd dtos.LoginCommand) Response {
  88. if setting.DisableLoginForm {
  89. return Error(401, "Login is disabled", nil)
  90. }
  91. authQuery := &models.LoginUserQuery{
  92. ReqContext: c,
  93. Username: cmd.User,
  94. Password: cmd.Password,
  95. IpAddress: c.Req.RemoteAddr,
  96. }
  97. if err := bus.Dispatch(authQuery); err != nil {
  98. e401 := Error(401, "Invalid username or password", err)
  99. if err == login.ErrInvalidCredentials || err == login.ErrTooManyLoginAttempts {
  100. return e401
  101. }
  102. // Do not expose disabled status,
  103. // just show incorrect user credentials error (see #17947)
  104. if err == login.ErrUserDisabled {
  105. hs.log.Warn("User is disabled", "user", cmd.User)
  106. return e401
  107. }
  108. return Error(500, "Error while trying to authenticate user", err)
  109. }
  110. user := authQuery.User
  111. hs.loginUserWithUser(user, c)
  112. result := map[string]interface{}{
  113. "message": "Logged in",
  114. }
  115. if redirectTo, _ := url.QueryUnescape(c.GetCookie("redirect_to")); len(redirectTo) > 0 {
  116. result["redirectUrl"] = redirectTo
  117. c.SetCookie("redirect_to", "", -1, setting.AppSubUrl+"/")
  118. }
  119. metrics.MApiLoginPost.Inc()
  120. return JSON(200, result)
  121. }
  122. func (hs *HTTPServer) loginUserWithUser(user *models.User, c *models.ReqContext) {
  123. if user == nil {
  124. hs.log.Error("user login with nil user")
  125. }
  126. userToken, err := hs.AuthTokenService.CreateToken(c.Req.Context(), user.Id, c.RemoteAddr(), c.Req.UserAgent())
  127. if err != nil {
  128. hs.log.Error("failed to create auth token", "error", err)
  129. }
  130. hs.log.Info("Successful Login", "User", user.Email)
  131. middleware.WriteSessionCookie(c, userToken.UnhashedToken, hs.Cfg.LoginMaxLifetimeDays)
  132. }
  133. func (hs *HTTPServer) Logout(c *models.ReqContext) {
  134. if err := hs.AuthTokenService.RevokeToken(c.Req.Context(), c.UserToken); err != nil && err != models.ErrUserTokenNotFound {
  135. hs.log.Error("failed to revoke auth token", "error", err)
  136. }
  137. middleware.WriteSessionCookie(c, "", -1)
  138. if setting.SignoutRedirectUrl != "" {
  139. c.Redirect(setting.SignoutRedirectUrl)
  140. } else {
  141. hs.log.Info("Successful Logout", "User", c.Email)
  142. c.Redirect(setting.AppSubUrl + "/login")
  143. }
  144. }
  145. func tryGetEncryptedCookie(ctx *models.ReqContext, cookieName string) (string, bool) {
  146. cookie := ctx.GetCookie(cookieName)
  147. if cookie == "" {
  148. return "", false
  149. }
  150. decoded, err := hex.DecodeString(cookie)
  151. if err != nil {
  152. return "", false
  153. }
  154. decryptedError, err := util.Decrypt(decoded, setting.SecretKey)
  155. return string(decryptedError), err == nil
  156. }
  157. func deleteCookie(ctx *models.ReqContext, cookieName string) {
  158. ctx.SetCookie(cookieName, "", -1, setting.AppSubUrl+"/")
  159. }
  160. func (hs *HTTPServer) trySetEncryptedCookie(ctx *models.ReqContext, cookieName string, value string, maxAge int) error {
  161. encryptedError, err := util.Encrypt([]byte(value), setting.SecretKey)
  162. if err != nil {
  163. return err
  164. }
  165. cookie := http.Cookie{
  166. Name: cookieName,
  167. MaxAge: 60,
  168. Value: hex.EncodeToString(encryptedError),
  169. HttpOnly: true,
  170. Path: setting.AppSubUrl + "/",
  171. Secure: hs.Cfg.CookieSecure,
  172. }
  173. if hs.Cfg.CookieSameSite != http.SameSiteDefaultMode {
  174. cookie.SameSite = hs.Cfg.CookieSameSite
  175. }
  176. http.SetCookie(ctx.Resp, &cookie)
  177. return nil
  178. }