dce-expresskit 4.0.0-beta.2 → 4.0.0-beta.3

package/genEncodedSecret.ts

@@ -1,84 +1,110 @@
 // Import crypto lib
 import crypto from 'crypto';
 
+// Prompt
+import readline from 'readline';
+
+// Create a readline interface
+const readlineInterface = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+/**
+ * Prompt user for input
+ * @author Gabe Abrams
+ * @param question the question to ask the user
+ * @returns the text from the user
+ */
+const prompt = (question: string): Promise<string> => {
+  return new Promise((resolve, reject) => {
+    readlineInterface.question(question, (answer: string) => {
+      if (!answer || answer.trim().length === 0) {
+        console.log('\nValue cannot be empty. Exiting...');
+        process.exit(0);
+      }
+
+      resolve(answer);
+    });
+  });
+};
+
+// All chars for randomizer
 const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 
-// Get args
-const DCEKIT_CRED_ENCODING_SALT = process.env.npm_config_salt;
-if (!DCEKIT_CRED_ENCODING_SALT) {
-  console.log('Encoding salt is required: --salt=...');
-  process.exit(1);
-}
-
-// Get the key
-let key = process.env.npm_config_key;
-if (!key) {
-  console.log('Key is required: --key=...');
-  process.exit(1);
-}
-
-// Get the description
-let description = process.env.npm_config_description;
-if (!description) {
-  console.log('Description is required: --description=...');
-  process.exit(1);
-}
-
-// Get secret
-let secret = process.env.npm_config_secret;
-if (!secret) {
-  // Generate a random secret
-  secret = '';
-  for (let i = 0; i < 32; i++) {
-    secret += chars.charAt(Math.floor(Math.random() * chars.length));
+(async () => {
+  console.log('––––– Generate Encoded Secret –––––');
+  console.log('\nFirst, we need info on the *receiving* server');
+  console.log('This is the server that hosts the cross-server endpoint, the one that receives requests from the sending server.\n');
+
+  // Get salt
+  console.log('Encoding salt on the *receiving* server')
+  const DCEKIT_CRED_ENCODING_SALT = await prompt('Salt: ');
+
+  // Get host
+  console.log('Hostname of the *receiving* server');
+  const host = await prompt('Host: ');
+
+  console.log('\n\nSecond, we need info on the *sending* server');
+  console.log('This is the server that sends requests to the receiving server.\n');
+
+  // Get key
+  console.log('Short unique key for the *sending* server')
+  const key = await prompt('Key: ');
+
+  // Get description
+  console.log('Human-readable description of the *sending* server')
+  const description = await prompt('Description: ');
+
+  // Get secret
+  let secret = process.env.npm_config_secret;
+  if (!secret) {
+    // Generate a random secret
+    secret = '';
+    for (let i = 0; i < 32; i++) {
+      secret += chars.charAt(Math.floor(Math.random() * chars.length));
+    }
+    console.log('Generated a random secret. If you have one in mind, use --secret=...');
   }
-  console.log('Generated a random secret. If you have one in mind, use --secret=...');
-}
-
-// Get the host name
-const host = process.env.npm_config_host;
-if (!host) {
-  console.log('Host of the receiving server is required: --host=...');
-  process.exit(1);
-}
-
-// Encryption process based on:
-// https://medium.com/@tony.infisical/guide-to-nodes-crypto-module-for-encryption-decryption-65c077176980
-
-// Create a random initialization vector
-const iv = crypto.randomBytes(12).toString('base64');
-
-// Create a cipher
-const cipher = crypto.createCipheriv(
-  'aes-256-gcm',
-  Buffer.from(secret, 'base64'),
-  Buffer.from(iv, 'base64'),
-);
-
-// Encrypt the string
-let ciphertext = cipher.update(secret, 'utf8', 'base64');
-
-// Finalize the encryption
-ciphertext += cipher.final('base64');
-
-// Get the authentication tag
-const tag = cipher.getAuthTag();
-
-// JSONify the encrypted data
-const encryptionPack = encodeURIComponent(JSON.stringify({
-  ciphertext,
-  iv,
-  tag,
-}));
-
-// Show the encrypted data
-console.log('\n\n');
-console.log('––––– Done! What\'s Next: –––––');
-console.log('');
-console.log('On the server *sending* the requests, append the following to the DCEKIT_CROSS_SERVER_CREDENTIALS env var:');
-console.log(`|${host}:${key}:${secret}|`);
-console.log('');
-console.log('On the server *receiving* the requests, add an entry to the "CrossServerCredential" collection:');
-console.log(`{ "description": "${description}", "key": "${key}", "encodedeSecret": "${encryptionPack}", "scopes": [] }`);
-console.log('');
-console.log('For all scopes that the server should have access to, add them to the "scopes" array.');
+
+  // Encryption process based on:
+  // https://medium.com/@tony.infisical/guide-to-nodes-crypto-module-for-encryption-decryption-65c077176980
+
+  // Create a random initialization vector
+  const iv = crypto.randomBytes(12).toString('base64');
+
+  // Create a cipher
+  const cipher = crypto.createCipheriv(
+    'aes-256-gcm',
+    Buffer.from(secret, 'base64'),
+    Buffer.from(iv, 'base64'),
+  );
+
+  // Encrypt the string
+  let ciphertext = cipher.update(secret, 'utf8', 'base64');
+
+  // Finalize the encryption
+  ciphertext += cipher.final('base64');
+
+  // Get the authentication tag
+  const tag = cipher.getAuthTag();
+
+  // JSONify the encrypted data
+  const encryptionPack = encodeURIComponent(JSON.stringify({
+    ciphertext,
+    iv,
+    tag,
+  }));
+
+  // Show the encrypted data
+  console.log('\n\n');
+  console.log('––––– Done! What\'s Next: –––––');
+  console.log('');
+  console.log('On the *sending* server, append the following to the DCEKIT_CROSS_SERVER_CREDENTIALS env var:');
+  console.log(`|${host}:${key}:${secret}|`);
+  console.log('');
+  console.log('On the *receiving* server, add an entry to its "CrossServerCredential" collection:');
+  console.log(`{ "description": "${description}", "key": "${key}", "encodedeSecret": "${encryptionPack}", "scopes": [] }`);
+  console.log('');
+  console.log('For all scopes that the server should have access to, add them to the "scopes" array.');
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-expresskit",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.3",
   "description": "Shared functions, helpers, and tools for Harvard DCE Express-based servers",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",