tor_netdoc/doc/netstatus/rs/
each_flavor.rs

1//! router status entries - items that vary by consensus flavor
2//!
3//! **This file is reincluded multiple times**,
4//! by the macros in [`crate::doc::ns_variety_definition_macros`],
5//! once for votes, and once for each consensus flavour.
6//! It is *not* a module `crate::doc::netstatus::rs::each_flavor`.
7//!
8//! Each time this file is included by one of the macros mentioned above,
9//! the `ns_***` macros (such as `ns_const_name!`) may expand to different values.
10//!
11//! See [`crate::doc::ns_variety_definition_macros`].
12
13use super::*;
14
15impl RouterStatus {
16    /// Return an iterator of ORPort addresses for this routerstatus
17    pub fn addrs(&self) -> impl Iterator<Item = net::SocketAddr> {
18        chain!(
19            [std::net::SocketAddrV4::new(self.r.ip, self.r.or_port).into()],
20            self.a.iter().copied(),
21        )
22    }
23    /// Return the declared weight of this routerstatus in the directory.
24    pub fn weight(&self) -> &RelayWeight {
25        &self.weight
26    }
27    /// Return the protovers that this routerstatus says it implements.
28    pub fn protovers(&self) -> &Protocols {
29        &self.protos
30    }
31    /// Return the nickname of this routerstatus.
32    pub fn nickname(&self) -> &str {
33        self.r.nickname.as_str()
34    }
35    /// Return the relay flags of this routerstatus.
36    pub fn flags(&self) -> &RelayFlags {
37        &self.flags.known
38    }
39    /// Return the version of this routerstatus.
40    pub fn version(&self) -> Option<&crate::doc::netstatus::rs::Version> {
41        self.version.as_ref()
42    }
43    /// Return true if the ed25519 identity on this relay reflects a
44    /// true consensus among the authorities.
45    pub fn ed25519_id_is_usable(&self) -> bool {
46        !self.flags.contains(RelayFlag::NoEdConsensus)
47    }
48    /// Return true if this routerstatus is listed with the BadExit flag.
49    pub fn is_flagged_bad_exit(&self) -> bool {
50        self.flags.contains(RelayFlag::BadExit)
51    }
52    /// Return true if this routerstatus is listed with the v2dir flag.
53    pub fn is_flagged_v2dir(&self) -> bool {
54        self.flags.contains(RelayFlag::V2Dir)
55    }
56    /// Return true if this routerstatus is listed with the Exit flag.
57    pub fn is_flagged_exit(&self) -> bool {
58        self.flags.contains(RelayFlag::Exit)
59    }
60    /// Return true if this routerstatus is listed with the Guard flag.
61    pub fn is_flagged_guard(&self) -> bool {
62        self.flags.contains(RelayFlag::Guard)
63    }
64    /// Return true if this routerstatus is listed with the HSDir flag.
65    pub fn is_flagged_hsdir(&self) -> bool {
66        self.flags.contains(RelayFlag::HSDir)
67    }
68    /// Return true if this routerstatus is listed with the Stable flag.
69    pub fn is_flagged_stable(&self) -> bool {
70        self.flags.contains(RelayFlag::Stable)
71    }
72    /// Return true if this routerstatus is listed with the Fast flag.
73    pub fn is_flagged_fast(&self) -> bool {
74        self.flags.contains(RelayFlag::Fast)
75    }
76    /// Return true if this routerstatus is listed with the MiddleOnly flag.
77    pub fn is_flagged_middle_only(&self) -> bool {
78        self.flags.contains(RelayFlag::MiddleOnly)
79    }
80}
81
82impl RouterStatus {
83    /// Return RSA identity for the relay described by this RouterStatus
84    pub fn rsa_identity(&self) -> &RsaIdentity {
85        &self.r.identity
86    }
87
88    /// Return the networkstatus consensus flavor in which this
89    /// routerstatus appears.
90    pub(crate) fn flavor() -> ConsensusFlavor {
91        FLAVOR
92    }
93
94    /// Parse a generic routerstatus from a section.
95    ///
96    /// Requires that the section obeys the right SectionRules,
97    /// matching `consensus_flavor`.
98    pub(crate) fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<RouterStatus> {
99        use NetstatusKwd::*;
100        // R line
101        let r_item = sec.required(RS_R)?;
102        let nickname = r_item.required_arg(0)?.parse()?;
103        let ident = r_item.required_arg(1)?;
104        let identity = ident.parse::<Base64Fingerprint>()?;
105        // Fields to skip in the "r" line.
106        let n_skip = match FLAVOR {
107            ConsensusFlavor::Microdesc => 0,
108            ConsensusFlavor::Plain => 1,
109        };
110        // We check that the published time is well-formed, but we never use it
111        // for anything in a consensus document.
112        let _ignore_published: time::SystemTime = {
113            // TODO: It's annoying to have to do this allocation, since we
114            // already have a slice that contains both of these arguments.
115            // Instead, we could get a slice of arguments: we'd have to add
116            // a feature for that.
117            let mut p = r_item.required_arg(2 + n_skip)?.to_string();
118            p.push(' ');
119            p.push_str(r_item.required_arg(3 + n_skip)?);
120            p.parse::<Iso8601TimeSp>()?.into()
121        };
122        let ip = r_item.required_arg(4 + n_skip)?.parse::<net::Ipv4Addr>()?;
123        let or_port = r_item.required_arg(5 + n_skip)?.parse::<u16>()?;
124        let _ = r_item.required_arg(6 + n_skip)?.parse::<u16>()?;
125
126        // main address and A lines.
127        let a_items = sec.slice(RS_A);
128        let a = a_items
129            .iter()
130            .map(|a_item| Ok(a_item.required_arg(0)?.parse::<net::SocketAddr>()?))
131            .collect::<Result<Vec<_>>>()?;
132
133        // S line
134        //
135        // Wrong for votes, but this code doesn't run for votes.
136        let flags = DocRelayFlags::from_item_consensus(sec.required(RS_S)?)?;
137
138        // V line
139        let version = sec.maybe(RS_V).args_as_str().map(str::parse).transpose()?;
140
141        // PR line
142        let protos = {
143            let tok = sec.required(RS_PR)?;
144            tok.args_as_str()
145                .parse::<Protocols>()
146                .map_err(|e| EK::BadArgument.at_pos(tok.pos()).with_source(e))?
147        };
148
149        // W line
150        let weight = sec
151            .get(RS_W)
152            .map(RelayWeight::from_item)
153            .transpose()?
154            .unwrap_or_default();
155
156        // No p line
157        // no ID line
158
159        // Try to find the document digest.  This is in different
160        // places depending on the kind of consensus we're in.
161        let doc_digest: DocDigest = match FLAVOR {
162            ConsensusFlavor::Microdesc => {
163                // M line
164                let m_item = sec.required(RS_M)?;
165                DocDigest::decode(m_item.required_arg(0)?)?
166            }
167            ConsensusFlavor::Plain => DocDigest::decode(r_item.required_arg(2)?)?,
168        };
169
170        ns_choose! { (
171            let r_doc_digest = doc_digest;
172            let m_doc_digest = NotPresent;
173        ) (
174            let r_doc_digest = NotPresent;
175            let m_doc_digest = doc_digest;
176        ) (
177            let r_doc_digest = doc_digest;
178            let m_doc_digest = NotPresent;
179        ) };
180
181        Ok(RouterStatus {
182            r: RouterStatusIntroItem {
183                nickname,
184                identity,
185                or_port,
186                doc_digest: r_doc_digest,
187                publication: IgnoredPublicationTimeSp,
188                ip,
189            },
190            m: m_doc_digest,
191            a,
192            flags,
193            version,
194            protos,
195            weight,
196        })
197    }
198}
199
200impl FromRsString for DocDigest {
201    fn decode(s: &str) -> Result<DocDigest> {
202        s.parse::<B64>()?
203            .check_len(DOC_DIGEST_LEN..=DOC_DIGEST_LEN)?
204            .as_bytes()
205            .try_into()
206            .map_err(|_| Error::from(internal!("correct length on digest, but unable to convert")))
207    }
208}
tor_netdoc/doc/netstatus/rs/each_flavor.rs

tor_netdoc/doc/netstatus/rs/
each_flavor.rs
