Struct SignedDocument 

pub struct SignedDocument {
    pub schema_version: u32,
    pub payload_encoding: String,
    pub payload_base64: String,
    pub payload_sha256: String,
    pub signatures: Vec<DocumentSignature>,
}

The signing envelope shared by every control document.

Fields

schema_version: u32

Format version of the envelope.

payload_encoding: String

How the payload is encoded.

payload_base64: String

The payload, exactly as it was signed and published.

payload_sha256: String

SHA-256 of the decoded payload bytes.

signatures: Vec<DocumentSignature>

Every signature offered; the document is accepted when any one of them verifies.

Implementations

impl SignedDocument

pub fn parse(bytes: &[u8]) -> Result<Self>

Parses an envelope without verifying anything about it.

Errors

When the bytes are not a structurally valid envelope.

pub fn decode_payload(&self) -> Result<Vec<u8>>

Unwraps the envelope and checks its checksum. Does not check any signature.

Errors

When the envelope is unsupported, or the payload bytes do not hash to the value it names.

pub fn is_well_formed(&self) -> bool

Whether the envelope is well formed enough to be worth verifying.

A shape check, never a verification: it says the document deserves an attempt, not that its signature is good.

Trait Implementations

impl Clone for SignedDocument

fn clone(&self) -> SignedDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignedDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignedDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SignedDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.