Enum Scope

#[non_exhaustive]
#[repr(u64)]
pub enum Scope {
    AbstractUnixSocket = 1,
    Signal = 2,
}

Scope right.

Each variant of Scope is a scope flag. A set of scopes can be created with BitFlags<Scope>.

Example

use landlock::{ABI, Access, Scope, BitFlags, make_bitflags};

let signal = Scope::Signal;

let signal_set: BitFlags<Scope> = signal.into();

let signal_uds = make_bitflags!(Scope::{Signal | AbstractUnixSocket});

let scope_v6 = Scope::from_all(ABI::V6);

assert_eq!(signal_uds, scope_v6);

Warning

To avoid unknown restrictions don’t use BitFlags::<Scope>::all() nor BitFlags::ALL, but use a version you tested and vetted instead, for instance Scope::from_all(ABI::V6). Direct use of the BitFlags API is deprecated. See ABI for the rationale and help to test it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AbstractUnixSocket = 1

Restrict from connecting to abstract UNIX sockets created outside the sandbox.

Signal = 2

Restrict from sending signals to processes outside the sandbox.

Trait Implementations

impl Access for Scope

Warning

If ABI <= ABI::V5, Scope::from_all() returns an empty BitFlags<AccessScope>, which makes Ruleset::handle_access(AccessScope::from_all(ABI::V5)) return an error.

fn from_all(abi: ABI) -> BitFlags<Self>

Gets the access rights defined by a specific ABI.

impl BitAnd for Scope

type Output = BitFlags<Scope>

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self::Output

Performs the & operation.

impl BitFlag for Scope

fn empty() -> BitFlags<Self>

Create a BitFlags with no flags set (in other words, with a value of 0).

fn all() -> BitFlags<Self>

Create a BitFlags with all flags set.

fn from_bits(bits: Self::Numeric) -> Result<BitFlags<Self>, FromBitsError<Self>>

Create a BitFlags if the raw value provided does not contain any illegal flags.

fn from_bits_truncate(bits: Self::Numeric) -> BitFlags<Self>

Create a BitFlags from an underlying bitwise value. If any invalid bits are set, ignore them.

unsafe fn from_bits_unchecked(bits: Self::Numeric) -> BitFlags<Self>

Create a BitFlags unsafely, without checking if the bits form a valid bit pattern for the type.

impl BitOr for Scope

type Output = BitFlags<Scope>

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl BitXor for Scope

type Output = BitFlags<Scope>

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self::Output

Performs the ^ operation.

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Not for Scope

type Output = BitFlags<Scope>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Scope

fn eq(&self, other: &Scope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RawBitFlags for Scope

const EMPTY: Self::Numeric = {transmute(0x0000000000000000): <scope::Scope as enumflags2::_internal::RawBitFlags>::Numeric}

A value with no bits set.

const DEFAULT: Self::Numeric = {transmute(0x0000000000000000): <scope::Scope as enumflags2::_internal::RawBitFlags>::Numeric}

The value used by the Default implementation. Equivalent to EMPTY, unless customized.

const ALL_BITS: Self::Numeric = {transmute(0x0000000000000003): <scope::Scope as enumflags2::_internal::RawBitFlags>::Numeric}

A value with all flag bits set.

const BITFLAGS_TYPE_NAME: &'static str = "BitFlags<Scope>"

The name of the type for debug formatting purposes.

type Numeric = u64

The underlying integer type.

fn bits(self) -> Self::Numeric

Return the bits as a number type.

impl Copy for Scope

impl Eq for Scope

impl StructuralPartialEq for Scope