@veramo/credential-ld 3.1.1-next.10

package/src/suites/EcdsaSecp256k1RecoverySignature2020.ts

@@ -0,0 +1,83 @@
+import { RequiredAgentMethods, VeramoLdSignature } from '../ld-suites'
+import { CredentialPayload, DIDDocument, IAgentContext, IKey, TKeyType } from '@veramo/core'
+import {
+  EcdsaSecp256k1RecoveryMethod2020,
+  EcdsaSecp256k1RecoverySignature2020,
+} from '@transmute/lds-ecdsa-secp256k1-recovery2020'
+
+import * as u8a from 'uint8arrays'
+import { asArray, encodeJoseBlob } from '@veramo/utils'
+
+export class VeramoEcdsaSecp256k1RecoverySignature2020 extends VeramoLdSignature {
+  getSupportedVerificationType(): string {
+    return 'EcdsaSecp256k1RecoveryMethod2020'
+  }
+
+  getSupportedVeramoKeyType(): TKeyType {
+    return 'Secp256k1'
+  }
+
+  getSuiteForSigning(
+    key: IKey,
+    did: string,
+    verifiableMethodId: string,
+    context: IAgentContext<RequiredAgentMethods>,
+  ): any {
+    const controller = did
+    const signer = {
+      //returns a JWS detached
+      sign: async (args: { data: Uint8Array }): Promise<string> => {
+        const header = {
+          alg: 'ES256K-R',
+          b64: false,
+          crit: ['b64'],
+        }
+        const headerString = encodeJoseBlob(header)
+        const messageBuffer = u8a.concat([u8a.fromString(`${headerString}.`, 'utf-8'), args.data])
+        const messageString = u8a.toString(messageBuffer, 'base64')
+        const signature = await context.agent.keyManagerSign({
+          keyRef: key.kid,
+          algorithm: 'ES256K-R',
+          data: messageString,
+          encoding: 'base64',
+        })
+        return `${headerString}..${signature}`
+      },
+    }
+
+    return new EcdsaSecp256k1RecoverySignature2020({
+      // signer,
+      key: new EcdsaSecp256k1RecoveryMethod2020({
+        publicKeyHex: key.publicKeyHex,
+        signer: () => signer,
+        type: this.getSupportedVerificationType(),
+        controller,
+        id: verifiableMethodId,
+      }),
+    })
+  }
+
+  getSuiteForVerification(): any {
+    return new EcdsaSecp256k1RecoverySignature2020()
+  }
+
+  preSigningCredModification(credential: CredentialPayload): void {
+    credential['@context'] = [
+      ...asArray(credential['@context'] || []),
+      'https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/lds-ecdsa-secp256k1-recovery2020-0.0.jsonld',
+    ]
+  }
+
+  preDidResolutionModification(didUrl: string, didDoc: DIDDocument): void {
+    // did:ethr
+    if (didUrl.toLowerCase().startsWith('did:ethr')) {
+      // TODO: EcdsaSecp256k1RecoveryMethod2020 does not support blockchainAccountId
+      // blockchainAccountId to ethereumAddress
+      didDoc.verificationMethod?.forEach((x) => {
+        if (x.blockchainAccountId) {
+          x.ethereumAddress = x.blockchainAccountId.substring(0, x.blockchainAccountId.lastIndexOf('@'))
+        }
+      })
+    }
+  }
+}

package/src/suites/Ed25519Signature2018.ts

