test pass

Author: seebees

modules/cache-material/src/caching_cryptographic_materials_decorators.ts

@@ -87,32 +87,32 @@ export function getEncryptionMaterials<S extends SupportedAlgorithmSuites> (
       this._cache.del(cacheKey)
     }
 
-    const response = await this
+    const material = await this
       ._backingMaterialsManager
       /* 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 })
 
     /* Check for early return (Postcondition): If I can not cache the EncryptionResponse, just return it. */
-    if (!response.suite.cacheSafe) return response
+    if (!material.suite.cacheSafe) return material
 
     /* It is possible for an entry to exceed limits immediately.
      * The simplest case is to need to encrypt more than then maxBytesEncrypted.
      * In this case, I return the response to encrypt the data,
      * but do not put a know invalid item into the cache.
      */
     const testEntry = {
-      response,
+      response: material,
       now: Date.now(),
       messagesEncrypted: 1,
       bytesEncrypted: plaintextLength
     }
     if (!this._cacheEntryHasExceededLimits(testEntry)) {
-      this._cache.putEncryptionResponse(cacheKey, response, plaintextLength, this._maxAge)
+      this._cache.putEncryptionResponse(cacheKey, material, plaintextLength, this._maxAge)
     }
 
-    return cloneResponse(response)
+    return cloneResponse(material)
   }
 }
 
@@ -140,12 +140,12 @@ export function decryptMaterials<S extends SupportedAlgorithmSuites> (
       this._cache.del(cacheKey)
     }
 
-    const response = await this
+    const material = await this
       ._backingMaterialsManager
       .decryptMaterials(request)
 
-    this._cache.putDecryptionResponse(cacheKey, response, this._maxAge)
-    return cloneResponse(response)
+    this._cache.putDecryptionResponse(cacheKey, material, this._maxAge)
+    return cloneResponse(material)
   }
 }
 

modules/cache-material/test/caching_cryptographic_materials_decorators.test.ts

@@ -216,25 +216,17 @@ describe('Cryptographic Material Functions', () => {
     .setUnencryptedDataKey(udk128, trace)
 
   const context = {}
-  const encryptionResponse = {
-    material: encryptionMaterial,
-    context
-  }
-  const decryptionResponse = {
-    material: decryptionMaterial,
-    context
-  }
 
   const _maxAge = 10
   const _maxBytesEncrypted = 10
   const _maxMessagesEncrypted = 10
   const _cache = getLocalCryptographicMaterialsCache(100)
   const _backingMaterialsManager = {
     getEncryptionMaterials () {
-      return encryptionResponse
+      return encryptionMaterial
     },
     decryptMaterials () {
-      return decryptionResponse
+      return decryptionMaterial
     }
   } as any
   const _partition = 'partition'
@@ -268,11 +260,9 @@ describe('Cryptographic Material Functions', () => {
         plaintextLength: 10
       })
       // The response must be cloned... i.e. not the same.
-      expect(test === encryptionResponse).to.equal(false)
-      // the material must be cloned... because after use it will be zeroed
-      expect(test.material === encryptionResponse.material).to.equal(false)
-      expect(test.context === encryptionResponse.context).to.equal(true)
-      expect(test.material.getUnencryptedDataKey()).to.deep.equal(encryptionMaterial.getUnencryptedDataKey())
+      expect(test === encryptionMaterial).to.equal(false)
+      expect(test.encryptionContext).to.deep.equal(encryptionMaterial.encryptionContext)
+      expect(test.getUnencryptedDataKey()).to.deep.equal(encryptionMaterial.getUnencryptedDataKey())
     })
   })
 
@@ -284,11 +274,9 @@ describe('Cryptographic Material Functions', () => {
         encryptedDataKeys: [edk1]
       })
       // The response must be cloned... i.e. not the same.
-      expect(test === decryptionResponse).to.equal(false)
-      // the material must be cloned... because after use it will be zeroed
-      expect(test.material === decryptionResponse.material).to.equal(false)
-      expect(test.context === decryptionResponse.context).to.equal(true)
-      expect(test.material.getUnencryptedDataKey()).to.deep.equal(decryptionMaterial.getUnencryptedDataKey())
+      expect(test === decryptionMaterial).to.equal(false)
+      expect(test.encryptionContext).to.deep.equal(decryptionMaterial.encryptionContext)
+      expect(test.getUnencryptedDataKey()).to.deep.equal(decryptionMaterial.getUnencryptedDataKey())
     })
   })
 })

modules/cache-material/test/get_local_cryptographic_materials_cache.test.ts

