Struct KeyConfig 

pub struct KeyConfig { /* private fields */ }

The key configuration of a server. This can be used by both client and server. An important invariant of this structure is that it does not include any combination of KEM, KDF, and AEAD that is not supported.

Implementations

impl KeyConfig

pub fn new( key_id: u8, kem: Kem, symmetric: Vec<SymmetricSuite>, ) -> Result<Self, Error>

Construct a configuration for the server side.

Panics

If the configurations don’t include a supported configuration.

pub fn derive( key_id: u8, kem: Kem, symmetric: Vec<SymmetricSuite>, ikm: &[u8], ) -> Result<Self, Error>

Derive a configuration for the server side from input keying material, using the DeriveKeyPair functionality of the HPKE KEM defined here: https://www.ietf.org/archive/id/draft-irtf-cfrg-hpke-12.html#section-4

Panics

If the configurations don’t include a supported configuration.

pub fn encode_list(list: &[impl AsRef<Self>]) -> Result<Vec<u8>, Error>

Encode a list of key configurations.

This produces the key configuration format that is used for the “application/ohttp-keys” media type. Each item in the list is written as per encode().

Panics

Not as a result of this function.

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode into a wire format. This shares a format with the core of ECH:

opaque HpkePublicKey[Npk];
uint16 HpkeKemId;  // Defined in I-D.irtf-cfrg-hpke
uint16 HpkeKdfId;  // Defined in I-D.irtf-cfrg-hpke
uint16 HpkeAeadId; // Defined in I-D.irtf-cfrg-hpke

struct {
  HpkeKdfId kdf_id;
  HpkeAeadId aead_id;
} ECHCipherSuite;

struct {
  uint8 key_id;
  HpkeKemId kem_id;
  HpkePublicKey public_key;
  ECHCipherSuite cipher_suites<4..2^16-4>;
} ECHKeyConfig;

Panics

Not as a result of this function.

pub fn decode(encoded_config: &[u8]) -> Result<Self, Error>

Construct a configuration from the encoded server configuration. The format of encoded_config is the output of Self::encode.

pub fn decode_list(encoded_list: &[u8]) -> Result<Vec<Self>, Error>

Decode a list of key configurations. This only returns the valid and supported key configurations; unsupported configurations are dropped silently.

pub fn select(&self, sym: SymmetricSuite) -> Result<HpkeConfig, Error>

Select creates a new configuration that contains the identified symmetric suite.

Errors

If the given suite is not supported by this configuration.

Trait Implementations

impl AsRef<KeyConfig> for KeyConfig

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyConfig

fn clone(&self) -> KeyConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.