Secure Frame (SFrame)

4.1. Application Context

SFrame is a general encryption framing, intended to be used as an E2EE layer over an underlying HBH-encrypted transport such as SRTP or QUIC [RFC3711][I-D.ietf-moq-transport].¶

The scale at which SFrame encryption is applied to media determines the overall amount of overhead that SFrame adds to the media stream, as well as the engineering complexity involved in integrating SFrame into a particular environment. Two patterns are common: Either using SFrame to encrypt whole media frames (per-frame) or individual transport-level media payloads (per-packet).¶

For example, Figure 1 shows a typical media sender stack that takes media from some source, encodes it into frames, divides those frames into media packets, and then sends those payloads in SRTP packets. The receiver stack performs the reverse operations, reassembling frames from SRTP packets and decoding. Arrows indicate two different ways that SFrame protection could be integrated into this media stack, to encrypt whole frames or individual media packets.¶

Applying SFrame per-frame in this system offers higher efficiency, but may require a more complex integration in environments where depacketization relies on the content of media packets. Applying SFrame per-packet avoids this complexity, at the cost of higher bandwidth consumption. Some quantitative discussion of these trade-offs is provided in Appendix C.¶

As noted above, however, SFrame is a general media encapsulation, and can be applied in other scenarios. The important thing is that the sender and receivers of an SFrame-encrypted object agree on that object's semantics. SFrame does not provide this agreement; it must be arranged by the application.¶

Like SRTP, SFrame does not define how the keys used for SFrame are exchanged by the parties in the conference. Keys for SFrame might be distributed over an existing E2E-secure channel (see Section 5.1), or derived from an E2E-secure shared secret (see Section 5.2). The key management system MUST ensure that each key used for encrypting media is used by exactly one media sender, in order to avoid reuse of nonces.¶

4.2. SFrame Ciphertext

An SFrame ciphertext comprises an SFrame header followed by the output of an AEAD encryption of the plaintext [RFC5116], with the header provided as additional authenticated data (AAD).¶

The SFrame header is a variable-length structure described in detail in Section 4.3. The structure of the encrypted data and authentication tag are determined by the AEAD algorithm in use.¶

When SFrame is applied per-packet, the payload of each packet will be an SFrame ciphertext. When SFrame is applied per-frame, the SFrame ciphertext representing an encrypted frame will span several packets, with the header appearing in the first packet and the authentication tag in the last packet. It is the responsibility of the application to reassemble an encrypted frame from individual packets, accounting for packet loss and reordering as necessary.¶

4.3. SFrame Header

The SFrame header specifies two values from which encryption parameters are derived:¶

• A Key ID (KID) that determines which encryption key should be used¶

• A counter (CTR) that is used to construct the nonce for the encryption¶

Applications MUST ensure that each (KID, CTR) combination is used for exactly one SFrame encryption operation. A typical approach to achieving this guarantee is outlined in Section 9.1.¶

The SFrame Header has the overall structure shown in Figure 2. The first byte is a "config byte", with the following fields:¶

Extended Key Id Flag (X, 1 bit):

Indicates if the K field contains the key id or the Key ID length.¶

Key or Key Length (K, 3 bits):

If the X flag is set to 0, this field contains the Key ID. If the X flag is set to 1, then it contains the length of the Key ID, minus one.¶

Extended Counter Flag (Y, 1 bit):

Indicates if the C field contains the counter or the counter length.¶

Counter or Counter Length (C, 3 bits):

This field contains the counter (CTR) if the Y flag is set to 0, or the counter length, minus one, if set to 1.¶

The Key ID and Counter fields are encoded as compact unsigned integers in network (big-endian) byte order. If the value of one of these fields is in the range 0-7, then the value is carried in the corresponding bits of the config byte (K or C) and the corresponding flag (X or Y) is set to zero. Otherwise, the value MUST be encoded with the minimum number of bytes required and appended after the configuration byte, with the Key ID first and Counter second. The header field (K or C) is set to the number of bytes in the encoded value, minus one. The value 000 represents a length of 1, 001 a length of 2, etc. This allows a 3-bit length field to represent the value lengths 1-8.¶

The SFrame header can thus take one of the four forms shown in Figure 3, depending on which of the X and Y flags are set.¶

4.4. Encryption Schema

SFrame encryption uses an AEAD encryption algorithm and hash function defined by the cipher suite in use (see Section 4.5). We will refer to the following aspects of the AEAD and the hash algorithm below:¶

• AEAD.Encrypt and AEAD.Decrypt - The encryption and decryption functions for the AEAD. We follow the convention of RFC 5116 [RFC5116] and consider the authentication tag part of the ciphertext produced by AEAD.Encrypt (as opposed to a separate field as in SRTP [RFC3711]).¶

• AEAD.Nk - The size in bytes of a key for the encryption algorithm¶

• AEAD.Nn - The size in bytes of a nonce for the encryption algorithm¶

• AEAD.Nt - The overhead in bytes of the encryption algorithm (typically the size of a "tag" that is added to the plaintext)¶

• AEAD.Nka - For cipher suites using the compound AEAD described in Section 4.5.1, the size in bytes of a key for the underlying AES-CTR algorithm¶

• Hash.Nh - The size in bytes of the output of the hash function¶

def derive_key_salt(KID, base_key):
  sframe_secret = HKDF-Extract("", base_key)

  sframe_key_label = "SFrame 1.0 Secret key " + KID + cipher_suite
  sframe_key = HKDF-Expand(sframe_secret, info, AEAD.Nk)

  sframe_salt_label = "SFrame 1.0 Secret salt " + KID + cipher_suite
  sframe_salt = HKDF-Expand(sframe_secret, info, AEAD.Nn)

  return sframe_key, sframe_salt

def encrypt(CTR, KID, metadata, plaintext):
  sframe_key, sframe_salt = key_store[KID]

  # encode_big_endian(x, n) produces an n-byte string encoding the integer x in
  # big-endian byte order.
  ctr = encode_big_endian(CTR, AEAD.Nn)
  nonce = xor(sframe_salt, CTR)

  # encode_sframe_header produces a byte string encoding the provided KID and
  # CTR values into an SFrame Header.
  header = encode_sframe_header(CTR, KID)
  aad = header + metadata

  ciphertext = AEAD.Encrypt(sframe_key, nonce, aad, plaintext)
  return header + ciphertext

def decrypt(metadata, sframe_ciphertext):
  KID, CTR, header, ciphertext = parse_ciphertext(sframe_ciphertext)

  sframe_key, sframe_salt = key_store[KID]

  ctr = encode_big_endian(CTR, AEAD.Nn)
  nonce = xor(sframe_salt, ctr)
  aad = header + metadata

  return AEAD.Decrypt(sframe_key, nonce, aad, ciphertext)

4.5. Cipher Suites

Each SFrame session uses a single cipher suite that specifies the following primitives:¶

• A hash function used for key derivation¶

• An AEAD encryption algorithm [RFC5116] used for frame encryption, optionally with a truncated authentication tag¶

This document defines the following cipher suites, with the constants defined in Section 4.4:¶

Numeric identifiers for these cipher suites are defined in the IANA registry created in Section 8.1.¶

In the suite names, the length of the authentication tag is indicated by the last value: "_128" indicates a hundred-twenty-eight-bit tag, "_80" indicates a eighty-bit tag, "_64" indicates a sixty-four-bit tag and "_32" indicates a thirty-two-bit tag.¶

In a session that uses multiple media streams, different cipher suites might be configured for different media streams. For example, in order to conserve bandwidth, a session might use a cipher suite with eighty-bit tags for video frames and another cipher suite with thirty-two-bit tags for audio frames.¶

