Verifiable addresses (#17)

* functions and types for signing and validating a VerifiablePayID

* get pem and x5c working
simplify verify call to use Embedded option

* lint fixes and refactored SigningParams types from interface to classes

* exports

* packages.json cleanup

Author: nhartner

package-lock.json

@@ -23,12 +23,16 @@
     "lintNoFix": "eslint . --ext .ts --max-warnings 0 && prettier --check '**/*.{md,json}'",
     "test": "nyc mocha 'test/**/*.test.ts'"
   },
+  "dependencies": {
+    "jose": "^1.27.2"
+  },
   "devDependencies": {
     "@arkweid/lefthook": "^0.7.2",
     "@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
     "@types/chai": "^4.2.11",
     "@types/mocha": "^7.0.2",
     "@types/node": "^14.0.14",
+    "@types/pem-jwk": "^1.5.0",
     "@typescript-eslint/eslint-plugin": "^3.7.1",
     "@typescript-eslint/parser": "^3.7.1",
     "@xpring-eng/eslint-config-base": "^0.11.0",

package.json

@@ -1,3 +1,4 @@
 export * from './parse'
 export * from './convert'
 export * from './helpers'
+export * from './verifiable'

src/index.ts

@@ -0,0 +1,28 @@
+import { JWK } from 'jose'
+
+import { SigningParams } from './verifiable-payid'
+
+import ECKey = JWK.ECKey
+import RSAKey = JWK.RSAKey
+import OctKey = JWK.OctKey
+import OKPKey = JWK.OKPKey
+
+/**
+ * Represents the properties needed to sign a PayID using an identity key.
+ */
+export default class IdentityKeySigningParams implements SigningParams {
+  public readonly keyType = 'identityKey'
+  public readonly key: ECKey | RSAKey | OctKey | OKPKey
+  public readonly alg: string
+
+  /**
+   * Default constructor.
+   *
+   * @param key - The private key to sign with.
+   * @param alg - The signing algorithm.
+   */
+  public constructor(key: ECKey | RSAKey | OctKey | OKPKey, alg: string) {
+    this.key = key
+    this.alg = alg
+  }
+}

src/verifiable/identity-key-signing-params.ts

@@ -0,0 +1,2 @@
+export * from './signatures'
+export * from './verifiable-payid'

src/verifiable/index.ts

@@ -0,0 +1,21 @@
+import { promises } from 'fs'
+
+import { JWK } from 'jose'
+
+import RSAKey = JWK.RSAKey
+import ECKey = JWK.ECKey
+import OKPKey = JWK.OKPKey
+import OctKey = JWK.OctKey
+
+/**
+ * Reads JWK key from a file.
+ *
+ * @param path - The full file path of the key file.
+ * @returns A JWK key.
+ */
+export default async function getKeyFromFile(
+  path: string,
+): Promise<RSAKey | ECKey | OKPKey | OctKey> {
+  const pem = await promises.readFile(path, 'ascii')
+  return JWK.asKey(pem)
+}

src/verifiable/keys.ts

@@ -0,0 +1,35 @@
+import { JWK } from 'jose'
+
+import { SigningParams } from './verifiable-payid'
+
+import ECKey = JWK.ECKey
+import RSAKey = JWK.RSAKey
+import OctKey = JWK.OctKey
+import OKPKey = JWK.OKPKey
+
+/**
+ * Represents the properties needed to sign a PayID using a server key.
+ */
+export default class ServerKeySigningParams implements SigningParams {
+  public readonly keyType = 'serverKey'
+  public readonly key: ECKey | RSAKey | OctKey | OKPKey
+  public readonly alg: string
+  public readonly x5c: ECKey | RSAKey | OctKey | OKPKey
+
+  /**
+   * Default constructor.
+   *
+   * @param key - The private key to sign with.
+   * @param alg - The signing algorithm.
+   * @param x5c - The public x509 certificate.
+   */
+  public constructor(
+    key: ECKey | RSAKey | OctKey | OKPKey,
+    alg: string,
+    x5c: ECKey | RSAKey | OctKey | OKPKey,
+  ) {
+    this.key = key
+    this.alg = alg
+    this.x5c = x5c
+  }
+}