@verii/verifgen 1.0.0-pre.1752076816

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# verifgen
+Generates credentials and presentations
+
+## Creating Credentials
+Veifgen allows you to create self signed credentials.
+
+### Options
+|flag|description|
+|---|---|
+|-o|specify output file|
+|-s|self sign|
+|-t|credential type to set|
+
+### Creating an identity credential (self signed)
+`$ node ./src/verifgen.js credential IdentityAndContact-Adam-Smith -o adamsmith-id -s`
+
+### Creating an a regular credential (self signed)
+`$ node ./src/verifgen.js credential CurrentEmploymentPosition-2015-Programme-Manager -s -t CurrentEmploymentPosition -o adam-currentemployment`
+
+`$ node ./src/verifgen.js credential Degree -s -t EducationDegree -o adam-educationdegree`
+
+## Creating Presentations
+Now that you have a set of credentials then you can create presentations for sending to an agent.
+
+### Options
+| flag | description                                                                                    |
+|------|------------------------------------------------------------------------------------------------|
+| -o   | specify output file                                                                            |
+| -r   | specify the presentation request or credential manifest containing the presentation definition |
+| -i   | specify issuer persona (See "Using personas" section below)                                    |
+| -p   | specify x-vnf-protocol-version for presentation (issuer persona is required for v2)            |
+| -c   | specify all input credential files                                                             |
+| -v   | specify a vendorOriginContext value                                                            |
+
+### Creating a identity presentation (for issuing)
+`$ node ./src/verifgen.js presentation -c adamsmith-id -r credential-manifest.json -o adam-id-presentation`
+
+### Creating a credentials presentation with a vendor origin context(for a disclosure)
+`$ node ./src/verifgen.js presentation -r presentation-request.json -v eyj!143PRrs -c adamsmith-id adam-currentemployment adam-educationdegree -o adam-creds-presentation.v1`
+
+## Future Dev
+- Support organization signed credentials
+
+
+## Creating agent jwt token
+`$ node ./src/verifgen agent-jwt --secret 'cc7e0d44fd473002f1c42167459001140ec6389b7353f8088f4d9a95f2f596f2' --email example@example.com --groupId 123654`
+
+## Verifgen proof command
+
+This command is used to generate a proof JWT.
+
+### How to Use
+
+verifgen proof [options]
+Options
+
+| -c, --challenge <challenge> Directly specify the challenge used in the JWT. If not provided, it will be loaded from the generate-offers response.
+
+| -r, --response <generate-offers-response-filename> The filename containing the generate-offers response. Defaults to generate-offers-response.json.
+
+| -a, --audience <audience> (required) Specifies the audience which must be present in the payload. (Usually the issuer url the proof is being generated for)
+
+|  -p, --persona <persona> (required) Specifies the persona private key used to sign the JWT. (See "Using personas" section below)
+
+`node ./src/verifgen proof -c someChallengeValue -a https://example.com/audience -p <persona>`
+
+### Using "personas"
+
+Whatever is passed in as the `-p` value, is what the documentation calls "a persona".
+In practice, what this means, is that it will look for certain files that are expected to be present
+for the persona to be used properly. 
+With a persona of johndoe, the following files would be expected.
+1. A did document named `johndoe.did`, with JSON contents like:
+   ```
+   {
+     "id":"did:jwk:..."
+   }
+   ```
+
+   The important thing here is that the `id` property is present, and represents the identity of the persona
+
+
+2. One of the following:
+   1. A private jwk in a file named `johndoe.prv.key.json`, with JSON contents like:
+      ```
+      {
+        "kty": "...",
+        "crv": "...",
+        "d": "...",
+        "x": "...",
+        "y": "..."
+      }
+      ```
+   2. A private hex string in a file named `johndoe.prv.key` with a string like:
+      ```
+      8a2c1...
+      ```
+      The CLI will attempt to load the JWK first. 
+      Otherwise the CLI will attempt to load the hex file.
+      
+      This private key will be used to sign whatever JWTs are relevant to the CLI tool being used.
+      So using `verifgen presentation`, this key will be used to sign the presentation.
+      And using `verifgen proof`, this key will be used to sign the proof.
+      And same goes for other instances where the `-p <persona` option is specified.

package/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('./src/verifgen');

