oidc_test.go 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763
  1. // Copyright (C) 2019-2023 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(_ string, _ ...oauth2.AuthCodeOption) string {
  61. return c.authCodeURL
  62. }
  63. func (c *mockOAuth2Config) Exchange(_ context.Context, _ string, _ ...oauth2.AuthCodeOption) (*oauth2.Token, error) {
  64. return c.token, c.err
  65. }
  66. func (c *mockOAuth2Config) TokenSource(_ context.Context, _ *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(_ context.Context, _ 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 id token clamims: username not a string
  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(`{"aud": "my_client_id","preferred_username": 1}`))
  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(tokenAudienceWebClient)
  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","sftpgo_role":"admin"}`))
  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, webClientLoginPath, rr.Header().Get("Location"))
  320. require.Len(t, oidcMgr.pendingAuths, 0)
  321. // invalid audience
  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"}`))
  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. // mapped user not found
  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":"test","sftpgo_role":"admin"}`))
  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, webAdminLoginPath, rr.Header().Get("Location"))
  358. require.Len(t, oidcMgr.pendingAuths, 0)
  359. // admin login ok
  360. authReq = newOIDCPendingAuth(tokenAudienceWebAdmin)
  361. oidcMgr.addPendingAuth(authReq)
  362. idToken = &oidc.IDToken{
  363. Nonce: authReq.Nonce,
  364. Expiry: time.Now().Add(5 * time.Minute),
  365. }
  366. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sftpgo_role":"admin","sid":"sid123"}`))
  367. server.binding.OIDC.verifier = &mockOIDCVerifier{
  368. err: nil,
  369. token: idToken,
  370. }
  371. rr = httptest.NewRecorder()
  372. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  373. assert.NoError(t, err)
  374. server.router.ServeHTTP(rr, r)
  375. assert.Equal(t, http.StatusFound, rr.Code)
  376. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  377. require.Len(t, oidcMgr.pendingAuths, 0)
  378. require.Len(t, oidcMgr.tokens, 1)
  379. // admin profile is not available
  380. var tokenCookie string
  381. for k := range oidcMgr.tokens {
  382. tokenCookie = k
  383. }
  384. oidcToken, err := oidcMgr.getToken(tokenCookie)
  385. assert.NoError(t, err)
  386. assert.Equal(t, "sid123", oidcToken.SessionID)
  387. assert.True(t, oidcToken.isAdmin())
  388. assert.False(t, oidcToken.isExpired())
  389. rr = httptest.NewRecorder()
  390. r, err = http.NewRequest(http.MethodGet, webAdminProfilePath, nil)
  391. assert.NoError(t, err)
  392. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  393. server.router.ServeHTTP(rr, r)
  394. assert.Equal(t, http.StatusForbidden, rr.Code)
  395. // the admin can access the allowed pages
  396. rr = httptest.NewRecorder()
  397. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  398. assert.NoError(t, err)
  399. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  400. server.router.ServeHTTP(rr, r)
  401. assert.Equal(t, http.StatusOK, rr.Code)
  402. // try with an invalid cookie
  403. rr = httptest.NewRecorder()
  404. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  405. assert.NoError(t, err)
  406. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, xid.New().String()))
  407. server.router.ServeHTTP(rr, r)
  408. assert.Equal(t, http.StatusFound, rr.Code)
  409. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  410. // Web Client is not available with an admin token
  411. rr = httptest.NewRecorder()
  412. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  413. assert.NoError(t, err)
  414. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  415. server.router.ServeHTTP(rr, r)
  416. assert.Equal(t, http.StatusFound, rr.Code)
  417. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  418. // logout the admin user
  419. rr = httptest.NewRecorder()
  420. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  421. assert.NoError(t, err)
  422. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  423. server.router.ServeHTTP(rr, r)
  424. assert.Equal(t, http.StatusFound, rr.Code)
  425. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  426. require.Len(t, oidcMgr.pendingAuths, 0)
  427. require.Len(t, oidcMgr.tokens, 0)
  428. // now login and logout a user
  429. username := "test_oidc_user"
  430. user := dataprovider.User{
  431. BaseUser: sdk.BaseUser{
  432. Username: username,
  433. Password: "pwd",
  434. HomeDir: filepath.Join(os.TempDir(), username),
  435. Status: 1,
  436. Permissions: map[string][]string{
  437. "/": {dataprovider.PermAny},
  438. },
  439. },
  440. Filters: dataprovider.UserFilters{
  441. BaseUserFilters: sdk.BaseUserFilters{
  442. WebClient: []string{sdk.WebClientSharesDisabled},
  443. },
  444. },
  445. }
  446. err = dataprovider.AddUser(&user, "", "", "")
  447. assert.NoError(t, err)
  448. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  449. oidcMgr.addPendingAuth(authReq)
  450. idToken = &oidc.IDToken{
  451. Nonce: authReq.Nonce,
  452. Expiry: time.Now().Add(5 * time.Minute),
  453. }
  454. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test_oidc_user"}`))
  455. server.binding.OIDC.verifier = &mockOIDCVerifier{
  456. err: nil,
  457. token: idToken,
  458. }
  459. rr = httptest.NewRecorder()
  460. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  461. assert.NoError(t, err)
  462. server.router.ServeHTTP(rr, r)
  463. assert.Equal(t, http.StatusFound, rr.Code)
  464. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  465. require.Len(t, oidcMgr.pendingAuths, 0)
  466. require.Len(t, oidcMgr.tokens, 1)
  467. // user profile is not available
  468. for k := range oidcMgr.tokens {
  469. tokenCookie = k
  470. }
  471. oidcToken, err = oidcMgr.getToken(tokenCookie)
  472. assert.NoError(t, err)
  473. assert.Empty(t, oidcToken.SessionID)
  474. assert.False(t, oidcToken.isAdmin())
  475. assert.False(t, oidcToken.isExpired())
  476. if assert.Len(t, oidcToken.Permissions, 1) {
  477. assert.Equal(t, sdk.WebClientSharesDisabled, oidcToken.Permissions[0])
  478. }
  479. rr = httptest.NewRecorder()
  480. r, err = http.NewRequest(http.MethodGet, webClientProfilePath, nil)
  481. assert.NoError(t, err)
  482. r.RequestURI = webClientProfilePath
  483. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  484. server.router.ServeHTTP(rr, r)
  485. assert.Equal(t, http.StatusOK, rr.Code)
  486. // the user can access the allowed pages
  487. rr = httptest.NewRecorder()
  488. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  489. assert.NoError(t, err)
  490. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  491. server.router.ServeHTTP(rr, r)
  492. assert.Equal(t, http.StatusOK, rr.Code)
  493. // try with an invalid cookie
  494. rr = httptest.NewRecorder()
  495. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  496. assert.NoError(t, err)
  497. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, xid.New().String()))
  498. server.router.ServeHTTP(rr, r)
  499. assert.Equal(t, http.StatusFound, rr.Code)
  500. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  501. // Web Admin is not available with a client cookie
  502. rr = httptest.NewRecorder()
  503. r, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  504. assert.NoError(t, err)
  505. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  506. server.router.ServeHTTP(rr, r)
  507. assert.Equal(t, http.StatusFound, rr.Code)
  508. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  509. // logout the user
  510. rr = httptest.NewRecorder()
  511. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  512. assert.NoError(t, err)
  513. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  514. server.router.ServeHTTP(rr, r)
  515. assert.Equal(t, http.StatusFound, rr.Code)
  516. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  517. require.Len(t, oidcMgr.pendingAuths, 0)
  518. require.Len(t, oidcMgr.tokens, 0)
  519. err = os.RemoveAll(user.GetHomeDir())
  520. assert.NoError(t, err)
  521. err = dataprovider.DeleteUser(username, "", "", "")
  522. assert.NoError(t, err)
  523. }
  524. func TestOIDCRefreshToken(t *testing.T) {
  525. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  526. require.True(t, ok)
  527. r, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  528. assert.NoError(t, err)
  529. token := oidcToken{
  530. Cookie: xid.New().String(),
  531. AccessToken: xid.New().String(),
  532. TokenType: "Bearer",
  533. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-1 * time.Minute)),
  534. Nonce: xid.New().String(),
  535. Role: adminRoleFieldValue,
  536. Username: defaultAdminUsername,
  537. }
  538. config := mockOAuth2Config{
  539. tokenSource: &mockTokenSource{
  540. err: common.ErrGenericFailure,
  541. },
  542. }
  543. verifier := mockOIDCVerifier{
  544. err: common.ErrGenericFailure,
  545. }
  546. err = token.refresh(context.Background(), &config, &verifier, r)
  547. if assert.Error(t, err) {
  548. assert.Contains(t, err.Error(), "refresh token not set")
  549. }
  550. token.RefreshToken = xid.New().String()
  551. err = token.refresh(context.Background(), &config, &verifier, r)
  552. assert.ErrorIs(t, err, common.ErrGenericFailure)
  553. newToken := &oauth2.Token{
  554. AccessToken: xid.New().String(),
  555. RefreshToken: xid.New().String(),
  556. Expiry: time.Now().Add(5 * time.Minute),
  557. }
  558. config = mockOAuth2Config{
  559. tokenSource: &mockTokenSource{
  560. token: newToken,
  561. },
  562. }
  563. verifier = mockOIDCVerifier{
  564. token: &oidc.IDToken{},
  565. }
  566. err = token.refresh(context.Background(), &config, &verifier, r)
  567. if assert.Error(t, err) {
  568. assert.Contains(t, err.Error(), "the refreshed token has no id token")
  569. }
  570. newToken = newToken.WithExtra(map[string]any{
  571. "id_token": "id_token_val",
  572. })
  573. newToken.Expiry = time.Time{}
  574. config = mockOAuth2Config{
  575. tokenSource: &mockTokenSource{
  576. token: newToken,
  577. },
  578. }
  579. verifier = mockOIDCVerifier{
  580. err: common.ErrGenericFailure,
  581. }
  582. err = token.refresh(context.Background(), &config, &verifier, r)
  583. assert.ErrorIs(t, err, common.ErrGenericFailure)
  584. newToken = newToken.WithExtra(map[string]any{
  585. "id_token": "id_token_val",
  586. })
  587. newToken.Expiry = time.Now().Add(5 * time.Minute)
  588. config = mockOAuth2Config{
  589. tokenSource: &mockTokenSource{
  590. token: newToken,
  591. },
  592. }
  593. verifier = mockOIDCVerifier{
  594. token: &oidc.IDToken{},
  595. }
  596. err = token.refresh(context.Background(), &config, &verifier, r)
  597. if assert.Error(t, err) {
  598. assert.Contains(t, err.Error(), "the refreshed token nonce mismatch")
  599. }
  600. verifier = mockOIDCVerifier{
  601. token: &oidc.IDToken{
  602. Nonce: token.Nonce,
  603. },
  604. }
  605. err = token.refresh(context.Background(), &config, &verifier, r)
  606. if assert.Error(t, err) {
  607. assert.Contains(t, err.Error(), "oidc: claims not set")
  608. }
  609. idToken := &oidc.IDToken{
  610. Nonce: token.Nonce,
  611. }
  612. setIDTokenClaims(idToken, []byte(`{"sid":"id_token_sid"}`))
  613. verifier = mockOIDCVerifier{
  614. token: idToken,
  615. }
  616. err = token.refresh(context.Background(), &config, &verifier, r)
  617. assert.NoError(t, err)
  618. assert.Len(t, token.Permissions, 1)
  619. token.Role = nil
  620. // user does not exist
  621. err = token.refresh(context.Background(), &config, &verifier, r)
  622. assert.Error(t, err)
  623. require.Len(t, oidcMgr.tokens, 1)
  624. oidcMgr.removeToken(token.Cookie)
  625. require.Len(t, oidcMgr.tokens, 0)
  626. }
  627. func TestOIDCRefreshUser(t *testing.T) {
  628. token := oidcToken{
  629. Cookie: xid.New().String(),
  630. AccessToken: xid.New().String(),
  631. TokenType: "Bearer",
  632. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(1 * time.Minute)),
  633. Nonce: xid.New().String(),
  634. Role: adminRoleFieldValue,
  635. Username: "missing username",
  636. }
  637. r, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  638. assert.NoError(t, err)
  639. err = token.refreshUser(r)
  640. assert.Error(t, err)
  641. admin := dataprovider.Admin{
  642. Username: "test_oidc_admin_refresh",
  643. Password: "p",
  644. Permissions: []string{dataprovider.PermAdminAny},
  645. Status: 0,
  646. Filters: dataprovider.AdminFilters{
  647. Preferences: dataprovider.AdminPreferences{
  648. HideUserPageSections: 1 + 2 + 4,
  649. },
  650. },
  651. }
  652. err = dataprovider.AddAdmin(&admin, "", "", "")
  653. assert.NoError(t, err)
  654. token.Username = admin.Username
  655. err = token.refreshUser(r)
  656. if assert.Error(t, err) {
  657. assert.Contains(t, err.Error(), "is disabled")
  658. }
  659. admin.Status = 1
  660. err = dataprovider.UpdateAdmin(&admin, "", "", "")
  661. assert.NoError(t, err)
  662. err = token.refreshUser(r)
  663. assert.NoError(t, err)
  664. assert.Equal(t, admin.Permissions, token.Permissions)
  665. assert.Equal(t, admin.Filters.Preferences.HideUserPageSections, token.HideUserPageSections)
  666. err = dataprovider.DeleteAdmin(admin.Username, "", "", "")
  667. assert.NoError(t, err)
  668. username := "test_oidc_user_refresh_token"
  669. user := dataprovider.User{
  670. BaseUser: sdk.BaseUser{
  671. Username: username,
  672. Password: "p",
  673. HomeDir: filepath.Join(os.TempDir(), username),
  674. Status: 0,
  675. Permissions: map[string][]string{
  676. "/": {dataprovider.PermAny},
  677. },
  678. },
  679. Filters: dataprovider.UserFilters{
  680. BaseUserFilters: sdk.BaseUserFilters{
  681. DeniedProtocols: []string{common.ProtocolHTTP},
  682. WebClient: []string{sdk.WebClientSharesDisabled, sdk.WebClientWriteDisabled},
  683. },
  684. },
  685. }
  686. err = dataprovider.AddUser(&user, "", "", "")
  687. assert.NoError(t, err)
  688. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  689. assert.NoError(t, err)
  690. token.Role = nil
  691. token.Username = username
  692. assert.False(t, token.isAdmin())
  693. err = token.refreshUser(r)
  694. if assert.Error(t, err) {
  695. assert.Contains(t, err.Error(), "is disabled")
  696. }
  697. user, err = dataprovider.UserExists(username, "")
  698. assert.NoError(t, err)
  699. user.Status = 1
  700. err = dataprovider.UpdateUser(&user, "", "", "")
  701. assert.NoError(t, err)
  702. err = token.refreshUser(r)
  703. if assert.Error(t, err) {
  704. assert.Contains(t, err.Error(), "protocol HTTP is not allowed")
  705. }
  706. user.Filters.DeniedProtocols = []string{common.ProtocolFTP}
  707. err = dataprovider.UpdateUser(&user, "", "", "")
  708. assert.NoError(t, err)
  709. err = token.refreshUser(r)
  710. assert.NoError(t, err)
  711. assert.Equal(t, user.Filters.WebClient, token.Permissions)
  712. err = dataprovider.DeleteUser(username, "", "", "")
  713. assert.NoError(t, err)
  714. }
  715. func TestValidateOIDCToken(t *testing.T) {
  716. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  717. require.True(t, ok)
  718. server := getTestOIDCServer()
  719. err := server.binding.OIDC.initialize()
  720. assert.NoError(t, err)
  721. server.initializeRouter()
  722. rr := httptest.NewRecorder()
  723. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  724. assert.NoError(t, err)
  725. _, err = server.validateOIDCToken(rr, r, false)
  726. assert.ErrorIs(t, err, errInvalidToken)
  727. // expired token and refresh error
  728. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  729. tokenSource: &mockTokenSource{
  730. err: common.ErrGenericFailure,
  731. },
  732. }
  733. token := oidcToken{
  734. Cookie: xid.New().String(),
  735. AccessToken: xid.New().String(),
  736. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  737. }
  738. oidcMgr.addToken(token)
  739. rr = httptest.NewRecorder()
  740. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  741. assert.NoError(t, err)
  742. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  743. _, err = server.validateOIDCToken(rr, r, false)
  744. assert.ErrorIs(t, err, errInvalidToken)
  745. oidcMgr.removeToken(token.Cookie)
  746. assert.Len(t, oidcMgr.tokens, 0)
  747. server.tokenAuth = jwtauth.New("PS256", util.GenerateRandomBytes(32), nil)
  748. token = oidcToken{
  749. Cookie: xid.New().String(),
  750. AccessToken: xid.New().String(),
  751. }
  752. oidcMgr.addToken(token)
  753. rr = httptest.NewRecorder()
  754. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  755. assert.NoError(t, err)
  756. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  757. server.router.ServeHTTP(rr, r)
  758. assert.Equal(t, http.StatusFound, rr.Code)
  759. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  760. oidcMgr.removeToken(token.Cookie)
  761. assert.Len(t, oidcMgr.tokens, 0)
  762. token = oidcToken{
  763. Cookie: xid.New().String(),
  764. AccessToken: xid.New().String(),
  765. Role: "admin",
  766. }
  767. oidcMgr.addToken(token)
  768. rr = httptest.NewRecorder()
  769. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  770. assert.NoError(t, err)
  771. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, token.Cookie))
  772. server.router.ServeHTTP(rr, r)
  773. assert.Equal(t, http.StatusFound, rr.Code)
  774. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  775. oidcMgr.removeToken(token.Cookie)
  776. assert.Len(t, oidcMgr.tokens, 0)
  777. }
  778. func TestSkipOIDCAuth(t *testing.T) {
  779. server := getTestOIDCServer()
  780. err := server.binding.OIDC.initialize()
  781. assert.NoError(t, err)
  782. server.initializeRouter()
  783. jwtTokenClaims := jwtTokenClaims{
  784. Username: "user",
  785. }
  786. _, tokenString, err := jwtTokenClaims.createToken(server.tokenAuth, tokenAudienceWebClient, "")
  787. assert.NoError(t, err)
  788. rr := httptest.NewRecorder()
  789. r, err := http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  790. assert.NoError(t, err)
  791. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", jwtCookieKey, tokenString))
  792. server.router.ServeHTTP(rr, r)
  793. assert.Equal(t, http.StatusFound, rr.Code)
  794. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  795. }
  796. func TestOIDCLogoutErrors(t *testing.T) {
  797. server := getTestOIDCServer()
  798. assert.Empty(t, server.binding.OIDC.providerLogoutURL)
  799. server.logoutFromOIDCOP("")
  800. server.binding.OIDC.providerLogoutURL = "http://foo\x7f.com/"
  801. server.doOIDCFromLogout("")
  802. server.binding.OIDC.providerLogoutURL = "http://127.0.0.1:11234"
  803. server.doOIDCFromLogout("")
  804. }
  805. func TestOIDCToken(t *testing.T) {
  806. admin := dataprovider.Admin{
  807. Username: "test_oidc_admin",
  808. Password: "p",
  809. Permissions: []string{dataprovider.PermAdminAny},
  810. Status: 0,
  811. }
  812. err := dataprovider.AddAdmin(&admin, "", "", "")
  813. assert.NoError(t, err)
  814. token := oidcToken{
  815. Username: admin.Username,
  816. }
  817. // role not initialized, user with the specified username does not exist
  818. req, err := http.NewRequest(http.MethodGet, webUsersPath, nil)
  819. assert.NoError(t, err)
  820. err = token.getUser(req)
  821. assert.ErrorIs(t, err, util.ErrNotFound)
  822. token.Role = "admin"
  823. req, err = http.NewRequest(http.MethodGet, webUsersPath, nil)
  824. assert.NoError(t, err)
  825. err = token.getUser(req)
  826. if assert.Error(t, err) {
  827. assert.Contains(t, err.Error(), "is disabled")
  828. }
  829. err = dataprovider.DeleteAdmin(admin.Username, "", "", "")
  830. assert.NoError(t, err)
  831. username := "test_oidc_user"
  832. token.Username = username
  833. token.Role = ""
  834. err = token.getUser(req)
  835. if assert.Error(t, err) {
  836. assert.ErrorIs(t, err, util.ErrNotFound)
  837. }
  838. user := dataprovider.User{
  839. BaseUser: sdk.BaseUser{
  840. Username: username,
  841. Password: "p",
  842. HomeDir: filepath.Join(os.TempDir(), username),
  843. Status: 0,
  844. Permissions: map[string][]string{
  845. "/": {dataprovider.PermAny},
  846. },
  847. },
  848. Filters: dataprovider.UserFilters{
  849. BaseUserFilters: sdk.BaseUserFilters{
  850. DeniedProtocols: []string{common.ProtocolHTTP},
  851. },
  852. },
  853. }
  854. err = dataprovider.AddUser(&user, "", "", "")
  855. assert.NoError(t, err)
  856. err = token.getUser(req)
  857. if assert.Error(t, err) {
  858. assert.Contains(t, err.Error(), "is disabled")
  859. }
  860. user, err = dataprovider.UserExists(username, "")
  861. assert.NoError(t, err)
  862. user.Status = 1
  863. user.Password = "np"
  864. err = dataprovider.UpdateUser(&user, "", "", "")
  865. assert.NoError(t, err)
  866. err = token.getUser(req)
  867. if assert.Error(t, err) {
  868. assert.Contains(t, err.Error(), "protocol HTTP is not allowed")
  869. }
  870. user.Filters.DeniedProtocols = nil
  871. user.FsConfig.Provider = sdk.SFTPFilesystemProvider
  872. user.FsConfig.SFTPConfig = vfs.SFTPFsConfig{
  873. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  874. Endpoint: "127.0.0.1:8022",
  875. Username: username,
  876. },
  877. Password: kms.NewPlainSecret("np"),
  878. }
  879. err = dataprovider.UpdateUser(&user, "", "", "")
  880. assert.NoError(t, err)
  881. err = token.getUser(req)
  882. if assert.Error(t, err) {
  883. assert.Contains(t, err.Error(), "SFTP loop")
  884. }
  885. common.Config.PostConnectHook = fmt.Sprintf("http://%v/404", oidcMockAddr)
  886. err = token.getUser(req)
  887. if assert.Error(t, err) {
  888. assert.Contains(t, err.Error(), "access denied")
  889. }
  890. common.Config.PostConnectHook = ""
  891. err = os.RemoveAll(user.GetHomeDir())
  892. assert.NoError(t, err)
  893. err = dataprovider.DeleteUser(username, "", "", "")
  894. assert.NoError(t, err)
  895. }
  896. func TestOIDCImplicitRoles(t *testing.T) {
  897. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  898. require.True(t, ok)
  899. server := getTestOIDCServer()
  900. server.binding.OIDC.ImplicitRoles = true
  901. err := server.binding.OIDC.initialize()
  902. assert.NoError(t, err)
  903. server.initializeRouter()
  904. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  905. oidcMgr.addPendingAuth(authReq)
  906. token := &oauth2.Token{
  907. AccessToken: "1234",
  908. Expiry: time.Now().Add(5 * time.Minute),
  909. }
  910. token = token.WithExtra(map[string]any{
  911. "id_token": "id_token_val",
  912. })
  913. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  914. tokenSource: &mockTokenSource{},
  915. authCodeURL: webOIDCRedirectPath,
  916. token: token,
  917. }
  918. idToken := &oidc.IDToken{
  919. Nonce: authReq.Nonce,
  920. Expiry: time.Now().Add(5 * time.Minute),
  921. }
  922. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  923. server.binding.OIDC.verifier = &mockOIDCVerifier{
  924. err: nil,
  925. token: idToken,
  926. }
  927. rr := httptest.NewRecorder()
  928. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  929. assert.NoError(t, err)
  930. server.router.ServeHTTP(rr, r)
  931. assert.Equal(t, http.StatusFound, rr.Code)
  932. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  933. require.Len(t, oidcMgr.pendingAuths, 0)
  934. require.Len(t, oidcMgr.tokens, 1)
  935. var tokenCookie string
  936. for k := range oidcMgr.tokens {
  937. tokenCookie = k
  938. }
  939. // Web Client is not available with an admin token
  940. rr = httptest.NewRecorder()
  941. r, err = http.NewRequest(http.MethodGet, webClientFilesPath, nil)
  942. assert.NoError(t, err)
  943. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  944. server.router.ServeHTTP(rr, r)
  945. assert.Equal(t, http.StatusFound, rr.Code)
  946. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  947. // logout the admin user
  948. rr = httptest.NewRecorder()
  949. r, err = http.NewRequest(http.MethodGet, webLogoutPath, nil)
  950. assert.NoError(t, err)
  951. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  952. server.router.ServeHTTP(rr, r)
  953. assert.Equal(t, http.StatusFound, rr.Code)
  954. assert.Equal(t, webAdminLoginPath, rr.Header().Get("Location"))
  955. require.Len(t, oidcMgr.pendingAuths, 0)
  956. require.Len(t, oidcMgr.tokens, 0)
  957. // now login and logout a user
  958. username := "test_oidc_implicit_user"
  959. user := dataprovider.User{
  960. BaseUser: sdk.BaseUser{
  961. Username: username,
  962. Password: "pwd",
  963. HomeDir: filepath.Join(os.TempDir(), username),
  964. Status: 1,
  965. Permissions: map[string][]string{
  966. "/": {dataprovider.PermAny},
  967. },
  968. },
  969. Filters: dataprovider.UserFilters{
  970. BaseUserFilters: sdk.BaseUserFilters{
  971. WebClient: []string{sdk.WebClientSharesDisabled},
  972. },
  973. },
  974. }
  975. err = dataprovider.AddUser(&user, "", "", "")
  976. assert.NoError(t, err)
  977. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  978. oidcMgr.addPendingAuth(authReq)
  979. idToken = &oidc.IDToken{
  980. Nonce: authReq.Nonce,
  981. Expiry: time.Now().Add(5 * time.Minute),
  982. }
  983. setIDTokenClaims(idToken, []byte(`{"preferred_username":"test_oidc_implicit_user"}`))
  984. server.binding.OIDC.verifier = &mockOIDCVerifier{
  985. err: nil,
  986. token: idToken,
  987. }
  988. rr = httptest.NewRecorder()
  989. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  990. assert.NoError(t, err)
  991. server.router.ServeHTTP(rr, r)
  992. assert.Equal(t, http.StatusFound, rr.Code)
  993. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  994. require.Len(t, oidcMgr.pendingAuths, 0)
  995. require.Len(t, oidcMgr.tokens, 1)
  996. for k := range oidcMgr.tokens {
  997. tokenCookie = k
  998. }
  999. rr = httptest.NewRecorder()
  1000. r, err = http.NewRequest(http.MethodGet, webClientLogoutPath, nil)
  1001. assert.NoError(t, err)
  1002. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  1003. server.router.ServeHTTP(rr, r)
  1004. assert.Equal(t, http.StatusFound, rr.Code)
  1005. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  1006. require.Len(t, oidcMgr.pendingAuths, 0)
  1007. require.Len(t, oidcMgr.tokens, 0)
  1008. err = os.RemoveAll(user.GetHomeDir())
  1009. assert.NoError(t, err)
  1010. err = dataprovider.DeleteUser(username, "", "", "")
  1011. assert.NoError(t, err)
  1012. }
  1013. func TestMemoryOIDCManager(t *testing.T) {
  1014. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1015. require.True(t, ok)
  1016. require.Len(t, oidcMgr.pendingAuths, 0)
  1017. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1018. oidcMgr.addPendingAuth(authReq)
  1019. require.Len(t, oidcMgr.pendingAuths, 1)
  1020. _, err := oidcMgr.getPendingAuth(authReq.State)
  1021. assert.NoError(t, err)
  1022. oidcMgr.removePendingAuth(authReq.State)
  1023. require.Len(t, oidcMgr.pendingAuths, 0)
  1024. authReq.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-61 * time.Second))
  1025. oidcMgr.addPendingAuth(authReq)
  1026. require.Len(t, oidcMgr.pendingAuths, 1)
  1027. _, err = oidcMgr.getPendingAuth(authReq.State)
  1028. if assert.Error(t, err) {
  1029. assert.Contains(t, err.Error(), "too old")
  1030. }
  1031. oidcMgr.cleanup()
  1032. require.Len(t, oidcMgr.pendingAuths, 0)
  1033. token := oidcToken{
  1034. AccessToken: xid.New().String(),
  1035. Nonce: xid.New().String(),
  1036. SessionID: xid.New().String(),
  1037. Cookie: xid.New().String(),
  1038. Username: xid.New().String(),
  1039. Role: "admin",
  1040. Permissions: []string{dataprovider.PermAdminAny},
  1041. }
  1042. require.Len(t, oidcMgr.tokens, 0)
  1043. oidcMgr.addToken(token)
  1044. require.Len(t, oidcMgr.tokens, 1)
  1045. _, err = oidcMgr.getToken(xid.New().String())
  1046. assert.Error(t, err)
  1047. storedToken, err := oidcMgr.getToken(token.Cookie)
  1048. assert.NoError(t, err)
  1049. token.UsedAt = 0 // ensure we don't modify the stored token
  1050. assert.Greater(t, storedToken.UsedAt, int64(0))
  1051. token.UsedAt = storedToken.UsedAt
  1052. assert.Equal(t, token, storedToken)
  1053. // the usage will not be updated, it is recent
  1054. oidcMgr.updateTokenUsage(storedToken)
  1055. storedToken, err = oidcMgr.getToken(token.Cookie)
  1056. assert.NoError(t, err)
  1057. assert.Equal(t, token, storedToken)
  1058. usedAt := util.GetTimeAsMsSinceEpoch(time.Now().Add(-5 * time.Minute))
  1059. storedToken.UsedAt = usedAt
  1060. oidcMgr.tokens[token.Cookie] = storedToken
  1061. storedToken, err = oidcMgr.getToken(token.Cookie)
  1062. assert.NoError(t, err)
  1063. assert.Equal(t, usedAt, storedToken.UsedAt)
  1064. token.UsedAt = storedToken.UsedAt
  1065. assert.Equal(t, token, storedToken)
  1066. oidcMgr.updateTokenUsage(storedToken)
  1067. storedToken, err = oidcMgr.getToken(token.Cookie)
  1068. assert.NoError(t, err)
  1069. assert.Greater(t, storedToken.UsedAt, usedAt)
  1070. token.UsedAt = storedToken.UsedAt
  1071. assert.Equal(t, token, storedToken)
  1072. storedToken.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now()) - tokenDeleteInterval - 1
  1073. oidcMgr.tokens[token.Cookie] = storedToken
  1074. storedToken, err = oidcMgr.getToken(token.Cookie)
  1075. if assert.Error(t, err) {
  1076. assert.Contains(t, err.Error(), "token is too old")
  1077. }
  1078. oidcMgr.removeToken(xid.New().String())
  1079. require.Len(t, oidcMgr.tokens, 1)
  1080. oidcMgr.removeToken(token.Cookie)
  1081. require.Len(t, oidcMgr.tokens, 0)
  1082. oidcMgr.addToken(token)
  1083. usedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-6 * time.Hour))
  1084. token.UsedAt = usedAt
  1085. oidcMgr.tokens[token.Cookie] = token
  1086. newToken := oidcToken{
  1087. Cookie: xid.New().String(),
  1088. }
  1089. oidcMgr.addToken(newToken)
  1090. oidcMgr.cleanup()
  1091. require.Len(t, oidcMgr.tokens, 1)
  1092. _, err = oidcMgr.getToken(token.Cookie)
  1093. assert.Error(t, err)
  1094. _, err = oidcMgr.getToken(newToken.Cookie)
  1095. assert.NoError(t, err)
  1096. oidcMgr.removeToken(newToken.Cookie)
  1097. require.Len(t, oidcMgr.tokens, 0)
  1098. }
  1099. func TestOIDCEvMgrIntegration(t *testing.T) {
  1100. providerConf := dataprovider.GetProviderConfig()
  1101. err := dataprovider.Close()
  1102. assert.NoError(t, err)
  1103. newProviderConf := providerConf
  1104. newProviderConf.NamingRules = 5
  1105. err = dataprovider.Initialize(newProviderConf, configDir, true)
  1106. assert.NoError(t, err)
  1107. // add a special chars to check json replacer
  1108. username := `test_"oidc_eventmanager`
  1109. u := map[string]any{
  1110. "username": "{{Name}}",
  1111. "status": 1,
  1112. "home_dir": filepath.Join(os.TempDir(), "{{IDPFieldcustom1.sub}}"),
  1113. "permissions": map[string][]string{
  1114. "/": {dataprovider.PermAny},
  1115. },
  1116. "description": "{{IDPFieldcustom2}}",
  1117. }
  1118. userTmpl, err := json.Marshal(u)
  1119. require.NoError(t, err)
  1120. a := map[string]any{
  1121. "username": "{{Name}}",
  1122. "status": 1,
  1123. "permissions": []string{dataprovider.PermAdminAny},
  1124. }
  1125. adminTmpl, err := json.Marshal(a)
  1126. require.NoError(t, err)
  1127. action := &dataprovider.BaseEventAction{
  1128. Name: "a",
  1129. Type: dataprovider.ActionTypeIDPAccountCheck,
  1130. Options: dataprovider.BaseEventActionOptions{
  1131. IDPConfig: dataprovider.EventActionIDPAccountCheck{
  1132. Mode: 0,
  1133. TemplateUser: string(userTmpl),
  1134. TemplateAdmin: string(adminTmpl),
  1135. },
  1136. },
  1137. }
  1138. err = dataprovider.AddEventAction(action, "", "", "")
  1139. assert.NoError(t, err)
  1140. rule := &dataprovider.EventRule{
  1141. Name: "r",
  1142. Status: 1,
  1143. Trigger: dataprovider.EventTriggerIDPLogin,
  1144. Conditions: dataprovider.EventConditions{
  1145. IDPLoginEvent: 0,
  1146. },
  1147. Actions: []dataprovider.EventAction{
  1148. {
  1149. BaseEventAction: dataprovider.BaseEventAction{
  1150. Name: action.Name,
  1151. },
  1152. Options: dataprovider.EventActionOptions{
  1153. ExecuteSync: true,
  1154. },
  1155. },
  1156. },
  1157. }
  1158. err = dataprovider.AddEventRule(rule, "", "", "")
  1159. assert.NoError(t, err)
  1160. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1161. require.True(t, ok)
  1162. server := getTestOIDCServer()
  1163. server.binding.OIDC.ImplicitRoles = true
  1164. server.binding.OIDC.CustomFields = []string{"custom1.sub", "custom2"}
  1165. err = server.binding.OIDC.initialize()
  1166. assert.NoError(t, err)
  1167. server.initializeRouter()
  1168. // login a user with OIDC
  1169. _, err = dataprovider.UserExists(username, "")
  1170. assert.ErrorIs(t, err, util.ErrNotFound)
  1171. authReq := newOIDCPendingAuth(tokenAudienceWebClient)
  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":"`+util.JSONEscape(username)+`","custom1":{"sub":"val1"},"custom2":"desc"}`))
  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, webClientFilesPath, rr.Header().Get("Location"))
  1200. user, err := dataprovider.UserExists(username, "")
  1201. assert.NoError(t, err)
  1202. assert.Equal(t, filepath.Join(os.TempDir(), "val1"), user.GetHomeDir())
  1203. assert.Equal(t, "desc", user.Description)
  1204. err = dataprovider.DeleteUser(username, "", "", "")
  1205. assert.NoError(t, err)
  1206. err = os.RemoveAll(user.GetHomeDir())
  1207. assert.NoError(t, err)
  1208. // login an admin with OIDC
  1209. _, err = dataprovider.AdminExists(username)
  1210. assert.ErrorIs(t, err, util.ErrNotFound)
  1211. authReq = newOIDCPendingAuth(tokenAudienceWebAdmin)
  1212. oidcMgr.addPendingAuth(authReq)
  1213. idToken = &oidc.IDToken{
  1214. Nonce: authReq.Nonce,
  1215. Expiry: time.Now().Add(5 * time.Minute),
  1216. }
  1217. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+util.JSONEscape(username)+`"}`))
  1218. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1219. err: nil,
  1220. token: idToken,
  1221. }
  1222. rr = httptest.NewRecorder()
  1223. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1224. assert.NoError(t, err)
  1225. server.router.ServeHTTP(rr, r)
  1226. assert.Equal(t, http.StatusFound, rr.Code)
  1227. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  1228. _, err = dataprovider.AdminExists(username)
  1229. assert.NoError(t, err)
  1230. err = dataprovider.DeleteAdmin(username, "", "", "")
  1231. assert.NoError(t, err)
  1232. // set invalid templates and try again
  1233. action.Options.IDPConfig.TemplateUser = `{}`
  1234. action.Options.IDPConfig.TemplateAdmin = `{}`
  1235. err = dataprovider.UpdateEventAction(action, "", "", "")
  1236. assert.NoError(t, err)
  1237. for _, audience := range []string{tokenAudienceWebAdmin, tokenAudienceWebClient} {
  1238. authReq = newOIDCPendingAuth(audience)
  1239. oidcMgr.addPendingAuth(authReq)
  1240. idToken = &oidc.IDToken{
  1241. Nonce: authReq.Nonce,
  1242. Expiry: time.Now().Add(5 * time.Minute),
  1243. }
  1244. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+util.JSONEscape(username)+`"}`))
  1245. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1246. err: nil,
  1247. token: idToken,
  1248. }
  1249. rr = httptest.NewRecorder()
  1250. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1251. assert.NoError(t, err)
  1252. server.router.ServeHTTP(rr, r)
  1253. assert.Equal(t, http.StatusFound, rr.Code)
  1254. }
  1255. for k := range oidcMgr.tokens {
  1256. oidcMgr.removeToken(k)
  1257. }
  1258. err = dataprovider.DeleteEventRule(rule.Name, "", "", "")
  1259. assert.NoError(t, err)
  1260. err = dataprovider.DeleteEventAction(action.Name, "", "", "")
  1261. assert.NoError(t, err)
  1262. err = dataprovider.Close()
  1263. assert.NoError(t, err)
  1264. err = dataprovider.Initialize(providerConf, configDir, true)
  1265. assert.NoError(t, err)
  1266. }
  1267. func TestOIDCPreLoginHook(t *testing.T) {
  1268. if runtime.GOOS == osWindows {
  1269. t.Skip("this test is not available on Windows")
  1270. }
  1271. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1272. require.True(t, ok)
  1273. username := "test_oidc_user_prelogin"
  1274. u := dataprovider.User{
  1275. BaseUser: sdk.BaseUser{
  1276. Username: username,
  1277. HomeDir: filepath.Join(os.TempDir(), username),
  1278. Status: 1,
  1279. Permissions: map[string][]string{
  1280. "/": {dataprovider.PermAny},
  1281. },
  1282. },
  1283. }
  1284. preLoginPath := filepath.Join(os.TempDir(), "prelogin.sh")
  1285. providerConf := dataprovider.GetProviderConfig()
  1286. err := dataprovider.Close()
  1287. assert.NoError(t, err)
  1288. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, false), os.ModePerm)
  1289. assert.NoError(t, err)
  1290. newProviderConf := providerConf
  1291. newProviderConf.PreLoginHook = preLoginPath
  1292. err = dataprovider.Initialize(newProviderConf, configDir, true)
  1293. assert.NoError(t, err)
  1294. server := getTestOIDCServer()
  1295. server.binding.OIDC.CustomFields = []string{"field1", "field2"}
  1296. err = server.binding.OIDC.initialize()
  1297. assert.NoError(t, err)
  1298. server.initializeRouter()
  1299. _, err = dataprovider.UserExists(username, "")
  1300. assert.ErrorIs(t, err, util.ErrNotFound)
  1301. // now login with OIDC
  1302. authReq := newOIDCPendingAuth(tokenAudienceWebClient)
  1303. oidcMgr.addPendingAuth(authReq)
  1304. token := &oauth2.Token{
  1305. AccessToken: "1234",
  1306. Expiry: time.Now().Add(5 * time.Minute),
  1307. }
  1308. token = token.WithExtra(map[string]any{
  1309. "id_token": "id_token_val",
  1310. })
  1311. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1312. tokenSource: &mockTokenSource{},
  1313. authCodeURL: webOIDCRedirectPath,
  1314. token: token,
  1315. }
  1316. idToken := &oidc.IDToken{
  1317. Nonce: authReq.Nonce,
  1318. Expiry: time.Now().Add(5 * time.Minute),
  1319. }
  1320. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`"}`))
  1321. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1322. err: nil,
  1323. token: idToken,
  1324. }
  1325. rr := httptest.NewRecorder()
  1326. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1327. assert.NoError(t, err)
  1328. server.router.ServeHTTP(rr, r)
  1329. assert.Equal(t, http.StatusFound, rr.Code)
  1330. assert.Equal(t, webClientFilesPath, rr.Header().Get("Location"))
  1331. _, err = dataprovider.UserExists(username, "")
  1332. assert.NoError(t, err)
  1333. err = dataprovider.DeleteUser(username, "", "", "")
  1334. assert.NoError(t, err)
  1335. err = os.RemoveAll(u.HomeDir)
  1336. assert.NoError(t, err)
  1337. err = os.WriteFile(preLoginPath, getPreLoginScriptContent(u, true), os.ModePerm)
  1338. assert.NoError(t, err)
  1339. authReq = newOIDCPendingAuth(tokenAudienceWebClient)
  1340. oidcMgr.addPendingAuth(authReq)
  1341. idToken = &oidc.IDToken{
  1342. Nonce: authReq.Nonce,
  1343. Expiry: time.Now().Add(5 * time.Minute),
  1344. }
  1345. setIDTokenClaims(idToken, []byte(`{"preferred_username":"`+username+`","field1":"value1","field2":"value2","field3":"value3"}`))
  1346. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1347. err: nil,
  1348. token: idToken,
  1349. }
  1350. rr = httptest.NewRecorder()
  1351. r, err = http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1352. assert.NoError(t, err)
  1353. server.router.ServeHTTP(rr, r)
  1354. assert.Equal(t, http.StatusFound, rr.Code)
  1355. assert.Equal(t, webClientLoginPath, rr.Header().Get("Location"))
  1356. _, err = dataprovider.UserExists(username, "")
  1357. assert.ErrorIs(t, err, util.ErrNotFound)
  1358. if assert.Len(t, oidcMgr.tokens, 1) {
  1359. for k := range oidcMgr.tokens {
  1360. oidcMgr.removeToken(k)
  1361. }
  1362. }
  1363. require.Len(t, oidcMgr.pendingAuths, 0)
  1364. require.Len(t, oidcMgr.tokens, 0)
  1365. err = dataprovider.Close()
  1366. assert.NoError(t, err)
  1367. err = dataprovider.Initialize(providerConf, configDir, true)
  1368. assert.NoError(t, err)
  1369. err = os.Remove(preLoginPath)
  1370. assert.NoError(t, err)
  1371. }
  1372. func TestOIDCIsAdmin(t *testing.T) {
  1373. type test struct {
  1374. input any
  1375. want bool
  1376. }
  1377. emptySlice := make([]any, 0)
  1378. tests := []test{
  1379. {input: "admin", want: true},
  1380. {input: append(emptySlice, "admin"), want: true},
  1381. {input: append(emptySlice, "user", "admin"), want: true},
  1382. {input: "user", want: false},
  1383. {input: emptySlice, want: false},
  1384. {input: append(emptySlice, 1), want: false},
  1385. {input: 1, want: false},
  1386. {input: nil, want: false},
  1387. {input: map[string]string{"admin": "admin"}, want: false},
  1388. }
  1389. for _, tc := range tests {
  1390. token := oidcToken{
  1391. Role: tc.input,
  1392. }
  1393. assert.Equal(t, tc.want, token.isAdmin(), "%v should return %t", tc.input, tc.want)
  1394. }
  1395. }
  1396. func TestParseAdminRole(t *testing.T) {
  1397. claims := make(map[string]any)
  1398. rawClaims := []byte(`{
  1399. "sub": "35666371",
  1400. "email": "[email protected]",
  1401. "preferred_username": "Sally",
  1402. "name": "Sally Tyler",
  1403. "updated_at": "2018-04-13T22:08:45Z",
  1404. "given_name": "Sally",
  1405. "family_name": "Tyler",
  1406. "params": {
  1407. "sftpgo_role": "admin",
  1408. "subparams": {
  1409. "sftpgo_role": "admin",
  1410. "inner": {
  1411. "sftpgo_role": ["user","admin"]
  1412. }
  1413. }
  1414. },
  1415. "at_hash": "lPLhxI2wjEndc-WfyroDZA",
  1416. "rt_hash": "mCmxPtA04N-55AxlEUbq-A",
  1417. "aud": "78d1d040-20c9-0136-5146-067351775fae92920",
  1418. "exp": 1523664997,
  1419. "iat": 1523657797
  1420. }`)
  1421. err := json.Unmarshal(rawClaims, &claims)
  1422. assert.NoError(t, err)
  1423. type test struct {
  1424. input string
  1425. want bool
  1426. val any
  1427. }
  1428. tests := []test{
  1429. {input: "", want: false},
  1430. {input: "sftpgo_role", want: false},
  1431. {input: "params.sftpgo_role", want: true, val: "admin"},
  1432. {input: "params.subparams.sftpgo_role", want: true, val: "admin"},
  1433. {input: "params.subparams.inner.sftpgo_role", want: true, val: []any{"user", "admin"}},
  1434. {input: "email", want: false},
  1435. {input: "missing", want: false},
  1436. {input: "params.email", want: false},
  1437. {input: "missing.sftpgo_role", want: false},
  1438. {input: "params", want: false},
  1439. {input: "params.subparams.inner.sftpgo_role.missing", want: false},
  1440. }
  1441. for _, tc := range tests {
  1442. token := oidcToken{}
  1443. token.getRoleFromField(claims, tc.input)
  1444. assert.Equal(t, tc.want, token.isAdmin(), "%q should return %t", tc.input, tc.want)
  1445. if tc.want {
  1446. assert.Equal(t, tc.val, token.Role)
  1447. }
  1448. }
  1449. }
  1450. func TestOIDCWithLoginFormsDisabled(t *testing.T) {
  1451. oidcMgr, ok := oidcMgr.(*memoryOIDCManager)
  1452. require.True(t, ok)
  1453. server := getTestOIDCServer()
  1454. server.binding.OIDC.ImplicitRoles = true
  1455. server.binding.EnabledLoginMethods = 3
  1456. server.binding.EnableWebAdmin = true
  1457. server.binding.EnableWebClient = true
  1458. err := server.binding.OIDC.initialize()
  1459. assert.NoError(t, err)
  1460. server.initializeRouter()
  1461. // login with an admin user
  1462. authReq := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1463. oidcMgr.addPendingAuth(authReq)
  1464. token := &oauth2.Token{
  1465. AccessToken: "1234",
  1466. Expiry: time.Now().Add(5 * time.Minute),
  1467. }
  1468. token = token.WithExtra(map[string]any{
  1469. "id_token": "id_token_val",
  1470. })
  1471. server.binding.OIDC.oauth2Config = &mockOAuth2Config{
  1472. tokenSource: &mockTokenSource{},
  1473. authCodeURL: webOIDCRedirectPath,
  1474. token: token,
  1475. }
  1476. idToken := &oidc.IDToken{
  1477. Nonce: authReq.Nonce,
  1478. Expiry: time.Now().Add(5 * time.Minute),
  1479. }
  1480. setIDTokenClaims(idToken, []byte(`{"preferred_username":"admin","sid":"sid456"}`))
  1481. server.binding.OIDC.verifier = &mockOIDCVerifier{
  1482. err: nil,
  1483. token: idToken,
  1484. }
  1485. rr := httptest.NewRecorder()
  1486. r, err := http.NewRequest(http.MethodGet, webOIDCRedirectPath+"?state="+authReq.State, nil)
  1487. assert.NoError(t, err)
  1488. server.router.ServeHTTP(rr, r)
  1489. assert.Equal(t, http.StatusFound, rr.Code)
  1490. assert.Equal(t, webUsersPath, rr.Header().Get("Location"))
  1491. var tokenCookie string
  1492. for k := range oidcMgr.tokens {
  1493. tokenCookie = k
  1494. }
  1495. // we should be able to create admins without setting a password
  1496. if csrfTokenAuth == nil {
  1497. csrfTokenAuth = jwtauth.New(jwa.HS256.String(), util.GenerateRandomBytes(32), nil)
  1498. }
  1499. adminUsername := "testAdmin"
  1500. form := make(url.Values)
  1501. form.Set(csrfFormToken, createCSRFToken(""))
  1502. form.Set("username", adminUsername)
  1503. form.Set("password", "")
  1504. form.Set("status", "1")
  1505. form.Set("permissions", "*")
  1506. rr = httptest.NewRecorder()
  1507. r, err = http.NewRequest(http.MethodPost, webAdminPath, bytes.NewBuffer([]byte(form.Encode())))
  1508. assert.NoError(t, err)
  1509. r.Header.Set("Cookie", fmt.Sprintf("%v=%v", oidcCookieKey, tokenCookie))
  1510. r.Header.Set("Content-Type", "application/x-www-form-urlencoded")
  1511. server.router.ServeHTTP(rr, r)
  1512. assert.Equal(t, http.StatusSeeOther, rr.Code)
  1513. _, err = dataprovider.AdminExists(adminUsername)
  1514. assert.NoError(t, err)
  1515. err = dataprovider.DeleteAdmin(adminUsername, "", "", "")
  1516. assert.NoError(t, err)
  1517. // login and password related routes are disabled
  1518. rr = httptest.NewRecorder()
  1519. r, err = http.NewRequest(http.MethodPost, webAdminLoginPath, nil)
  1520. assert.NoError(t, err)
  1521. server.router.ServeHTTP(rr, r)
  1522. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1523. rr = httptest.NewRecorder()
  1524. r, err = http.NewRequest(http.MethodPost, webAdminTwoFactorPath, nil)
  1525. assert.NoError(t, err)
  1526. server.router.ServeHTTP(rr, r)
  1527. assert.Equal(t, http.StatusNotFound, rr.Code)
  1528. rr = httptest.NewRecorder()
  1529. r, err = http.NewRequest(http.MethodPost, webClientLoginPath, nil)
  1530. assert.NoError(t, err)
  1531. server.router.ServeHTTP(rr, r)
  1532. assert.Equal(t, http.StatusMethodNotAllowed, rr.Code)
  1533. rr = httptest.NewRecorder()
  1534. r, err = http.NewRequest(http.MethodPost, webClientForgotPwdPath, nil)
  1535. assert.NoError(t, err)
  1536. server.router.ServeHTTP(rr, r)
  1537. assert.Equal(t, http.StatusNotFound, rr.Code)
  1538. }
  1539. func TestDbOIDCManager(t *testing.T) {
  1540. if !isSharedProviderSupported() {
  1541. t.Skip("this test it is not available with this provider")
  1542. }
  1543. mgr := newOIDCManager(1)
  1544. pendingAuth := newOIDCPendingAuth(tokenAudienceWebAdmin)
  1545. mgr.addPendingAuth(pendingAuth)
  1546. authReq, err := mgr.getPendingAuth(pendingAuth.State)
  1547. assert.NoError(t, err)
  1548. assert.Equal(t, pendingAuth, authReq)
  1549. pendingAuth.IssuedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1550. mgr.addPendingAuth(pendingAuth)
  1551. _, err = mgr.getPendingAuth(pendingAuth.State)
  1552. if assert.Error(t, err) {
  1553. assert.Contains(t, err.Error(), "auth request is too old")
  1554. }
  1555. mgr.removePendingAuth(pendingAuth.State)
  1556. _, err = mgr.getPendingAuth(pendingAuth.State)
  1557. if assert.Error(t, err) {
  1558. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1559. }
  1560. mgr.addPendingAuth(pendingAuth)
  1561. _, err = mgr.getPendingAuth(pendingAuth.State)
  1562. if assert.Error(t, err) {
  1563. assert.Contains(t, err.Error(), "auth request is too old")
  1564. }
  1565. mgr.cleanup()
  1566. _, err = mgr.getPendingAuth(pendingAuth.State)
  1567. if assert.Error(t, err) {
  1568. assert.Contains(t, err.Error(), "unable to get the auth request for the specified state")
  1569. }
  1570. token := oidcToken{
  1571. Cookie: xid.New().String(),
  1572. AccessToken: xid.New().String(),
  1573. TokenType: "Bearer",
  1574. RefreshToken: xid.New().String(),
  1575. ExpiresAt: util.GetTimeAsMsSinceEpoch(time.Now().Add(-2 * time.Minute)),
  1576. SessionID: xid.New().String(),
  1577. IDToken: xid.New().String(),
  1578. Nonce: xid.New().String(),
  1579. Username: xid.New().String(),
  1580. Permissions: []string{dataprovider.PermAdminAny},
  1581. Role: "admin",
  1582. }
  1583. mgr.addToken(token)
  1584. tokenGet, err := mgr.getToken(token.Cookie)
  1585. assert.NoError(t, err)
  1586. assert.Greater(t, tokenGet.UsedAt, int64(0))
  1587. token.UsedAt = tokenGet.UsedAt
  1588. assert.Equal(t, token, tokenGet)
  1589. time.Sleep(100 * time.Millisecond)
  1590. mgr.updateTokenUsage(token)
  1591. // no change
  1592. tokenGet, err = mgr.getToken(token.Cookie)
  1593. assert.NoError(t, err)
  1594. assert.Equal(t, token.UsedAt, tokenGet.UsedAt)
  1595. tokenGet.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1596. tokenGet.RefreshToken = xid.New().String()
  1597. mgr.updateTokenUsage(tokenGet)
  1598. tokenGet, err = mgr.getToken(token.Cookie)
  1599. assert.NoError(t, err)
  1600. assert.NotEmpty(t, tokenGet.RefreshToken)
  1601. assert.NotEqual(t, token.RefreshToken, tokenGet.RefreshToken)
  1602. assert.Greater(t, tokenGet.UsedAt, token.UsedAt)
  1603. mgr.removeToken(token.Cookie)
  1604. tokenGet, err = mgr.getToken(token.Cookie)
  1605. if assert.Error(t, err) {
  1606. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1607. }
  1608. // add an expired token
  1609. token.UsedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-24 * time.Hour))
  1610. session := dataprovider.Session{
  1611. Key: token.Cookie,
  1612. Data: token,
  1613. Type: dataprovider.SessionTypeOIDCToken,
  1614. Timestamp: token.UsedAt + tokenDeleteInterval,
  1615. }
  1616. err = dataprovider.AddSharedSession(session)
  1617. assert.NoError(t, err)
  1618. _, err = mgr.getToken(token.Cookie)
  1619. if assert.Error(t, err) {
  1620. assert.Contains(t, err.Error(), "token is too old")
  1621. }
  1622. mgr.cleanup()
  1623. _, err = mgr.getToken(token.Cookie)
  1624. if assert.Error(t, err) {
  1625. assert.Contains(t, err.Error(), "unable to get the token for the specified session")
  1626. }
  1627. // adding a session without a key should fail
  1628. session.Key = ""
  1629. err = dataprovider.AddSharedSession(session)
  1630. if assert.Error(t, err) {
  1631. assert.Contains(t, err.Error(), "unable to save a session with an empty key")
  1632. }
  1633. session.Key = xid.New().String()
  1634. session.Type = 1000
  1635. err = dataprovider.AddSharedSession(session)
  1636. if assert.Error(t, err) {
  1637. assert.Contains(t, err.Error(), "invalid session type")
  1638. }
  1639. dbMgr, ok := mgr.(*dbOIDCManager)
  1640. if assert.True(t, ok) {
  1641. _, err = dbMgr.decodePendingAuthData(2)
  1642. assert.Error(t, err)
  1643. _, err = dbMgr.decodeTokenData(true)
  1644. assert.Error(t, err)
  1645. }
  1646. }
  1647. func getTestOIDCServer() *httpdServer {
  1648. return &httpdServer{
  1649. binding: Binding{
  1650. OIDC: OIDC{
  1651. ClientID: "sftpgo-client",
  1652. ClientSecret: "jRsmE0SWnuZjP7djBqNq0mrf8QN77j2c",
  1653. ConfigURL: fmt.Sprintf("http://%v/auth/realms/sftpgo", oidcMockAddr),
  1654. RedirectBaseURL: "http://127.0.0.1:8081/",
  1655. UsernameField: "preferred_username",
  1656. RoleField: "sftpgo_role",
  1657. ImplicitRoles: false,
  1658. Scopes: []string{oidc.ScopeOpenID, "profile", "email"},
  1659. CustomFields: nil,
  1660. Debug: true,
  1661. },
  1662. },
  1663. enableWebAdmin: true,
  1664. enableWebClient: true,
  1665. }
  1666. }
  1667. func getPreLoginScriptContent(user dataprovider.User, nonJSONResponse bool) []byte {
  1668. content := []byte("#!/bin/sh\n\n")
  1669. if nonJSONResponse {
  1670. content = append(content, []byte("echo 'text response'\n")...)
  1671. return content
  1672. }
  1673. if len(user.Username) > 0 {
  1674. u, _ := json.Marshal(user)
  1675. content = append(content, []byte(fmt.Sprintf("echo '%v'\n", string(u)))...)
  1676. }
  1677. return content
  1678. }