Struct redox_users::AllUsers

pub struct AllUsers { /* fields omitted */ }

AllUsers provides (borrowed) access to all the users on the system. Note that this struct implements All for a bunch of convenient access functions.

Notes

Note that everything in this section also applies to AllGroups

• If you mutate anything owned by an AllUsers, you must call the save method in order for those changes to be applied to the system.
• The API here is kept small on purpose in order to reduce the surface area for security exploitation. Most mutating actions can be accomplished via the get_mut_by_id and get_mut_by_name functions.

Shadowfile handling

This implementation of redox-users uses a shadowfile implemented primarily by this struct. AllUsers respects the auth_enabled status of the Config that is was passed. If auth is enabled, it populates the hash fields of each user struct that it parses from /etc/passwd with info from /et/shadow. If a caller attempts to perform an action that requires this info with an AllUsers config that does not have auth enabled, the User handling action will panic.

Implementations

impl AllUsers

pub fn new(config: Config) -> Result<AllUsers>

See Shadowfile Handling for configuration information regarding this constructor.

pub fn add_user(
    &mut self,
    login: &str,
    uid: usize,
    gid: usize,
    name: &str,
    home: &str,
    shell: &str
) -> Result<()>

Adds a user with the specified attributes to the AllUsers instance. Note that the user's password is set unset (see Unset vs Blank Passwords) during this call.

This function is classified as a mutating operation, and users must therefore call save in order for the new user to be applied to the system.

Panics

This function will panic! if the Config passed to AllUsers::new does not have authentication enabled (see Shadowfile handling).

pub fn save(&self) -> Result<()>

Syncs the data stored in the AllUsers instance to the filesystem. To apply changes to the system from an AllUsers, you MUST call this function!

Trait Implementations

impl All for AllUsers

fn iter(&self) -> Iter<'_, Self::Gruser>

Get an iterator borrowing all User's or Group's on the system.

fn iter_mut(&mut self) -> IterMut<'_, Self::Gruser>

Get an iterator mutably borrowing all User's or Group's on the system.

fn get_by_name(&self, name: impl AsRef<str>) -> Option<&Self::Gruser>

Borrow the User or Group with a given name.

fn get_mut_by_name(
    &mut self,
    name: impl AsRef<str>
) -> Option<&mut Self::Gruser>

Mutable version of get_by_name.

fn get_by_id(&self, id: usize) -> Option<&Self::Gruser>

Borrow the User or Group with the given ID.

fn get_mut_by_id(&mut self, id: usize) -> Option<&mut Self::Gruser>

Mutable version of get_by_id.

fn get_unique_id(&self) -> Option<usize>

Provides an unused id based on the min and max values in the Config passed to the All's constructor.

fn remove_by_name(&mut self, name: impl AsRef<str>)

Remove a User or Group from this All given it's name. This won't provide an indication of whether the user was removed or not, but is guaranteed to work if a user with the specified name exists.

fn remove_by_id(&mut self, id: usize)

Id version of remove_by_name.

impl Debug for AllUsers

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

Formats the value using the given formatter.