def derive_subkeys(sframe_key):
  enc_key = sframe_key[..Nka]
  auth_key = sframe_key[Nka..]
  return enc_key, auth_key

def truncate(tag, n):
  # Take the first `n` bytes of `tag`
  return tag[..n]

def compute_tag(auth_key, nonce, aad, ct):
  aad_len = encode_big_endian(len(aad), 8)
  ct_len = encode_big_endian(len(ct), 8)
  tag_len = encode_big_endian(Nt, 8)
  auth_data = aad_len + ct_len + tag_len + nonce + aad + ct
  tag = HMAC(auth_key, auth_data)
  return truncate(tag, Nt)

def AEAD.Encrypt(key, nonce, aad, pt):
  enc_key, auth_key = derive_subkeys(key)
  initial_counter = nonce + 0x00000000 # append four zero bytes
  ct = AES-CTR.Encrypt(enc_key, initial_counter, pt)
  tag = compute_tag(auth_key, nonce, aad, ct)
  return ct + tag

def AEAD.Decrypt(key, nonce, aad, ct):
  inner_ct, tag = split_ct(ct, tag_len)

  enc_key, auth_key = derive_subkeys(key)
  candidate_tag = compute_tag(auth_key, nonce, aad, inner_ct)
  if !constant_time_equal(tag, candidate_tag):
    raise Exception("Authentication Failure")

  initial_counter = nonce + 0x00000000 # append four zero bytes
  return AES-CTR.Decrypt(enc_key, initial_counter, inner_ct)

5.1. Sender Keys

If the participants in a call have a pre-existing E2E-secure channel, they can use it to distribute SFrame keys. Each client participating in a call generates a fresh base_key value that it will use to encrypt media. The client then uses the E2E-secure channel to send their encryption key to the other participants.¶

In this scheme, it is assumed that receivers have a signal outside of SFrame for which client has sent a given frame (e.g., an RTP SSRC). SFrame KID values are then used to distinguish between versions of the sender's base_key.¶

Key IDs in this scheme have two parts, a "key generation" and a "ratchet step". Both are unsigned integers that begin at zero. The key generation increments each time the sender distributes a new key to receivers. The "ratchet step" is incremented each time the sender ratchets their key forward for forward secrecy:¶

base_key[i+1] = HKDF-Expand(
                  HKDF-Extract("", base_key[i]),
                  "SFrame 1.0 Ratchet", CipherSuite.Nh)

For compactness, we do not send the whole ratchet step. Instead, we send only its low-order R bits, where R is a value set by the application. Different senders may use different values of R, but each receiver of a given sender needs to know what value of R is used by the sender so that they can recognize when they need to ratchet (vs. expecting a new key). R effectively defines a re-ordering window, since no more than 2^R ratchet steps can be active at a given time. The key generation is sent in the remaining 64 - R bits of the key ID.¶

KID = (key_generation << R) + (ratchet_step % (1 << R))

The sender signals such a ratchet step update by sending with a KID value in which the ratchet step has been incremented. A receiver who receives from a sender with a new KID computes the new key as above. The old key may be kept for some time to allow for out-of-order delivery, but should be deleted promptly.¶

If a new participant joins in the middle of a session, they will need to receive from each sender (a) the current sender key for that sender and (b) the current KID value for the sender. Evicting a participant requires each sender to send a fresh sender key to all receivers.¶

It is up to the application to decide when sender keys are updated. A sender key may be updated by sending a new base_key (updating the key generation) or by hashing the current base_key (updating the ratchet step). Ratcheting the key forward is useful when adding new receivers to an SFrame-based interaction, since it assures that the new receivers can't decrypt any media encrypted before they were added. If a sender wishes to assure the opposite property when removing a receiver (i.e., ensuring that the receiver can't decrypt media after they are removed), then the sender will need to distribute a new sender key.¶

5.2. MLS

The Messaging Layer Security (MLS) protocol provides group authenticated key exchange [MLS-ARCH] [MLS-PROTO]. In principle, it could be used to instantiate the sender key scheme above, but it can also be used more efficiently directly.¶

MLS creates a linear sequence of keys, each of which is shared among the members of a group at a given point in time. When a member joins or leaves the group, a new key is produced that is known only to the augmented or reduced group. Each step in the lifetime of the group is known as an "epoch", and each member of the group is assigned an "index" that is constant for the time they are in the group.¶

To generate keys and nonces for SFrame, we use the MLS exporter function to generate a base_key value for each MLS epoch. Each member of the group is assigned a set of KID values, so that each member has a unique sframe_key and sframe_salt that it uses to encrypt with. Senders may choose any KID value within their assigned set of KID values, e.g., to allow a single sender to send multiple uncoordinated outbound media streams.¶

base_key = MLS-Exporter("SFrame 1.0 Base Key", "", AEAD.Nk)

For compactness, we do not send the whole epoch number. Instead, we send only its low-order E bits, where E is a value set by the application. E effectively defines a re-ordering window, since no more than 2^E epochs can be active at a given time. Receivers MUST be prepared for the epoch counter to roll over, removing an old epoch when a new epoch with the same E lower bits is introduced.¶

Let S be the number of bits required to encode a member index in the group, i.e., the smallest value such that group_size <= (1 << S). The sender index is encoded in the S bits above the epoch. The remaining 64 - S - E bits of the KID value are a context value chosen by the sender (context value 0 will produce the shortest encoded KID).¶

KID = (context << (S + E)) + (sender_index << E) + (epoch % (1 << E))

Once an SFrame stack has been provisioned with the sframe_epoch_secret for an epoch, it can compute the required KID values on demand (as well as the resulting SFrame keys/nonces derived from the base_key and KID), as it needs to encrypt or decrypt for a given member.¶

6.1. Selective Forwarding Units

Selective Forwarding Units (SFUs) (e.g., those described in Section 3.7 of [RFC7667]) receive the media streams from each participant and select which ones should be forwarded to each of the other participants. There are several approaches for stream selection, but in general, the SFU needs to access metadata associated to each frame and modify the RTP information of the incoming packets when they are transmitted to the received participants.¶

This section describes how this normal SFU modes of operation interact with the E2EE provided by SFrame.¶

6.2. Video Key Frames

Forward Security and Post-Compromise Security require that the E2EE keys (base keys) are updated any time a participant joins or leaves the call.¶

The key exchange happens asynchronously and on a different path than the SFU signaling and media. So it may happen that when a new participant joins the call and the SFU side requests a key frame, the sender generates the E2EE frame with a key not known by the receiver, so it will be discarded. When the sender updates his sending key with the new key, it will send it in a non-key frame, so the receiver will be able to decrypt it, but not decode it.¶

The new Receiver will then re-request a key frame, but due to sender and SFU policies, that new key frame could take some time to be generated.¶

If the sender sends a key frame after the new E2EE key is in use, the time required for the new participant to display the video is minimized.¶

Note that this issue does not arise for media streams that do not have dependencies among frames, e.g., audio streams. In these streams, each frame is independently decodeable, so there is never a need to process two frames together which might be on two sides of a key rotation.¶

6.3. Partial Decoding

Some codecs support partial decoding, where individual packets can be decoded without waiting for the full frame to arrive. When SFrame is applied per-frame, this won't be possible because the decoder cannot access data until an entire frame has arrived and has been decrypted.¶

7.1. No Header Confidentiality

