Skip to main content

Lattice

Struct Lattice 

Source
pub struct Lattice { /* private fields */ }
Expand description

The active lattice policy: the closed compartment vocabulary (name↔bit) and the version. Levels and assurances are fixed by their enums (TCB), so only the open dimension — compartments — needs a registry.

Built once at startup from the schema $scope annotations + site policy (S3, #569) and treated as immutable thereafter (a change is a version bump). Bit assignments are stable within a version (S4’s compiled TE matrix is keyed to them via the shared generation).

§Canonical serialization (S1↔S4, #570)

A signed CompiledPolicy must carry the lattice so the PDP and every distributed AVC reconstruct the identical name↔bit map — otherwise CompartmentSet bits desync from genesis across processes. The wire form is deliberately minimal: just the LatticeVersion and the compartment names in bit-index order. Decoding re-interns those names in that exact order via Lattice::new, so bit assignments are derived, never trusted from the wire — a tampered reverse map cannot exist. Use Lattice::to_bytes / Lattice::from_bytes for the deterministic (CBOR) byte form, or the Serialize/Deserialize impls to embed in a larger signed structure.

Implementations§

Source§

impl Lattice

Source

pub fn new( version: LatticeVersion, known_compartments: impl IntoIterator<Item = Compartment>, ) -> Lattice

Construct a lattice policy from a compartment vocabulary, assigning each name a stable bit index in iteration order (0, 1, 2, …). Duplicate names collapse to the first index. Names beyond MAX_COMPARTMENTS are rejected by truncation (they simply never get a bit — fail-closed).

Source

pub fn version(&self) -> LatticeVersion

Source

pub fn compartment_count(&self) -> u32

Number of compartments in the vocabulary.

Source

pub fn compartment_names(&self) -> &[Compartment]

The compartment vocabulary in canonical construction (bit-index) order: compartment_names()[i] is the name interned at bit i. This is the order Lattice::new assigned and the order the wire form preserves — S4’s PDP can iterate it to align its TE matrix columns with the exact bits a SecurityLabel carries.

Source

pub fn to_bytes(&self) -> Vec<u8> ⓘ

Canonical, deterministic byte form (CBOR) — the same codec the COSE signing path uses — so a signed CompiledPolicy can carry the lattice verbatim. Round-trips through Lattice::from_bytes preserving every name↔bit assignment exactly. Serialization of an in-memory lattice is infallible.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Lattice, LatticeCodecError>

Reconstruct a lattice from its canonical byte form. Fails closed on a malformed encoding or a vocabulary TryFrom would have to alter (duplicate names / over-width) — never silently yields a different lattice than the issuer signed.

Source

pub fn bit_of(&self, c: &Compartment) -> Option<u32>

The bit index assigned to a compartment name, if known.

Source

pub fn name_of(&self, bit: u32) -> Option<&Compartment>

The compartment name for a bit index, if registered.

Source

pub fn knows(&self, c: &Compartment) -> bool

Is c a recognized compartment under this policy?

Source

pub fn intern<'a>( &self, names: impl IntoIterator<Item = &'a Compartment>, ) -> Result<CompartmentSet, LabelError>

Intern a set of compartment names into a CompartmentSet bitset.

This is the genesis/enrollment seam that turns the human-facing vocabulary into the packed representation a SecurityLabel carries. An unknown name is an error (fail-closed) — it never silently becomes “no compartment”.

Source

pub fn label( &self, level: Level, assurance: Assurance, names: impl IntoIterator<Item = Compartment>, ) -> Result<SecurityLabel, LabelError>

Build a SecurityLabel from names, interning compartments through this policy. The ergonomic genesis constructor: (level, assurance, names) → label. Fails closed on any unknown compartment name.

Source

pub fn validate(&self, label: &SecurityLabel) -> Result<(), LabelError>

Validate that a label is well-formed under this policy: every compartment bit it carries maps to a registered name. Use at genesis / enrollment / seal time before a label is allowed to exist. Does NOT touch dominance.

Source

pub fn top(&self) -> SecurityLabel

The lattice top ⊤ under this policy = max level, max assurance, all known compartments. The only clearance that dominates every well-formed label. (Useful for genesis-labeling the policy authority itself, and for tests.)

Source

pub fn bottom(&self) -> SecurityLabel

The lattice bottom ⊥ = (Public, Unverified, {}). Same as SecurityLabel::bottom; provided here for symmetry with top.

Source

pub fn can_access( &self, subject: &SecurityLabel, object: &SecurityLabel, ) -> bool

Dominance, re-exposed at the policy object for callers that hold a Lattice. Identical to SecurityLabel::can_access — the policy does NOT change the order; this is purely an ergonomic forwarder. Debug builds assert both labels are well-formed (a mis-labeled object reaching the monitor is a genesis bug).

Source

pub fn join(&self, a: &SecurityLabel, b: &SecurityLabel) -> SecurityLabel

IFC join, re-exposed at the policy object. Identical algebra to SecurityLabel::join; the result is always well-formed if both inputs are (union of known compartments is known).

Trait Implementations§

Source§

impl Clone for Lattice

Source§

fn clone(&self) -> Lattice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Lattice

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Lattice

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Lattice, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Lattice

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<LatticeWire> for Lattice

Source§

fn try_from( w: LatticeWire, ) -> Result<Lattice, <Lattice as TryFrom<LatticeWire>>::Error>

Reconstruct by interning in wire order. Rejects (fail-closed) a vocabulary that Lattice::new would have silently altered — duplicate names or an over-width list — since either would desync bits from the issuer rather than reproduce them.

Source§

type Error = LatticeDecodeError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> JaggedSlice<T> for T

§

type Index = Index2

§

fn push_into(self, array: &mut Jagged<T>)

§

fn insert_into(self, index: <T as JaggedSlice<T>>::Index, array: &mut Jagged<T>)

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<E> ResultError for E
where E: Send + Debug + Sync,

§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,

§

impl<T> RpcMessage for T
where T: Debug + Serialize + DeserializeOwned + Send + Sync + Unpin + 'static,

§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

Source§

impl<T> TerminalState for T
where T: Clone + Send + Sync,