@veramo/cli 3.0.1-next.8 → 3.1.1-next.10

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veramo/cli",
   "description": "Veramo command line application.",
-  "version": "3.0.1-next.8+0ca9b448",
+  "version": "3.1.1-next.10+ef7797d4",
   "main": "build/cli.js",
   "types": "build/cli.d.ts",
   "bin": {
@@ -14,68 +14,69 @@
     "update-veramo-latest": "yarn add @veramo/core@latest @veramo/discovery@latest @veramo/remote-client@latest @veramo/remote-server@latest @veramo/did-provider-key@latest @veramo/did-resolver@latest @veramo/did-jwt@latest @veramo/credential-w3c@latest @veramo/did-provider-ethr@latest @veramo/did-provider-web@latest @veramo/did-comm@latest @veramo/kms-local@latest @veramo/selective-disclosure@latest @veramo/data-store@latest @veramo/key-manager@latest @veramo/message-handler@latest @veramo/did-manager@latest @veramo/url-handler@latest"
   },
   "dependencies": {
-    "@microsoft/api-extractor": "7.18.11",
-    "@microsoft/api-extractor-model": "7.13.9",
+    "@microsoft/api-extractor": "7.18.19",
+    "@microsoft/api-extractor-model": "7.13.16",
     "@types/blessed": "^0.1.17",
     "@types/swagger-ui-express": "^4.1.2",
-    "@veramo/core": "^3.0.1-next.8+0ca9b448",
-    "@veramo/credential-w3c": "^3.0.1-next.8+0ca9b448",
-    "@veramo/data-store": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-comm": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-discovery": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-jwt": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-manager": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-provider-ethr": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-provider-key": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-provider-web": "^3.0.1-next.8+0ca9b448",
-    "@veramo/did-resolver": "^3.0.1-next.8+0ca9b448",
-    "@veramo/key-manager": "^3.0.1-next.8+0ca9b448",
-    "@veramo/kms-local": "^3.0.1-next.8+0ca9b448",
-    "@veramo/message-handler": "^3.0.1-next.8+0ca9b448",
-    "@veramo/remote-client": "^3.0.1-next.8+0ca9b448",
-    "@veramo/remote-server": "^3.0.1-next.8+0ca9b448",
-    "@veramo/selective-disclosure": "^3.0.1-next.8+0ca9b448",
-    "@veramo/url-handler": "^3.0.1-next.8+0ca9b448",
+    "@veramo/core": "^3.1.1-next.10+ef7797d4",
+    "@veramo/credential-w3c": "^3.1.1-next.10+ef7797d4",
+    "@veramo/data-store": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-comm": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-discovery": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-jwt": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-manager": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-provider-ethr": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-provider-key": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-provider-web": "^3.1.1-next.10+ef7797d4",
+    "@veramo/did-resolver": "^3.1.1-next.10+ef7797d4",
+    "@veramo/key-manager": "^3.1.1-next.10+ef7797d4",
+    "@veramo/kms-local": "^3.1.1-next.10+ef7797d4",
+    "@veramo/message-handler": "^3.1.1-next.10+ef7797d4",
+    "@veramo/remote-client": "^3.1.1-next.10+ef7797d4",
+    "@veramo/remote-server": "^3.1.1-next.10+ef7797d4",
+    "@veramo/selective-disclosure": "^3.1.1-next.10+ef7797d4",
+    "@veramo/url-handler": "^3.1.1-next.10+ef7797d4",
     "blessed": "^0.1.81",
-    "commander": "^7.0.0",
+    "commander": "^8.0.0",
     "console-table-printer": "^2.8.2",
     "cors": "^2.8.5",
     "cross-fetch": "^3.1.4",
     "date-fns": "^2.16.1",
     "debug": "^4.1.1",
-    "did-resolver": "3.1.0",
+    "did-resolver": "3.1.3",
     "dotenv": "^10.0.0",
-    "ethr-did-resolver": "4.3.4",
+    "ethr-did-resolver": "5.0.2",
     "express": "^4.17.1",
-    "express-handlebars": "^5.2.0",
+    "express-handlebars": "^6.0.0",
     "fuzzy": "^0.1.3",
     "handlebars": "^4.7.6",
     "inquirer": "^8.0.0",
     "inquirer-autocomplete-prompt": "^1.2.0",
-    "json-schema": "^0.3.0",
-    "jsonpointer": "^4.1.0",
+    "json-schema": "^0.4.0",
+    "json5": "^2.2.0",
+    "jsonpointer": "^5.0.0",
     "oas-resolver": "^2.5.3",
-    "openapi-types": "^9.0.0",
+    "openapi-types": "9.3.1",
     "passport": "^0.5.0",
     "passport-http-bearer": "^1.0.1",
     "pg": "^8.6.0",
     "qrcode-terminal": "^0.12.0",
     "sqlite3": "^5.0.0",
     "swagger-ui-express": "^4.1.5",
-    "ts-json-schema-generator": "^0.95.0",
-    "typeorm": "0.2.37",
+    "ts-json-schema-generator": "^0.97.0",
+    "typeorm": "0.2.41",
     "url-parse": "^1.5.1",
-    "web-did-resolver": "2.0.4",
+    "web-did-resolver": "2.0.8",
     "ws": "^8.0.0",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "@types/inquirer": "8.1.2",
+    "@types/inquirer": "8.1.3",
     "@types/node-fetch": "3.0.2",
     "@types/passport-http-bearer": "1.0.37",
     "@types/ws": "8.2.0",
-    "typescript": "4.4.3"
+    "typescript": "4.5.2"
   },
   "files": [
     "bin/**/*",
@@ -99,5 +100,5 @@
   ],
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "0ca9b448db8b467630a14bc64343082af29bc725"
+  "gitHead": "ef7797d4c5f20b22e4e39a5ad60a851fa1c4f2ed"
 }

