Add module: "key management"

.gitignore

@@ -24,6 +24,7 @@ Thumbs.db
 *.temp
 
 # IDE/editor files
+.vscode/
 .idea/
 *.swp
 *.swo
@@ -33,3 +34,9 @@ tsconfig.tsbuildinfo
 
 # Environment variables
 .env
+
+# ignore private key certs
+*.pem
+
+# ignore .yarn
+.yarn/

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package.json

@@ -8,11 +8,12 @@
   ],
   "scripts": {
     "build": "yarn workspaces run build",
+    "clean": "rm -rf dist",
     "test": "yarn workspaces run test"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5"
   }
-}
+}

packages/auto-id/README.md

@@ -0,0 +1,25 @@
+# Auto ID
+
+## Build
+
+```sh
+yarn
+yarn build
+```
+
+## Test
+
+```sh
+yarn test
+```
+
+## Examples
+
+```sh
+yarn eg-1
+yarn eg-2
+yarn eg-3
+yarn eg-4
+yarn eg-5
+yarn eg-6
+```

packages/auto-id/examples/eg1.ts

@@ -0,0 +1,10 @@
+/* 
+    Simple RSA key pair generation
+*/
+
+import { generateRsaKeyPair, loadPrivateKey, saveKey } from '../src/keyManagement'
+
+// Example usage:
+const [privateKeyRsa, publicKeyRsa] = generateRsaKeyPair()
+console.log(`Private key: ${privateKeyRsa}`)
+console.log(`Public key: ${publicKeyRsa}`)

packages/auto-id/examples/eg2.ts

@@ -0,0 +1,10 @@
+/* 
+  Simple Ed25519 key pair generation
+*/
+
+import { generateEd25519KeyPair, loadPrivateKey, saveKey } from '../src/keyManagement'
+
+// Example usage:
+const [privateKey, publicKey] = generateEd25519KeyPair()
+console.log(`Private key: ${privateKey}`)
+console.log(`Public key: ${publicKey}`)

packages/auto-id/examples/eg3.ts

@@ -0,0 +1,23 @@
+/* 
+  This example demonstrates how to generate a RSA key pair and export it as PEM format.
+  The private key can be exported with or without password.
+*/
+
+import { createPrivateKey, createPublicKey } from 'crypto'
+import { generateRsaKeyPair, keyToPem } from '../src/keyManagement'
+
+const [privateKeyRsa, publicKeyRsa] = generateRsaKeyPair()
+console.log(`Private key: ${privateKeyRsa}`)
+console.log(`Public key: ${publicKeyRsa}`)
+console.log(`========================`)
+
+const privateKeyObjectRsa = createPrivateKey({
+  key: privateKeyRsa,
+  format: 'pem', // Input can still be PEM
+})
+
+const publicKey2 = createPublicKey(privateKeyObjectRsa)
+
+console.log(keyToPem(privateKeyObjectRsa)) // Export without password
+console.log(keyToPem(privateKeyObjectRsa, 'subspace')) // Export with password
+console.log(keyToPem(publicKey2)) // Export public key

packages/auto-id/examples/eg4.ts

@@ -0,0 +1,23 @@
+/* 
+  This example demonstrates how to generate a Ed25519 key pair and export it as PEM format.
+  The private key can be exported with or without password.
+*/
+
+import { createPrivateKey, createPublicKey } from 'crypto'
+import { generateEd25519KeyPair, keyToPem } from '../src/keyManagement'
+
+const [privateKeyEd25519, publicKeyEd25519] = generateEd25519KeyPair()
+console.log(`Private key: ${privateKeyEd25519}`)
+console.log(`Public key: ${publicKeyEd25519}`)
+console.log(`========================`)
+
+const privateKey2 = createPrivateKey({
+  key: privateKeyEd25519,
+  format: 'pem', // Input can still be PEM
+})
+
+const publicKey2 = createPublicKey(privateKeyEd25519)
+
+console.log(keyToPem(privateKey2)) // Export without password
+console.log(keyToPem(privateKey2, 'subspace')) // Export with password
+console.log(keyToPem(publicKey2)) // Export public key

packages/auto-id/examples/eg5.ts

