Skip to main content

HttpAuthRequest

Struct HttpAuthRequest 

Source
pub struct HttpAuthRequest {
    pub url: Url,
    pub method: HttpMethod,
    pub payload_hash: Option<[u8; 32]>,
}
Expand description

Typed bundle for a kind: 27235 HTTP-auth event.

Fields§

§url: Url

Absolute request URL (the u tag).

§method: HttpMethod

HTTP method (the method tag).

§payload_hash: Option<[u8; 32]>

Optional SHA-256 over the request body (the payload tag). None matches a body-less request.

Implementations§

Source§

impl HttpAuthRequest

Source

pub const fn new(url: Url, method: HttpMethod) -> Self

Construct a body-less request bundle.

Source

pub const fn payload_hash(self, hash: [u8; 32]) -> Self

Attach a SHA-256 hash of the request body.

Source

pub fn payload(self, body: &[u8]) -> Self

Convenience: hash body with SHA-256 and attach the digest.

Use this when the caller already has the body bytes in hand.

Source

pub fn to_tags(&self) -> Vec<Tag>

Render to the tag list of a kind: 27235 event.

Source

pub fn from_event(event: &Event) -> Result<Self, HttpAuthError>

Parse a kind: 27235 event back into a typed bundle.

§Errors
Source

pub fn from_tags(tags: &Tags) -> Result<Self, HttpAuthError>

Parse from a tag list (without enforcing the wrapping kind).

§Errors

See Self::from_event.

Source

pub fn validate( &self, signed_at: Timestamp, now: Timestamp, skew_secs: u64, request_url: &Url, request_method: &HttpMethod, body: Option<&[u8]>, ) -> Result<(), HttpAuthError>

Server-side validation per NIP-98 §“Servers MUST perform the following checks”:

  1. Event kind is 27235 (already enforced when the bundle came from Self::from_event).
  2. created_at is within ±skew of now. Default skew is DEFAULT_TIMESTAMP_SKEW_SECS.
  3. The bundle’s Self::url equals request_url byte-for-byte.
  4. The bundle’s Self::method equals request_method.

When body is Some, the SHA-256 over those bytes must equal the bundle’s Self::payload_hash.

A body == None + payload_hash == Some(_) mismatch fails validation; a body == Some + payload_hash == None is allowed (spec uses “SHOULD include”, not “MUST”), but most servers will want to reject it themselves with a higher-level rule.

§Errors

One of the variants of HttpAuthError tagged with Validation*.

Trait Implementations§

Source§

impl Clone for HttpAuthRequest

Source§

fn clone(&self) -> HttpAuthRequest

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 HttpAuthRequest

Source§

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

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

impl Eq for HttpAuthRequest

Source§

impl PartialEq for HttpAuthRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HttpAuthRequest

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more