SFrame provides integrity protection to the SFrame Header (the key ID and counter values), but does not provide confidentiality protection. Parties that can observe the SFrame header may learn, for example, which parties are sending SFrame payloads (from KID values) and at what rates (from CTR values). In cases where SFrame is used for end-to-end security on top of hop-by-hop protections (e.g., running over SRTP as described in Appendix C.5), the hop-by-hop security mechanisms provide confidentiality protection of the SFrame header between hops.¶

7.2. No Per-Sender Authentication

SFrame does not provide per-sender authentication of media data. Any sender in a session can send media that will be associated with any other sender. This is because SFrame uses symmetric encryption to protect media data, so that any receiver also has the keys required to encrypt packets for the sender.¶

7.3. Key Management

Key exchange mechanism is out of scope of this document, however every client SHOULD change their keys when new clients joins or leaves the call for forward secrecy and post compromise security.¶

7.4. Replay

The handling of replay is out of the scope of this document. However, senders MUST reject requests to encrypt multiple times with the same key and nonce, since several AEAD algorithms fail badly in such cases (see, e.g., Section 5.1.1 of [RFC5116]).¶

7.5. Risks due to Short Tags

The SFrame ciphersuites based on AES-CTR allow for the use of short authentication tags, which bring a higher risk that an attacker will be able to cause an SFrame receiver to accept an SFrame ciphertext of the attacker's choosing.¶

Assuming that the authentication properties of the ciphersuite are robust, the only attack that an attacker can mount is an attempt to find an acceptable (ciphertext, tag) combination through brute force. Such a brute-force attack will have an expected sucess rate of the following form:¶

attacker_success_rate = attempts_per_second / 2^(8*Nt) ¶

For example, a gigabit ethernet connection is able to transmit roughly 2^20 packets per second. If an attacker saturated such a link with guesses against a 32-bit authentication tag (Nt=4), then the attacker would succeed on average roughly once every 2^12 seconds, or about once an hour.¶

In a typical SFrame usage in a real-time media application, there are a few approaches to mitigating this risk:¶

• Receivers only accept SFrame ciphertexts over HBH-secure channels (e.g., SRTP security associations or QUIC connections). If this is the case, only an entity that is part of such a channel can mount the above attack.¶

• The expected packet rate for a media stream is very predictable (and typically far lower than the above example). On the one hand, attacks at this rate will succeed even less often than the high-rate attack described above. On the other hand, the application may use an elevated packet arrival rate as a signal of a brute-force attack. This latter approach is common in other settings, e.g., mitigating brute-force attacks on passwords.¶

• Media applications typically do not provide feedback to media senders as to which media packets failed to decrypt. When media quality feedback mechanisms are used, decryption failures will typically appear as packet losses, but only at an aggregate level.¶

• Anti-replay mechanisms (see Section 7.4) prevent the attacker from re-using valid ciphertexts (either observed or guessed by the attacker). A receiver applying anti-replay controls will only accept one valid plaintext per CTR value. Since the CTR value is covered by SFrame authentication, an attacker has to do a fresh search for a valid tag for every forged ciphertext, even if the encrypted content is unchanged. In other words, when the above brute force attack succeeds, it only allows the attacker to send a single SFrame ciphertext; the ciphertext cannot be reused because either it will have the same CTR value and be discarded as a replay, or else it will have a different CTR value its tag will no longer be valid.¶

Nonetheless, without these mitigations, an application that makes use of short tags will be at heightened risk of forgery attacks. In many cases, it is simpler to use full-size tags and tolerate slightly higher bandwidth usage rather than add the additional defenses necessary to safely use short tags.¶

8.1. SFrame Cipher Suites

This registry lists identifiers for SFrame cipher suites, as defined in Section 4.5. The cipher suite field is two bytes wide, so the valid cipher suites are in the range 0x0000 to 0xFFFF.¶

Template:¶

• Value: The numeric value of the cipher suite¶

• Name: The name of the cipher suite¶

• Reference: The document where this cipher suite is defined¶

Initial contents:¶

9.1. Header Value Uniqueness

Applications MUST ensure that each (base_key, KID, CTR) combination is used for at most one SFrame encryption operation. This ensures that the (key, nonce) pairs used by the underlying AEAD algorithm are never reused. Typically this is done by assigning each sender a KID or set of KIDs, then having each sender use the CTR field as a monotonic counter, incrementing for each plaintext that is encrypted. In addition to its simplicity, this scheme minimizes overhead by keeping CTR values as small as possible.¶

9.2. Key Management Framework

It is up to the application to provision SFrame with a mapping of KID values to base_key values and the resulting keys and salts. More importantly, the application specifies which KID values are used for which purposes (e.g., by which senders). An application's KID assignment strategy MUST be structured to assure the non-reuse properties discussed in Section 9.1.¶

It is also up to the application to define a rotation schedule for keys. For example, one application might have an ephemeral group for every call and keep rotating keys when end points join or leave the call, while another application could have a persistent group that can be used for multiple calls and simply derives ephemeral symmetric keys for a specific call.¶

It should be noted that KID values are not encrypted by SFrame, and are thus visible to any application-layer intermediaries that might handle an SFrame ciphertext. If there are application semantics included in KID values, then this information would be exposed to intermediaries. For example, in the scheme of Section 5.1, the number of ratchet steps per sender is exposed, and in the scheme of Section 5.2, the number of epochs and the MLS sender ID of the SFrame sender are exposed.¶

9.3. Anti-Replay

It is the responsibility of the application to handle anti-replay. Replay by network attackers is assumed to be prevented by network-layer facilities (e.g., TLS, SRTP). As mentioned in Section 7.4, senders MUST reject requests to encrypt multiple times with the same key and nonce.¶

It is not mandatory to implement anti-replay on the receiver side. Receivers MAY apply time or counter based anti-replay mitigations. For example, Section 3.3.2 of [RFC3711] specifies a counter-based anti-replay mitigation, which could be adapted to use with SFrame, using the CTR field as the counter.¶

9.4. Metadata

The metadata input to SFrame operations is pure application-specified data. As such, it is up to the application to define what information should go in the metadata input and ensure that it is provided to the encryption and decryption functions at the appropriate points. A receiver MUST NOT use SFrame-authenticated metadata until after the SFrame decrypt function has authenticated it, unless the purpose of such usage is to prepare an SFrame ciphertext for SFrame decryption. Essentially, metadata may be used "upstream of SFrame" in a processing pipeline, but only to prepare for SFrame decryption.¶

For example, consider an application where SFrame is used to encrypt audio frames that are sent over SRTP, with some application data included in the RTP header extension. Suppose the application also includes this application data in the SFrame metadata, so that the SFU is allowed to read, but not modify the application data. A receiver can use the application data in the RTP header extension as part of the standard SRTP decryption process, since this is required to recover the SFrame ciphertext carried in the SRTP payload. However, the receiver MUST NOT use the application data for other purposes before SFrame decryption has authenticated the application data.¶

C.1. Assumptions

In the below calculations, we make conservative assumptions about SFrame overhead, so that the overhead amounts we compute here are likely to be an upper bound on those seen in practice.¶

In total, then, we assume that each SFrame encryption will add 22 bytes of overhead.¶

We consider two scenarios, applying SFrame per-frame and per-packet. In each scenario, we compute the SFrame overhead in absolute terms (Kbps) and as a percentage of the base bandwidth.¶

C.2. Audio

In audio streams, there is typically a one-to-one relationship between frames and packets, so the overhead is the same whether one uses SFrame at a per-packet or per-frame level.¶

The below table considers three scenarios, based on recommended configurations of the Opus codec [RFC6716]:¶

• Narrow-band speech: 120ms packets, 8Kbps¶

• Full-band speech: 20ms packets, 32Kbps¶

• Full-band stereo music: 10ms packets, 128Kbps¶

