SignedPacket

Struct SignedPacket 

Source
pub struct SignedPacket { /* private fields */ }
Expand description

A signed DNS packet in the pkarr format.

Wire format: <32 bytes pubkey><64 bytes signature><8 bytes BE timestamp><DNS wire format>

The DNS packet must be at most 1000 bytes. Total max size is 1104 bytes.

Implementations§

Source§

impl SignedPacket

Source

pub const MAX_BYTES: usize = 1_104usize

Maximum total byte size of a signed packet.

Source

pub fn from_txt_strings( secret_key: &SecretKey, name: &str, values: impl IntoIterator<Item = impl AsRef<str>>, ttl: u32, ) -> Result<SignedPacket, SignedPacketBuildError>

Create a signed packet containing TXT records under a single name.

This is the common case: multiple TXT values under the same DNS name (e.g. "_iroh").

Source

pub fn from_bytes(bytes: &[u8]) -> Result<SignedPacket, SignedPacketVerifyError>

Parse and verify a signed packet from its wire representation.

Source

pub fn from_relay_payload( public_key: &PublicKey, payload: &[u8], ) -> Result<SignedPacket, SignedPacketVerifyError>

Create from a public key and relay payload (signature + timestamp + dns).

Source

pub fn from_bytes_unchecked( bytes: &[u8], ) -> Result<SignedPacket, SignedPacketVerifyError>

Parse a signed packet without verifying the signature.

Still validates minimum length and DNS parsing.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

Return the full serialized bytes.

Source

pub fn to_relay_payload(&self) -> Vec<u8> ⓘ

Return the relay payload (everything after the public key).

Source

pub fn public_key(&self) -> PublicKey

Return the public key.

Source

pub fn signature(&self) -> Signature

Return the signature.

Source

pub fn timestamp(&self) -> Timestamp

Return the timestamp.

Source

pub fn encoded_packet(&self) -> &[u8] ⓘ

Return the encoded DNS packet bytes.

Source

pub fn txt_records(&self, name: &str) -> Vec<String>

Iterate over TXT records under a specific DNS name.

The name is normalized relative to the signer’s z-base-32 public key. Returns the TXT string values.

Source

pub fn all_txt_records(&self) -> Vec<(String, String)>

Iterate over all TXT records, yielding (name_relative_to_origin, value) pairs.

The name is the part before the z-base-32 public key zone.

Source

pub fn from_parts_unchecked( public_key: &[u8], signature: &[u8], timestamp: Timestamp, encoded_packet: &[u8], ) -> Result<Self, SignedPacketVerifyError>

Reconstruct a signed packet from its raw parts without verifying the signature.

This is useful for reconstructing a packet from storage or DHT mutable items where the components are stored separately.

Source

pub fn more_recent_than(&self, other: &SignedPacket) -> bool

Return whether this packet is more recent than another.

Trait Implementations§

Source§

impl Clone for SignedPacket

Source§

fn clone(&self) -> SignedPacket

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SignedPacket

Source§

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

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

impl Display for SignedPacket

Source§

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

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

impl PartialEq for SignedPacket

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for SignedPacket

Source§

impl StructuralPartialEq for SignedPacket

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
§

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

§

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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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