Struct IgvmCapabilityBitMap 

pub struct IgvmCapabilityBitMap(/* private fields */);

Bitmap of additional Igvm request attributes. 0 - error_code: Requesting IGVM Agent Error code 1 - retry: Retry preference 2 - skip_hw_unsealing: Skip hardware unsealing in case key release request fails 3 - use_rsa_aes_key_wrap_384: Request that the IGVM Agent ask Azure Key Vault (AKV) to wrap and release the key with the SHA-384 variant of the composite RSA+AES key-wrap scheme (PKCS#11 CKM_RSA_AES_KEY_WRAP / AKV’s RSA_AES_KEY_WRAP_384): RSA-OAEP-SHA384 (MGF1-SHA-384) wraps an AES-256 KEK that performs AES Key Wrap on the released key. The default is the same CKM_RSA_AES_KEY_WRAP scheme with the inner RSA-OAEP using SHA-1 (MGF1-SHA-1). 4 - corim_endorsement: Request that the IGVM Agent fetch the CoRIM launch endorsement for the guest and include it in the attestation flow.

Implementations

impl IgvmCapabilityBitMap

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u32) -> Self

Convert from bits.

pub const fn into_bits(self) -> u32

Convert into bits.

pub const fn error_code(&self) -> bool

Bits: 0..1

pub const fn with_error_code_checked(self, value: bool) -> Result<Self, ()>

Bits: 0..1

pub const fn with_error_code(self, value: bool) -> Self

Bits: 0..1

pub const fn set_error_code(&mut self, value: bool)

Bits: 0..1

pub const fn set_error_code_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 0..1

pub const fn retry(&self) -> bool

Bits: 1..2

pub const fn with_retry_checked(self, value: bool) -> Result<Self, ()>

Bits: 1..2

pub const fn with_retry(self, value: bool) -> Self

Bits: 1..2

pub const fn set_retry(&mut self, value: bool)

Bits: 1..2

pub const fn set_retry_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 1..2

pub const fn skip_hw_unsealing(&self) -> bool

Bits: 2..3

pub const fn with_skip_hw_unsealing_checked( self, value: bool, ) -> Result<Self, ()>

Bits: 2..3

pub const fn with_skip_hw_unsealing(self, value: bool) -> Self

Bits: 2..3

pub const fn set_skip_hw_unsealing(&mut self, value: bool)

Bits: 2..3

pub const fn set_skip_hw_unsealing_checked( &mut self, value: bool, ) -> Result<(), ()>

Bits: 2..3

pub const fn use_rsa_aes_key_wrap_384(&self) -> bool

Bits: 3..4

pub const fn with_use_rsa_aes_key_wrap_384_checked( self, value: bool, ) -> Result<Self, ()>

Bits: 3..4

pub const fn with_use_rsa_aes_key_wrap_384(self, value: bool) -> Self

Bits: 3..4

pub const fn set_use_rsa_aes_key_wrap_384(&mut self, value: bool)

Bits: 3..4

pub const fn set_use_rsa_aes_key_wrap_384_checked( &mut self, value: bool, ) -> Result<(), ()>

Bits: 3..4

pub const fn corim_endorsement(&self) -> bool

Bits: 4..5

pub const fn with_corim_endorsement_checked( self, value: bool, ) -> Result<Self, ()>

Bits: 4..5

pub const fn with_corim_endorsement(self, value: bool) -> Self

Bits: 4..5

pub const fn set_corim_endorsement(&mut self, value: bool)

Bits: 4..5

pub const fn set_corim_endorsement_checked( &mut self, value: bool, ) -> Result<(), ()>

Bits: 4..5

Trait Implementations

impl Clone for IgvmCapabilityBitMap

fn clone(&self) -> IgvmCapabilityBitMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgvmCapabilityBitMap

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

Formats the value using the given formatter.

impl Default for IgvmCapabilityBitMap

fn default() -> Self

Returns the “default value” for a type.

impl From<IgvmCapabilityBitMap> for u32

fn from(v: IgvmCapabilityBitMap) -> u32

Converts to this type from the input type.

impl From<u32> for IgvmCapabilityBitMap

fn from(v: u32) -> Self

Converts to this type from the input type.

impl FromBytes for IgvmCapabilityBitMap

where u32: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for IgvmCapabilityBitMap

where u32: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Result<Vec<Self>, AllocError>

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl IntoBytes for IgvmCapabilityBitMap

where u32: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for IgvmCapabilityBitMap

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl TryFromBytes for IgvmCapabilityBitMap

where u32: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for IgvmCapabilityBitMap

impl Immutable for IgvmCapabilityBitMap

where u32: Immutable,