Struct ActEnvelope 

pub struct ActEnvelope {
    pub v: u64,
    pub alg: String,
    pub claims: ByteBuf,
    pub sig: ByteBuf,
    pub kid: Option<String>,
}

The outer envelope, as it appears on the wire.

Fields

v: u64

Format version.

alg: String

Signature algorithm identifier.

claims: ByteBuf

CBOR-encoded claims. These exact bytes are what the signature covers.

sig: ByteBuf

Raw signature over claims.

kid: Option<String>

Optional key identifier, so a verifier can select a key during rotation instead of trying every trusted key.

Implementations

impl ActEnvelope

pub fn decode(bytes: &[u8]) -> ActResult<Self>

Decodes an envelope without verifying its signature.

Useful for reading kid in order to select a verification key. The claims inside are unauthenticated until verify succeeds, and must not be used for any authorization decision.

Errors

Returns ActError::TooLarge above MAX_ACT_BYTES, ActError::EnvelopeDecode for malformed CBOR, ActError::UnsupportedVersion or ActError::UnsupportedAlgorithm for a format this build does not implement.

pub fn encode(&self) -> ActResult<Vec<u8>>

Serializes this envelope to CBOR.

Errors

Returns ActError::Encode if serialization fails.

Trait Implementations

impl Clone for ActEnvelope

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 ActEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ActEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.