From 8d7ad8a31a257906905351269972c93cced47b38 Mon Sep 17 00:00:00 2001 From: oskarth Date: Wed, 7 Jul 2021 14:26:27 +0800 Subject: [PATCH] 26/WAKU-PAYLOAD (#413) * 26/WAKU-PAYLOAD Init with 7/WAKU-DATA * Import 6/WAKU1 payload encryption * Clarify purpose and cryptographic primitives * Clarify Waku v1 vs Waku v2 usage * fmt * Add section on ECIES encryption * typo * credit * typos * Add design requirements * tweaks * move encryption details section * tweak * add references * fix salt field typo * design goals * overhaul spec sec * updat references * remove scratch * Update content/docs/rfcs/26/README.md * Update content/docs/rfcs/26/README.md * Update content/docs/rfcs/26/README.md * Update content/docs/rfcs/26/README.md * Update content/docs/rfcs/26/README.md * remove iv and tag from abnf * must to may encryption * typo * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * typo * clarify * clarify * restructure * tweak * Update content/docs/rfcs/26/README.md Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> * Revert "Update content/docs/rfcs/26/README.md" This reverts commit ba496e166221a4c6f03ebceba92be9fa2c6d3963. * clarify field names * add ethereum yellow paper * Add to menu Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> --- content/docs/rfcs/26/README.md | 155 +++++++++++++++++++++++++++++++++ content/menu/index.md | 1 + 2 files changed, 156 insertions(+) create mode 100644 content/docs/rfcs/26/README.md diff --git a/content/docs/rfcs/26/README.md b/content/docs/rfcs/26/README.md new file mode 100644 index 00000000..40d704f4 --- /dev/null +++ b/content/docs/rfcs/26/README.md @@ -0,0 +1,155 @@ +--- +slug: 26 +title: 26/WAKU-PAYLOAD +name: Waku Message Payload Encryption +status: draft +editor: Oskar Thoren +contributors: +--- + +This specification describes how Waku provides confidentiality, authenticity, and integrity, as well as some form of unlinkability. +Specifically, it describes how encryption, decryption and signing works in [6/WAKU1](/spec/6) and in [10/WAKU2](/spec/10) with [14/WAKU-MESSAGE version 1](/spec/14/#version1). + +This specification effectively replaces [7/WAKU-DATA](/spec/7) as well as [6/WAKU1 Payload encryption](/spec/6/#payload-encryption) but written in a way that is agnostic and self-contained for Waku v1 and Waku v2. + +Large sections of the specification originate from [EIP-627: Whisper spec](https://eips.ethereum.org/EIPS/eip-627) as well from [RLPx Transport Protocol spec (ECIES encryption)](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption) with some modifications. + +## Design requirements + +- *Confidentiality*: The adversary should not be able to learn what data is being sent from one Waku node to one or several other Waku nodes. +- *Authenticity*: The adversary should not be able to cause Waku endpoint to accept data from any third party as though it came from the other endpoint. +- *Integrity*: The adversary should not be able to cause a Waku endpoint to accept data that has been tampered with. + +Notable, *forward secrecy* is not provided for at this layer. +If this property is desired, a more fully featured secure communication protocol can be used on top, such as [Status 5/SECURE-TRANSPORT](https://specs.status.im/spec/5). + +It also provides some form of *unlinkability* since: +- only participants who are able to decrypt a message can see its signature +- payload are padded to a fixed length + +## Cryptographic primitives + +- AES-256-GCM (for symmetric encryption) +- ECIES +- ECDSA +- KECCAK-256 + +ECIES is using the following cryptosystem: +- Curve: secp256k1 +- KDF: NIST SP 800-56 Concatenation Key Derivation Function, with SHA-256 option +- MAC: HMAC with SHA-256 +- AES: AES-128-CTR + +## Specification + +For 6/WAKU1, the `data` field is used in the `waku envelope`, and the field MAY contain the encrypted payload. + +For 10/WAKU2, the `payload` field is used in `WakuMessage` and MAY contain the encrypted payload. + +The fields that are concatenated and encrypted as part of the `data` (Waku v1) / `payload` (Waku v2) field are: + - flags + - payload-length + - payload + - padding + - signature + +### ABNF + +Using [Augmented Backus-Naur form (ABNF)](https://tools.ietf.org/html/rfc5234) we have the following format: + +```abnf +; 1 byte; first two bits contain the size of payload-length field, +; third bit indicates whether the signature is present. +flags = 1OCTET + +; contains the size of payload. +payload-length = 4*OCTET + +; byte array of arbitrary size (may be zero). +payload = *OCTET + +; byte array of arbitrary size (may be zero). +padding = *OCTET + +; 65 bytes, if present. +signature = 65OCTET + +data = flags payload-length payload padding [signature] + +; This field is called payload in Waku v2 +payload = data +``` + +### Signature + +Those unable to decrypt the payload/data are also unable to access the signature. +The signature, if provided, is the ECDSA signature of the Keccak-256 hash of the unencrypted data using the secret key of the originator identity. +The signature is serialized as the concatenation of the `r`, `s` and `v` parameters of the SECP-256k1 ECDSA signature, in that order. +`r` and `s` MUST be big-endian encoded, fixed-width 256-bit unsigned. +`v` MUST be an 8-bit big-endian encoded, non-normalized and should be either 27 or 28. + +See [Ethereum "Yellow paper": Appendix F Signing transactions](https://ethereum.github.io/yellowpaper/paper.pdf) for more information on signature generation, parameters and public key recovery. + +### Encryption + +#### Symmetric + +Symmetric encryption uses AES-256-GCM for [authenticated encryption](https://en.wikipedia.org/wiki/Authenticated_encryption). +The output of encryption is of the form (`ciphertext`, `tag`, `iv`) where `ciphertext` is the encrypted message, `tag` is a 16 byte message authentication tag and `iv` is a 12 byte initialization vector (nonce). +The message authentication `tag` and initialization vector `iv` field MUST be appended to the resulting `ciphertext`, in that order. +Note that previous specifications and some implementations might refer to `iv` as `nonce` or `salt`. + +#### Asymmetric + +Asymmetric encryption uses the standard Elliptic Curve Integrated Encryption Scheme (ECIES) with SECP-256k1 public key. + +#### ECIES + +This section originates from the [RLPx Transport Protocol spec](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption) spec with minor modifications. + +The cryptosystem used is: + +- The elliptic curve secp256k1 with generator `G`. +- `KDF(k, len)`: the NIST SP 800-56 Concatenation Key Derivation Function. +- `MAC(k, m)`: HMAC using the SHA-256 hash function. +- `AES(k, iv, m)`: the AES-128 encryption function in CTR mode. + +Special notation used: `X || Y` denotes concatenation of `X` and `Y`. + +Alice wants to send an encrypted message that can be decrypted by Bob's static private key `kB`. Alice knows about Bobs static public key `KB`. + +To encrypt the message `m`, Alice generates a random number `r` and corresponding elliptic curve public key `R = r * G` and computes the shared secret `S = Px` where `(Px, Py) = r * KB`. +She derives key material for encryption and authentication as `kE || kM = KDF(S, 32)` as well as a random initialization vector `iv`. +Alice sends the encrypted message `R || iv || c || d` where `c = AES(kE, iv , m)` and `d = MAC(sha256(kM), iv || c)` to Bob. + +For Bob to decrypt the message `R || iv || c || d`, he derives the shared secret `S = Px` where `(Px, Py) = kB * R` as well as the encryption and authentication keys `kE || kM = KDF(S, 32)`. +Bob verifies the authenticity of the message by checking whether `d == MAC(sha256(kM), iv || c)` then obtains the plaintext as `m = AES(kE, iv || c)`. + +### Padding + +The padding field is used to align data size, since data size alone might reveal important metainformation. +Padding can be arbitrary size. +However, it is recommended that the size of Data Field (excluding the IV and tag) before encryption (i.e. plain text) SHOULD be a multiple of 256 bytes. + +### Decoding a message + +In order to decode a message, a node SHOULD try to apply both symmetric and asymmetric decryption operations. +This is because the type of encryption is not included in the message. + +## References + +1. [6/WAKU1](/spec/6) +2. [10/WAKU2](/spec/10) +3. [14/WAKU-MESSAGE version 1](/spec/14/#version1) +4. [7/WAKU-DATA](/spec/7) +5. [6/WAKU1 Payload encryption](/spec/6/#payload-encryption) +6. [EIP-627: Whisper spec](https://eips.ethereum.org/EIPS/eip-627) +7. [RLPx Transport Protocol spec (ECIES encryption)](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption) +8. [Status 5/SECURE-TRANSPORT](https://specs.status.im/spec/5) +9. [Augmented Backus-Naur form (ABNF)](https://tools.ietf.org/html/rfc5234) +10. [Ethereum "Yellow paper": Appendix F Signing transactions](https://ethereum.github.io/yellowpaper/paper.pdf) +11. [Authenticated encryption](https://en.wikipedia.org/wiki/Authenticated_encryption) + +## Copyright + +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/content/menu/index.md b/content/menu/index.md index c1c19e65..84bed571 100644 --- a/content/menu/index.md +++ b/content/menu/index.md @@ -23,6 +23,7 @@ bookMenuLevels: 1 - [19/WAKU2-LIGHTPUSH]({{< relref "/docs/rfcs/19/README.md" >}}) - [22/TOY-CHAT]({{< relref "/docs/rfcs/22/README.md" >}}) - [23/WAKU2-TOPICS]({{< relref "/docs/rfcs/23/README.md" >}}) + - [26/WAKU2-PAYLOAD]({{< relref "/docs/rfcs/26/README.md" >}}) - [27/WAKU2-PEERS]({{< relref "/docs/rfcs/27/README.md" >}}) - Stable - [2/MVDS]({{< relref "/docs/rfcs/2/README.md" >}})