@@ -0,0 +1,75 @@
+import { encodeJoseBlob } from '@veramo/utils'
+import { RequiredAgentMethods, VeramoLdSignature } from '../ld-suites'
+import { CredentialPayload, DIDDocument, IAgentContext, IKey, TKeyType } from '@veramo/core'
+import * as u8a from 'uint8arrays'
+import { Ed25519Signature2018, Ed25519VerificationKey2018 } from '@transmute/ed25519-signature-2018'
+
+export class VeramoEd25519Signature2018 extends VeramoLdSignature {
+  getSupportedVerificationType(): string {
+    return 'Ed25519VerificationKey2018'
+  }
+
+  getSupportedVeramoKeyType(): TKeyType {
+    return 'Ed25519'
+  }
+
+  getSuiteForSigning(
+    key: IKey,
+    issuerDid: string,
+    verificationMethodId: string,
+    context: IAgentContext<RequiredAgentMethods>,
+  ): any {
+    const controller = issuerDid
+
+    // DID Key ID
+    let id = verificationMethodId
+
+    const signer = {
+      // returns a JWS detached
+      sign: async (args: { data: Uint8Array }): Promise<string> => {
+        const header = {
+          alg: 'EdDSA',
+          b64: false,
+          crit: ['b64'],
+        }
+        const headerString = encodeJoseBlob(header)
+        const messageBuffer = u8a.concat([u8a.fromString(`${headerString}.`, 'utf-8'), args.data])
+        const messageString = u8a.toString(messageBuffer, 'base64')
+        const signature = await context.agent.keyManagerSign({
+          keyRef: key.kid,
+          algorithm: 'EdDSA',
+          data: messageString,
+          encoding: 'base64',
+        })
+        return `${headerString}..${signature}`
+      },
+    }
+
+    const verificationKey = new Ed25519VerificationKey2018({
+      id,
+      controller,
+      publicKey: u8a.fromString(key.publicKeyHex, 'base16'),
+      signer: () => signer,
+      type: this.getSupportedVerificationType(),
+    })
+    // overwrite the signer since we're not passing the private key and transmute doesn't support that behavior
+    verificationKey.signer = () => signer as any
+
+    return new Ed25519Signature2018({
+      key: verificationKey,
+      signer: signer,
+    })
+  }
+
+  getSuiteForVerification(): any {
+    return new Ed25519Signature2018()
+  }
+
+  preSigningCredModification(credential: CredentialPayload): void {
+    // nothing to do here
+  }
+
+  preDidResolutionModification(didUrl: string, didDoc: DIDDocument): void {
+    // nothing to do here
+  }
+}

package/src/types.ts

