Struct AuthUnixParams

pub struct AuthUnixParams<T>
where
    T: AsRef<[u8]>,
{ /* private fields */ }

AuthUnixParams represents the structures referred to as both AUTH_UNIX and AUTH_SYS in the various RFCs, used to identify the client as a Unix user.

The structure is implemented as specified in APPENDIX A of RFC1831.

The client-provided machine name is limited to, at most, 16 bytes. If additional group IDs (AuthUnixParams::gids()) are provided, the protocol allows for at most 16 values.

These values are trivial to forge and provide no actual security.

Implementations

impl<T> AuthUnixParams<T>

where T: AsRef<[u8]>,

pub fn new( stamp: u32, machine_name: T, uid: u32, gid: u32, gids: impl IntoIterator<Item = u32>, ) -> Self

Initialise a new AuthUnixParams instance containing the specified unix account identifiers.

Panics

Panics if the machine name exceeds 16 bytes, or gids contains more than 16 elements.

pub fn serialise_into<W: Write>(&self, buf: W) -> Result<(), Error>

Serialises this AuthUnixParams into buf, advancing the cursor position by AuthUnixParams::serialised_len() bytes.

pub fn stamp(&self) -> u32

An arbitrary ID generated by the caller.

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

The hostname of the caller’s machine.

pub fn machine_name_str(&self) -> &str

The hostname of the caller’s machine as a reference to a UTF8 string.

# Panics

If the machine name cannot be expressed as a valid UTF8 string, this method panics.

pub fn uid(&self) -> u32

The caller’s Unix user ID.

pub fn gid(&self) -> u32

The caller’s primary Unix group ID.

pub fn gids(&self) -> Option<&[u32]>

Returns a copy of the gids array, a set of Unix group IDs the caller is a member of.

pub fn serialised_len(&self) -> u32

Returns the on-wire length of this message once serialised, including the message header.

Trait Implementations

impl<T> Clone for AuthUnixParams<T>

where T: AsRef<[u8]> + Clone,

fn clone(&self) -> AuthUnixParams<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for AuthUnixParams<T>

where T: AsRef<[u8]> + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for AuthUnixParams<T>

where T: AsRef<[u8]> + PartialEq,

fn eq(&self, other: &AuthUnixParams<T>) -> 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 TryFrom<Bytes> for AuthUnixParams<Bytes>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> StructuralPartialEq for AuthUnixParams<T>

where T: AsRef<[u8]>,