@sphereon/ssi-sdk.ebsi-support 0.27.0 → 0.27.1-next.12

package/src/agent/EbsiSupport.ts

@@ -5,7 +5,8 @@ import { IPEXFilterResult } from '@sphereon/ssi-sdk.presentation-exchange'
 import { CredentialMapper, PresentationSubmission } from '@sphereon/ssi-types'
 import { IAgentPlugin } from '@veramo/core'
 import fetch from 'cross-fetch'
-import { determineWellknownEndpoint, ebsiGetIssuerMock } from '../did/functions'
+import { CreateEbsiDidOnLedgerResult, CreateEbsiDidParams } from '../did'
+import { determineWellknownEndpoint, ebsiCreateDidOnLedger as ebsiCreateDidOnLedgerFunction, ebsiGetIssuerMock } from '../did/functions'
 import { ebsiCreateAttestationAuthRequestURL, ebsiGetAttestation } from '../functions'
 import {
   ApiOpts,
@@ -30,9 +31,20 @@ import {
 
 import { v4 } from 'uuid'
 
+export const ebsiSupportMethods: Array<string> = [
+  'ebsiCreateDidOnLedger',
+  'ebsiWellknownMetadata',
+  'ebsiAuthorizationServerJwks',
+  'ebsiPresentationDefinitionGet',
+  'ebsiAccessTokenGet',
+  'ebsiCreateAttestationAuthRequestURL',
+  'ebsiGetAttestation',
+]
+
 export class EbsiSupport implements IAgentPlugin {
   readonly schema = schema.IEbsiSupport
   readonly methods: IEbsiSupport = {
+    ebsiCreateDidOnLedger: this.ebsiCreateDidOnLedger.bind(this),
     ebsiWellknownMetadata: this.ebsiWellknownMetadata.bind(this),
     ebsiAuthorizationServerJwks: this.ebsiAuthorizationServerJwks.bind(this),
     ebsiPresentationDefinitionGet: this.ebsiPresentationDefinitionGet.bind(this),
@@ -41,6 +53,10 @@ export class EbsiSupport implements IAgentPlugin {
     ebsiGetAttestation: ebsiGetAttestation.bind(this),
   }
 
+  private async ebsiCreateDidOnLedger(args: CreateEbsiDidParams, context: IRequiredContext): Promise<CreateEbsiDidOnLedgerResult> {
+    return await ebsiCreateDidOnLedgerFunction(args, context)
+  }
+
   private async ebsiWellknownMetadata(args: WellknownOpts): Promise<GetOIDProviderMetadataResponse> {
     const url = determineWellknownEndpoint(args)
     return await (

package/src/did/EbsiDidProvider.ts

@@ -35,6 +35,7 @@ export class EbsiDidProvider extends AbstractIdentifierProvider {
       notAfter,
       secp256k1Key,
       secp256r1Key,
+      keys,
       accessTokenOpts,
       executeLedgerOperation = !!args.options?.accessTokenOpts,
       methodSpecificId = generateEbsiMethodSpecificId(EBSI_DID_SPEC_INFOS.V1),
@@ -48,9 +49,11 @@ export class EbsiDidProvider extends AbstractIdentifierProvider {
     const rpcId = options?.rpcId ?? randomRpcId()
 
     if (type === EBSI_DID_SPEC_INFOS.KEY) {
-      throw new Error(`Type ${type} not supported. Please use @sphereon/ssi-sdk-ext.did-provider-key for Natural Person EBSI DIDs`)
+      return Promise.reject(Error(`Type ${type} not supported. Please use @sphereon/ssi-sdk-ext.did-provider-key for Natural Person EBSI DIDs`))
     } else if (!kms) {
       return Promise.reject(Error(`No KMS value provided`))
+    } else if (keys && keys.length > 0 && !executeLedgerOperation) {
+      return Promise.reject(Error(`Cannot add additional keys if ledger operation is not enabled at creation. Please add the keys later yourself`))
     }
 
     // CapabilityInvocation purpose
@@ -95,6 +98,7 @@ export class EbsiDidProvider extends AbstractIdentifierProvider {
     }
 
     if (executeLedgerOperation) {
+      // This can only work if we enable global jwks hosting. DID JWK hosting will not work as the DID is not registered at this point
       await ebsiCreateDidOnLedger(
         {
           identifier,
@@ -106,6 +110,20 @@ export class EbsiDidProvider extends AbstractIdentifierProvider {
         },
         context,
       )
+      if (keys && keys.length > 0) {
+        for (const keyOpts of keys) {
+          const key = await ebsiGenerateOrUseKeyPair(
+            {
+              keyOpts,
+              keyType: keyOpts.type ?? 'Secp256r1',
+              kms,
+            },
+            context,
+          )
+          const managedKeyInfo = await context.agent.keyManagerImport(key)
+          console.warn(`FIXME: Anchor additional key on EBSI`, managedKeyInfo)
+        }
+      }
     }
 
     debug('Created', identifier.did)

package/src/did/functions.ts

@@ -3,7 +3,7 @@ import { CreateRequestObjectMode } from '@sphereon/oid4vci-common'
 import { getControllerKey, getEthereumAddressFromKey, getKeys } from '@sphereon/ssi-sdk-ext.did-utils'
 import { calculateJwkThumbprint, calculateJwkThumbprintForKey, JwkKeyUse, toJwk } from '@sphereon/ssi-sdk-ext.key-utils'
 import { W3CVerifiableCredential } from '@sphereon/ssi-types'
-import { IAgentContext, IIdentifier, IKey, IKeyManager, MinimalImportableKey, TKeyType } from '@veramo/core'
+import { IAgentContext, IKey, IKeyManager, MinimalImportableKey, TKeyType } from '@veramo/core'
 import { getBytes, SigningKey, Transaction } from 'ethers'
 import { base58btc } from 'multiformats/bases/base58'
 import * as u8a from 'uint8arrays'
@@ -14,6 +14,7 @@ import { ebsiWaitTillDocumentAnchored } from './services/EbsiRestService'
 import { callRpcMethod } from './services/EbsiRPCService'
 import {
   BASE_CONTEXT_DOC,
+  CreateEbsiDidOnLedgerResult,
   CreateEbsiDidParams,
   EBSI_DID_SPEC_INFOS,
   EbsiDidRegistryAPIEndpoints,
@@ -253,7 +254,8 @@ export const assertedPurposes = (args: { key?: IKeyOpts }): EbsiPublicKeyPurpose
         if (
           key?.purposes &&
           key.purposes.length > 0 &&
-          key.purposes.every((purpose) => [EbsiPublicKeyPurpose.AssertionMethod, EbsiPublicKeyPurpose.Authentication].includes(purpose))
+          key.purposes.includes(EbsiPublicKeyPurpose.AssertionMethod) &&
+          key.purposes.includes(EbsiPublicKeyPurpose.Authentication)
         ) {
           return key.purposes
         }
@@ -287,16 +289,7 @@ export const randomRpcId = (): number => {
   return Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
 }
 
-export const ebsiCreateDidOnLedger = async (
-  args: CreateEbsiDidParams,
-  context: IRequiredContext,
-): Promise<{
-  identifier: IIdentifier
-  addVerificationMethod: EbsiRPCResponse
-  insertDidDoc: EbsiRPCResponse
-  addAssertionMethodRelationship: EbsiRPCResponse
-  addAuthenticationRelationship: EbsiRPCResponse
-}> => {
+export const ebsiCreateDidOnLedger = async (args: CreateEbsiDidParams, context: IRequiredContext): Promise<CreateEbsiDidOnLedgerResult> => {
   const {
     accessTokenOpts,
     notBefore = Math.floor(Date.now() / 1000 - 60),

package/src/did/types.ts

@@ -83,6 +83,7 @@ export type EbsiCreateIdentifierOpts = {
   rpcId?: number
   secp256k1Key?: IKeyOpts
   secp256r1Key?: IKeyOpts
+  keys?: IKeyOpts[] // additional importable keys, but only in case execute ledger is true
   executeLedgerOperation?: boolean // Whether to persist on the EBSI ledger. By default looks at whether access token opts are set or not
   baseDocument?: string
   notBefore?: number
@@ -379,7 +380,7 @@ export type GetDidDocumentsResponse = {
   links: Links
 }
 
-type EbsiAccessTokenOpts = {
+export type EbsiAccessTokenOpts = {
   attestationToOnboard?: W3CVerifiableCredential
   jwksUri?: string
   redirectUri: string
@@ -408,7 +409,13 @@ export type CreateEbsiDidParams = {
   baseDocument?: string
   accessTokenOpts: EbsiAccessTokenOpts
 }
-
+export interface CreateEbsiDidOnLedgerResult {
+  identifier: IIdentifier
+  addVerificationMethod: EbsiRPCResponse
+  insertDidDoc: EbsiRPCResponse
+  addAssertionMethodRelationship: EbsiRPCResponse
+  addAuthenticationRelationship: EbsiRPCResponse
+}
 /**
  * @constant JSON_RPC_VERSION
  */

package/src/index.ts

@@ -3,6 +3,6 @@ import { Loggers } from '@sphereon/ssi-types'
 export const logger = Loggers.DEFAULT.get('sphereon:ebsi-support')
 const schema = require('../plugin.schema.json')
 export { schema }
-export { EbsiSupport } from './agent/EbsiSupport'
+export { EbsiSupport, ebsiSupportMethods } from './agent/EbsiSupport'
 export * from './types/IEbsiSupport'
 export { EbsiDidProvider } from './did'

package/src/types/IEbsiSupport.ts

@@ -8,6 +8,7 @@ import { IPresentationExchange } from '@sphereon/ssi-sdk.presentation-exchange'
 import { IDidAuthSiopOpAuthenticator } from '@sphereon/ssi-sdk.siopv2-oid4vp-op-auth'
 import { PresentationSubmission, W3CVerifiableCredential } from '@sphereon/ssi-types'
 import { IAgentContext, IDIDManager, IIdentifier, IKeyManager, IPluginMethodMap, IResolver } from '@veramo/core'
+import { CreateEbsiDidOnLedgerResult, CreateEbsiDidParams } from '../did'
 import { AttestationAuthRequestUrlResult } from '../functions'
 
 /**
@@ -40,6 +41,8 @@ export type ApiOpts = { environment?: EbsiEnvironment; version: EbsiApiVersion }
 export type WellknownOpts = ApiOpts & { type: WellknownType; system?: EbsiSystem | EbsiEnvironment; mock?: EbsiMock }
 
 export interface IEbsiSupport extends IPluginMethodMap {
+  ebsiCreateDidOnLedger(args: CreateEbsiDidParams, context: IRequiredContext): Promise<CreateEbsiDidOnLedgerResult>
+
   ebsiWellknownMetadata(args?: ApiOpts): Promise<GetOIDProviderMetadataResponse>
 
   ebsiAuthorizationServerJwks(args?: ApiOpts): Promise<GetOIDProviderJwksResponse>