fix: framLength is not passed to the CMM (#190)

resolves: #161

The CMM accepts `plaintextLength` but not `frameLenth`.

Author: seebees

modules/cache-material/src/caching_cryptographic_materials_decorators.ts

@@ -70,7 +70,7 @@ export function getEncryptionMaterials<S extends SupportedAlgorithmSuites> (
     this: CachingMaterialsManager<S>,
     request: EncryptionRequest<S>
   ): Promise<EncryptionMaterial<S>> {
-    const { suite, encryptionContext, frameLength, plaintextLength } = request
+    const { suite, encryptionContext, plaintextLength } = request
     /* Check for early return (Postcondition): If I can not cache the EncryptionMaterial, do not even look. */
     if ((suite && !suite.cacheSafe) || typeof plaintextLength !== 'number' || plaintextLength < 0) {
       return this
@@ -92,7 +92,7 @@ export function getEncryptionMaterials<S extends SupportedAlgorithmSuites> (
       /* Strip any information about the plaintext from the backing request,
        * because the resulting response may be used to encrypt multiple plaintexts.
        */
-      .getEncryptionMaterials({ suite, encryptionContext, frameLength })
+      .getEncryptionMaterials({ suite, encryptionContext, plaintextLength })
 
     /* Check for early return (Postcondition): If I can not cache the EncryptionMaterial, just return it. */
     if (!material.suite.cacheSafe) return material

modules/encrypt-browser/src/encrypt.ts

@@ -80,7 +80,6 @@ export async function encrypt (
   const encryptionRequest: WebCryptoEncryptionRequest = {
     suite,
     encryptionContext,
-    frameLength,
     plaintextLength
   }
 

modules/encrypt-node/src/encrypt_stream.ts

@@ -56,7 +56,7 @@ export function encryptStream (
   cmm: KeyringNode|NodeMaterialsManager,
   op: EncryptStreamInput = {}
 ): Duplex {
-  const { suiteId, encryptionContext = {}, frameLength = FRAME_LENGTH } = op
+  const { suiteId, encryptionContext = {}, frameLength = FRAME_LENGTH, plaintextLength } = op
 
   /* Precondition: The frameLength must be less than the maximum frame size Node.js stream. */
   needs(frameLength > 0 && Maximum.FRAME_SIZE >= frameLength, `frameLength out of bounds: 0 > frameLength >= ${Maximum.FRAME_SIZE}`)
@@ -70,7 +70,7 @@ export function encryptStream (
 
   const wrappingStream = new Duplexify()
 
-  cmm.getEncryptionMaterials({ suite, encryptionContext, frameLength })
+  cmm.getEncryptionMaterials({ suite, encryptionContext, plaintextLength })
     .then(async (material) => {
       const { dispose, getSigner } = getEncryptHelper(material)
 

modules/material-management/src/types.ts

@@ -45,7 +45,6 @@ export type MixedBackendCryptoKey = {
 export interface EncryptionRequest<S extends NodeAlgorithmSuite|WebCryptoAlgorithmSuite> {
   readonly suite?: S
   readonly encryptionContext: EncryptionContext
-  readonly frameLength?: number
   readonly plaintextLength?: number
 }