@credo-ts/core 0.5.0-alpha.101

package/build/modules/vc/data-integrity/signature-suites/JwsLinkedDataSignature.js

@@ -0,0 +1,209 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JwsLinkedDataSignature = void 0;
+const error_1 = require("../../../../error");
+const utils_1 = require("../../../../utils");
+const jsonld_signatures_1 = require("../libraries/jsonld-signatures");
+const LinkedDataSignature = jsonld_signatures_1.suites.LinkedDataSignature;
+class JwsLinkedDataSignature extends LinkedDataSignature {
+    /**
+     * @param options - Options hashmap.
+     * @param options.type - Provided by subclass.
+     * @param options.alg - JWS alg provided by subclass.
+     * @param [options.LDKeyClass] - Provided by subclass or subclass
+     *   overrides `getVerificationMethod`.
+     *
+     * Either a `key` OR at least one of `signer`/`verifier` is required.
+     *
+     * @param [options.key] - An optional key object (containing an
+     *   `id` property, and either `signer` or `verifier`, depending on the
+     *   intended operation. Useful for when the application is managing keys
+     *   itself (when using a KMS, you never have access to the private key,
+     *   and so should use the `signer` param instead).
+     *
+     * Advanced optional parameters and overrides.
+     *
+     * @param [options.proof] - A JSON-LD document with options to use
+     *   for the `proof` node. Any other custom fields can be provided here
+     *   using a context different from `security-v2`.
+     * @param [options.date] - Signing date to use if not passed.
+     * @param options.contextUrl - JSON-LD context url that corresponds
+     *   to this signature suite. Used for enforcing suite context during the
+     *   `sign()` operation.
+     * @param [options.useNativeCanonize] - Whether to use a native
+     *   canonize algorithm.
+     */
+    constructor(options) {
+        super({
+            type: options.type,
+            LDKeyClass: options.LDKeyClass,
+            contextUrl: options.contextUrl,
+            key: options.key,
+            signer: undefined,
+            verifier: undefined,
+            proof: options.proof,
+            date: options.date,
+            useNativeCanonize: options.useNativeCanonize,
+        });
+        this.alg = options.algorithm;
+    }
+    /**
+     * @param options - Options hashmap.
+     * @param options.verifyData - The data to sign.
+     * @param options.proof - A JSON-LD document with options to use
+     *   for the `proof` node. Any other custom fields can be provided here
+     *   using a context different from `security-v2`.
+     *
+     * @returns The proof containing the signature value.
+     */
+    async sign(options) {
+        if (!(this.signer && typeof this.signer.sign === 'function')) {
+            throw new Error('A signer API has not been specified.');
+        }
+        // JWS header
+        const header = {
+            alg: this.alg,
+            b64: false,
+            crit: ['b64'],
+        };
+        /*
+        +-------+-----------------------------------------------------------+
+        | "b64" | JWS Signing Input Formula                                 |
+        +-------+-----------------------------------------------------------+
+        | true  | ASCII(BASE64URL(UTF8(JWS Protected Header)) || '.' ||     |
+        |       | BASE64URL(JWS Payload))                                   |
+        |       |                                                           |
+        | false | ASCII(BASE64URL(UTF8(JWS Protected Header)) || '.') ||    |
+        |       | JWS Payload                                               |
+        +-------+-----------------------------------------------------------+
+        */
+        // create JWS data and sign
+        const encodedHeader = utils_1.JsonEncoder.toBase64URL(header);
+        const data = _createJws({ encodedHeader, verifyData: options.verifyData });
+        const signature = await this.signer.sign({ data });
+        // create detached content signature
+        const encodedSignature = utils_1.TypedArrayEncoder.toBase64URL(signature);
+        options.proof.jws = encodedHeader + '..' + encodedSignature;
+        return options.proof;
+    }
+    /**
+     * @param options - Options hashmap.
+     * @param options.verifyData - The data to verify.
+     * @param options.verificationMethod - A verification method.
+     * @param options.proof - The proof to be verified.
+     *
+     * @returns Resolves with the verification result.
+     */
+    async verifySignature(options) {
+        if (!(options.proof.jws && typeof options.proof.jws === 'string' && options.proof.jws.includes('.'))) {
+            throw new TypeError('The proof does not include a valid "jws" property.');
+        }
+        // add payload into detached content signature
+        const [encodedHeader /*payload*/, , encodedSignature] = options.proof.jws.split('.');
+        let header;
+        try {
+            header = utils_1.JsonEncoder.fromBase64(encodedHeader);
+        }
+        catch (e) {
+            throw new Error('Could not parse JWS header; ' + e);
+        }
+        if (!(header && typeof header === 'object')) {
+            throw new Error('Invalid JWS header.');
+        }
+        // confirm header matches all expectations
+        if (!(header.alg === this.alg &&
+            header.b64 === false &&
+            Array.isArray(header.crit) &&
+            header.crit.length === 1 &&
+            header.crit[0] === 'b64') &&
+            Object.keys(header).length === 3) {
+            throw new Error(`Invalid JWS header parameters for ${this.type}.`);
+        }
+        // do signature verification
+        const signature = utils_1.TypedArrayEncoder.fromBase64(encodedSignature);
+        const data = _createJws({ encodedHeader, verifyData: options.verifyData });
+        let { verifier } = this;
+        if (!verifier) {
+            const key = await this.LDKeyClass.from(options.verificationMethod);
+            verifier = key.verifier();
+        }
+        return verifier.verify({ data, signature });
+    }
+    async getVerificationMethod(options) {
+        if (this.key) {
+            // This happens most often during sign() operations. For verify(),
+            // the expectation is that the verification method will be fetched
+            // by the documentLoader (below), not provided as a `key` parameter.
+            return this.key.export({ publicKey: true });
+        }
+        let { verificationMethod } = options.proof;
+        if (typeof verificationMethod === 'object' && verificationMethod !== null) {
+            verificationMethod = verificationMethod.id;
+        }
+        if (!verificationMethod) {
+            throw new Error('No "verificationMethod" found in proof.');
+        }
+        if (!options.documentLoader) {
+            throw new error_1.AriesFrameworkError('Missing custom document loader. This is required for resolving verification methods.');
+        }
+        const { document } = await options.documentLoader(verificationMethod);
+        verificationMethod = typeof document === 'string' ? JSON.parse(document) : document;
+        await this.assertVerificationMethod(verificationMethod);
+        return verificationMethod;
+    }
+    /**
+     * Checks whether a given proof exists in the document.
+     *
+     * @param options - Options hashmap.
+     * @param options.proof - A proof.
+     * @param options.document - A JSON-LD document.
+     * @param options.purpose - A jsonld-signatures ProofPurpose
+     *  instance (e.g. AssertionProofPurpose, AuthenticationProofPurpose, etc).
+     * @param options.documentLoader  - A secure document loader (it is
+     *   recommended to use one that provides static known documents, instead of
+     *   fetching from the web) for returning contexts, controller documents,
+     *   keys, and other relevant URLs needed for the proof.
+     *
+     * @returns Whether a match for the proof was found.
+     */
+    async matchProof(options) {
+        const proofMatches = await super.matchProof({
+            proof: options.proof,
+            document: options.document,
+            purpose: options.purpose,
+            documentLoader: options.documentLoader,
+        });
+        if (!proofMatches) {
+            return false;
+        }
+        // NOTE: When subclassing this suite: Extending suites will need to check
+        if (!this.key) {
+            // no key specified, so assume this suite matches and it can be retrieved
+            return true;
+        }
+        const { verificationMethod } = options.proof;
+        // only match if the key specified matches the one in the proof
+        if (typeof verificationMethod === 'object') {
+            return verificationMethod.id === this.key.id;
+        }
+        return verificationMethod === this.key.id;
+    }
+}
+exports.JwsLinkedDataSignature = JwsLinkedDataSignature;
+/**
+ * Creates the bytes ready for signing.
+ *
+ * @param {object} options -  Options hashmap.
+ * @param {string} options.encodedHeader - A base64url encoded JWT header.
+ * @param {Uint8Array} options.verifyData - Payload to sign/verify.
+ * @returns {Uint8Array} A combined byte array for signing.
+ */
+function _createJws(options) {
+    const encodedHeaderBytes = utils_1.TypedArrayEncoder.fromString(options.encodedHeader + '.');
+    // concatenate the two uint8arrays
+    const data = new Uint8Array(encodedHeaderBytes.length + options.verifyData.length);
+    data.set(encodedHeaderBytes, 0);
+    data.set(options.verifyData, encodedHeaderBytes.length);
+    return data;
+}
+//# sourceMappingURL=JwsLinkedDataSignature.js.map

