Struct SignOptions 

#[non_exhaustive]
pub struct SignOptions { /* private fields */ }

Options for signing a document.

Implementations

impl SignOptions

pub fn new() -> Self

New options with PadesProfile::BasicSignature as default.

pub fn reason(self, v: impl Into<String>) -> Self

Human-readable reason for signing.

pub fn location(self, v: impl Into<String>) -> Self

Location of signing.

pub fn contact_info(self, v: impl Into<String>) -> Self

Signer contact information.

pub fn field_name(self, v: impl Into<String>) -> Self

Signature form field name. Defaults to Signature1.

pub fn visible_rect(self, page: usize, rect: [f64; 4]) -> Self

Place a visible signature appearance on a specific page.

pub fn revocation_data( self, ocsp_responses: Vec<Vec<u8>>, crls: Vec<Vec<u8>>, ) -> Self

Revocation evidence for the DSS, DER-encoded.

PAdES B-LT is the profile that lets a verifier check the signature years later without going back on the network, and that takes more than the certificate chain: it takes the evidence that those certificates were not revoked at signing time. Fetching it is the caller’s, because the engine makes no network call while signing.

Include what covers the signer’s chain, and the timestamp authority’s chain as well if you have it – a verifier offline in five years checks both. PadesProfile::LongTerm is refused without any of it, rather than writing a DSS that names the profile and cannot support it.

pub fn profile(self, p: PadesProfile) -> Self

Select the PAdES profile.

PadesProfile::Timestamped and PadesProfile::LongTerm have to be signed through PdfDocument::sign_timestamped, which fetches the token over the signature it just made.

pub fn timestamp_token(self, der: impl Into<Vec<u8>>) -> Self

Supply a DER-encoded RFC 3161 timestamp token you already hold.

Only a token over this document’s signature will be accepted, and a token obtained before signing cannot be one: the signature does not exist yet, so its digest cannot be in the token’s messageImprint. PdfDocument::sign refuses a token that stamps other bytes rather than writing a B-T claim that no verifier will accept (#515).

So this method is for the case where the token genuinely is about this signature – one carried across a process boundary, say. To fetch a token in the ordinary way, use PdfDocument::sign_timestamped, which sequences the two correctly. The engine deliberately has no HTTP client of its own (that is what keeps document content off the network), so talking to the authority stays the caller’s job either way.

Ignored for PadesProfile::BasicSignature, which carries no timestamp by definition.

Trait Implementations

impl Clone for SignOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignOptions

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

Formats the value using the given formatter.

impl Default for SignOptions

fn default() -> Self

Returns the “default value” for a type.