@enbox/dwn-sdk-js 0.0.6 → 0.0.8

package/dist/esm/src/interfaces/records-write-signing.js

@@ -0,0 +1,81 @@
+import { Cid } from '../utils/cid.js';
+import { Encoder } from '../utils/encoder.js';
+import { Encryption } from '../utils/encryption.js';
+import { GeneralJwsBuilder } from '../jose/jws/general/builder.js';
+import { Jws } from '../utils/jws.js';
+import { removeUndefinedProperties } from '../utils/object.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+/**
+ * Creates the JWE `encryption` property if encryption input is given. Else `undefined` is returned.
+ * Uses ECDH-ES+A256KW key agreement with X25519 and AEAD content encryption (A256GCM or XC20P).
+ * @param encryptionInput The encryption input containing CEK, IV, authentication tag, and recipient key encryption inputs.
+ */
+export async function createEncryptionProperty(encryptionInput) {
+    if (encryptionInput === undefined) {
+        return undefined;
+    }
+    // Build the JWE structure. The authentication tag comes from the AEAD encryption of record data.
+    const jwe = await Encryption.buildJwe(encryptionInput, encryptionInput.authenticationTag);
+    return jwe;
+}
+/**
+ * Creates the `attestation` property of a RecordsWrite message if given signature inputs; returns `undefined` otherwise.
+ */
+export async function createAttestation(descriptorCid, signers) {
+    if (signers === undefined || signers.length === 0) {
+        return undefined;
+    }
+    const attestationPayload = { descriptorCid };
+    const attestationPayloadBytes = Encoder.objectToBytes(attestationPayload);
+    const builder = await GeneralJwsBuilder.create(attestationPayloadBytes, signers);
+    return builder.getJws();
+}
+/**
+ * Creates the `signature` property in the `authorization` of a `RecordsWrite` message.
+ */
+export async function createSignerSignature(input) {
+    const { recordId, contextId, descriptorCid, attestation, encryption, signer, delegatedGrantId, permissionGrantId, protocolRole } = input;
+    const attestationCid = attestation ? await Cid.computeCid(attestation) : undefined;
+    const encryptionCid = encryption ? await Cid.computeCid(encryption) : undefined;
+    const signaturePayload = {
+        recordId,
+        descriptorCid,
+        contextId,
+        attestationCid,
+        encryptionCid,
+        delegatedGrantId,
+        permissionGrantId,
+        protocolRole
+    };
+    removeUndefinedProperties(signaturePayload);
+    const signaturePayloadBytes = Encoder.objectToBytes(signaturePayload);
+    const builder = await GeneralJwsBuilder.create(signaturePayloadBytes, [signer]);
+    const signature = builder.getJws();
+    return signature;
+}
+/**
+ * Validates the structural integrity of the `attestation` property.
+ * NOTE: Cryptographic verification of attestation signatures is performed in `authenticate()`.
+ */
+export async function validateAttestationIntegrity(message) {
+    if (message.attestation === undefined) {
+        return;
+    }
+    // TODO: support multiple attesters (https://github.com/enboxorg/enbox/issues/223)
+    if (message.attestation.signatures.length !== 1) {
+        throw new DwnError(DwnErrorCode.RecordsWriteAttestationIntegrityMoreThanOneSignature, `Currently implementation only supports 1 attester, but got ${message.attestation.signatures.length}`);
+    }
+    const payloadJson = Jws.decodePlainObjectPayload(message.attestation);
+    const { descriptorCid } = payloadJson;
+    // `descriptorCid` validation - ensure that the provided descriptorCid matches the CID of the actual message
+    const expectedDescriptorCid = await Cid.computeCid(message.descriptor);
+    if (descriptorCid !== expectedDescriptorCid) {
+        throw new DwnError(DwnErrorCode.RecordsWriteAttestationIntegrityDescriptorCidMismatch, `descriptorCid ${descriptorCid} does not match expected descriptorCid ${expectedDescriptorCid}`);
+    }
+    // check to ensure that no other unexpected properties exist in payload.
+    const propertyCount = Object.keys(payloadJson).length;
+    if (propertyCount > 1) {
+        throw new DwnError(DwnErrorCode.RecordsWriteAttestationIntegrityInvalidPayloadProperty, `Only 'descriptorCid' is allowed in attestation payload, but got ${propertyCount} properties.`);
+    }
+}
+//# sourceMappingURL=records-write-signing.js.map

package/dist/esm/src/interfaces/records-write-signing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records-write-signing.js","sourceRoot":"","sources":["../../../../src/interfaces/records-write-signing.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,eAA4C;IAE5C,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iGAAiG;IACjG,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC;IAE1F,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,aAAqB,EAAE,OAAyB;IACtF,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,kBAAkB,GAAmC,EAAE,aAAa,EAAE,CAAC;IAC7E,MAAM,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACjF,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,KAU3C;IACC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;IAEzI,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnF,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEhF,MAAM,gBAAgB,GAAiC;QACrD,QAAQ;QACR,aAAa;QACb,SAAS;QACT,cAAc;QACd,aAAa;QACb,gBAAgB;QAChB,iBAAiB;QACjB,YAAY;KACb,CAAC;IACF,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IAE5C,MAAM,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAEtE,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAChF,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAEnC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,OAA4B;IAC7E,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO;IACT,CAAC;IAED,kFAAkF;IAClF,IAAI,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,oDAAoD,EACjE,8DAA8D,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,CACtG,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,GAAG,CAAC,wBAAwB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACtE,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC;IAEtC,4GAA4G;IAC5G,MAAM,qBAAqB,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,IAAI,aAAa,KAAK,qBAAqB,EAAE,CAAC;QAC5C,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,qDAAqD,EAClE,iBAAiB,aAAa,0CAA0C,qBAAqB,EAAE,CAChG,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;IACtD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,sDAAsD,EACnE,mEAAmE,aAAa,cAAc,CAC/F,CAAC;IACJ,CAAC;AACH,CAAC"}