@sphereon/did-provider-oyd 0.28.1-feature.oyd.cmsm.improv.20 → 0.28.1-next.53

package/src/oyd-did-provider.ts

@@ -1,3 +1,4 @@
+import { importProvidedOrGeneratedKey } from '@sphereon/ssi-sdk-ext.key-utils'
 import { IAgentContext, IIdentifier, IKey, IKeyManager, IService, TKeyType } from '@veramo/core'
 import { AbstractIdentifierProvider } from '@veramo/did-manager'
 import { KeyManager } from '@veramo/key-manager'
@@ -5,6 +6,7 @@ import fetch from 'cross-fetch'
 import Multibase from 'multibase'
 import Multicodec from 'multicodec'
 
+// @ts-ignore
 import * as u8a from 'uint8arrays'
 
 import Debug from 'debug'
@@ -12,9 +14,9 @@ import type {
   CMSMCallbackOpts,
   OydConstructorOptions,
   OydCreateIdentifierOptions,
-  OydDidHoldKeysArgs,
+  // OydDidHoldKeysArgs,
   OydDidSupportedKeyTypes,
-} from './types/oyd-provider-types.js'
+} from './types/oyd-provider-types'
 
 const debug = Debug('veramo:oyd-did:identifier-provider')
 const OYDID_REGISTRAR_URL = 'https://oydid-registrar.data-container.net/1.0/createIdentifier'
@@ -47,7 +49,7 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
   }
 
   async createIdentifier(
-    { kms, options }: { kms?: string; options: OydCreateIdentifierOptions },
+    { kms, alias, options }: { kms?: string; alias?: string; options: OydCreateIdentifierOptions },
     context: IContext
   ): Promise<Omit<IIdentifier, 'provider'>> {
     const resolvedKms = await this.assertedKms(kms, this.defaultKms)
@@ -62,7 +64,7 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
     const body = {
       options: {
         cmsm: false,
-        key_type: options.keyType ?? 'Secp256r1',
+        key_type: options.type ?? 'Secp256r1',
       },
     }
     let didDoc: any | undefined
@@ -84,15 +86,18 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
       return Promise.reject(Error('There has been a problem with the fetch operation: ' + error.toString()))
     }
 
