feat: integration-browser (#68)

A module to help test the Encryption SDK by using aws-encryption-sdk-test-vectors

Author: seebees

.gitignore

@@ -10,6 +10,7 @@
 build
 node_modules
 package-lock.json
+package.json.decrypt
 
 # VSCode
 .vscode
@@ -21,10 +22,12 @@ coverage
 
 # symlink to test vectors
 /modules/integration-node/fixtures
+/modules/integration-browser/fixtures
 
 # Lerna
 /lerna-debug.log
 
 # TypeScript config is built by ./util/bootstrap_tsconfig
 /tsconfig.json
+/tsconfig.module.json
 package.json.decrypt

lerna.json

@@ -1,5 +1,5 @@
 {
-  "lerna": "2.11.0",
+  "lerna": "3.13.3",
   "packages": [
     "modules/*"
   ],

modules/integration-browser/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

modules/integration-browser/NOTICE

@@ -0,0 +1,2 @@
+AWS Encryption SDK for Javascript
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. 

modules/integration-browser/Readme.md

@@ -0,0 +1,11 @@
+# AWS Encryption SDK for Javascript Browser Integration
+
+This repository is for compatibility tests with the other versions of the AWS Encryption SDK's.
+It's purpose is to facilitate testing the set of test vectors the AWS Encryption SDK.
+The test vectors can be found at [email protected]:awslabs/aws-encryption-sdk-test-vectors.git
+
+# To test browser compatibility
+
+1. Get a manifest zip file from aws-encryption-sdk-test-vectors or a supported format.
+1. Use `npm run build_fixtures -- -v path/to/zip` to extract the fixtures from the zip file
+1. Run `npm run karma` execute the extracted tests

modules/integration-browser/build_fixtures

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+/*
+ * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+ * this file except in compliance with the License. A copy of the License is
+ * located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const argv = require('yargs')
+  .option('vectorFile', {
+    alias: 'v',
+    describe: 'a vector zip file from aws-encryption-sdk-test-vectors',
+    demandOption: true,
+    type: 'string'
+  })
+  .option('testName', {
+    alias: 't',
+    describe: 'an optional test name to execute',
+    type: 'string'
+  })
+  .option('slice', {
+    alias: 's',
+    describe: 'an optional range start:end e.g. 100:200',
+    type: 'string'
+  })
+  .options('karma', {
+    alias: 'k',
+    describe: 'start karma and run the tests',
+    type: 'boolean'
+  })
+  .argv
+
+const { vectorFile, testName, slice, karma } = argv
+const {Open} = require('unzipper')
+const streamToPromise = require('stream-to-promise')
+const fs = require('fs')
+const path = require('path')
+const { spawnSync } = require('child_process')
+const fixtures = path.join(__dirname, './fixtures')
+
+const [start=0, end=9999] = (slice || '').split(':').map(n => parseInt(n, 10))
+
+if (!fs.existsSync(fixtures)){
+  fs.mkdirSync(fixtures)
+}
+
+;(async () => {
+  const centralDirectory = await Open.file(vectorFile)
+  const filesMap = new Map(centralDirectory.files.map(file => [file.path, file]))
+
+  const readUriOnce = (() => {
+    const cache = new Map()
+    return async (uri) => {
+      const has = cache.get(uri)
+      if (has) return has
+      const fileInfo = filesMap.get(testUri2Path(uri))
+      if (!fileInfo) throw new Error(`${uri} does not exist`)
+      const buffer = await fileInfo.buffer()
+      cache.set(uri, buffer)
+      return buffer
+    }
+  })()
+
+  const manifestBuffer = await readUriOnce('manifest.json')
+  const { keys: keysFile, tests } = JSON.parse(manifestBuffer.toString('utf8'))
+  const keysBuffer = await readUriOnce(keysFile)
+  const { keys } = JSON.parse(keysBuffer.toString('utf8'))
+  const testNames = []
+  let count = 0
+
+  for (const [name, testInfo] of Object.entries(tests)) {
+    count += 1
+
+    if (testName) {
+      if (name !== testName) continue
+    }
+
+    if (slice) {
+      if (start >= count) continue
+      if (count > end) continue
+    }
+
+    testNames.push(name)
+
+    const { plaintext: plaintextFile, ciphertext, 'master-keys': masterKeys } = testInfo
+    const plainTextInfo = filesMap.get(testUri2Path(plaintextFile))
+    const cipherInfo = filesMap.get(testUri2Path(ciphertext))
+    if (!cipherInfo || !plainTextInfo) throw new Error(`no file for ${name}: ${ciphertext} | ${plaintextFile}`)
+    
+    const cipherText = await streamToPromise(cipherInfo.stream())
+    const plainText = await readUriOnce(plainTextInfo.path)
+    const keysInfo = masterKeys.map(keyInfo => {
+      const key = keys[keyInfo.key]
+      if (!key) throw new Error(`no key for ${name}`)
+      return [keyInfo, key]
+    })
+
+    const test = JSON.stringify({
+      name,
+      keysInfo,
+      cipherFile: cipherInfo.path,
+      cipherText: cipherText.toString('base64'),
+      plainText: plainText.toString('base64')
+    })
+
+    fs.writeFileSync(`${fixtures}/${name}.json`, test)
+  }
+
+  fs.writeFileSync(`${fixtures}/tests.json`, JSON.stringify(testNames))
+
+  if (karma) {
+    spawnSync('npm', ['run', 'karma'], {
+      cwd: __dirname,
+      stdio: 'inherit'
+    })
+  }
+})()
+
+function testUri2Path (uri) {
+  return uri.replace('file://', '')
+}