Struct EncodedAuthCert 

pub struct EncodedAuthCert(/* private fields */);

Available on crate features parse2 and plain-consensus only.

Entire authority key certificate, encoded and signed

This is a newtype around String.

Invariants

• Is a complete document in netdoc metasyntax including trailing newline.
• Starts with one dir-key-certificate-version
• Ends with one dir-key-certification
• No other items are structural in a vote
• Every item keyword starts dir- or is fingerprint

See https://spec.torproject.org/dir-spec/creating-key-certificates.html#nesting

Non-invariant

• Signature and timeliness have not been checked.

Functionality

Implements TryFrom<String> and FromStr.

Implements NetdocParseable: parser matches dir-key-certificate-version and dir-key-certification, but also calls Bug if the caller’s stop_at reports that this keyword is structural for its container. (This could happen if an EncodedAuthCert existedd in some other document but a vote. We do not check this property during encoding.)

Rationale

Unlike most sub-documents found within netdocs, an authcert is a signed document. We expect to be able to copy an authcert into a vote, encode, convey and parse the vote, and extract the authcert, and verify the authcert’s signature.

Additionally, the fact that authcerts have their own signatures means that they need to be constructed separately from the surrounding document, and then embedded in it later.

When parsing a vote, we need to be able to see which parts are the authcert, and we need to be able to extract the specific document text, but we maybe don’t want to parse the authcert.

Conversely, signature verification of authcerts during decoding of a vote is fairly complex. We don’t want to do signature verification during parsing, because signature verification involves the time, and we don’t want parsing to need to know the time.

Implementations

impl EncodedAuthCert

pub fn as_str(&self) -> &str

Obtain the document text as a str

Trait Implementations

impl AsRef<str> for EncodedAuthCert

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EncodedAuthCert

fn clone(&self) -> EncodedAuthCert

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodedAuthCert

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

Formats the value using the given formatter.

impl FromStr for EncodedAuthCert

type Err = ErrorProblem

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, EP>

Parses a string s to return a value of this type.

impl Hash for EncodedAuthCert

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NetdocParseable for EncodedAuthCert

fn doctype_for_error() -> &'static str

Document type for errors, normally its intro keyword

fn is_intro_item_keyword(kw: KeywordRef<'_>) -> bool

Is Keyword an intro Item Keyword for this kind of document?

fn is_structural_keyword(kw: KeywordRef<'_>) -> Option<IsStructural>

Is Keyword a structural keyword for this kind of document?

fn from_items( input: &mut ItemStream<'_>, stop_at: StopAt<impl StopPredicate>, ) -> Result<Self, EP>

Parse the document from a stream of Items

impl Ord for EncodedAuthCert

fn cmp(&self, other: &EncodedAuthCert) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EncodedAuthCert

fn eq(&self, other: &EncodedAuthCert) -> 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 PartialOrd for EncodedAuthCert

fn partial_cmp(&self, other: &EncodedAuthCert) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<String> for EncodedAuthCert

type Error = ErrorProblem

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, EP>

Performs the conversion.

impl Eq for EncodedAuthCert

impl StructuralPartialEq for EncodedAuthCert