oidc.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726
  1. // Copyright (C) 2019-2022 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package httpd
  15. import (
  16. "context"
  17. "errors"
  18. "fmt"
  19. "net/http"
  20. "net/url"
  21. "strings"
  22. "time"
  23. "github.com/coreos/go-oidc/v3/oidc"
  24. "github.com/rs/xid"
  25. "golang.org/x/oauth2"
  26. "github.com/drakkan/sftpgo/v2/internal/common"
  27. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  28. "github.com/drakkan/sftpgo/v2/internal/httpclient"
  29. "github.com/drakkan/sftpgo/v2/internal/logger"
  30. "github.com/drakkan/sftpgo/v2/internal/util"
  31. )
  32. const (
  33. oidcCookieKey = "oidc"
  34. adminRoleFieldValue = "admin"
  35. authStateValidity = 1 * 60 * 1000 // 1 minute
  36. tokenUpdateInterval = 3 * 60 * 1000 // 3 minutes
  37. tokenDeleteInterval = 2 * 3600 * 1000 // 2 hours
  38. )
  39. var (
  40. oidcTokenKey = &contextKey{"OIDC token key"}
  41. oidcGeneratedToken = &contextKey{"OIDC generated token"}
  42. )
  43. // OAuth2Config defines an interface for OAuth2 methods, so we can mock them
  44. type OAuth2Config interface {
  45. AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string
  46. Exchange(ctx context.Context, code string, opts ...oauth2.AuthCodeOption) (*oauth2.Token, error)
  47. TokenSource(ctx context.Context, t *oauth2.Token) oauth2.TokenSource
  48. }
  49. // OIDCTokenVerifier defines an interface for OpenID token verifier, so we can mock them
  50. type OIDCTokenVerifier interface {
  51. Verify(ctx context.Context, rawIDToken string) (*oidc.IDToken, error)
  52. }
  53. // OIDC defines the OpenID Connect configuration
  54. type OIDC struct {
  55. // ClientID is the application's ID
  56. ClientID string `json:"client_id" mapstructure:"client_id"`
  57. // ClientSecret is the application's secret
  58. ClientSecret string `json:"client_secret" mapstructure:"client_secret"`
  59. // ConfigURL is the identifier for the service.
  60. // SFTPGo will try to retrieve the provider configuration on startup and then
  61. // will refuse to start if it fails to connect to the specified URL
  62. ConfigURL string `json:"config_url" mapstructure:"config_url"`
  63. // RedirectBaseURL is the base URL to redirect to after OpenID authentication.
  64. // The suffix "/web/oidc/redirect" will be added to this base URL, adding also the
  65. // "web_root" if configured
  66. RedirectBaseURL string `json:"redirect_base_url" mapstructure:"redirect_base_url"`
  67. // ID token claims field to map to the SFTPGo username
  68. UsernameField string `json:"username_field" mapstructure:"username_field"`
  69. // Optional ID token claims field to map to a SFTPGo role.
  70. // If the defined ID token claims field is set to "admin" the authenticated user
  71. // is mapped to an SFTPGo admin.
  72. // You don't need to specify this field if you want to use OpenID only for the
  73. // Web Client UI
  74. RoleField string `json:"role_field" mapstructure:"role_field"`
  75. // If set, the `RoleField` is ignored and the SFTPGo role is assumed based on
  76. // the login link used
  77. ImplicitRoles bool `json:"implicit_roles" mapstructure:"implicit_roles"`
  78. // Scopes required by the OAuth provider to retrieve information about the authenticated user.
  79. // The "openid" scope is required.
  80. // Refer to your OAuth provider documentation for more information about this
  81. Scopes []string `json:"scopes" mapstructure:"scopes"`
  82. // Custom token claims fields to pass to the pre-login hook
  83. CustomFields []string `json:"custom_fields" mapstructure:"custom_fields"`
  84. // Debug enables the OIDC debug mode. In debug mode, the received id_token will be logged
  85. // at the debug level
  86. Debug bool `json:"debug" mapstructure:"debug"`
  87. provider *oidc.Provider
  88. verifier OIDCTokenVerifier
  89. providerLogoutURL string
  90. oauth2Config OAuth2Config
  91. }
  92. func (o *OIDC) isEnabled() bool {
  93. return o.provider != nil
  94. }
  95. func (o *OIDC) hasRoles() bool {
  96. return o.isEnabled() && (o.RoleField != "" || o.ImplicitRoles)
  97. }
  98. func (o *OIDC) getForcedRole(audience string) string {
  99. if !o.ImplicitRoles {
  100. return ""
  101. }
  102. if audience == tokenAudienceWebAdmin {
  103. return adminRoleFieldValue
  104. }
  105. return ""
  106. }
  107. func (o *OIDC) getRedirectURL() string {
  108. url := o.RedirectBaseURL
  109. if strings.HasSuffix(o.RedirectBaseURL, "/") {
  110. url = strings.TrimSuffix(o.RedirectBaseURL, "/")
  111. }
  112. url += webOIDCRedirectPath
  113. logger.Debug(logSender, "", "oidc redirect URL: %#v", url)
  114. return url
  115. }
  116. func (o *OIDC) initialize() error {
  117. if o.ConfigURL == "" {
  118. return nil
  119. }
  120. if o.UsernameField == "" {
  121. return errors.New("oidc: username field cannot be empty")
  122. }
  123. if o.RedirectBaseURL == "" {
  124. return errors.New("oidc: redirect base URL cannot be empty")
  125. }
  126. if !util.Contains(o.Scopes, oidc.ScopeOpenID) {
  127. return fmt.Errorf("oidc: required scope %q is not set", oidc.ScopeOpenID)
  128. }
  129. ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
  130. defer cancel()
  131. provider, err := oidc.NewProvider(ctx, o.ConfigURL)
  132. if err != nil {
  133. return fmt.Errorf("oidc: unable to initialize provider for URL %#v: %w", o.ConfigURL, err)
  134. }
  135. claims := make(map[string]any)
  136. // we cannot get an error here because the response body was already parsed as JSON
  137. // on provider creation
  138. provider.Claims(&claims) //nolint:errcheck
  139. endSessionEndPoint, ok := claims["end_session_endpoint"]
  140. if ok {
  141. if val, ok := endSessionEndPoint.(string); ok {
  142. o.providerLogoutURL = val
  143. logger.Debug(logSender, "", "oidc end session endpoint %#v", o.providerLogoutURL)
  144. }
  145. }
  146. o.provider = provider
  147. o.verifier = provider.Verifier(&oidc.Config{
  148. ClientID: o.ClientID,
  149. })
  150. o.oauth2Config = &oauth2.Config{
  151. ClientID: o.ClientID,
  152. ClientSecret: o.ClientSecret,
  153. Endpoint: o.provider.Endpoint(),
  154. RedirectURL: o.getRedirectURL(),
  155. Scopes: o.Scopes,
  156. }
  157. return nil
  158. }
  159. type oidcPendingAuth struct {
  160. State string `json:"state"`
  161. Nonce string `json:"nonce"`
  162. Audience tokenAudience `json:"audience"`
  163. IssuedAt int64 `json:"issued_at"`
  164. }
  165. func newOIDCPendingAuth(audience tokenAudience) oidcPendingAuth {
  166. return oidcPendingAuth{
  167. State: xid.New().String(),
  168. Nonce: xid.New().String(),
  169. Audience: audience,
  170. IssuedAt: util.GetTimeAsMsSinceEpoch(time.Now()),
  171. }
  172. }
  173. type oidcToken struct {
  174. AccessToken string `json:"access_token"`
  175. TokenType string `json:"token_type,omitempty"`
  176. RefreshToken string `json:"refresh_token,omitempty"`
  177. ExpiresAt int64 `json:"expires_at,omitempty"`
  178. SessionID string `json:"session_id"`
  179. IDToken string `json:"id_token"`
  180. Nonce string `json:"nonce"`
  181. Username string `json:"username"`
  182. Permissions []string `json:"permissions"`
  183. Role any `json:"role"`
  184. CustomFields *map[string]any `json:"custom_fields,omitempty"`
  185. Cookie string `json:"cookie"`
  186. UsedAt int64 `json:"used_at"`
  187. }
  188. func (t *oidcToken) parseClaims(claims map[string]any, usernameField, roleField string, customFields []string,
  189. forcedRole string,
  190. ) error {
  191. getClaimsFields := func() []string {
  192. keys := make([]string, 0, len(claims))
  193. for k := range claims {
  194. keys = append(keys, k)
  195. }
  196. return keys
  197. }
  198. username, ok := claims[usernameField].(string)
  199. if !ok || username == "" {
  200. logger.Warn(logSender, "", "username field %#v not found, claims fields: %+v", usernameField, getClaimsFields())
  201. return errors.New("no username field")
  202. }
  203. t.Username = username
  204. if forcedRole != "" {
  205. t.Role = forcedRole
  206. } else {
  207. t.getRoleFromField(claims, roleField)
  208. }
  209. t.CustomFields = nil
  210. if len(customFields) > 0 {
  211. for _, field := range customFields {
  212. if val, ok := claims[field]; ok {
  213. if t.CustomFields == nil {
  214. customFields := make(map[string]any)
  215. t.CustomFields = &customFields
  216. }
  217. logger.Debug(logSender, "", "custom field %#v found in token claims", field)
  218. (*t.CustomFields)[field] = val
  219. } else {
  220. logger.Info(logSender, "", "custom field %#v not found in token claims", field)
  221. }
  222. }
  223. }
  224. sid, ok := claims["sid"].(string)
  225. if ok {
  226. t.SessionID = sid
  227. }
  228. return nil
  229. }
  230. func (t *oidcToken) getRoleFromField(claims map[string]any, roleField string) {
  231. if roleField != "" {
  232. role, ok := claims[roleField]
  233. if ok {
  234. t.Role = role
  235. return
  236. }
  237. if !strings.Contains(roleField, ".") {
  238. return
  239. }
  240. getStructValue := func(outer any, field string) (any, bool) {
  241. switch val := outer.(type) {
  242. case map[string]any:
  243. res, ok := val[field]
  244. return res, ok
  245. }
  246. return nil, false
  247. }
  248. for idx, field := range strings.Split(roleField, ".") {
  249. if idx == 0 {
  250. role, ok = getStructValue(claims, field)
  251. } else {
  252. role, ok = getStructValue(role, field)
  253. }
  254. if !ok {
  255. return
  256. }
  257. }
  258. t.Role = role
  259. }
  260. }
  261. func (t *oidcToken) isAdmin() bool {
  262. switch v := t.Role.(type) {
  263. case string:
  264. return v == adminRoleFieldValue
  265. case []any:
  266. for _, s := range v {
  267. if val, ok := s.(string); ok && val == adminRoleFieldValue {
  268. return true
  269. }
  270. }
  271. return false
  272. default:
  273. return false
  274. }
  275. }
  276. func (t *oidcToken) isExpired() bool {
  277. if t.ExpiresAt == 0 {
  278. return false
  279. }
  280. return t.ExpiresAt < util.GetTimeAsMsSinceEpoch(time.Now())
  281. }
  282. func (t *oidcToken) refresh(config OAuth2Config, verifier OIDCTokenVerifier) error {
  283. if t.RefreshToken == "" {
  284. logger.Debug(logSender, "", "refresh token not set, unable to refresh cookie %#v", t.Cookie)
  285. return errors.New("refresh token not set")
  286. }
  287. oauth2Token := oauth2.Token{
  288. AccessToken: t.AccessToken,
  289. TokenType: t.TokenType,
  290. RefreshToken: t.RefreshToken,
  291. }
  292. if t.ExpiresAt > 0 {
  293. oauth2Token.Expiry = util.GetTimeFromMsecSinceEpoch(t.ExpiresAt)
  294. }
  295. ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
  296. defer cancel()
  297. newToken, err := config.TokenSource(ctx, &oauth2Token).Token()
  298. if err != nil {
  299. logger.Debug(logSender, "", "unable to refresh token for cookie %#v: %v", t.Cookie, err)
  300. return err
  301. }
  302. rawIDToken, ok := newToken.Extra("id_token").(string)
  303. if !ok {
  304. logger.Debug(logSender, "", "the refreshed token has no id token, cookie %#v", t.Cookie)
  305. return errors.New("the refreshed token has no id token")
  306. }
  307. t.AccessToken = newToken.AccessToken
  308. t.TokenType = newToken.TokenType
  309. t.RefreshToken = newToken.RefreshToken
  310. t.IDToken = rawIDToken
  311. if !newToken.Expiry.IsZero() {
  312. t.ExpiresAt = util.GetTimeAsMsSinceEpoch(newToken.Expiry)
  313. } else {
  314. t.ExpiresAt = 0
  315. }
  316. idToken, err := verifier.Verify(ctx, rawIDToken)
  317. if err != nil {
  318. logger.Debug(logSender, "", "unable to verify refreshed id token for cookie %#v: %v", t.Cookie, err)
  319. return err
  320. }
  321. if idToken.Nonce != t.Nonce {
  322. logger.Debug(logSender, "", "unable to verify refreshed id token for cookie %#v: nonce mismatch", t.Cookie)
  323. return errors.New("the refreshed token nonce mismatch")
  324. }
  325. claims := make(map[string]any)
  326. err = idToken.Claims(&claims)
  327. if err != nil {
  328. logger.Debug(logSender, "", "unable to get refreshed id token claims for cookie %#v: %v", t.Cookie, err)
  329. return err
  330. }
  331. sid, ok := claims["sid"].(string)
  332. if ok {
  333. t.SessionID = sid
  334. }
  335. logger.Debug(logSender, "", "oidc token refreshed for user %#v, cookie %#v", t.Username, t.Cookie)
  336. oidcMgr.addToken(*t)
  337. return nil
  338. }
  339. func (t *oidcToken) getUser(r *http.Request) error {
  340. if t.isAdmin() {
  341. admin, err := dataprovider.AdminExists(t.Username)
  342. if err != nil {
  343. return err
  344. }
  345. if err := admin.CanLogin(util.GetIPFromRemoteAddress(r.RemoteAddr)); err != nil {
  346. return err
  347. }
  348. t.Permissions = admin.Permissions
  349. dataprovider.UpdateAdminLastLogin(&admin)
  350. return nil
  351. }
  352. ipAddr := util.GetIPFromRemoteAddress(r.RemoteAddr)
  353. user, err := dataprovider.GetUserAfterIDPAuth(t.Username, ipAddr, common.ProtocolOIDC, t.CustomFields)
  354. if err != nil {
  355. return err
  356. }
  357. if err := common.Config.ExecutePostConnectHook(ipAddr, common.ProtocolOIDC); err != nil {
  358. updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
  359. return fmt.Errorf("access denied by post connect hook: %w", err)
  360. }
  361. if err := user.CheckLoginConditions(); err != nil {
  362. updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
  363. return err
  364. }
  365. connectionID := fmt.Sprintf("%v_%v", common.ProtocolOIDC, xid.New().String())
  366. if err := checkHTTPClientUser(&user, r, connectionID, true); err != nil {
  367. updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
  368. return err
  369. }
  370. defer user.CloseFs() //nolint:errcheck
  371. err = user.CheckFsRoot(connectionID)
  372. if err != nil {
  373. logger.Warn(logSender, connectionID, "unable to check fs root: %v", err)
  374. updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, common.ErrInternalFailure)
  375. return err
  376. }
  377. updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, nil)
  378. dataprovider.UpdateLastLogin(&user)
  379. t.Permissions = user.Filters.WebClient
  380. return nil
  381. }
  382. func (s *httpdServer) validateOIDCToken(w http.ResponseWriter, r *http.Request, isAdmin bool) (oidcToken, error) {
  383. doRedirect := func() {
  384. removeOIDCCookie(w, r)
  385. if isAdmin {
  386. http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
  387. return
  388. }
  389. http.Redirect(w, r, webClientLoginPath, http.StatusFound)
  390. }
  391. cookie, err := r.Cookie(oidcCookieKey)
  392. if err != nil {
  393. logger.Debug(logSender, "", "no oidc cookie, redirecting to login page")
  394. doRedirect()
  395. return oidcToken{}, errInvalidToken
  396. }
  397. token, err := oidcMgr.getToken(cookie.Value)
  398. if err != nil {
  399. logger.Debug(logSender, "", "error getting oidc token associated with cookie %#v: %v", cookie.Value, err)
  400. doRedirect()
  401. return oidcToken{}, errInvalidToken
  402. }
  403. if token.isExpired() {
  404. logger.Debug(logSender, "", "oidc token associated with cookie %#v is expired", token.Cookie)
  405. if err = token.refresh(s.binding.OIDC.oauth2Config, s.binding.OIDC.verifier); err != nil {
  406. setFlashMessage(w, r, "Your OpenID token is expired, please log-in again")
  407. doRedirect()
  408. return oidcToken{}, errInvalidToken
  409. }
  410. } else {
  411. oidcMgr.updateTokenUsage(token)
  412. }
  413. if isAdmin {
  414. if !token.isAdmin() {
  415. logger.Debug(logSender, "", "oidc token associated with cookie %#v is not valid for admin users", token.Cookie)
  416. setFlashMessage(w, r, "Your OpenID token is not valid for the SFTPGo Web Admin UI. Please logout from your OpenID server and log-in as an SFTPGo admin")
  417. doRedirect()
  418. return oidcToken{}, errInvalidToken
  419. }
  420. return token, nil
  421. }
  422. if token.isAdmin() {
  423. logger.Debug(logSender, "", "oidc token associated with cookie %#v is valid for admin users", token.Cookie)
  424. setFlashMessage(w, r, "Your OpenID token is not valid for the SFTPGo Web Client UI. Please logout from your OpenID server and log-in as an SFTPGo user")
  425. doRedirect()
  426. return oidcToken{}, errInvalidToken
  427. }
  428. return token, nil
  429. }
  430. func (s *httpdServer) oidcTokenAuthenticator(audience tokenAudience) func(next http.Handler) http.Handler {
  431. return func(next http.Handler) http.Handler {
  432. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  433. if canSkipOIDCValidation(r) {
  434. next.ServeHTTP(w, r)
  435. return
  436. }
  437. token, err := s.validateOIDCToken(w, r, audience == tokenAudienceWebAdmin)
  438. if err != nil {
  439. return
  440. }
  441. jwtTokenClaims := jwtTokenClaims{
  442. Username: token.Username,
  443. Permissions: token.Permissions,
  444. }
  445. _, tokenString, err := jwtTokenClaims.createToken(s.tokenAuth, audience, util.GetIPFromRemoteAddress(r.RemoteAddr))
  446. if err != nil {
  447. setFlashMessage(w, r, "Unable to create cookie")
  448. if audience == tokenAudienceWebAdmin {
  449. http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
  450. } else {
  451. http.Redirect(w, r, webClientLoginPath, http.StatusFound)
  452. }
  453. return
  454. }
  455. ctx := context.WithValue(r.Context(), oidcTokenKey, token.Cookie)
  456. ctx = context.WithValue(ctx, oidcGeneratedToken, tokenString)
  457. next.ServeHTTP(w, r.WithContext(ctx))
  458. })
  459. }
  460. }
  461. func (s *httpdServer) handleWebAdminOIDCLogin(w http.ResponseWriter, r *http.Request) {
  462. s.oidcLoginRedirect(w, r, tokenAudienceWebAdmin)
  463. }
  464. func (s *httpdServer) handleWebClientOIDCLogin(w http.ResponseWriter, r *http.Request) {
  465. s.oidcLoginRedirect(w, r, tokenAudienceWebClient)
  466. }
  467. func (s *httpdServer) oidcLoginRedirect(w http.ResponseWriter, r *http.Request, audience tokenAudience) {
  468. pendingAuth := newOIDCPendingAuth(audience)
  469. oidcMgr.addPendingAuth(pendingAuth)
  470. http.Redirect(w, r, s.binding.OIDC.oauth2Config.AuthCodeURL(pendingAuth.State,
  471. oidc.Nonce(pendingAuth.Nonce)), http.StatusFound)
  472. }
  473. func (s *httpdServer) debugTokenClaims(claims map[string]any, rawIDToken string) {
  474. if s.binding.OIDC.Debug {
  475. if claims == nil {
  476. logger.Debug(logSender, "", "raw id token %q", rawIDToken)
  477. } else {
  478. logger.Debug(logSender, "", "raw id token %q, parsed claims %+v", rawIDToken, claims)
  479. }
  480. }
  481. }
  482. func (s *httpdServer) handleOIDCRedirect(w http.ResponseWriter, r *http.Request) {
  483. state := r.URL.Query().Get("state")
  484. authReq, err := oidcMgr.getPendingAuth(state)
  485. if err != nil {
  486. logger.Debug(logSender, "", "oidc authentication state did not match")
  487. s.renderClientMessagePage(w, r, "Invalid authentication request", "Authentication state did not match",
  488. http.StatusBadRequest, nil, "")
  489. return
  490. }
  491. oidcMgr.removePendingAuth(state)
  492. doRedirect := func() {
  493. if authReq.Audience == tokenAudienceWebAdmin {
  494. http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
  495. return
  496. }
  497. http.Redirect(w, r, webClientLoginPath, http.StatusFound)
  498. }
  499. doLogout := func(rawIDToken string) {
  500. s.logoutFromOIDCOP(rawIDToken)
  501. }
  502. ctx, cancel := context.WithTimeout(r.Context(), 20*time.Second)
  503. defer cancel()
  504. oauth2Token, err := s.binding.OIDC.oauth2Config.Exchange(ctx, r.URL.Query().Get("code"))
  505. if err != nil {
  506. logger.Debug(logSender, "", "failed to exchange oidc token: %v", err)
  507. setFlashMessage(w, r, "Failed to exchange OpenID token")
  508. doRedirect()
  509. return
  510. }
  511. rawIDToken, ok := oauth2Token.Extra("id_token").(string)
  512. if !ok {
  513. logger.Debug(logSender, "", "no id_token field in OAuth2 OpenID token")
  514. setFlashMessage(w, r, "No id_token field in OAuth2 OpenID token")
  515. doRedirect()
  516. return
  517. }
  518. s.debugTokenClaims(nil, rawIDToken)
  519. idToken, err := s.binding.OIDC.verifier.Verify(ctx, rawIDToken)
  520. if err != nil {
  521. logger.Debug(logSender, "", "failed to verify oidc token: %v", err)
  522. setFlashMessage(w, r, "Failed to verify OpenID token")
  523. doRedirect()
  524. doLogout(rawIDToken)
  525. return
  526. }
  527. if idToken.Nonce != authReq.Nonce {
  528. logger.Debug(logSender, "", "oidc authentication nonce did not match")
  529. setFlashMessage(w, r, "OpenID authentication nonce did not match")
  530. doRedirect()
  531. doLogout(rawIDToken)
  532. return
  533. }
  534. claims := make(map[string]any)
  535. err = idToken.Claims(&claims)
  536. if err != nil {
  537. logger.Debug(logSender, "", "unable to get oidc token claims: %v", err)
  538. setFlashMessage(w, r, "Unable to get OpenID token claims")
  539. doRedirect()
  540. doLogout(rawIDToken)
  541. return
  542. }
  543. s.debugTokenClaims(claims, rawIDToken)
  544. token := oidcToken{
  545. AccessToken: oauth2Token.AccessToken,
  546. TokenType: oauth2Token.TokenType,
  547. RefreshToken: oauth2Token.RefreshToken,
  548. IDToken: rawIDToken,
  549. Nonce: idToken.Nonce,
  550. Cookie: xid.New().String(),
  551. }
  552. if !oauth2Token.Expiry.IsZero() {
  553. token.ExpiresAt = util.GetTimeAsMsSinceEpoch(oauth2Token.Expiry)
  554. }
  555. err = token.parseClaims(claims, s.binding.OIDC.UsernameField, s.binding.OIDC.RoleField,
  556. s.binding.OIDC.CustomFields, s.binding.OIDC.getForcedRole(authReq.Audience))
  557. if err != nil {
  558. logger.Debug(logSender, "", "unable to parse oidc token claims: %v", err)
  559. setFlashMessage(w, r, fmt.Sprintf("Unable to parse OpenID token claims: %v", err))
  560. doRedirect()
  561. doLogout(rawIDToken)
  562. return
  563. }
  564. switch authReq.Audience {
  565. case tokenAudienceWebAdmin:
  566. if !token.isAdmin() {
  567. logger.Debug(logSender, "", "wrong oidc token role, the mapped user is not an SFTPGo admin")
  568. setFlashMessage(w, r, "Wrong OpenID role, the logged in user is not an SFTPGo admin")
  569. doRedirect()
  570. doLogout(rawIDToken)
  571. return
  572. }
  573. case tokenAudienceWebClient:
  574. if token.isAdmin() {
  575. logger.Debug(logSender, "", "wrong oidc token role, the mapped user is an SFTPGo admin")
  576. setFlashMessage(w, r, "Wrong OpenID role, the logged in user is an SFTPGo admin")
  577. doRedirect()
  578. doLogout(rawIDToken)
  579. return
  580. }
  581. }
  582. err = token.getUser(r)
  583. if err != nil {
  584. logger.Debug(logSender, "", "unable to get the sftpgo user associated with oidc token: %v", err)
  585. setFlashMessage(w, r, "Unable to get the user associated with the OpenID token")
  586. doRedirect()
  587. doLogout(rawIDToken)
  588. return
  589. }
  590. loginOIDCUser(w, r, token)
  591. }
  592. func loginOIDCUser(w http.ResponseWriter, r *http.Request, token oidcToken) {
  593. oidcMgr.addToken(token)
  594. cookie := http.Cookie{
  595. Name: oidcCookieKey,
  596. Value: token.Cookie,
  597. Path: "/",
  598. HttpOnly: true,
  599. Secure: isTLS(r),
  600. SameSite: http.SameSiteLaxMode,
  601. }
  602. // we don't set a cookie expiration so we can refresh the token without setting a new cookie
  603. // the cookie will be invalidated on browser close
  604. http.SetCookie(w, &cookie)
  605. if token.isAdmin() {
  606. http.Redirect(w, r, webUsersPath, http.StatusFound)
  607. return
  608. }
  609. http.Redirect(w, r, webClientFilesPath, http.StatusFound)
  610. }
  611. func (s *httpdServer) logoutOIDCUser(w http.ResponseWriter, r *http.Request) {
  612. if oidcKey, ok := r.Context().Value(oidcTokenKey).(string); ok {
  613. removeOIDCCookie(w, r)
  614. token, err := oidcMgr.getToken(oidcKey)
  615. if err == nil {
  616. s.logoutFromOIDCOP(token.IDToken)
  617. }
  618. oidcMgr.removeToken(oidcKey)
  619. }
  620. }
  621. func (s *httpdServer) logoutFromOIDCOP(idToken string) {
  622. if s.binding.OIDC.providerLogoutURL == "" {
  623. logger.Debug(logSender, "", "oidc: provider logout URL not set, unable to logout from the OP")
  624. return
  625. }
  626. go s.doOIDCFromLogout(idToken)
  627. }
  628. func (s *httpdServer) doOIDCFromLogout(idToken string) {
  629. logoutURL, err := url.Parse(s.binding.OIDC.providerLogoutURL)
  630. if err != nil {
  631. logger.Warn(logSender, "", "oidc: unable to parse logout URL: %v", err)
  632. return
  633. }
  634. query := logoutURL.Query()
  635. if idToken != "" {
  636. query.Set("id_token_hint", idToken)
  637. }
  638. logoutURL.RawQuery = query.Encode()
  639. resp, err := httpclient.RetryableGet(logoutURL.String())
  640. if err != nil {
  641. logger.Warn(logSender, "", "oidc: error calling logout URL %#v: %v", logoutURL.String(), err)
  642. return
  643. }
  644. defer resp.Body.Close()
  645. logger.Debug(logSender, "", "oidc: logout url response code %v", resp.StatusCode)
  646. }
  647. func removeOIDCCookie(w http.ResponseWriter, r *http.Request) {
  648. http.SetCookie(w, &http.Cookie{
  649. Name: oidcCookieKey,
  650. Value: "",
  651. Path: "/",
  652. Expires: time.Unix(0, 0),
  653. MaxAge: -1,
  654. HttpOnly: true,
  655. Secure: isTLS(r),
  656. SameSite: http.SameSiteLaxMode,
  657. })
  658. }
  659. // canSkipOIDCValidation returns true if there is no OIDC cookie but a jwt cookie is set
  660. // and so we check if the user is logged in using a built-in user
  661. func canSkipOIDCValidation(r *http.Request) bool {
  662. _, err := r.Cookie(oidcCookieKey)
  663. if err != nil {
  664. _, err = r.Cookie(jwtCookieKey)
  665. return err == nil
  666. }
  667. return false
  668. }
  669. func isLoggedInWithOIDC(r *http.Request) bool {
  670. _, ok := r.Context().Value(oidcTokenKey).(string)
  671. return ok
  672. }