package/build/modules/vc/data-integrity/signature-suites/JwsLinkedDataSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JwsLinkedDataSignature.js","sourceRoot":"","sources":["../../../../../src/modules/vc/data-integrity/signature-suites/JwsLinkedDataSignature.ts"],"names":[],"mappings":";;;AAMA,6CAAuD;AACvD,6CAAkE;AAClE,sEAAuD;AAEvD,MAAM,mBAAmB,GAAG,0BAAM,CAAC,mBAAmB,CAAA;AAYtD,MAAa,sBAAuB,SAAQ,mBAAmB;IAC7D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAmB,OAAsC;QACvD,KAAK,CAAC;YACJ,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;SAC7C,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,SAAS,CAAA;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,CAAC,OAAiD;QACjE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE;YAC5D,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;SACxD;QACD,aAAa;QACb,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,GAAG,EAAE,KAAK;YACV,IAAI,EAAE,CAAC,KAAK,CAAC;SACd,CAAA;QAED;;;;;;;;;;UAUE;QAEF,2BAA2B;QAC3B,MAAM,aAAa,GAAG,mBAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAErD,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;QAE1E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;QAElD,oCAAoC;QACpC,MAAM,gBAAgB,GAAG,yBAAiB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;QACjE,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,aAAa,GAAG,IAAI,GAAG,gBAAgB,CAAA;QAC3D,OAAO,OAAO,CAAC,KAAK,CAAA;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,eAAe,CAAC,OAI5B;QACC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE;YACpG,MAAM,IAAI,SAAS,CAAC,oDAAoD,CAAC,CAAA;SAC1E;QACD,8CAA8C;QAC9C,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,AAAD,EAAG,gBAAgB,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEpF,IAAI,MAAM,CAAA;QACV,IAAI;YACF,MAAM,GAAG,mBAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;SAC/C;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,CAAC,CAAA;SACpD;QACD,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;SACvC;QAED,0CAA0C;QAC1C,IACE,CAAC,CACC,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG;YACvB,MAAM,CAAC,GAAG,KAAK,KAAK;YACpB,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CACzB;YACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAChC;YACA,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;SACnE;QAED,4BAA4B;QAC5B,MAAM,SAAS,GAAG,yBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;QAEhE,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;QAE1E,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QACvB,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;YAClE,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;SAC1B;QACD,OAAO,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;IAC7C,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAA0D;QAC3F,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,kEAAkE;YAClE,kEAAkE;YAClE,oEAAoE;YACpE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;SAC5C;QAED,IAAI,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;QAE1C,IAAI,OAAO,kBAAkB,KAAK,QAAQ,IAAI,kBAAkB,KAAK,IAAI,EAAE;YACzE,kBAAkB,GAAG,kBAAkB,CAAC,EAAE,CAAA;SAC3C;QAED,IAAI,CAAC,kBAAkB,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;YAC3B,MAAM,IAAI,2BAAmB,CAC3B,sFAAsF,CACvF,CAAA;SACF;QAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAA;QAErE,kBAAkB,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;QAEnF,MAAM,IAAI,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAA;QACvD,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,UAAU,CAAC,OAMvB;QACC,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;YAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAA;QACF,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO,KAAK,CAAA;SACb;QACD,yEAAyE;QAEzE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,yEAAyE;YACzE,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;QAE5C,+DAA+D;QAC/D,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;YAC1C,OAAO,kBAAkB,CAAC,EAAE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;SAC7C;QACD,OAAO,kBAAkB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC3C,CAAC;CACF;AA9ND,wDA8NC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,OAA0D;IAC5E,MAAM,kBAAkB,GAAG,yBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC,CAAA;IAEpF,kCAAkC;IAClC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;IAClF,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAA;IAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACvD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/build/modules/vc/data-integrity/signature-suites/ed25519/Ed25519Signature2018.d.ts

