7/WAKU-DATA: Import

2021-03-29 16:55:14 +08:00 · 2021-03-29 16:55:14 +08:00 · afc24400ae
parent 5781cc7e20
commit afc24400ae
1 changed files with 80 additions and 0 deletions
--- a/content/docs/rfcs/7/README.md
+++ b/content/docs/rfcs/7/README.md
@ -0,0 +1,80 @@
+---
+title: Envelope data field
+version: 1.0.0
+status: Stable
+authors: Oskar Thorén <oskar@status.im>, Dean Eigenmann <dean@status.im>
+redirect_from:
+  - /waku/envelope-data-format.html
+---
+
+## Table of Contents
+
+ 1. [Abstract](#abstract)
+ 2. [Specification](#specification)
+    1. [ABNF](#abnf)
+    2. [Signature](#signature)
+    3. [Padding](#padding)
+ 3. [Changelog](#changelog) 
+ 4. [Copyright](#copyright)
+
+## Abstract
+
+This specification describes the encryption, decryption and signing of the content in the [data field used in Waku](waku.md#abnf-specification).
+
+## Specification
+
+The `data` field is used within the `waku envelope`, the field MUST contain the encrypted payload of the envelope.
+
+The fields that are concatenated and encrypted as part of the `data` field are:
+ - flags
+ - auxiliary field
+ - payload
+ - padding
+ - signature
+ 
+In case of symmetric encryption, a `salt`  (a.k.a. AES Nonce, 12 bytes) field MUST be appended. 
+
+### 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 auxiliary field, 
+; third bit indicates whether the signature is present.
+flags           = 1OCTET
+
+; contains the size of payload.
+auxiliary-field = 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
+
+; 2 bytes, if present (in case of symmetric encryption).
+salt            = 2OCTET
+
+data        = flags auxiliary-field payload padding [signature] [salt]
+```
+
+### Signature
+
+Those unable to decrypt the envelope 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.
+
+### 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 Salt) before encryption (i.e. plain text) SHOULD be factor of 256 bytes.
+
+## Changelog
+
+| Version                                                                                 | Comment          |
+| :--------------------------------------------------------------------------------------:| ---------------- |
+| [1.0.0](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8)| Initial release. |
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).