@@ -40,9 +40,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('putEncryptionResponse', () => {
     const key = 'some encryption key'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key, response, 1)
     const test = getEncryptionResponse(key, 1)
@@ -54,9 +52,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
   })
 
   it('Precondition: putEncryptionResponse plaintextLength can not be negative.', () => {
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
     const u: any = undefined
     const s: any = 'not-number'
     const n = -1
@@ -67,9 +63,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('Postcondition: Only return EncryptionMaterial.', () => {
     const key = 'some decryption key'
-    const response: any = {
-      material: decryptionMaterial
-    }
+    const response: any = decryptionMaterial
 
     putDecryptionResponse(key, response)
     expect(() => getEncryptionResponse(key, 1)).to.throw()
@@ -78,18 +72,14 @@ describe('getLocalCryptographicMaterialsCache', () => {
   it('Precondition: Only cache EncryptionMaterial that is cacheSafe.', () => {
     const key = 'some encryption key'
     const suite = new NodeAlgorithmSuite(AlgorithmSuiteIdentifier.ALG_AES128_GCM_IV12_TAG16)
-    const response: any = {
-      material: new NodeEncryptionMaterial(suite, {})
-    }
+    const response: any = new NodeEncryptionMaterial(suite, {})
 
     expect(() => putEncryptionResponse(key, response, 1)).to.throw()
   })
 
   it('putDecryptionResponse', () => {
     const key = 'some decryption key'
-    const response: any = {
-      material: decryptionMaterial
-    }
+    const response: any = decryptionMaterial
 
     putDecryptionResponse(key, response)
     const test = getDecryptionResponse(key)
@@ -102,19 +92,15 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('Precondition: Only cache DecryptionMaterial.', () => {
     const key = 'some decryption key'
-    const response: any = {
-      material: 'not material'
-    }
+    const response: any = 'not material'
 
     expect(() => putDecryptionResponse(key, response)).to.throw()
   })
 
   it('Precondition: Only cache DecryptionMaterial that is cacheSafe.', () => {
     const key = 'some decryption key'
     const suite = new NodeAlgorithmSuite(AlgorithmSuiteIdentifier.ALG_AES128_GCM_IV12_TAG16)
-    const response: any = {
-      material: new NodeEncryptionMaterial(suite, {})
-    }
+    const response: any = new NodeEncryptionMaterial(suite, {})
 
     expect(() => putDecryptionResponse(key, response)).to.throw()
   })
@@ -135,9 +121,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('Precondition: Only cache EncryptionMaterial.', () => {
     const key = 'some encryption key'
-    const response: any = {
-      material: 'not material'
-    }
+    const response: any = 'not material'
 
     expect(() => putEncryptionResponse(key, response, 1)).to.throw()
   })
@@ -149,9 +133,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('Postcondition: Only return DecryptionMaterial.', () => {
     const key = 'some encryption key'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key, response, 1)
     expect(() => getDecryptionResponse(key))
@@ -163,9 +145,7 @@ describe('getLocalCryptographicMaterialsCache', () => {
 
   it('zero is an acceptable plaintextLength', () => {
     const key = 'some encryption key'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key, response, 0)
     const test = getEncryptionResponse(key, 0)
@@ -186,9 +166,7 @@ describe('cache eviction', () => {
 
     const key1 = 'key lost'
     const key2 = 'key replace'
-    const response: any = {
-      material: decryptionMaterial
-    }
+    const response: any = decryptionMaterial
 
     putDecryptionResponse(key1, response)
     putDecryptionResponse(key2, response)
@@ -206,9 +184,7 @@ describe('cache eviction', () => {
     } = getLocalCryptographicMaterialsCache(1)
 
     const key = 'key deleted'
-    const response: any = {
-      material: decryptionMaterial
-    }
+    const response: any = decryptionMaterial
 
     putDecryptionResponse(key, response)
     del(key)
@@ -223,9 +199,7 @@ describe('cache eviction', () => {
     } = getLocalCryptographicMaterialsCache(1, 10)
 
     const key = 'key lost'
-    const response: any = {
-      material: decryptionMaterial
-    }
+    const response: any = decryptionMaterial
 
     putDecryptionResponse(key, response, 1)
     await new Promise(resolve => setTimeout(resolve, 20))
@@ -241,9 +215,7 @@ describe('cache eviction', () => {
 
     const key1 = 'key lost'
     const key2 = 'key replace'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key1, response, 0)
     putEncryptionResponse(key2, response, 0)
@@ -261,9 +233,7 @@ describe('cache eviction', () => {
     } = getLocalCryptographicMaterialsCache(1, 10)
 
     const key = 'key lost'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key, response, 1, 1)
     del(key)
@@ -278,9 +248,7 @@ describe('cache eviction', () => {
     } = getLocalCryptographicMaterialsCache(1, 10)
 
     const key = 'key lost'
-    const response: any = {
-      material: encryptionMaterial
-    }
+    const response: any = encryptionMaterial
 
     putEncryptionResponse(key, response, 1, 1)
     await new Promise(resolve => setTimeout(resolve, 20))

modules/material-management-browser/test/browser_cryptographic_materials_manager.test.ts

@@ -103,7 +103,7 @@ describe('WebCryptoDefaultCryptographicMaterialsManager', () => {
     expect(encryptionContext).to.have.haveOwnProperty('some').and.to.equal('context')
   })
 
-  it('set a verificationKey from context', async () => {
+  it('set a verificationKey from encryption context', async () => {
     class TestKeyring extends KeyringWebCrypto {
       async _onEncrypt (): Promise<WebCryptoEncryptionMaterial> {
         throw new Error('I should never see this error')
@@ -179,7 +179,7 @@ describe('WebCryptoDefaultCryptographicMaterialsManager', () => {
     expect(cmm._initializeDecryptionMaterial(suite, context)).to.rejectedWith(Error)
   })
 
-  it('can return an encryption response', async () => {
+  it('can return a encryption material', async () => {
     class TestKeyring extends KeyringWebCrypto {
       async _onEncrypt (material: WebCryptoEncryptionMaterial): Promise<WebCryptoEncryptionMaterial> {
         const udk = synchronousRandomValues(suite.keyLengthBytes)
@@ -288,7 +288,7 @@ describe('WebCryptoDefaultCryptographicMaterialsManager', () => {
     expect(cmm.getEncryptionMaterials({ encryptionContext })).to.rejectedWith(Error)
   })
 
-  it('can return a decryption response', async () => {
+  it('can return decryption material', async () => {
     class TestKeyring extends KeyringWebCrypto {
       async _onEncrypt (): Promise<WebCryptoEncryptionMaterial> {
         throw new Error('I should never see this error')