-
Notifications
You must be signed in to change notification settings - Fork 25
/
IDToken.ts
executable file
·197 lines (175 loc) · 6.9 KB
/
IDToken.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
import { JWTHeader } from 'did-jwt';
import { AuthorizationResponseOpts, VerifyAuthorizationResponseOpts } from '../authorization-response';
import { assertValidVerifyOpts } from '../authorization-response/Opts';
import { getResolver, getSubDidFromPayload, parseJWT, signIDTokenPayload, validateLinkedDomainWithDid, verifyDidJWT } from '../did';
import {
CheckLinkedDomain,
IDTokenJwt,
IDTokenPayload,
JWTPayload,
ResponseIss,
SIOPErrors,
VerifiedAuthorizationRequest,
VerifiedIDToken,
} from '../types';
import { createIDTokenPayload } from './Payload';
export class IDToken {
private _header?: JWTHeader;
private _payload?: IDTokenPayload;
private _jwt?: IDTokenJwt;
private readonly _responseOpts: AuthorizationResponseOpts;
private constructor(jwt?: IDTokenJwt, payload?: IDTokenPayload, responseOpts?: AuthorizationResponseOpts) {
this._jwt = jwt;
this._payload = payload;
this._responseOpts = responseOpts;
}
public static async fromVerifiedAuthorizationRequest(
verifiedAuthorizationRequest: VerifiedAuthorizationRequest,
responseOpts: AuthorizationResponseOpts,
verifyOpts?: VerifyAuthorizationResponseOpts
) {
const authorizationRequestPayload = verifiedAuthorizationRequest.authorizationRequestPayload;
if (!authorizationRequestPayload) {
throw new Error(SIOPErrors.NO_REQUEST);
}
const idToken = new IDToken(null, await createIDTokenPayload(verifiedAuthorizationRequest, responseOpts), responseOpts);
if (verifyOpts) {
await idToken.verify(verifyOpts);
}
return idToken;
}
public static async fromIDToken(idTokenJwt: IDTokenJwt, verifyOpts?: VerifyAuthorizationResponseOpts) {
if (!idTokenJwt) {
throw new Error(SIOPErrors.NO_JWT);
}
const idToken = new IDToken(idTokenJwt, undefined);
if (verifyOpts) {
await idToken.verify(verifyOpts);
}
return idToken;
}
public static async fromIDTokenPayload(
idTokenPayload: IDTokenPayload,
responseOpts: AuthorizationResponseOpts,
verifyOpts?: VerifyAuthorizationResponseOpts
) {
if (!idTokenPayload) {
throw new Error(SIOPErrors.NO_JWT);
}
const idToken = new IDToken(null, idTokenPayload, responseOpts);
if (verifyOpts) {
await idToken.verify(verifyOpts);
}
return idToken;
}
public async payload(): Promise<IDTokenPayload> {
if (!this._payload) {
if (!this._jwt) {
throw new Error(SIOPErrors.NO_JWT);
}
const { header, payload } = this.parseAndVerifyJwt();
this._header = header;
this._payload = payload;
}
return this._payload;
}
public async jwt(): Promise<IDTokenJwt> {
if (!this._jwt) {
if (!this.responseOpts) {
throw Error(SIOPErrors.BAD_SIGNATURE_PARAMS);
}
this._jwt = await signIDTokenPayload(this._payload, this.responseOpts);
const { header, payload } = this.parseAndVerifyJwt();
this._header = header;
this._payload = payload;
}
return this._jwt;
}
private parseAndVerifyJwt(): { header: JWTHeader; payload: IDTokenPayload } {
const { header, payload } = parseJWT(this._jwt);
this.assertValidResponseJWT({ header, payload });
const idTokenPayload = payload as IDTokenPayload;
return { header, payload: idTokenPayload };
}
/**
* Verifies a SIOP ID Response JWT on the RP Side
*
* @param idToken ID token to be validated
* @param verifyOpts
*/
public async verify(verifyOpts: VerifyAuthorizationResponseOpts): Promise<VerifiedIDToken> {
assertValidVerifyOpts(verifyOpts);
const { header, payload } = parseJWT(await this.jwt());
this.assertValidResponseJWT({ header, payload });
const verifiedJWT = await verifyDidJWT(await this.jwt(), getResolver(verifyOpts.verification.resolveOpts), {
...verifyOpts.verification.resolveOpts?.jwtVerifyOpts,
audience: verifyOpts.audience ?? verifyOpts.verification.resolveOpts?.jwtVerifyOpts?.audience,
});
const issuerDid = getSubDidFromPayload(payload);
if (verifyOpts.verification.checkLinkedDomain && verifyOpts.verification.checkLinkedDomain !== CheckLinkedDomain.NEVER) {
await validateLinkedDomainWithDid(issuerDid, verifyOpts.verification);
} else if (!verifyOpts.verification.checkLinkedDomain) {
await validateLinkedDomainWithDid(issuerDid, verifyOpts.verification);
}
const verPayload = verifiedJWT.payload as IDTokenPayload;
this.assertValidResponseJWT({ header, verPayload: verPayload, audience: verifyOpts.audience });
// Enforces verifyPresentationCallback function on the RP side,
if (!verifyOpts?.verification.presentationVerificationCallback) {
throw new Error(SIOPErrors.VERIFIABLE_PRESENTATION_VERIFICATION_FUNCTION_MISSING);
}
return {
jwt: await this.jwt(),
didResolutionResult: verifiedJWT.didResolutionResult,
signer: verifiedJWT.signer,
issuer: issuerDid,
payload: { ...verPayload },
verifyOpts,
};
}
static async verify(idTokenJwt: IDTokenJwt, verifyOpts: VerifyAuthorizationResponseOpts): Promise<VerifiedIDToken> {
const idToken = await IDToken.fromIDToken(idTokenJwt, verifyOpts);
const verifiedIdToken = await idToken.verify(verifyOpts);
return {
...verifiedIdToken,
};
}
private assertValidResponseJWT(opts: { header: JWTHeader; payload?: JWTPayload; verPayload?: IDTokenPayload; audience?: string; nonce?: string }) {
if (!opts.header) {
throw new Error(SIOPErrors.BAD_PARAMS);
}
if (opts.payload) {
if (!opts.payload.iss || !(opts.payload.iss.includes(ResponseIss.SELF_ISSUED_V2) || opts.payload.iss.startsWith('did:'))) {
throw new Error(`${SIOPErrors.NO_SELFISSUED_ISS}, got: ${opts.payload.iss}`);
}
}
if (opts.verPayload) {
if (!opts.verPayload.nonce) {
throw Error(SIOPErrors.NO_NONCE);
// No need for our own expiration check. DID jwt already does that
/*} else if (!opts.verPayload.exp || opts.verPayload.exp < Date.now() / 1000) {
throw Error(SIOPErrors.EXPIRED);
/!*} else if (!opts.verPayload.iat || opts.verPayload.iat > (Date.now() / 1000)) {
throw Error(SIOPErrors.EXPIRED);*!/
// todo: Add iat check
*/
}
if ((opts.verPayload.aud && !opts.audience) || (!opts.verPayload.aud && opts.audience)) {
throw Error(SIOPErrors.NO_AUDIENCE);
} else if (opts.audience && opts.audience != opts.verPayload.aud) {
throw Error(SIOPErrors.INVALID_AUDIENCE);
} else if (opts.nonce && opts.nonce != opts.verPayload.nonce) {
throw Error(SIOPErrors.BAD_NONCE);
}
}
}
get header(): JWTHeader {
return this._header;
}
get responseOpts(): AuthorizationResponseOpts {
return this._responseOpts;
}
public async isSelfIssued(): Promise<boolean> {
const payload = await this.payload();
return payload.iss === ResponseIss.SELF_ISSUED_V2 || (payload.sub !== undefined && payload.sub === payload.iss);
}
}