|
| 1 | +/** |
| 2 | + * Copyright (c) 2023 Gitpod GmbH. All rights reserved. |
| 3 | + * Licensed under the GNU Affero General Public License (AGPL). |
| 4 | + * See License.AGPL.txt in the project root for license information. |
| 5 | + */ |
| 6 | + |
| 7 | +import * as express from "express"; |
| 8 | +import { Container } from "inversify"; |
| 9 | +import { createTestContainer } from "./test/service-testing-container-module"; |
| 10 | +import { TypeORM, resetDB } from "@gitpod/gitpod-db/lib"; |
| 11 | +import { SessionHandler } from "./session-handler"; |
| 12 | +import { expect } from "chai"; |
| 13 | +import { UserService } from "./user/user-service"; |
| 14 | +import { User } from "@gitpod/gitpod-protocol"; |
| 15 | +import { v4 } from "uuid"; |
| 16 | +import { Deferred } from "@gitpod/gitpod-protocol/lib/util/deferred"; |
| 17 | + |
| 18 | +describe("SessionHandler", () => { |
| 19 | + let container: Container; |
| 20 | + let sessionHandler: SessionHandler; |
| 21 | + let existingUser: User; |
| 22 | + |
| 23 | + beforeEach(async () => { |
| 24 | + container = createTestContainer(); |
| 25 | + sessionHandler = container.get(SessionHandler); |
| 26 | + const userService = container.get(UserService); |
| 27 | + // insert some users to the DB to reproduce INC-379 |
| 28 | + await userService.createUser({ |
| 29 | + identity: { |
| 30 | + authName: "github", |
| 31 | + authProviderId: "github", |
| 32 | + authId: "1234", |
| 33 | + }, |
| 34 | + }); |
| 35 | + existingUser = await userService.createUser({ |
| 36 | + identity: { |
| 37 | + authName: "github", |
| 38 | + authProviderId: "github", |
| 39 | + authId: "1234", |
| 40 | + }, |
| 41 | + }); |
| 42 | + }); |
| 43 | + |
| 44 | + afterEach(async () => { |
| 45 | + const typeorm = container.get(TypeORM); |
| 46 | + await resetDB(typeorm); |
| 47 | + }); |
| 48 | + |
| 49 | + describe("verify", () => { |
| 50 | + it("should return undefined for an empty cookie", async () => { |
| 51 | + const user = await sessionHandler.verify(""); |
| 52 | + expect(user).to.be.undefined; |
| 53 | + }); |
| 54 | + it("should return undefined for an invalid cookie", async () => { |
| 55 | + const user = await sessionHandler.verify("invalid"); |
| 56 | + expect(user).to.be.undefined; |
| 57 | + }); |
| 58 | + it("should return the user for a valid JWT with correct 'sub' claim", async () => { |
| 59 | + const cookie = await sessionHandler.createJWTSessionCookie(existingUser.id); |
| 60 | + const user = await sessionHandler.verify(`${cookie.name}=${cookie.value}`); |
| 61 | + expect(user?.id).to.be.equal(existingUser.id); |
| 62 | + }); |
| 63 | + it("should return undefined for a valid JWT with incorrect 'sub' claim", async () => { |
| 64 | + const unexisingUserId = v4(); |
| 65 | + const cookie = await sessionHandler.createJWTSessionCookie(unexisingUserId); |
| 66 | + const user = await sessionHandler.verify(`${cookie.name}=${cookie.value}`); |
| 67 | + expect(user).to.be.undefined; |
| 68 | + }); |
| 69 | + }); |
| 70 | + describe("createJWTSessionCookie", () => { |
| 71 | + it("should create a valid JWT token with correct attributes and cookie options", async () => { |
| 72 | + const issuedAfter = Math.floor(new Date().getTime() / 1000); |
| 73 | + const expiresAfter = issuedAfter + 7 * 24 * 60 * 60; |
| 74 | + const { name, value: token, opts } = await sessionHandler.createJWTSessionCookie("1"); |
| 75 | + |
| 76 | + const decoded = await sessionHandler.verifyJWTCookie(`${name}=${token}`); |
| 77 | + expect(decoded, "Verify the JWT is valid").to.not.be.null; |
| 78 | + |
| 79 | + expect(decoded!.sub).to.equal("1", "Check the 'sub' claim"); |
| 80 | + expect(decoded!.iat || 0).to.be.greaterThanOrEqual(issuedAfter, "Check the 'iat' claim"); |
| 81 | + expect(decoded!.exp || 0).to.be.greaterThanOrEqual(expiresAfter, "Check the 'exp' claim"); |
| 82 | + |
| 83 | + // Check cookie options |
| 84 | + expect(opts.httpOnly).to.equal(true); |
| 85 | + expect(opts.secure).to.equal(true); |
| 86 | + expect(opts.maxAge).to.equal(604800000); |
| 87 | + expect(opts.sameSite).to.equal("strict"); |
| 88 | + |
| 89 | + expect(name, "Check cookie name").to.equal("_gitpod_dev_jwt_"); |
| 90 | + }); |
| 91 | + }); |
| 92 | + describe("jwtSessionConvertor", () => { |
| 93 | + it("should manage a JWT cookie", async () => { |
| 94 | + const jwtSessionHandler = sessionHandler.jwtSessionConvertor(); |
| 95 | + interface Response { |
| 96 | + status?: number; |
| 97 | + value?: string; |
| 98 | + cookie?: string; |
| 99 | + } |
| 100 | + const handle = async (user?: User, cookie?: string): Promise<Response> => { |
| 101 | + const deferred = new Deferred<Response>(); |
| 102 | + const result: Response = { |
| 103 | + status: undefined, |
| 104 | + value: undefined, |
| 105 | + cookie: undefined, |
| 106 | + }; |
| 107 | + jwtSessionHandler( |
| 108 | + { user, headers: { cookie } } as express.Request, |
| 109 | + { |
| 110 | + status: function (statusCode: number) { |
| 111 | + result.status = statusCode; |
| 112 | + return this; |
| 113 | + }, |
| 114 | + send: function (value: string) { |
| 115 | + result.value = value; |
| 116 | + deferred.resolve(result); |
| 117 | + }, |
| 118 | + cookie: function (name: string, value: string, opts: express.CookieOptions) { |
| 119 | + result.cookie = `${name}=${value}; `; |
| 120 | + }, |
| 121 | + } as any as express.Response, |
| 122 | + () => {}, |
| 123 | + ); |
| 124 | + return await deferred.promise; |
| 125 | + }; |
| 126 | + |
| 127 | + // User is not authenticated |
| 128 | + let res = await handle(); |
| 129 | + expect(res.status).to.equal(401); |
| 130 | + expect(res.value).to.equal("User has no valid session."); |
| 131 | + expect(res.cookie).to.be.undefined; |
| 132 | + |
| 133 | + // JWT cookie is not present |
| 134 | + res = await handle(existingUser); |
| 135 | + expect(res.status).to.equal(200); |
| 136 | + expect(res.value).to.equal("New JWT cookie issued."); |
| 137 | + expect(res.cookie).not.to.be.undefined; |
| 138 | + |
| 139 | + // JWT cookie is present and valid |
| 140 | + res = await handle(existingUser, res.cookie); |
| 141 | + expect(res.status).to.equal(200); |
| 142 | + expect(res.value).to.equal("User session already has a valid JWT session."); |
| 143 | + expect(res.cookie).to.be.undefined; |
| 144 | + |
| 145 | + // JWT cookie is present and refreshed |
| 146 | + const cookieToRefresh = await sessionHandler.createJWTSessionCookie(existingUser.id, { |
| 147 | + issuedAtMs: Date.now() - SessionHandler.JWT_REFRESH_THRESHOLD - 1, |
| 148 | + }); |
| 149 | + res = await handle(existingUser, `${cookieToRefresh.name}=${cookieToRefresh.value}`); |
| 150 | + expect(res.status).to.equal(200); |
| 151 | + expect(res.value).to.equal("Refreshed JWT cookie issued."); |
| 152 | + expect(res.cookie).not.to.be.undefined; |
| 153 | + |
| 154 | + // JWT cookie is present and expired |
| 155 | + const expiredCookie = await sessionHandler.createJWTSessionCookie(existingUser.id, { |
| 156 | + expirySeconds: 0, |
| 157 | + }); |
| 158 | + res = await handle(existingUser, `${expiredCookie.name}=${expiredCookie.value}`); |
| 159 | + expect(res.status).to.equal(401); |
| 160 | + expect(res.value).to.equal("JWT Session is invalid"); |
| 161 | + expect(res.cookie).to.be.undefined; |
| 162 | + |
| 163 | + // JWT cookie is present but invalid |
| 164 | + res = await handle(existingUser, "_gitpod_dev_jwt_=invalid"); |
| 165 | + expect(res.status).to.equal(401); |
| 166 | + expect(res.value).to.equal("JWT Session is invalid"); |
| 167 | + expect(res.cookie).to.be.undefined; |
| 168 | + }); |
| 169 | + }); |
| 170 | +}); |
0 commit comments