Struct KeyDocument 

#[non_exhaustive]
pub struct KeyDocument {
    pub keys: KeyDoc,
    pub declarations: Option<Declarations>,
}

A host’s key document (9.2) with its declarations (spec-0.4.3), checked: the keys as a KeyDoc, and the declarations the publisher made for its own functions, which licence inheritance (8.5, crate::inherit_licence) and the entitlement check (10.3, crate::check_entitlement) read. Verification (10.1) reads the keys only: a document with declarations verifies every receipt exactly as the same document without them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keys: KeyDoc

The host and its keys.

declarations: Option<Declarations>

The declarations; None when the document has none (an empty declarations is not a valid document, so Some is never empty).

Implementations

impl KeyDocument

pub fn from_json(host: &str, body: &[u8]) -> Result<KeyDocument>

Parses and checks a key document fetched from host, declarations included (9.2). Every failure is E_KEY_DOC: anything malformed in the declarations rejects the whole document, as a malformed key does.

pub fn new( keys: KeyDoc, declarations: Option<Declarations>, ) -> Result<KeyDocument>

A key document from its parts, for a publisher writing its own: declarations, when given, must be non-empty and name only functions under keys.host (E_KEY_DOC).

pub fn host(&self) -> &str

The host the document was fetched from.

Trait Implementations

impl Clone for KeyDocument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDocument

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

Formats the value using the given formatter.

impl Eq for KeyDocument

impl From<KeyDoc> for KeyDocument

fn from(keys: KeyDoc) -> KeyDocument

Converts to this type from the input type.

impl Hash for KeyDocument

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyDocument

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyDocument