relibc/header/grp/

mod.rs

//! `grp.h` implementation.
//!
//! See <https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/grp.h.html>.

use core::{
    cell::SyncUnsafeCell,
    convert::TryInto,
    mem::{self, MaybeUninit},
    num::ParseIntError,
    ops::{Deref, DerefMut},
    pin::Pin,
    ptr, slice,
};

use alloc::string::{FromUtf8Error, String};

use crate::{
    error::ResultExt,
    fs::File,
    header::{errno, fcntl, limits, string::strlen},
    io::{self, BufReader, Lines, prelude::*},
    platform::{
        self, Pal, Sys,
        types::{c_char, c_int, c_void, gid_t, size_t},
    },
};

use super::{
    errno::{EINVAL, EIO, ENOENT, ERANGE},
    string::strncmp,
};

/// cbindgen:ignore
#[cfg(target_os = "linux")]
const SEPARATOR: char = ':';

/// cbindgen:ignore
#[cfg(target_os = "redox")]
const SEPARATOR: char = ';';

/// cbindgen:ignore
const GROUP_FILE: &core::ffi::CStr = c"/etc/group";

#[derive(Clone, Copy, Debug)]
struct DestBuffer {
    ptr: *mut u8,
    len: usize,
}

// Shamelessly stolen from pwd/mod.rs
#[derive(Debug)]
enum MaybeAllocated {
    Owned(Pin<Box<[u8]>>),
    Borrowed(DestBuffer),
}
impl Deref for MaybeAllocated {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        match self {
            MaybeAllocated::Owned(boxed) => boxed,
            MaybeAllocated::Borrowed(dst) => unsafe {
                core::slice::from_raw_parts(dst.ptr, dst.len)
            },
        }
    }
}
impl DerefMut for MaybeAllocated {
    fn deref_mut(&mut self) -> &mut Self::Target {
        match self {
            MaybeAllocated::Owned(boxed) => boxed,
            MaybeAllocated::Borrowed(dst) => unsafe {
                core::slice::from_raw_parts_mut(dst.ptr, dst.len)
            },
        }
    }
}

/// cbindgen:ignore
static mut GROUP_BUF: Option<MaybeAllocated> = None;
/// cbindgen:ignore
static mut GROUP: group = group {
    gr_name: ptr::null_mut(),
    gr_passwd: ptr::null_mut(),
    gr_gid: 0,
    gr_mem: ptr::null_mut(),
};

/// cbindgen:ignore
static LINE_READER: SyncUnsafeCell<Option<Lines<BufReader<File>>>> = SyncUnsafeCell::new(None);

/// See <https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/grp.h.html>.
#[allow(non_camel_case_types)]
#[repr(C)]
#[derive(Debug)]
pub struct group {
    /// The name of the group.
    pub gr_name: *mut c_char,
    /// Non-POSIX, see <https://www.man7.org/linux/man-pages/man3/getgrnam.3.html>.
    ///
    /// Group password.
    pub gr_passwd: *mut c_char,
    /// Numerical group ID.
    pub gr_gid: gid_t,
    /// Pointer to a null-terminated array of character pointers to member
    /// names.
    pub gr_mem: *mut *mut c_char,
}

#[derive(Debug)]
enum Error {
    EOF,
    Syntax,
    BufTooSmall,
    Misc(io::Error),
    FromUtf8(FromUtf8Error),
    ParseInt(ParseIntError),
    Other,
}

#[derive(Debug)]
struct OwnedGrp {
    buffer: MaybeAllocated,
    reference: group,
}

impl OwnedGrp {
    fn into_global(self) -> *mut group {
        unsafe {
            GROUP_BUF = Some(self.buffer);
            GROUP = self.reference;
            &raw mut GROUP
        }
    }
}

