Struct SignerBuilder

pub struct SignerBuilder<'a> { /* private fields */ }

Builder type to construct an entity that will sign some data.

Instances will be attached to SignedDataBuilder instances where they will sign data using configured settings.

Implementations

impl<'a> SignerBuilder<'a>

pub fn new( signing_key: &'a dyn KeyInfoSigner, signing_certificate: CapturedX509Certificate, ) -> Self

Construct a new entity that will sign content.

An entity is constructed from a signing key, which is mandatory.

pub fn new_with_signer_identifier( signing_key: &'a dyn KeyInfoSigner, signer_identifier: SignerIdentifier, ) -> Self

Construct a new entity that will sign content.

An entity is constructed from a signing key and signer identifier, which are mandatory.

pub fn signature_algorithm(&self) -> Result<SignatureAlgorithm, CmsError>

Obtain the signature algorithm used by the signing key.

pub fn message_id_content(self, data: Vec<u8>) -> Self

Define the content to use to calculate the message-id attribute.

In most cases, this is never called and the encapsulated content embedded within the generated message is used. However, some users omit storing the data inline and instead use a message-id digest calculated from a different source. This defines that different source.

pub fn content_type(self, oid: Oid) -> Self

Define the content type of the signed content.

pub fn signed_attribute(self, typ: Oid, values: Vec<AttributeValue>) -> Self

Add an additional attribute to sign.

pub fn signed_attribute_octet_string(self, typ: Oid, data: &[u8]) -> Self

Add an additional OctetString signed attribute.

This is a helper for converting a byte slice to an OctetString and AttributeValue without having to go through low-level ASN.1 code.

pub fn time_stamp_url(self, url: impl IntoUrl) -> Result<Self, Error>

Obtain a time-stamp token from a server.

If this is called, the URL must be a server implementing the Time-Stamp Protocol (TSP) as defined by RFC 3161. At signature generation time, the server will be contacted and the time stamp token response will be added as an unsigned attribute on the SignedData instance.

Trait Implementations

impl<'a> Clone for SignerBuilder<'a>

fn clone(&self) -> SignerBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.