@bedrock/vc-delivery 3.0.0 → 3.0.1

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@bedrock/vc-delivery",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "type": "module",
   "description": "Bedrock Verifiable Credential Delivery",
   "main": "./lib/index.js",
   "files": [
-    "lib/**/*.js"
+    "lib/**/*.js",
+    "schemas/**/*.js"
   ],
   "scripts": {
     "lint": "eslint ."
@@ -15,7 +16,14 @@
     "url": "https://github.com/digitalbazaar/bedrock-vc-delivery"
   },
   "keywords": [
-    "bedrock"
+    "bedrock",
+    "exchange",
+    "oid4vci",
+    "oid4vc",
+    "VC API",
+    "vc-api",
+    "verifiable credential",
+    "verifiable presentation"
   ],
   "author": {
     "name": "Digital Bazaar, Inc.",
@@ -61,6 +69,6 @@
     "jsdoc-to-markdown": "^8.0.0"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   }
 }

package/schemas/bedrock-vc-exchanger.js

@@ -0,0 +1,286 @@
+/*!
+ * Copyright (c) 2022-2023 Digital Bazaar, Inc. All rights reserved.
+ */
+import {schemas} from '@bedrock/validation';
+
+const credentialDefinition = {
+  title: 'OID4VCI Verifiable Credential Definition',
+  type: 'object',
+  additionalProperties: false,
+  required: ['@context', 'type'],
+  properties: {
+    '@context': {
+      type: 'array',
+      minItems: 1,
+      item: {
+        type: 'string'
+      }
+    },
+    type: {
+      type: 'array',
+      minItems: 2,
+      item: {
+        type: 'string'
+      }
+    }
+  }
+};
+
+const openIdExchangeOptions = {
+  title: 'OpenID Exchange options',
+  type: 'object',
+  additionalProperties: false,
+  required: ['expectedCredentialRequests', 'preAuthorizedCode', 'oauth2'],
+  properties: {
+    expectedCredentialRequests: {
+      title: 'OpenID Expected Credential Requests',
+      type: 'array',
+      minItems: 1,
+      items: {
+        type: 'object',
+        additionalProperties: false,
+        required: ['credential_definition', 'format'],
+        properties: {
+          credential_definition: credentialDefinition,
+          format: {
+            type: 'string',
+            enum: ['ldp_vc']
+          }
+        }
+      }
+    },
+    preAuthorizedCode: {
+      type: 'string'
+    },
+    oauth2: {
+      title: 'OpenID Exchange OAuth2 Options',
+      type: 'object',
+      additionalProperties: false,
+      oneOf: [{
+        required: ['keyPair']
+      }, {
+        required: ['generateKeyPair']
+      }],
+      properties: {
+        generateKeyPair: {
+          type: 'object',
+          additionalProperties: false,
+          required: ['algorithm'],
+          properties: {
+            algorithm: {
+              enum: ['EdDSA', 'ES256', 'ES256K', 'ES384']
+            }
+          }
+        },
+        keyPair: {
+          type: 'object',
+          additionalProperties: false,
+          required: ['privateKeyJwk', 'publicKeyJwk'],
+          properties: {
+            privateKeyJwk: {
+              type: 'object'
+            },
+            publicKeyJwk: {
+              type: 'object'
+            }
+          }
+        },
+        maxClockSkew: {
+          type: 'number'
+        }
+      }
+    }
+  }
+};
+
+export const createExchangeBody = {
+  title: 'Create Exchange',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    ttl: {
+      type: 'number'
+    },
+    variables: {
+      type: 'object',
+      additionalProperties: true
+    },
+    openId: openIdExchangeOptions
+  }
+};
+
+const credentialTemplate = {
+  title: 'Credential Template',
+  type: 'object',
+  required: ['type', 'template'],
+  additionalProperties: false,
+  properties: {
+    type: {
+      type: 'string',
+      enum: ['jsonata']
+    },
+    template: {
+      type: 'string'
+    }
+  }
+};
+
+export const credentialTemplates = {
+  title: 'Credential Templates',
+  type: 'array',
+  minItems: 1,
+  items: credentialTemplate
+};
+
+const step = {
+  title: 'Exchange Step',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    createChallenge: {
+      type: 'boolean'
+    },
+    verifiablePresentationRequest: {
+      type: 'object'
+    },
+    jwtDidProofRequest: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        acceptedMethods: {
+          title: 'Accepted DID Methods',
+          type: 'array',
+          minItems: 1,
+          items: {
+            title: 'Accepted DID Method',
+            type: 'object',
+            additionalProperties: false,
+            properties: {
+              method: {
+                type: 'string'
+              }
+            }
+          }
+        },
+        allowedAlgorithms: {
+          title: 'Allowed JWT Algorithms',
+          type: 'array',
+          minItems: 1,
+          items: {
+            type: 'string'
+          }
+        }
+      }
+    },
+    // FIXME: add jsonata template to convert VPR or
+    // `jwtDidProofRequest` to more variables to be
+    // used when issuing VCs
+    // FIXME: `nextStep` feature not yet implemented
+    // nextStep: {
+    //   type: 'string'
+    // }
+  }
+};
+
+export const steps = {
+  title: 'Exchange Steps',
+  type: 'object',
+  additionalProperties: false,
+  patternProperties: {
+    '^.*$': step
+  }
+};
+
+export const initialStep = {
+  title: 'Initial Exchange Step',
+  type: 'string'
+};
+
+export function useExchangeBody() {
+  return {
+    title: 'Use Exchange',
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      verifiablePresentation: schemas.verifiablePresentation()
+    }
+  };
+}
+
+const openIdCredentialRequest = {
+  title: 'OpenID Credential Request',
+  type: 'object',
+  additionalProperties: false,
+  required: ['credential_definition', 'format'],
+  properties: {
+    credential_definition: credentialDefinition,
+    format: {
+      type: 'string',
+      enum: ['ldp_vc']
+    },
+    did: {
+      type: 'string'
+    },
+    proof: {
+      title: 'DID Authn Proof JWT',
+      type: 'object',
+      additionalProperties: false,
+      required: ['proof_type', 'jwt'],
+      properties: {
+        proof_type: {
+          type: 'string',
+          enum: ['jwt']
+        },
+        jwt: {
+          type: 'string'
+        }
+      }
+    }
+  }
+};
+
+export const openIdCredentialBody = openIdCredentialRequest;
+
+export const openIdBatchCredentialBody = {
+  title: 'OpenID Batch Credential Request',
+  type: 'object',
+  additionalProperties: false,
+  required: ['credential_requests'],
+  properties: {
+    credential_requests: {
+      title: 'OpenID Credential Requests',
+      type: 'array',
+      minItems: 1,
+      items: openIdCredentialRequest
+    }
+  }
+};
+
+export const openIdTokenBody = {
+  title: 'OpenID Token Request',
+  type: 'object',
+  additionalProperties: false,
+  required: ['grant_type'],
+  properties: {
+    grant_type: {
+      type: 'string'
+    },
+    'pre-authorized_code': {
+      type: 'string'
+    },
+    // FIXME: there is no implementation for using these fields yet:
+    // user_pin: {
+    //   type: 'string'
+    // },
+    // // params for `authorization_code` grant type
+    // code: {
+    //   type: 'string'
+    // },
+    // verifier: {
+    //   type: 'string'
+    // },
+    // redirect_uri: {
+    //   type: 'string'
+    // }
+  }
+};