| Internet-Draft | Mesh: Data At Rest Encryption | January 2021 |
| Hallam-Baker | Expires 17 July 2021 | [Page] |
This document describes the Data At Rest Encryption (DARE) Envelope and Container syntax.¶
The DARE Envelope syntax is used to digitally sign, digest, authenticate, or encrypt arbitrary content data.¶
The DARE Container syntax describes an append-only sequence of entries, each containing a DARE Envelope. DARE Containers may support cryptographic integrity verification of the entire data container content by means of a Merkle tree.¶
[Note to Readers]¶
Discussion of this draft takes place on the MATHMESH mailing list (mathmesh@ietf.org), which is archived at https://mailarchive.ietf.org/arch/search/?email_list=mathmesh.¶
This document is also available online at http://mathmesh.com/Documents/draft-hallambaker-mesh-dare.html.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 17 July 2021.¶
Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document.¶
This document describes the Data At Rest Encryption (DARE) Envelope and Container Syntax. The DARE Envelope syntax is used to digitally sign, digest, authenticate, or encrypt arbitrary message content. The DARE Container syntax describes an append-only sequence of data frames, each containing a DARE Envelope that supports efficient incremental signature and encryption.¶
The DARE Envelope Syntax is based on a subset of the JSON Web Signature [RFC7515] and JSON Web Encryption [RFC7516] standards and shares many fields and semantics. The processing model and data structures have been streamlined to remove alternative means of specifying the same content and to enable multiple data sequences to be signed and encrypted under a single master encryption key without compromise to security.¶
A DARE Envelope consists of a Header, Payload and an optional Trailer. To enable single pass encoding and decoding, the Header contains all the information required to perform cryptographic processing of the Payload and authentication data (digest, MAC, signature values) MAY be deferred to the Trailer section.¶
A DARE Container is an append-only log format consisting of a sequence of frames. Cryptographic enhancements (signature, encryption) may be applied to individual frames or to sets of frames. Thus, a single key exchange may be used to provide a master key to encrypt multiple frames and a single signature may be used to authenticate all the frames in the container up to and including the frame in which the signature is presented.¶
The DARE Envelope syntax may be used either as a standalone cryptographic message syntax or as a means of presenting a single DARE Container frame together with the complete cryptographic context required to verify the contents and decrypt them.¶
A key innovation in the DARE Envelope Syntax is the separation of key exchange and data encryption operations so that a Master Key (MK) established in a single exchange to be applied to multiple data sequences. This means that a single public key operation MAY be used to encrypt and/or authenticate multiple parts of the same DARE Envelope or multiple frames in a DARE Container.¶
To avoid reuse of the key and to avoid the need to communicate separate IVs, each octet sequence is encrypted under a different encryption key (and IV if required) derived from the Master Key by means of a salt that is unique for each octet sequence that is encrypted. The same approach is used to generate keys for calculating a MAC over the octet sequence if required. This approach allows encryption and integrity protections to be applied to the envelope payload, to header or trailer fields or to application defined Enhanced Data Sequences in the header or trailer.¶
Traditional cryptographic containers describe the application of a single key exchange to encryption of a single octet sequence. Examples include PCKS#7/CMS [RFC2315], OpenPGP [RFC4880] and JSON Web Encryption [RFC7516].¶
To encrypt data using RSA, the encoder first generates a random encryption key and initialization vector (IV). The encryption key is encrypted under the public key of each recipient to create a per-recipient decryption entry. The encryption key, plaintext and IV are used to generate the ciphertext (figure 1).¶
This approach is adequate for the task of encrypting a single octet stream. It is less than satisfactory when encrypting multiple octet streams or very long streams for which a rekeying operation is desirable.¶
In the DARE approach, key exchange and key derivation are separate operations and keys MAY be derived for encryption or integrity purposes or both. A single key exchange MAY be used to derive keys to apply encryption and integrity enhancements to multiple data sequences.¶
The DARE key exchange begins with the same key exchange used to produce the CEK in JWE but instead of using the CEK to encipher data directly, it is used as one of the inputs to a Key Derivation Function (KDF) that is used to derive parameters for each block of data to be encrypted. To avoid the need to introduce additional terminology, the term 'CEK' is still used to describe the output of the key agreement algorithm (including key unwrapping if required) but it is more appropriately described as a Master Key (figure 2).¶
A Master Key may be used to encrypt any number of data items. Each data item is encrypted under a different encryption key and IV (if required). This data is derived from the Master Key using the HKDF function [RFC5869] using a different salt for each data item and separate info tags for each cryptographic function (figure 3).¶
This approach to encryption offers considerably greater flexibility allowing the same format for data item encryption to be applied at the transport, message or field level.¶
Each encrypted DARE Envelope specifies a unique Master Salt value of at least 128 bits which is used to derive the salt values used to derive cryptographic keys for the envelope payload and annotations.¶
Erasure of the Master Salt value MAY be used to effectively render the envelope payload and annotations undecipherable without altering the envelope payload data. The work factor for decryption will be O(2^128) even if the decryption key is compromised.¶
As with encryption, DARE Envelope signatures MAY be applied to an individual envelope or a sequence of envelope.¶
When an individual plaintext envelope is signed, the digest value used to create the signature is calculated over the binary value of the payload data. That is, the value of the payload before the encoding (Base-64, JSON-B) is applied.¶
When an individual plaintext envelope is signed, the digest value used to create the signature is calculated over the binary value of the payload data. That is, the value of the payload after encryption but before the encoding (Base-64, JSON-B) is applied.¶
Use of signing and encryption in combination presents the risk of subtle attacks depending on the order in which signing and encryption take place [Davis2001].¶
Na?ve approaches in which an envelope is encrypted and then signed present the possibility of a surreptitious forwarding attack. For example, Alice signs an envelope and sends it to Mallet who then strips off Alice's signature and sends the envelope to Bob.¶
Na?ve approaches in which an envelope is signed and then encrypted present the possibility of an attacker claiming authorship of a ciphertext. For example, Alice encrypts a ciphertext for Bob and then signs it. Mallet then intercepts the envelope and sends it to Bob.¶
While neither attack is a concern in all applications, both attacks pose potential hazards for the unwary and require close inspection of application protocol design to avoid exploitation.¶
To prevent these attacks, each signature on an envelope that is signed and encrypted MUST include a witness value that is calculated by applying a MAC function to the signature value as described in section XXX.¶
To sign multiple envelopes with a single signature, we first construct a Merkle tree of the envelope payload digest values and then sign the root of the Merkle tree.¶
[This is not yet implemented but will be soon.]¶
DARE Container is a message and file syntax that allows a sequence of data frames to be represented with cryptographic integrity, signature, and encryption enhancements to be constructed in an append only format.¶
The format is designed to meet the requirements of a wide range of use cases including:¶
A Container consists of a sequence of variable length Frames. Each frame consists of a forward length indicator, the framed data and a reverse length indicator. The reverse length indicator is written out backwards allowing the length and thus the frame to be read in the reverse direction:¶
Each frame contains a single DARE Envelope consisting of a Header, Payload and Trailer (if required). The first frame in a container describes the container format options and defaults. These include the range of encoding options for frame metadata supported and the container profiles to which the container conforms.¶
All internal data formats support use of pointers of up to 64 bits allowing containers of up to 18 exabytes to be written.¶
Five container types are currently specified:¶
The container does not provide any index or content integrity checks.¶
Frame headers contain entries that specify the start position of previous frames at the apex of the immediately enclosing binary tree. This enables efficient random access to any frame in the file.¶
Each frame trailer contains a PayloadDigest field. Modification of the payload will cause verification of the PayloadDigest value to fail on that frame.¶
Each frame trailer contains PayloadDigest and ChainDigest fields allowing modifications to the payload data to be detected. Modification of the payload will cause verification of the PayloadDigest value to fail on that frame and verification of the ChainDigest value to fail on all subsequent frames.¶
Frame headers contain entries that specify the start position of previous frames at the apex of the immediately enclosing binary tree. Frame Trailers contain TreeDigestPartial and TreeDigestFinal entries forming a Merkle digest tree.¶
In normal circumstances, Containers are written as an append only log. As with Envelopes, integrity information (payload digest, signatures) is written to the entry trailer. Thus, large payloads may be written without the need to buffer the payload data provided that the content length is known in advance.¶
Should exceptional circumstances require, Container entries MAY be erased by overwriting the Payload and/or parts of the Header content without compromising the ability to verify other entries in the container. If the entry Payload is encrypted, it is sufficient to erase the container salt value to render the container entry effectively inaccessible (though recovery might still be possible if the original salt value can be recovered from the storage media.¶
Frame payloads and associated attributes MAY be encrypted and/or authenticated in the same manner as Envelopes.¶
Incremental encryption is supported allowing encryption parameters from a single public key exchange operation to be applied to encrypt multiple frames. The public key exchange information is specified in the first encrypted frame and subsequent frames encrypted under those parameters specify the location at which the key exchange information is to be found by means of the ExchangePosition field which MUST specify a location that is earlier in the file.¶
To avoid cryptographic vulnerabilities resulting from key re-use, the DARE key exchange requires that each encrypted sequence use an encryption key and initialization vector derived from the master key established in the public key exchange by means of a unique salt.¶
Each Envelope and by extension, each Container frame MUST specify a unique salt value of at least 128 bits. Since the encryption key is derived from the salt value by means of a Key Derivation Function, erasure of the salt MAY be used as a means of rendering the payload plaintext value inaccessible without changing the payload value.¶
Signatures MAY be applied to a payload digest, the final digest in a chain or tree. The chain and tree digest modes allow a single signature to be used to authenticate all frame payloads in a container.¶
The tree signature mode is particularly suited to applications such as file archives as it allows files to be verified individually without requiring the signer to sign each individually. Furthermore, in applications such as code signing, it allows a single signature to be used to verify both the integrity of the code and its membership of the distribution.¶
As with DARE Envelope, the signature mechanism does not specify the interpretation of the signature semantics. The presence of a signature demonstrates that the holder of the private key applied it to the specified digest value but not their motive for doing so. Describing such semantics is beyond the scope of this document and is deferred to future work.¶
The chief disadvantage of using an append-only format is that containers only increase in size. In many applications, much of the data in the container becomes redundant or obsolete and a process analogous to garbage collection is required. This process is called redaction.¶
The simplest method of redaction is to create a new container and sequentially copy each entry from the old container to the new, discarding redundant frames and obsolete header information.¶
For example, partial index records may be consolidated into a single index record placed in the last frame of the container. Unnecessary signature and integrity data may be discarded and so on.¶
While redaction could in principle be effected by moving data in-place in the existing container, supporting this approach in a robust fashion is considerably more complex as it requires backward references in subsequent frames to be overridden as each frame is moved.¶
Many file proprietary formats are in use that support some or all of these capabilities but only a handful have public, let alone open, standards. DARE Container is designed to provide a superset of the capabilities of existing message and file syntaxes, including:¶
Attempting to make use of these specifications in a layered fashion would require at least three separate encoders and introduce unnecessary complexity. Furthermore, there is considerable overlap between the specifications providing multiple means of achieving the same ends, all of which must be supported if decoders are to work reliably.¶
Every data format represents a compromise between different concerns, in particular:¶
The space required to record data in the encoding.¶
The additional volatile storage (RAM) required to maintain indexes etc. to support efficient retrieval operations.¶
The number of operations required to retrieve data from or append data to an existing encoded sequence.¶
Optimizing the response time of magnetic storage media to random access read requests has traditionally been one of the central concerns of database design. The DARE Container format is designed to the assumption that this will cease to be a concern as solid state media replaces magnetic.¶
While the cost of storage of all types has declined rapidly over the past decades, so has the amount of data to be stored. DARE Container represents a pragmatic balance of these considerations for current technology. In particular, since payload volumes are likely to be very large, memory and operational efficiency are considered higher priorities than compactness.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].¶
The terms "Authentication Tag", "Content Encryption Key", "Key Management Mode", "Key Encryption", "Direct Key Agreement", "Key Agreement with Key Wrapping" and "Direct Encryption" are defined in the JWE specification [RFC7516].¶
The terms "Authentication", "Ciphertext", "Digital Signature", "Encryption", "Initialization Vector (IV)", "Message Authentication Code (MAC)", "Plaintext" and "Salt" are defined by the Internet Security Glossary, Version 2 [RFC4949].¶
A DARE Envelope that contains an Annotations field with at least one entry.¶
A Message Authentication Code or authentication tag.¶
A DARE envelope that contains the key exchange information necessary for the intended recipient(s) to decrypt it.¶
A DARE envelope that does not contain the key exchange information necessary for the intended recipient(s) to decrypt it.¶
The master key, encryption algorithms and associated parameters used to generate a set of one or more enhanced data sequences.¶
A sequence consisting of a salt, content data and authentication data (if required by the encryption context).¶
Applying a cryptographic operation to a data sequence. This includes encryption, authentication and both at the same time.¶
The party that generates a DARE envelope.¶
A key used to encrypt data to be read by a group of users. This is typically achieved by means of some form of proxy re-encryption or distributed key generation.¶
A key identifier for a group encryption key.¶
The master secret from which keys are derived for authenticating enhanced data sequences.¶
Any party that receives and processes at least some part of a DARE envelope.¶
A set of DARE envelopes that share the same key exchange information and hence the same Master Key.¶
The means of presenting the result of a cryptographic digest function over a data sequence and content type identifier specified in the Uniform Data Fingerprint specification [draft-hallambaker-mesh-udf]¶
A DARE Envelope is a sequence of three parts:¶
A JSON object containing information a reader requires to begin processing the envelope.¶
An array of octets.¶
A JSON object containing information calculated from the envelope payload.¶
For example, the following sequence is a JSON encoded Envelope with an empty header, a payload of zero length and an empty trailer:¶
[ {}, "", {} ]¶
DARE Envelopes MAY be encoded using JSON serialization or a binary serialization for greater efficiency.¶
Offers compatibility with applications and libraries that support JSON. Payload data is encoded using Base64 incurring a 33% overhead.¶
A superset of JSON encoding that permits binary data to be encoded as a sequence of length-data segments. This avoids the Base64 overhead incurred by JSON encoding. Since JSON-B is a superset of JSON encoding, an application can use a single decoder for either format.¶
A superset of JSON-C which provides additional efficiency by allowing field tags and other repeated string data to be encoded by reference to a dictionary. Since JSON-C is a superset of JSON and JSON-B encodings, an application can use a single decoder for all three formats.¶
DARE Envelope processors MUST support JSON serialization and SHOULD support JSON-B serialization.¶
The DARE Envelope Syntax supports single pass encoding and decoding without buffering of data. All the information required to begin processing a DARE envelope (key agreement information, digest algorithms), is provided in the envelope header. All the information that is derived from envelope processing (authentication codes, digest values, signatures) is presented in the envelope trailer.¶
The choice of envelope encoding does not affect the semantics of envelope processing. A DARE Envelope MAY be reserialized under the same serialization or converted from any of the specified serialization to any other serialization without changing the semantics or integrity properties of the envelope.¶
A header MAY contain header fields describing the payload content. These include:¶
A list of Encoded Data Sequences that provide application specific annotations to the envelope.¶
For example, consider the following mail message:¶
From: Alice@example.com To: bob@example.com Subject: TOP-SECRET Product Launch Today! The CEO told me the product launch is today. Tell no-one!¶
Existing encryption approaches require that header fields such as the subject line be encrypted with the body of the message or not encrypted at all. Neither approach is satisfactory. In this example, the subject line gives away important information that the sender probably assumed would be encrypted. But if the subject line is encrypted together with the message body, a mail client must retrieve at least part of the message body to provide a 'folder' view.¶
The plaintext form of the equivalent DARE Message encoding is:¶
[{
"annotations":["iAEAiBdGcm9tOiBBbGljZUBleGFtcGxlLmNvbQ",
"iAEBiBNUbzogYm9iQGV4YW1wbGUuY29t",
"iAECiClTdWJqZWN0OiBUT1AtU0VDUkVUIFByb2R1Y3QgTGF1bmNoIFRvZG
F5IQ"
],
"ContentMetaData":"ewogICJjdHkiOiAiYXBwbGljYXRpb24vZXhhbXBsZS
1tYWlsIn0"},
"VGhlIENFTyB0b2xkIG1lIHRoZSBwcm9kdWN0IGxhdW5jaCBpcyB0b2RheS4gVG
VsbCBuby1vbmUh"
]¶
This contains the same information as before but the mail message headers are now presented as a list of Encoded Data Sequences.¶
An encoded data sequence (EDS) is a sequence of octets that encodes a data sequence according to cryptographic enhancements specified in the context in which it is presented. An EDS MAY be encrypted and MAY be authenticated by means of a MAC. The keys and other cryptographic parameters used to apply these enhancements are derived from the cryptographic context and a Salt prefix specified in the EDS itself.¶
An EDS sequence contains exactly three binary fields encoded in JSON-B serialization as follows:¶
A sequence of octets used to derive the encryption key, Initialization Vector and MAC key as required.¶
The plaintext or encrypted content.¶
The authentication code value in the case that the cryptographic context specifies use of authenticated encryption or a MAC, otherwise is a zero-length field.¶
Requiring all three fields to be present, even in cases where they are unnecessary simplifies processing at the cost of up to six additional data bytes.¶
The encoding of the 'From' header of the previous example as a plaintext EDS is as follows:¶
88 01 00 88 17 46 72 6f 6d 3a 20 41 6c 69 63 65 40 65 78 61 6d 70 6c 65 2e 63 6f 6d [EOF]¶
Encryption and integrity protections MAY be applied to any DARE Envelope Payload and Annotations.¶
The following is an encrypted version of the message shown earlier. The payload and annotations have both increased in size as a result of the block cipher padding. The header now includes Recipients and Salt fields to enable the content to be decoded.¶
[{
"enc":"A256CBC",
"kid":"EBQH-3NAT-FW7Z-IRDK-QC3M-SC2B-UI77",
"Salt":"-7YjIinh89vumJlW5P2GMg",
"annotations":["iAEAiCC8xyPT3IaxCUiUUDdUKfJ4FojwKinCRX9DIQ5UXd
14vQ",
"iAEBiCCwXnWWrKxt6ijdvmVm8QkKBWwWu3zcjOsQ2HiYNI5qFg",
"iAECiDCPK9HdJbLx0DRO4mWcUc36Q5vPpfjK0kchlTnJOAaAJ6BBM1RJw_
hzAaekH0FeD64"
],
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"9vIwyosnE76w1gtCYqY0nKu5MrIf3jPeiPFE_6T3-ks"}},
"wmk":"QZwtHQUzXS6qlipGvjQhz_0GjHNFV27sAUP_nPf5vxTBJbtxUb
El-Q"}
],
"ContentMetaData":"ewogICJjdHkiOiAiYXBwbGljYXRpb24vZXhhbXBsZS
1tYWlsIn0"},
"DvWZ9em6q2rIrWAAUcaS-W7DN1dbEVeyO9L5iqC-1okIbwm2V4pP8prKH1Acy7
IJrWKK8d8Smxm5ep9XiIrjuw"
]¶
The DARE key exchange is based on the JWE key exchange except that encryption modes are intentionally limited and the output of the key exchange is the DARE Master Key rather than the Content Encryption Key.¶
A DARE Key Exchange MAY contain any number of Recipient entries, each providing a means of decrypting the Master Key using a different private key.¶
If the Key Exchange mechanism supports message recovery, Direct Key Agreement is used, in all other cases, Key Wrapping is used.¶
This approach allows envelopes with one intended recipient to be handled in the exact same fashion as envelopes with multiple recipients. While this does require an additional key wrapping operation, that could be avoided if an envelope has exactly one intended recipient, this is offset by the reduction in code complexity.¶
If the key exchange algorithm does not support message recovery (e.g. Diffie Hellman and Elliptic Curve Diffie-Hellman), the HKDF Extract-and-Expand Key Derivation Function is used to derive a master key using the following info tag:¶
Key derivation info field used when deriving a master key from the output of a key exchange.¶
The master key length is the maximum of the key size of the encryption algorithm specified by the key exchange header, the key size of the MAC algorithm specified by the key exchange header (if used) and 256.¶
The JWE/JWS specifications define a kid field for use as a key identifier but not how the identifier itself is constructed. All DARE key identifiers are either UDF key fingerprints [draft-hallambaker-mesh-udf] or Mesh/Recrypt Group Key Identifiers.¶
A UDF fingerprint is formed as the digest of an IANA content type and the digested data. A UDF key fingerprint is formed with the content type application/pkix-keyinfo and the digested data is the ASN.1 DER encoded PKIX certificate keyInfo sequence for the corresponding public key.¶
A Group Key Identifier has the form <fingerprint>@<domain>. Where <fingerprint> is a UDF key fingerprint and <domain> is the DNS address of a service that provides the encryption service to support decryption by group members.¶
A Master Salt is a sequence of 16 or more octets that is specified in the Salt field of the header.¶
The Master Salt is used to derive salt values for the envelope payload and associated encoded data sequences as follows.¶
Encoders SHOULD NOT generate salt values that exceed 1024 octets.¶
The salt value is opaque to the DARE encoding but MAY be used to encode application specific semantics including:¶
For data erasure to be effective, the salt MUST be constructed so that the difficulty of recovering the key is sufficiently high that it is infeasible. For most purposes, a salt with 128 bits of appropriately random data is sufficient.¶
Encryption and/or authentication keys are derived from the Master Key using a Extract-and-Expand Key Derivation Function as follows:¶
The application specific information inputs are:¶
While encryption and integrity enhancements can be applied to any part of a DARE Envelope, signatures are only applied to payload digest values calculated over one or more envelope payloads.¶
The payload digest value for an envelope is calculated over the binary payload data. That is, after any encryption enhancement has been applied but before the envelope encoding is applied. This allows envelopes to be converted from one encoding to another without affecting signature verification.¶
The signed value is the payload digest of the envelope payload.¶
The signed value is the root of a Merkle Tree in which the payload digest of the envelope is one of the leaves.¶
Verification of a multiple payload signature naturally requires the additional digest values required to construct the Merkle Tree. These are provided in the Trailer in a format that permits multiple signers to reference the same tree data.¶
The key wrapping and derivation algorithms.¶
Since the means of public key exchange is determined by the key identifier of the recipient key, it is only necessary to specify the algorithms used for key wrapping and derivation.¶
The default (and so far only) algorithm is kwd-aes-sha2-256-256.¶
Advanced Encryption Standard (AES) Key Wrap with Padding Algorithm [RFC3394] is used to wrap the Master Exchange Key. AES 256 is used.¶
HMAC-based Extract-and-Expand Key Derivation Function [RFC5869] is used for key derivation. SHA-2-256 is used for the hash function.¶
Frame sequences in a DARE container MAY be protected against a frame insertion attack by means of a digest chain, a binary Merkle tree or both.¶
A digest chain is simple to implement but can only be verified if the full chain of values is known. Appending a frame to the chain has O(1) complexity but verification has O(n) complexity:¶
The value of the chain digest for the first frame (frame 0) is H(H(null)+H(Payload0)), where null is a zero length octet sequence and payloadn is the sequence of payload data bytes for frame n¶
The value of the chain digest for frame n is H(H(Payloadn-1 +H(Payloadn)), where A+B stands for concatenation of the byte sequences A and B.¶
The tree index mechanism describe earlier may be used to implement a binary Merkle tree. The value TreeDigest specifies the apex value of the tree for that node.¶
Appending a frame to the chain has O(log2 (n)) complexity provided that the container format supports at least the binary tree index. Verifying a chain has O(log2 (n)) complexity, provided that the set of necessary digest inputs is known.¶
To calculate the value of the tree digest for a node, we first calculate the values of all the sub trees that have their apex at that node and then calculate the digest of that value and the immediately preceding local apex.¶
Payload data MAY be signed using a JWS [RFC7515] as applied in the Envelope.¶
Signatures are specified by the Signatures parameter in the content header. The data that the signature is calculated over is defined by the typ parameter of the Signature as follows.¶
PayloadThe value of the PayloadDigest parameter¶
ChainThe value of the ChainDigest parameter¶
TreeThe value of the TreeDigestFinal parameter¶
If the typ parameter is absent, the value Payload is implied.¶
A frame MAY contain multiple signatures created with the same signing key and different typ values.¶
The use of signatures over chain and tree digest values permit multiple frames to be validated using a single signature verification operation.¶
A DARE Envelope consists of a Header, an Enhanced Data Sequence (EDS) and an optional trailer. This section describes the JSON data fields used to construct headers, trailers and complete envelopes.¶
Wherever possible, fields from JWE, JWS and JWK have been used. In these cases, the fields have the exact same semantics. Note however that the classes in which these fields are presented have different structure and nesting.¶
A DARE envelope contains a single DAREMessageSequence in either the JSON or Compact serialization as directed by the protocol in which it is applied.¶
A DARE envelope containing Header, EDS and Trailer in JSON object encoding. Since a DAREMessage is almost invariably presented in JSON sequence or compact encoding, use of the DAREMessage subclass is preferred.¶
Although a DARE envelope is functionally an object, it is serialized as an ordered sequence. This ensures that the envelope header field will always precede the body in a serialization, this allowing processing of the header information to be performed before the entire body has been received.¶
The envelope header. May specify the key exchange data, pre-signature or signature data, cloaked headers and/or encrypted data sequences.¶
The envelope body¶
The envelope trailer. If present, this contains the signature.¶
A DARE sequence MUST contain a (possibly empty) DAREHeader and MAY contain a DARETrailer.¶
A DARE envelope Trailer¶
A list of signatures. A envelope trailer MUST NOT contain a signatures field if the header contains a signatures field.¶
Contains a DAREHeader object¶
If present, contains the digest of the Payload.¶
If present, contains the digest of the PayloadDigest values of this frame and the frame immediately preceding.¶
If present, contains the Binary Merkle Tree digest value.¶
A DARE Envelope Header. Since any field that is present in a trailer MAY be placed in a header instead, the envelope header inherits from the trailer.¶
Unique identifier¶
The encryption algorithm as specified in JWE¶
Digest Algorithm. If specified, tells decoder that the digest algorithm is used to construct a signature over the envelope payload.¶
Base seed identifier.¶
Salt value used to derrive cryptographic parameters for the content data.¶
Hash of the Salt value used to derrive cryptographic parameters for the content data. This field SHOULD NOT be present if the Salt field is present. It is used to allow the salt value to be erased (thus rendering the payload content irrecoverable) without affecting the ability to calculate the payload digest value.¶
If present in a header or trailer, specifies an encrypted data block containing additional header fields whose values override those specified in the envelope and context headers.¶
When specified in a header, a cloaked field MAY be used to conceal metadata (content type, compression) and/or to specify an additional layer of key exchange. That applies to both the envelope body and to headers specified within the cloaked header.¶
Processing of cloaked data is described in...¶
If present, the Annotations field contains a sequence of Encrypted Data Segments encrypted under the envelope base seed. The interpretation of these fields is application specific.¶
A list of 'presignature'¶
A list of recipient key exchange information blocks.¶
A DARE security policy governing future additions to the container.¶
If present contains a JSON encoded ContentInfo structure which specifies plaintext content metadata and forms one of the inputs to the envelope digest value.¶
Information that describes container information¶
An index of records in the current container up to but not including this one.¶
Date on which the envelope was received.¶
Unique object identifier¶
List of labels that are applied to the payload of the frame.¶
List of key/value pairs describing the payload of the frame.¶
The mesh message type¶
The content type field as specified in JWE¶
List of filename paths for the payload of the frame.¶
The original filename under which the data was stored.¶
Operation on the header¶
Initial creation date.¶
Date of last modification.¶
Date at which the associated transaction will expire¶
Frame number of the first object instance value.¶
Frame number of the immediately prior object instance value¶
Information describing the file entry on disk.¶
DARE envelope uses the same fields as JWE and JWS but with different structure. In particular, DARE envelopes MAY have multiple recipients and multiple signers.¶
The signature value¶
Digest algorithm hint. Specifying the digest algorithm to be applied to the envelope body allows the body to be processed in streaming mode.¶
Key exchange algorithm¶
Key identifier of the signature key.¶
PKIX certificate of signer.¶
PKIX certificates that establish a trust path for the signer.¶
The data description that was signed.¶
The signature value as an Enhanced Data Sequence under the envelope base seed.¶
The signature witness value used on an encrypted envelope to demonstrate that the signature was authorized by a party with actual knowledge of the encryption key used to encrypt the envelope.¶
Recipient information¶
Key identifier for the encryption key.¶
The Key identifier MUST be either a UDF fingerprint of a key or a Group Key Identifier¶
The key wrapping and derivation algorithms.¶
The wrapped base seed. The base seed is encrypted under the result of the key exchange.¶
The per-recipient key exchange data.¶
The encryption algorithm to be used to compute the payload.¶
The digest algorithm to be used to compute the payload digest.¶
The encryption policy specifier, determines how often a key exchange is required. 'Single': All entries are encrypted under the key exchange specified in the entry specifying this policy. 'Isolated': All entries are encrypted under a separate key exchange. 'All': All entries are encrypted. 'None': No entries are encrypted.¶
Default value is 'None' if EncryptKeys is null, and 'All' otherwise.¶
The signature policy 'None': No entries are signed. 'Last': The last entry in the container is signed. 'Isolated': All entries are independently signed. 'Any': Entries may be signed.¶
Default value is 'None' if SignKeys is null, and 'Any' otherwise.¶
If true the policy is immutable and cannot be changed by a subsequent policy override.¶
The file path in canonical form.¶
The creation time of the file on disk in UTC¶
The last access time of the file on disk in UTC¶
The last write time of the file on disk in UTC¶
The file attribues as a bitmapped integer.¶
TBS stuff¶
TBS stuff¶
Information that describes container information¶
Specifies the data encoding for the header section of for the following frames. This value is ONLY valid in Frame 0 which MUST have a header encoded in JSON.¶
Specifies the container type for the following records. This value is ONLY valid in Frame 0 which MUST have a header encoded in JSON.¶
The record index within the file. This MUST be unique and satisfy any additional requirements determined by the ContainerType.¶
If true, the current frame is a meta frame and does not contain a payload.¶
Note: Meta frames MAY be present in any container. Applications MUST accept containers that contain meta frames at any position in the file. Applications MUST NOT interpret a meta frame as a data frame with an enpty payload.¶
If set true in a persistent container, specifies that this record contains the default object for the container.¶
Position of the frame containing the apex of the preceding sub-tree.¶
Specifies the position in the file at which the last index entry is to be found¶
Specifies the position in the file at which the key exchange data is to be found¶
TBS stuff¶
A container index¶
If true, the index is complete and contains position entries for all the frames in the file. If absent or false, the index is incremental and only contains position entries for records added since the last frame containing a ContainerIndex.¶
List of container position entries¶
Specifies the position in a file at which a specified record index is found¶
Specifies a key/value entry¶
DARE Containers are used to implement two forms of persistence store to support Mesh operations:¶
A set of related items which MAY be added, modified or deleted at any time.¶
A list of related items whose status MAY be changed at any time but which are immutable once added.¶
Since DARE Containers are an append only log format, entries can only be modified or deleted by adding items to the log to change the status of previous entries. It is always possible to undo any operation on a catalog or spool unless the underlying container is purged or the individual entries modified.¶
Catalogs contain a set of entries, each of which is distinguished by a unique identifier.¶
Three operations are supported:¶
Addition of the entry to the catalog¶
Modification of the data associated with the entry excluding the identifier¶
Removal of the entry from the catalog¶
The set of valid state transitions is defined by the Finite State machine:¶
(Add-Update*-Delete)*¶
Catalogs are used to represent sets of persistent objects associated with a Mesh Service Account. The user's set of contacts for example. Each contact entry may be modified many times over time but refers to the same subject for its entire lifetime.¶
Spools contain lists of entries, each of which is distinguished by a unique identifier.¶
Four operations are supported:¶
Addition of the entry to the spool¶
Marks the entry as having been processed.¶
Returns the entry to the unread state.¶
Mark the entry as deleted allowing recovery of associated storage in a subsequent purge operation.¶
The set of valid state transitions is defined by the Finite State machine:¶
Post-(Processed| Unprocessed| Delete *)¶
Spools are used to represent time sequence ordered entries such as lists of messages being sent or received, task queues and transaction logs.¶
The current specification describes an approach in which containers are written according to a strict append-only policy. Greater flexibility may be achieved by loosening this requirement allowing record(s) at the end of the container to be overwritten.¶
A major concern when operating a critical service is the possibility of a hardware or power failure occurring during a write operation causing the file update to be incomplete. While most modern operating systems have effective mechanisms in place to prevent corruption of the file system itself in such circumstances, this does not provide sufficient protection at the application level.¶
Appending a null record containing a container-specific magic number provides an effective means of detecting this circumstance that can be quickly verified.¶
If a container specifies a terminal integrity check value in the header of frame zero, the container is considered to be in an incomplete write state if the final frame is not a null record specifying the magic number.¶
When appending new records to such containers, the old terminal integrity check record is overwritten by the data being added and a new integrity check record appended to the end.¶
A writer can maintain a complete (or partial) index of the container in its final record without additional space overhead by overwriting the prior index on each update.¶
The task of updating terminal indexes may be deferred to a time when the machine is not busy. This improves responsiveness and may avoid the need to re-index containers receiving a sequence of updates.¶
This approach may be supported by appending new entries to the end of the container in the usual fashion and maintaining a record of containers to be updated as a separate task.¶
When updating the index on a container that has been updated in this fashion, the writer must ensure that no data is lost even if the process is interrupted. The use of guard records and other precautions against loss of state is advised.¶
This section describes security considerations arising from the use of DARE in general applications.¶
Additional security considerations for use of DARE in Mesh services and applications are described in the Mesh Security Considerations guide [draft-hallambaker-mesh-security].¶
A list of people who have contributed to the design of the Mesh is presented in [draft-hallambaker-mesh-architecture].¶
The name Data At Rest Encryption was proposed by Melhi Abdulhayo?lu.¶
In the following examples, Alice's encryption private key parameters are:¶
{
"PrivateKeyECDH":{
"crv":"Ed25519",
"Private":"6o3XJvRF5WrG4-DY3hBG_qPb3j5JiAvWPfts3VhdQeg"}}¶
Alice's signature private key parameters are:¶
{
"PrivateKeyECDH":{
"crv":"Ed25519",
"Private":"3JhYW8Q2YHJ2_cPjLYOLbzprvecQi4xsfuat0eOKLxw"}}¶
The body of the test message is the UTF8 representation of the following string:¶
"This is a test long enough to require multiple blocks"¶
The EDS sequences, are the UTF8 representation of the following strings:¶
"Subject: Message metadata should be encrypted" "2018-02-01"¶
A plaintext message without associated EDS sequences is an empty header followed by the message body:¶
{
"DareEnvelope":[{},
"VGhpcyBpcyBhIHRlc3QgbG9uZyBlbm91Z2ggdG8gcmVxdWlyZSBtdWx0aXBs
ZSBibG9ja3M"
]}¶
If a plaintext message contains EDS sequences, these are also in plaintext:¶
{
"DareEnvelope":[{
"annotations":["iAEAiC1TdWJqZWN0OiBNZXNzYWdlIG1ldGFkYXRhIHNo
b3VsZCBiZSBlbmNyeXB0ZWQ",
"iAEBiAoyMDE4LTAyLTAx"
]},
"VGhpcyBpcyBhIHRlc3QgbG9uZyBlbm91Z2ggdG8gcmVxdWlyZSBtdWx0aXBs
ZSBibG9ja3M"
]}¶
The creator generates a base seed:¶
60 14 70 EB 98 22 EB 47 61 24 46 E2 C8 F0 86 31 95 DD 37 38 C7 08 08 8C 1F 16 05 EE B7 CC F3 8B¶
For each recipient of the message:¶
The creator generates an ephemeral key:¶
{
"PrivateKeyECDH":{
"crv":"Ed25519",
"Private":"c3B3RFkR8tSm71a0nzZmHbWHgPPtrjGdu6ZB21NjBQ4"}}¶
The key agreement value is calculated:¶
D5 CB 99 BE FC F0 BA DF FA C5 9A 29 6E AE 8F DB 76 4E B0 95 76 F1 03 36 E7 1E 78 DA FC 8D EF 72¶
The key agreement value is used as the input to a HKDF key derivation function with the info parameter master to create the key used to wrap the base seed:¶
3C 79 76 F7 22 61 62 CB 2B C8 98 31 16 75 71 39 CC E3 9E 6A 25 6C F9 21 A9 6C 58 F2 DB 97 23 27¶
The wrapped base seed is:¶
41 9C 2D 1D 05 33 5D 2E AA 96 2A 46 BE 34 21 CF FD 06 8C 73 45 57 6E EC 01 43 FF 9C F7 F9 BF 14 C1 25 BB 71 51 B1 25 F9¶
This information is used to calculate the Recipient information shown in the example below.¶
To encrypt a message, we first generate a unique salt value:¶
6D 64 72 61 7D 48 99 D4 04 F2 36 7F DA 78 E1 8D¶
The base seed and salt value are used to generate the payload encryption key:¶
84 7F 2C EB 72 4A CB B2 0F 66 21 81 30 76 43 06 4F 63 80 B4 F2 68 68 EB CA 7B 96 B7 FC 04 DF DC¶
Since AES is a block cipher, we also require an initializarion vector:¶
A2 87 C4 F3 FA 8A 89 5B 4F CA 40 6E BD E2 E5 76¶
The output sequence is the encrypted bytes:¶
5A 34 06 42 1C 6A 5C 4B BF D7 44 43 4B F8 A2 B7 3E 56 65 27 AD AC 98 B1 07 59 2F F8 43 D5 A0 53 13 A1 BB D3 90 76 FB F5 1C 30 58 FB 0B 06 67 54 7A 66 FB 1D 43 50 3E C5 21 15 BA 79 AB 96 C1 1F¶
Since the message is not signed, there is no need for a trailer. The completed message is:¶
{
"DareEnvelope":[{
"enc":"A256CBC",
"kid":"EBQG-J7ZP-4NPO-BS3J-YFE4-3YPM-TICI",
"Salt":"bWRyYX1ImdQE8jZ_2njhjQ",
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"5DmkW-Ieh_XdDKRYKi-_4gPeH3QwdNZ4BYajMsxdk
e0"}},
"wmk":"8-F2jDSBxmuCE2iYqP-BVcZiZUKcE8CrL3Vxis_487W-xjUx
3b8F-A"}
]},
"WjQGQhxqXEu_10RDS_iitz5WZSetrJixB1kv-EPVoFMTobvTkHb79RwwWPsL
BmdUemb7HUNQPsUhFbp5q5bBHw"
]}¶
Signed messages specify the digest algorithm to be used in the header and the signature value in the trailer. Note that the digest algorithm is not optional since it serves as notice that a decoder should digest the payload value to enable signature verification.¶
{
"DareEnvelope":[{
"dig":"S512"},
"VGhpcyBpcyBhIHRlc3QgbG9uZyBlbm91Z2ggdG8gcmVxdWlyZSBtdWx0aXBs
ZSBibG9ja3M",
{
"signatures":[{
"alg":"S512",
"kid":"MCQU-ONOR-SMME-AJM3-4RNU-2EDR-KWX4",
"signature":"NthXHWAJ3b4r9ulhG5VRzcH3d-_RJ7PlT7F9wzD-dr
XFLFVTUfrvuXteEuBaE4-9c-DLWGc_pIc9eGLjXBB9Dw"}
],
"PayloadDigest":"raim8SV5adPbWWn8FMM4mrRAQCO9A2jZ0NZAnFXWlG
0xF6sWGJbnKSdtIJMmMU_hjarlIPEoY3vy9UdVlH5KAg"}
]}¶
A signed and encrypted message is encrypted and then signed. The signer proves knowledge of the payload plaintext by providing the plaintext witness value.¶
{
"DareEnvelope":[{
"enc":"A256CBC",
"dig":"S512",
"kid":"EBQE-FQSV-HURW-44LI-W7E3-4HMX-AR37",
"Salt":"zel4BwvOFCzTs6BrNL0yzQ",
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"bYxb8Q4_gnY3CKnppk-82V33DHseB_caD8vu7s8wT
40"}},
"wmk":"hiLLca5zdVe8BFkT8n5dPxNOlDa5l4bhCXnjFRvSil9J19g7
tnwMIQ"}
]},
"KlaXVXwrVm1t5xny6xD8U1qAvOo6Iaw1uPV_7-XvmplQCU5sGT9kyZ6Xay3H
AKP3gJ8CsxriOvxZjMwnwn4OZg",
{
"signatures":[{
"alg":"S512",
"kid":"MCQU-ONOR-SMME-AJM3-4RNU-2EDR-KWX4",
"signature":"9pXy6nHEzFjYSohDG9lR1h2ml4bvHGz6jGbMzCm_dn
8ANcNZR_E6K7JM-sTexlooTgmdMKflGylCvqNJFiyNAA",
"witness":"eqhzn-rVajjxuYGTjpOVNjJOOkeGiYa5E9iUnSr3wSg"}
],
"PayloadDigest":"HNflV2DRiLjMWSWfJ5VZW7oeXA5YxmDuq0MN9F5rCG
Kwh58BoxTE7CNyH85Cv4EH6-fKxtlmJayUmS4oxTv0Pw"}
]}¶
The data payloads in all the following examples are identical, only the authentication and/or encryption is different.¶
For conciseness, the raw data format is omitted for examples after the first, except where the data payload has been transformed, (i.e. encrypted).¶
The following example shows a simple sequence with first frame and a single data frame:¶
f4 91 f0 8b f0 00 f0 00 91 f4 f5 01 73 f0 42 f1 01 2c 73 01 f5¶
Since there is no integrity check, there is no need for trailer entries. The header values are:¶
Frame 0¶
{
"DareHeader":{
"policy":{},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"List",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1}}}
[Empty trailer]¶
The following example shows a chain sequence with a first frame and three data frames. The headers of these frames is the same as before but the frames now have trailers specifying the PayloadDigest and ChainDigest values:¶
Frame 0¶
{
"DareHeader":{
"dig":"S512",
"policy":{},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"Chain",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"ChainDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYV
RVz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 2¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":2}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"ChainDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYV
RVz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 3¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":3}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"ChainDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYV
RVz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
The following example shows a chain sequence with a first frame and six data frames. The trailers now contain the TreePosition and TreeDigest values:¶
Frame 0¶
{
"DareHeader":{
"dig":"S512",
"policy":{},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"Merkle",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1,
"TreePosition":0}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYVR
Vz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 2¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":2,
"TreePosition":392}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"7fHmkEIsPkN6sDYAOLvpIJn5Dg3PxDDAaq-ll2kh8722kok
kFnZQcYtjuVC71aHNXI18q-lPnfRkmwryG-bhqQ"}}¶
Frame 3¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":3,
"TreePosition":392}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYVR
Vz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 4¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":4,
"TreePosition":1676}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"vJ6ngNATvZcXSMALi5IUqzl1GBxBnTNVcC87VL_BhMRCbAv
KSj8gs0VFgxxLkZ2myrtaDIwhHoswiTiBMLNWug"}}¶
Frame 5¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":5,
"TreePosition":1676}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYVR
Vz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 6¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":6,
"TreePosition":2963}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"WgHlz3EHczVPqgtpc39Arv7CFIsCbFVsk8wg0j2qLlEfur9
SZ0mdr65Ka-HF0Qx8gg_DAoiJwUrwADDXyxVJOg"}}¶
The following example shows a tree sequence with a signature in the final record. The signing key parameters are:¶
{
"PrivateKeyECDH":{
"crv":"Ed25519",
"Private":"3JhYW8Q2YHJ2_cPjLYOLbzprvecQi4xsfuat0eOKLxw"}}¶
The sequence headers and trailers are:¶
Frame 0¶
{
"DareHeader":{
"dig":"S512",
"policy":{},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"Merkle",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1,
"TreePosition":0}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"T7S1FcrgY3AaWD4L-t5W1K-3XYkPTcOdGEGyjglTD6yMYVR
Vz9tn_KQc6GdA-P4VSRigBygV65OEd2Vv3YDhww"}}¶
Frame 2¶
{
"DareHeader":{
"dig":"S512",
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":2,
"TreePosition":392}}}
{
"DareTrailer":{
"PayloadDigest":"8dyi62d7MDJlsLm6_w4GEgKBjzXBRwppu6qbtmAl6UjZ
DlZeaWQlBsYhOu88-ekpNXpZ2iY96zTRI229zaJ5sw",
"TreeDigest":"7fHmkEIsPkN6sDYAOLvpIJn5Dg3PxDDAaq-ll2kh8722kok
kFnZQcYtjuVC71aHNXI18q-lPnfRkmwryG-bhqQ"}}¶
The following example shows a sequence in which all the frame payloads are encrypted under the same base seed established in a key agreement specified in the first frame.¶
Frame 0¶
{
"DareHeader":{
"enc":"A256CBC",
"kid":"EBQM-SNWC-5R6N-4JVS-JUHM-364P-FO7Y",
"Salt":"eK7VIQt1h6emMMXXJDagGA",
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"pHHafE97kxgz89p-IwkFMlbkWUHzXJ-0aTMqDJIS0Y0"}},
"wmk":"ptMrMLScJdZ7AmxcUGxJP6jQBCaunNYNbTMUQNqaQI6c4Rs7uE
fCVg"}
],
"policy":{
"enc":"none",
"dig":"none",
"EncryptKeys":[{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"-NDENZ8r4M2h3G_W7iW6IOBJlHCjMLxWnwsMnIOBcxo"}}
],
"Sealed":true},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"List",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"enc":"A256CBC",
"kid":"EBQI-WIWG-AI3H-DDR3-X6CC-CP5Q-DJIR",
"Salt":"QHNWV-Q5Amrce1_r-YA4BA",
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"GLlHst-jwA9J6Dj0x0ktFPh4_feoq9epvvdzKvd6Ils"}},
"wmk":"2M4v64eG0D-9k50EnHSFFbPbQ5GKgtu_dRET-dHFRjAGfmj6JC
EeKQ"}
],
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1}}}
[Empty trailer]¶
Frame 2¶
{
"DareHeader":{
"enc":"A256CBC",
"kid":"EBQK-6MSJ-J4DD-ZYWE-B3SJ-IXIN-55FV",
"Salt":"W-428mJAs68fIoZkLXAlEg",
"recipients":[{
"kid":"MCZG-SJCC-WPAU-MNRF-6TCG-KUUQ-ICAQ",
"epk":{
"PublicKeyECDH":{
"crv":"Ed25519",
"Public":"5lQ_frHzXaQUyMtUTAWC8E2kWDiiNCO6XeqPBrTXYn8"}},
"wmk":"hKwGLOdl56Kf2o_v2Pgr4KRfJjKtEYXutxm3Oo50kzltAAs668
60Dw"}
],
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":2}}}
[Empty trailer]¶
Here are the sequence bytes. Note that the content is now encrypted and has expanded by 25 bytes. These are the salt (16 bytes), the AES padding (4 bytes) and the JSON-B framing (5 bytes).¶
f5 02 ef f1 02 d8 f0 10 f0 00 ef 02 f5 f5 02 f9 f1 01 c3 f1 01 30 f9 02 f5 f5 02 f9 f1 01 c3 f1 01 30 f9 02 f5¶
The following example shows a sequence in which all the frame payloads are encrypted under separate key agreements specified in the payload frames.¶
Frame 0¶
{
"DareHeader":{
"policy":{
"enc":"none",
"dig":"none",
"Sealed":true},
"ContentMetaData":"e30",
"SequenceInfo":{
"DataEncoding":"JSON",
"ContainerType":"List",
"Index":0}}}
[Empty trailer]¶
Frame 1¶
{
"DareHeader":{
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":1}}}
[Empty trailer]¶
Frame 2¶
{
"DareHeader":{
"ContentMetaData":"e30",
"SequenceInfo":{
"Index":2}}}
[Empty trailer]¶
public long PreviousFrame (long Frame) {
long x2 = Frame + 1;
long d = 1;
while (x2 > 0) {
if ((x2 & 1) == 1) {
return x2 == 1 ? (d / 2) - 1 : Frame - d;
}
d = d * 2;
x2 = x2 / 2;
}
return 0;
}¶
The following issues need to be addressed.¶
| Issue | Description |
|---|---|
| Indexing | No examples are given of indexing a container |
| Archive | Should include a file archive example |
| File Path | Mention the file path security issue in the security considerations |
| Security Considerations | Write Security considerations |
| AES-GCM | Switch to using AES GCM in the examples |
| Witness | Complete handling of witness values. |
| Schema | Complete the schema documentation |