oidc_test.go 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456
  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. "bytes"
  17. "context"
  18. "encoding/json"
  19. "fmt"
  20. "net/http"
  21. "net/http/httptest"
  22. "net/url"
  23. "os"
  24. "path/filepath"
  25. "reflect"
  26. "runtime"
  27. "testing"
  28. "time"
  29. "unsafe"
  30. "github.com/coreos/go-oidc/v3/oidc"
  31. "github.com/go-chi/jwtauth/v5"
  32. "github.com/lestrrat-go/jwx/jwa"
  33. "github.com/rs/xid"
  34. "github.com/sftpgo/sdk"
  35. "github.com/stretchr/testify/assert"
  36. "github.com/stretchr/testify/require"
  37. "golang.org/x/oauth2"
  38. "github.com/drakkan/sftpgo/v2/internal/common"
  39. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  40. "github.com/drakkan/sftpgo/v2/internal/kms"
  41. "github.com/drakkan/sftpgo/v2/internal/util"
  42. "github.com/drakkan/sftpgo/v2/internal/vfs"
  43. )
  44. const (
  45. oidcMockAddr = "127.0.0.1:11111"
  46. )
  47. type mockTokenSource struct {
  48. token *oauth2.Token
  49. err error
  50. }
  51. func (t *mockTokenSource) Token() (*oauth2.Token, error) {
  52. return t.token, t.err
  53. }
  54. type mockOAuth2Config struct {
  55. tokenSource *mockTokenSource
  56. authCodeURL string
  57. token *oauth2.Token
  58. err error
  59. }
  60. func (c *mockOAuth2Config) AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string {
  61. return c.authCodeURL
  62. }
  63. func (c *mockOAuth2Config) Exchange(ctx context.Context, code string, opts ...oauth2.AuthCodeOption) (*oauth2.Token, error) {
  64. return c.token, c.err
  65. }
  66. func (c *mockOAuth2Config) TokenSource(ctx context.Context, t *oauth2.Token) oauth2.TokenSource {
  67. return c.tokenSource
  68. }
  69. type mockOIDCVerifier struct {
  70. token *oidc.IDToken
  71. err error
  72. }
  73. func (v *mockOIDCVerifier) Verify(ctx context.Context, rawIDToken string) (*oidc.IDToken, error) {
  74. return v.token, v.err
  75. }
  76. // hack because the field is unexported
  77. func setIDTokenClaims(idToken *oidc.IDToken, claims []byte) {
  78. pointerVal := reflect.ValueOf(idToken)
  79. val := reflect.Indirect(pointerVal)
  80. member := val.FieldByName("claims")
  81. ptr := unsafe.Pointer(member.UnsafeAddr())
  82. realPtr := (*[]byte)(ptr)
  83. *realPtr = claims
  84. }
  85. func TestOIDCInitialization(t *testing.T) {
  86. config := OIDC{}
  87. err := config.initialize()
  88. assert.NoError(t, err)
  89. config = OIDC{
  90. ClientID: "sftpgo-client",
  91. ClientSecret: "jRsmE0SWnuZjP7djBqNq0mrf8QN77j2c",
  92. ConfigURL: fmt.Sprintf("http://%v/", oidcMockAddr),
  93. RedirectBaseURL: "http://127.0.0.1:8081/",
  94. UsernameField: "preferred_username",
  95. RoleField: "sftpgo_role",
  96. }
  97. err = config.initialize()
  98. if assert.Error(t, err) {
  99. assert.Contains(t, err.Error(), "oidc: required scope \"openid\" is not set")
  100. }
  101. config.Scopes = []string{oidc.ScopeOpenID}
  102. err = config.initialize()
  103. if assert.Error(t, err) {
  104. assert.Contains(t, err.Error(), "oidc: unable to initialize provider")
  105. }
  106. config.ConfigURL = fmt.Sprintf("http://%v/auth/realms/sftpgo", oidcMockAddr)
  107. err = config.initialize()
  108. assert.NoError(t, err)
  109. assert.Equal(t, "http://127.0.0.1:8081"+webOIDCRedirectPath, config.getRedirectURL())
  110. }
  111. func TestOIDCLoginLogout(t *testing.T) {
  112. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  113. require.True(t, ok)
  114. server := getTestOIDCServer()
  115. err := server.binding.OIDC.initialize()
  116. assert.NoError(t, err)
  117. server.initializeRouter()
  118. rr := httptest.NewRecorder()
  119. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath, nil)
  120. assert.NoError(t, err)
  121. server.router.ServeHTTP(rr, r)
  122. assert.Equal(t, http.StatusBadRequest, rr.Code)
  123. assert.Contains(t, rr.Body.String(), "Authentication state did not match")
  124. expiredAuthReq := oidcPendingAuth{
  125. State: xid.New().String(),
  126. Nonce: xid.New().String(),
  127. Audience: tokenAudienceWebClient,
  128. IssuedAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-10 * time.Minute)),
  129. }
  130. oidcMgr.addPendingAuth(expiredAuthReq)
  131. rr = httptest.NewRecorder()
  132. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+expiredAuthReq.State, nil)
  133. assert.NoError(t, err)
  134. server.router.ServeHTTP(rr, r)
  135. assert.Equal(t, http.StatusBadRequest, rr.Code)
  136. assert.Contains(t, rr.Body.String(), "Authentication state did not match")
  137. oidcMgr.removePendingAuth(expiredAuthReq.State)
  138. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  139. tokenSource: &mockTokenSource{},
  140. authCodeURL: webOIDCRedirectPath,
  141. err: common.ErrGenericFailure,
  142. }
  143. server.binding.OIDC.verifier = &mockOIDCVerifier{
  144. err: common.ErrGenericFailure,
  145. }
  146. rr = httptest.NewRecorder()
  147. r, err = http.NewRequest(http.MethodGet, webAdminOIDCLoginPath, nil)
  148. assert.NoError(t, err)
  149. server.router.ServeHTTP(rr, r)
  150. assert.Equal(t, http.StatusFound, rr.Code)
  151. assert.Equal(t, webOIDCRedirectPath, rr.Header().Get("Location"))
  152. require.Len(t, oidcMgr.pendingAuths, 1)
  153. var state string
  154. for k := range oidcMgr.pendingAuths {
  155. state = k
  156. }
  157. rr = httptest.NewRecorder()
  158. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+state, nil)
  159. assert.NoError(t, err)
  160. server.router.ServeHTTP(rr, r)
  161. assert.Equal(t, http.StatusFound, rr.Code)
  162. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  163. require.Len(t, oidcMgr.pendingAuths, 0)
  164. rr = httptest.NewRecorder()
  165. r, err = http.NewRequest(http.MethodGet, webAdminLoginPath, nil)
  166. assert.NoError(t, err)
  167. server.router.ServeHTTP(rr, r)
  168. assert.Equal(t, http.StatusOK, rr.Code)
  169. // now the same for the web client
  170. rr = httptest.NewRecorder()
  171. r, err = http.NewRequest(http.MethodGet, webClientOIDCLoginPath, nil)
  172. assert.NoError(t, err)
  173. server.router.ServeHTTP(rr, r)
  174. assert.Equal(t, http.StatusFound, rr.Code)
  175. assert.Equal(t, webOIDCRedirectPath, rr.Header().Get("Location"))
  176. require.Len(t, oidcMgr.pendingAuths, 1)
  177. for k := range oidcMgr.pendingAuths {
  178. state = k
  179. }
  180. rr = httptest.NewRecorder()
  181. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+state, nil)
  182. assert.NoError(t, err)
  183. server.router.ServeHTTP(rr, r)
  184. assert.Equal(t, http.StatusFound, rr.Code)
  185. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  186. require.Len(t, oidcMgr.pendingAuths, 0)
  187. rr = httptest.NewRecorder()
  188. r, err = http.NewRequest(http.MethodGet, webClientLoginPath, nil)
  189. assert.NoError(t, err)
  190. server.router.ServeHTTP(rr, r)
  191. assert.Equal(t, http.StatusOK, rr.Code)
  192. // now return an OAuth2 token without the id_token
  193. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  194. tokenSource: &mockTokenSource{},
  195. authCodeURL: webOIDCRedirectPath,
  196. token: &oauth2.Token{
  197. AccessToken: "123",
  198. Expiry: time.Now().Add(5 * time.Minute),
  199. },
  200. err: nil,
  201. }
  202. authReq := newOIDCPendingAuth(tokenAudienceWebClient)
  203. oidcMgr.addPendingAuth(authReq)
  204. rr = httptest.NewRecorder()
  205. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  206. assert.NoError(t, err)
  207. server.router.ServeHTTP(rr, r)
  208. assert.Equal(t, http.StatusFound, rr.Code)
  209. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  210. require.Len(t, oidcMgr.pendingAuths, 0)
  211. // now fail to verify the id token
  212. token := &oauth2.Token{
  213. AccessToken: "123",
  214. Expiry: time.Now().Add(5 * time.Minute),
  215. }
  216. token = token.WithExtra(map[string]any{
  217. "id_token": "id_token_val",
  218. })
  219. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  220. tokenSource: &mockTokenSource{},
  221. authCodeURL: webOIDCRedirectPath,
  222. token: token,
  223. err: nil,
  224. }
  225. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  226. oidcMgr.addPendingAuth(authReq)
  227. rr = httptest.NewRecorder()
  228. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  229. assert.NoError(t, err)
  230. server.router.ServeHTTP(rr, r)
  231. assert.Equal(t, http.StatusFound, rr.Code)
  232. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  233. require.Len(t, oidcMgr.pendingAuths, 0)
  234. // id token nonce does not match
  235. server.binding.OIDC.verifier = &mockOIDCVerifier{
  236. err: nil,
  237. token: &oidc.IDToken{},
  238. }
  239. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  240. oidcMgr.addPendingAuth(authReq)
  241. rr = httptest.NewRecorder()
  242. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  243. assert.NoError(t, err)
  244. server.router.ServeHTTP(rr, r)
  245. assert.Equal(t, http.StatusFound, rr.Code)
  246. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  247. require.Len(t, oidcMgr.pendingAuths, 0)
  248. // null id token claims
  249. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  250. oidcMgr.addPendingAuth(authReq)
  251. server.binding.OIDC.verifier = &mockOIDCVerifier{
  252. err: nil,
  253. token: &oidc.IDToken{
  254. Nonce: authReq.Nonce,
  255. },
  256. }
  257. rr = httptest.NewRecorder()
  258. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  259. assert.NoError(t, err)
  260. server.router.ServeHTTP(rr, r)
  261. assert.Equal(t, http.StatusFound, rr.Code)
  262. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  263. require.Len(t, oidcMgr.pendingAuths, 0)
  264. // invalid id token claims (no username)
  265. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  266. oidcMgr.addPendingAuth(authReq)
  267. idToken := &oidc.IDToken{
  268. Nonce: authReq.Nonce,
  269. Expiry: time.Now().Add(5 * time.Minute),
  270. }
  271. setIDTokenClaims(idToken, []byte(`{"aud": "my_client_id"}`))
  272. server.binding.OIDC.verifier = &mockOIDCVerifier{
  273. err: nil,
  274. token: idToken,
  275. }
  276. rr = httptest.NewRecorder()
  277. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  278. assert.NoError(t, err)
  279. server.router.ServeHTTP(rr, r)
  280. assert.Equal(t, http.StatusFound, rr.Code)
  281. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  282. require.Len(t, oidcMgr.pendingAuths, 0)
  283. // invalid audience
  284. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  285. oidcMgr.addPendingAuth(authReq)
  286. idToken = &oidc.IDToken{
  287. Nonce: authReq.Nonce,
  288. Expiry: time.Now().Add(5 * time.Minute),
  289. }
  290. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test","sftpgo_role":"admin"}`))
  291. server.binding.OIDC.verifier = &mockOIDCVerifier{
  292. err: nil,
  293. token: idToken,
  294. }
  295. rr = httptest.NewRecorder()
  296. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  297. assert.NoError(t, err)
  298. server.router.ServeHTTP(rr, r)
  299. assert.Equal(t, http.StatusFound, rr.Code)
  300. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  301. require.Len(t, oidcMgr.pendingAuths, 0)
  302. // invalid audience
  303. authReq = newOIDCPendingAuth(tokenAudienceWebAdmin)
  304. oidcMgr.addPendingAuth(authReq)
  305. idToken = &oidc.IDToken{
  306. Nonce: authReq.Nonce,
  307. Expiry: time.Now().Add(5 * time.Minute),
  308. }
  309. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test"}`))
  310. server.binding.OIDC.verifier = &mockOIDCVerifier{
  311. err: nil,
  312. token: idToken,
  313. }
  314. rr = httptest.NewRecorder()
  315. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  316. assert.NoError(t, err)
  317. server.router.ServeHTTP(rr, r)
  318. assert.Equal(t, http.StatusFound, rr.Code)
  319. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  320. require.Len(t, oidcMgr.pendingAuths, 0)
  321. // mapped user not found
  322. authReq = newOIDCPendingAuth(tokenAudienceWebAdmin)
  323. oidcMgr.addPendingAuth(authReq)
  324. idToken = &oidc.IDToken{
  325. Nonce: authReq.Nonce,
  326. Expiry: time.Now().Add(5 * time.Minute),
  327. }
  328. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test","sftpgo_role":"admin"}`))
  329. server.binding.OIDC.verifier = &mockOIDCVerifier{
  330. err: nil,
  331. token: idToken,
  332. }
  333. rr = httptest.NewRecorder()
  334. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  335. assert.NoError(t, err)
  336. server.router.ServeHTTP(rr, r)
  337. assert.Equal(t, http.StatusFound, rr.Code)
  338. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  339. require.Len(t, oidcMgr.pendingAuths, 0)
  340. // admin login ok
  341. authReq = newOIDCPendingAuth(tokenAudienceWebAdmin)
  342. oidcMgr.addPendingAuth(authReq)
  343. idToken = &oidc.IDToken{
  344. Nonce: authReq.Nonce,
  345. Expiry: time.Now().Add(5 * time.Minute),
  346. }
  347. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sftpgo_role":"admin","sid":"sid123"}`))
  348. server.binding.OIDC.verifier = &mockOIDCVerifier{
  349. err: nil,
  350. token: idToken,
  351. }
  352. rr = httptest.NewRecorder()
  353. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  354. assert.NoError(t, err)
  355. server.router.ServeHTTP(rr, r)
  356. assert.Equal(t, http.StatusFound, rr.Code)
  357. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  358. require.Len(t, oidcMgr.pendingAuths, 0)
  359. require.Len(t, oidcMgr.tokens, 1)
  360. // admin profile is not available
  361. var tokenCookie string
  362. for k := range oidcMgr.tokens {
  363. tokenCookie = k
  364. }
  365. oidcToken, err := oidcMgr.getToken(tokenCookie)
  366. assert.NoError(t, err)
  367. assert.Equal(t, "sid123", oidcToken.SessionID)
  368. assert.True(t, oidcToken.isAdmin())
  369. assert.False(t, oidcToken.isExpired())
  370. rr = httptest.NewRecorder()
  371. r, err = http.NewRequest(http.MethodGet, webAdminProfilePath, nil)
  372. assert.NoError(t, err)
  373. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  374. server.router.ServeHTTP(rr, r)
  375. assert.Equal(t, http.StatusForbidden, rr.Code)
  376. // the admin can access the allowed pages
  377. rr = httptest.NewRecorder()
  378. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  379. assert.NoError(t, err)
  380. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  381. server.router.ServeHTTP(rr, r)
  382. assert.Equal(t, http.StatusOK, rr.Code)
  383. // try with an invalid cookie
  384. rr = httptest.NewRecorder()
  385. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  386. assert.NoError(t, err)
  387. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, xid.New().String()))
  388. server.router.ServeHTTP(rr, r)
  389. assert.Equal(t, http.StatusFound, rr.Code)
  390. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  391. // Web Client is not available with an admin token
  392. rr = httptest.NewRecorder()
  393. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  394. assert.NoError(t, err)
  395. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  396. server.router.ServeHTTP(rr, r)
  397. assert.Equal(t, http.StatusFound, rr.Code)
  398. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  399. // logout the admin user
  400. rr = httptest.NewRecorder()
  401. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  402. assert.NoError(t, err)
  403. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  404. server.router.ServeHTTP(rr, r)
  405. assert.Equal(t, http.StatusFound, rr.Code)
  406. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  407. require.Len(t, oidcMgr.pendingAuths, 0)
  408. require.Len(t, oidcMgr.tokens, 0)
  409. // now login and logout a user
  410. username := "test_oidc_user"
  411. user := dataprovider.User{
  412. BaseUser: sdk.BaseUser{
  413. Username: username,
  414. Password: "pwd",
  415. HomeDir: filepath.Join(os.TempDir(), username),
  416. Status: 1,
  417. Permissions: map[string][]string{
  418. "/": {dataprovider.PermAny},
  419. },
  420. },
  421. Filters: dataprovider.UserFilters{
  422. BaseUserFilters: sdk.BaseUserFilters{
  423. WebClient: []string{sdk.WebClientSharesDisabled},
  424. },
  425. },
  426. }
  427. err = dataprovider.AddUser(&user, "", "")
  428. assert.NoError(t, err)
  429. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  430. oidcMgr.addPendingAuth(authReq)
  431. idToken = &oidc.IDToken{
  432. Nonce: authReq.Nonce,
  433. Expiry: time.Now().Add(5 * time.Minute),
  434. }
  435. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test_oidc_user"}`))
  436. server.binding.OIDC.verifier = &mockOIDCVerifier{
  437. err: nil,
  438. token: idToken,
  439. }
  440. rr = httptest.NewRecorder()
  441. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  442. assert.NoError(t, err)
  443. server.router.ServeHTTP(rr, r)
  444. assert.Equal(t, http.StatusFound, rr.Code)
  445. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  446. require.Len(t, oidcMgr.pendingAuths, 0)
  447. require.Len(t, oidcMgr.tokens, 1)
  448. // user profile is not available
  449. for k := range oidcMgr.tokens {
  450. tokenCookie = k
  451. }
  452. oidcToken, err = oidcMgr.getToken(tokenCookie)
  453. assert.NoError(t, err)
  454. assert.Empty(t, oidcToken.SessionID)
  455. assert.False(t, oidcToken.isAdmin())
  456. assert.False(t, oidcToken.isExpired())
  457. if assert.Len(t, oidcToken.Permissions, 1) {
  458. assert.Equal(t, sdk.WebClientSharesDisabled, oidcToken.Permissions[0])
  459. }
  460. rr = httptest.NewRecorder()
  461. r, err = http.NewRequest(http.MethodGet, webClientProfilePath, nil)
  462. assert.NoError(t, err)
  463. r.RequestURI = webClientProfilePath
  464. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  465. server.router.ServeHTTP(rr, r)
  466. assert.Equal(t, http.StatusOK, rr.Code)
  467. // the user can access the allowed pages
  468. rr = httptest.NewRecorder()
  469. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  470. assert.NoError(t, err)
  471. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  472. server.router.ServeHTTP(rr, r)
  473. assert.Equal(t, http.StatusOK, rr.Code)
  474. // try with an invalid cookie
  475. rr = httptest.NewRecorder()
  476. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  477. assert.NoError(t, err)
  478. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, xid.New().String()))
  479. server.router.ServeHTTP(rr, r)
  480. assert.Equal(t, http.StatusFound, rr.Code)
  481. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  482. // Web Admin is not available with a client cookie
  483. rr = httptest.NewRecorder()
  484. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  485. assert.NoError(t, err)
  486. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  487. server.router.ServeHTTP(rr, r)
  488. assert.Equal(t, http.StatusFound, rr.Code)
  489. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  490. // logout the user
  491. rr = httptest.NewRecorder()
  492. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  493. assert.NoError(t, err)
  494. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  495. server.router.ServeHTTP(rr, r)
  496. assert.Equal(t, http.StatusFound, rr.Code)
  497. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  498. require.Len(t, oidcMgr.pendingAuths, 0)
  499. require.Len(t, oidcMgr.tokens, 0)
  500. err = os.RemoveAll(user.GetHomeDir())
  501. assert.NoError(t, err)
  502. err = dataprovider.DeleteUser(username, "", "")
  503. assert.NoError(t, err)
  504. }
  505. func TestOIDCRefreshToken(t *testing.T) {
  506. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  507. require.True(t, ok)
  508. token := oidcToken{
  509. Cookie: xid.New().String(),
  510. AccessToken: xid.New().String(),
  511. TokenType: "Bearer",
  512. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-1 * time.Minute)),
  513. Nonce: xid.New().String(),
  514. }
  515. config := mockOAuth2Config{
  516. tokenSource: &mockTokenSource{
  517. err: common.ErrGenericFailure,
  518. },
  519. }
  520. verifier := mockOIDCVerifier{
  521. err: common.ErrGenericFailure,
  522. }
  523. err := token.refresh(&config, &verifier)
  524. if assert.Error(t, err) {
  525. assert.Contains(t, err.Error(), "refresh token not set")
  526. }
  527. token.RefreshToken = xid.New().String()
  528. err = token.refresh(&config, &verifier)
  529. assert.ErrorIs(t, err, common.ErrGenericFailure)
  530. newToken := &oauth2.Token{
  531. AccessToken: xid.New().String(),
  532. RefreshToken: xid.New().String(),
  533. Expiry: time.Now().Add(5 * time.Minute),
  534. }
  535. config = mockOAuth2Config{
  536. tokenSource: &mockTokenSource{
  537. token: newToken,
  538. },
  539. }
  540. verifier = mockOIDCVerifier{
  541. token: &oidc.IDToken{},
  542. }
  543. err = token.refresh(&config, &verifier)
  544. if assert.Error(t, err) {
  545. assert.Contains(t, err.Error(), "the refreshed token has no id token")
  546. }
  547. newToken = newToken.WithExtra(map[string]any{
  548. "id_token": "id_token_val",
  549. })
  550. newToken.Expiry = time.Time{}
  551. config = mockOAuth2Config{
  552. tokenSource: &mockTokenSource{
  553. token: newToken,
  554. },
  555. }
  556. verifier = mockOIDCVerifier{
  557. err: common.ErrGenericFailure,
  558. }
  559. err = token.refresh(&config, &verifier)
  560. assert.ErrorIs(t, err, common.ErrGenericFailure)
  561. newToken = newToken.WithExtra(map[string]any{
  562. "id_token": "id_token_val",
  563. })
  564. newToken.Expiry = time.Now().Add(5 * time.Minute)
  565. config = mockOAuth2Config{
  566. tokenSource: &mockTokenSource{
  567. token: newToken,
  568. },
  569. }
  570. verifier = mockOIDCVerifier{
  571. token: &oidc.IDToken{},
  572. }
  573. err = token.refresh(&config, &verifier)
  574. if assert.Error(t, err) {
  575. assert.Contains(t, err.Error(), "the refreshed token nonce mismatch")
  576. }
  577. verifier = mockOIDCVerifier{
  578. token: &oidc.IDToken{
  579. Nonce: token.Nonce,
  580. },
  581. }
  582. err = token.refresh(&config, &verifier)
  583. if assert.Error(t, err) {
  584. assert.Contains(t, err.Error(), "oidc: claims not set")
  585. }
  586. idToken := &oidc.IDToken{
  587. Nonce: token.Nonce,
  588. }
  589. setIDTokenClaims(idToken, []byte(`{"sid":"id_token_sid"}`))
  590. verifier = mockOIDCVerifier{
  591. token: idToken,
  592. }
  593. err = token.refresh(&config, &verifier)
  594. assert.NoError(t, err)
  595. require.Len(t, oidcMgr.tokens, 1)
  596. oidcMgr.removeToken(token.Cookie)
  597. require.Len(t, oidcMgr.tokens, 0)
  598. }
  599. func TestValidateOIDCToken(t *testing.T) {
  600. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  601. require.True(t, ok)
  602. server := getTestOIDCServer()
  603. err := server.binding.OIDC.initialize()
  604. assert.NoError(t, err)
  605. server.initializeRouter()
  606. rr := httptest.NewRecorder()
  607. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  608. assert.NoError(t, err)
  609. _, err = server.validateOIDCToken(rr, r, false)
  610. assert.ErrorIs(t, err, errInvalidToken)
  611. // expired token and refresh error
  612. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  613. tokenSource: &mockTokenSource{
  614. err: common.ErrGenericFailure,
  615. },
  616. }
  617. token := oidcToken{
  618. Cookie: xid.New().String(),
  619. AccessToken: xid.New().String(),
  620. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  621. }
  622. oidcMgr.addToken(token)
  623. rr = httptest.NewRecorder()
  624. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  625. assert.NoError(t, err)
  626. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  627. _, err = server.validateOIDCToken(rr, r, false)
  628. assert.ErrorIs(t, err, errInvalidToken)
  629. oidcMgr.removeToken(token.Cookie)
  630. assert.Len(t, oidcMgr.tokens, 0)
  631. server.tokenAuth = jwtauth.New("PS256", util.GenerateRandomBytes(32), nil)
  632. token = oidcToken{
  633. Cookie: xid.New().String(),
  634. AccessToken: xid.New().String(),
  635. }
  636. oidcMgr.addToken(token)
  637. rr = httptest.NewRecorder()
  638. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  639. assert.NoError(t, err)
  640. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  641. server.router.ServeHTTP(rr, r)
  642. assert.Equal(t, http.StatusFound, rr.Code)
  643. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  644. oidcMgr.removeToken(token.Cookie)
  645. assert.Len(t, oidcMgr.tokens, 0)
  646. token = oidcToken{
  647. Cookie: xid.New().String(),
  648. AccessToken: xid.New().String(),
  649. Role: "admin",
  650. }
  651. oidcMgr.addToken(token)
  652. rr = httptest.NewRecorder()
  653. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  654. assert.NoError(t, err)
  655. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  656. server.router.ServeHTTP(rr, r)
  657. assert.Equal(t, http.StatusFound, rr.Code)
  658. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  659. oidcMgr.removeToken(token.Cookie)
  660. assert.Len(t, oidcMgr.tokens, 0)
  661. }
  662. func TestSkipOIDCAuth(t *testing.T) {
  663. server := getTestOIDCServer()
  664. err := server.binding.OIDC.initialize()
  665. assert.NoError(t, err)
  666. server.initializeRouter()
  667. jwtTokenClaims := jwtTokenClaims{
  668. Username: "user",
  669. }
  670. _, tokenString, err := jwtTokenClaims.createToken(server.tokenAuth, tokenAudienceWebClient, "")
  671. assert.NoError(t, err)
  672. rr := httptest.NewRecorder()
  673. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  674. assert.NoError(t, err)
  675. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", jwtCookieKey, tokenString))
  676. server.router.ServeHTTP(rr, r)
  677. assert.Equal(t, http.StatusFound, rr.Code)
  678. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  679. }
  680. func TestOIDCLogoutErrors(t *testing.T) {
  681. server := getTestOIDCServer()
  682. assert.Empty(t, server.binding.OIDC.providerLogoutURL)
  683. server.logoutFromOIDCOP("")
  684. server.binding.OIDC.providerLogoutURL = "http://foo\x7f.com/"
  685. server.doOIDCFromLogout("")
  686. server.binding.OIDC.providerLogoutURL = "http://127.0.0.1:11234"
  687. server.doOIDCFromLogout("")
  688. }
  689. func TestOIDCToken(t *testing.T) {
  690. admin := dataprovider.Admin{
  691. Username: "test_oidc_admin",
  692. Password: "p",
  693. Permissions: []string{dataprovider.PermAdminAny},
  694. Status: 0,
  695. }
  696. err := dataprovider.AddAdmin(&admin, "", "")
  697. assert.NoError(t, err)
  698. token := oidcToken{
  699. Username: admin.Username,
  700. Role: "admin",
  701. }
  702. req, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  703. assert.NoError(t, err)
  704. err = token.getUser(req)
  705. if assert.Error(t, err) {
  706. assert.Contains(t, err.Error(), "is disabled")
  707. }
  708. err = dataprovider.DeleteAdmin(admin.Username, "", "")
  709. assert.NoError(t, err)
  710. username := "test_oidc_user"
  711. token.Username = username
  712. token.Role = ""
  713. err = token.getUser(req)
  714. if assert.Error(t, err) {
  715. _, ok := err.(*util.RecordNotFoundError)
  716. assert.True(t, ok)
  717. }
  718. user := dataprovider.User{
  719. BaseUser: sdk.BaseUser{
  720. Username: username,
  721. Password: "p",
  722. HomeDir: filepath.Join(os.TempDir(), username),
  723. Status: 0,
  724. Permissions: map[string][]string{
  725. "/": {dataprovider.PermAny},
  726. },
  727. },
  728. Filters: dataprovider.UserFilters{
  729. BaseUserFilters: sdk.BaseUserFilters{
  730. DeniedProtocols: []string{common.ProtocolHTTP},
  731. },
  732. },
  733. }
  734. err = dataprovider.AddUser(&user, "", "")
  735. assert.NoError(t, err)
  736. err = token.getUser(req)
  737. if assert.Error(t, err) {
  738. assert.Contains(t, err.Error(), "is disabled")
  739. }
  740. user, err = dataprovider.UserExists(username)
  741. assert.NoError(t, err)
  742. user.Status = 1
  743. user.Password = "np"
  744. err = dataprovider.UpdateUser(&user, "", "")
  745. assert.NoError(t, err)
  746. err = token.getUser(req)
  747. if assert.Error(t, err) {
  748. assert.Contains(t, err.Error(), "protocol HTTP is not allowed")
  749. }
  750. user.Filters.DeniedProtocols = nil
  751. user.FsConfig.Provider = sdk.SFTPFilesystemProvider
  752. user.FsConfig.SFTPConfig = vfs.SFTPFsConfig{
  753. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  754. Endpoint: "127.0.0.1:8022",
  755. Username: username,
  756. },
  757. Password: kms.NewPlainSecret("np"),
  758. }
  759. err = dataprovider.UpdateUser(&user, "", "")
  760. assert.NoError(t, err)
  761. err = token.getUser(req)
  762. if assert.Error(t, err) {
  763. assert.Contains(t, err.Error(), "SFTP loop")
  764. }
  765. common.Config.PostConnectHook = fmt.Sprintf("http://%v/404", oidcMockAddr)
  766. err = token.getUser(req)
  767. if assert.Error(t, err) {
  768. assert.Contains(t, err.Error(), "access denied by post connect hook")
  769. }
  770. common.Config.PostConnectHook = ""
  771. err = os.RemoveAll(user.GetHomeDir())
  772. assert.NoError(t, err)
  773. err = dataprovider.DeleteUser(username, "", "")
  774. assert.NoError(t, err)
  775. }
  776. func TestOIDCImplicitRoles(t *testing.T) {
  777. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  778. require.True(t, ok)
  779. server := getTestOIDCServer()
  780. server.binding.OIDC.ImplicitRoles = true
  781. err := server.binding.OIDC.initialize()
  782. assert.NoError(t, err)
  783. server.initializeRouter()
  784. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  785. oidcMgr.addPendingAuth(authReq)
  786. token := &oauth2.Token{
  787. AccessToken: "1234",
  788. Expiry: time.Now().Add(5 * time.Minute),
  789. }
  790. token = token.WithExtra(map[string]any{
  791. "id_token": "id_token_val",
  792. })
  793. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  794. tokenSource: &mockTokenSource{},
  795. authCodeURL: webOIDCRedirectPath,
  796. token: token,
  797. }
  798. idToken := &oidc.IDToken{
  799. Nonce: authReq.Nonce,
  800. Expiry: time.Now().Add(5 * time.Minute),
  801. }
  802. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  803. server.binding.OIDC.verifier = &mockOIDCVerifier{
  804. err: nil,
  805. token: idToken,
  806. }
  807. rr := httptest.NewRecorder()
  808. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  809. assert.NoError(t, err)
  810. server.router.ServeHTTP(rr, r)
  811. assert.Equal(t, http.StatusFound, rr.Code)
  812. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  813. require.Len(t, oidcMgr.pendingAuths, 0)
  814. require.Len(t, oidcMgr.tokens, 1)
  815. var tokenCookie string
  816. for k := range oidcMgr.tokens {
  817. tokenCookie = k
  818. }
  819. // Web Client is not available with an admin token
  820. rr = httptest.NewRecorder()
  821. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  822. assert.NoError(t, err)
  823. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  824. server.router.ServeHTTP(rr, r)
  825. assert.Equal(t, http.StatusFound, rr.Code)
  826. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  827. // logout the admin user
  828. rr = httptest.NewRecorder()
  829. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  830. assert.NoError(t, err)
  831. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  832. server.router.ServeHTTP(rr, r)
  833. assert.Equal(t, http.StatusFound, rr.Code)
  834. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  835. require.Len(t, oidcMgr.pendingAuths, 0)
  836. require.Len(t, oidcMgr.tokens, 0)
  837. // now login and logout a user
  838. username := "test_oidc_implicit_user"
  839. user := dataprovider.User{
  840. BaseUser: sdk.BaseUser{
  841. Username: username,
  842. Password: "pwd",
  843. HomeDir: filepath.Join(os.TempDir(), username),
  844. Status: 1,
  845. Permissions: map[string][]string{
  846. "/": {dataprovider.PermAny},
  847. },
  848. },
  849. Filters: dataprovider.UserFilters{
  850. BaseUserFilters: sdk.BaseUserFilters{
  851. WebClient: []string{sdk.WebClientSharesDisabled},
  852. },
  853. },
  854. }
  855. err = dataprovider.AddUser(&user, "", "")
  856. assert.NoError(t, err)
  857. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  858. oidcMgr.addPendingAuth(authReq)
  859. idToken = &oidc.IDToken{
  860. Nonce: authReq.Nonce,
  861. Expiry: time.Now().Add(5 * time.Minute),
  862. }
  863. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test_oidc_implicit_user"}`))
  864. server.binding.OIDC.verifier = &mockOIDCVerifier{
  865. err: nil,
  866. token: idToken,
  867. }
  868. rr = httptest.NewRecorder()
  869. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  870. assert.NoError(t, err)
  871. server.router.ServeHTTP(rr, r)
  872. assert.Equal(t, http.StatusFound, rr.Code)
  873. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  874. require.Len(t, oidcMgr.pendingAuths, 0)
  875. require.Len(t, oidcMgr.tokens, 1)
  876. for k := range oidcMgr.tokens {
  877. tokenCookie = k
  878. }
  879. rr = httptest.NewRecorder()
  880. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  881. assert.NoError(t, err)
  882. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  883. server.router.ServeHTTP(rr, r)
  884. assert.Equal(t, http.StatusFound, rr.Code)
  885. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  886. require.Len(t, oidcMgr.pendingAuths, 0)
  887. require.Len(t, oidcMgr.tokens, 0)
  888. err = os.RemoveAll(user.GetHomeDir())
  889. assert.NoError(t, err)
  890. err = dataprovider.DeleteUser(username, "", "")
  891. assert.NoError(t, err)
  892. }
  893. func TestMemoryOIDCManager(t *testing.T) {
  894. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  895. require.True(t, ok)
  896. require.Len(t, oidcMgr.pendingAuths, 0)
  897. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  898. oidcMgr.addPendingAuth(authReq)
  899. require.Len(t, oidcMgr.pendingAuths, 1)
  900. _, err := oidcMgr.getPendingAuth(authReq.State)
  901. assert.NoError(t, err)
  902. oidcMgr.removePendingAuth(authReq.State)
  903. require.Len(t, oidcMgr.pendingAuths, 0)
  904. authReq.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-61 * time.Second))
  905. oidcMgr.addPendingAuth(authReq)
  906. require.Len(t, oidcMgr.pendingAuths, 1)
  907. _, err = oidcMgr.getPendingAuth(authReq.State)
  908. if assert.Error(t, err) {
  909. assert.Contains(t, err.Error(), "too old")
  910. }
  911. oidcMgr.cleanup()
  912. require.Len(t, oidcMgr.pendingAuths, 0)
  913. token := oidcToken{
  914. AccessToken: xid.New().String(),
  915. Nonce: xid.New().String(),
  916. SessionID: xid.New().String(),
  917. Cookie: xid.New().String(),
  918. Username: xid.New().String(),
  919. Role: "admin",
  920. Permissions: []string{dataprovider.PermAdminAny},
  921. }
  922. require.Len(t, oidcMgr.tokens, 0)
  923. oidcMgr.addToken(token)
  924. require.Len(t, oidcMgr.tokens, 1)
  925. _, err = oidcMgr.getToken(xid.New().String())
  926. assert.Error(t, err)
  927. storedToken, err := oidcMgr.getToken(token.Cookie)
  928. assert.NoError(t, err)
  929. token.UsedAt = 0 // ensure we don't modify the stored token
  930. assert.Greater(t, storedToken.UsedAt, int64(0))
  931. token.UsedAt = storedToken.UsedAt
  932. assert.Equal(t, token, storedToken)
  933. // the usage will not be updated, it is recent
  934. oidcMgr.updateTokenUsage(storedToken)
  935. storedToken, err = oidcMgr.getToken(token.Cookie)
  936. assert.NoError(t, err)
  937. assert.Equal(t, token, storedToken)
  938. usedAt := util.GetTimeAsMsSinceEpoch(time.Now().Add(-5 * time.Minute))
  939. storedToken.UsedAt = usedAt
  940. oidcMgr.tokens[token.Cookie] = storedToken
  941. storedToken, err = oidcMgr.getToken(token.Cookie)
  942. assert.NoError(t, err)
  943. assert.Equal(t, usedAt, storedToken.UsedAt)
  944. token.UsedAt = storedToken.UsedAt
  945. assert.Equal(t, token, storedToken)
  946. oidcMgr.updateTokenUsage(storedToken)
  947. storedToken, err = oidcMgr.getToken(token.Cookie)
  948. assert.NoError(t, err)
  949. assert.Greater(t, storedToken.UsedAt, usedAt)
  950. token.UsedAt = storedToken.UsedAt
  951. assert.Equal(t, token, storedToken)
  952. storedToken.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now()) - tokenDeleteInterval - 1
  953. oidcMgr.tokens[token.Cookie] = storedToken
  954. storedToken, err = oidcMgr.getToken(token.Cookie)
  955. if assert.Error(t, err) {
  956. assert.Contains(t, err.Error(), "token is too old")
  957. }
  958. oidcMgr.removeToken(xid.New().String())
  959. require.Len(t, oidcMgr.tokens, 1)
  960. oidcMgr.removeToken(token.Cookie)
  961. require.Len(t, oidcMgr.tokens, 0)
  962. oidcMgr.addToken(token)
  963. usedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-6 * time.Hour))
  964. token.UsedAt = usedAt
  965. oidcMgr.tokens[token.Cookie] = token
  966. newToken := oidcToken{
  967. Cookie: xid.New().String(),
  968. }
  969. oidcMgr.addToken(newToken)
  970. oidcMgr.cleanup()
  971. require.Len(t, oidcMgr.tokens, 1)
  972. _, err = oidcMgr.getToken(token.Cookie)
  973. assert.Error(t, err)
  974. _, err = oidcMgr.getToken(newToken.Cookie)
  975. assert.NoError(t, err)
  976. oidcMgr.removeToken(newToken.Cookie)
  977. require.Len(t, oidcMgr.tokens, 0)
  978. }
  979. func TestOIDCPreLoginHook(t *testing.T) {
  980. if runtime.GOOS == osWindows {
  981. t.Skip("this test is not available on Windows")
  982. }
  983. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  984. require.True(t, ok)
  985. username := "test_oidc_user_prelogin"
  986. u := dataprovider.User{
  987. BaseUser: sdk.BaseUser{
  988. Username: username,
  989. HomeDir: filepath.Join(os.TempDir(), username),
  990. Status: 1,
  991. Permissions: map[string][]string{
  992. "/": {dataprovider.PermAny},
  993. },
  994. },
  995. }
  996. preLoginPath := filepath.Join(os.TempDir(), "prelogin.sh")
  997. providerConf := dataprovider.GetProviderConfig()
  998. err := dataprovider.Close()
  999. assert.NoError(t, err)
  1000. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, false), os.ModePerm)
  1001. assert.NoError(t, err)
  1002. newProviderConf := providerConf
  1003. newProviderConf.PreLoginHook = preLoginPath
  1004. err = dataprovider.Initialize(newProviderConf, configDir, true)
  1005. assert.NoError(t, err)
  1006. server := getTestOIDCServer()
  1007. server.binding.OIDC.CustomFields = []string{"field1", "field2"}
  1008. err = server.binding.OIDC.initialize()
  1009. assert.NoError(t, err)
  1010. server.initializeRouter()
  1011. _, err = dataprovider.UserExists(username)
  1012. _, ok = err.(*util.RecordNotFoundError)
  1013. assert.True(t, ok)
  1014. // now login with OIDC
  1015. authReq := newOIDCPendingAuth(tokenAudienceWebClient)
  1016. oidcMgr.addPendingAuth(authReq)
  1017. token := &oauth2.Token{
  1018. AccessToken: "1234",
  1019. Expiry: time.Now().Add(5 * time.Minute),
  1020. }
  1021. token = token.WithExtra(map[string]any{
  1022. "id_token": "id_token_val",
  1023. })
  1024. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1025. tokenSource: &mockTokenSource{},
  1026. authCodeURL: webOIDCRedirectPath,
  1027. token: token,
  1028. }
  1029. idToken := &oidc.IDToken{
  1030. Nonce: authReq.Nonce,
  1031. Expiry: time.Now().Add(5 * time.Minute),
  1032. }
  1033. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`"}`))
  1034. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1035. err: nil,
  1036. token: idToken,
  1037. }
  1038. rr := httptest.NewRecorder()
  1039. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1040. assert.NoError(t, err)
  1041. server.router.ServeHTTP(rr, r)
  1042. assert.Equal(t, http.StatusFound, rr.Code)
  1043. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  1044. _, err = dataprovider.UserExists(username)
  1045. assert.NoError(t, err)
  1046. err = dataprovider.DeleteUser(username, "", "")
  1047. assert.NoError(t, err)
  1048. err = os.RemoveAll(u.HomeDir)
  1049. assert.NoError(t, err)
  1050. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, true), os.ModePerm)
  1051. assert.NoError(t, err)
  1052. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  1053. oidcMgr.addPendingAuth(authReq)
  1054. idToken = &oidc.IDToken{
  1055. Nonce: authReq.Nonce,
  1056. Expiry: time.Now().Add(5 * time.Minute),
  1057. }
  1058. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`","field1":"value1","field2":"value2","field3":"value3"}`))
  1059. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1060. err: nil,
  1061. token: idToken,
  1062. }
  1063. rr = httptest.NewRecorder()
  1064. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1065. assert.NoError(t, err)
  1066. server.router.ServeHTTP(rr, r)
  1067. assert.Equal(t, http.StatusFound, rr.Code)
  1068. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  1069. _, err = dataprovider.UserExists(username)
  1070. _, ok = err.(*util.RecordNotFoundError)
  1071. assert.True(t, ok)
  1072. if assert.Len(t, oidcMgr.tokens, 1) {
  1073. for k := range oidcMgr.tokens {
  1074. oidcMgr.removeToken(k)
  1075. }
  1076. }
  1077. require.Len(t, oidcMgr.pendingAuths, 0)
  1078. require.Len(t, oidcMgr.tokens, 0)
  1079. err = dataprovider.Close()
  1080. assert.NoError(t, err)
  1081. err = dataprovider.Initialize(providerConf, configDir, true)
  1082. assert.NoError(t, err)
  1083. err = os.Remove(preLoginPath)
  1084. assert.NoError(t, err)
  1085. }
  1086. func TestOIDCIsAdmin(t *testing.T) {
  1087. type test struct {
  1088. input any
  1089. want bool
  1090. }
  1091. emptySlice := make([]any, 0)
  1092. tests := []test{
  1093. {input: "admin", want: true},
  1094. {input: append(emptySlice, "admin"), want: true},
  1095. {input: append(emptySlice, "user", "admin"), want: true},
  1096. {input: "user", want: false},
  1097. {input: emptySlice, want: false},
  1098. {input: append(emptySlice, 1), want: false},
  1099. {input: 1, want: false},
  1100. {input: nil, want: false},
  1101. {input: map[string]string{"admin": "admin"}, want: false},
  1102. }
  1103. for _, tc := range tests {
  1104. token := oidcToken{
  1105. Role: tc.input,
  1106. }
  1107. assert.Equal(t, tc.want, token.isAdmin(), "%v should return %t", tc.input, tc.want)
  1108. }
  1109. }
  1110. func TestParseAdminRole(t *testing.T) {
  1111. claims := make(map[string]any)
  1112. rawClaims := []byte(`{
  1113. "sub": "35666371",
  1114. "email": "[email protected]",
  1115. "preferred_username": "Sally",
  1116. "name": "Sally Tyler",
  1117. "updated_at": "2018-04-13T22:08:45Z",
  1118. "given_name": "Sally",
  1119. "family_name": "Tyler",
  1120. "params": {
  1121. "sftpgo_role": "admin",
  1122. "subparams": {
  1123. "sftpgo_role": "admin",
  1124. "inner": {
  1125. "sftpgo_role": ["user","admin"]
  1126. }
  1127. }
  1128. },
  1129. "at_hash": "lPLhxI2wjEndc-WfyroDZA",
  1130. "rt_hash": "mCmxPtA04N-55AxlEUbq-A",
  1131. "aud": "78d1d040-20c9-0136-5146-067351775fae92920",
  1132. "exp": 1523664997,
  1133. "iat": 1523657797
  1134. }`)
  1135. err := json.Unmarshal(rawClaims, &claims)
  1136. assert.NoError(t, err)
  1137. type test struct {
  1138. input string
  1139. want bool
  1140. }
  1141. tests := []test{
  1142. {input: "sftpgo_role", want: false},
  1143. {input: "params.sftpgo_role", want: true},
  1144. {input: "params.subparams.sftpgo_role", want: true},
  1145. {input: "params.subparams.inner.sftpgo_role", want: true},
  1146. {input: "email", want: false},
  1147. {input: "missing", want: false},
  1148. {input: "params.email", want: false},
  1149. {input: "missing.sftpgo_role", want: false},
  1150. {input: "params", want: false},
  1151. {input: "params.subparams.inner.sftpgo_role.missing", want: false},
  1152. }
  1153. for _, tc := range tests {
  1154. token := oidcToken{}
  1155. token.getRoleFromField(claims, tc.input)
  1156. assert.Equal(t, tc.want, token.isAdmin(), "%q should return %t", tc.input, tc.want)
  1157. }
  1158. }
  1159. func TestOIDCWithLoginFormsDisabled(t *testing.T) {
  1160. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1161. require.True(t, ok)
  1162. server := getTestOIDCServer()
  1163. server.binding.OIDC.ImplicitRoles = true
  1164. server.binding.EnabledLoginMethods = 3
  1165. server.binding.EnableWebAdmin = true
  1166. server.binding.EnableWebClient = true
  1167. err := server.binding.OIDC.initialize()
  1168. assert.NoError(t, err)
  1169. server.initializeRouter()
  1170. // login with an admin user
  1171. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1172. oidcMgr.addPendingAuth(authReq)
  1173. token := &oauth2.Token{
  1174. AccessToken: "1234",
  1175. Expiry: time.Now().Add(5 * time.Minute),
  1176. }
  1177. token = token.WithExtra(map[string]any{
  1178. "id_token": "id_token_val",
  1179. })
  1180. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1181. tokenSource: &mockTokenSource{},
  1182. authCodeURL: webOIDCRedirectPath,
  1183. token: token,
  1184. }
  1185. idToken := &oidc.IDToken{
  1186. Nonce: authReq.Nonce,
  1187. Expiry: time.Now().Add(5 * time.Minute),
  1188. }
  1189. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  1190. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1191. err: nil,
  1192. token: idToken,
  1193. }
  1194. rr := httptest.NewRecorder()
  1195. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1196. assert.NoError(t, err)
  1197. server.router.ServeHTTP(rr, r)
  1198. assert.Equal(t, http.StatusFound, rr.Code)
  1199. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  1200. var tokenCookie string
  1201. for k := range oidcMgr.tokens {
  1202. tokenCookie = k
  1203. }
  1204. // we should be able to create admins without setting a password
  1205. if csrfTokenAuth == nil {
  1206. csrfTokenAuth = jwtauth.New(jwa.HS256.String(), util.GenerateRandomBytes(32), nil)
  1207. }
  1208. adminUsername := "testAdmin"
  1209. form := make(url.Values)
  1210. form.Set(csrfFormToken, createCSRFToken(""))
  1211. form.Set("username", adminUsername)
  1212. form.Set("password", "")
  1213. form.Set("status", "1")
  1214. form.Set("permissions", "*")
  1215. rr = httptest.NewRecorder()
  1216. r, err = http.NewRequest(http.MethodPost, webAdminPath, bytes.NewBuffer([]byte(form.Encode())))
  1217. assert.NoError(t, err)
  1218. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  1219. r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
  1220. server.router.ServeHTTP(rr, r)
  1221. assert.Equal(t, http.StatusSeeOther, rr.Code)
  1222. _, err = dataprovider.AdminExists(adminUsername)
  1223. assert.NoError(t, err)
  1224. err = dataprovider.DeleteAdmin(adminUsername, "", "")
  1225. assert.NoError(t, err)
  1226. // login and password related routes are disabled
  1227. rr = httptest.NewRecorder()
  1228. r, err = http.NewRequest(http.MethodPost, webAdminLoginPath, nil)
  1229. assert.NoError(t, err)
  1230. server.router.ServeHTTP(rr, r)
  1231. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1232. rr = httptest.NewRecorder()
  1233. r, err = http.NewRequest(http.MethodPost, webAdminTwoFactorPath, nil)
  1234. assert.NoError(t, err)
  1235. server.router.ServeHTTP(rr, r)
  1236. assert.Equal(t, http.StatusNotFound, rr.Code)
  1237. rr = httptest.NewRecorder()
  1238. r, err = http.NewRequest(http.MethodPost, webClientLoginPath, nil)
  1239. assert.NoError(t, err)
  1240. server.router.ServeHTTP(rr, r)
  1241. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1242. rr = httptest.NewRecorder()
  1243. r, err = http.NewRequest(http.MethodPost, webClientForgotPwdPath, nil)
  1244. assert.NoError(t, err)
  1245. server.router.ServeHTTP(rr, r)
  1246. assert.Equal(t, http.StatusNotFound, rr.Code)
  1247. }
  1248. func TestDbOIDCManager(t *testing.T) {
  1249. if !isSharedProviderSupported() {
  1250. t.Skip("this test it is not available with this provider")
  1251. }
  1252. mgr := newOIDCManager(1)
  1253. pendingAuth := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1254. mgr.addPendingAuth(pendingAuth)
  1255. authReq, err := mgr.getPendingAuth(pendingAuth.State)
  1256. assert.NoError(t, err)
  1257. assert.Equal(t, pendingAuth, authReq)
  1258. pendingAuth.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1259. mgr.addPendingAuth(pendingAuth)
  1260. _, err = mgr.getPendingAuth(pendingAuth.State)
  1261. if assert.Error(t, err) {
  1262. assert.Contains(t, err.Error(), "auth request is too old")
  1263. }
  1264. mgr.removePendingAuth(pendingAuth.State)
  1265. _, err = mgr.getPendingAuth(pendingAuth.State)
  1266. if assert.Error(t, err) {
  1267. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1268. }
  1269. mgr.addPendingAuth(pendingAuth)
  1270. _, err = mgr.getPendingAuth(pendingAuth.State)
  1271. if assert.Error(t, err) {
  1272. assert.Contains(t, err.Error(), "auth request is too old")
  1273. }
  1274. mgr.cleanup()
  1275. _, err = mgr.getPendingAuth(pendingAuth.State)
  1276. if assert.Error(t, err) {
  1277. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1278. }
  1279. token := oidcToken{
  1280. Cookie: xid.New().String(),
  1281. AccessToken: xid.New().String(),
  1282. TokenType: "Bearer",
  1283. RefreshToken: xid.New().String(),
  1284. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  1285. SessionID: xid.New().String(),
  1286. IDToken: xid.New().String(),
  1287. Nonce: xid.New().String(),
  1288. Username: xid.New().String(),
  1289. Permissions: []string{dataprovider.PermAdminAny},
  1290. Role: "admin",
  1291. }
  1292. mgr.addToken(token)
  1293. tokenGet, err := mgr.getToken(token.Cookie)
  1294. assert.NoError(t, err)
  1295. assert.Greater(t, tokenGet.UsedAt, int64(0))
  1296. token.UsedAt = tokenGet.UsedAt
  1297. assert.Equal(t, token, tokenGet)
  1298. time.Sleep(100 * time.Millisecond)
  1299. mgr.updateTokenUsage(token)
  1300. // no change
  1301. tokenGet, err = mgr.getToken(token.Cookie)
  1302. assert.NoError(t, err)
  1303. assert.Equal(t, token.UsedAt, tokenGet.UsedAt)
  1304. tokenGet.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1305. tokenGet.RefreshToken = xid.New().String()
  1306. mgr.updateTokenUsage(tokenGet)
  1307. tokenGet, err = mgr.getToken(token.Cookie)
  1308. assert.NoError(t, err)
  1309. assert.NotEmpty(t, tokenGet.RefreshToken)
  1310. assert.NotEqual(t, token.RefreshToken, tokenGet.RefreshToken)
  1311. assert.Greater(t, tokenGet.UsedAt, token.UsedAt)
  1312. mgr.removeToken(token.Cookie)
  1313. tokenGet, err = mgr.getToken(token.Cookie)
  1314. if assert.Error(t, err) {
  1315. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1316. }
  1317. // add an expired token
  1318. token.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1319. session := dataprovider.Session{
  1320. Key: token.Cookie,
  1321. Data: token,
  1322. Type: dataprovider.SessionTypeOIDCToken,
  1323. Timestamp: token.UsedAt + tokenDeleteInterval,
  1324. }
  1325. err = dataprovider.AddSharedSession(session)
  1326. assert.NoError(t, err)
  1327. _, err = mgr.getToken(token.Cookie)
  1328. if assert.Error(t, err) {
  1329. assert.Contains(t, err.Error(), "token is too old")
  1330. }
  1331. mgr.cleanup()
  1332. _, err = mgr.getToken(token.Cookie)
  1333. if assert.Error(t, err) {
  1334. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1335. }
  1336. // adding a session without a key should fail
  1337. session.Key = ""
  1338. err = dataprovider.AddSharedSession(session)
  1339. if assert.Error(t, err) {
  1340. assert.Contains(t, err.Error(), "unable to save a session with an empty key")
  1341. }
  1342. session.Key = xid.New().String()
  1343. session.Type = 1000
  1344. err = dataprovider.AddSharedSession(session)
  1345. if assert.Error(t, err) {
  1346. assert.Contains(t, err.Error(), "invalid session type")
  1347. }
  1348. dbMgr, ok := mgr.(*dbOIDCManager)
  1349. if assert.True(t, ok) {
  1350. _, err = dbMgr.decodePendingAuthData(2)
  1351. assert.Error(t, err)
  1352. _, err = dbMgr.decodeTokenData(true)
  1353. assert.Error(t, err)
  1354. }
  1355. }
  1356. func getTestOIDCServer() *httpdServer {
  1357. return &httpdServer{
  1358. binding: Binding{
  1359. OIDC: OIDC{
  1360. ClientID: "sftpgo-client",
  1361. ClientSecret: "jRsmE0SWnuZjP7djBqNq0mrf8QN77j2c",
  1362. ConfigURL: fmt.Sprintf("http://%v/auth/realms/sftpgo", oidcMockAddr),
  1363. RedirectBaseURL: "http://127.0.0.1:8081/",
  1364. UsernameField: "preferred_username",
  1365. RoleField: "sftpgo_role",
  1366. ImplicitRoles: false,
  1367. Scopes: []string{oidc.ScopeOpenID, "profile", "email"},
  1368. CustomFields: nil,
  1369. Debug: true,
  1370. },
  1371. },
  1372. enableWebAdmin: true,
  1373. enableWebClient: true,
  1374. }
  1375. }
  1376. func getPreLoginScriptContent(user dataprovider.User, nonJSONResponse bool) []byte {
  1377. content := []byte("#!/bin/sh\n\n")
  1378. if nonJSONResponse {
  1379. content = append(content, []byte("echo 'text response'\n")...)
  1380. return content
  1381. }
  1382. if len(user.Username) > 0 {
  1383. u, _ := json.Marshal(user)
  1384. content = append(content, []byte(fmt.Sprintf("echo '%v'\n", string(u)))...)
  1385. }
  1386. return content
  1387. }