Enum UnixControlData 

pub enum UnixControlData {
    Rights(Vec<FileHandle>),
    Credentials(ucred),
    Security(FsString),
}

A control message for a Unix domain socket.

Variants

Rights(Vec<FileHandle>)

“Send or receive a set of open file descriptors from another process. The data portion contains an integer array of the file descriptors.”

See https://man7.org/linux/man-pages/man7/unix.7.html.

Credentials(ucred)

“Send or receive UNIX credentials. This can be used for authentication. The credentials are passed as a struct ucred ancillary message.”

See https://man7.org/linux/man-pages/man7/unix.7.html.

Security(FsString)

“Receive the SELinux security context (the security label) of the peer socket. The received ancillary data is a null-terminated string containing the security context.”

See https://man7.org/linux/man-pages/man7/unix.7.html.

Implementations

impl UnixControlData

pub fn new( current_task: &CurrentTask, message: ControlMsg, ) -> Result<Self, Errno>

Creates a new UnixControlData instance for the provided message_header. This includes reading the associated data from the task (e.g., files from file descriptors).

pub fn unknown_creds() -> Self

Returns a UnixControlData message that can be used when passcred is enabled but no credentials were sent.

pub fn into_controlmsg<L>( self, locked: &mut Locked<L>, current_task: &CurrentTask, flags: SocketMessageFlags, ) -> Result<Option<ControlMsg>, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Constructs a ControlMsg for this control data, with a destination of task.

The provided task is used to create any required file descriptors, etc.

pub fn total_size(&self, current_task: &CurrentTask) -> usize

Returns the total size of all data in this message.

pub fn minimum_size(&self) -> usize

Returns the minimum size that can fit some amount of this message’s data. For example, the minimum size for an SCM_RIGHTS message is the size of a single FD. If the buffer is large enough for the minimum size but too small for the total size, the message is truncated and the MSG_CTRUNC flag is set.

Trait Implementations

impl Clone for UnixControlData

fn clone(&self) -> UnixControlData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnixControlData

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

Formats the value using the given formatter.