feat: initial commit for encrypt-browser (#13)

Encrypt Browser

Author: seebees

modules/encrypt-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/encrypt-browser/NOTICE

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

modules/encrypt-browser/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@aws-crypto/encrypt-browser",
+  "private": true,
+  "version": "0.0.1",
+  "scripts": {
+    "prepublishOnly": "tsc -p tsconfig.json && tsc -p tsconfig.module.json",
+    "lint": "standard src/*.ts test/**/*.ts",
+    "mocha": "mocha --require ts-node/register test/**/*test.ts",
+    "test": "npm run lint && npm run coverage",
+    "coverage": "nyc -e .ts npm run mocha"
+  },
+  "author": {
+    "name": "AWS Crypto Tools Team",
+    "email": "[email protected]",
+    "url": "https://github.com/awslabs/aws-encryption-sdk-javascript"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@aws-crypto/material-management-browser": "^0.0.1",
+    "@aws-crypto/serialize": "^0.0.1",
+    "@aws-crypto/web-crypto-backend": "^0.0.1",
+    "@aws-sdk/util-utf8-browser": "0.1.0-preview.1",
+    "tslib": "^1.9.3"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.1.4",
+    "@types/mocha": "^5.2.5",
+    "@types/node": "^11.11.4",
+    "@typescript-eslint/eslint-plugin": "^1.4.2",
+    "@typescript-eslint/parser": "^1.4.2",
+    "chai": "^4.1.2",
+    "mocha": "^5.2.0",
+    "nyc": "^12.0.2",
+    "standard": "^12.0.1",
+    "ts-node": "^7.0.1",
+    "typescript": "^3.2.0"
+  },
+  "sideEffects": false,
+  "main": "./build/main/index.js",
+  "module": "./build/module/index.js",
+  "types": "./build/main/index.d.ts",
+  "files": ["./build/**/*"],
+  "standard": {
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ]
+  }
+}

modules/encrypt-browser/src/encrypt.ts

@@ -0,0 +1,127 @@
+/*
+ * 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.
+ */
+
+import {
+  WebCryptoAlgorithmSuite,
+  WebCryptoCryptographicMaterialsManager, // eslint-disable-line no-unused-vars
+  WebCryptoEncryptionRequest, // eslint-disable-line no-unused-vars
+  EncryptionContext, // eslint-disable-line no-unused-vars
+  AlgorithmSuiteIdentifier,
+  getEncryptHelper
+} from '@aws-crypto/material-management-browser'
+import {
+  serializeFactory,
+  aadFactory,
+  kdfInfo,
+  concatBuffers,
+  MessageHeader, // eslint-disable-line no-unused-vars
+  SerializationVersion,
+  ObjectType,
+  ContentType
+} from '@aws-crypto/serialize'
+import { fromUtf8 } from '@aws-sdk/util-utf8-browser'
+import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend'
+
+const serialize = serializeFactory(fromUtf8)
+const { messageAADContentString, messageAAD } = aadFactory(fromUtf8)
+
+export interface EncryptInput {
+  suiteId?: AlgorithmSuiteIdentifier
+  encryptionContext?: EncryptionContext
+  // frameLength?: number // Subtle Crypto functions are all one-shot, so frames and length are === plaintext.byteLength
+  // plaintextLength?: number // Subtle Crypto functions are all one-shot, so frames and length are === plaintext.byteLength
+}
+
+export interface EncryptResult {
+  messageHeader: MessageHeader
+  cipherMessage: Uint8Array
+}
+
+export async function encrypt (
+  cmm: WebCryptoCryptographicMaterialsManager,
+  plaintext: Uint8Array,
+  { suiteId, encryptionContext }: EncryptInput = {}
+): Promise<EncryptResult> {
+  const backend = await getWebCryptoBackend()
+  if (!backend) throw new Error('No supported crypto backend')
+
+  // Subtle Crypto functions are all one-shot so all the plaintext needs to be available.
+  const plaintextLength = plaintext.byteLength
+  const frameLength = plaintextLength + 1
+  const suite = suiteId ? new WebCryptoAlgorithmSuite(suiteId) : new WebCryptoAlgorithmSuite(AlgorithmSuiteIdentifier.ALG_AES256_GCM_IV12_TAG16_HKDF_SHA384_ECDSA_P384)
+
+  const encryptionRequest: WebCryptoEncryptionRequest = {
+    suite,
+    encryptionContext,
+    frameLength,
+    plaintextLength
+  }
+
+  const { material, context } = await cmm.getEncryptionMaterials(encryptionRequest)
+  const { kdfGetSubtleEncrypt, subtleSign, dispose } = await getEncryptHelper(material)
+
+  // Why is this here?
+  const idLength = 16
+  const messageId = await backend.randomValues(idLength)
+
+  const { id, ivLength } = material.suite
+
+  const messageHeader: MessageHeader = {
+    version: SerializationVersion.V1,
+    type: ObjectType.CUSTOMER_AE_DATA,
+    suiteId: id,
+    messageId,
+    encryptionContext: context,
+    encryptedDataKeys: material.encryptedDataKeys,
+    contentType: ContentType.FRAMED_DATA,
+    headerIvLength: ivLength,
+    frameLength
+  }
+
+  const header = serialize.serializeMessageHeader(messageHeader)
+  const info = kdfInfo(id, messageId)
+  const getSubtleEncrypt = kdfGetSubtleEncrypt(info)
+
+  const headerAuthIv = serialize.headerAuthIv(ivLength)
+  const headerAuthTag = await getSubtleEncrypt(headerAuthIv, header)(new Uint8Array(0))
+
+  const sequenceNumber = 1
+  const frameIv = serialize.frameIv(ivLength, sequenceNumber)
+  const finalFrameHeader = serialize.finalFrameHeader(sequenceNumber, frameIv, plaintextLength)
+  const messageAdditionalData = messageAAD(
+    messageId,
+    messageAADContentString({ contentType: messageHeader.contentType, isFinalFrame: true }),
+    sequenceNumber,
+    plaintextLength
+  )
+
+  const cipherBufferAndAuthTag = await getSubtleEncrypt(frameIv, messageAdditionalData)(plaintext)
+  const cipherMessage = concatBuffers(
+    header,
+    headerAuthIv,
+    headerAuthTag,
+    finalFrameHeader,
+    cipherBufferAndAuthTag
+  )
+
+  dispose()
+
+  if (typeof subtleSign === 'function') {
+    const signature = await subtleSign(cipherMessage)
+    return { cipherMessage: concatBuffers(cipherMessage, signature), messageHeader }
+  } else {
+    return { cipherMessage, messageHeader }
+  }
+}