Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: lowercase sha algorithm to be compliant #266

Merged
merged 3 commits into from
Jan 13, 2025
Merged

chore: lowercase sha algorithm to be compliant #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d4764f
chore: lowercase sha algorithm to be compliant
cre8 Jan 12, 2025
3d3f96e
fix: check for valid hash algorithm name
cre8 Jan 12, 2025
0f4b457
chore: format
cre8 Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/0.x/sdjwt-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const sdjwt = new SDJwtInstance({
verifier,
signAlg: 'EdDSA',
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});
```
Expand All @@ -33,7 +33,7 @@ type SDJWTConfig = {
omitTyp?: boolean;
// hash function: (data: string) => Promise<string> or string;
hasher?: Hasher;
// hash algorithm string (e.g. 'SHA-256')
// hash algorithm string (e.g. 'sha-256')
hashAlg?: string;
// salt generate function: (length: number) => Promise<string> or string;
saltGenerator?: SaltGenerator;
Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-example/all.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, generateSalt, ES256 } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-example/basic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-example/custom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-example/custom_header.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-example/decoy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});
// Issuer Define the claims object with the user's information
Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-vc-example/all.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-vc-example/basic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-vc-example/custom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-vc-example/custom_header.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion examples/sd-jwt-vc-example/decoy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { createSignerVerifier, digest, ES256, generateSalt } from './utils';
verifier,
signAlg: ES256.alg,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});
// Issuer Define the claims object with the user's information
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,6 @@
"typescript": "^5.3.2",
"vite": "^5.1.1",
"vitest": "^1.2.2"
}
},
"packageManager": "[email protected]+sha512.f549b8a52c9d2b8536762f99c0722205efc5af913e77835dbccc3b0b0b2ca9e7dc8022b78062c17291c48e88749c70ce88eb5a74f1fa8c4bf5e18bb46c8bd83a"
}
8 changes: 4 additions & 4 deletions packages/browser-crypto/src/crypto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const generateSalt = (length: number): string => {

export async function digest(
data: string | ArrayBuffer,
algorithm = 'SHA-256',
algorithm = 'sha-256',
): Promise<Uint8Array> {
const ec = new TextEncoder();
const digest = await window.crypto.subtle.digest(
Expand All @@ -25,7 +25,7 @@ export async function digest(
return new Uint8Array(digest);
}

export const getHasher = (algorithm = 'SHA-256') => {
export const getHasher = (algorithm = 'sha-256') => {
return (data: string) => digest(data, algorithm);
};

Expand Down Expand Up @@ -72,7 +72,7 @@ export const ES256 = {
const signature = await window.crypto.subtle.sign(
{
name: 'ECDSA',
hash: { name: 'SHA-256' }, // Required for ES256
hash: { name: 'sha-256' }, // Required for ES256
},
privateKey,
encoder.encode(data),
Expand Down Expand Up @@ -107,7 +107,7 @@ export const ES256 = {
const isValid = await window.crypto.subtle.verify(
{
name: 'ECDSA',
hash: { name: 'SHA-256' }, // Required for ES256
hash: { name: 'sha-256' }, // Required for ES256
},
publicKey,
signature,
Expand Down
37 changes: 37 additions & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
type SDJWTConfig,
type JwtPayload,
type Signer,
type HashAlgorithm,
} from '@sd-jwt/types';
import { getSDAlgAndPayload } from '@sd-jwt/decode';
import { FlattenJSON } from './flattenJSON';
Expand All @@ -31,6 +32,26 @@ export * from './generalJSON';

export type SdJwtPayload = Record<string, unknown>;

const IANA_HASH_ALGORITHMS: HashAlgorithm[] = [
'sha-256',
'sha-256-128',
'sha-256-120',
'sha-256-96',
'sha-256-64',
'sha-256-32',
'sha-384',
'sha-512',
'sha3-224',
'sha3-256',
'sha3-384',
'sha3-512',
'blake2s-256',
'blake2b-256',
'blake2b-512',
'k12-256',
'k12-512',
];

export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {
//header type
protected type?: string;
Expand All @@ -41,6 +62,14 @@ export class SDJwtInstance<ExtendedPayload extends SdJwtPayload> {

constructor(userConfig?: SDJWTConfig) {
if (userConfig) {
if (
userConfig.hashAlg &&
!IANA_HASH_ALGORITHMS.includes(userConfig.hashAlg)
) {
throw new SDJWTException(
`Invalid hash algorithm: ${userConfig.hashAlg}`,
);
}
this.userConfig = userConfig;
}
}
Expand Down Expand Up @@ -340,6 +369,14 @@ export class SDJwtGeneralJSONInstance<ExtendedPayload extends SdJwtPayload> {

constructor(userConfig?: SDJWTConfig) {
if (userConfig) {
if (
userConfig.hashAlg &&
!IANA_HASH_ALGORITHMS.includes(userConfig.hashAlg)
) {
throw new SDJWTException(
`Invalid hash algorithm: ${userConfig.hashAlg}`,
);
}
this.userConfig = userConfig;
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/app-e2e.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ describe('App', () => {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down Expand Up @@ -208,7 +208,7 @@ async function JSONtest(filename: string) {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
2 changes: 1 addition & 1 deletion packages/hash/src/test/sha256.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ describe('SHA-256 tests', () => {

test('Hasher', async () => {
const s1 = bytesToHex(await digest('test'));
const s2 = bytesToHex(hasher('test', 'SHA-256'));
const s2 = bytesToHex(hasher('test', 'sha-256'));
const s3 = bytesToHex(hasher('test', 'SHA256'));
const s4 = bytesToHex(hasher('test', 'sha256'));
const s5 = bytesToHex(hasher('test', 'sha-256'));
Expand Down
6 changes: 3 additions & 3 deletions packages/node-crypto/src/crypto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const generateSalt = (length: number): string => {

export const digest = (
data: string | ArrayBuffer,
algorithm = 'SHA-256',
algorithm = 'sha-256',
): Uint8Array => {
const nodeAlg = toNodeCryptoAlg(algorithm);
const hash = createHash(nodeAlg);
Expand Down Expand Up @@ -64,7 +64,7 @@ export const ES256 = {
const signature = await subtle.sign(
{
name: 'ECDSA',
hash: { name: 'SHA-256' }, // Required for ES256
hash: { name: 'sha-256' }, // Required for ES256
},
privateKey,
encoder.encode(data),
Expand Down Expand Up @@ -98,7 +98,7 @@ export const ES256 = {
const isValid = await subtle.verify(
{
name: 'ECDSA',
hash: { name: 'SHA-256' }, // Required for ES256
hash: { name: 'sha-256' }, // Required for ES256
},
publicKey,
signature,
Expand Down
6 changes: 3 additions & 3 deletions packages/present/src/test/present.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ describe('Present tests', () => {
'RrOc4ZfBVyD6iNlMbtmdokZOti322mOXfvIOBKvpuc4',
'aXqInKwHoE1l8OM1VNUQDqTPeNUG1cMJVwVbxZJpP14',
],
_sd_alg: 'SHA-256',
_sd_alg: 'sha-256',
};

const presentationFrame = {
Expand Down Expand Up @@ -225,7 +225,7 @@ describe('Present tests', () => {
'RrOc4ZfBVyD6iNlMbtmdokZOti322mOXfvIOBKvpuc4',
'aXqInKwHoE1l8OM1VNUQDqTPeNUG1cMJVwVbxZJpP14',
],
_sd_alg: 'SHA-256',
_sd_alg: 'sha-256',
};

const presentationFrame = {};
Expand Down Expand Up @@ -265,7 +265,7 @@ describe('Present tests', () => {
'RrOc4ZfBVyD6iNlMbtmdokZOti322mOXfvIOBKvpuc4',
'aXqInKwHoE1l8OM1VNUQDqTPeNUG1cMJVwVbxZJpP14',
],
_sd_alg: 'SHA-256',
_sd_alg: 'sha-256',
};

const presentationFrame = {
Expand Down
2 changes: 1 addition & 1 deletion packages/sd-jwt-vc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ const sdjwt = new SDJwtVcInstance({
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
loadTypeMetadataFormat: true,
});
Expand Down
4 changes: 2 additions & 2 deletions packages/sd-jwt-vc/src/test/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ describe('App', () => {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand All @@ -94,7 +94,7 @@ describe('Revocation', () => {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
statusListFetcher(uri: string) {
// we emulate fetching the status list from the uri. Validation of the JWT is not done here in the test but should be done in the implementation.
Expand Down
2 changes: 1 addition & 1 deletion packages/sd-jwt-vc/src/test/vct.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ describe('App', () => {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
loadTypeMetadataFormat: true,
});
Expand Down
4 changes: 2 additions & 2 deletions packages/sd-jwt-vc/test/app-e2e.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('App', () => {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down Expand Up @@ -222,7 +222,7 @@ async function JSONtest(filename: string) {
signAlg: 'EdDSA',
verifier,
hasher: digest,
hashAlg: 'SHA-256',
hashAlg: 'sha-256',
saltGenerator: generateSalt,
});

Expand Down
22 changes: 21 additions & 1 deletion packages/types/src/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,30 @@ export type Base64urlString = string;

export type DisclosureData<T> = [string, string, T] | [string, T];

// based on https://www.iana.org/assignments/named-information/named-information.xhtml
export type HashAlgorithm =
| 'sha-256'
| 'sha-256-128'
| 'sha-256-120'
| 'sha-256-96'
| 'sha-256-64'
| 'sha-256-32'
| 'sha-384'
| 'sha-512'
| 'sha3-224'
| 'sha3-256'
| 'sha3-384'
| 'sha3-512'
| 'blake2s-256'
| 'blake2b-256'
| 'blake2b-512'
| 'k12-256'
| 'k12-512';

export type SDJWTConfig = {
omitTyp?: boolean;
hasher?: Hasher;
hashAlg?: string;
hashAlg?: HashAlgorithm;
saltGenerator?: SaltGenerator;
signer?: Signer;
signAlg?: string;
Expand Down
Loading