Struct linux_keyutils::KeyPermissions

pub struct KeyPermissions(_);

Construct key permissions for use with Key::set_perms or returned by Metadata::get_perms.

Usage:

use linux_keyutils::{Permission, KeyPermissions};

let mut perms = KeyPermissions::new();
perms.set_user_perms(Permission::ALL);
perms.set_group_perms(Permission::VIEW);

Implementations

impl KeyPermissions

pub fn new() -> Self

Create a new KeyPermissions object, defaults to empty permissions

Examples found in repository

src/permissions.rs (line 58)

    fn default() -> Self {
        Self::new()
    }

pub fn from_u32(raw: u32) -> Self

Construct the permissions manually

Examples found in repository

src/metadata.rs (line 67)

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // Begin parsing
        let mut iter = s.split(';');

        // Parse type into KeyType
        let ktype: KeyType = iter
            .next()
            .and_then(|v| v.try_into().ok())
            .ok_or(KeyError::InvalidDescription)?;

        // Parse the UID
        let uid = iter
            .next()
            .and_then(|v| v.parse().ok())
            .ok_or(KeyError::InvalidDescription)?;

        // Parse the GID
        let gid = iter
            .next()
            .and_then(|v| v.parse().ok())
            .ok_or(KeyError::InvalidDescription)?;

        // Parse the permissions
        let perms: u32 = iter
            .next()
            .and_then(|v| u32::from_str_radix(v, 16).ok())
            .ok_or(KeyError::InvalidDescription)?;

        // Copy the actual description
        let description = iter.next().ok_or(KeyError::InvalidDescription)?.to_string();

        // Create the description
        Ok(Self {
            ktype,
            uid,
            gid,
            perm: KeyPermissions::from_u32(perms),
            description,
        })
    }

pub fn bits(&self) -> u32

Obtain the u32 bits for this set

Examples found in repository

src/key.rs (line 129)

    pub fn set_perms(&self, perm: KeyPermissions) -> Result<(), KeyError> {
        _ = ffi::keyctl!(
            KeyCtlOperation::SetPerm,
            self.0.as_raw_id() as libc::c_ulong,
            perm.bits() as _
        )?;
        Ok(())
    }

pub fn set_posessor_perms(&mut self, perm: Permission)

Set the permissions available to the key’s possessor

Examples found in repository

src/permissions.rs (line 111)

    pub fn posessor(mut self, perm: Permission) -> Self {
        self.0.set_posessor_perms(perm);
        self
    }

pub fn set_user_perms(&mut self, perm: Permission)

Set the permissions available to the key’s owning user (UID)

Examples found in repository

src/permissions.rs (line 117)

    pub fn user(mut self, perm: Permission) -> Self {
        self.0.set_user_perms(perm);
        self
    }

pub fn set_group_perms(&mut self, perm: Permission)

Set the permissions available to the key’s owning group (GID)

Examples found in repository

src/permissions.rs (line 123)

    pub fn group(mut self, perm: Permission) -> Self {
        self.0.set_group_perms(perm);
        self
    }

pub fn set_world_perms(&mut self, perm: Permission)

Set the permissions available to any 3rd party

Examples found in repository

src/permissions.rs (line 129)

    pub fn world(mut self, perm: Permission) -> Self {
        self.0.set_world_perms(perm);
        self
    }

Trait Implementations

impl Clone for KeyPermissions

fn clone(&self) -> KeyPermissions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPermissions

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

Formats the value using the given formatter.

impl Default for KeyPermissions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for KeyPermissions