fn split(buf: &mut [u8]) -> Option<group> {
    let gr_gid = match buf[0..mem::size_of::<gid_t>()].try_into() {
        Ok(buf) => gid_t::from_ne_bytes(buf),
        Err(err) => return None,
    };

    // Get address of buffer for fixing up gr_mem
    let buf_addr = buf.as_ptr() as usize;

    // We moved the gid to the beginning of the byte buffer so we can do this.
    let mut parts = buf[mem::size_of::<gid_t>()..].split_mut(|&c| c == b'\0');
    let gr_name = parts.next()?.as_mut_ptr().cast::<c_char>();
    let gr_passwd = parts.next()?.as_mut_ptr().cast::<c_char>();
    let gr_mem = parts.next()?.as_mut_ptr().cast::<usize>();

    // Adjust gr_mem address by buffer base address
    // TODO: max group members length?
    for i in 0..4096 {
        unsafe {
            if *gr_mem.add(i) == 0 {
                // End of gr_mem pointer array
                break;
            }
            *gr_mem.add(i) += buf_addr;
        }
    }

    Some(group {
        gr_name,
        gr_passwd,
        gr_gid,
        gr_mem: gr_mem.cast::<*mut c_char>(),
    })
}

fn parse_grp(line: String, destbuf: Option<DestBuffer>) -> Result<OwnedGrp, Error> {
    let buffer = line.clone().into_bytes();

    let mut buffer = buffer
        .into_iter()
        .map(|i| if i == SEPARATOR as u8 { b'\0' } else { i })
        .chain(*b"\0")
        .collect::<Vec<_>>();
    let mut buffer = buffer.split_mut(|i| *i == b'\0');

    let strings = {
        let mut vec: Vec<u8> = Vec::new();

        let gr_name = buffer.next().ok_or(Error::EOF)?.to_vec();
        let gr_passwd = buffer.next().ok_or(Error::EOF)?.to_vec();
        let gr_gid = String::from_utf8(buffer.next().ok_or(Error::EOF)?.to_vec())
            .map_err(Error::FromUtf8)?
            .parse::<gid_t>()
            .map_err(Error::ParseInt)?;

        // Place the gid at the beginning of the byte buffer to make getting it back out again later, much faster.

        vec.extend(gr_gid.to_ne_bytes());
        vec.extend(gr_name);
        vec.push(0);
        vec.extend(gr_passwd);
        vec.push(0);

        let members = buffer.next().ok_or(Error::EOF)?;

        // Get the offset of the members array
        let member_array_start = vec.len();

        // Push enough null pointers to fit all members
        for _member in members
            .split(|b| *b == b',')
            .filter(|member| !member.is_empty())
        {
            vec.extend(0usize.to_ne_bytes());
        }
        let member_array_end = vec.len();
        // Push a null pointer to terminate the members array
        vec.extend(0usize.to_ne_bytes());

        // Fill in member names
        for (i, member) in members
            .split(|b| *b == b',')
            .filter(|member| !member.is_empty())
            .enumerate()
        {
            let cur_offset = vec.len();

            // This must be recomputed each time, because `vec` is undergoing extensions and so
            // its backing memory might be reallocated and moved and its old memory deallocated.
            let member_array = &mut vec[member_array_start..member_array_end];
            let member_ptr = {
                const SIZEOF_PTR: usize = mem::size_of::<*mut c_void>();
                let start = i * SIZEOF_PTR;
                let end = start + SIZEOF_PTR;
                &mut member_array[start..end]
            };

            // Store offset to start of member, MUST BE ADJUSTED LATER BASED ON THE ADDRESS OF THE BUFFER
            member_ptr.copy_from_slice(&cur_offset.to_ne_bytes());

            vec.extend(member);
            vec.push(0);
        }

        vec
    };

    let mut buffer = match destbuf {
        None => MaybeAllocated::Owned(Box::into_pin(strings.into_boxed_slice())),
        Some(buf) => {
            let mut buf = MaybeAllocated::Borrowed(buf);

            if buf.len() < strings.len() {
                platform::ERRNO.set(errno::ERANGE);
                return Err(Error::BufTooSmall);
            }

            buf[..strings.len()].copy_from_slice(&strings);
            buf
        }
    };
    let reference = split(&mut buffer).ok_or(Error::Other)?;

    Ok(OwnedGrp { buffer, reference })
}

