Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 10x 10x 10x 10x 10x 10x 1x 1x 9x 9x 9x 9x 9x 9x 9x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 4x 4x 4x 4x 4x 7x 4x 4x 3x 3x 3x 3x 3x 3x 3x 1x 1x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 4x 4x 4x 4x 7x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 6x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 6x 2x 2x 2x 2x 2x 1x 1x 20x 20x 20x 20x 20x 20x 10x 2x 2x 8x 10x 10x 10x 2x 2x 10x 2x 2x 2x 2x 2x 2x 2x 2x 2x 10x 8x 8x 8x 8x 8x 10x 10x 10x 4x 6x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 8x 8x 8x 8x 8x 8x 10x 10x 1x 1x 1x 2x 2x 2x 2x 2x 6x 6x 6x 6x 2x 2x 1x 1x 2x 2x 2x 2x 2x 6x 6x 6x 6x 2x 2x 1x 1x 1x 10x 10x 10x 10x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import {
Base64urlDecode,
SDJWTException,
Disclosure,
} from '@hopae/sd-jwt-util';
import {
Hasher,
HasherAndAlg,
SD_DIGEST,
SD_LIST_KEY,
SD_SEPARATOR,
} from '@hopae/sd-jwt-type';
import { HasherAndAlgSync, HasherSync } from '@hopae/sd-jwt-type/src/type';
export const decodeJwt = <
H extends Record<string, any>,
T extends Record<string, any>,
>(
jwt: string,
): { header: H; payload: T; signature: string } => {
const { 0: header, 1: payload, 2: signature, length } = jwt.split('.');
if (length !== 3) {
throw new SDJWTException('Invalid JWT as input');
}
return {
header: JSON.parse(Base64urlDecode(header)),
payload: JSON.parse(Base64urlDecode(payload)),
signature: signature,
};
};
// Split the sdjwt into 3 parts: jwt, disclosures and keybinding jwt. each part is base64url encoded
// It's separated by the ~ character
//
// If there is no keybinding jwt, the third part will be undefined
// If there are no disclosures, the second part will be an empty array
export const splitSdJwt = (
sdjwt: string,
): { jwt: string; disclosures: string[]; kbJwt?: string } => {
const [encodedJwt, ...encodedDisclosures] = sdjwt.split(SD_SEPARATOR);
if (encodedDisclosures.length === 0) {
// if input is just jwt, then return here.
// This is for compatibility with jwt
return {
jwt: encodedJwt,
disclosures: [],
};
}
const encodedKeyBindingJwt = encodedDisclosures.pop();
return {
jwt: encodedJwt,
disclosures: encodedDisclosures,
kbJwt: encodedKeyBindingJwt || undefined,
};
};
// Decode the sdjwt into the jwt, disclosures and keybinding jwt
// jwt, disclosures and keybinding jwt are also decoded
export const decodeSdJwt = async (
sdjwt: string,
hasher: Hasher,
): Promise<DecodedSDJwt> => {
const [encodedJwt, ...encodedDisclosures] = sdjwt.split(SD_SEPARATOR);
const jwt = decodeJwt(encodedJwt);
if (encodedDisclosures.length === 0) {
// if input is just jwt, then return here.
// This is for compatibility with jwt
return {
jwt,
disclosures: [],
};
}
const encodedKeyBindingJwt = encodedDisclosures.pop();
const kbJwt = encodedKeyBindingJwt
? decodeJwt(encodedKeyBindingJwt)
: undefined;
const { _sd_alg } = getSDAlgAndPayload(jwt.payload);
const disclosures = await Promise.all(
encodedDisclosures.map((ed) =>
Disclosure.fromEncode(ed, { alg: _sd_alg, hasher }),
),
);
return {
jwt,
disclosures,
kbJwt,
};
};
export const decodeSdJwtSync = (
sdjwt: string,
hasher: HasherSync,
): DecodedSDJwt => {
const [encodedJwt, ...encodedDisclosures] = sdjwt.split(SD_SEPARATOR);
const jwt = decodeJwt(encodedJwt);
if (encodedDisclosures.length === 0) {
// if input is just jwt, then return here.
// This is for compatibility with jwt
return {
jwt,
disclosures: [],
};
}
const encodedKeyBindingJwt = encodedDisclosures.pop();
const kbJwt = encodedKeyBindingJwt
? decodeJwt(encodedKeyBindingJwt)
: undefined;
const { _sd_alg } = getSDAlgAndPayload(jwt.payload);
const disclosures = encodedDisclosures.map((ed) =>
Disclosure.fromEncodeSync(ed, { alg: _sd_alg, hasher }),
);
return {
jwt,
disclosures,
kbJwt,
};
};
// Get the claims from jwt and disclosures
// The digested values are matched with the disclosures and the claims are extracted
export const getClaims = async <T>(
rawPayload: any,
disclosures: Array<Disclosure<any>>,
hasher: Hasher,
): Promise<T> => {
const { unpackedObj } = await unpack(rawPayload, disclosures, hasher);
return unpackedObj as T;
};
export const getClaimsSync = <T>(
rawPayload: any,
disclosures: Array<Disclosure<any>>,
hasher: HasherSync,
): T => {
const { unpackedObj } = unpackSync(rawPayload, disclosures, hasher);
return unpackedObj as T;
};
export const unpackArray = (
arr: Array<any>,
map: Record<string, Disclosure<any>>,
prefix: string = '',
): { unpackedObj: any; disclosureKeymap: Record<string, string> } => {
const keys: Record<string, string> = {};
const unpackedArray: any[] = [];
arr.forEach((item, idx) => {
if (item instanceof Object) {
if (item[SD_LIST_KEY]) {
const hash = item[SD_LIST_KEY];
const disclosed = map[hash];
if (disclosed) {
const presentKey = prefix ? `${prefix}.${idx}` : `${idx}`;
keys[presentKey] = hash;
const { unpackedObj, disclosureKeymap: disclosureKeys } = unpackObj(
disclosed.value,
map,
presentKey,
);
unpackedArray.push(unpackedObj);
Object.assign(keys, disclosureKeys);
}
} else {
const newKey = prefix ? `${prefix}.${idx}` : `${idx}`;
const { unpackedObj, disclosureKeymap: disclosureKeys } = unpackObj(
item,
map,
newKey,
);
unpackedArray.push(unpackedObj);
Object.assign(keys, disclosureKeys);
}
} else {
unpackedArray.push(item);
}
});
return { unpackedObj: unpackedArray, disclosureKeymap: keys };
};
export const unpackObj = (
obj: any,
map: Record<string, Disclosure<any>>,
prefix: string = '',
): { unpackedObj: any; disclosureKeymap: Record<string, string> } => {
const keys: Record<string, string> = {};
if (obj instanceof Object) {
if (obj instanceof Array) {
return unpackArray(obj, map, prefix);
}
for (const key in obj) {
if (
key !== SD_DIGEST &&
key !== SD_LIST_KEY &&
obj[key] instanceof Object
) {
const newKey = prefix ? `${prefix}.${key}` : key;
const { unpackedObj, disclosureKeymap: disclosureKeys } = unpackObj(
obj[key],
map,
newKey,
);
obj[key] = unpackedObj;
Object.assign(keys, disclosureKeys);
}
}
const { _sd, ...payload } = obj;
const claims: any = {};
if (_sd) {
_sd.forEach((hash: string) => {
const disclosed = map[hash];
if (disclosed && disclosed.key) {
const presentKey = prefix
? `${prefix}.${disclosed.key}`
: disclosed.key;
keys[presentKey] = hash;
const { unpackedObj, disclosureKeymap: disclosureKeys } = unpackObj(
disclosed.value,
map,
presentKey,
);
claims[disclosed.key] = unpackedObj;
Object.assign(keys, disclosureKeys);
}
});
}
const unpackedObj = Object.assign(payload, claims);
return { unpackedObj, disclosureKeymap: keys };
}
return { unpackedObj: obj, disclosureKeymap: keys };
};
// Creates a mapping of the digests of the disclosures to the actual disclosures
export const createHashMapping = async (
disclosures: Array<Disclosure<any>>,
hash: HasherAndAlg,
) => {
const map: Record<string, Disclosure<any>> = {};
for (let i = 0; i < disclosures.length; i++) {
const disclosure = disclosures[i];
const digest = await disclosure.digest(hash);
map[digest] = disclosure;
}
return map;
};
export const createHashMappingSync = (
disclosures: Array<Disclosure<any>>,
hash: HasherAndAlgSync,
) => {
const map: Record<string, Disclosure<any>> = {};
for (let i = 0; i < disclosures.length; i++) {
const disclosure = disclosures[i];
const digest = disclosure.digestSync(hash);
map[digest] = disclosure;
}
return map;
};
// Extract _sd_alg. If it is not present, it is assumed to be sha-256
export const getSDAlgAndPayload = (sdjwtPayload: any) => {
const { _sd_alg, ...payload } = sdjwtPayload;
if (typeof _sd_alg !== 'string') {
// This is for compatibility
return { _sd_alg: 'sha-256', payload };
}
return { _sd_alg, payload };
};
// Match the digests of the disclosures with the claims and extract the claims
// unpack function use unpackObj and unpackArray to recursively unpack the claims
export const unpack = async (
sdjwtPayload: any,
disclosures: Array<Disclosure<any>>,
hasher: Hasher,
) => {
const { _sd_alg, payload } = getSDAlgAndPayload(sdjwtPayload);
const hash = { hasher, alg: _sd_alg };
const map = await createHashMapping(disclosures, hash);
return unpackObj(payload, map);
};
export const unpackSync = (
sdjwtPayload: any,
disclosures: Array<Disclosure<any>>,
hasher: HasherSync,
) => {
const { _sd_alg, payload } = getSDAlgAndPayload(sdjwtPayload);
const hash = { hasher, alg: _sd_alg };
const map = createHashMappingSync(disclosures, hash);
return unpackObj(payload, map);
};
// This is the type of the object that is returned by the decodeSdJwt function
// It is a combination of the decoded jwt, the disclosures and the keybinding jwt
export type DecodedSDJwt = {
jwt: {
header: Record<string, any>;
payload: Record<string, any>; // raw payload of sd-jwt
signature: string;
};
disclosures: Array<Disclosure<any>>;
kbJwt?: {
header: Record<string, any>;
payload: Record<string, any>;
signature: string;
};
};
|