package/jest.config.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const jestConfig = require('../../jest.config.base');
+const pack = require('./package.json');
+
+module.exports = jestConfig(pack.name);

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@verii/verifgen",
+  "version": "1.0.0-pre.1752076816",
+  "description": "A tool for creating verifiable credentials and verifiable presentations.",
+  "repository": "https://github.com/LFDT-Verii/core",
+  "main": "index.js",
+  "bin": {
+    "verifgen": "index.js"
+  },
+  "scripts": {
+    "test": "jest --config ./jest.config.js --runInBand --coverage --passWithNoTests",
+    "lint": "eslint . --format json >> eslint.json",
+    "lint:fix": "eslint --fix --ext .js ."
+  },
+  "author": "Itay Podhajcer",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "eslint": "8.57.1",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-better-mutation": "1.7.0",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-watch": "7.0.0",
+    "jest": "29.7.0",
+    "prettier": "2.8.8"
+  },
+  "dependencies": {
+    "@verii/blockchain-functions": "1.0.0-pre.1752076816",
+    "@verii/common-functions": "1.0.0-pre.1752076816",
+    "@verii/crypto": "1.0.0-pre.1752076816",
+    "@verii/did-doc": "1.0.0-pre.1752076816",
+    "@verii/jwt": "1.0.0-pre.1752076816",
+    "@verii/vc-checks": "1.0.0-pre.1752076816",
+    "@verii/verifiable-credentials": "1.0.0-pre.1752076816",
+    "bs58": "~6.0.0",
+    "chalk": "~4.1.2",
+    "commander": "~13.1.0",
+    "got": "11.8.6",
+    "lodash": "^4.17.21",
+    "nanoid": "~3.3.4"
+  },
+  "gitHead": "5885ce94149cc0102b2bc9cde18834293174bfaf"
+}

package/src/common.js

@@ -0,0 +1,98 @@
+const console = require('console');
+const chalk = require('chalk');
+const fs = require('fs');
+const { default: bs58 } = require('bs58');
+const path = require('path');
+const { getOr } = require('lodash/fp');
+const { generateKeyPair } = require('@verii/crypto');
+const { toEthereumAddress } = require('@verii/blockchain-functions');
+const { generateProof } = require('@verii/did-doc');
+
+const templatesPath = path.resolve(__dirname, '../templates');
+
+const writeFile = (filePath, fileContent) => {
+  const fileBasename = path.basename(filePath, '.*');
+
+  console.info(`${chalk.green('Writing:')} ${chalk.whiteBright(fileBasename)}`);
+
+  fs.writeFileSync(filePath, fileContent, 'utf8');
+};
+
+const readFile = (filePath, missingError) => {
+  if (!fs.existsSync(filePath)) {
+    throw new Error(missingError);
+  }
+
+  return fs.readFileSync(filePath, 'utf8');
+};
+
+const resolveTemplate = (template) =>
+  path.resolve(templatesPath, `${template}.json`);
+
+const printError = (ex) => console.error(ex);
+const printInfo = (data) => console.info(data);
+
+const generateDid = (controller = {}) => {
+  const { privateKey, publicKey } = generateKeyPair();
+  const address = toEthereumAddress(publicKey);
+  const did = `did:velocity:${address}`;
+  const proofSigningKey = getOr(privateKey, 'privateKey', controller);
+  const proofController = getOr(did, 'did.id', controller);
+  const didObject = {
+    '@context': [
+      'https://www.w3.org/ns/did/v1',
+      'https://w3id.org/security/v1',
+    ],
+    id: did,
+    publicKey: [
+      {
+        id: `${did}#key-1`,
+        type: 'EcdsaSecp256k1VerificationKey2019',
+        controller: did,
+        publicKeyBase58: bs58.encode(Buffer.from(publicKey, 'hex')),
+      },
+    ],
+    created: new Date().toISOString(),
+    updated: new Date().toISOString(),
+  };
+
+  didObject.proof = generateProof(
+    didObject,
+    proofController,
+    proofSigningKey,
+    `${proofController}#key-1`
+  );
+
+  return { privateKey, publicKey, address, did, didObject };
+};
+
+const loadPersonaFiles = (persona) => {
+  return {
+    did: JSON.parse(
+      readFile(`${persona}.did`, `Persona ${persona} DID File not found`)
+    ),
+    privateKey: loadPersonaPrivateKey(persona),
+  };
+};
+
+const loadPersonaPrivateKey = (persona) => {
+  const missingErrorMessage = `Persona ${persona}  private key file not found`;
+  const jwkFilePath = `${persona}.prv.key.json`;
+  const filePath = `${persona}.prv.key`;
+  if (fs.existsSync(jwkFilePath)) {
+    const jsonStr = readFile(jwkFilePath, missingErrorMessage);
+    return JSON.parse(jsonStr);
+  }
+  return readFile(filePath, missingErrorMessage);
+};
+
+module.exports = {
+  printInfo,
+  templatesPath,
+  writeFile,
+  readFile,
+  resolveTemplate,
+  printError,
+  generateDid,
+  loadPersonaFiles,
+};

