Merge branch 'typos' into 'main'
Fix typos See merge request tpo/core/arti!1431
This commit is contained in:
commit
19f097d1fa
|
@ -80,7 +80,7 @@ pub(crate) struct BoxedResponse {
|
|||
/// An ID for the request that we're responding to.
|
||||
///
|
||||
/// This is always present on a response to every valid request; it is also
|
||||
/// present on responses to invalid requests if we could decern what their
|
||||
/// present on responses to invalid requests if we could discern what their
|
||||
/// `id` field was. We only omit it when the request id was indeterminate.
|
||||
/// If we do that, we close the connection immediately afterwards.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
//! Variations on our message types used to give better diagnostics for
|
||||
//! unparseable requests.
|
||||
//! unparsable requests.
|
||||
|
||||
use tor_rpcbase as rpc;
|
||||
|
||||
|
|
|
@ -69,7 +69,7 @@
|
|||
|
||||
# Whether to log sensitive information (such as target hostnames and ip addresses)
|
||||
#
|
||||
# If set to `false` (the default), such information is not logged in meessages of
|
||||
# If set to `false` (the default), such information is not logged in messages of
|
||||
# level `info` or higher.
|
||||
#log_sensitive_information = false
|
||||
|
||||
|
@ -85,7 +85,7 @@
|
|||
# an odd interval of time.)
|
||||
#
|
||||
# This option can't affect the granularity of times recorded by logging systems
|
||||
# outside of arti, inluding journald.
|
||||
# outside of arti, including journald.
|
||||
#
|
||||
#time_granularity = "1s"
|
||||
|
||||
|
@ -204,7 +204,7 @@
|
|||
# These are case-sensitive.
|
||||
#
|
||||
[override_net_params]
|
||||
# For example (not the eefaults):
|
||||
# For example (not the defaults):
|
||||
# circwindow = 1000
|
||||
# min_paths_for_circs_pct = 60
|
||||
|
||||
|
@ -280,7 +280,7 @@
|
|||
#initial_predicted_ports = [80, 443]
|
||||
|
||||
# After we see the client request a connection to a new port, how long should we
|
||||
# predict that the client will still want to have circuitsw available for that
|
||||
# predict that the client will still want to have circuits available for that
|
||||
# port?
|
||||
#prediction_lifetime = "1 hour"
|
||||
|
||||
|
@ -301,7 +301,7 @@
|
|||
[channel]
|
||||
|
||||
# Should we use reduced channel padding? (This roughly halves the padding
|
||||
# cell frequency, and makes the padding unidrecteional, increasing the
|
||||
# cell frequency, and makes the padding unidirectional, increasing the
|
||||
# traceability of the client connections.)
|
||||
# Or disable it entirely?
|
||||
#
|
||||
|
@ -347,7 +347,7 @@
|
|||
# Should we allow attempts to make Tor connections to local addresses?
|
||||
#allow_local_addrs = false
|
||||
|
||||
# Should Arti make connections to hidden serivces (.onion services) ?
|
||||
# Should Arti make connections to hidden services (.onion services) ?
|
||||
#
|
||||
# As of this implementation, Arti's onion service support lacks the
|
||||
# "vanguards" feature that Tor uses to prevent guard discovery attacks over time.
|
||||
|
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
# Whether to log sensitive information (such as target hostnames and ip addresses)
|
||||
#
|
||||
# If set to `false` (the default), such information is not logged in meessages of
|
||||
# If set to `false` (the default), such information is not logged in messages of
|
||||
# level `info` or higher.
|
||||
#log_sensitive_information = false
|
||||
|
||||
|
@ -113,7 +113,7 @@
|
|||
# These are case-sensitive.
|
||||
#
|
||||
[override_net_params]
|
||||
# For example (not the eefaults):
|
||||
# For example (not the defaults):
|
||||
# circwindow = 1000
|
||||
# min_paths_for_circs_pct = 60
|
||||
|
||||
|
@ -189,7 +189,7 @@
|
|||
#initial_predicted_ports = [80, 443]
|
||||
|
||||
# After we see the client request a connection to a new port, how long should we
|
||||
# predict that the client will still want to have circuitsw available for that
|
||||
# predict that the client will still want to have circuits available for that
|
||||
# port?
|
||||
#prediction_lifetime = "1 hour"
|
||||
|
||||
|
@ -210,7 +210,7 @@
|
|||
[channel]
|
||||
|
||||
# Should we use reduced channel padding? (This roughly halves the padding
|
||||
# cell frequency, and makes the padding unidrecteional, increasing the
|
||||
# cell frequency, and makes the padding unidirectional, increasing the
|
||||
# traceability of the client connections.)
|
||||
# Or disable it entirely?
|
||||
#
|
||||
|
|
|
@ -33,7 +33,7 @@ caret_int! {
|
|||
/// rend-spec-v3.txt \[PROCESS_INTRO].
|
||||
//
|
||||
// TODO this shouldn't live here. It ought to be in some more general crate.
|
||||
// But it should then also be useable in the netdoc parser. In particular, it ought
|
||||
// But it should then also be usable in the netdoc parser. In particular, it ought
|
||||
// to be able to handle the *textual* values in `hsdesc/inner.rs`, and maybe
|
||||
// the ad-hocery in the routerdesc parsing too.
|
||||
struct OnionKeyType(u8) {
|
||||
|
|
|
@ -5,5 +5,5 @@ Core implementation for onion services client.
|
|||
This crate creates circuits to onion circuits,
|
||||
retains them for reuse,
|
||||
and hands them out as appropriate.
|
||||
It is also responsibile for maintaining all relevant state
|
||||
It is also responsible for maintaining all relevant state
|
||||
about hidden services, and their descriptors and introduction points.
|
||||
|
|
|
@ -145,7 +145,7 @@ struct IptExperience {
|
|||
///
|
||||
/// This function has a minimum of functionality, since it is the boundary
|
||||
/// between "mock connection, used for testing `state.rs`" and
|
||||
/// "mock circuit and netdir, used for testing `connnect.rs`",
|
||||
/// "mock circuit and netdir, used for testing `connect.rs`",
|
||||
/// so it is not, itself, unit-testable.
|
||||
pub(crate) async fn connect<R: Runtime>(
|
||||
connector: &HsClientConnector<R>,
|
||||
|
@ -170,7 +170,7 @@ pub(crate) async fn connect<R: Runtime>(
|
|||
|
||||
/// Common context for a single request to connect to a hidden service
|
||||
///
|
||||
/// This saves on passing this same set of (immuntable) values (or subsets thereof)
|
||||
/// This saves on passing this same set of (immutable) values (or subsets thereof)
|
||||
/// to each method in the principal functional code, everywhere.
|
||||
/// It also provides a convenient type to be `Self`.
|
||||
///
|
||||
|
@ -216,7 +216,7 @@ struct Rendezvous<'r, R: Runtime, M: MocksForConnect<R>> {
|
|||
/// Receiver that will give us the RENDEZVOUS2 message.
|
||||
///
|
||||
/// The sending ended is owned by the handler
|
||||
/// which receives control messages on the rednezvous circuit,
|
||||
/// which receives control messages on the rendezvous circuit,
|
||||
/// and which was installed when we sent `ESTABLISH_RENDEZVOUS`.
|
||||
///
|
||||
/// (`RENDEZVOUS2` is the message containing the onion service's side of the handshake.)
|
||||
|
@ -245,7 +245,7 @@ struct UsableIntroPt<'i> {
|
|||
sort_rand: IptSortRand,
|
||||
}
|
||||
|
||||
/// Lookup key for looking up and recording our IPT use experiencess
|
||||
/// Lookup key for looking up and recording our IPT use experiences
|
||||
///
|
||||
/// Used to identify a relay when looking to see what happened last time we used it,
|
||||
/// and storing that information after we tried it.
|
||||
|
@ -432,7 +432,7 @@ impl<'c, R: Runtime, M: MocksForConnect<R>> Context<'c, R, M> {
|
|||
/// Does all necessary retries and timeouts.
|
||||
/// Returns an error if no valid descriptor could be found.
|
||||
async fn descriptor_ensure<'d>(&self, data: &'d mut DataHsDesc) -> Result<&'d HsDesc, CE> {
|
||||
// Maxmimum number of hsdir connection and retrieval attempts we'll make
|
||||
// Maximum number of hsdir connection and retrieval attempts we'll make
|
||||
let max_total_attempts = self
|
||||
.config
|
||||
.retry
|
||||
|
@ -622,7 +622,7 @@ impl<'c, R: Runtime, M: MocksForConnect<R>> Context<'c, R, M> {
|
|||
desc: &HsDesc,
|
||||
data: &mut DataIpts,
|
||||
) -> Result<Arc<ClientCirc!(R, M)>, CE> {
|
||||
// Maxmimum number of rendezvous/introduction attempts we'll make
|
||||
// Maximum number of rendezvous/introduction attempts we'll make
|
||||
let max_total_attempts = self
|
||||
.config
|
||||
.retry
|
||||
|
@ -643,7 +643,7 @@ impl<'c, R: Runtime, M: MocksForConnect<R>> Context<'c, R, M> {
|
|||
|
||||
// Limit on the duration of each attempt to negotiate with an introduction point
|
||||
//
|
||||
// *Does* include establishing the ciruit.
|
||||
// *Does* include establishing the circuit.
|
||||
let intro_timeout = self.estimate_timeout(&[
|
||||
(1, TimeoutsAction::BuildCircuit { length: HOPS }), // build circuit
|
||||
// This does some crypto too, but we don't account for that.
|
||||
|
@ -663,7 +663,7 @@ impl<'c, R: Runtime, M: MocksForConnect<R>> Context<'c, R, M> {
|
|||
//
|
||||
// What we are timing here is:
|
||||
//
|
||||
// INTFRODUCE2 goes from IPT to HS
|
||||
// INTRODUCE2 goes from IPT to HS
|
||||
// but that happens in parallel with us waiting for INTRODUCE_ACK,
|
||||
// which is controlled by `intro_timeout` so not pat of `ipt_rpt_timeout`.
|
||||
// and which has to come HOPS hops. So don't count INTRODUCE2 here.
|
||||
|
@ -742,7 +742,7 @@ impl<'c, R: Runtime, M: MocksForConnect<R>> Context<'c, R, M> {
|
|||
// We retain a rendezvous we managed to set up in here. That way if we created it, and
|
||||
// then failed before we actually needed it, we can reuse it.
|
||||
// If we exit with an error, we will waste it - but because we isolate things we do
|
||||
// for different services, it wouldn't be reuseable anway.
|
||||
// for different services, it wouldn't be reusable anyway.
|
||||
let mut saved_rendezvous = None;
|
||||
|
||||
// We might consider making multiple attempts to different IPTs in in parallel,
|
||||
|
|
|
@ -56,7 +56,7 @@ pub enum ConnError {
|
|||
#[error("consensus contains no suitable hidden service directories")]
|
||||
NoHsDirs,
|
||||
|
||||
/// The descriptor contained only unuseable introduction points!
|
||||
/// The descriptor contained only unusable introduction points!
|
||||
///
|
||||
/// This is the fault of the service, or shows incompatibility between us and them.
|
||||
#[error("hidden service has no introduction points usable by us")]
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
// stored, for that HS, outside the keystore. (IIRC C Tor does keep the client auth public keys
|
||||
// for an HS in its keystore, so we need to be compatible with that, but that doesn't necessary
|
||||
// have to be done in Arti via the keystore API. Perhaps the "C Tor keystore" object could
|
||||
// impement both the keystore trait and an "HS client public keys" trait.)
|
||||
// implement both the keystore trait and an "HS client public keys" trait.)
|
||||
//
|
||||
// I should explain why I have this opinion:
|
||||
// Basically, (private) keystores are awkward. They have to handle private key material, deal with
|
||||
|
|
|
@ -58,7 +58,7 @@ pub trait Keystore: Send + Sync + 'static {
|
|||
|
||||
/// Remove the specified key.
|
||||
///
|
||||
/// A return vaue of `Ok(None)` indicates the key doesn't exist in this key store, whereas
|
||||
/// A return value of `Ok(None)` indicates the key doesn't exist in this key store, whereas
|
||||
/// `Ok(Some(())` means the key was successfully removed.
|
||||
///
|
||||
/// Returns `Err` if an error occurred while trying to remove the key.
|
||||
|
|
|
@ -262,7 +262,7 @@ pub enum NetdocErrorKind {
|
|||
#[display(fmt = "unexpected document type")]
|
||||
BadDocumentType,
|
||||
/// We expected a kind of entry that we didn't find
|
||||
#[display(fmt = "missing entriy")]
|
||||
#[display(fmt = "missing entry")]
|
||||
MissingEntry,
|
||||
/// Document or section started with wrong token
|
||||
#[display(fmt = "Wrong starting token")]
|
||||
|
|
|
@ -24,7 +24,7 @@ use crate::Object;
|
|||
///
|
||||
/// Note that the concrete object type `O`
|
||||
/// is *not* represented in the type of `CastTable`;
|
||||
/// `CastTable`s are obtained and used at runtime, as part of dynamic despatch,
|
||||
/// `CastTable`s are obtained and used at runtime, as part of dynamic dispatch,
|
||||
/// so the type `O` is erased. We work with `TypeId`s and various `&dyn ...`.
|
||||
#[derive(Default)]
|
||||
pub struct CastTable {
|
||||
|
|
|
@ -98,7 +98,7 @@ release?" above.
|
|||
couldn't find.
|
||||
|
||||
Run `maint/thanks arti-v${LAST_VERSION}`
|
||||
to generate our list of ackowledgments;
|
||||
to generate our list of acknowledgments;
|
||||
insert this into the changelog.
|
||||
|
||||
Add an acknowledgement for the current sponsor(s).
|
||||
|
@ -152,7 +152,7 @@ before you continue!
|
|||
1. Finalize the changelog.
|
||||
|
||||
Make sure that the date is correct.
|
||||
Make sure that the acknoweldgments and links are correct,
|
||||
Make sure that the acknowledgments and links are correct,
|
||||
if they might have gotten stale.
|
||||
|
||||
2. Increase all appropriate version numbers.
|
||||
|
@ -270,7 +270,7 @@ since the last release.)
|
|||
3. In `.gitlab-ci.yml`,
|
||||
prepend the failing shell command with `true X X X`
|
||||
(only with the three Xs cuddled together).
|
||||
This will cause it to not run, but "succed".
|
||||
This will cause it to not run, but "succeed".
|
||||
The `XXXs` will cause the blocking-todos CI job to fail,
|
||||
hindering accidental merge of this branch to main.
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ So each `FooConfig` needs to be re-exported by `arti-client`, and semver-breakin
|
|||
|
||||
### Discussion
|
||||
|
||||
To make our config loading code reuseable, in everything from a slightly extended version of `arti`, to some entirely different embedding of our Tor, code, we need to separate out:
|
||||
To make our config loading code reusable, in everything from a slightly extended version of `arti`, to some entirely different embedding of our Tor, code, we need to separate out:
|
||||
|
||||
* Code that knows about configuration sources (how to read a file, default locations of files, how to access the command line)
|
||||
|
||||
|
|
|
@ -111,7 +111,7 @@ directories (`root_dir`, `client_dir`, `key_dir`).
|
|||
# The Arti key store.
|
||||
[keys.arti_store]
|
||||
# The root of the key store. All keys are stored somewhere in the `root_dir`
|
||||
# heirarchy
|
||||
# hierarchy
|
||||
root_dir = ""
|
||||
```
|
||||
|
||||
|
@ -152,7 +152,7 @@ key_dir = ""
|
|||
[[onion_service]]
|
||||
# This corresponds to C Tor's HiddenServiceDir option.
|
||||
hs_service_dir = "/home/bob/hs1"
|
||||
# The maximum number of syteams per rendezvous circuit.
|
||||
# The maximum number of streams per rendezvous circuit.
|
||||
#
|
||||
# This corresponds to C Tor's HiddenServiceMaxStreams.
|
||||
max_streams = 0
|
||||
|
@ -163,7 +163,7 @@ max_streams = 0
|
|||
[[onion_service]]
|
||||
# This corresponds to C Tor's HiddenServiceDir option.
|
||||
hs_service_dir = "/home/bob/hs2"
|
||||
# The maximum number of syteams per rendezvous circuit.
|
||||
# The maximum number of streams per rendezvous circuit.
|
||||
#
|
||||
# This corresponds to C Tor's HiddenServiceMaxStreams.
|
||||
max_streams = 9000
|
||||
|
|
|
@ -341,7 +341,7 @@ message
|
|||
: A String providing a short human-readable description of the error.
|
||||
Clients SHOULD NOT rely on any aspect of the format of this String,
|
||||
or do anything with it besides display it to the end user.
|
||||
(This is generated by `tor_error::Report` or equivalant.)
|
||||
(This is generated by `tor_error::Report` or equivalent.)
|
||||
|
||||
kinds
|
||||
: An array of Strings, each
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/env bash
|
||||
#
|
||||
# Run `cargo test` for every crate with the default featues
|
||||
# Run `cargo test` for every crate with the default features
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
|
|
Loading…
Reference in New Issue