Struct etherparse::IpAuthHeader

pub struct IpAuthHeader {
    pub next_header: IpNumber,
    pub spi: u32,
    pub sequence_number: u32,
    /* private fields */
}

IP Authentication Header (rfc4302)

Fields

next_header: IpNumber

IP protocol number specifying the next header or transport layer protocol.

See IpNumber or ip_number for a definition of the known values.

spi: u32

Security Parameters Index

sequence_number: u32

This unsigned 32-bit field contains a counter value that increases by one for each packet sent.

Implementations

impl<'a> IpAuthHeader

pub const MIN_LEN: usize = 12usize

Minimum length of an IP authentication header in bytes/octets.

pub const MAX_LEN: usize = 1_028usize

Maximum length of an IP authentication header in bytes/octets.

This number is calculated by taking the maximum value that the “payload length” field supports (0xff) adding 2 and multiplying the sum by 4 as the “payload length” specifies how many 4 bytes words are present in the header.

pub const MAX_ICV_LEN: usize = 1_016usize

The maximum amount of bytes/octets that can be stored in the ICV part of an IP authentication header.

pub fn new( next_header: IpNumber, spi: u32, sequence_number: u32, raw_icv: &'a [u8], ) -> Result<IpAuthHeader, IcvLenError>

Create a new authentication header with the given parameters.

Note: The length of the raw_icv slice must be a multiple of 4 and the maximum allowed length is 1016 bytes (IpAuthHeader::MAX_ICV_LEN). If the slice length does not fulfill these requirements the value is not copied and an crate::err::ip_auth::IcvLenError is returned. If successful an Ok(()) is returned.

pub fn from_slice( slice: &'a [u8], ) -> Result<(IpAuthHeader, &'a [u8]), HeaderSliceError>

Read an authentication header from a slice and return the header & unused parts of the slice.

pub fn read<T: Read + Sized>( reader: &mut T, ) -> Result<IpAuthHeader, HeaderReadError>

Available on crate feature std only.

Read an authentication header from the current reader position.

pub fn read_limited<T: Read + Sized>( reader: &mut LimitedReader<T>, ) -> Result<IpAuthHeader, HeaderLimitedReadError>

Available on crate feature std only.

Read an authentication header from the current reader position with a limited reader.

pub fn raw_icv(&self) -> &[u8]

Returns a slice the raw icv value.

pub fn set_raw_icv(&mut self, raw_icv: &[u8]) -> Result<(), IcvLenError>

Sets the icv value to the given raw value. The length of the slice must be a multiple of 4 and the maximum allowed length is 1016 bytes (IpAuthHeader::MAX_ICV_LEN). If the slice length does not fulfill these requirements the value is not copied and an crate::err::ip_auth::IcvLenError is returned. If successful an Ok(()) is returned.

pub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), Error>

Available on crate feature std only.

Writes the given authentication header to the current position.

pub fn header_len(&self) -> usize

Length of the header in bytes.

pub fn to_bytes(&self) -> ArrayVec<u8, { IpAuthHeader::MAX_LEN }>

Returns the serialized header.

Trait Implementations

impl Clone for IpAuthHeader

fn clone(&self) -> IpAuthHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpAuthHeader

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

Formats the value using the given formatter.

impl Default for IpAuthHeader

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for IpAuthHeader

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for IpAuthHeader