@credo-ts/core
Version:
<p align="center"> <br /> <img alt="Credo Logo" src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png" height="250px" /> </p> <h1 align="center"><b>Credo - Core</b></h1
127 lines (126 loc) • 5.5 kB
JavaScript
import { CREDENTIALS_CONTEXT_V1_URL, SECURITY_CONTEXT_URL, SECURITY_ED25519_2018_CONTEXT_URL } from "../../constants.mjs";
import { DEFAULT_CONTEXTS } from "../../jsonld/contexts/defaultContexts.mjs";
import jsonld_default from "../../jsonld/jsonld.mjs";
import { _includesContext } from "../proof-ops/jsonldUtil.mjs";
import { JwsLinkedDataSignature } from "./JwsLinkedDataSignature.mjs";
//#region src/modules/vc/linked-data-proofs/signature-suites/Ed25519Signature2018.ts
const jsonldWithHasValue = jsonld_default;
var Ed25519Signature2018 = class Ed25519Signature2018 extends 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: Ed25519Signature2018.CONTEXT_URL,
key: options.key,
proof: options.proof,
date: options.date,
useNativeCanonize: options.useNativeCanonize
});
this.requiredKeyType = "Ed25519VerificationKey2018";
}
async assertVerificationMethod(document) {
if (!_includesCompatibleContext({ document })) throw new TypeError(`The '@context' of the verification method (key) MUST contain the context url "${this.contextUrl}".`);
if (!_isEd2018Key(document)) {
const verificationMethodType = jsonld_default.getValues(document, "type")[0];
throw new Error(`Unsupported verification method type '${verificationMethodType}' for proof type '${this.type}'. Verification method type MUST be '${this.requiredKeyType}'.`);
}
if (document.revoked !== void 0) throw new Error("The verification method has been revoked.");
}
/**
* 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
});
}
};
Ed25519Signature2018.CONTEXT_URL = SECURITY_ED25519_2018_CONTEXT_URL;
Ed25519Signature2018.CONTEXT = DEFAULT_CONTEXTS[SECURITY_ED25519_2018_CONTEXT_URL];
function _includesCompatibleContext(options) {
const hasEd2018 = _includesContext({
document: options.document,
contextUrl: Ed25519Signature2018.CONTEXT_URL
});
const hasCred = _includesContext({
document: options.document,
contextUrl: CREDENTIALS_CONTEXT_V1_URL
});
const hasSecV2 = _includesContext({
document: options.document,
contextUrl: SECURITY_CONTEXT_URL
});
if (hasEd2018 && hasCred) return false;
if (hasEd2018 && hasSecV2) return false;
return hasEd2018 || hasCred || hasSecV2;
}
function _isEd2018Key(verificationMethod) {
return jsonldWithHasValue.hasValue(verificationMethod, "type", "Ed25519VerificationKey2018");
}
//#endregion
export { Ed25519Signature2018 };
//# sourceMappingURL=Ed25519Signature2018.mjs.map