package/src/cli.ts

@@ -1,4 +1,4 @@
-import program from 'commander'
+import { program } from 'commander'
 import inquirer from 'inquirer'
 
 inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'))

package/src/config.ts

@@ -1,6 +1,7 @@
 import 'cross-fetch/polyfill'
-import program from 'commander'
+import { program } from 'commander'
 import { SecretBox } from '@veramo/kms-local'
+import { getAgent, getConfig } from './setup'
 const fs = require('fs')
 const { dirname } = require('path')
 
@@ -38,12 +39,51 @@ config
 
 config
   .command('create-secret-key')
+  .alias('gen-key')
+  .alias('key-gen')
   .description('generate secret key')
-  .action(async (raw) => {
+  .option('-q, --quiet', 'Only print the raw key, no instructions', false)
+  .action(async (options) => {
     try {
-      const secretKey = await SecretBox.createSecretKey()
-      console.log(secretKey)
+      const dbEncryptionKey = await SecretBox.createSecretKey()
+      if (options.quiet === true) {
+        console.log(dbEncryptionKey)
+      } else {
+        console.log(`
+        X25519 raw private key (hex encoded):
+  
+        ${dbEncryptionKey}
+  
+        You can use this key with @veramo/kms-local#SecretBox
+        or replace the default agent.yml 'dbEncryptionKey' constant
+        `)
+      }
     } catch (e: any) {
       console.error(e.message)
     }
   })
+
+config
+  .command('check')
+  .alias('verify')
+  .description('Verify an agent config file syntax')
+  .option('-f, --filename <string>', 'Config file name', './agent.yml')
+  .option('-m, --method <string>', 'Check that a specific method is exposed by the agent.', 'execute')
+  .action(async (options) => {
+    const agent = getAgent(options.filename)
+    if (!agent) {
+      console.error(
+        'unknown error while creating the agent from your config. Consider running `veramo config create` to generate a new configuration file, or to manually compare differences.',
+      )
+    } else {
+      if (typeof agent[options.method] !== 'function') {
+        console.error(
+          `The agent was created using the config, but the 'agent.${options.method}()' method is not available. Make sure the plugin that implements that method is installed.`,
+        )
+      } else {
+        console.log(
+          `Your Veramo configuration seems fine. An agent can be created and the 'agent.${options.method}()' method can be called on it.`,
+        )
+      }
+    }
+  })

package/src/credential.ts

@@ -1,8 +1,11 @@
-import { W3CCredential } from '@veramo/core'
 import { getAgent } from './setup'
-import program from 'commander'
+import { program } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
+import * as fs from 'fs'
+import * as json5 from 'json5'
+import { readStdin } from './util'
+import { CredentialPayload } from '@veramo/core'
 
 const credential = program.command('credential').description('W3C Verifiable Credential')
 
@@ -10,6 +13,7 @@ credential
   .command('create', { isDefault: true })
   .description('Create W3C Verifiable Credential')
   .option('-s, --send', 'Send')
+  .option('-j, --json', 'Output in JSON')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
     const agent = getAgent(program.opts().config)
@@ -19,6 +23,12 @@ credential
       process.exit()
     }
     const answers = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'proofFormat',
+        choices: ['jwt', 'lds'],
+        message: 'Credential proofFormat',
+      },
       {
         type: 'list',
         name: 'iss',
@@ -68,9 +78,9 @@ credential
     const type: string = answers.claimType
     credentialSubject[type] = answers.claimValue
 
-    const credential: W3CCredential = {
+    const credential: CredentialPayload = {
       issuer: { id: answers.iss },
-      '@context': ['https://www.w3.org/2018/credentials/v1'],
+      '@context': ['https://www.w3.org/2018/credentials/v1', 'https://veramo.io/contexts/profile/v1'],
       type: answers.type.split(','),
       issuanceDate: new Date().toISOString(),
       credentialSubject,
@@ -101,18 +111,27 @@ credential
     const verifiableCredential = await agent.createVerifiableCredential({
       save: true,
       credential,
-      proofFormat: 'jwt',
+      proofFormat: answers.proofFormat,
     })
 
     if (cmd.send) {
+      let body
+      let type
+      if (answers.proofFormat == 'jwt') {
+        body = verifiableCredential.proof.jwt
+        type = 'jwt'
+      } else {
+        body = verifiableCredential
+        type = 'w3c.vc'
+      }
       try {
         const message = await agent.sendMessageDIDCommAlpha1({
           save: true,
           data: {
             from: answers.iss,
             to: answers.sub,
-            type: 'jwt',
-            body: verifiableCredential.proof.jwt,
+            type,
+            body,
           },
         })
         console.dir(message, { depth: 10 })
@@ -124,6 +143,48 @@ credential
     if (cmd.qrcode) {
       qrcode.generate(verifiableCredential.proof.jwt)
     } else {
-      console.dir(verifiableCredential, { depth: 10 })
+      if (cmd.json) {
+        console.log(JSON.stringify(verifiableCredential, null, 2))
+      } else {
+        console.dir(verifiableCredential, { depth: 10 })
+      }
+    }
+  })
+
+credential
+  .command('verify')
+  .description('Verify a W3C Verifiable Credential provided as raw string, file or stdin')
+  .option('-f, --filename <string>', 'Optional. Read the credential from a file instead of stdin')
+  .option('-r, --raw <string>', 'Optional. Specify the credential as a parameter instead of file or stdin')
+  .action(async (options) => {
+    const agent = getAgent(program.opts().config)
+    let raw: string = ''
+    if (options.raw) {
+      raw = options.raw
+    } else if (options.filename) {
+      raw = await fs.promises.readFile(options.filename, 'utf-8')
+    } else {
+      raw = await readStdin()
+    }
+    let credentialAsJSON: any
+    try {
+      credentialAsJSON = json5.parse(raw)
+    } catch (e: any) {
+      credentialAsJSON = {
+        proof: {
+          type: 'JwtProof2020',
+          jwt: raw,
+        },
+      } as any
+    }
+    try {
+      const result = await agent.verifyCredential({ credential: credentialAsJSON })
+      if (result === true) {
+        console.log('Credential was verified successfully.')
+      } else {
+        console.error('Credential could not be verified.')
+      }
+    } catch (e) {
+      console.error(e.message)
     }
   })

package/src/dev.ts

@@ -1,21 +1,16 @@
-import { getAgent } from './setup'
-import program from 'commander'
-const fs = require('fs')
-import { resolve, dirname } from 'path'
-import { writeFileSync, readFileSync } from 'fs'
-import * as TJS from 'ts-json-schema-generator'
-import { JSONSchema7 } from 'json-schema'
-import { OpenAPIV3 } from 'openapi-types'
 import { Extractor, ExtractorConfig, ExtractorResult } from '@microsoft/api-extractor'
 import {
+  ApiMethodSignature,
   ApiModel,
-  ApiPackage,
   ApiParameterListMixin,
-  ApiDocumentedItem,
   ApiReturnTypeMixin,
-  ApiMethodSignature,
 } from '@microsoft/api-extractor-model'
-import { IIdentifier } from '@veramo/core'
+import { program } from 'commander'
+import { writeFileSync } from 'fs'
+import { OpenAPIV3 } from 'openapi-types'
+import { resolve } from 'path'
+import * as TJS from 'ts-json-schema-generator'
+const fs = require('fs')
 
 interface Method {
   packageName: string
@@ -50,6 +45,7 @@ function createSchema(generator: TJS.SchemaGenerator, symbol: string) {
   schemaStr = schemaStr.replace(/Where\<(.*)\>/gm, 'Where-$1')
   schemaStr = schemaStr.replace(/Order\<(.*)\>/gm, 'Order-$1')
   schemaStr = schemaStr.replace(/FindArgs\<(.*)\>/gm, 'FindArgs-$1')
+  schemaStr = schemaStr.replace(/https \:\/\//gm, 'https://')
   return JSON.parse(schemaStr)
 }
 

package/src/did.ts

@@ -1,7 +1,7 @@
 import { IDIDManagerCreateArgs } from '@veramo/core'
 import { getAgent } from './setup'
 import inquirer from 'inquirer'
-import program from 'commander'
+import { program } from 'commander'
 import { printTable } from 'console-table-printer'
 
 const did = program.command('did').description('Decentralized identifiers')

package/src/discover.ts

@@ -1,5 +1,5 @@
 import { getAgent } from './setup'
-import program from 'commander'
+import { program } from 'commander'
 import { printTable } from 'console-table-printer'
 
 const discover = program.command('discover').description('Discovery')

package/src/execute.ts

@@ -1,7 +1,5 @@
-import { input } from 'blessed'
-import program from 'commander'
+import { program } from 'commander'
 import inquirer from 'inquirer'
-import jsonpointer from 'jsonpointer'
 import { getAgent } from './setup'
 const fs = require('fs')
 const OasResolver = require('oas-resolver')

package/src/explore/credentials.ts

@@ -3,6 +3,7 @@ import { UniqueVerifiableCredential } from '@veramo/data-store'
 import { shortDate, shortDid } from './utils'
 import { ConfiguredAgent } from '../setup'
 import { styles } from './styles'
+import { asArray, extractIssuer } from '@veramo/utils'
 
 export const getCredentialsTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {
   screen.title = 'Credentials'
@@ -25,8 +26,8 @@ export const getCredentialsTable = async (agent: ConfiguredAgent, screen: Widget
     [['Created', 'Type', 'From', 'To']].concat(
       credentials.map(({ verifiableCredential: m }) => [
         shortDate(m.issuanceDate),
-        m.type.join(','),
-        shortDid(m.issuer.id),
+        asArray(m.type || []).join(','),
+        shortDid(extractIssuer(m)),
         shortDid(m.credentialSubject.id),
       ]),
     ),

package/src/explore/index.ts

@@ -1,5 +1,5 @@
 import { getAgent } from '../setup'
-import program from 'commander'
+import { program } from 'commander'
 import { renderMainScreen } from './main'
 
 program

package/src/explore/presentations.ts

@@ -1,9 +1,9 @@
 import blessed, { Widgets } from 'blessed'
-import { VerifiablePresentation } from '@veramo/core'
 import { UniqueVerifiablePresentation } from '@veramo/data-store'
 import { shortDate, shortDid } from './utils'
 import { ConfiguredAgent } from '../setup'
 import { styles } from './styles'
+import { asArray } from '@veramo/utils'
 
 export const getPresentationsTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {
   screen.title = 'Presentations'
@@ -26,9 +26,9 @@ export const getPresentationsTable = async (agent: ConfiguredAgent, screen: Widg
     [['Created', 'Type', 'Holder', 'Verifier']].concat(
       presentations.map(({ verifiablePresentation: m }) => [
         shortDate(m.issuanceDate),
-        m.type.join(','),
+        asArray(m.type || []).join(','),
         shortDid(m.holder),
-        shortDid(m.verifier.join(',')),
+        shortDid(asArray(m.verifier || []).join(',')),
       ]),
     ),
   )

package/src/message.ts

@@ -1,5 +1,5 @@
 import { getAgent } from './setup'
-import program from 'commander'
+import { program } from 'commander'
 const fs = require('fs')
 
 const message = program.command('message').description('Messages')

package/src/presentation.ts

@@ -1,8 +1,11 @@
-import { W3CCredential } from '@veramo/core'
 import { getAgent } from './setup'
-import program from 'commander'
+import { program } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
+import { readStdin } from './util'
+import * as fs from 'fs'
+import * as json5 from 'json5'
+import { extractIssuer } from '@veramo/utils'
 
 const presentation = program.command('presentation').description('W3C Verifiable Presentation')
 
@@ -85,7 +88,7 @@ presentation
           name:
             JSON.stringify(credential.verifiableCredential.credentialSubject) +
             ' | Issuer: ' +
-            credential.verifiableCredential.issuer.id,
+            extractIssuer(credential.verifiableCredential),
           value: credential.verifiableCredential,
         })
       }
@@ -153,3 +156,43 @@ presentation
       }
     }
   })
+
+presentation
+  .command('verify')
+  .description('Verify a W3C Verifiable Presentation provided as a string param or a file or from stdin')
+  .option('-c, --challenge <string>', 'Optional. Specify a challenge that the presentation should match.')
+  .option('-d, --domain <string>', 'Optional. Specify a domain that the presentation should match.')
+  .option('-f, --filename <string>', 'Optional. Read the presentation from a file instead of stdin')
+  .option('-r, --raw <string>', 'Optional. Presentation as a parameter string instead of a file or stdin.')
+  .action(async (options) => {
+    const agent = getAgent(program.opts().config)
+    let raw: string = ''
+    if (options.raw) {
+      raw = options.raw
+    } else if (options.filename) {
+      raw = await fs.promises.readFile(options.filename, 'utf-8')
+    } else {
+      raw = await readStdin()
+    }
+    let presentationAsJSON: any
+    try {
+      presentationAsJSON = json5.parse(raw)
+    } catch (e: any) {
+      presentationAsJSON = {
+        proof: {
+          type: 'JwtProof2020',
+          jwt: raw,
+        },
+      } as any
+    }
+    const result = await agent.verifyPresentation({
+      presentation: presentationAsJSON,
+      challenge: options.challenge,
+      domain: options.domain,
+    })
+    if (result === true) {
+      console.log('Presentation was verified successfully.')
+    } else {
+      console.error('Presentation could not be verified.')
+    }
+  })

package/src/sdr.ts

@@ -1,10 +1,12 @@
 import { ICredentialRequestInput } from '@veramo/selective-disclosure'
 import { getAgent } from './setup'
-import program from 'commander'
+import { program } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
 import { shortDate, shortDid } from './explore/utils'
 import { VerifiableCredential } from '@veramo/core'
+import { asArray, extractIssuer } from '@veramo/utils'
+
 const fuzzy = require('fuzzy')
 
 const sdr = program.command('sdr').description('Selective Disclosure Request')
@@ -173,7 +175,7 @@ sdr
             name:
               JSON.stringify(credential.verifiableCredential.credentialSubject) +
               ' | Issuer: ' +
-              credential.verifiableCredential.issuer.id,
+              extractIssuer(credential.verifiableCredential),
             value: credential.verifiableCredential.proof.jwt,
           })
         }