package/src/verifgen-address.js

@@ -0,0 +1,34 @@
+const { program } = require('commander');
+const { toEthereumAddress } = require('@verii/blockchain-functions');
+const common = require('./common');
+
+const generateAddress = (publicKeyFile, addressFile) => {
+  try {
+    const publicKey = common.readFile(publicKeyFile, 'Public key not found');
+    const address = toEthereumAddress(publicKey);
+
+    common.writeFile(addressFile, address);
+  } catch (ex) {
+    common.printError(ex);
+  }
+};
+
+program
+  .name('verifgen address')
+  .description('Generates an account address')
+  .usage('[options]')
+  .option(
+    '-b, --public-key-file <filename>',
+    'Input public key file name',
+    'pub.key'
+  )
+  .option(
+    '-a, --address-file <filename>',
+    'Output account address file name',
+    'account.address'
+  )
+  .action(() => {
+    const options = program.opts();
+    return generateAddress(options.publicKeyFile, options.addressFile);
+  })
+  .parse(process.argv);

package/src/verifgen-agent-jwt-generator.js

@@ -0,0 +1,32 @@
+const { program } = require('commander');
+const { jwtSignSymmetric } = require('@verii/jwt');
+const { printInfo, printError, writeFile } = require('./common');
+
+const generateJWT = async ({ secret, email, groupId }) => {
+  const payload = {
+    user: email,
+    groupId,
+  };
+  const token = await jwtSignSymmetric(payload, secret);
+  return token;
+};
+
+program
+  .name('verifgen agent-jwt')
+  .description('Generate JWTs for agent')
+  .usage('[options]')
+  .option('-s, --secret <secret>', 'Client Secret')
+  .option('-e, --email <email>', 'Client Email')
+  .option('-g, --groupId <groupId>', 'Client Group Id')
+  .action(async () => {
+    const options = program.opts();
+    try {
+      printInfo(`options: ${JSON.stringify(options, null, 2)}`);
+      const data = await generateJWT(options);
+      writeFile(`agent-jwt-${Date.now()}.jwt`, JSON.stringify(data));
+      printInfo(data);
+    } catch (error) {
+      printError(error);
+    }
+  })
+  .parse(process.argv);

package/src/verifgen-asymmetric-jwt.js

@@ -0,0 +1,44 @@
+const { program } = require('commander');
+const { generateDocJwt } = require('@verii/jwt');
+const { printInfo, printError, writeFile } = require('./common');
+
+const generateJWT = async ({
+  issuer,
+  subject,
+  audience,
+  scope,
+  signingKey,
+  expiresIn = '30y',
+}) => {
+  return generateDocJwt({ scope }, signingKey, {
+    issuer,
+    subject,
+    expiresIn,
+    audience,
+    iat: Math.floor(Date.now() / 1000),
+  });
+};
+
+program
+  .name('verifgen asymmetric-jwt')
+  .description('Generate JWTs using asymmetric keys')
+  .usage('[options]')
+  .requiredOption('-i, --issuer <issuer>', 'Token issuer')
+  .requiredOption('-s, --subject <subject>', 'Token subject')
+  .requiredOption('-a, --audience <audience>', 'Token audience')
+  .requiredOption('-sc, --scope <scope>', 'Token scope')
+  .requiredOption('-k, --signingKey <signingKey>', 'Private key for signing')
+  .option('-e, --expiresIn <expiresIn>', 'Token expiration time')
+  .action(async () => {
+    const options = program.opts();
+
+    try {
+      printInfo(`options: ${JSON.stringify(options, null, 2)}`);
+      const data = await generateJWT(options);
+      writeFile(`agent-jwt-${Date.now()}.jwt`, JSON.stringify(data));
+      printInfo(data);
+    } catch (error) {
+      printError(error);
+    }
+  })
+  .parse(process.argv);