C.3. Video

Video frames can be larger than an MTU and thus are commonly split across multiple frames. Table 5 and Table 6 show the estimated overhead of encrypting a video stream, where SFrame is applied per-frame and per-packet, respectively. The choices of resolution, frames per second, and bandwidth are chosen to roughly reflect the capabilities of modern video codecs across a range from very low to very high quality.¶

In the per-frame case, the SFrame percentage overhead approaches zero as the quality of the video goes up, since bandwidth is driven more by picture size than frame rate. In the per-packet case, the SFrame percentage overhead approaches the ratio between the SFrame overhead per packet and the MTU (here 22 bytes of SFrame overhead divided by an assumed 1200-byte MTU, or about 1.8%).¶

C.4. Conferences

Real conferences usually involve several audio and video streams. The overhead of SFrame in such a conference is the aggregate of the overhead over all the individual streams. Thus, while SFrame incurs a large percentage overhead on an audio stream, if the conference also involves a video stream, then the audio overhead is likely negligible relative to the overall bandwidth of the conference.¶

For example, Table 7 shows the overhead estimates for a two person conference where one person is sending low-quality media and the other sending high-quality. (And we assume that SFrame is applied per-frame.) The video streams dominate the bandwidth at the SFU, so the total bandwidth overhead is only around 1%.¶

C.5. SFrame over RTP

SFrame is a generic encapsulation format, but many of the applications in which it is likely to be integrated are based on RTP. This section discusses how an integration between SFrame and RTP could be done, and some of the challenges that would need to be overcome.¶

As discussed in Section 4.1, there are two natural patterns for integrating SFrame into an application: applying SFrame per-frame or per-packet. In RTP-based applications, applying SFrame per-packet means that the payload of each RTP packet will be an SFrame ciphertext, starting with an SFrame Header, as shown in Figure 10. Applying SFrame per-frame means that different RTP payloads will have different formats: The first payload of a frame will contain the SFrame headers, and subsequent payloads will contain further chunks of the ciphertext, as shown in Figure 11.¶

In order for these media payloads to be properly interpreted by receivers, receivers will need to be configured to know which of the above schemes the sender has applied to a given sequence of RTP packets. SFrame does not provide a mechanism for distributing this configuration information. In applications that use SDP for negotiating RTP media streams [RFC4566], an appropriate extension to SDP could provide this function.¶

Applying SFrame per-frame also requires that packetization and depacketization be done in a generic manner that does not depend on the media content of the packets, since the content being packetized / depacketized will be opaque ciphertext (except for the SFrame header). In order for such a generic packetization scheme to work interoperably one would have to be defined, e.g., as proposed in [I-D.codec-agnostic-rtp-payload-format].¶

D.1. Header encoding/decoding

For each case, we provide:¶

• kid: A KID value¶

• ctr: A CTR value¶

• header: An encoded SFrame header¶

An implementation should verify that:¶

• Encoding a header with the KID and CTR results in the provided header value¶

• Decoding the provided header value results in the provided KID and CTR values¶

kid: 0x0000000000000000
ctr: 0x0000000000000000
header: 00

kid: 0x0000000000000000
ctr: 0x0000000000000001
header: 01

kid: 0x0000000000000000
ctr: 0x00000000000000ff
header: 08ff

kid: 0x0000000000000000
ctr: 0x0000000000000100
header: 090100

kid: 0x0000000000000000
ctr: 0x000000000000ffff
header: 09ffff

kid: 0x0000000000000000
ctr: 0x0000000000010000
header: 0a010000

kid: 0x0000000000000000
ctr: 0x0000000000ffffff
header: 0affffff

kid: 0x0000000000000000
ctr: 0x0000000001000000
header: 0b01000000

kid: 0x0000000000000000
ctr: 0x00000000ffffffff
header: 0bffffffff

kid: 0x0000000000000000
ctr: 0x0000000100000000
header: 0c0100000000

kid: 0x0000000000000000
ctr: 0x000000ffffffffff
header: 0cffffffffff

kid: 0x0000000000000000
ctr: 0x0000010000000000
header: 0d010000000000

kid: 0x0000000000000000
ctr: 0x0000ffffffffffff
header: 0dffffffffffff

kid: 0x0000000000000000
ctr: 0x0001000000000000
header: 0e01000000000000

kid: 0x0000000000000000
ctr: 0x00ffffffffffffff
header: 0effffffffffffff

kid: 0x0000000000000000
ctr: 0x0100000000000000
header: 0f0100000000000000

kid: 0x0000000000000000
ctr: 0xffffffffffffffff
header: 0fffffffffffffffff

kid: 0x0000000000000001
ctr: 0x0000000000000000
header: 10

kid: 0x0000000000000001
ctr: 0x0000000000000001
header: 11

kid: 0x0000000000000001
ctr: 0x00000000000000ff
header: 18ff

kid: 0x0000000000000001
ctr: 0x0000000000000100
header: 190100

kid: 0x0000000000000001
ctr: 0x000000000000ffff
header: 19ffff

kid: 0x0000000000000001
ctr: 0x0000000000010000
header: 1a010000

kid: 0x0000000000000001
ctr: 0x0000000000ffffff
header: 1affffff

kid: 0x0000000000000001
ctr: 0x0000000001000000
header: 1b01000000

kid: 0x0000000000000001
ctr: 0x00000000ffffffff
header: 1bffffffff

kid: 0x0000000000000001
ctr: 0x0000000100000000
header: 1c0100000000

kid: 0x0000000000000001
ctr: 0x000000ffffffffff
header: 1cffffffffff

kid: 0x0000000000000001
ctr: 0x0000010000000000
header: 1d010000000000

kid: 0x0000000000000001
ctr: 0x0000ffffffffffff
header: 1dffffffffffff

kid: 0x0000000000000001
ctr: 0x0001000000000000
header: 1e01000000000000

kid: 0x0000000000000001
ctr: 0x00ffffffffffffff
header: 1effffffffffffff

kid: 0x0000000000000001
ctr: 0x0100000000000000
header: 1f0100000000000000

kid: 0x0000000000000001
ctr: 0xffffffffffffffff
header: 1fffffffffffffffff

kid: 0x00000000000000ff
ctr: 0x0000000000000000
header: 80ff

kid: 0x00000000000000ff
ctr: 0x0000000000000001
header: 81ff

kid: 0x00000000000000ff
ctr: 0x00000000000000ff
header: 88ffff

kid: 0x00000000000000ff
ctr: 0x0000000000000100
header: 89ff0100

kid: 0x00000000000000ff
ctr: 0x000000000000ffff
header: 89ffffff

kid: 0x00000000000000ff
ctr: 0x0000000000010000
header: 8aff010000

kid: 0x00000000000000ff
ctr: 0x0000000000ffffff
header: 8affffffff

kid: 0x00000000000000ff
ctr: 0x0000000001000000
header: 8bff01000000

kid: 0x00000000000000ff
ctr: 0x00000000ffffffff
header: 8bffffffffff

kid: 0x00000000000000ff
ctr: 0x0000000100000000
header: 8cff0100000000

kid: 0x00000000000000ff
ctr: 0x000000ffffffffff
header: 8cffffffffffff

kid: 0x00000000000000ff
ctr: 0x0000010000000000
header: 8dff010000000000

kid: 0x00000000000000ff
ctr: 0x0000ffffffffffff
header: 8dffffffffffffff

kid: 0x00000000000000ff
ctr: 0x0001000000000000
header: 8eff01000000000000

kid: 0x00000000000000ff
ctr: 0x00ffffffffffffff
header: 8effffffffffffffff

