@estoc/didcomm-node 0.4.1-estoc.1

package/LICENSE

@@ -0,0 +1,176 @@
+                              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

package/README.md

@@ -0,0 +1,282 @@
+# DIDComm
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Basic [DIDComm v2](https://identity.foundation/didcomm-messaging/spec) support for modern browsers and NodeJS.
+
+## Estoc fork
+
+`@estoc/didcomm` and `@estoc/didcomm-node` are built from [estoc-net/didcomm-rust](https://github.com/estoc-net/didcomm-rust),
+a fork of [sicpa-dlab/didcomm-rust](https://github.com/sicpa-dlab/didcomm-rust) 0.4.1.
+Versions are `<upstream version>-estoc.<n>`.
+
+Changes from upstream:
+
+- `UnpackOptions.verify_from_prior` (default `true`). When `false`, `Message.unpack` keeps the raw `from_prior` JWT
+  in the returned message without resolving its issuer DID, and leaves `from_prior` and `from_prior_issuer_kid`
+  in the metadata unset. Verify it separately with `FromPrior.unpack`.
+
+## Under the hood
+
+This package is written in Rust using [didcomm](<(https://img.shields.io/crates/v/didcomm)>) crate. It compiles
+to `wasm32` and exposes Javascript/Typescript API with [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) help.
+Also [wasmp-pack](https://github.com/rustwasm/wasm-pack) helps in packaging and publishing.
+
+## Usage
+
+To use `didcomm` install it with npm
+
+```sh
+npm install @estoc/didcomm --save # If you plan use webpack or other bundler
+
+npm install @estoc/didcomm-node --save # If you plan use it without bundlers in NodeJS
+
+```
+
+## Run demo
+
+```sh
+WASM_TARGET=nodejs make # builds NodeJS package in pkg directory
+cd ./demo
+npm install
+npm run start
+```
+
+## Assumptions and Limitations
+
+- This library requires `wasm32` compatible environment (modern browsers and recent NodeJS are supported).
+- In order to use the library, `SecretsResolver` and `DIDResolver` interfaces must be implemented on the application level.
+  Demo application provides 2 simple implementations `ExampleDIDResolver`
+  and `ExampleSecretsResolver` that allows resolve locally known DID docs and secrets for tests/demo purposes.
+  - Verification materials are expected in JWK, Base58 and Multibase (internally Base58 only) formats.
+      - In Base58 and Multibase formats, keys using only X25519 and Ed25519 curves are supported.
+      - For private keys in Base58 and Multibase formats, the verification material value contains both private and public parts (concatenated bytes).
+      - In Multibase format, bytes of the verification material value is prefixed with the corresponding Multicodec code.
+  - Key IDs (kids) used in `SecretsResolver` must match the corresponding key IDs from DID Doc verification methods.
+  - Key IDs (kids) in DID Doc verification methods and secrets must be a full [DID Fragment](https://www.w3.org/TR/did-core/#fragment), that is `did#key-id`.
+  - Verification methods referencing another DID Document are not supported (see [Referring to Verification Methods](https://www.w3.org/TR/did-core/#referring-to-verification-methods)).
+- The following curves and algorithms are supported:
+  - Encryption:
+    - Curves: X25519, P-256
+    - Content encryption algorithms:
+      - XC20P (to be used with ECDH-ES only, default for anoncrypt),
+      - A256GCM (to be used with ECDH-ES only),
+      - A256CBC-HS512 (default for authcrypt)
+    - Key wrapping algorithms: ECDH-ES+A256KW, ECDH-1PU+A256KW
+  - Signing:
+    - Curves: Ed25519, Secp256k1, P-256
+    - Algorithms: EdDSA (with crv=Ed25519), ES256, ES256K
+- Forward protocol is implemented and used by default.
+- DID rotation (`fromPrior` field) is supported.
+- DIDComm has been implemented under the following [Assumptions](https://hackmd.io/i3gLqgHQR2ihVFV5euyhqg)
+
+## Examples
+
+A general usage of the API is the following:
+
+- Sender Side:
+  - Build a `Message` (plaintext, payload).
+  - Convert a message to a DIDComm Message for further transporting by calling one of the following:
+    - `Message.pack_encrypted` to build an Encrypted DIDComm message
+    - `Message.pack_signed` to build a Signed DIDComm message
+    - `Message.pack_plaintext` to build a Plaintext DIDComm message
+- Receiver side:
+  - Call `Message.unpack` on receiver side that will decrypt the message, verify signature if needed
+    and return a `Message` for further processing on the application level.
+
+### 1. Build an Encrypted DIDComm message for the given recipient
+
+This is the most common DIDComm message to be used in most of the applications.
+
+A DIDComm encrypted message is an encrypted JWM (JSON Web Messages) that
+
+- hides its content from all but authorized recipients
+- (optionally) discloses and proves the sender to only those recipients
+- provides message integrity guarantees
+
+It is important in privacy-preserving routing. It is what normally moves over network transports in DIDComm
+applications, and is the safest format for storing DIDComm data at rest.
+
+See `Message::pack_encrypted` documentation for more details.
+
+**Authentication encryption** example (most common case):
+
+```typescript
+// --- Build message from ALICE to BOB ---
+const msg = new Message({
+  id: "1234567890",
+  typ: "application/didcomm-plain+json",
+  type: "http://example.com/protocols/lets_do_lunch/1.0/proposal",
+  from: "did:example:alice",
+  to: ["did:example:bob"],
+  created_time: 1516269022,
+  expires_time: 1516385931,
+  body: { messagespecificattribute: "and its value" },
+});
+
+// --- Packing encrypted and authenticated message ---
+
+let didResolver = new ExampleDIDResolver([ALICE_DID_DOC, BOB_DID_DOC]);
+let secretsResolver = new ExampleSecretsResolver(ALICE_SECRETS);
+
+const [encryptedMsg, encryptMetadata] = await msg.pack_encrypted(
+  BOB_DID,
+  ALICE_DID,
+  null,
+  didResolver,
+  secretsResolver,
+  {
+    forward: false, // Forward wrapping is unsupported in current version
+  }
+);
+
+console.log("Encryption metadata is\n", encryptMetadata);
+
+// --- Send message ---
+console.log("Sending message\n", encryptedMsg);
+
+// --- Unpacking message ---
+didResolver = new ExampleDIDResolver([ALICE_DID_DOC, BOB_DID_DOC]);
+secretsResolver = new ExampleSecretsResolver(BOB_SECRETS);
+
+const [unpackedMsg, unpackMetadata] = await Message.unpack(
+  encrypted_msg,
+  didResolver,
+  secretsResolver,
+  {}
+);
+
+console.log("Receved message is\n", unpackedMsg.as_value());
+console.log("Receved message unpack metadata is\n", unpackMetadata);
+```
+
+**Anonymous encryption** example:
+
+```typescript
+let [encryptedMsg, encryptMetadata] = await msg.pack_encrypted(
+  BOB_DID,
+  null, // Keep sender as None here
+  null,
+  didResolver,
+  secretsResolver,
+  {
+    forward: false, // Forward wrapping is unsupported in current version
+  }
+);
+```
+
+**Encryption with non-repudiation** example:
+
+```typescript
+let [encrypted_msg, encrypt_metadata] = await msg.pack_encrypted(
+  BOB_DID,
+  ALICE_DID,
+  ALICE_DID, // Provide information about signer here
+  did_resolver,
+  secrets_resolver,
+  {
+    forward: false, // Forward wrapping is unsupported in current version
+  }
+);
+```
+
+### 2. Build an unencrypted but Signed DIDComm message
+
+Signed messages are only necessary when
+
+- the origin of plaintext must be provable to third parties
+- or the sender can’t be proven to the recipient by authenticated encryption because the recipient is not known in advance (e.g., in a
+  broadcast scenario).
+
+Adding a signature when one is not needed can degrade rather than enhance security because it
+relinquishes the sender’s ability to speak off the record.
+
+See `Message.pack_signed` documentation for more details.
+
+```typescript
+let [signed, metadata] = await msg.pack_signed(
+  ALICE_DID,
+  didResolver,
+  secretsResolver
+);
+```
+
+### 3. Build a Plaintext DIDComm message
+
+A DIDComm message in its plaintext form that
+
+- is not packaged into any protective envelope
+- lacks confidentiality and integrity guarantees
+- repudiable
+
+They are therefore not normally transported across security boundaries.
+
+```typescript
+let plaintext = msg.pack_plaintext(didResolver).expect("Unable pack_plaintext");
+```
+
+## How to build
+
+Install `wasm-pack` from https://rustwasm.github.io/wasm-pack/installer/ and then
+
+```bash
+make # Will output modules best-suited to be bundled with webpack
+WASM_TARGET=nodejs make # Will output modules that can be directly consumed by NodeJS
+WASM_TARGET=web make # Will output modules that can be directly consumed in browser without bundler usage
+```
+
+### How to build with `wasm-pack build`
+
+```bash
+wasm-pack build # Will output modules best-suited to be bundled with webpack
+wasm-pack build --target=nodejs # Will output modules that can be directly consumed by NodeJS
+wasm-pack build --target=web # Will output modules that can be directly consumed in browser without bundler usage
+```
+
+## How to test in NodeJS
+
+```bash
+WASM_TARGET=nodejs make
+cd ./tests-js
+npm install
+npm test
+```
+
+## How to test in Browser
+
+```bash
+WASM_TARGET=nodejs make
+cd ./tests-js
+npm install
+npm run test-puppeteer
+```
+
+_Note tests will be executed with jest+puppeteer in Chromium installed inside node_modules._
+
+## Hot to publish to NPM with `wasm-pack publish`
+
+```
+wasm-pack publish
+```
+
+## 🔋 Batteries Included
+
+- [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
+  between WebAssembly and JavaScript.
+- [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
+  for logging panic messages to the developer console.
+- [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized
+  for small code size.
+
+## Contribution
+
+PRs are welcome!
+
+The following CI checks are run against every PR:
+
+- No warnings from `cargo check --all-targets`
+- No warnings from `npm run check` in `tests-js` directory
+- No warnings from `npm run check` in `demo` directory
+- All tests must pass with `npm test` in `tests-js` directory
+- Rust code must be formatted by `cargo fmt --all`
+- Javascript/Typescript code must be formatted by prettier `npx prettier --write .`