Struct onc_rpc::auth::AuthUnixParams

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

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

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

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: Option<SmallVec<[u32; 16]>>
) -> Self

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

pub fn serialise_into(&self, buf: &mut Cursor<Vec<u8>>) -> Result<(), Error>

Serialises this AuthUnixParams into buf, advancing the cursor position by 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.

Callers should probably make use of machine_name in general.

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<&SmallVec<[u32; 16]>>

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: Debug> Debug for AuthUnixParams<T> where
    T: AsRef<[u8]>, 

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<AuthUnixParams<T>> for AuthUnixParams<T> where
    T: AsRef<[u8]>, 

pub fn eq(&self, other: &AuthUnixParams<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &AuthUnixParams<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for AuthUnixParams<T> where
    T: AsRef<[u8]>, 

impl TryFrom<Bytes> for AuthUnixParams<Bytes>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.