kid: 0x00000000000000ff
ctr: 0x0100000000000000
header: 8fff0100000000000000

kid: 0x00000000000000ff
ctr: 0xffffffffffffffff
header: 8fffffffffffffffffff

kid: 0x0000000000000100
ctr: 0x0000000000000000
header: 900100

kid: 0x0000000000000100
ctr: 0x0000000000000001
header: 910100

kid: 0x0000000000000100
ctr: 0x00000000000000ff
header: 980100ff

kid: 0x0000000000000100
ctr: 0x0000000000000100
header: 9901000100

kid: 0x0000000000000100
ctr: 0x000000000000ffff
header: 990100ffff

kid: 0x0000000000000100
ctr: 0x0000000000010000
header: 9a0100010000

kid: 0x0000000000000100
ctr: 0x0000000000ffffff
header: 9a0100ffffff

kid: 0x0000000000000100
ctr: 0x0000000001000000
header: 9b010001000000

kid: 0x0000000000000100
ctr: 0x00000000ffffffff
header: 9b0100ffffffff

kid: 0x0000000000000100
ctr: 0x0000000100000000
header: 9c01000100000000

kid: 0x0000000000000100
ctr: 0x000000ffffffffff
header: 9c0100ffffffffff

kid: 0x0000000000000100
ctr: 0x0000010000000000
header: 9d0100010000000000

kid: 0x0000000000000100
ctr: 0x0000ffffffffffff
header: 9d0100ffffffffffff

kid: 0x0000000000000100
ctr: 0x0001000000000000
header: 9e010001000000000000

kid: 0x0000000000000100
ctr: 0x00ffffffffffffff
header: 9e0100ffffffffffffff

kid: 0x0000000000000100
ctr: 0x0100000000000000
header: 9f01000100000000000000

kid: 0x0000000000000100
ctr: 0xffffffffffffffff
header: 9f0100ffffffffffffffff

kid: 0x000000000000ffff
ctr: 0x0000000000000000
header: 90ffff

kid: 0x000000000000ffff
ctr: 0x0000000000000001
header: 91ffff

kid: 0x000000000000ffff
ctr: 0x00000000000000ff
header: 98ffffff

kid: 0x000000000000ffff
ctr: 0x0000000000000100
header: 99ffff0100

kid: 0x000000000000ffff
ctr: 0x000000000000ffff
header: 99ffffffff

kid: 0x000000000000ffff
ctr: 0x0000000000010000
header: 9affff010000

kid: 0x000000000000ffff
ctr: 0x0000000000ffffff
header: 9affffffffff

kid: 0x000000000000ffff
ctr: 0x0000000001000000
header: 9bffff01000000

kid: 0x000000000000ffff
ctr: 0x00000000ffffffff
header: 9bffffffffffff

kid: 0x000000000000ffff
ctr: 0x0000000100000000
header: 9cffff0100000000

kid: 0x000000000000ffff
ctr: 0x000000ffffffffff
header: 9cffffffffffffff

kid: 0x000000000000ffff
ctr: 0x0000010000000000
header: 9dffff010000000000

kid: 0x000000000000ffff
ctr: 0x0000ffffffffffff
header: 9dffffffffffffffff

kid: 0x000000000000ffff
ctr: 0x0001000000000000
header: 9effff01000000000000

kid: 0x000000000000ffff
ctr: 0x00ffffffffffffff
header: 9effffffffffffffffff

kid: 0x000000000000ffff
ctr: 0x0100000000000000
header: 9fffff0100000000000000

kid: 0x000000000000ffff
ctr: 0xffffffffffffffff
header: 9fffffffffffffffffffff

kid: 0x0000000000010000
ctr: 0x0000000000000000
header: a0010000

kid: 0x0000000000010000
ctr: 0x0000000000000001
header: a1010000

kid: 0x0000000000010000
ctr: 0x00000000000000ff
header: a8010000ff

kid: 0x0000000000010000
ctr: 0x0000000000000100
header: a90100000100

kid: 0x0000000000010000
ctr: 0x000000000000ffff
header: a9010000ffff

kid: 0x0000000000010000
ctr: 0x0000000000010000
header: aa010000010000

kid: 0x0000000000010000
ctr: 0x0000000000ffffff
header: aa010000ffffff

kid: 0x0000000000010000
ctr: 0x0000000001000000
header: ab01000001000000

kid: 0x0000000000010000
ctr: 0x00000000ffffffff
header: ab010000ffffffff

kid: 0x0000000000010000
ctr: 0x0000000100000000
header: ac0100000100000000

kid: 0x0000000000010000
ctr: 0x000000ffffffffff
header: ac010000ffffffffff

kid: 0x0000000000010000
ctr: 0x0000010000000000
header: ad010000010000000000

kid: 0x0000000000010000
ctr: 0x0000ffffffffffff
header: ad010000ffffffffffff

kid: 0x0000000000010000
ctr: 0x0001000000000000
header: ae01000001000000000000

kid: 0x0000000000010000
ctr: 0x00ffffffffffffff
header: ae010000ffffffffffffff

kid: 0x0000000000010000
ctr: 0x0100000000000000
header: af0100000100000000000000

kid: 0x0000000000010000
ctr: 0xffffffffffffffff
header: af010000ffffffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0000000000000000
header: a0ffffff

kid: 0x0000000000ffffff
ctr: 0x0000000000000001
header: a1ffffff

kid: 0x0000000000ffffff
ctr: 0x00000000000000ff
header: a8ffffffff

kid: 0x0000000000ffffff
ctr: 0x0000000000000100
header: a9ffffff0100

kid: 0x0000000000ffffff
ctr: 0x000000000000ffff
header: a9ffffffffff

kid: 0x0000000000ffffff
ctr: 0x0000000000010000
header: aaffffff010000

kid: 0x0000000000ffffff
ctr: 0x0000000000ffffff
header: aaffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0000000001000000
header: abffffff01000000

kid: 0x0000000000ffffff
ctr: 0x00000000ffffffff
header: abffffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0000000100000000
header: acffffff0100000000

kid: 0x0000000000ffffff
ctr: 0x000000ffffffffff
header: acffffffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0000010000000000
header: adffffff010000000000

kid: 0x0000000000ffffff
ctr: 0x0000ffffffffffff
header: adffffffffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0001000000000000
header: aeffffff01000000000000

kid: 0x0000000000ffffff
ctr: 0x00ffffffffffffff
header: aeffffffffffffffffffff

kid: 0x0000000000ffffff
ctr: 0x0100000000000000
header: afffffff0100000000000000

kid: 0x0000000000ffffff
ctr: 0xffffffffffffffff
header: afffffffffffffffffffffff

kid: 0x0000000001000000
ctr: 0x0000000000000000
header: b001000000

kid: 0x0000000001000000
ctr: 0x0000000000000001
header: b101000000

kid: 0x0000000001000000
ctr: 0x00000000000000ff
header: b801000000ff

kid: 0x0000000001000000
ctr: 0x0000000000000100
header: b9010000000100

kid: 0x0000000001000000
ctr: 0x000000000000ffff
header: b901000000ffff

kid: 0x0000000001000000
ctr: 0x0000000000010000
header: ba01000000010000

kid: 0x0000000001000000
ctr: 0x0000000000ffffff
header: ba01000000ffffff

kid: 0x0000000001000000
ctr: 0x0000000001000000
header: bb0100000001000000

kid: 0x0000000001000000
ctr: 0x00000000ffffffff
header: bb01000000ffffffff

kid: 0x0000000001000000
ctr: 0x0000000100000000
header: bc010000000100000000

kid: 0x0000000001000000
ctr: 0x000000ffffffffff
header: bc01000000ffffffffff