@@ -0,0 +1,80 @@
+import type { DocumentLoader, JsonLdDoc, Proof, VerificationMethod } from '../../jsonldUtil';
+import type { JwsLinkedDataSignatureOptions } from '../JwsLinkedDataSignature';
+import { JwsLinkedDataSignature } from '../JwsLinkedDataSignature';
+type Ed25519Signature2018Options = Pick<JwsLinkedDataSignatureOptions, 'key' | 'proof' | 'date' | 'useNativeCanonize' | 'LDKeyClass'>;
+export declare class Ed25519Signature2018 extends JwsLinkedDataSignature {
+    static CONTEXT_URL: string;
+    static CONTEXT: any;
+    /**
+     * @param {object} options - Options hashmap.
+     *
+     * Either a `key` OR at least one of `signer`/`verifier` is required.
+     *
+     * @param {object} [options.key] - An optional key object (containing an
+     *   `id` property, and either `signer` or `verifier`, depending on the
+     *   intended operation. Useful for when the application is managing keys
+     *   itself (when using a KMS, you never have access to the private key,
+     *   and so should use the `signer` param instead).
+     * @param {Function} [options.signer] - Signer function that returns an
+     *   object with an async sign() method. This is useful when interfacing
+     *   with a KMS (since you don't get access to the private key and its
+     *   `signer()`, the KMS client gives you only the signer function to use).
+     * @param {Function} [options.verifier] - Verifier function that returns
+     *   an object with an async `verify()` method. Useful when working with a
+     *   KMS-provided verifier function.
+     *
+     * Advanced optional parameters and overrides.
+     *
+     * @param {object} [options.proof] - A JSON-LD document with options to use
+     *   for the `proof` node. Any other custom fields can be provided here
+     *   using a context different from security-v2).
+     * @param {string|Date} [options.date] - Signing date to use if not passed.
+     * @param {boolean} [options.useNativeCanonize] - Whether to use a native
+     *   canonize algorithm.
+     */
+    constructor(options: Ed25519Signature2018Options);
+    assertVerificationMethod(document: JsonLdDoc): Promise<void>;
+    getVerificationMethod(options: {
+        proof: Proof;
+        documentLoader?: DocumentLoader;
+    }): Promise<any>;
+    /**
+     * Ensures the document to be signed contains the required signature suite
+     * specific `@context`, by either adding it (if `addSuiteContext` is true),
+     * or throwing an error if it's missing.
+     *
+     * @override
+     *
+     * @param {object} options - Options hashmap.
+     * @param {object} options.document - JSON-LD document to be signed.
+     * @param {boolean} options.addSuiteContext - Add suite context?
+     */
+    ensureSuiteContext(options: {
+        document: JsonLdDoc;
+        addSuiteContext: boolean;
+    }): void;
+    /**
+     * Checks whether a given proof exists in the document.
+     *
+     * @override
+     *
+     * @param {object} options - Options hashmap.
+     * @param {object} options.proof - A proof.
+     * @param {object} options.document - A JSON-LD document.
+     * @param {object} options.purpose - A jsonld-signatures ProofPurpose
+     *  instance (e.g. AssertionProofPurpose, AuthenticationProofPurpose, etc).
+     * @param {Function} options.documentLoader  - A secure document loader (it is
+     *   recommended to use one that provides static known documents, instead of
+     *   fetching from the web) for returning contexts, controller documents,
+     *   keys, and other relevant URLs needed for the proof.
+     *
+     * @returns {Promise<boolean>} Whether a match for the proof was found.
+     */
+    matchProof(options: {
+        proof: Proof;
+        document: VerificationMethod;
+        purpose: any;
+        documentLoader?: DocumentLoader;
+    }): Promise<boolean>;
+}
+export {};

