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.

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

Add COSE Hash Envelope #17

Merged
merged 1 commit into from
Aug 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 14 additions & 2 deletions src/cose/Params.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ export const PartyVOther = -26

export const ContentType = 3

export const ProofType = -111
export const ProofType = 395

export const PayloadLocation = -6801;
export const PayloadPreImageContentType = -6802;
export const PayloadHashAlgorithm = -6800;

export const Protected = {
...HeaderParameters,
Expand All @@ -42,7 +45,11 @@ export const Protected = {
PartyVNonce,
PartyVOther,
ContentType,
ProofType // new from COSE Merkle Tree Proofs
ProofType, // new from COSE Merkle Tree Proofs

PayloadHashAlgorithm, // new COSE Hash Envelop
PayloadPreImageContentType,
PayloadLocation,
}

export const Unprotected = {
Expand All @@ -57,6 +64,11 @@ export const Aead = {
A128GCM
}


export const Hash = {
'SHA256': -16
}

export const Signature = {
'ES256': -7
}
Expand Down
10 changes: 5 additions & 5 deletions src/cose/receipt/consistency/issue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export type RequestIssueConsistencyReceipt = {

export const issue = async (req: RequestIssueConsistencyReceipt) => {
const { protectedHeader, receipt, entries, signer } = req;
const consistencyVds = protectedHeader.get(-111)
const consistencyVds = protectedHeader.get(395)
if (consistencyVds !== 1) {
throw new Error('Unsupported verifiable data structure. See https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs')
}
Expand All @@ -27,12 +27,12 @@ export const issue = async (req: RequestIssueConsistencyReceipt) => {

const [protectedHeaderBytes, unprotectedHeaderMap, payload] = value
const receiptProtectedHeader = cbor.decode(protectedHeaderBytes)
const inclusionVds = receiptProtectedHeader.get(-111);
const inclusionVds = receiptProtectedHeader.get(395);
if (inclusionVds !== 1) {
throw new Error('Unsupported verifiable data structure. See https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs')
}

const [inclusion] = unprotectedHeaderMap.get(-222).get(-1) // get first inclusion proof
const [inclusion] = unprotectedHeaderMap.get(396).get(-1) // get first inclusion proof
if (payload !== null) {
throw new Error('payload must be null for this type of proof')
}
Expand All @@ -51,7 +51,7 @@ export const issue = async (req: RequestIssueConsistencyReceipt) => {
const root = await CoMETRE.RFC9162_SHA256.root(entries)

const proofs = new Map();
proofs.set(-2, [ // -2 is consistency proof for -111 (vds), 1 (RFC9162)
proofs.set(-2, [ // -2 is consistency proof for 395 (vds), 1 (RFC9162)
cbor.encode([
consistency_proof.tree_size_1,
consistency_proof.tree_size_2,
Expand All @@ -60,7 +60,7 @@ export const issue = async (req: RequestIssueConsistencyReceipt) => {
])

const unprotectedHeader = new Map();
unprotectedHeader.set(-222, proofs)
unprotectedHeader.set(396, proofs)

const consistency = await signer.sign({
protectedHeader,
Expand Down
4 changes: 2 additions & 2 deletions src/cose/receipt/consistency/verify.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ export const verify = async (req: RequestVerifyConsistencyReceipt) => {
}
const [protectedHeaderBytes, unprotectedHeaderMap, payload] = value
const protectedHeader = cbor.decode(protectedHeaderBytes)
const vds = protectedHeader.get(-111);
const vds = protectedHeader.get(395);
if (vds !== 1) {
throw new Error('Unsupported verifiable data structure. See https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs')
}
const proofs = unprotectedHeaderMap.get(-222)
const proofs = unprotectedHeaderMap.get(396)
const [consistency] = proofs.get(-2) // get first consistency proof
if (payload !== null) {
throw new Error('payload must be null for this type of proof')
Expand Down
6 changes: 3 additions & 3 deletions src/cose/receipt/inclusion/issue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export type RequestIssueInclusionReceipt = {

export const issue = async (req: RequestIssueInclusionReceipt) => {
const { protectedHeader, entry, entries, signer } = req;
const vds = protectedHeader.get(-111)
const vds = protectedHeader.get(395)
if (vds !== 1) {
throw new Error('Unsupported verifiable data structure. See https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs')
}
Expand All @@ -24,15 +24,15 @@ export const issue = async (req: RequestIssueInclusionReceipt) => {
entries,
)
const proofs = new Map();
proofs.set(-1, [ // -1 is inclusion proof for -111 (vds), 1 (RFC9162)
proofs.set(-1, [ // -1 is inclusion proof for 395 (vds), 1 (RFC9162)
cbor.encode([ // encoded proof
proof.tree_size,
proof.leaf_index,
proof.inclusion_path.map(cbor.toArrayBuffer),
])
])
const unprotectedHeader = new Map();
unprotectedHeader.set(-222, proofs)
unprotectedHeader.set(396, proofs)
return signer.sign({
protectedHeader,
unprotectedHeader,
Expand Down
4 changes: 2 additions & 2 deletions src/cose/receipt/inclusion/verify.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ export const verify = async (req: RequestVerifyInclusionReceipt) => {
}
const [protectedHeaderBytes, unprotectedHeaderMap, payload] = value
const protectedHeader = cbor.decode(protectedHeaderBytes)
const vds = protectedHeader.get(-111);
const vds = protectedHeader.get(395);
if (vds !== 1) {
throw new Error('Unsupported verifiable data structure. See https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs')
}
const proofs = unprotectedHeaderMap.get(-222)
const proofs = unprotectedHeaderMap.get(396)
const [inclusion] = proofs.get(-1) // get first inclusion proof
if (payload !== null) {
throw new Error('payload must be null for this type of proof')
Expand Down
28 changes: 28 additions & 0 deletions src/cose/sign1/hashEnvelopeSigner.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import signer from "./signer";

import subtleCryptoProvider from "../../crypto/subtleCryptoProvider";

import { RequestCoseSign1Signer, RequestCoseSign1 } from "./types"

// https://datatracker.ietf.org/doc/draft-steele-cose-hash-envelope/


import { Protected } from "../Params";


export const hash = {
signer: ({ remote }: RequestCoseSign1Signer) => {
return {
sign: async ({ protectedHeader, unprotectedHeader, payload }: RequestCoseSign1): Promise<Uint8Array> => {
const subtle = await subtleCryptoProvider();
const hashEnvelopeAlgorithm = protectedHeader.get(Protected.PayloadHashAlgorithm)
if (hashEnvelopeAlgorithm !== -16) {
throw new Error('Unsupported hash envelope algorithm (-16 is only one supported)')
}
const payloadHash = await subtle.digest("SHA-256", payload)
const normalSigner = signer({ remote })
return new Uint8Array(await normalSigner.sign({ protectedHeader, unprotectedHeader, payload: payloadHash }))
}
}
}
}
3 changes: 2 additions & 1 deletion src/cose/sign1/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@

import signer from "./signer";
import verifier from "./verifier";
import { hash } from './hashEnvelopeSigner'

export * from './types'

export { signer, verifier }
export { signer, verifier, hash }
Loading