kid: 0x0000000001000000
ctr: 0x0000010000000000
header: bd01000000010000000000

kid: 0x0000000001000000
ctr: 0x0000ffffffffffff
header: bd01000000ffffffffffff

kid: 0x0000000001000000
ctr: 0x0001000000000000
header: be0100000001000000000000

kid: 0x0000000001000000
ctr: 0x00ffffffffffffff
header: be01000000ffffffffffffff

kid: 0x0000000001000000
ctr: 0x0100000000000000
header: bf010000000100000000000000

kid: 0x0000000001000000
ctr: 0xffffffffffffffff
header: bf01000000ffffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000000000000
header: b0ffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000000000001
header: b1ffffffff

kid: 0x00000000ffffffff
ctr: 0x00000000000000ff
header: b8ffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000000000100
header: b9ffffffff0100

kid: 0x00000000ffffffff
ctr: 0x000000000000ffff
header: b9ffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000000010000
header: baffffffff010000

kid: 0x00000000ffffffff
ctr: 0x0000000000ffffff
header: baffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000001000000
header: bbffffffff01000000

kid: 0x00000000ffffffff
ctr: 0x00000000ffffffff
header: bbffffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000000100000000
header: bcffffffff0100000000

kid: 0x00000000ffffffff
ctr: 0x000000ffffffffff
header: bcffffffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0000010000000000
header: bdffffffff010000000000

kid: 0x00000000ffffffff
ctr: 0x0000ffffffffffff
header: bdffffffffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0001000000000000
header: beffffffff01000000000000

kid: 0x00000000ffffffff
ctr: 0x00ffffffffffffff
header: beffffffffffffffffffffff

kid: 0x00000000ffffffff
ctr: 0x0100000000000000
header: bfffffffff0100000000000000

kid: 0x00000000ffffffff
ctr: 0xffffffffffffffff
header: bfffffffffffffffffffffffff

kid: 0x0000000100000000
ctr: 0x0000000000000000
header: c00100000000

kid: 0x0000000100000000
ctr: 0x0000000000000001
header: c10100000000

kid: 0x0000000100000000
ctr: 0x00000000000000ff
header: c80100000000ff

kid: 0x0000000100000000
ctr: 0x0000000000000100
header: c901000000000100

kid: 0x0000000100000000
ctr: 0x000000000000ffff
header: c90100000000ffff

kid: 0x0000000100000000
ctr: 0x0000000000010000
header: ca0100000000010000

kid: 0x0000000100000000
ctr: 0x0000000000ffffff
header: ca0100000000ffffff

kid: 0x0000000100000000
ctr: 0x0000000001000000
header: cb010000000001000000

kid: 0x0000000100000000
ctr: 0x00000000ffffffff
header: cb0100000000ffffffff

kid: 0x0000000100000000
ctr: 0x0000000100000000
header: cc01000000000100000000

kid: 0x0000000100000000
ctr: 0x000000ffffffffff
header: cc0100000000ffffffffff

kid: 0x0000000100000000
ctr: 0x0000010000000000
header: cd0100000000010000000000

kid: 0x0000000100000000
ctr: 0x0000ffffffffffff
header: cd0100000000ffffffffffff

kid: 0x0000000100000000
ctr: 0x0001000000000000
header: ce010000000001000000000000

kid: 0x0000000100000000
ctr: 0x00ffffffffffffff
header: ce0100000000ffffffffffffff

kid: 0x0000000100000000
ctr: 0x0100000000000000
header: cf01000000000100000000000000

kid: 0x0000000100000000
ctr: 0xffffffffffffffff
header: cf0100000000ffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000000000000
header: c0ffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000000000001
header: c1ffffffffff

kid: 0x000000ffffffffff
ctr: 0x00000000000000ff
header: c8ffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000000000100
header: c9ffffffffff0100

kid: 0x000000ffffffffff
ctr: 0x000000000000ffff
header: c9ffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000000010000
header: caffffffffff010000

kid: 0x000000ffffffffff
ctr: 0x0000000000ffffff
header: caffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000001000000
header: cbffffffffff01000000

kid: 0x000000ffffffffff
ctr: 0x00000000ffffffff
header: cbffffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000000100000000
header: ccffffffffff0100000000

kid: 0x000000ffffffffff
ctr: 0x000000ffffffffff
header: ccffffffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0000010000000000
header: cdffffffffff010000000000

kid: 0x000000ffffffffff
ctr: 0x0000ffffffffffff
header: cdffffffffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0001000000000000
header: ceffffffffff01000000000000

kid: 0x000000ffffffffff
ctr: 0x00ffffffffffffff
header: ceffffffffffffffffffffffff

kid: 0x000000ffffffffff
ctr: 0x0100000000000000
header: cfffffffffff0100000000000000

kid: 0x000000ffffffffff
ctr: 0xffffffffffffffff
header: cfffffffffffffffffffffffffff

kid: 0x0000010000000000
ctr: 0x0000000000000000
header: d0010000000000

kid: 0x0000010000000000
ctr: 0x0000000000000001
header: d1010000000000

kid: 0x0000010000000000
ctr: 0x00000000000000ff
header: d8010000000000ff

kid: 0x0000010000000000
ctr: 0x0000000000000100
header: d90100000000000100

kid: 0x0000010000000000
ctr: 0x000000000000ffff
header: d9010000000000ffff

kid: 0x0000010000000000
ctr: 0x0000000000010000
header: da010000000000010000

kid: 0x0000010000000000
ctr: 0x0000000000ffffff
header: da010000000000ffffff

kid: 0x0000010000000000
ctr: 0x0000000001000000
header: db01000000000001000000

kid: 0x0000010000000000
ctr: 0x00000000ffffffff
header: db010000000000ffffffff

kid: 0x0000010000000000
ctr: 0x0000000100000000
header: dc0100000000000100000000

kid: 0x0000010000000000
ctr: 0x000000ffffffffff
header: dc010000000000ffffffffff

kid: 0x0000010000000000
ctr: 0x0000010000000000
header: dd010000000000010000000000

kid: 0x0000010000000000
ctr: 0x0000ffffffffffff
header: dd010000000000ffffffffffff

kid: 0x0000010000000000
ctr: 0x0001000000000000
header: de01000000000001000000000000

kid: 0x0000010000000000
ctr: 0x00ffffffffffffff
header: de010000000000ffffffffffffff

kid: 0x0000010000000000
ctr: 0x0100000000000000
header: df0100000000000100000000000000

kid: 0x0000010000000000
ctr: 0xffffffffffffffff
header: df010000000000ffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000000000000
header: d0ffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000000000001
header: d1ffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x00000000000000ff
header: d8ffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000000000100
header: d9ffffffffffff0100

kid: 0x0000ffffffffffff
ctr: 0x000000000000ffff
header: d9ffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000000010000
header: daffffffffffff010000

kid: 0x0000ffffffffffff
ctr: 0x0000000000ffffff
header: daffffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000001000000
header: dbffffffffffff01000000

kid: 0x0000ffffffffffff
ctr: 0x00000000ffffffff
header: dbffffffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000000100000000
header: dcffffffffffff0100000000

kid: 0x0000ffffffffffff
ctr: 0x000000ffffffffff
header: dcffffffffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0000010000000000
header: ddffffffffffff010000000000

kid: 0x0000ffffffffffff
ctr: 0x0000ffffffffffff
header: ddffffffffffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0001000000000000
header: deffffffffffff01000000000000

kid: 0x0000ffffffffffff
ctr: 0x00ffffffffffffff
header: deffffffffffffffffffffffffff