package/build/modules/vc/data-integrity/signature-suites/ed25519/Ed25519Signature2018.js

@@ -0,0 +1,190 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ed25519Signature2018 = void 0;
+const utils_1 = require("../../../../../utils");
+const constants_1 = require("../../../constants");
+const jsonldUtil_1 = require("../../jsonldUtil");
+const jsonld_1 = __importDefault(require("../../libraries/jsonld"));
+const JwsLinkedDataSignature_1 = require("../JwsLinkedDataSignature");
+const constants_2 = require("./constants");
+const context_1 = require("./context");
+class Ed25519Signature2018 extends JwsLinkedDataSignature_1.JwsLinkedDataSignature {
+    /**
+     * @param {object} options - Options hashmap.
+     *
+     * Either a `key` OR at least one of `signer`/`verifier` is required.
+     *
+     * @param {object} [options.key] - An optional key object (containing an
+     *   `id` property, and either `signer` or `verifier`, depending on the
+     *   intended operation. Useful for when the application is managing keys
+     *   itself (when using a KMS, you never have access to the private key,
+     *   and so should use the `signer` param instead).
+     * @param {Function} [options.signer] - Signer function that returns an
+     *   object with an async sign() method. This is useful when interfacing
+     *   with a KMS (since you don't get access to the private key and its
+     *   `signer()`, the KMS client gives you only the signer function to use).
+     * @param {Function} [options.verifier] - Verifier function that returns
+     *   an object with an async `verify()` method. Useful when working with a
+     *   KMS-provided verifier function.
+     *
+     * Advanced optional parameters and overrides.
+     *
+     * @param {object} [options.proof] - A JSON-LD document with options to use
+     *   for the `proof` node. Any other custom fields can be provided here
+     *   using a context different from security-v2).
+     * @param {string|Date} [options.date] - Signing date to use if not passed.
+     * @param {boolean} [options.useNativeCanonize] - Whether to use a native
+     *   canonize algorithm.
+     */
+    constructor(options) {
+        super({
+            type: 'Ed25519Signature2018',
+            algorithm: 'EdDSA',
+            LDKeyClass: options.LDKeyClass,
+            contextUrl: constants_2.ED25519_SUITE_CONTEXT_URL_2018,
+            key: options.key,
+            proof: options.proof,
+            date: options.date,
+            useNativeCanonize: options.useNativeCanonize,
+        });
+        this.requiredKeyType = 'Ed25519VerificationKey2018';
+    }
+    async assertVerificationMethod(document) {
+        if (!_includesCompatibleContext({ document: document })) {
+            // For DID Documents, since keys do not have their own contexts,
+            // the suite context is usually provided by the documentLoader logic
+            throw new TypeError(`The '@context' of the verification method (key) MUST contain the context url "${this.contextUrl}".`);
+        }
+        if (!_isEd2018Key(document) && !_isEd2020Key(document)) {
+            const verificationMethodType = jsonld_1.default.getValues(document, 'type')[0];
+            throw new Error(`Unsupported verification method type '${verificationMethodType}'. Verification method type MUST be 'Ed25519VerificationKey2018' or 'Ed25519VerificationKey2020'.`);
+        }
+        else if (_isEd2018Key(document) && !_includesEd2018Context(document)) {
+            throw new Error(`For verification method type 'Ed25519VerificationKey2018' the '@context' MUST contain the context url "${constants_2.ED25519_SUITE_CONTEXT_URL_2018}".`);
+        }
+        else if (_isEd2020Key(document) && !_includesEd2020Context(document)) {
+            throw new Error(`For verification method type 'Ed25519VerificationKey2020' the '@context' MUST contain the context url "${constants_2.ED25519_SUITE_CONTEXT_URL_2020}".`);
+        }
+        // ensure verification method has not been revoked
+        if (document.revoked !== undefined) {
+            throw new Error('The verification method has been revoked.');
+        }
+    }
+    async getVerificationMethod(options) {
+        let verificationMethod = await super.getVerificationMethod({
+            proof: options.proof,
+            documentLoader: options.documentLoader,
+        });
+        // convert Ed25519VerificationKey2020 to Ed25519VerificationKey2018
+        if (_isEd2020Key(verificationMethod) && _includesEd2020Context(verificationMethod)) {
+            // -- convert multibase to base58 --
+            const publicKeyBuffer = utils_1.MultiBaseEncoder.decode(verificationMethod.publicKeyMultibase);
+            // -- update context --
+            // remove 2020 context
+            const context2020Index = verificationMethod['@context'].indexOf(constants_2.ED25519_SUITE_CONTEXT_URL_2020);
+            verificationMethod['@context'].splice(context2020Index, 1);
+            // add 2018 context
+            verificationMethod['@context'].push(constants_2.ED25519_SUITE_CONTEXT_URL_2018);
+            // -- update type
+            verificationMethod.type = 'Ed25519VerificationKey2018';
+            verificationMethod = Object.assign(Object.assign({}, verificationMethod), { publicKeyMultibase: undefined, publicKeyBase58: utils_1.TypedArrayEncoder.toBase58(publicKeyBuffer.data) });
+        }
+        return verificationMethod;
+    }
+    /**
+     * Ensures the document to be signed contains the required signature suite
+     * specific `@context`, by either adding it (if `addSuiteContext` is true),
+     * or throwing an error if it's missing.
+     *
+     * @override
+     *
+     * @param {object} options - Options hashmap.
+     * @param {object} options.document - JSON-LD document to be signed.
+     * @param {boolean} options.addSuiteContext - Add suite context?
+     */
+    ensureSuiteContext(options) {
+        if (_includesCompatibleContext({ document: options.document })) {
+            return;
+        }
+        super.ensureSuiteContext({ document: options.document, addSuiteContext: options.addSuiteContext });
+    }
+    /**
+     * Checks whether a given proof exists in the document.
+     *
+     * @override
+     *
+     * @param {object} options - Options hashmap.
+     * @param {object} options.proof - A proof.
+     * @param {object} options.document - A JSON-LD document.
+     * @param {object} options.purpose - A jsonld-signatures ProofPurpose
+     *  instance (e.g. AssertionProofPurpose, AuthenticationProofPurpose, etc).
+     * @param {Function} options.documentLoader  - A secure document loader (it is
+     *   recommended to use one that provides static known documents, instead of
+     *   fetching from the web) for returning contexts, controller documents,
+     *   keys, and other relevant URLs needed for the proof.
+     *
+     * @returns {Promise<boolean>} Whether a match for the proof was found.
+     */
+    async matchProof(options) {
+        if (!_includesCompatibleContext({ document: options.document })) {
+            return false;
+        }
+        return super.matchProof({
+            proof: options.proof,
+            document: options.document,
+            purpose: options.purpose,
+            documentLoader: options.documentLoader,
+        });
+    }
+}
+exports.Ed25519Signature2018 = Ed25519Signature2018;
+Ed25519Signature2018.CONTEXT_URL = constants_2.ED25519_SUITE_CONTEXT_URL_2018;
+Ed25519Signature2018.CONTEXT = context_1.ed25519Signature2018Context.get(constants_2.ED25519_SUITE_CONTEXT_URL_2018);
+function _includesCompatibleContext(options) {
+    // Handle the unfortunate Ed25519Signature2018 / credentials/v1 collision
+    const hasEd2018 = (0, jsonldUtil_1._includesContext)({
+        document: options.document,
+        contextUrl: constants_2.ED25519_SUITE_CONTEXT_URL_2018,
+    });
+    const hasEd2020 = (0, jsonldUtil_1._includesContext)({
+        document: options.document,
+        contextUrl: constants_2.ED25519_SUITE_CONTEXT_URL_2020,
+    });
+    const hasCred = (0, jsonldUtil_1._includesContext)({ document: options.document, contextUrl: constants_1.CREDENTIALS_CONTEXT_V1_URL });
+    const hasSecV2 = (0, jsonldUtil_1._includesContext)({ document: options.document, contextUrl: constants_1.SECURITY_CONTEXT_URL });
+    // TODO: the console.warn statements below should probably be replaced with logging statements. However, this would currently require injection and I'm not sure we want to do that.
+    if (hasEd2018 && hasCred) {
+        // Warn if both are present
+        // console.warn('Warning: The ed25519-2018/v1 and credentials/v1 ' + 'contexts are incompatible.')
+        // console.warn('For VCs using Ed25519Signature2018 suite,' + ' using the credentials/v1 context is sufficient.')
+        return false;
+    }
+    if (hasEd2018 && hasSecV2) {
+        // Warn if both are present
+        // console.warn('Warning: The ed25519-2018/v1 and security/v2 ' + 'contexts are incompatible.')
+        // console.warn('For VCs using Ed25519Signature2018 suite,' + ' using the security/v2 context is sufficient.')
+        return false;
+    }
+    // Either one by itself is fine, for this suite
+    return hasEd2018 || hasEd2020 || hasCred || hasSecV2;
+}
+function _isEd2018Key(verificationMethod) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - .hasValue is not part of the public API
+    return jsonld_1.default.hasValue(verificationMethod, 'type', 'Ed25519VerificationKey2018');
+}
+function _includesEd2018Context(document) {
+    return (0, jsonldUtil_1._includesContext)({ document, contextUrl: constants_2.ED25519_SUITE_CONTEXT_URL_2018 });
+}
+function _isEd2020Key(verificationMethod) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - .hasValue is not part of the public API
+    return jsonld_1.default.hasValue(verificationMethod, 'type', 'Ed25519VerificationKey2020');
+}
+function _includesEd2020Context(document) {
+    return (0, jsonldUtil_1._includesContext)({ document, contextUrl: constants_2.ED25519_SUITE_CONTEXT_URL_2020 });
+}
+//# sourceMappingURL=Ed25519Signature2018.js.map

