Struct tss_esapi::structures::PublicBuilder

pub struct PublicBuilder { /* private fields */ }

A builder for the Public type.

Implementations

impl PublicBuilder

pub const fn new() -> Self

Creates a new PublicBuilder

Details

Builds the Public type using the provided parameters. Parameters associated with other algorithms then the provided public algorithm will be ignored.

pub const fn with_public_algorithm(
    self,
    public_algorithm: PublicAlgorithm
) -> Self

Adds the public algorithm for the Public structure to the builder.

pub const fn with_object_attributes(
    self,
    object_attributes: ObjectAttributes
) -> Self

Adds the attributes of the Public structure to the builder

pub const fn with_name_hashing_algorithm(
    self,
    name_hashing_algorithm: HashingAlgorithm
) -> Self

Adds the name hash algorithm for the Public strucutre to the builder.

pub fn with_auth_policy(self, auth_policy: Digest) -> Self

Adds the auth policy for the Public strucutre to the builder

pub fn with_rsa_parameters(self, rsa_parameters: PublicRsaParameters) -> Self

Adds the RSA parameters for the Public structure to the builder.

Details

This is required if the public algorithm is set to Rsa.

pub fn with_rsa_unique_identifier(
    self,
    rsa_unique_identifier: PublicKeyRsa
) -> Self

Adds the RSA unique identifier for the Public structure to the builder.

Details

This is required if the public algorithm is set to Rsa.

The unique identifier is the public key.

pub fn with_keyed_hash_parameters(
    self,
    keyed_hash_parameters: PublicKeyedHashParameters
) -> Self

Adds the keyed hash parameters for the Public structure to the builder.

Details

This is required if the public algorithm is set to KeyedHash.

pub fn with_keyed_hash_unique_identifier(
    self,
    keyed_hash_unique_identifier: Digest
) -> Self

Adds the keyed hash unique identifier for the Public structure to the builder.

Details

This is required if the public algorithm is set to KeyedHash.

pub const fn with_ecc_parameters(
    self,
    ecc_parameters: PublicEccParameters
) -> Self

Adds the ECC parameters for the Public structure to the builder.

Details

This is required if the public algorithm is set to Ecc.

pub fn with_ecc_unique_identifier(self, ecc_unique_identifier: EccPoint) -> Self

Adds the ECC unique identifier for the Public structure to the builder.

Details

This is required if the public algorithm is set to Ecc.

The unique identifier is a ecc point.

pub const fn with_symmetric_cipher_parameters(
    self,
    symmetric_cipher_parameters: SymmetricCipherParameters
) -> Self

Adds the symmetric cipher parameters for the Public structure to the builder.

Details

This is required if the public algorithm is set to SymCipher.

pub fn with_symmetric_cipher_unique_identifier(
    self,
    symmetric_cipher_unique_identifier: Digest
) -> Self

Adds the symmetric cipher unique identifier for the Public structure to the builder.

Details

This is required if the public algorithm is set to SymCipher.

pub fn build(self) -> Result<Public>

Builds the Public structure.

Errors

Will return error if the public algorithm, object attributes or name hashing algorithm have not been set or if the parameters and unique identifier does not match the selected public algorithm.

Trait Implementations

impl Clone for PublicBuilder

fn clone(&self) -> PublicBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicBuilder

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

Formats the value using the given formatter.