@@ -0,0 +1,208 @@
+import {
+  CredentialPayload,
+  IAgentContext,
+  IDIDManager,
+  IKey,
+  IKeyManager,
+  IPluginMethodMap,
+  IResolver,
+  PresentationPayload,
+  VerifiableCredential,
+  VerifiablePresentation,
+} from '@veramo/core'
+
+/**
+ * The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations
+ * that use JSON-LD format.
+ *
+ * @remarks Please see {@link https://www.w3.org/TR/vc-data-model | W3C Verifiable Credentials data model}
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export interface ICredentialIssuerLD extends IPluginMethodMap {
+  /**
+   * Creates a Verifiable Presentation.
+   * The payload, signer and format are chosen based on the `args` parameter.
+   *
+   * @param args - Arguments necessary to create the Presentation.
+   * @param context - This reserved param is automatically added and handled by the framework, *do not override*
+   *
+   * @returns - a promise that resolves to the {@link @veramo/core#VerifiablePresentation} that was requested or rejects with an error
+   * if there was a problem with the input or while getting the key to sign
+   *
+   * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Presentation data model }
+   *
+   * @beta This API is likely to change without a BREAKING CHANGE notice
+   */
+  createVerifiablePresentationLD(
+    args: ICreateVerifiablePresentationLDArgs,
+    context: IRequiredContext,
+  ): Promise<VerifiablePresentation>
+
+  /**
+   * Creates a Verifiable Credential.
+   * The payload, signer and format are chosen based on the `args` parameter.
+   *
+   * @param args - Arguments necessary to create the Presentation.
+   * @param context - This reserved param is automatically added and handled by the framework, *do not override*
+   *
+   * @returns - a promise that resolves to the {@link @veramo/core#VerifiableCredential} that was requested or rejects with an error
+   * if there was a problem with the input or while getting the key to sign
+   *
+   * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
+   *
+   * @beta This API is likely to change without a BREAKING CHANGE notice
+   */
+  createVerifiableCredentialLD(
+    args: ICreateVerifiableCredentialLDArgs,
+    context: IRequiredContext,
+  ): Promise<VerifiableCredential>
+
+  /**
+   * Verifies a Verifiable Credential JWT or LDS Format.
+   *
+   * @param args - Arguments necessary to verify a VerifiableCredential
+   * @param context - This reserved param is automatically added and handled by the framework, *do not override*
+   *
+   * @returns - a promise that resolves to the boolean true on successful verification or rejects on error
+   *
+   * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
+   *
+   * @beta This API is likely to change without a BREAKING CHANGE notice
+   */
+  verifyCredentialLD(args: IVerifyCredentialLDArgs, context: IRequiredContext): Promise<boolean>
+
+  /**
+   * Verifies a Verifiable Presentation JWT or LDS Format.
+   *
+   * @param args - Arguments necessary to verify a VerifiableCredential
+   * @param context - This reserved param is automatically added and handled by the framework, *do not override*
+   *
+   * @returns - a promise that resolves to the boolean true on successful verification or rejects on error
+   *
+   * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Credential data model}
+   *
+   * @beta This API is likely to change without a BREAKING CHANGE notice
+   */
+  verifyPresentationLD(args: IVerifyPresentationLDArgs, context: IRequiredContext): Promise<boolean>
+}
+
+/**
+ * Encapsulates the parameters required to create a
+ * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export interface ICreateVerifiablePresentationLDArgs {
+  /**
+   * The json payload of the Presentation according to the
+   * {@link https://www.w3.org/TR/vc-data-model/#presentations | canonical model}.
+   *
+   * The signer of the Presentation is chosen based on the `holder` property
+   * of the `presentation`
+   *
+   * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+   */
+  presentation: PresentationPayload
+
+  /**
+   * Optional (only JWT) string challenge parameter to add to the verifiable presentation.
+   */
+  challenge?: string
+
+  /**
+   * Optional string domain parameter to add to the verifiable presentation.
+   */
+  domain?: string
+
+  /**
+   * Optional. The key handle ({@link IKey#kid}) from the internal database.
+   */
+  keyRef?: string
+}
+
+/**
+ * Encapsulates the parameters required to create a
+ * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export interface ICreateVerifiableCredentialLDArgs {
+  /**
+   * The json payload of the Credential according to the
+   * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
+   *
+   * The signer of the Credential is chosen based on the `issuer.id` property
+   * of the `credential`
+   *
+   * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+   */
+  credential: CredentialPayload
+
+  /**
+   * Optional. The key handle ({@link IKey#kid}) from the internal database.
+   */
+  keyRef?: string
+}
+
+/**
+ * Encapsulates the parameters required to verify a
+ * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export interface IVerifyCredentialLDArgs {
+  /**
+   * The json payload of the Credential according to the
+   * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
+   *
+   * The signer of the Credential is chosen based on the `issuer.id` property
+   * of the `credential`
+   *
+   */
+  credential: VerifiableCredential
+}
+
+/**
+ * Encapsulates the parameters required to verify a
+ * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export interface IVerifyPresentationLDArgs {
+  /**
+   * The json payload of the Credential according to the
+   * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
+   *
+   * The signer of the Credential is chosen based on the `issuer.id` property
+   * of the `credential`
+   *
+   */
+  presentation: VerifiablePresentation
+
+  /**
+   * Optional (only for JWT) string challenge parameter to verify the verifiable presentation against
+   */
+  challenge?: string
+
+  /**
+   * Optional (only for JWT) string domain parameter to verify the verifiable presentation against
+   */
+  domain?: string
+}
+
+/**
+ * Represents the requirements that this plugin has.
+ * The agent that is using this plugin is expected to provide these methods.
+ *
+ * This interface can be used for static type checks, to make sure your application is properly initialized.
+ *
+ * @beta This API is likely to change without a BREAKING CHANGE notice
+ */
+export type IRequiredContext = IAgentContext<
+  IResolver & Pick<IDIDManager, 'didManagerGet'> & Pick<IKeyManager, 'keyManagerGet' | 'keyManagerSign'>
+>
+
+export type ContextDoc = {
+  '@context': Record<string, any>
+}