oidc_test.go 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561
  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/v2/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. r, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  509. assert.NoError(t, err)
  510. token := oidcToken{
  511. Cookie: xid.New().String(),
  512. AccessToken: xid.New().String(),
  513. TokenType: "Bearer",
  514. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-1 * time.Minute)),
  515. Nonce: xid.New().String(),
  516. Role: adminRoleFieldValue,
  517. Username: defaultAdminUsername,
  518. }
  519. config := mockOAuth2Config{
  520. tokenSource: &mockTokenSource{
  521. err: common.ErrGenericFailure,
  522. },
  523. }
  524. verifier := mockOIDCVerifier{
  525. err: common.ErrGenericFailure,
  526. }
  527. err = token.refresh(&config, &verifier, r)
  528. if assert.Error(t, err) {
  529. assert.Contains(t, err.Error(), "refresh token not set")
  530. }
  531. token.RefreshToken = xid.New().String()
  532. err = token.refresh(&config, &verifier, r)
  533. assert.ErrorIs(t, err, common.ErrGenericFailure)
  534. newToken := &oauth2.Token{
  535. AccessToken: xid.New().String(),
  536. RefreshToken: xid.New().String(),
  537. Expiry: time.Now().Add(5 * time.Minute),
  538. }
  539. config = mockOAuth2Config{
  540. tokenSource: &mockTokenSource{
  541. token: newToken,
  542. },
  543. }
  544. verifier = mockOIDCVerifier{
  545. token: &oidc.IDToken{},
  546. }
  547. err = token.refresh(&config, &verifier, r)
  548. if assert.Error(t, err) {
  549. assert.Contains(t, err.Error(), "the refreshed token has no id token")
  550. }
  551. newToken = newToken.WithExtra(map[string]any{
  552. "id_token": "id_token_val",
  553. })
  554. newToken.Expiry = time.Time{}
  555. config = mockOAuth2Config{
  556. tokenSource: &mockTokenSource{
  557. token: newToken,
  558. },
  559. }
  560. verifier = mockOIDCVerifier{
  561. err: common.ErrGenericFailure,
  562. }
  563. err = token.refresh(&config, &verifier, r)
  564. assert.ErrorIs(t, err, common.ErrGenericFailure)
  565. newToken = newToken.WithExtra(map[string]any{
  566. "id_token": "id_token_val",
  567. })
  568. newToken.Expiry = time.Now().Add(5 * time.Minute)
  569. config = mockOAuth2Config{
  570. tokenSource: &mockTokenSource{
  571. token: newToken,
  572. },
  573. }
  574. verifier = mockOIDCVerifier{
  575. token: &oidc.IDToken{},
  576. }
  577. err = token.refresh(&config, &verifier, r)
  578. if assert.Error(t, err) {
  579. assert.Contains(t, err.Error(), "the refreshed token nonce mismatch")
  580. }
  581. verifier = mockOIDCVerifier{
  582. token: &oidc.IDToken{
  583. Nonce: token.Nonce,
  584. },
  585. }
  586. err = token.refresh(&config, &verifier, r)
  587. if assert.Error(t, err) {
  588. assert.Contains(t, err.Error(), "oidc: claims not set")
  589. }
  590. idToken := &oidc.IDToken{
  591. Nonce: token.Nonce,
  592. }
  593. setIDTokenClaims(idToken, []byte(`{"sid":"id_token_sid"}`))
  594. verifier = mockOIDCVerifier{
  595. token: idToken,
  596. }
  597. err = token.refresh(&config, &verifier, r)
  598. assert.NoError(t, err)
  599. assert.Len(t, token.Permissions, 1)
  600. token.Role = nil
  601. // user does not exist
  602. err = token.refresh(&config, &verifier, r)
  603. assert.Error(t, err)
  604. require.Len(t, oidcMgr.tokens, 1)
  605. oidcMgr.removeToken(token.Cookie)
  606. require.Len(t, oidcMgr.tokens, 0)
  607. }
  608. func TestOIDCRefreshUser(t *testing.T) {
  609. token := oidcToken{
  610. Cookie: xid.New().String(),
  611. AccessToken: xid.New().String(),
  612. TokenType: "Bearer",
  613. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Minute)),
  614. Nonce: xid.New().String(),
  615. Role: adminRoleFieldValue,
  616. Username: "missing username",
  617. }
  618. r, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  619. assert.NoError(t, err)
  620. err = token.refreshUser(r)
  621. assert.Error(t, err)
  622. admin := dataprovider.Admin{
  623. Username: "test_oidc_admin_refresh",
  624. Password: "p",
  625. Permissions: []string{dataprovider.PermAdminAny},
  626. Status: 0,
  627. Filters: dataprovider.AdminFilters{
  628. Preferences: dataprovider.AdminPreferences{
  629. HideUserPageSections: 1 + 2 + 4,
  630. },
  631. },
  632. }
  633. err = dataprovider.AddAdmin(&admin, "", "")
  634. assert.NoError(t, err)
  635. token.Username = admin.Username
  636. err = token.refreshUser(r)
  637. if assert.Error(t, err) {
  638. assert.Contains(t, err.Error(), "is disabled")
  639. }
  640. admin.Status = 1
  641. err = dataprovider.UpdateAdmin(&admin, "", "")
  642. assert.NoError(t, err)
  643. err = token.refreshUser(r)
  644. assert.NoError(t, err)
  645. assert.Equal(t, admin.Permissions, token.Permissions)
  646. assert.Equal(t, admin.Filters.Preferences.HideUserPageSections, token.HideUserPageSections)
  647. err = dataprovider.DeleteAdmin(admin.Username, "", "")
  648. assert.NoError(t, err)
  649. username := "test_oidc_user_refresh_token"
  650. user := dataprovider.User{
  651. BaseUser: sdk.BaseUser{
  652. Username: username,
  653. Password: "p",
  654. HomeDir: filepath.Join(os.TempDir(), username),
  655. Status: 0,
  656. Permissions: map[string][]string{
  657. "/": {dataprovider.PermAny},
  658. },
  659. },
  660. Filters: dataprovider.UserFilters{
  661. BaseUserFilters: sdk.BaseUserFilters{
  662. DeniedProtocols: []string{common.ProtocolHTTP},
  663. WebClient: []string{sdk.WebClientSharesDisabled, sdk.WebClientWriteDisabled},
  664. },
  665. },
  666. }
  667. err = dataprovider.AddUser(&user, "", "")
  668. assert.NoError(t, err)
  669. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  670. assert.NoError(t, err)
  671. token.Role = nil
  672. token.Username = username
  673. assert.False(t, token.isAdmin())
  674. err = token.refreshUser(r)
  675. if assert.Error(t, err) {
  676. assert.Contains(t, err.Error(), "is disabled")
  677. }
  678. user, err = dataprovider.UserExists(username)
  679. assert.NoError(t, err)
  680. user.Status = 1
  681. err = dataprovider.UpdateUser(&user, "", "")
  682. assert.NoError(t, err)
  683. err = token.refreshUser(r)
  684. if assert.Error(t, err) {
  685. assert.Contains(t, err.Error(), "protocol HTTP is not allowed")
  686. }
  687. user.Filters.DeniedProtocols = []string{common.ProtocolFTP}
  688. err = dataprovider.UpdateUser(&user, "", "")
  689. assert.NoError(t, err)
  690. err = token.refreshUser(r)
  691. assert.NoError(t, err)
  692. assert.Equal(t, user.Filters.WebClient, token.Permissions)
  693. err = dataprovider.DeleteUser(username, "", "")
  694. assert.NoError(t, err)
  695. }
  696. func TestValidateOIDCToken(t *testing.T) {
  697. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  698. require.True(t, ok)
  699. server := getTestOIDCServer()
  700. err := server.binding.OIDC.initialize()
  701. assert.NoError(t, err)
  702. server.initializeRouter()
  703. rr := httptest.NewRecorder()
  704. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  705. assert.NoError(t, err)
  706. _, err = server.validateOIDCToken(rr, r, false)
  707. assert.ErrorIs(t, err, errInvalidToken)
  708. // expired token and refresh error
  709. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  710. tokenSource: &mockTokenSource{
  711. err: common.ErrGenericFailure,
  712. },
  713. }
  714. token := oidcToken{
  715. Cookie: xid.New().String(),
  716. AccessToken: xid.New().String(),
  717. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  718. }
  719. oidcMgr.addToken(token)
  720. rr = httptest.NewRecorder()
  721. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  722. assert.NoError(t, err)
  723. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  724. _, err = server.validateOIDCToken(rr, r, false)
  725. assert.ErrorIs(t, err, errInvalidToken)
  726. oidcMgr.removeToken(token.Cookie)
  727. assert.Len(t, oidcMgr.tokens, 0)
  728. server.tokenAuth = jwtauth.New("PS256", util.GenerateRandomBytes(32), nil)
  729. token = oidcToken{
  730. Cookie: xid.New().String(),
  731. AccessToken: xid.New().String(),
  732. }
  733. oidcMgr.addToken(token)
  734. rr = httptest.NewRecorder()
  735. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  736. assert.NoError(t, err)
  737. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  738. server.router.ServeHTTP(rr, r)
  739. assert.Equal(t, http.StatusFound, rr.Code)
  740. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  741. oidcMgr.removeToken(token.Cookie)
  742. assert.Len(t, oidcMgr.tokens, 0)
  743. token = oidcToken{
  744. Cookie: xid.New().String(),
  745. AccessToken: xid.New().String(),
  746. Role: "admin",
  747. }
  748. oidcMgr.addToken(token)
  749. rr = httptest.NewRecorder()
  750. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  751. assert.NoError(t, err)
  752. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  753. server.router.ServeHTTP(rr, r)
  754. assert.Equal(t, http.StatusFound, rr.Code)
  755. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  756. oidcMgr.removeToken(token.Cookie)
  757. assert.Len(t, oidcMgr.tokens, 0)
  758. }
  759. func TestSkipOIDCAuth(t *testing.T) {
  760. server := getTestOIDCServer()
  761. err := server.binding.OIDC.initialize()
  762. assert.NoError(t, err)
  763. server.initializeRouter()
  764. jwtTokenClaims := jwtTokenClaims{
  765. Username: "user",
  766. }
  767. _, tokenString, err := jwtTokenClaims.createToken(server.tokenAuth, tokenAudienceWebClient, "")
  768. assert.NoError(t, err)
  769. rr := httptest.NewRecorder()
  770. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  771. assert.NoError(t, err)
  772. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", jwtCookieKey, tokenString))
  773. server.router.ServeHTTP(rr, r)
  774. assert.Equal(t, http.StatusFound, rr.Code)
  775. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  776. }
  777. func TestOIDCLogoutErrors(t *testing.T) {
  778. server := getTestOIDCServer()
  779. assert.Empty(t, server.binding.OIDC.providerLogoutURL)
  780. server.logoutFromOIDCOP("")
  781. server.binding.OIDC.providerLogoutURL = "http://foo\x7f.com/"
  782. server.doOIDCFromLogout("")
  783. server.binding.OIDC.providerLogoutURL = "http://127.0.0.1:11234"
  784. server.doOIDCFromLogout("")
  785. }
  786. func TestOIDCToken(t *testing.T) {
  787. admin := dataprovider.Admin{
  788. Username: "test_oidc_admin",
  789. Password: "p",
  790. Permissions: []string{dataprovider.PermAdminAny},
  791. Status: 0,
  792. }
  793. err := dataprovider.AddAdmin(&admin, "", "")
  794. assert.NoError(t, err)
  795. token := oidcToken{
  796. Username: admin.Username,
  797. Role: "admin",
  798. }
  799. req, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  800. assert.NoError(t, err)
  801. err = token.getUser(req)
  802. if assert.Error(t, err) {
  803. assert.Contains(t, err.Error(), "is disabled")
  804. }
  805. err = dataprovider.DeleteAdmin(admin.Username, "", "")
  806. assert.NoError(t, err)
  807. username := "test_oidc_user"
  808. token.Username = username
  809. token.Role = ""
  810. err = token.getUser(req)
  811. if assert.Error(t, err) {
  812. _, ok := err.(*util.RecordNotFoundError)
  813. assert.True(t, ok)
  814. }
  815. user := dataprovider.User{
  816. BaseUser: sdk.BaseUser{
  817. Username: username,
  818. Password: "p",
  819. HomeDir: filepath.Join(os.TempDir(), username),
  820. Status: 0,
  821. Permissions: map[string][]string{
  822. "/": {dataprovider.PermAny},
  823. },
  824. },
  825. Filters: dataprovider.UserFilters{
  826. BaseUserFilters: sdk.BaseUserFilters{
  827. DeniedProtocols: []string{common.ProtocolHTTP},
  828. },
  829. },
  830. }
  831. err = dataprovider.AddUser(&user, "", "")
  832. assert.NoError(t, err)
  833. err = token.getUser(req)
  834. if assert.Error(t, err) {
  835. assert.Contains(t, err.Error(), "is disabled")
  836. }
  837. user, err = dataprovider.UserExists(username)
  838. assert.NoError(t, err)
  839. user.Status = 1
  840. user.Password = "np"
  841. err = dataprovider.UpdateUser(&user, "", "")
  842. assert.NoError(t, err)
  843. err = token.getUser(req)
  844. if assert.Error(t, err) {
  845. assert.Contains(t, err.Error(), "protocol HTTP is not allowed")
  846. }
  847. user.Filters.DeniedProtocols = nil
  848. user.FsConfig.Provider = sdk.SFTPFilesystemProvider
  849. user.FsConfig.SFTPConfig = vfs.SFTPFsConfig{
  850. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  851. Endpoint: "127.0.0.1:8022",
  852. Username: username,
  853. },
  854. Password: kms.NewPlainSecret("np"),
  855. }
  856. err = dataprovider.UpdateUser(&user, "", "")
  857. assert.NoError(t, err)
  858. err = token.getUser(req)
  859. if assert.Error(t, err) {
  860. assert.Contains(t, err.Error(), "SFTP loop")
  861. }
  862. common.Config.PostConnectHook = fmt.Sprintf("http://%v/404", oidcMockAddr)
  863. err = token.getUser(req)
  864. if assert.Error(t, err) {
  865. assert.Contains(t, err.Error(), "access denied by post connect hook")
  866. }
  867. common.Config.PostConnectHook = ""
  868. err = os.RemoveAll(user.GetHomeDir())
  869. assert.NoError(t, err)
  870. err = dataprovider.DeleteUser(username, "", "")
  871. assert.NoError(t, err)
  872. }
  873. func TestOIDCImplicitRoles(t *testing.T) {
  874. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  875. require.True(t, ok)
  876. server := getTestOIDCServer()
  877. server.binding.OIDC.ImplicitRoles = true
  878. err := server.binding.OIDC.initialize()
  879. assert.NoError(t, err)
  880. server.initializeRouter()
  881. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  882. oidcMgr.addPendingAuth(authReq)
  883. token := &oauth2.Token{
  884. AccessToken: "1234",
  885. Expiry: time.Now().Add(5 * time.Minute),
  886. }
  887. token = token.WithExtra(map[string]any{
  888. "id_token": "id_token_val",
  889. })
  890. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  891. tokenSource: &mockTokenSource{},
  892. authCodeURL: webOIDCRedirectPath,
  893. token: token,
  894. }
  895. idToken := &oidc.IDToken{
  896. Nonce: authReq.Nonce,
  897. Expiry: time.Now().Add(5 * time.Minute),
  898. }
  899. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  900. server.binding.OIDC.verifier = &mockOIDCVerifier{
  901. err: nil,
  902. token: idToken,
  903. }
  904. rr := httptest.NewRecorder()
  905. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  906. assert.NoError(t, err)
  907. server.router.ServeHTTP(rr, r)
  908. assert.Equal(t, http.StatusFound, rr.Code)
  909. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  910. require.Len(t, oidcMgr.pendingAuths, 0)
  911. require.Len(t, oidcMgr.tokens, 1)
  912. var tokenCookie string
  913. for k := range oidcMgr.tokens {
  914. tokenCookie = k
  915. }
  916. // Web Client is not available with an admin token
  917. rr = httptest.NewRecorder()
  918. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  919. assert.NoError(t, err)
  920. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  921. server.router.ServeHTTP(rr, r)
  922. assert.Equal(t, http.StatusFound, rr.Code)
  923. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  924. // logout the admin user
  925. rr = httptest.NewRecorder()
  926. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  927. assert.NoError(t, err)
  928. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  929. server.router.ServeHTTP(rr, r)
  930. assert.Equal(t, http.StatusFound, rr.Code)
  931. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  932. require.Len(t, oidcMgr.pendingAuths, 0)
  933. require.Len(t, oidcMgr.tokens, 0)
  934. // now login and logout a user
  935. username := "test_oidc_implicit_user"
  936. user := dataprovider.User{
  937. BaseUser: sdk.BaseUser{
  938. Username: username,
  939. Password: "pwd",
  940. HomeDir: filepath.Join(os.TempDir(), username),
  941. Status: 1,
  942. Permissions: map[string][]string{
  943. "/": {dataprovider.PermAny},
  944. },
  945. },
  946. Filters: dataprovider.UserFilters{
  947. BaseUserFilters: sdk.BaseUserFilters{
  948. WebClient: []string{sdk.WebClientSharesDisabled},
  949. },
  950. },
  951. }
  952. err = dataprovider.AddUser(&user, "", "")
  953. assert.NoError(t, err)
  954. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  955. oidcMgr.addPendingAuth(authReq)
  956. idToken = &oidc.IDToken{
  957. Nonce: authReq.Nonce,
  958. Expiry: time.Now().Add(5 * time.Minute),
  959. }
  960. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test_oidc_implicit_user"}`))
  961. server.binding.OIDC.verifier = &mockOIDCVerifier{
  962. err: nil,
  963. token: idToken,
  964. }
  965. rr = httptest.NewRecorder()
  966. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  967. assert.NoError(t, err)
  968. server.router.ServeHTTP(rr, r)
  969. assert.Equal(t, http.StatusFound, rr.Code)
  970. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  971. require.Len(t, oidcMgr.pendingAuths, 0)
  972. require.Len(t, oidcMgr.tokens, 1)
  973. for k := range oidcMgr.tokens {
  974. tokenCookie = k
  975. }
  976. rr = httptest.NewRecorder()
  977. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  978. assert.NoError(t, err)
  979. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  980. server.router.ServeHTTP(rr, r)
  981. assert.Equal(t, http.StatusFound, rr.Code)
  982. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  983. require.Len(t, oidcMgr.pendingAuths, 0)
  984. require.Len(t, oidcMgr.tokens, 0)
  985. err = os.RemoveAll(user.GetHomeDir())
  986. assert.NoError(t, err)
  987. err = dataprovider.DeleteUser(username, "", "")
  988. assert.NoError(t, err)
  989. }
  990. func TestMemoryOIDCManager(t *testing.T) {
  991. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  992. require.True(t, ok)
  993. require.Len(t, oidcMgr.pendingAuths, 0)
  994. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  995. oidcMgr.addPendingAuth(authReq)
  996. require.Len(t, oidcMgr.pendingAuths, 1)
  997. _, err := oidcMgr.getPendingAuth(authReq.State)
  998. assert.NoError(t, err)
  999. oidcMgr.removePendingAuth(authReq.State)
  1000. require.Len(t, oidcMgr.pendingAuths, 0)
  1001. authReq.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-61 * time.Second))
  1002. oidcMgr.addPendingAuth(authReq)
  1003. require.Len(t, oidcMgr.pendingAuths, 1)
  1004. _, err = oidcMgr.getPendingAuth(authReq.State)
  1005. if assert.Error(t, err) {
  1006. assert.Contains(t, err.Error(), "too old")
  1007. }
  1008. oidcMgr.cleanup()
  1009. require.Len(t, oidcMgr.pendingAuths, 0)
  1010. token := oidcToken{
  1011. AccessToken: xid.New().String(),
  1012. Nonce: xid.New().String(),
  1013. SessionID: xid.New().String(),
  1014. Cookie: xid.New().String(),
  1015. Username: xid.New().String(),
  1016. Role: "admin",
  1017. Permissions: []string{dataprovider.PermAdminAny},
  1018. }
  1019. require.Len(t, oidcMgr.tokens, 0)
  1020. oidcMgr.addToken(token)
  1021. require.Len(t, oidcMgr.tokens, 1)
  1022. _, err = oidcMgr.getToken(xid.New().String())
  1023. assert.Error(t, err)
  1024. storedToken, err := oidcMgr.getToken(token.Cookie)
  1025. assert.NoError(t, err)
  1026. token.UsedAt = 0 // ensure we don't modify the stored token
  1027. assert.Greater(t, storedToken.UsedAt, int64(0))
  1028. token.UsedAt = storedToken.UsedAt
  1029. assert.Equal(t, token, storedToken)
  1030. // the usage will not be updated, it is recent
  1031. oidcMgr.updateTokenUsage(storedToken)
  1032. storedToken, err = oidcMgr.getToken(token.Cookie)
  1033. assert.NoError(t, err)
  1034. assert.Equal(t, token, storedToken)
  1035. usedAt := util.GetTimeAsMsSinceEpoch(time.Now().Add(-5 * time.Minute))
  1036. storedToken.UsedAt = usedAt
  1037. oidcMgr.tokens[token.Cookie] = storedToken
  1038. storedToken, err = oidcMgr.getToken(token.Cookie)
  1039. assert.NoError(t, err)
  1040. assert.Equal(t, usedAt, storedToken.UsedAt)
  1041. token.UsedAt = storedToken.UsedAt
  1042. assert.Equal(t, token, storedToken)
  1043. oidcMgr.updateTokenUsage(storedToken)
  1044. storedToken, err = oidcMgr.getToken(token.Cookie)
  1045. assert.NoError(t, err)
  1046. assert.Greater(t, storedToken.UsedAt, usedAt)
  1047. token.UsedAt = storedToken.UsedAt
  1048. assert.Equal(t, token, storedToken)
  1049. storedToken.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now()) - tokenDeleteInterval - 1
  1050. oidcMgr.tokens[token.Cookie] = storedToken
  1051. storedToken, err = oidcMgr.getToken(token.Cookie)
  1052. if assert.Error(t, err) {
  1053. assert.Contains(t, err.Error(), "token is too old")
  1054. }
  1055. oidcMgr.removeToken(xid.New().String())
  1056. require.Len(t, oidcMgr.tokens, 1)
  1057. oidcMgr.removeToken(token.Cookie)
  1058. require.Len(t, oidcMgr.tokens, 0)
  1059. oidcMgr.addToken(token)
  1060. usedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-6 * time.Hour))
  1061. token.UsedAt = usedAt
  1062. oidcMgr.tokens[token.Cookie] = token
  1063. newToken := oidcToken{
  1064. Cookie: xid.New().String(),
  1065. }
  1066. oidcMgr.addToken(newToken)
  1067. oidcMgr.cleanup()
  1068. require.Len(t, oidcMgr.tokens, 1)
  1069. _, err = oidcMgr.getToken(token.Cookie)
  1070. assert.Error(t, err)
  1071. _, err = oidcMgr.getToken(newToken.Cookie)
  1072. assert.NoError(t, err)
  1073. oidcMgr.removeToken(newToken.Cookie)
  1074. require.Len(t, oidcMgr.tokens, 0)
  1075. }
  1076. func TestOIDCPreLoginHook(t *testing.T) {
  1077. if runtime.GOOS == osWindows {
  1078. t.Skip("this test is not available on Windows")
  1079. }
  1080. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1081. require.True(t, ok)
  1082. username := "test_oidc_user_prelogin"
  1083. u := dataprovider.User{
  1084. BaseUser: sdk.BaseUser{
  1085. Username: username,
  1086. HomeDir: filepath.Join(os.TempDir(), username),
  1087. Status: 1,
  1088. Permissions: map[string][]string{
  1089. "/": {dataprovider.PermAny},
  1090. },
  1091. },
  1092. }
  1093. preLoginPath := filepath.Join(os.TempDir(), "prelogin.sh")
  1094. providerConf := dataprovider.GetProviderConfig()
  1095. err := dataprovider.Close()
  1096. assert.NoError(t, err)
  1097. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, false), os.ModePerm)
  1098. assert.NoError(t, err)
  1099. newProviderConf := providerConf
  1100. newProviderConf.PreLoginHook = preLoginPath
  1101. err = dataprovider.Initialize(newProviderConf, configDir, true)
  1102. assert.NoError(t, err)
  1103. server := getTestOIDCServer()
  1104. server.binding.OIDC.CustomFields = []string{"field1", "field2"}
  1105. err = server.binding.OIDC.initialize()
  1106. assert.NoError(t, err)
  1107. server.initializeRouter()
  1108. _, err = dataprovider.UserExists(username)
  1109. _, ok = err.(*util.RecordNotFoundError)
  1110. assert.True(t, ok)
  1111. // now login with OIDC
  1112. authReq := newOIDCPendingAuth(tokenAudienceWebClient)
  1113. oidcMgr.addPendingAuth(authReq)
  1114. token := &oauth2.Token{
  1115. AccessToken: "1234",
  1116. Expiry: time.Now().Add(5 * time.Minute),
  1117. }
  1118. token = token.WithExtra(map[string]any{
  1119. "id_token": "id_token_val",
  1120. })
  1121. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1122. tokenSource: &mockTokenSource{},
  1123. authCodeURL: webOIDCRedirectPath,
  1124. token: token,
  1125. }
  1126. idToken := &oidc.IDToken{
  1127. Nonce: authReq.Nonce,
  1128. Expiry: time.Now().Add(5 * time.Minute),
  1129. }
  1130. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`"}`))
  1131. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1132. err: nil,
  1133. token: idToken,
  1134. }
  1135. rr := httptest.NewRecorder()
  1136. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1137. assert.NoError(t, err)
  1138. server.router.ServeHTTP(rr, r)
  1139. assert.Equal(t, http.StatusFound, rr.Code)
  1140. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  1141. _, err = dataprovider.UserExists(username)
  1142. assert.NoError(t, err)
  1143. err = dataprovider.DeleteUser(username, "", "")
  1144. assert.NoError(t, err)
  1145. err = os.RemoveAll(u.HomeDir)
  1146. assert.NoError(t, err)
  1147. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, true), os.ModePerm)
  1148. assert.NoError(t, err)
  1149. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  1150. oidcMgr.addPendingAuth(authReq)
  1151. idToken = &oidc.IDToken{
  1152. Nonce: authReq.Nonce,
  1153. Expiry: time.Now().Add(5 * time.Minute),
  1154. }
  1155. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`","field1":"value1","field2":"value2","field3":"value3"}`))
  1156. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1157. err: nil,
  1158. token: idToken,
  1159. }
  1160. rr = httptest.NewRecorder()
  1161. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1162. assert.NoError(t, err)
  1163. server.router.ServeHTTP(rr, r)
  1164. assert.Equal(t, http.StatusFound, rr.Code)
  1165. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  1166. _, err = dataprovider.UserExists(username)
  1167. _, ok = err.(*util.RecordNotFoundError)
  1168. assert.True(t, ok)
  1169. if assert.Len(t, oidcMgr.tokens, 1) {
  1170. for k := range oidcMgr.tokens {
  1171. oidcMgr.removeToken(k)
  1172. }
  1173. }
  1174. require.Len(t, oidcMgr.pendingAuths, 0)
  1175. require.Len(t, oidcMgr.tokens, 0)
  1176. err = dataprovider.Close()
  1177. assert.NoError(t, err)
  1178. err = dataprovider.Initialize(providerConf, configDir, true)
  1179. assert.NoError(t, err)
  1180. err = os.Remove(preLoginPath)
  1181. assert.NoError(t, err)
  1182. }
  1183. func TestOIDCIsAdmin(t *testing.T) {
  1184. type test struct {
  1185. input any
  1186. want bool
  1187. }
  1188. emptySlice := make([]any, 0)
  1189. tests := []test{
  1190. {input: "admin", want: true},
  1191. {input: append(emptySlice, "admin"), want: true},
  1192. {input: append(emptySlice, "user", "admin"), want: true},
  1193. {input: "user", want: false},
  1194. {input: emptySlice, want: false},
  1195. {input: append(emptySlice, 1), want: false},
  1196. {input: 1, want: false},
  1197. {input: nil, want: false},
  1198. {input: map[string]string{"admin": "admin"}, want: false},
  1199. }
  1200. for _, tc := range tests {
  1201. token := oidcToken{
  1202. Role: tc.input,
  1203. }
  1204. assert.Equal(t, tc.want, token.isAdmin(), "%v should return %t", tc.input, tc.want)
  1205. }
  1206. }
  1207. func TestParseAdminRole(t *testing.T) {
  1208. claims := make(map[string]any)
  1209. rawClaims := []byte(`{
  1210. "sub": "35666371",
  1211. "email": "[email protected]",
  1212. "preferred_username": "Sally",
  1213. "name": "Sally Tyler",
  1214. "updated_at": "2018-04-13T22:08:45Z",
  1215. "given_name": "Sally",
  1216. "family_name": "Tyler",
  1217. "params": {
  1218. "sftpgo_role": "admin",
  1219. "subparams": {
  1220. "sftpgo_role": "admin",
  1221. "inner": {
  1222. "sftpgo_role": ["user","admin"]
  1223. }
  1224. }
  1225. },
  1226. "at_hash": "lPLhxI2wjEndc-WfyroDZA",
  1227. "rt_hash": "mCmxPtA04N-55AxlEUbq-A",
  1228. "aud": "78d1d040-20c9-0136-5146-067351775fae92920",
  1229. "exp": 1523664997,
  1230. "iat": 1523657797
  1231. }`)
  1232. err := json.Unmarshal(rawClaims, &claims)
  1233. assert.NoError(t, err)
  1234. type test struct {
  1235. input string
  1236. want bool
  1237. }
  1238. tests := []test{
  1239. {input: "sftpgo_role", want: false},
  1240. {input: "params.sftpgo_role", want: true},
  1241. {input: "params.subparams.sftpgo_role", want: true},
  1242. {input: "params.subparams.inner.sftpgo_role", want: true},
  1243. {input: "email", want: false},
  1244. {input: "missing", want: false},
  1245. {input: "params.email", want: false},
  1246. {input: "missing.sftpgo_role", want: false},
  1247. {input: "params", want: false},
  1248. {input: "params.subparams.inner.sftpgo_role.missing", want: false},
  1249. }
  1250. for _, tc := range tests {
  1251. token := oidcToken{}
  1252. token.getRoleFromField(claims, tc.input)
  1253. assert.Equal(t, tc.want, token.isAdmin(), "%q should return %t", tc.input, tc.want)
  1254. }
  1255. }
  1256. func TestOIDCWithLoginFormsDisabled(t *testing.T) {
  1257. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1258. require.True(t, ok)
  1259. server := getTestOIDCServer()
  1260. server.binding.OIDC.ImplicitRoles = true
  1261. server.binding.EnabledLoginMethods = 3
  1262. server.binding.EnableWebAdmin = true
  1263. server.binding.EnableWebClient = true
  1264. err := server.binding.OIDC.initialize()
  1265. assert.NoError(t, err)
  1266. server.initializeRouter()
  1267. // login with an admin user
  1268. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1269. oidcMgr.addPendingAuth(authReq)
  1270. token := &oauth2.Token{
  1271. AccessToken: "1234",
  1272. Expiry: time.Now().Add(5 * time.Minute),
  1273. }
  1274. token = token.WithExtra(map[string]any{
  1275. "id_token": "id_token_val",
  1276. })
  1277. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1278. tokenSource: &mockTokenSource{},
  1279. authCodeURL: webOIDCRedirectPath,
  1280. token: token,
  1281. }
  1282. idToken := &oidc.IDToken{
  1283. Nonce: authReq.Nonce,
  1284. Expiry: time.Now().Add(5 * time.Minute),
  1285. }
  1286. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  1287. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1288. err: nil,
  1289. token: idToken,
  1290. }
  1291. rr := httptest.NewRecorder()
  1292. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1293. assert.NoError(t, err)
  1294. server.router.ServeHTTP(rr, r)
  1295. assert.Equal(t, http.StatusFound, rr.Code)
  1296. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  1297. var tokenCookie string
  1298. for k := range oidcMgr.tokens {
  1299. tokenCookie = k
  1300. }
  1301. // we should be able to create admins without setting a password
  1302. if csrfTokenAuth == nil {
  1303. csrfTokenAuth = jwtauth.New(jwa.HS256.String(), util.GenerateRandomBytes(32), nil)
  1304. }
  1305. adminUsername := "testAdmin"
  1306. form := make(url.Values)
  1307. form.Set(csrfFormToken, createCSRFToken(""))
  1308. form.Set("username", adminUsername)
  1309. form.Set("password", "")
  1310. form.Set("status", "1")
  1311. form.Set("permissions", "*")
  1312. rr = httptest.NewRecorder()
  1313. r, err = http.NewRequest(http.MethodPost, webAdminPath, bytes.NewBuffer([]byte(form.Encode())))
  1314. assert.NoError(t, err)
  1315. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  1316. r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
  1317. server.router.ServeHTTP(rr, r)
  1318. assert.Equal(t, http.StatusSeeOther, rr.Code)
  1319. _, err = dataprovider.AdminExists(adminUsername)
  1320. assert.NoError(t, err)
  1321. err = dataprovider.DeleteAdmin(adminUsername, "", "")
  1322. assert.NoError(t, err)
  1323. // login and password related routes are disabled
  1324. rr = httptest.NewRecorder()
  1325. r, err = http.NewRequest(http.MethodPost, webAdminLoginPath, nil)
  1326. assert.NoError(t, err)
  1327. server.router.ServeHTTP(rr, r)
  1328. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1329. rr = httptest.NewRecorder()
  1330. r, err = http.NewRequest(http.MethodPost, webAdminTwoFactorPath, nil)
  1331. assert.NoError(t, err)
  1332. server.router.ServeHTTP(rr, r)
  1333. assert.Equal(t, http.StatusNotFound, rr.Code)
  1334. rr = httptest.NewRecorder()
  1335. r, err = http.NewRequest(http.MethodPost, webClientLoginPath, nil)
  1336. assert.NoError(t, err)
  1337. server.router.ServeHTTP(rr, r)
  1338. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1339. rr = httptest.NewRecorder()
  1340. r, err = http.NewRequest(http.MethodPost, webClientForgotPwdPath, nil)
  1341. assert.NoError(t, err)
  1342. server.router.ServeHTTP(rr, r)
  1343. assert.Equal(t, http.StatusNotFound, rr.Code)
  1344. }
  1345. func TestDbOIDCManager(t *testing.T) {
  1346. if !isSharedProviderSupported() {
  1347. t.Skip("this test it is not available with this provider")
  1348. }
  1349. mgr := newOIDCManager(1)
  1350. pendingAuth := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1351. mgr.addPendingAuth(pendingAuth)
  1352. authReq, err := mgr.getPendingAuth(pendingAuth.State)
  1353. assert.NoError(t, err)
  1354. assert.Equal(t, pendingAuth, authReq)
  1355. pendingAuth.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1356. mgr.addPendingAuth(pendingAuth)
  1357. _, err = mgr.getPendingAuth(pendingAuth.State)
  1358. if assert.Error(t, err) {
  1359. assert.Contains(t, err.Error(), "auth request is too old")
  1360. }
  1361. mgr.removePendingAuth(pendingAuth.State)
  1362. _, err = mgr.getPendingAuth(pendingAuth.State)
  1363. if assert.Error(t, err) {
  1364. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1365. }
  1366. mgr.addPendingAuth(pendingAuth)
  1367. _, err = mgr.getPendingAuth(pendingAuth.State)
  1368. if assert.Error(t, err) {
  1369. assert.Contains(t, err.Error(), "auth request is too old")
  1370. }
  1371. mgr.cleanup()
  1372. _, err = mgr.getPendingAuth(pendingAuth.State)
  1373. if assert.Error(t, err) {
  1374. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1375. }
  1376. token := oidcToken{
  1377. Cookie: xid.New().String(),
  1378. AccessToken: xid.New().String(),
  1379. TokenType: "Bearer",
  1380. RefreshToken: xid.New().String(),
  1381. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  1382. SessionID: xid.New().String(),
  1383. IDToken: xid.New().String(),
  1384. Nonce: xid.New().String(),
  1385. Username: xid.New().String(),
  1386. Permissions: []string{dataprovider.PermAdminAny},
  1387. Role: "admin",
  1388. }
  1389. mgr.addToken(token)
  1390. tokenGet, err := mgr.getToken(token.Cookie)
  1391. assert.NoError(t, err)
  1392. assert.Greater(t, tokenGet.UsedAt, int64(0))
  1393. token.UsedAt = tokenGet.UsedAt
  1394. assert.Equal(t, token, tokenGet)
  1395. time.Sleep(100 * time.Millisecond)
  1396. mgr.updateTokenUsage(token)
  1397. // no change
  1398. tokenGet, err = mgr.getToken(token.Cookie)
  1399. assert.NoError(t, err)
  1400. assert.Equal(t, token.UsedAt, tokenGet.UsedAt)
  1401. tokenGet.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1402. tokenGet.RefreshToken = xid.New().String()
  1403. mgr.updateTokenUsage(tokenGet)
  1404. tokenGet, err = mgr.getToken(token.Cookie)
  1405. assert.NoError(t, err)
  1406. assert.NotEmpty(t, tokenGet.RefreshToken)
  1407. assert.NotEqual(t, token.RefreshToken, tokenGet.RefreshToken)
  1408. assert.Greater(t, tokenGet.UsedAt, token.UsedAt)
  1409. mgr.removeToken(token.Cookie)
  1410. tokenGet, err = mgr.getToken(token.Cookie)
  1411. if assert.Error(t, err) {
  1412. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1413. }
  1414. // add an expired token
  1415. token.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1416. session := dataprovider.Session{
  1417. Key: token.Cookie,
  1418. Data: token,
  1419. Type: dataprovider.SessionTypeOIDCToken,
  1420. Timestamp: token.UsedAt + tokenDeleteInterval,
  1421. }
  1422. err = dataprovider.AddSharedSession(session)
  1423. assert.NoError(t, err)
  1424. _, err = mgr.getToken(token.Cookie)
  1425. if assert.Error(t, err) {
  1426. assert.Contains(t, err.Error(), "token is too old")
  1427. }
  1428. mgr.cleanup()
  1429. _, err = mgr.getToken(token.Cookie)
  1430. if assert.Error(t, err) {
  1431. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1432. }
  1433. // adding a session without a key should fail
  1434. session.Key = ""
  1435. err = dataprovider.AddSharedSession(session)
  1436. if assert.Error(t, err) {
  1437. assert.Contains(t, err.Error(), "unable to save a session with an empty key")
  1438. }
  1439. session.Key = xid.New().String()
  1440. session.Type = 1000
  1441. err = dataprovider.AddSharedSession(session)
  1442. if assert.Error(t, err) {
  1443. assert.Contains(t, err.Error(), "invalid session type")
  1444. }
  1445. dbMgr, ok := mgr.(*dbOIDCManager)
  1446. if assert.True(t, ok) {
  1447. _, err = dbMgr.decodePendingAuthData(2)
  1448. assert.Error(t, err)
  1449. _, err = dbMgr.decodeTokenData(true)
  1450. assert.Error(t, err)
  1451. }
  1452. }
  1453. func getTestOIDCServer() *httpdServer {
  1454. return &httpdServer{
  1455. binding: Binding{
  1456. OIDC: OIDC{
  1457. ClientID: "sftpgo-client",
  1458. ClientSecret: "jRsmE0SWnuZjP7djBqNq0mrf8QN77j2c",
  1459. ConfigURL: fmt.Sprintf("http://%v/auth/realms/sftpgo", oidcMockAddr),
  1460. RedirectBaseURL: "http://127.0.0.1:8081/",
  1461. UsernameField: "preferred_username",
  1462. RoleField: "sftpgo_role",
  1463. ImplicitRoles: false,
  1464. Scopes: []string{oidc.ScopeOpenID, "profile", "email"},
  1465. CustomFields: nil,
  1466. Debug: true,
  1467. },
  1468. },
  1469. enableWebAdmin: true,
  1470. enableWebClient: true,
  1471. }
  1472. }
  1473. func getPreLoginScriptContent(user dataprovider.User, nonJSONResponse bool) []byte {
  1474. content := []byte("#!/bin/sh\n\n")
  1475. if nonJSONResponse {
  1476. content = append(content, []byte("echo 'text response'\n")...)
  1477. return content
  1478. }
  1479. if len(user.Username) > 0 {
  1480. u, _ := json.Marshal(user)
  1481. content = append(content, []byte(fmt.Sprintf("echo '%v'\n", string(u)))...)
  1482. }
  1483. return content
  1484. }