Lines
92.59 %
Functions
30.91 %
Branches
100 %
//! Identifier objects used to specify guards and/or fallbacks.
use derive_more::AsRef;
use serde::{Deserialize, Serialize};
use tor_linkspec::{HasRelayIds, RelayIds};
#[cfg(test)]
use tor_llcrypto::pk;
use crate::GuardSetSelector;
/// An identifier for a fallback directory cache.
///
/// This is a separate type from GuardId and FirstHopId to avoid confusion
/// about what kind of object we're identifying.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd, AsRef)]
pub(crate) struct FallbackId(pub(crate) RelayIds);
impl FallbackId {
/// Return a new, manually constructed `FallbackId`
/// Extract a `FallbackId` from a ChanTarget object.
pub(crate) fn from_relay_ids<T>(target: &T) -> Self
where
T: tor_linkspec::HasRelayIds + ?Sized,
{
Self(RelayIds::from_relay_ids(target))
}
impl HasRelayIds for FallbackId {
fn identity(
&self,
key_type: tor_linkspec::RelayIdType,
) -> Option<tor_linkspec::RelayIdRef<'_>> {
self.0.identity(key_type)
/// An identifier for a sampled guard.
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Ord, PartialOrd, AsRef)]
#[serde(transparent)]
pub(crate) struct GuardId(pub(crate) RelayIds);
impl GuardId {
/// Return a new, manually constructed `GuardId`
pub(crate) fn new(ed25519: pk::ed25519::Ed25519Identity, rsa: pk::rsa::RsaIdentity) -> Self {
Self(
RelayIds::builder()
.ed_identity(ed25519)
.rsa_identity(rsa)
.build()
.expect("Couldn't build RelayIds"),
)
/// Extract a `GuardId` from a ChanTarget object.
impl HasRelayIds for GuardId {
/// Implementation type held inside of FirstHopId.
/// This exists as a separate type from FirstHopId because Rust requires that a pub enum's variants are all public.
#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
pub(crate) enum FirstHopIdInner {
/// Identifies a guard.
Guard(GuardSetSelector, GuardId),
/// Identifies a fallback.
Fallback(FallbackId),
/// A unique cryptographic identifier for a selected guard or fallback
/// directory.
/// (This is implemented internally using all of the guard's known identities.)
pub struct FirstHopId(pub(crate) FirstHopIdInner);
impl From<FallbackId> for FirstHopId {
fn from(id: FallbackId) -> Self {
Self(FirstHopIdInner::Fallback(id))
impl AsRef<RelayIds> for FirstHopId {
/// Return the inner `RelayIds` for this object.
/// Only use this when it's okay to erase the type information about
/// whether this identifies a guard or a fallback.
fn as_ref(&self) -> &RelayIds {
match &self.0 {
FirstHopIdInner::Guard(_, id) => id.as_ref(),
FirstHopIdInner::Fallback(id) => id.as_ref(),
impl tor_linkspec::HasRelayIds for FirstHopId {
self.as_ref().identity(key_type)
impl FirstHopId {
/// Return the relay in `netdir` that corresponds to this ID, if there
/// is one.
//
// We have to define this function so it'll be public.
pub fn get_relay<'a>(&self, netdir: &'a tor_netdir::NetDir) -> Option<tor_netdir::Relay<'a>> {
netdir.by_ids(self)
/// Construct a FirstHopId for a guard in a given sample.
pub(crate) fn in_sample(sample: GuardSetSelector, id: GuardId) -> Self {
Self(FirstHopIdInner::Guard(sample, id))