Skip to main content

EnvelopeFormat

Enum EnvelopeFormat 

Source
pub enum EnvelopeFormat {
    Raw,
    StripeV1,
    SlackV0,
    GithubHmac,
}
Expand description

Selector for how a webhook signature header should be parsed, and the resulting HMAC signing-input shape.

Each variant maps to a real-world signing scheme used by a major developer-facing API. Adding a new variant means: extending this enum, extending parse_envelope in src/rules.rs, extending the signing_input match in WebhookSignatureMismatch::evaluate, and extending the envelope_format enum in cases.schema.json.

Variants§

§

Raw

Header value is a raw hex digest, optionally prefixed sha256=. Timestamp comes from a separate timestamp_header. Signing input: "{ts}.{body}".

§

StripeV1

Stripe-style envelope: t=<unix_ts>,v1=<sig>,v0=<sig>,.... Timestamp comes from the envelope’s t= field; timestamp_header is ignored. Signing input: "{ts}.{body}".

§

SlackV0

Slack v0 envelope: X-Slack-Signature: v0=<hex>. Timestamp comes from a separate X-Slack-Request-Timestamp header. Signing input: "v0:{ts}:{body}".

§

GithubHmac

GitHub-style HMAC: X-Hub-Signature-256: sha256=<hex>. There is no timestamp claim; webhook_timestamp_stale cannot fire. Signing input: {body} (raw body, no prefix).

Trait Implementations§

Source§

impl Clone for EnvelopeFormat

Source§

fn clone(&self) -> EnvelopeFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnvelopeFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EnvelopeFormat

Source§

fn default() -> EnvelopeFormat

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EnvelopeFormat

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EnvelopeFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for EnvelopeFormat

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for EnvelopeFormat

Source§

impl Eq for EnvelopeFormat

Source§

impl StructuralPartialEq for EnvelopeFormat

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,