@@ -0,0 +1,38 @@
+/* 
+  This example demonstrates how to generate a RSA key pair and export it as PEM format.
+  The private key can be exported with or without password.
+*/
+
+import { createPrivateKey, createPublicKey } from 'crypto'
+import { generateRsaKeyPair, keyToPem, loadPrivateKey, saveKey } from '../src/keyManagement'
+
+const [privateKeyRsa, publicKeyRsa] = generateRsaKeyPair()
+console.log(`Private key: ${privateKeyRsa}`)
+console.log(`Public key: ${publicKeyRsa}`)
+console.log(`========================`)
+
+const privateKeyObject = createPrivateKey({
+  key: privateKeyRsa,
+  format: 'pem', // Input can still be PEM
+})
+
+const publicKeyKeyObject = createPublicKey(privateKeyObject)
+
+console.log(keyToPem(privateKeyObject)) // Export without password
+console.log(keyToPem(privateKeyObject, 'subspace')) // Export with password
+console.log(keyToPem(publicKeyKeyObject)) // Export public key
+
+// w/o password
+saveKey(privateKeyObject, './privateKey.pem')
+  .then(() => console.log('Key saved successfully'))
+  .catch((err) => console.error('Error saving key:', err))
+// with password i.e. encrypted key
+saveKey(privateKeyObject, './privateKeyPassword.pem', 'subspace')
+  .then(() => console.log('Encrypted Key (with password) saved successfully'))
+  .catch((err) => console.error('Error saving key:', err))
+
+loadPrivateKey('./privateKey.pem')
+  .then((key) => {
+    console.log(`Private keys match: ${key.toString() === privateKeyObject.toString()}`)
+  })
+  .catch((err) => console.error('Error loading key:', err))

packages/auto-id/examples/eg6.ts

@@ -0,0 +1,35 @@
+/* 
+  This example demonstrates how to generate a Ed25519 key pair and export it as PEM format.
+  The private key can be exported with or without password.
+*/
+
+import { createPrivateKey, createPublicKey } from 'crypto'
+import { generateEd25519KeyPair, keyToPem, saveKey } from '../src/keyManagement'
+
+const [privateKeyEd25519, publicKeyEd25519] = generateEd25519KeyPair()
+console.log(`Private key: ${privateKeyEd25519}`)
+console.log(`Public key: ${publicKeyEd25519}`)
+console.log(`========================`)
+
+const privateKeyObject = createPrivateKey({
+  key: privateKeyEd25519,
+  format: 'pem', // Input can still be PEM
+})
+
+const publicKeyObject = createPublicKey(privateKeyEd25519)
+
+console.log(keyToPem(privateKeyObject)) // Export without password
+console.log(keyToPem(privateKeyObject, 'subspace')) // Export with password
+console.log(keyToPem(publicKeyObject)) // Export public key
+
+// w/o password
+saveKey(privateKeyObject, './privateKey.pem')
+  .then(() => console.log('Key saved successfully'))
+  .catch((err) => console.error('Error saving key:', err))
+// with password i.e. encrypted key
+saveKey(privateKeyObject, './privateKeyPassword.pem', 'subspace')
+  .then(() => console.log('Key (with password) saved successfully'))
+  .catch((err) => console.error('Error saving key:', err))
+
+// const loadedPrivateKey = loadPrivateKey('./privateKey.pem')
+// console.log(`Private keys match: ${loadedPrivateKey.toString() === privateKey.toString()}`)

packages/auto-id/jest.config.ts

@@ -0,0 +1,3 @@
+module.exports = {
+  preset: 'ts-jest',
+}

packages/auto-id/package.json

@@ -3,9 +3,23 @@
   "version": "0.1.0",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "eg-1": "tsc && node dist/examples/eg1.js",
+    "eg-2": "tsc && node dist/examples/eg2.js",
+    "eg-3": "tsc && node dist/examples/eg3.js",
+    "eg-4": "tsc && node dist/examples/eg4.js",
+    "eg-5": "tsc && node dist/examples/eg5.js",
+    "eg-6": "tsc && node dist/examples/eg6.js",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "test": "jest"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.4",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   }
-}
+}

packages/auto-id/src/index.ts

@@ -1,3 +1,5 @@
-export const helloWorld = () => {
+// TODO: Complete once all the modules are ready
+/* export const helloWorld = () => {
     console.log('Hello World');
 };
+ */