kid: 0x0000ffffffffffff
ctr: 0x0100000000000000
header: dfffffffffffff0100000000000000

kid: 0x0000ffffffffffff
ctr: 0xffffffffffffffff
header: dfffffffffffffffffffffffffffff

kid: 0x0001000000000000
ctr: 0x0000000000000000
header: e001000000000000

kid: 0x0001000000000000
ctr: 0x0000000000000001
header: e101000000000000

kid: 0x0001000000000000
ctr: 0x00000000000000ff
header: e801000000000000ff

kid: 0x0001000000000000
ctr: 0x0000000000000100
header: e9010000000000000100

kid: 0x0001000000000000
ctr: 0x000000000000ffff
header: e901000000000000ffff

kid: 0x0001000000000000
ctr: 0x0000000000010000
header: ea01000000000000010000

kid: 0x0001000000000000
ctr: 0x0000000000ffffff
header: ea01000000000000ffffff

kid: 0x0001000000000000
ctr: 0x0000000001000000
header: eb0100000000000001000000

kid: 0x0001000000000000
ctr: 0x00000000ffffffff
header: eb01000000000000ffffffff

kid: 0x0001000000000000
ctr: 0x0000000100000000
header: ec010000000000000100000000

kid: 0x0001000000000000
ctr: 0x000000ffffffffff
header: ec01000000000000ffffffffff

kid: 0x0001000000000000
ctr: 0x0000010000000000
header: ed01000000000000010000000000

kid: 0x0001000000000000
ctr: 0x0000ffffffffffff
header: ed01000000000000ffffffffffff

kid: 0x0001000000000000
ctr: 0x0001000000000000
header: ee0100000000000001000000000000

kid: 0x0001000000000000
ctr: 0x00ffffffffffffff
header: ee01000000000000ffffffffffffff

kid: 0x0001000000000000
ctr: 0x0100000000000000
header: ef010000000000000100000000000000

kid: 0x0001000000000000
ctr: 0xffffffffffffffff
header: ef01000000000000ffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000000000000
header: e0ffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000000000001
header: e1ffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x00000000000000ff
header: e8ffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000000000100
header: e9ffffffffffffff0100

kid: 0x00ffffffffffffff
ctr: 0x000000000000ffff
header: e9ffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000000010000
header: eaffffffffffffff010000

kid: 0x00ffffffffffffff
ctr: 0x0000000000ffffff
header: eaffffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000001000000
header: ebffffffffffffff01000000

kid: 0x00ffffffffffffff
ctr: 0x00000000ffffffff
header: ebffffffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000000100000000
header: ecffffffffffffff0100000000

kid: 0x00ffffffffffffff
ctr: 0x000000ffffffffff
header: ecffffffffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0000010000000000
header: edffffffffffffff010000000000

kid: 0x00ffffffffffffff
ctr: 0x0000ffffffffffff
header: edffffffffffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0001000000000000
header: eeffffffffffffff01000000000000

kid: 0x00ffffffffffffff
ctr: 0x00ffffffffffffff
header: eeffffffffffffffffffffffffffff

kid: 0x00ffffffffffffff
ctr: 0x0100000000000000
header: efffffffffffffff0100000000000000

kid: 0x00ffffffffffffff
ctr: 0xffffffffffffffff
header: efffffffffffffffffffffffffffffff

kid: 0x0100000000000000
ctr: 0x0000000000000000
header: f00100000000000000

kid: 0x0100000000000000
ctr: 0x0000000000000001
header: f10100000000000000

kid: 0x0100000000000000
ctr: 0x00000000000000ff
header: f80100000000000000ff

kid: 0x0100000000000000
ctr: 0x0000000000000100
header: f901000000000000000100

kid: 0x0100000000000000
ctr: 0x000000000000ffff
header: f90100000000000000ffff

kid: 0x0100000000000000
ctr: 0x0000000000010000
header: fa0100000000000000010000

kid: 0x0100000000000000
ctr: 0x0000000000ffffff
header: fa0100000000000000ffffff

kid: 0x0100000000000000
ctr: 0x0000000001000000
header: fb010000000000000001000000

kid: 0x0100000000000000
ctr: 0x00000000ffffffff
header: fb0100000000000000ffffffff

kid: 0x0100000000000000
ctr: 0x0000000100000000
header: fc01000000000000000100000000

kid: 0x0100000000000000
ctr: 0x000000ffffffffff
header: fc0100000000000000ffffffffff

kid: 0x0100000000000000
ctr: 0x0000010000000000
header: fd0100000000000000010000000000

kid: 0x0100000000000000
ctr: 0x0000ffffffffffff
header: fd0100000000000000ffffffffffff

kid: 0x0100000000000000
ctr: 0x0001000000000000
header: fe010000000000000001000000000000

kid: 0x0100000000000000
ctr: 0x00ffffffffffffff
header: fe0100000000000000ffffffffffffff

kid: 0x0100000000000000
ctr: 0x0100000000000000
header: ff010000000000000001000000000000
        00

kid: 0x0100000000000000
ctr: 0xffffffffffffffff
header: ff0100000000000000ffffffffffffff
        ff

kid: 0xffffffffffffffff
ctr: 0x0000000000000000
header: f0ffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000000000000001
header: f1ffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x00000000000000ff
header: f8ffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000000000000100
header: f9ffffffffffffffff0100

kid: 0xffffffffffffffff
ctr: 0x000000000000ffff
header: f9ffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000000000010000
header: faffffffffffffffff010000

kid: 0xffffffffffffffff
ctr: 0x0000000000ffffff
header: faffffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000000001000000
header: fbffffffffffffffff01000000

kid: 0xffffffffffffffff
ctr: 0x00000000ffffffff
header: fbffffffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000000100000000
header: fcffffffffffffffff0100000000

kid: 0xffffffffffffffff
ctr: 0x000000ffffffffff
header: fcffffffffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0000010000000000
header: fdffffffffffffffff010000000000

kid: 0xffffffffffffffff
ctr: 0x0000ffffffffffff
header: fdffffffffffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0001000000000000
header: feffffffffffffffff01000000000000

kid: 0xffffffffffffffff
ctr: 0x00ffffffffffffff
header: feffffffffffffffffffffffffffffff

kid: 0xffffffffffffffff
ctr: 0x0100000000000000
header: ffffffffffffffffff01000000000000
        00

kid: 0xffffffffffffffff
ctr: 0xffffffffffffffff
header: ffffffffffffffffffffffffffffffff
        ff

D.2. AEAD encryption/decryption using AES-CTR and HMAC

For each case, we provide:¶

• cipher_suite: The index of the cipher suite in use (see Section 8.1)¶

• key: The key input to encryption/decryption¶

• enc_key: The encryption subkey produced by the derive_subkeys() algorithm¶

• auth_key: The encryption subkey produced by the derive_subkeys() algorithm¶

• nonce: The nonce input to encryption/decryption¶

• aad: The aad input to encryption/decryption¶

• pt: The plaintext¶

• ct: The ciphertext¶

An implementation should verify that the following are true, where AEAD.Encrypt and AEAD.Decrypt are as defined in Section 4.5.1:¶

• AEAD.Encrypt(key, nonce, aad, pt) == ct¶

• AEAD.Decrypt(key, nonce, aad, ct) == pt¶

The other values in the test vector are intermediate values provided to facilitate debugging of test failures.¶

cipher_suite: 0x0001
key: 000102030405060708090a0b0c0d0e0f
     101112131415161718191a1b1c1d1e1f
     202122232425262728292a2b2c2d2e2f