/// MT-Unsafe race:grgid locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getgrgid.html>.
///
/// Searches the group database for an entry with a matching `gid`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrgid(gid: gid_t) -> *mut group {
    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return ptr::null_mut();
    };

    for line in BufReader::new(db).lines() {
        let Ok(line) = line else {
            return ptr::null_mut();
        };
        let Ok(grp) = parse_grp(line, None) else {
            return ptr::null_mut();
        };

        if grp.reference.gr_gid == gid {
            return grp.into_global();
        }
    }

    ptr::null_mut()
}

/// MT-Unsafe race:grnam locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getgrnam.html>.
///
/// Searches the group database for an entry with a matching `name`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrnam(name: *const c_char) -> *mut group {
    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return ptr::null_mut();
    };

    for line in BufReader::new(db).lines() {
        let Ok(line) = line else {
            return ptr::null_mut();
        };

        let Ok(grp) = parse_grp(line, None) else {
            return ptr::null_mut();
        };

        // Attempt to prevent BO vulnerabilities
        if unsafe {
            strncmp(
                grp.reference.gr_name,
                name,
                strlen(grp.reference.gr_name).min(strlen(name)),
            ) == 0
        } {
            return grp.into_global();
        }
    }

    ptr::null_mut()
}

/// MT-Safe locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getgrgid_r.html>.
///
/// Updates the `group` structure pointed to by `result_buf` and store a
/// pointer to that structure at the location pointed to by `result`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrgid_r(
    gid: gid_t,
    result_buf: *mut group,
    buffer: *mut c_char,
    buflen: size_t,
    result: *mut *mut group,
) -> c_int {
    // In case of error or the requested entry is not found.
    unsafe {
        *result = ptr::null_mut();
    }

    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return ENOENT;
    };

    for line in BufReader::new(db).lines() {
        let Ok(line) = line else { return EINVAL };
        let grp = match parse_grp(
            line,
            Some(DestBuffer {
                ptr: buffer.cast::<u8>(),
                len: buflen,
            }),
        ) {
            Ok(grp) => grp,
            Err(err) => {
                return match err {
                    Error::BufTooSmall => ERANGE,
                    Error::EOF
                    | Error::Syntax
                    | Error::FromUtf8(_)
                    | Error::ParseInt(_)
                    | Error::Other => EINVAL,
                    Error::Misc(io_err) => match io_err.kind() {
                        io::ErrorKind::InvalidData | io::ErrorKind::UnexpectedEof => EINVAL,
                        io::ErrorKind::NotFound => ENOENT,
                        _ => EIO,
                    },
                };
            }
        };

        if grp.reference.gr_gid == gid {
            unsafe {
                *result_buf = grp.reference;
                *result = result_buf;
            }

            return 0;
        }
    }

    // The requested entry was not found.
    0
}

/// MT-Safe locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getgrnam_r.html>.
///
/// Updates the `group` structure pointed to by `result_buf` and store a
/// pointer to that structure at the location pointed to by `result`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrnam_r(
    name: *const c_char,
    result_buf: *mut group,
    buffer: *mut c_char,
    buflen: size_t,
    result: *mut *mut group,
) -> c_int {
    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return ENOENT;
    };

    for line in BufReader::new(db).lines() {
        let Ok(line) = line else { return EINVAL };
        let Ok(grp) = parse_grp(
            line,
            Some(DestBuffer {
                ptr: buffer.cast::<u8>(),
                len: buflen,
            }),
        ) else {
            return EINVAL;
        };

        if unsafe {
            strncmp(
                grp.reference.gr_name,
                name,
                strlen(grp.reference.gr_name).min(strlen(name)),
            ) == 0
        } {
            unsafe {
                *result_buf = grp.reference;
                *result = result_buf;
            }

            return 0;
        }
    }

    ENOENT
}

