-
Notifications
You must be signed in to change notification settings - Fork 42
/
crypto-helper.ts
148 lines (136 loc) · 4.57 KB
/
crypto-helper.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
* Copyright (c) 2022, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { SUPPORTED_SIGNATURE_ALGORITHMS } from "../constants";
import { AsgardeoAuthException } from "../exception";
import { CryptoUtils, DecodedIDTokenPayload, JWKInterface } from "../models";
export class CryptoHelper<T = any> {
private _cryptoUtils: CryptoUtils<T>;
public constructor(cryptoUtils: CryptoUtils<T>) {
this._cryptoUtils = cryptoUtils;
}
/**
* Generate code verifier.
*
* @returns code verifier.
*/
public getCodeVerifier(): string {
return this._cryptoUtils.base64URLEncode(this._cryptoUtils.generateRandomBytes(32));
}
/**
* Derive code challenge from the code verifier.
*
* @param verifier - Code verifier.
*
* @returns - code challenge.
*/
public getCodeChallenge(verifier: string): string {
return this._cryptoUtils.base64URLEncode(this._cryptoUtils.hashSha256(verifier));
}
/**
* Get JWK used for the id_token
*
* @param jwtHeader - header of the id_token.
* @param keys - jwks response.
*
* @returns public key.
*
* @throws
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
public getJWKForTheIdToken(jwtHeader: string, keys: JWKInterface[]): JWKInterface {
const headerJSON: Record<string, string> = JSON.parse(this._cryptoUtils.base64URLDecode(jwtHeader));
for (const key of keys) {
if (headerJSON.kid === key.kid) {
return key;
}
}
throw new AsgardeoAuthException(
"JS-CRYPTO_UTIL-GJFTIT-IV01",
"kid not found.",
"Failed to find the 'kid' specified in the id_token. 'kid' found in the header : " +
headerJSON.kid +
", Expected values: " +
keys.map((key: JWKInterface) => key.kid).join(", ")
);
}
/**
* Verify id token.
*
* @param idToken - id_token received from the IdP.
* @param jwk - public key used for signing.
* @param clientID - app identification.
* @param issuer - id_token issuer.
* @param username - Username.
* @param clockTolerance - Allowed leeway for id_tokens (in seconds).
*
* @returns whether the id_token is valid.
*
* @throws
*/
public isValidIdToken(
idToken: string,
jwk: JWKInterface,
clientID: string,
issuer: string,
username: string,
clockTolerance: number | undefined,
validateJwtIssuer: boolean | undefined
): Promise<boolean> {
return this._cryptoUtils
.verifyJwt(
idToken,
jwk,
SUPPORTED_SIGNATURE_ALGORITHMS,
clientID,
issuer,
username,
clockTolerance,
validateJwtIssuer
)
.then((response: boolean) => {
if (response) {
return Promise.resolve(true);
}
return Promise.reject(
new AsgardeoAuthException(
"JS-CRYPTO_HELPER-IVIT-IV01",
"Invalid ID token.",
"ID token validation returned false"
)
);
});
}
/**
* This function decodes the payload of an id token and returns it.
*
* @param idToken - The id token to be decoded.
*
* @returns - The decoded payload of the id token.
*
* @throws
*/
public decodeIDToken(idToken: string): DecodedIDTokenPayload {
try {
const utf8String: string = this._cryptoUtils.base64URLDecode(idToken.split(".")[ 1 ]);
const payload: DecodedIDTokenPayload = JSON.parse(utf8String);
return payload;
} catch (error: any) {
throw new AsgardeoAuthException("JS-CRYPTO_UTIL-DIT-IV01", "Decoding ID token failed.", error);
}
}
}