package/build/modules/vc/data-integrity/signature-suites/ed25519/Ed25519Signature2018.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Ed25519Signature2018.js","sourceRoot":"","sources":["../../../../../../src/modules/vc/data-integrity/signature-suites/ed25519/Ed25519Signature2018.ts"],"names":[],"mappings":";;;;;;AAGA,gDAA0E;AAC1E,kDAAqF;AACrF,iDAAmD;AACnD,oEAA2C;AAC3C,sEAAkE;AAElE,2CAA4F;AAC5F,uCAAuD;AAOvD,MAAa,oBAAqB,SAAQ,+CAAsB;IAI9D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAmB,OAAoC;QACrD,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAsB;YAC5B,SAAS,EAAE,OAAO;YAClB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,UAAU,EAAE,0CAA8B;YAC1C,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;SAC7C,CAAC,CAAA;QACF,IAAI,CAAC,eAAe,GAAG,4BAA4B,CAAA;IACrD,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,QAAmB;QACvD,IAAI,CAAC,0BAA0B,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE;YACvD,gEAAgE;YAChE,oEAAoE;YACpE,MAAM,IAAI,SAAS,CACjB,iFAAiF,IAAI,CAAC,UAAU,IAAI,CACrG,CAAA;SACF;QAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;YACtD,MAAM,sBAAsB,GAAG,gBAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YACpE,MAAM,IAAI,KAAK,CACb,yCAAyC,sBAAsB,mGAAmG,CACnK,CAAA;SACF;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE;YACtE,MAAM,IAAI,KAAK,CACb,0GAA0G,0CAA8B,IAAI,CAC7I,CAAA;SACF;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE;YACtE,MAAM,IAAI,KAAK,CACb,0GAA0G,0CAA8B,IAAI,CAC7I,CAAA;SACF;QAED,kDAAkD;QAClD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;SAC7D;IACH,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,OAA0D;QAC3F,IAAI,kBAAkB,GAAG,MAAM,KAAK,CAAC,qBAAqB,CAAC;YACzD,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAA;QAEF,mEAAmE;QACnE,IAAI,YAAY,CAAC,kBAAkB,CAAC,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,EAAE;YAClF,oCAAoC;YACpC,MAAM,eAAe,GAAG,wBAAgB,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;YAEtF,uBAAuB;YACvB,sBAAsB;YACtB,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,0CAA8B,CAAC,CAAA;YAC/F,kBAAkB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAA;YAE1D,mBAAmB;YACnB,kBAAkB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,0CAA8B,CAAC,CAAA;YAEnE,iBAAiB;YACjB,kBAAkB,CAAC,IAAI,GAAG,4BAA4B,CAAA;YAEtD,kBAAkB,mCACb,kBAAkB,KACrB,kBAAkB,EAAE,SAAS,EAC7B,eAAe,EAAE,yBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,GAClE,CAAA;SACF;QAED,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACI,kBAAkB,CAAC,OAA0D;QAClF,IAAI,0BAA0B,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC9D,OAAM;SACP;QAED,KAAK,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IACpG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,UAAU,CAAC,OAMvB;QACC,IAAI,CAAC,0BAA0B,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC/D,OAAO,KAAK,CAAA;SACb;QACD,OAAO,KAAK,CAAC,UAAU,CAAC;YACtB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAA;IACJ,CAAC;;AA/JH,oDAgKC;AA/Je,gCAAW,GAAG,0CAA8B,CAAA;AAC5C,4BAAO,GAAG,qCAA2B,CAAC,GAAG,CAAC,0CAA8B,CAAC,CAAA;AAgKzF,SAAS,0BAA0B,CAAC,OAAgC;IAClE,yEAAyE;IACzE,MAAM,SAAS,GAAG,IAAA,6BAAgB,EAAC;QACjC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,0CAA8B;KAC3C,CAAC,CAAA;IACF,MAAM,SAAS,GAAG,IAAA,6BAAgB,EAAC;QACjC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,0CAA8B;KAC3C,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,IAAA,6BAAgB,EAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,sCAA0B,EAAE,CAAC,CAAA;IACxG,MAAM,QAAQ,GAAG,IAAA,6BAAgB,EAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,gCAAoB,EAAE,CAAC,CAAA;IAEnG,oLAAoL;IACpL,IAAI,SAAS,IAAI,OAAO,EAAE;QACxB,2BAA2B;QAC3B,kGAAkG;QAClG,iHAAiH;QACjH,OAAO,KAAK,CAAA;KACb;IAED,IAAI,SAAS,IAAI,QAAQ,EAAE;QACzB,2BAA2B;QAC3B,+FAA+F;QAC/F,8GAA8G;QAC9G,OAAO,KAAK,CAAA;KACb;IAED,+CAA+C;IAC/C,OAAO,SAAS,IAAI,SAAS,IAAI,OAAO,IAAI,QAAQ,CAAA;AACtD,CAAC;AAED,SAAS,YAAY,CAAC,kBAA6B;IACjD,6DAA6D;IAC7D,uDAAuD;IACvD,OAAO,gBAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,4BAA4B,CAAC,CAAA;AAClF,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAmB;IACjD,OAAO,IAAA,6BAAgB,EAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,0CAA8B,EAAE,CAAC,CAAA;AACnF,CAAC;AAED,SAAS,YAAY,CAAC,kBAA6B;IACjD,6DAA6D;IAC7D,uDAAuD;IACvD,OAAO,gBAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,4BAA4B,CAAC,CAAA;AAClF,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAmB;IACjD,OAAO,IAAA,6BAAgB,EAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,0CAA8B,EAAE,CAAC,CAAA;AACnF,CAAC"}

