Skip to main content

SignedNote

Struct SignedNote 

Source
pub struct SignedNote { /* private fields */ }
Expand description

A parsed signed note: the signed text plus its (still unverified) signature lines.

Implementations§

Source§

impl SignedNote

Source

pub fn new(text: String, signatures: Vec<Signature>) -> Result<Self>

Create a signed note from text and signatures.

§Errors

Returns Error::MalformedNote if text does not end in a newline.

Source

pub fn text(&self) -> &str

The note text (including its final newline; excluding the separating blank line). This is the exact byte string signatures are computed over.

Source

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

The parsed signature lines.

Source

pub fn parse(msg: &str) -> Result<Self>

Parse a complete signed-note byte string.

Mirrors the reference Go note.Open structural parse: validates UTF-8 and the no-control-characters rule, splits the text from the trailing signature block at the last blank line, and parses each signature line. Signatures are not verified here; call SignedNote::verify.

§Errors

Returns Error::MalformedNote for any structural violation.

Source

pub fn marshal(&self) -> String

Serialize this signed note to its canonical byte string: text || "\n" || signature lines.

Source

pub fn verify<'a>( &'a self, trusted: &[VerifierKey], ) -> Result<Vec<&'a Signature>>

Verify the note against a set of trusted verifier keys.

Following the C2SP signed-note rules:

  • signatures whose (name, key id) match no trusted key are ignored;
  • if a signature from a known key fails to verify, the whole note is rejected (Error::InvalidSignature);
  • if no signature from a trusted key verifies, the note is rejected (Error::NoTrustedSignature).

On success returns references to the signatures that verified.

§Errors

Error::InvalidSignature or Error::NoTrustedSignature as above.

Trait Implementations§

Source§

impl Clone for SignedNote

Source§

fn clone(&self) -> SignedNote

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SignedNote

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SignedNote

Source§

impl PartialEq for SignedNote

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for SignedNote

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.