dce-reactkit 3.12.1-beta-cross-server.2 → 3.12.3

package/src/server/initServer.ts

@@ -27,9 +27,6 @@ let _cacclGetLaunchInfo: GetLaunchInfoFunction;
 // Stored copy of dce-mango log collection
 let _logCollection: any;
 
-// Stored copy of dce-mango cross-server credential collection
-let _crossServerCredentialCollection: any;
-
 /*------------------------------------------------------------------------*/
 /*                                 Helpers                                */
 /*------------------------------------------------------------------------*/
@@ -61,16 +58,6 @@ export const internalGetLogCollection = () => {
   return _logCollection ?? null;
 };
 
-/**
- * Get cross-server credential collection
- * @author Gabe Abrams
- * @return cross-server credential collection if one was included during launch or null
- *   if we don't have a cross-server credential collection (yet)
- */
-export const internalGetCrossServerCredentialCollection = () => {
-  return _crossServerCredentialCollection ?? null;
-};
-
 /*------------------------------------------------------------------------*/
 /*                                  Main                                  */
 /*------------------------------------------------------------------------*/
@@ -91,9 +78,6 @@ export const internalGetCrossServerCredentialCollection = () => {
  *   userIds are allowed to review logs. If a dce-mango collection, only
  *   Canvas admins with entries in that collection ({ userId, ...}) are allowed
  *   to review logs
- * @param [opts.crossServerCredentialCollection] mongo collection from dce-mango to use for
- *   storing cross-server credentials. If none is included, cross-server credentials
- *   are not supported
  */
 const initServer = (
   opts: {
@@ -101,12 +85,10 @@ const initServer = (
     getLaunchInfo: GetLaunchInfoFunction,
     logCollection?: any,
     logReviewAdmins?: (number[] | any),
-    crossServerCredentialCollection?: any,
   },
 ) => {
   _cacclGetLaunchInfo = opts.getLaunchInfo;
   _logCollection = opts.logCollection;
-  _crossServerCredentialCollection = opts.crossServerCredentialCollection;
 
   /*----------------------------------------*/
   /*                Logging                 */

package/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK30
+// Highest error code = DRK18
 
 /**
  * List of error codes built into the react kit
@@ -25,18 +25,6 @@ enum ReactKitErrorCode {
   NotConnected = 'DRK14',
   SelfSigned = 'DRK15',
   ResponseParseError = 'DRK16',
-  PackUnparseable = 'DRK28',
-  PackInvalidMethod = 'DRK19',
-  PackInvalidPath = 'DRK20',
-  PackInvalidCollection = 'DRK21',
-  PackInvalidCredential = 'DRK23',
-  PackInvalidScope = 'DRK22',
-  PackInvalidTimestamp = 'DRK24',
-  PackInvalidSignature = 'DRK25',
-  PackInvalidBody = 'DRK26',
-  CrossServerNoCredentialsToSignWith = 'DRK27',
-  CrossServerNoPack = 'DRK29',
-  CrossServerNoCredentialEncodingSalt = 'DRK30',
 }
 
 export default ReactKitErrorCode;

package/dist/cjs/types/helpers/dataSigner.d.ts

@@ -1,38 +0,0 @@
-/**
- * Sign data with a private reactkit key, package it into a signed data pack
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method to sign
- * @param opts.path the http request path
- * @param opts.params the data in the body to sign
- * @param opts.key the reactkit key to sign with
- * @param opts.secret the reactkit secret to sign with
- * @return the signed data
- */
-export declare const createSignedPack: (opts: {
-    method: string;
-    path: string;
-    params: {
-        [key: string]: any;
-    };
-    key: string;
-    secret: string;
-}) => string;
-/**
- * Parse signed pack. Throws an error if invalid
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method of the data validate
- * @param opts.path the http request path to validate
- * @param opts.scope the name of the scope to validate
- * @param opts.signedPack the signed data pack to validate
- * @returns parsed and validated params
- */
-export declare const parseSignedPack: (opts: {
-    method: string;
-    path: string;
-    scope: string;
-    signedPack: string;
-}) => Promise<{
-    [key: string]: any;
-}>;

package/dist/cjs/types/server/initCrossServerCredentialCollection.d.ts

@@ -1,8 +0,0 @@
-/**
- * Initialize a cross-server credential collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-declare const initCrossServerCredentialCollection: (Collection: any) => any;
-export default initCrossServerCredentialCollection;

package/dist/cjs/types/types/CrossServerCredential.d.ts

@@ -1,11 +0,0 @@
-/**
- * Single cross-server credential
- * @author Gabe Abrams
- */
-type CrossServerCredential = {
-    description: string;
-    key: string;
-    encodedeSecret: string;
-    scopes: string[];
-};
-export default CrossServerCredential;

package/dist/esm/types/helpers/dataSigner.d.ts

@@ -1,38 +0,0 @@
-/**
- * Sign data with a private reactkit key, package it into a signed data pack
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method to sign
- * @param opts.path the http request path
- * @param opts.params the data in the body to sign
- * @param opts.key the reactkit key to sign with
- * @param opts.secret the reactkit secret to sign with
- * @return the signed data
- */
-export declare const createSignedPack: (opts: {
-    method: string;
-    path: string;
-    params: {
-        [key: string]: any;
-    };
-    key: string;
-    secret: string;
-}) => string;
-/**
- * Parse signed pack. Throws an error if invalid
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method of the data validate
- * @param opts.path the http request path to validate
- * @param opts.scope the name of the scope to validate
- * @param opts.signedPack the signed data pack to validate
- * @returns parsed and validated params
- */
-export declare const parseSignedPack: (opts: {
-    method: string;
-    path: string;
-    scope: string;
-    signedPack: string;
-}) => Promise<{
-    [key: string]: any;
-}>;

package/dist/esm/types/server/initCrossServerCredentialCollection.d.ts

@@ -1,8 +0,0 @@
-/**
- * Initialize a cross-server credential collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-declare const initCrossServerCredentialCollection: (Collection: any) => any;
-export default initCrossServerCredentialCollection;

package/dist/esm/types/types/CrossServerCredential.d.ts

@@ -1,11 +0,0 @@
-/**
- * Single cross-server credential
- * @author Gabe Abrams
- */
-type CrossServerCredential = {
-    description: string;
-    key: string;
-    encodedeSecret: string;
-    scopes: string[];
-};
-export default CrossServerCredential;

package/genEncodedSecret.ts

@@ -1,28 +0,0 @@
-// Import jwt
-import jwt from 'jwt-simple';
-
-// Get args
-let { REACTKIT_CRED_ENCODING_SALT } = process.env;
-if (!REACTKIT_CRED_ENCODING_SALT) {
-  REACTKIT_CRED_ENCODING_SALT = process.env.npm_config_salt;
-}
-if (!REACTKIT_CRED_ENCODING_SALT) {
-  console.log('REACTKIT_CRED_ENCODING_SALT is required either as an environment variable or as: --salt=...');
-  process.exit(1);
-}
-
-// Get secret
-let secret = process.env.npm_config_secret;
-if (!secret) {
-  // Generate a random secret
-  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-  secret = '';
-  for (let i = 0; i < 64; i++) {
-    secret += chars.charAt(Math.floor(Math.random() * chars.length));
-  }
-  console.log('Generated a random secret. If you have one in mind, use --secret=...');
-}
-
-// Encode the secret
-const encodedSecret = jwt.encode(secret, REACTKIT_CRED_ENCODING_SALT);
-console.log(`\nNew Secret Generated!\n\nSecret: ${secret}\n\nEncoded Secret: ${encodedSecret}`);

package/src/helpers/dataSigner.ts

@@ -1,232 +0,0 @@
-// Import crypto
-import { createHash } from 'crypto';
-
-// Import jwt
-import jwt from 'jwt-simple';
-
-// Import shared helpers
-import { internalGetCrossServerCredentialCollection } from '../server/initServer';
-
-// Import shared types
-import ErrorWithCode from '../errors/ErrorWithCode';
-import ReactKitErrorCode from '../types/ReactKitErrorCode';
-import CrossServerCredential from '../types/CrossServerCredential';
-
-// Import shared constants
-import MINUTE_IN_MS from '../constants/MINUTE_IN_MS';
-
-/*------------------------------------------------------------------------*/
-/* ------------------------------ Encoding ------------------------------ */
-/*------------------------------------------------------------------------*/
-
-/**
- * Validate a JWT token
- * @author Gabe Abrams
- * @param encodedSecret the encoded secret
- * @return the secret
- */
-const decodeCredentialSecret = (encodedSecret: string): string => {
-  // Get the credential encoding salt
-  const credentialEncodingSalt = process.env.REACTKIT_CRED_ENCODING_SALT;
-  if (!credentialEncodingSalt) {
-    throw new ErrorWithCode(
-      'Cannot decode a cross-server credential secret because the credential encoding salt was not found in env.',
-      ReactKitErrorCode.CrossServerNoCredentialEncodingSalt,
-    );
-  }
-
-  // Decode the secret
-  return jwt.decode(encodedSecret, credentialEncodingSalt);
-};
-
-/*------------------------------------------------------------------------*/
-/* ------------------------------- Signing ------------------------------ */
-/*------------------------------------------------------------------------*/
-
-/**
- * Sign using sha 256
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.pack the pack to sign
- * @param opts.secret the reactkit secret to sign with
- * @return the signed hash
- */
-const genSignature = (
-  opts: {
-    pack: string,
-    secret: string,
-  },
-): string => {
-  // Generate signature
-  return (
-    createHash('sha256')
-      .update(JSON.stringify({ pack: opts.pack, secret: opts.secret }))
-      .digest('base64')
-  );
-};
-
-/**
- * Sign data with a private reactkit key, package it into a signed data pack
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method to sign
- * @param opts.path the http request path
- * @param opts.params the data in the body to sign
- * @param opts.key the reactkit key to sign with
- * @param opts.secret the reactkit secret to sign with
- * @return the signed data
- */
-export const createSignedPack = (
-  opts: {
-    method: string,
-    path: string,
-    params: { [key: string]: any },
-    key: string,
-    secret: string,
-  },
-): string => {
-  // Create a timestamp
-  const timestamp = Date.now();
-
-  // Create the pack
-  const pack = JSON.stringify({
-    method: opts.method,
-    path: opts.path,
-    params: opts.params,
-    key: opts.key,
-    timestamp,
-  });
-
-  // Generate signature
-  const signature = genSignature({
-    pack,
-    secret: opts.secret,
-  });
-
-  // Create a signed pack
-  const signedPack = encodeURIComponent(JSON.stringify({
-    pack,
-    signature,
-  }));
-
-  // Return the signed pack
-  return signedPack;
-};
-
-/**
- * Parse signed pack. Throws an error if invalid
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.method the method of the data validate
- * @param opts.path the http request path to validate
- * @param opts.scope the name of the scope to validate
- * @param opts.signedPack the signed data pack to validate
- * @returns parsed and validated params
- */
-export const parseSignedPack = async (
-  opts: {
-    method: string,
-    path: string,
-    scope: string,
-    signedPack: string,
-  },
-): Promise<{ [key: string]: any }> => {
-  // Extract signature
-  let pack: string;
-  let signature: string;
-  let method: string;
-  let path: string;
-  let key: string;
-  let timestamp: number;
-  let params: { [k: string]: any };
-  try {
-    ({
-      pack,
-      signature,
-    } = JSON.parse(decodeURIComponent(opts.signedPack)));
-
-    // Unpack
-    ({
-      method,
-      path,
-      params,
-      key,
-      timestamp,
-    } = JSON.parse(pack));
-  } catch (err) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the request could not be parsed.',
-      ReactKitErrorCode.PackUnparseable,
-    );
-  }
-
-  // Make sure the method and path match
-  if (method !== opts.method) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the method did not match.',
-      ReactKitErrorCode.PackInvalidMethod,
-    );
-  }
-  if (path !== opts.path) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the path did not match.',
-      ReactKitErrorCode.PackInvalidPath,
-    );
-  }
-
-  // Make sure the timestamp was recent enough
-  const elapsedMs = Math.abs(Date.now() - timestamp);
-  if (elapsedMs < MINUTE_IN_MS) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the request was too old.',
-      ReactKitErrorCode.PackInvalidTimestamp,
-    );
-  }
-
-  // Get the cross-server credential collection
-  const crossServerCredentialCollection = internalGetCrossServerCredentialCollection();
-  if (!crossServerCredentialCollection) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the cross-server credential collection was not ready in time.',
-      ReactKitErrorCode.PackInvalidCollection,
-    );
-  }
-
-  // Get the cross-server credential
-  const crossServerCredential: CrossServerCredential = await crossServerCredentialCollection.find({ key });
-  if (!crossServerCredential) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the credential was not found.',
-      ReactKitErrorCode.PackInvalidCredential,
-    );
-  }
-
-  // Make sure the scope is included
-  const allowedScopes = crossServerCredential.scopes;
-  if (!allowedScopes.includes(opts.scope)) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the scope was not included.',
-      ReactKitErrorCode.PackInvalidScope,
-    );
-  }
-
-  // Decode the secret
-  const secret = decodeCredentialSecret(crossServerCredential.encodedeSecret);
-
-  // Generate signature
-  const expectedSignature = genSignature({
-    pack,
-    secret,
-  });
-
-  // Make sure the signature matches
-  if (signature !== expectedSignature) {
-    throw new ErrorWithCode(
-      'Could not validate a cross-server request because the signature did not match.',
-      ReactKitErrorCode.PackInvalidSignature,
-    );
-  }
-
-  // Return body
-  return params ?? {};
-};

package/src/server/initCrossServerCredentialCollection.ts

@@ -1,16 +0,0 @@
-/**
- * Initialize a cross-server credential collection given the dce-mango Collection class
- * @author Gabe Abrams
- * @param Collection the Collection class from dce-mango
- * @returns initialized logCollection
- */
-const initCrossServerCredentialCollection = (Collection: any) => {
-  return new Collection(
-    'CrossServerCredential',
-    {
-      uniqueIndexKey: 'key',
-    },
-  );
-};
-
-export default initCrossServerCredentialCollection;

package/src/types/CrossServerCredential.ts

@@ -1,16 +0,0 @@
-/**
- * Single cross-server credential
- * @author Gabe Abrams
- */
-type CrossServerCredential = {
-  // Description of the credential (human-readable)
-  description: string,
-  // The key of the credential
-  key: string,
-  // The encoded secret of the credential
-  encodedeSecret: string,
-  // The list of scopes for the credential
-  scopes: string[],
-};
-
-export default CrossServerCredential;