|
| 1 | +/* |
| 2 | +Copyright 2023 The Matrix.org Foundation C.I.C. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +import fetchMockJest from "fetch-mock-jest"; |
| 18 | +import * as randomStringUtils from "matrix-js-sdk/src/randomstring"; |
| 19 | + |
| 20 | +import { startOidcLogin } from "../../../src/utils/oidc/authorize"; |
| 21 | + |
| 22 | +describe("startOidcLogin()", () => { |
| 23 | + const issuer = "https://auth.com/"; |
| 24 | + const authorizationEndpoint = "https://auth.com/authorization"; |
| 25 | + const homeserver = "https://matrix.org"; |
| 26 | + const clientId = "xyz789"; |
| 27 | + const baseUrl = "https://test.com"; |
| 28 | + |
| 29 | + const delegatedAuthConfig = { |
| 30 | + issuer, |
| 31 | + registrationEndpoint: issuer + "registration", |
| 32 | + authorizationEndpoint, |
| 33 | + tokenEndpoint: issuer + "token", |
| 34 | + }; |
| 35 | + |
| 36 | + const sessionStorageGetSpy = jest.spyOn(sessionStorage.__proto__, "setItem").mockReturnValue(undefined); |
| 37 | + const randomStringMockImpl = (length: number) => new Array(length).fill("x").join(""); |
| 38 | + |
| 39 | + // to restore later |
| 40 | + const realWindowLocation = window.location; |
| 41 | + |
| 42 | + beforeEach(() => { |
| 43 | + fetchMockJest.mockClear(); |
| 44 | + fetchMockJest.resetBehavior(); |
| 45 | + |
| 46 | + sessionStorageGetSpy.mockClear(); |
| 47 | + |
| 48 | + // @ts-ignore allow delete of non-optional prop |
| 49 | + delete window.location; |
| 50 | + // @ts-ignore ugly mocking |
| 51 | + window.location = { |
| 52 | + href: baseUrl, |
| 53 | + origin: baseUrl, |
| 54 | + }; |
| 55 | + |
| 56 | + jest.spyOn(randomStringUtils, "randomString").mockRestore(); |
| 57 | + }); |
| 58 | + |
| 59 | + afterAll(() => { |
| 60 | + window.location = realWindowLocation; |
| 61 | + }); |
| 62 | + |
| 63 | + it("should store authorization params in session storage", async () => { |
| 64 | + jest.spyOn(randomStringUtils, "randomString").mockReset().mockImplementation(randomStringMockImpl); |
| 65 | + await startOidcLogin(delegatedAuthConfig, clientId, homeserver); |
| 66 | + |
| 67 | + const state = randomStringUtils.randomString(8); |
| 68 | + |
| 69 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith(`oidc_${state}_nonce`, randomStringUtils.randomString(8)); |
| 70 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith(`oidc_${state}_redirectUri`, baseUrl); |
| 71 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith( |
| 72 | + `oidc_${state}_codeVerifier`, |
| 73 | + randomStringUtils.randomString(64), |
| 74 | + ); |
| 75 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith(`oidc_${state}_clientId`, clientId); |
| 76 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith(`oidc_${state}_issuer`, issuer); |
| 77 | + expect(sessionStorageGetSpy).toHaveBeenCalledWith(`oidc_${state}_homeserver`, homeserver); |
| 78 | + }); |
| 79 | + |
| 80 | + it("navigates to authorization endpoint with correct parameters", async () => { |
| 81 | + await startOidcLogin(delegatedAuthConfig, clientId, homeserver); |
| 82 | + |
| 83 | + const expectedScopeWithoutDeviceId = `openid urn:matrix:org.matrix.msc2967.client:api:* urn:matrix:org.matrix.msc2967.client:device:`; |
| 84 | + |
| 85 | + const authUrl = new URL(window.location.href); |
| 86 | + |
| 87 | + expect(authUrl.searchParams.get("response_mode")).toEqual("query"); |
| 88 | + expect(authUrl.searchParams.get("response_type")).toEqual("code"); |
| 89 | + expect(authUrl.searchParams.get("client_id")).toEqual(clientId); |
| 90 | + expect(authUrl.searchParams.get("code_challenge_method")).toEqual("S256"); |
| 91 | + |
| 92 | + // scope ends with a 10char randomstring deviceId |
| 93 | + const scope = authUrl.searchParams.get("scope")!; |
| 94 | + expect(scope.substring(0, scope.length - 10)).toEqual(expectedScopeWithoutDeviceId); |
| 95 | + expect(scope.substring(scope.length - 10)).toBeTruthy(); |
| 96 | + |
| 97 | + // random string, just check they are set |
| 98 | + expect(authUrl.searchParams.has("state")).toBeTruthy(); |
| 99 | + expect(authUrl.searchParams.has("nonce")).toBeTruthy(); |
| 100 | + expect(authUrl.searchParams.has("code_challenge")).toBeTruthy(); |
| 101 | + }); |
| 102 | +}); |
0 commit comments