/// MT-Unsafe race:grent race:grentbuf locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/endgrent.html>.
///
/// Returns a pointer to a structure containing the broken-out fields of an
/// entry in the group database.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrent() -> *mut group {
    let mut line_reader = unsafe { &mut *LINE_READER.get() };

    if line_reader.is_none() {
        let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
            return ptr::null_mut();
        };
        *line_reader = Some(BufReader::new(db).lines());
    }

    if let Some(lines) = line_reader.deref_mut() {
        let Some(line) = lines.next() else {
            return ptr::null_mut();
        };
        let Ok(line) = line else {
            return ptr::null_mut();
        };

        if let Ok(grp) = parse_grp(line, None) {
            grp.into_global()
        } else {
            ptr::null_mut()
        }
    } else {
        ptr::null_mut()
    }
}

/// MT-Unsafe race:grent locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/endgrent.html>.
///
/// Closes the group database.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn endgrent() {
    unsafe {
        *LINE_READER.get() = None;
    }
}

/// MT-Unsafe race:grent locale
///
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/endgrent.html>.
///
/// Rewinds the group database so that the next `getgrent()` call returns the
/// first entry, allowing repeated searches.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn setgrent() {
    let line_reader = unsafe { &mut *LINE_READER.get() };
    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return;
    };
    *line_reader = Some(BufReader::new(db).lines());
}

// TODO should be guarded by `_DEFAULT_SOURCE`
/// MT-Safe locale
/// Non-POSIX, see <https://www.man7.org/linux/man-pages/man3/getgrouplist.3.html>.
///
/// Get a list of groups to which a user belongs.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn getgrouplist(
    user: *const c_char,
    group: gid_t,
    groups: *mut gid_t,
    ngroups: *mut c_int,
) -> c_int {
    let grps = unsafe {
        slice::from_raw_parts_mut(groups.cast::<MaybeUninit<gid_t>>(), ngroups.read() as usize)
    };

    // FIXME: This API probably expects the group database to already exist in memory, as it
    // doesn't seem to have any documented error handling.

    let Ok(user) = (unsafe { crate::c_str::CStr::from_ptr(user).to_str() }) else {
        return 0;
    };

    let Ok(db) = File::open(GROUP_FILE.into(), fcntl::O_RDONLY) else {
        return 0;
    };

    let mut groups_found: c_int = 0;

    for line in BufReader::new(db).lines() {
        let Ok(line) = line else {
            return 0;
        };

        let mut parts = line.split(SEPARATOR);

        let group_name = parts.next().unwrap_or("");
        let group_password = parts.next().unwrap_or("");
        let group_id = parts.next().unwrap_or("-1").parse::<c_int>().unwrap();
        let members = parts
            .next()
            .unwrap_or("")
            .split(",")
            .map(|i| i.trim())
            .collect::<Vec<_>>();

        if !members.contains(&user) {
            continue;
        }

        if let Some(dst) = grps.get_mut(groups_found as usize) {
            dst.write(group_id);
        }

        groups_found = match groups_found.checked_add(1) {
            Some(g) => g,
            None => break,
        };
    }

    unsafe {
        ngroups.write(groups_found);
    }

    if groups_found as usize > grps.len() {
        -1
    } else {
        groups_found
    }
}

// TODO should be guarded by `_DEFAULT_SOURCE`
/// MT-Safe locale
/// Non-POSIX, see <https://www.man7.org/linux/man-pages/man3/initgroups.3.html>.
///
/// Initialize the supplementary group access list.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn initgroups(user: *const c_char, gid: gid_t) -> c_int {
    let mut groups = [0; limits::NGROUPS_MAX];
    let mut count = groups.len() as c_int;
    if unsafe { getgrouplist(user, gid, groups.as_mut_ptr(), &raw mut count) < 0 } {
        return -1;
    }
    unsafe { setgroups(count as size_t, groups.as_ptr()) }
}

// TODO should be guarded by `_DEFAULT_SOURCE`
/// Non-POSIX, see <https://www.man7.org/linux/man-pages/man2/setgroups.2.html>.
///
/// Set a list of supplementary group IDs.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn setgroups(size: size_t, list: *const gid_t) -> c_int {
    unsafe { Sys::setgroups(size, list) }
        .map(|()| 0)
        .or_minus_one_errno()
}