Struct Blob

#[repr(C, packed(1))]
pub struct Blob<T: BlobLayout>(/* private fields */);

C-compatible dynamic inline structure.

Can be used to house data with a header structure of a statically known size but with trailing data of size dependent on the header field values.

Layout

The structure is marked as #[repr(C, packed)] to be layout-compatible with regular byte slice ([u8]) since it’s mostly constructed from Box<[u8]> via C FFI.

It’s worth noting that heap allocation will often align to pointer size, so no unaligned load should happen once the value is constructed from heap-allocated bytes.

Implementations

impl Blob<DsaParameter>

pub fn clone_from_parts( header: &BCRYPT_DSA_PARAMETER_HEADER, tail: &DsaParameterViewTail<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaParameter>

pub fn prime(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

impl Blob<DsaParameterV2>

pub fn clone_from_parts( header: &BCRYPT_DSA_PARAMETER_HEADER_V2, tail: &DsaParameterV2ViewTail<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaParameterV2>

pub fn prime(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

impl Blob<DhParameter>

pub fn clone_from_parts( header: &BCRYPT_DH_PARAMETER_HEADER, tail: &DhParameterViewTail<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DhParameter>

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

impl<T> Blob<T>

where T: BlobLayout + KeyBlob,

pub fn magic(&self) -> ULONG

pub fn blob_type(&self) -> Option<BlobType>

pub fn as_erased(&self) -> &Blob<ErasedKeyBlob>

pub fn try_into<U>(self: Box<Self>) -> Result<Box<Blob<U>>, Box<Self>>

where U: BlobLayout + KeyBlob,

impl Blob<ErasedKeyBlob>

pub fn clone_from_parts( header: &BCRYPT_KEY_BLOB, tail: &ErasedKeyPayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<ErasedKeyBlob>

pub fn phantom(&self) -> &[u8]

impl Blob<RsaKeyPublicBlob>

pub fn clone_from_parts( header: &BCRYPT_RSAKEY_BLOB, tail: &RsaKeyPublicPayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<RsaKeyPublicBlob>

pub fn pub_exp(&self) -> &[u8]

pub fn modulus(&self) -> &[u8]

impl Blob<RsaKeyPrivateBlob>

pub fn clone_from_parts( header: &BCRYPT_RSAKEY_BLOB, tail: &RsaKeyPrivatePayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<RsaKeyPrivateBlob>

pub fn pub_exp(&self) -> &[u8]

pub fn modulus(&self) -> &[u8]

pub fn prime1(&self) -> &[u8]

pub fn prime2(&self) -> &[u8]

impl Blob<RsaKeyFullPrivateBlob>

pub fn clone_from_parts( header: &BCRYPT_RSAKEY_BLOB, tail: &RsaKeyFullPrivatePayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<RsaKeyFullPrivateBlob>

pub fn pub_exp(&self) -> &[u8]

pub fn modulus(&self) -> &[u8]

pub fn prime1(&self) -> &[u8]

pub fn prime2(&self) -> &[u8]

pub fn exponent1(&self) -> &[u8]

pub fn exponent2(&self) -> &[u8]

pub fn coeff(&self) -> &[u8]

pub fn priv_exp(&self) -> &[u8]

impl Blob<DhKeyPublicBlob>

pub fn clone_from_parts( header: &BCRYPT_DH_KEY_BLOB, tail: &DhKeyPublicPayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DhKeyPublicBlob>

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

impl Blob<DhKeyPrivateBlob>

pub fn clone_from_parts( header: &BCRYPT_DH_KEY_BLOB, tail: &DhKeyPrivatePayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DhKeyPrivateBlob>

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

pub fn priv_exp(&self) -> &[u8]

impl Blob<DsaKeyPublicBlob>

pub fn clone_from_parts( header: &BCRYPT_DSA_KEY_BLOB, tail: &DsaKeyPublicPayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaKeyPublicBlob>

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

impl Blob<DsaKeyPrivateBlob>

pub fn clone_from_parts( header: &BCRYPT_DSA_KEY_BLOB, tail: &DsaKeyPrivatePayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaKeyPrivateBlob>

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

pub fn priv_exp(&self) -> &[u8]

impl Blob<DsaKeyPublicV2Blob>

pub fn clone_from_parts( header: &BCRYPT_DSA_KEY_BLOB_V2, tail: &DsaKeyPublicV2Payload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaKeyPublicV2Blob>

pub fn seed(&self) -> &[u8]

pub fn group(&self) -> &[u8]

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

impl Blob<DsaKeyPrivateV2Blob>

pub fn clone_from_parts( header: &BCRYPT_DSA_KEY_BLOB_V2, tail: &DsaKeyPrivateV2Payload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<DsaKeyPrivateV2Blob>

pub fn seed(&self) -> &[u8]

pub fn group(&self) -> &[u8]

pub fn modulus(&self) -> &[u8]

pub fn generator(&self) -> &[u8]

pub fn public(&self) -> &[u8]

pub fn priv_exp(&self) -> &[u8]

impl Blob<EccKeyPublicBlob>

pub fn clone_from_parts( header: &BCRYPT_ECCKEY_BLOB, tail: &EccKeyPublicPayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<EccKeyPublicBlob>

pub fn x(&self) -> &[u8]

pub fn y(&self) -> &[u8]

impl Blob<EccKeyPrivateBlob>

pub fn clone_from_parts( header: &BCRYPT_ECCKEY_BLOB, tail: &EccKeyPrivatePayload<'_>, ) -> Box<Self>

Create a [$wrapper_ident] blob instance from its parts.

SAFETY: The header might contain length information about the payload (i.e. the tail argument). An mismatch between the two won’t cause a memory corruption, but it will panic. Careful validation of the arguments must be done to ensure proper behaviour.

impl Blob<EccKeyPrivateBlob>

pub fn x(&self) -> &[u8]

pub fn y(&self) -> &[u8]

pub fn d(&self) -> &[u8]

impl<T: BlobLayout> Blob<T>

pub fn header(&self) -> &T::Header

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

pub fn into_bytes(self: Box<Self>) -> Box<[u8]>

pub fn from_boxed(boxed: Box<[u8]>) -> Box<Self>

Trait Implementations

impl<T: BlobLayout> AsBytes for Blob<T>

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

fn into_bytes(self: Box<Self>) -> Box<[u8]>

impl<T> AsRef<Blob<ErasedKeyBlob>> for Blob<T>

where T: BlobLayout + KeyBlob,

fn as_ref(&self) -> &Blob<ErasedKeyBlob>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Blob<ErasedKeyBlob>> for DsaPrivateBlob

fn as_ref(&self) -> &Blob<ErasedKeyBlob>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Blob<ErasedKeyBlob>> for DsaPublicBlob

fn as_ref(&self) -> &Blob<ErasedKeyBlob>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: BlobLayout> FromBytes for Blob<T>

const MIN_LAYOUT: Layout

Specified the minimum layout requirements for the allocation:

fn from_bytes(bytes: &[u8]) -> &Self

fn from_boxed(boxed: Box<[u8]>) -> Box<Self>