@@ -305,9 +307,9 @@ sdr
           name:
             c.verifiableCredential.credentialSubject[item.claimType] +
             ' (' +
-            c.verifiableCredential.type.join(',') +
+            asArray(c.verifiableCredential.type || []).join(',') +
             ') issued by: ' +
-            c.verifiableCredential.issuer.id +
+            extractIssuer(c.verifiableCredential) +
             ' ' +
             shortDate(c.verifiableCredential.issuanceDate) +
             ' ago',

package/src/server.ts

@@ -1,5 +1,5 @@
 import express from 'express'
-import program from 'commander'
+import { program } from 'commander'
 import { getConfig } from './setup'
 import { createObjects } from './lib/objectCreator'
 

package/src/setup.ts

@@ -17,7 +17,7 @@ export const getConfig = (fileName: string): any => {
     process.exit(1)
   }
 
-  const config = yaml.parse(fs.readFileSync(fileName).toString())
+  const config = yaml.parse(fs.readFileSync(fileName).toString(), { prettyErrors: true })
 
   if (config?.version != 3) {
     console.log('Unsupported configuration file version:', config.version)

package/src/util.ts

@@ -0,0 +1,23 @@
+export async function readStdin(): Promise<string> {
+  return new Promise((resolve, reject) => {
+    let data = ''
+    process.stdin.setEncoding('utf-8')
+
+    process.stdin.on('readable', () => {
+      let chunk: string
+      while ((chunk = process.stdin.read())) {
+        data += chunk
+      }
+    })
+
+    process.stdin.on('end', () => {
+      // There will be a trailing \n from the user hitting enter. Get rid of it.
+      data = data.replace(/\n$/, '')
+      resolve(data)
+    })
+
+    process.stdin.on('error', (error) => {
+      reject(error)
+    })
+  })
+}

package/src/version.ts

@@ -1,4 +1,4 @@
-import program from 'commander'
+import { program } from 'commander'
 
 const { version } = require('../package.json')