enc_key: 000102030405060708090a0b0c0d0e0f
auth_key: 101112131415161718191a1b1c1d1e1f
          202122232425262728292a2b2c2d2e2f
nonce: 101112131415161718191a1b
aad: 4945544620534672616d65205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 6339af04ada1d064688a442b8dc69d5b
    6bfa40f4bef0583e8081069cc60705

cipher_suite: 0x0002
key: 000102030405060708090a0b0c0d0e0f
     101112131415161718191a1b1c1d1e1f
     202122232425262728292a2b2c2d2e2f
enc_key: 000102030405060708090a0b0c0d0e0f
auth_key: 101112131415161718191a1b1c1d1e1f
          202122232425262728292a2b2c2d2e2f
nonce: 101112131415161718191a1b
aad: 4945544620534672616d65205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 6339af04ada1d064688a442b8dc69d5b
    6bfa40f4be6e93b7da076927bb

cipher_suite: 0x0003
key: 000102030405060708090a0b0c0d0e0f
     101112131415161718191a1b1c1d1e1f
     202122232425262728292a2b2c2d2e2f
enc_key: 000102030405060708090a0b0c0d0e0f
auth_key: 101112131415161718191a1b1c1d1e1f
          202122232425262728292a2b2c2d2e2f
nonce: 101112131415161718191a1b
aad: 4945544620534672616d65205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 6339af04ada1d064688a442b8dc69d5b
    6bfa40f4be09480509

D.3. SFrame encryption/decryption

For each case, we provide:¶

• cipher_suite: The index of the cipher suite in use (see Section 8.1)¶

• kid: A KID value¶

• ctr: A CTR value¶

• base_key: The base_key input to the derive_key_salt algorithm¶

• sframe_key_label: The label used to derive sframe_key in the derive_key_salt algorithm¶

• sframe_salt_label: The label used to derive sframe_salt in the derive_key_salt algorithm¶

• sframe_secret: The sframe_secret variable in the derive_key_salt algorithm¶

• sframe_key: The sframe_key value produced by the derive_key_salt algorithm¶

• sframe_salt: The sframe_salt value produced by the derive_key_salt algorithm¶

• metadata: The metadata input to the SFrame encrypt algorithm¶

• pt: The plaintext¶

• ct: The SFrame ciphertext¶

An implementation should verify that the following are true, where encrypt and decrypt are as defined in Section 4.4, using an SFrame context initialized with base_key assigned to kid:¶

• encrypt(ctr, kid, metadata, plaintext) == ct¶

• decrypt(metadata, ct) == pt¶

The other values in the test vector are intermediate values provided to facilitate debugging of test failures.¶

cipher_suite: 0x0001
kid: 0x0000000000000123
ctr: 0x0000000000004567
base_key: 000102030405060708090a0b0c0d0e0f
sframe_key_label: 534672616d6520312e30205365637265
                  74206b65792000000000000001230001
sframe_salt_label: 534672616d6520312e30205365637265
                   742073616c7420000000000000012300
                   01
sframe_secret: d926952ca8b7ec4a95941d1ada3a5203
               ceff8cceee34f574d23909eb314c40c0
sframe_key: 3f7d9a7c83ae8e1c8a11ae695ab59314
            b367e359fadac7b9c46b2bc6f81f46e1
            6b96f0811868d59402b7e870102720b3
sframe_salt: 50b29329a04dc0f184ac3168
metadata: 4945544620534672616d65205747
nonce: 50b29329a04dc0f184ac740f
aad: 99012345674945544620534672616d65
     205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 9901234567449408b6f490086165b9d6
    f62b24ae1a59a56486b4ae8ed036b889
    12e24f11

cipher_suite: 0x0002
kid: 0x0000000000000123
ctr: 0x0000000000004567
base_key: 000102030405060708090a0b0c0d0e0f
sframe_key_label: 534672616d6520312e30205365637265
                  74206b65792000000000000001230002
sframe_salt_label: 534672616d6520312e30205365637265
                   742073616c7420000000000000012300
                   02
sframe_secret: d926952ca8b7ec4a95941d1ada3a5203
               ceff8cceee34f574d23909eb314c40c0
sframe_key: e2ec5c797540310483b16bf6e7a570d2
            a27d192fe869c7ccd8584a8d9dab9154
            9fbe553f5113461ec6aa83bf3865553e
sframe_salt: e68ac8dd3d02fbcd368c5577
metadata: 4945544620534672616d65205747
nonce: e68ac8dd3d02fbcd368c1010
aad: 99012345674945544620534672616d65
     205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 99012345673f31438db4d09434e43afa
    0f8a2f00867a2be085046a9f5cb4f101
    d607

cipher_suite: 0x0003
kid: 0x0000000000000123
ctr: 0x0000000000004567
base_key: 000102030405060708090a0b0c0d0e0f
sframe_key_label: 534672616d6520312e30205365637265
                  74206b65792000000000000001230003
sframe_salt_label: 534672616d6520312e30205365637265
                   742073616c7420000000000000012300
                   03
sframe_secret: d926952ca8b7ec4a95941d1ada3a5203
               ceff8cceee34f574d23909eb314c40c0
sframe_key: 2c5703089cbb8c583475e4fc461d97d1
            8809df79b6d550f78eb6d50ffa80d892
            11d57909934f46f5405e38cd583c69fe
sframe_salt: 38c16e4f5159700c00c7f350
metadata: 4945544620534672616d65205747
nonce: 38c16e4f5159700c00c7b637
aad: 99012345674945544620534672616d65
     205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 990123456717fc8af28a5a695afcfc6c
    8df6358a17e26b2fcb3bae32e443

cipher_suite: 0x0004
kid: 0x0000000000000123
ctr: 0x0000000000004567
base_key: 000102030405060708090a0b0c0d0e0f
sframe_key_label: 534672616d6520312e30205365637265
                  74206b65792000000000000001230004
sframe_salt_label: 534672616d6520312e30205365637265
                   742073616c7420000000000000012300
                   04
sframe_secret: d926952ca8b7ec4a95941d1ada3a5203
               ceff8cceee34f574d23909eb314c40c0
sframe_key: d34f547f4ca4f9a7447006fe7fcbf768
sframe_salt: 75234edefe07819026751816
metadata: 4945544620534672616d65205747
nonce: 75234edefe07819026755d71
aad: 99012345674945544620534672616d65
     205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 9901234567b7412c2513a1b66dbb4884
    1bbaf17f598751176ad847681a69c6d0
    b091c07018ce4adb34eb

cipher_suite: 0x0005
kid: 0x0000000000000123
ctr: 0x0000000000004567
base_key: 000102030405060708090a0b0c0d0e0f
sframe_key_label: 534672616d6520312e30205365637265
                  74206b65792000000000000001230005
sframe_salt_label: 534672616d6520312e30205365637265
                   742073616c7420000000000000012300
                   05
sframe_secret: 0fc3ea6de6aac97a35f194cf9bed94d4
               b5230f1cb45a785c9fe5dce9c188938a
               b6ba005bc4c0a19181599e9d1bcf7b74
               aca48b60bf5e254e546d809313e083a3
sframe_key: d3e27b0d4a5ae9e55df01a70e6d4d28d
            969b246e2936f4b7a5d9b494da6b9633
sframe_salt: 84991c167b8cd23c93708ec7
metadata: 4945544620534672616d65205747
nonce: 84991c167b8cd23c9370cba0
aad: 99012345674945544620534672616d65
     205747
pt: 64726166742d696574662d736672616d
    652d656e63
ct: 990123456794f509d36e9beacb0e261d
    99c7d1e972f1fed787d4049f17ca2135
    3c1cc24d56ceabced279