Skip to main content

Module v1

Module v1 

Source
Expand description

Code implementing version 1 proof-of-work for onion service hosts.

Spec links:

Re-exportsΒ§

use std::collections::BTreeSet; πŸ”’
use std::collections::HashMap; πŸ”’
use std::collections::VecDeque; πŸ”’
use std::sync::Arc; πŸ”’
use std::sync::Mutex; πŸ”’
use std::sync::RwLock; πŸ”’
use std::task::Waker; πŸ”’
use arrayvec::ArrayVec; πŸ”’
use equix::EquiXBuilder; πŸ”’
use futures::SinkExt; πŸ”’
use futures::StreamExt; πŸ”’
use futures::Stream; πŸ”’
use futures::channel::mpsc; πŸ”’
use num_traits::FromPrimitive; πŸ”’
use rand::CryptoRng; πŸ”’
use serde::Deserialize; πŸ”’
use serde::Deserialize; πŸ”’
use serde::Serialize; πŸ”’
use serde::Serialize; πŸ”’
use thiserror::Error; πŸ”’
use tor_basic_utils::RngExt as _; πŸ”’
use tor_cell::relaycell::hs::pow::ProofOfWork; πŸ”’
use tor_cell::relaycell::hs::pow::v1::ProofOfWorkV1; πŸ”’
use tor_checkable::timed::TimeRangeBound; πŸ”’
use tor_error::warn_report; πŸ”’
use tor_hscrypto::pk::HsBlindIdKey; πŸ”’
use tor_hscrypto::pow::v1::Effort; πŸ”’
use tor_hscrypto::pow::v1::Instance; πŸ”’
use tor_hscrypto::pow::v1::RuntimeOption; πŸ”’
use tor_hscrypto::pow::v1::Seed; πŸ”’
use tor_hscrypto::pow::v1::SeedHead; πŸ”’
use tor_hscrypto::pow::v1::Solution; πŸ”’
use tor_hscrypto::pow::v1::SolutionErrorV1; πŸ”’
use tor_hscrypto::pow::v1::Verifier; πŸ”’
use tor_hscrypto::time::TimePeriod; πŸ”’
use tor_keymgr::KeyMgr; πŸ”’
use tor_netdir::NetDirProvider; πŸ”’
use tor_netdir::NetdirProviderShutdown; πŸ”’
use tor_netdir::params::NetParameters; πŸ”’
use tor_netdoc::doc::hsdesc::pow::PowParams; πŸ”’
use tor_netdoc::doc::hsdesc::pow::v1::PowParamsV1; πŸ”’
use tor_persist::hsnickname::HsNickname; πŸ”’
use tor_persist::state_dir::InstanceRawSubdir; πŸ”’
use tor_persist::state_dir::StorageHandle; πŸ”’
use tor_rtcompat::Runtime; πŸ”’
use tor_rtcompat::SpawnExt; πŸ”’
use web_time_compat::Duration; πŸ”’
use web_time_compat::Instant; πŸ”’
use web_time_compat::InstantExt; πŸ”’
use web_time_compat::SystemTime; πŸ”’
use web_time_compat::SystemTimeExt; πŸ”’
use crate::BlindIdPublicKeySpecifier; πŸ”’
use crate::OnionServiceConfig; πŸ”’
use crate::RendRequest; πŸ”’
use crate::ReplayError; πŸ”’
use crate::StartupError; πŸ”’
use crate::rend_handshake; πŸ”’
use crate::replay::OpenReplayLogError; πŸ”’
use crate::replay::PowNonceReplayLog; πŸ”’
use crate::status::PowManagerStatusSender; πŸ”’
use crate::status::Problem; πŸ”’
use crate::status::State as PowManagerState; πŸ”’
use super::NewPowManager; πŸ”’

StructsΒ§

PowManagerGeneric πŸ”’
This is responsible for rotating Proof-of-Work seeds and doing verification of PoW solves.
PowManagerStateRecord πŸ”’
On-disk record of PowManagerGeneric state.
RendRequestOrdByEffort πŸ”’
Wrapper around RendRequest that implements std::cmp::Ord to sort by Effort and time.
RendRequestReceiver πŸ”’
Implements Stream for incoming RendRequests, using a priority queue system to dequeue high-Effort requests first.
RendRequestReceiverInner πŸ”’
Inner implementation for RendRequestReceiver.
SeedsForTimePeriod πŸ”’
Information about the current and previous Seed for a given TimePeriod.
State πŸ”’
Internal state for PowManagerGeneric.

EnumsΒ§

PowError
Error within the PoW subsystem.
PowSolveError πŸ”’
A PoW solve was invalid.

ConstantsΒ§

EXPIRATION_TIME_MINS_MAX πŸ”’
Maximum seed expiration time in minutes. See: https://spec.torproject.org/hspow-spec/v1-equix.html#parameter-descriptor
EXPIRATION_TIME_MINS_MIN πŸ”’
Minimum seed expiration time in minutes. See: https://spec.torproject.org/hspow-spec/v1-equix.html#parameter-descriptor
HS_UPDATE_PERIOD πŸ”’
How frequently the suggested effort should be recalculated.
PUBLISHER_UPDATE_QUEUE_DEPTH πŸ”’
Depth of the queue used to signal the publisher that it needs to update a given time period.
SEED_EARLY_ROTATION_TIME πŸ”’
How soon before a seed’s expiration time we should rotate it and publish a new seed.
SUGGESTED_EFFORT_DEADZONE πŸ”’
When the suggested effort has changed by less than this much, we don’t republish it.

TraitsΒ§

MockablePowManager πŸ”’
Trait to allow mocking PowManagerGeneric in tests.
MockableRendRequest πŸ”’
Trait to allow mocking RendRequest in tests.

Type AliasesΒ§

PowManager πŸ”’
Proof-of-Work manager type alias for production, using concrete RendRequest.