package/build/modules/vc/data-integrity/signature-suites/ed25519/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ED25519_SUITE_CONTEXT_URL_2018 = "https://w3id.org/security/suites/ed25519-2018/v1";
+export declare const ED25519_SUITE_CONTEXT_URL_2020 = "https://w3id.org/security/suites/ed25519-2020/v1";

package/build/modules/vc/data-integrity/signature-suites/ed25519/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ED25519_SUITE_CONTEXT_URL_2020 = exports.ED25519_SUITE_CONTEXT_URL_2018 = void 0;
+exports.ED25519_SUITE_CONTEXT_URL_2018 = 'https://w3id.org/security/suites/ed25519-2018/v1';
+exports.ED25519_SUITE_CONTEXT_URL_2020 = 'https://w3id.org/security/suites/ed25519-2020/v1';
+//# sourceMappingURL=constants.js.map

package/build/modules/vc/data-integrity/signature-suites/ed25519/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../../src/modules/vc/data-integrity/signature-suites/ed25519/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,8BAA8B,GAAG,kDAAkD,CAAA;AACnF,QAAA,8BAA8B,GAAG,kDAAkD,CAAA"}

package/build/modules/vc/data-integrity/signature-suites/ed25519/context.d.ts

@@ -0,0 +1,93 @@
+export declare const context: {
+    '@context': {
+        id: string;
+        type: string;
+        '@protected': boolean;
+        proof: {
+            '@id': string;
+            '@type': string;
+            '@container': string;
+        };
+        Ed25519VerificationKey2018: {
+            '@id': string;
+            '@context': {
+                '@protected': boolean;
+                id: string;
+                type: string;
+                controller: {
+                    '@id': string;
+                    '@type': string;
+                };
+                revoked: {
+                    '@id': string;
+                    '@type': string;
+                };
+                publicKeyBase58: {
+                    '@id': string;
+                };
+            };
+        };
+        Ed25519Signature2018: {
+            '@id': string;
+            '@context': {
+                '@protected': boolean;
+                id: string;
+                type: string;
+                challenge: string;
+                created: {
+                    '@id': string;
+                    '@type': string;
+                };
+                domain: string;
+                expires: {
+                    '@id': string;
+                    '@type': string;
+                };
+                nonce: string;
+                proofPurpose: {
+                    '@id': string;
+                    '@type': string;
+                    '@context': {
+                        '@protected': boolean;
+                        id: string;
+                        type: string;
+                        assertionMethod: {
+                            '@id': string;
+                            '@type': string;
+                            '@container': string;
+                        };
+                        authentication: {
+                            '@id': string;
+                            '@type': string;
+                            '@container': string;
+                        };
+                        capabilityInvocation: {
+                            '@id': string;
+                            '@type': string;
+                            '@container': string;
+                        };
+                        capabilityDelegation: {
+                            '@id': string;
+                            '@type': string;
+                            '@container': string;
+                        };
+                        keyAgreement: {
+                            '@id': string;
+                            '@type': string;
+                            '@container': string;
+                        };
+                    };
+                };
+                jws: {
+                    '@id': string;
+                };
+                verificationMethod: {
+                    '@id': string;
+                    '@type': string;
+                };
+            };
+        };
+    };
+};
+declare const ed25519Signature2018Context: Map<any, any>;
+export { ed25519Signature2018Context };