Struct CleartextSignedMessage

pub struct CleartextSignedMessage { /* private fields */ }

Implementation of a Cleartext Signed Message.

Ref https://www.rfc-editor.org/rfc/rfc9580.html#name-cleartext-signature-framewo

Implementations

impl CleartextSignedMessage

pub fn new<F>( text: &str, config: SignatureConfig, key: &impl SecretKeyTrait, key_pw: F, ) -> Result<Self>

where F: FnOnce() -> String,

Construct a new cleartext message and sign it using the given key.

pub fn sign<R, F>( rng: R, text: &str, key: &impl SecretKeyTrait, key_pw: F, ) -> Result<Self>

where R: Rng + CryptoRng, F: FnOnce() -> String,

Sign the given text.

pub fn new_many<F>(text: &str, signer: F) -> Result<Self>

where F: FnOnce(&[u8]) -> Result<Vec<Signature>>,

Sign the same message with multiple keys.

The signer function gets invoked with the normalized original text to be signed, and needs to produce the individual signatures.

pub fn signatures(&self) -> &[StandaloneSignature]

The signature on the message.

pub fn verify(&self, key: &impl PublicKeyTrait) -> Result<&StandaloneSignature>

Verify the signature against the normalized cleartext.

On success returns the first signature that verified against this key.

pub fn verify_many<F>(&self, verifier: F) -> Result<()>

where F: Fn(usize, &StandaloneSignature, &[u8]) -> Result<()>,

Verify each signature, potentially against a different key.

pub fn signed_text(&self) -> String

Normalizes the text to the format that was hashed for the signature. The output is normalized to “\r\n” line endings.

pub fn text(&self) -> &str

The “cleartext framework”-encoded (i.e. dash-escaped) form of the message.

pub fn from_armor<R: Read>(bytes: R) -> Result<(Self, Headers)>

Parse from an arbitrary reader, containing the text of the message.

pub fn from_string(input: &str) -> Result<(Self, Headers)>

Parse from string, containing the text of the message.

pub fn from_armor_buf<R: BufRead>(b: R) -> Result<(Self, Headers)>

Parse from a buffered reader, containing the text of the message.

pub fn from_armor_after_header<R: BufRead>( b: R, headers: Headers, ) -> Result<(Self, Headers)>

pub fn to_armored_writer( &self, writer: &mut impl Write, opts: ArmorOptions<'_>, ) -> Result<()>

pub fn to_armored_bytes(&self, opts: ArmorOptions<'_>) -> Result<Vec<u8>>

pub fn to_armored_string(&self, opts: ArmorOptions<'_>) -> Result<String>

Trait Implementations

impl Clone for CleartextSignedMessage

fn clone(&self) -> CleartextSignedMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CleartextSignedMessage

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

Formats the value using the given formatter.

impl PartialEq for CleartextSignedMessage

fn eq(&self, other: &CleartextSignedMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CleartextSignedMessage

impl StructuralPartialEq for CleartextSignedMessage