-    const keyType: OydDidSupportedKeyTypes = options?.keyType ?? 'Secp256r1'
-    const key = await this.importOrCreateKey(
+    const keyType: OydDidSupportedKeyTypes = options?.type ?? 'Secp256r1'
+    const key = await importProvidedOrGeneratedKey(
       {
         kms: resolvedKms,
+        alias: alias ?? options.alias ?? options.kid ?? `${didDoc.did}#key-doc`,
         options: {
-          keyType,
-          kid: didDoc.did + '#key-doc',
-          publicKeyHex: didDoc.keys[0].publicKeyHex,
-          privateKeyHex: didDoc.keys[0].privateKeyHex,
+          key: {
+            kid: `${didDoc.did}#key-doc`,
+            type: keyType,
+            publicKeyHex: didDoc.keys[0].publicKeyHex,
+            privateKeyHex: didDoc.keys[0].privateKeyHex,
+          },
         },
       },
       context
@@ -119,11 +124,10 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
 
     const assertedKms = await this.assertedKms(kms, this.defaultKms)
     const pubKey =
-      options.key ??
-      (await cmsmCallbackOpts.publicKeyCallback(options.kid ?? 'default', assertedKms, options.cmsm?.create !== false, options.keyType)) // "default" is probably not right, TODO!!
+      options.key ?? (await cmsmCallbackOpts.publicKeyCallback(options.kid ?? 'default', assertedKms, options.cmsm?.create !== false, options.type)) // "default" is probably not right, TODO!!
     const kid = pubKey.kid
     const keyType = pubKey.type
-    const key = base58btc({publicKeyHex: pubKey.publicKeyHex, keyType})
+    const key = base58btc({ publicKeyHex: pubKey.publicKeyHex, keyType })
 
     console.log(`Bae58 pubkey key: ${key}`)
     let signValue: any | undefined // do the request
@@ -161,8 +165,6 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
 
     console.log(`Signature: ${signature}`)
 
-
-
     const body_signed = {
       key,
       options: {
@@ -195,24 +197,6 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
       return Promise.reject(Error('There has been a problem with the fetch operation: ' + error.toString()))
     }
 
-    /*    let oydKeyType: OydDidSupportedKeyTypes = "Secp256r1";
-
-        const key = await this.holdKeys(
-          {
-            kms: assertedKms,
-            options: {
-              keyType: oydKeyType,
-              kid: kid,
-              publicKeyHex: pubKey.publicKeyHex,
-            },
-          },
-          context
-        );*/
-
-
-
-
-
     const identifier: Omit<IIdentifier, 'provider'> = {
       did: didDoc.did,
       controllerKeyId: pubKey.kid,
@@ -252,31 +236,6 @@ export class OydDIDProvider extends AbstractIdentifierProvider {
   async removeService(args: { identifier: IIdentifier; id: string; options?: any }, context: IContext): Promise<any> {
     return { success: true }
   }
-
-  private async importOrCreateKey(args: OydDidHoldKeysArgs, context: IContext): Promise<IKey> {
-    const kms = await this.assertedKms(args.kms, this.defaultKms)
-    if (args.options.privateKeyHex) {
-      return context.agent.keyManagerImport({
-        kms,
-        type: args.options.keyType,
-        kid: args.options.kid,
-        privateKeyHex: args.options.privateKeyHex,
-        /*meta: {
-          algorithms: ['Secp256r1'],
-        },*/
-      })
-    }
-    return context.agent.keyManagerCreate({
-      type: args.options.keyType,
-      kms,
-      meta: {
-        algorithms: ['Secp256r1'],
-      },
-    })
-  }
-
-
-
 }
 
 const keyCodecs = {
@@ -289,17 +248,15 @@ const keyCodecs = {
   Bls12381G2: 'bls12_381-g2-pub',
 } as const
 
-const base58btc = ({publicKeyHex, keyType = 'Secp256r1'}:{publicKeyHex: string, keyType?: TKeyType}): string => {
+const base58btc = ({ publicKeyHex, keyType = 'Secp256r1' }: { publicKeyHex: string; keyType?: TKeyType }): string => {
   const codecName = keyCodecs[keyType]
 
-
   // methodSpecificId  = bytesToMultibase({bytes: u8a.fromString(key.publicKeyHex, 'hex'), codecName})
   return u8a
-    .toString(
-      Multibase.encode('base58btc', Multicodec.addPrefix(codecName as Multicodec.CodecName, u8a.fromString(publicKeyHex, 'hex')))
-    )
+    .toString(Multibase.encode('base58btc', Multicodec.addPrefix(codecName as Multicodec.CodecName, u8a.fromString(publicKeyHex, 'hex'))))
     .toString()
 }
+
 export function defaultOydCmsmPublicKeyCallback(
   keyManager: KeyManager
 ): (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey> {
@@ -314,7 +271,27 @@ export function defaultOydCmsmPublicKeyCallback(
       if (!kms) {
         return Promise.reject(Error('No KMS provided, whilst creating a new key!'))
       }
-      return await keyManager.keyManagerCreate({ kms, type: createKeyType ?? 'Secp256r1' })
+      const alias = kid ?? `oyd-${new Date().toISOString()}`
+
+      const agent = keyManager
+      const key = await importProvidedOrGeneratedKey(
+        {
+          kms,
+          alias,
+          options: {
+            key: {
+              type: createKeyType ?? 'Secp256r1',
+            },
+          },
+        },
+        {
+          //@ts-ignore
+          agent,
+        }
+      )
+      return key
+
+      // return await keyManager.keyManagerCreate({ kms, type: createKeyType ?? 'Secp256r1' })
     }
     return Promise.reject(Error('No existing key found, and create is false!'))
   }
@@ -327,11 +304,17 @@ export function defaultOydCmsmSignCallback(keyManager: KeyManager): (kid: string
 }
 
 export class DefaultOydCmsmCallbacks implements CMSMCallbackOpts {
-  constructor(private keyManager: KeyManager) {}
+  private readonly keyManager: KeyManager
 
-  publicKeyCallback: (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey> = defaultOydCmsmPublicKeyCallback(
-    this.keyManager
-  )
+  constructor(keyManager: KeyManager) {
+    this.keyManager = keyManager
+  }
 
-  signCallback: (kid: string, value: string) => Promise<string> = defaultOydCmsmSignCallback(this.keyManager)
+  publicKeyCallback(kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType): Promise<IKey> {
+    return defaultOydCmsmPublicKeyCallback(this.keyManager)(kid, kms, create, createKeyType)
+  }
+
+  signCallback(kid: string, value: string): Promise<string> {
+    return defaultOydCmsmSignCallback(this.keyManager)(kid, value)
+  }
 }

package/src/types/oyd-provider-types.ts

@@ -1,49 +1,49 @@
 import { IKey, TKeyType } from '@veramo/core'
 
 export type OydConstructorOptions = {
-  defaultKms?: string;
-  clientManagedSecretMode?: CMSMCallbackOpts;
+  defaultKms?: string
+  clientManagedSecretMode?: CMSMCallbackOpts
 }
 
 export type OydCreateIdentifierOptions = {
-  keyType?: OydDidSupportedKeyTypes;
-  privateKeyHex?: string;
-  kid?: string;
-  keyUse?: KeyUse;
-  cmsm?: CmsmOptions;
+  type?: OydDidSupportedKeyTypes
+  privateKeyHex?: string
+  kid?: string
+  alias?: string
+  keyUse?: KeyUse
+  cmsm?: CmsmOptions
   key?: IKey // Use the supplied key instead of looking it up in the KMS or creating a new one
 }
 
-
 export type CmsmOptions = {
   enabled: boolean
   create?: boolean
 }
 
 export type OydDidHoldKeysArgs = {
-  kms?: string;
-  options: HoldKeysOpts;
+  kms?: string
+  options: HoldKeysOpts
 }
 
 type HoldKeysOpts = {
-  keyType: OydDidSupportedKeyTypes;
-  kid: string;
-  publicKeyHex?: string;
-  privateKeyHex?: string;
+  keyType: OydDidSupportedKeyTypes
+  kid: string
+  publicKeyHex?: string
+  privateKeyHex?: string
 }
 
 export type CMSMCallbackOpts = {
-  publicKeyCallback: (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey>;
-  signCallback: (kid: string, value: string) => Promise<string>;
+  publicKeyCallback: (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey>
+  signCallback: (kid: string, value: string) => Promise<string>
 }
 
-export enum SupportedKeyTypes {
+enum SupportedKeyTypes {
   Secp256r1 = 'Secp256r1',
   Secp256k1 = 'Secp256k1',
   Ed25519 = 'Ed25519',
   X25519 = 'X25519',
 }
 
-export type OydDidSupportedKeyTypes = keyof typeof SupportedKeyTypes;
+export type OydDidSupportedKeyTypes = keyof typeof SupportedKeyTypes
 
-export type KeyUse = 'sig' | 'enc';
+export type KeyUse = 'sig' | 'enc'

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,cAAc,4BAA4B,CAAA"}

package/dist/oyd-did-provider.d.ts

@@ -1,61 +0,0 @@
-import { IAgentContext, IIdentifier, IKey, IKeyManager, IService, TKeyType } from '@veramo/core';
-import { AbstractIdentifierProvider } from '@veramo/did-manager';
-import { KeyManager } from '@veramo/key-manager';
-import type { CMSMCallbackOpts, OydConstructorOptions, OydCreateIdentifierOptions } from './types/oyd-provider-types.js';
-type IContext = IAgentContext<IKeyManager>;
-/**
- * {@link @veramo/did-manager#DIDManager} identifier provider for `did:oyd` identifiers
- * @public
- */
-export declare class OydDIDProvider extends AbstractIdentifierProvider {
-    private readonly defaultKms?;
-    private readonly cmsmCallbackOpts?;
-    constructor(options?: OydConstructorOptions);
-    private assertedKms;
-    createIdentifier({ kms, options }: {
-        kms?: string;
-        options: OydCreateIdentifierOptions;
-    }, context: IContext): Promise<Omit<IIdentifier, 'provider'>>;
-    createIdentifierWithCMSM({ kms, options }: {
-        kms?: string;
-        options: OydCreateIdentifierOptions;
-    }, context: IContext): Promise<Omit<IIdentifier, 'provider'>>;
-    updateIdentifier(args: {
-        did: string;
-        kms?: string | undefined;
-        alias?: string | undefined;
-        options?: any;
-    }, context: IAgentContext<IKeyManager>): Promise<IIdentifier>;
-    deleteIdentifier(identifier: IIdentifier, context: IContext): Promise<boolean>;
-    addKey({ identifier, key, options }: {
-        identifier: IIdentifier;
-        key: IKey;
-        options?: any;
-    }, context: IContext): Promise<any>;
-    addService({ identifier, service, options }: {
-        identifier: IIdentifier;
-        service: IService;
-        options?: any;
-    }, context: IContext): Promise<any>;
-    removeKey(args: {
-        identifier: IIdentifier;
-        kid: string;
-        options?: any;
-    }, context: IContext): Promise<any>;
-    removeService(args: {
-        identifier: IIdentifier;
-        id: string;
-        options?: any;
-    }, context: IContext): Promise<any>;
-    private importOrCreateKey;
-}
-export declare function defaultOydCmsmPublicKeyCallback(keyManager: KeyManager): (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey>;
-export declare function defaultOydCmsmSignCallback(keyManager: KeyManager): (kid: string, data: string) => Promise<string>;
-export declare class DefaultOydCmsmCallbacks implements CMSMCallbackOpts {
-    private keyManager;
-    constructor(keyManager: KeyManager);
-    publicKeyCallback: (kid: string, kms?: string, create?: boolean, createKeyType?: TKeyType) => Promise<IKey>;
-    signCallback: (kid: string, value: string) => Promise<string>;
-}
-export {};
-//# sourceMappingURL=oyd-did-provider.d.ts.map

package/dist/oyd-did-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"oyd-did-provider.d.ts","sourceRoot":"","sources":["../src/oyd-did-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAChG,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAQhD,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,EAG3B,MAAM,+BAA+B,CAAA;AAKtC,KAAK,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,CAAA;AAE1C;;;GAGG;AACH,qBAAa,cAAe,SAAQ,0BAA0B;IAC5D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAkB;gBAExC,OAAO,CAAC,EAAE,qBAAqB;YAM7B,WAAW;IAWnB,gBAAgB,CACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,0BAA0B,CAAA;KAAE,EACvE,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IA2DnC,wBAAwB,CAC5B,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,0BAA0B,CAAA;KAAE,EACvE,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAgHnC,gBAAgB,CACpB,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAC1F,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,GAClC,OAAO,CAAC,WAAW,CAAC;IAIjB,gBAAgB,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAO9E,MAAM,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5H,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,QAAQ,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5I,SAAS,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzG,aAAa,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;YAIpG,iBAAiB;CAwBhC;AAuBD,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,UAAU,GACrB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAgB1F;AAED,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAIjH;AAED,qBAAa,uBAAwB,YAAW,gBAAgB;IAClD,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAE1C,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAE1G;IAED,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAA8C;CAC5G"}