1
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
2
#![doc = include_str!("../README.md")]
3
// @@ begin lint list maintained by maint/add_warning @@
4
#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)
5
#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
6
#![warn(missing_docs)]
7
#![warn(noop_method_call)]
8
#![warn(unreachable_pub)]
9
#![warn(clippy::all)]
10
#![deny(clippy::await_holding_lock)]
11
#![deny(clippy::cargo_common_metadata)]
12
#![deny(clippy::cast_lossless)]
13
#![deny(clippy::checked_conversions)]
14
#![warn(clippy::cognitive_complexity)]
15
#![deny(clippy::debug_assert_with_mut_call)]
16
#![deny(clippy::exhaustive_enums)]
17
#![deny(clippy::exhaustive_structs)]
18
#![deny(clippy::expl_impl_clone_on_copy)]
19
#![deny(clippy::fallible_impl_from)]
20
#![deny(clippy::implicit_clone)]
21
#![deny(clippy::large_stack_arrays)]
22
#![warn(clippy::manual_ok_or)]
23
#![deny(clippy::missing_docs_in_private_items)]
24
#![warn(clippy::needless_borrow)]
25
#![warn(clippy::needless_pass_by_value)]
26
#![warn(clippy::option_option)]
27
#![deny(clippy::print_stderr)]
28
#![deny(clippy::print_stdout)]
29
#![warn(clippy::rc_buffer)]
30
#![deny(clippy::ref_option_ref)]
31
#![warn(clippy::semicolon_if_nothing_returned)]
32
#![warn(clippy::trait_duplication_in_bounds)]
33
#![deny(clippy::unchecked_duration_subtraction)]
34
#![deny(clippy::unnecessary_wraps)]
35
#![warn(clippy::unseparated_literal_suffix)]
36
#![deny(clippy::unwrap_used)]
37
#![deny(clippy::mod_module_files)]
38
#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
39
#![allow(clippy::uninlined_format_args)]
40
#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
41
#![allow(clippy::result_large_err)] // temporary workaround for arti#587
42
#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
43
#![allow(clippy::needless_lifetimes)] // See arti#1765
44
//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
45

            
46
use derive_more::Display;
47

            
48
mod internal;
49
pub use internal::*;
50

            
51
mod report;
52
pub use report::*;
53

            
54
mod retriable;
55
pub use retriable::*;
56

            
57
mod misc;
58
pub use misc::*;
59

            
60
#[cfg(feature = "tracing")]
61
pub mod tracing;
62

            
63
/// Classification of an error arising from Arti's Tor operations
64
///
65
/// This `ErrorKind` should suffice for programmatic handling by most applications embedding Arti:
66
/// get the kind via [`HasKind::kind`] and compare it to the expected value(s) with equality
67
/// or by matching.
68
///
69
/// When forwarding or reporting errors, use the whole error (e.g., `TorError`), not just the kind:
70
/// the error itself will contain more detail and context which is useful to humans.
71
//
72
// Splitting vs lumping guidelines:
73
//
74
// # Split on the place which caused the error
75
//
76
// Every ErrorKind should generally have an associated "location" in
77
// which it occurred.  If a problem can happen in two different
78
// "locations", it should have two different ErrorKinds.  (This goal
79
// may be frustrated sometimes by difficulty in determining where exactly
80
// a given error occurred.)
81
//
82
// The location of an ErrorKind should always be clear from its name.  If is not
83
// clear, add a location-related word to the name of the ErrorKind.
84
//
85
// For the purposes of this discussion, the following locations exist:
86
//   - Process:  Our code, or the application code using it.  These errors don't
87
//     usually need a special prefix.
88
//   - Host: A problem with our local computing  environment.  These errors
89
//     usually reflect trying to run under impossible circumstances (no file
90
//     system, no permissions, etc).
91
//   - Local: Another process on the same machine, or on the network between us
92
//     and the Tor network.  Errors in this location often indicate an outage,
93
//     misconfiguration, or a censorship event.
94
//   - Tor: Anywhere within the Tor network, or connections between Tor relays.
95
//     The words "Exit" and "Relay" also indicate this location.
96
//   - Remote: Anywhere _beyond_ the Tor exit. Can be a problem in the Tor
97
//     exit's connection to the real internet,  or with the remote host that the
98
//     exit is talking to.  (This kind of error can also indicate that the exit
99
//     is lying.)
100
//
101
// ## Lump any locations more fine-grained than that.
102
//
103
// We do not split locations more finely unless there's a good reason to do so.
104
// For example, we don't typically split errors within the "Tor" location based
105
// on whether they happened at a guard, a directory, or an exit.  (Errors with
106
// "Exit" or "Guard" in their names are okay, so long as that kind of error can
107
// _only_ occur at an Exit or Guard.)
108
//
109
// # Split based on reasonable response and semantics
110
//
111
// We also should split ErrorKinds based on what it's reasonable for the
112
// receiver to do with them.  Users may find more applications for our errors
113
// than we do, so we shouldn't assume that we can predict every reasonable use
114
// in advance.
115
//
116
// ErrorKinds should be more specific than just the locations in which they
117
// happen: for example, there shouldn't be a `TorNetworkError` or
118
// a `RemoteFailure`.
119
//
120
// # Avoid exposing implementation details
121
//
122
// ErrorKinds should not relate to particular code paths in the Arti codebase.
123

            
124
#[derive(Debug, Clone, Copy, PartialEq, Eq, Display)]
125
#[non_exhaustive]
126
pub enum ErrorKind {
127
    /// Error connecting to the Tor network
128
    ///
129
    /// Perhaps the local network is not working,
130
    /// or perhaps the chosen relay or bridge is not working properly.
131
    /// Not used for errors that occur within the Tor network, or accessing the public
132
    /// internet on the far side of Tor.
133
    #[display("error connecting to Tor")]
134
    TorAccessFailed,
135

            
136
    /// An attempt was made to use a Tor client for something without bootstrapping it first.
137
    #[display("attempted to use unbootstrapped client")]
138
    BootstrapRequired,
139

            
140
    /// Our network directory has expired before we were able to replace it.
141
    ///
142
    /// This kind of error can indicate one of several possible problems:
143
    /// * It can occur if the client used to be on the network, but has been
144
    ///   unable to make directory connections for a while.
145
    /// * It can occur if the client has been suspended or sleeping for a long
146
    ///   time, and has suddenly woken up without having a chance to replace its
147
    ///   network directory.
148
    /// * It can happen if the client has a sudden clock jump.
149
    ///
150
    /// Often, retrying after a minute or so will resolve this issue.
151
    ///
152
    // TODO this is pretty shonky.  "try again after a minute or so", seriously?
153
    //
154
    /// Future versions of Arti may resolve this situation automatically without caller
155
    /// intervention, possibly depending on preferences and API usage, in which case this kind of
156
    /// error will never occur.
157
    //
158
    // TODO: We should distinguish among the actual issues here, and report a
159
    // real bootstrapping problem when it exists.
160
    #[display("network directory is expired.")]
161
    DirectoryExpired,
162

            
163
    /// IO error accessing local persistent state
164
    ///
165
    /// For example, the disk might be full, or there may be a permissions problem.
166
    /// Usually the source will be [`std::io::Error`].
167
    ///
168
    /// Note that this kind of error only applies to problems in your `state_dir`:
169
    /// problems with your cache are another kind.
170
    #[display("could not read/write persistent state")]
171
    PersistentStateAccessFailed,
172

            
173
    /// We could not start up because a local resource is already being used by someone else
174
    ///
175
    /// Local resources include things like listening ports and state lockfiles.
176
    /// (We don't use this error for "out of disk space" and the like.)
177
    ///
178
    /// This can occur when another process
179
    /// (or another caller of Arti APIs)
180
    /// is already running a facility that overlaps with the one being requested.
181
    ///
182
    /// For example,
183
    /// running multiple processes each containing instances of the same hidden service,
184
    /// using the same state directories etc., is not supported.
185
    ///
186
    /// Another example:
187
    /// if Arti is configured to listen on a particular port,
188
    /// but another process on the system is already listening there,
189
    /// the resulting error has kind `LocalResourceAlreadyInUse`.
190
    // Actually, we only currently listen on ports in `arti` so we don't return
191
    // any Rust errors for this situation at all, at the time of writing.
192
    #[display("local resource (port, lockfile, etc.) already in use")]
193
    LocalResourceAlreadyInUse,
194

            
195
    /// We encountered a problem with filesystem permissions.
196
    ///
197
    /// This is likeliest to be caused by permissions on a file or directory
198
    /// being too permissive; the next likeliest cause is that we were unable to
199
    /// check the permissions on the file or directory, or on one of its
200
    /// ancestors.
201
    #[display("problem with filesystem permissions")]
202
    FsPermissions,
203

            
204
    /// Tor client's persistent state has been corrupted
205
    ///
206
    /// This could be because of a bug in the Tor code, or because something
207
    /// else has been messing with the data.
208
    ///
209
    /// This might also occur if the Tor code was upgraded and the new Tor is
210
    /// not compatible.
211
    ///
212
    /// Note that this kind of error only applies to problems in your
213
    /// `state_dir`: problems with your cache are another kind.
214
    #[display("corrupted data in persistent state")]
215
    PersistentStateCorrupted,
216

            
217
    /// Tor client's cache has been corrupted.
218
    ///
219
    /// This could be because of a bug in the Tor code, or because something else has been messing
220
    /// with the data.
221
    ///
222
    /// This might also occur if the Tor code was upgraded and the new Tor is not compatible.
223
    ///
224
    /// Note that this kind of error only applies to problems in your `cache_dir`:
225
    /// problems with your persistent state are another kind.
226
    #[display("corrupted data in cache")]
227
    CacheCorrupted,
228

            
229
    /// We had a problem reading or writing to our data cache.
230
    ///
231
    /// This may be a disk error, a file permission error, or similar.
232
    ///
233
    /// Note that this kind of error only applies to problems in your `cache_dir`:
234
    /// problems with your persistent state are another kind.
235
    #[display("cache access problem")]
236
    CacheAccessFailed,
237

            
238
    /// The keystore has been corrupted
239
    ///
240
    /// This could be because of a bug in the Tor code, or because something else has been messing
241
    /// with the data.
242
    ///
243
    /// Note that this kind of error only applies to problems in your `keystore_dir`:
244
    /// problems with your cache or persistent state are another kind.
245
    #[display("corrupted data in keystore")]
246
    KeystoreCorrupted,
247

            
248
    /// IO error accessing keystore
249
    ///
250
    /// For example, the disk might be full, or there may be a permissions problem.
251
    /// The source is typically an [`std::io::Error`].
252
    ///
253
    /// Note that this kind of error only applies to problems in your `keystore_dir`:
254
    /// problems with your cache or persistent state are another kind.
255
    #[display("could not access keystore")]
256
    KeystoreAccessFailed,
257

            
258
    /// Tor client's Rust async reactor is shutting down.
259
    ///
260
    /// This likely indicates that the reactor has encountered a fatal error, or
261
    /// has been told to do a clean shutdown, and it isn't possible to spawn new
262
    /// tasks.
263
    #[display("reactor is shutting down")]
264
    ReactorShuttingDown,
265

            
266
    /// Tor client is shutting down.
267
    ///
268
    /// This likely indicates that the last handle to the `TorClient` has been
269
    /// dropped, and is preventing other operations from completing.
270
    #[display("Tor client is shutting down.")]
271
    ArtiShuttingDown,
272

            
273
    /// An operation failed because we waited too long for an exit to do
274
    /// something.
275
    ///
276
    /// This error can happen if the host you're trying to connect to isn't
277
    /// responding to traffic.
278
    /// It can also happen if an exit, or hidden service, is overloaded, and
279
    /// unable to answer your replies in a timely manner.
280
    ///
281
    /// And it might simply mean that the Tor network itself
282
    /// (including possibly relays, or hidden service introduction or rendezvous points)
283
    /// is not working properly
284
    ///
285
    /// In either case, trying later, or on a different circuit, might help.
286
    //
287
    // TODO: Say that this is distinct from the case where the exit _tells you_
288
    // that there is a timeout.
289
    #[display("operation timed out at exit")]
290
    RemoteNetworkTimeout,
291

            
292
    /// One or more configuration values were invalid or incompatible.
293
    ///
294
    /// This kind of error can happen if the user provides an invalid or badly
295
    /// formatted configuration file, if some of the options in that file are
296
    /// out of their ranges or unparsable, or if the options are not all
297
    /// compatible with one another. It can also happen if configuration options
298
    /// provided via APIs are out of range.
299
    ///
300
    /// If this occurs because of user configuration, it's probably best to tell
301
    /// the user about the error. If it occurs because of API usage, it's
302
    /// probably best to fix the code that causes the error.
303
    #[display("invalid configuration")]
304
    InvalidConfig,
305

            
306
    /// Tried to change the configuration of a running Arti service in a way
307
    /// that isn't supported.
308
    ///
309
    /// This kind of error can happen when you call a `reconfigure()` method on
310
    /// a service (or part of a service) and the new configuration is not
311
    /// compatible with the previous configuration.
312
    ///
313
    /// The only available remedy is to tear down the service and make a fresh
314
    /// one (for example, by making a new `TorClient`).
315
    #[display("invalid configuration transition")]
316
    InvalidConfigTransition,
317

            
318
    /// Tried to look up a directory depending on the user's home directory, but
319
    /// the user's home directory isn't set or can't be found.
320
    ///
321
    /// This kind of error can also occur if we're running in an environment
322
    /// where users don't have home directories.
323
    ///
324
    /// To resolve this kind of error, either move to an OS with home
325
    /// directories, or make sure that all paths in the configuration are set
326
    /// explicitly, and do not depend on any path variables.
327
    #[display("could not find a home directory")]
328
    NoHomeDirectory,
329

            
330
    /// A requested operation was not implemented by Arti.
331
    ///
332
    /// This kind of error can happen when requesting a piece of protocol
333
    /// functionality that has not (yet) been implemented in the Arti project.
334
    ///
335
    /// If it happens as a result of a user activity, it's fine to ignore, log,
336
    /// or report the error. If it happens as a result of direct API usage, it
337
    /// may indicate that you're using something that isn't implemented yet.
338
    ///
339
    /// This kind can relate both to operations which we plan to implement, and
340
    /// to operations which we do not.  It does not relate to facilities which
341
    /// are disabled (e.g. at build time) or harmful.
342
    ///
343
    /// It can refer to facilities which were once implemented in Tor or Arti
344
    /// but for which support has been removed.
345
    #[display("operation not implemented")]
346
    NotImplemented,
347

            
348
    /// A feature was requested which has been disabled in this build of Arti.
349
    ///
350
    /// This kind of error happens when the running Arti was built without the
351
    /// appropriate feature (usually, cargo feature) enabled.
352
    ///
353
    /// This might indicate that the overall running system has been
354
    /// mis-configured at build-time.  Alternatively, it can occur if the
355
    /// running system is deliberately stripped down, in which case it might be
356
    /// reasonable to simply report this error to a user.
357
    #[display("operation not supported because Arti feature disabled")]
358
    FeatureDisabled,
359

            
360
    /// Someone or something local violated a network protocol.
361
    ///
362
    /// This kind of error can happen when a local program accessing us over some
363
    /// other protocol violates the protocol's requirements.
364
    ///
365
    /// This usually indicates a programming error: either in that program's
366
    /// implementation of the protocol, or in ours.  In any case, the problem
367
    /// is with software on the local system (or otherwise sharing a Tor client).
368
    ///
369
    /// It might also occur if the local system has an incompatible combination
370
    /// of tools that we can't talk with.
371
    ///
372
    /// This error kind does *not* include situations that are better explained
373
    /// by a local program simply crashing or terminating unexpectedly.
374
    #[display("local protocol violation (local bug or incompatibility)")]
375
    LocalProtocolViolation,
376

            
377
    /// Someone or something on the Tor network violated the Tor protocols.
378
    ///
379
    /// This kind of error can happen when a remote Tor instance behaves in a
380
    /// way we don't expect.
381
    ///
382
    /// It usually indicates a programming error: either in their implementation
383
    /// of the protocol, or in ours.  It can also indicate an attempted attack,
384
    /// though that can be hard to diagnose.
385
    #[display("Tor network protocol violation (bug, incompatibility, or attack)")]
386
    TorProtocolViolation,
387

            
388
    /// Something went wrong with a network connection or the local network.
389
    ///
390
    /// This kind of error is usually safe to retry, and shouldn't typically be
391
    /// seen.  By the time it reaches the caller, a more specific error type
392
    /// should typically be available.
393
    #[display("problem with network or connection")]
394
    LocalNetworkError,
395

            
396
    /// More of a local resource was needed, than is available (or than we are allowed)
397
    ///
398
    /// For example, we tried to use more memory than permitted by our memory quota.
399
    #[display("local resource exhausted")]
400
    LocalResourceExhausted,
401

            
402
    /// A problem occurred when launching or communicating with an external
403
    /// process running on this computer.
404
    #[display("an externally launched plug-in tool failed")]
405
    ExternalToolFailed,
406

            
407
    /// A relay had an identity other than the one we expected.
408
    ///
409
    /// This could indicate a MITM attack, but more likely indicates that the
410
    /// relay has changed its identity but the new identity hasn't propagated
411
    /// through the directory system yet.
412
    #[display("identity mismatch")]
413
    RelayIdMismatch,
414

            
415
    /// An attempt to do something remotely through the Tor network failed
416
    /// because the circuit it was using shut down before the operation could
417
    /// finish.
418
    #[display("circuit collapsed")]
419
    CircuitCollapse,
420

            
421
    /// An operation timed out on the tor network.
422
    ///
423
    /// This may indicate a network problem, either with the local network
424
    /// environment's ability to contact the Tor network, or with the Tor
425
    /// network itself.
426
    #[display("tor operation timed out")]
427
    TorNetworkTimeout,
428

            
429
    /// We tried but failed to download a piece of directory information.
430
    ///
431
    /// This is a lower-level kind of error; in general it should be retried
432
    /// before the user can see it.   In the future it is likely to be split
433
    /// into several other kinds.
434
    // TODO ^
435
    #[display("directory fetch attempt failed")]
436
    TorDirectoryError,
437

            
438
    /// An operation finished because a remote stream was closed successfully.
439
    ///
440
    /// This can indicate that the target server closed the TCP connection,
441
    /// or that the exit told us that it closed the TCP connection.
442
    /// Callers should generally treat this like a closed TCP connection.
443
    #[display("remote stream closed")]
444
    RemoteStreamClosed,
445

            
446
    /// An operation finished because the remote stream was closed abruptly.
447
    ///
448
    /// This kind of error is analogous to an ECONNRESET error; it indicates
449
    /// that the exit reported that the stream was terminated without a clean
450
    /// TCP shutdown.
451
    ///
452
    /// For most purposes, it's fine to treat this kind of error the same as
453
    /// regular unexpected close.
454
    #[display("remote stream reset")]
455
    RemoteStreamReset,
456

            
457
    /// An operation finished because a remote stream was closed unsuccessfully.
458
    ///
459
    /// This indicates that the exit reported some error message for the stream.
460
    ///
461
    /// We only provide this error kind when no more specific kind is available.
462
    #[display("remote stream error")]
463
    RemoteStreamError,
464

            
465
    /// A stream failed, and the exit reports that the remote host refused
466
    /// the connection.
467
    ///
468
    /// This is analogous to an ECONNREFUSED error.
469
    #[display("remote host refused connection")]
470
    RemoteConnectionRefused,
471

            
472
    /// A stream was rejected by the exit relay because of that relay's exit
473
    /// policy.
474
    ///
475
    /// (In Tor, exits have a set of policies declaring which addresses and
476
    /// ports they're willing to connect to.  Clients download only _summaries_
477
    /// of these policies, so it's possible to be surprised by an exit's refusal
478
    /// to connect somewhere.)
479
    #[display("rejected by exit policy")]
480
    ExitPolicyRejected,
481

            
482
    /// An operation failed, and the exit reported that it waited too long for
483
    /// the operation to finish.
484
    ///
485
    /// This kind of error is distinct from `RemoteNetworkTimeout`, which means
486
    /// that _our own_ timeout threshold was violated.
487
    #[display("timeout at exit relay")]
488
    ExitTimeout,
489

            
490
    /// An operation failed, and the exit reported a network failure of some
491
    /// kind.
492
    ///
493
    /// This kind of error can occur for a number of reasons.  If it happens
494
    /// when trying to open a stream, it usually indicates a problem connecting,
495
    /// such as an ENOROUTE error.
496
    #[display("network failure at exit")]
497
    RemoteNetworkFailed,
498

            
499
    /// An operation finished because an exit failed to look up a hostname.
500
    ///
501
    /// Unfortunately, the Tor protocol does not distinguish failure of DNS
502
    /// services ("we couldn't find out if this host exists and what its name is")
503
    /// from confirmed denials ("this is not a hostname").  So this kind
504
    /// conflates both those sorts of error.
505
    ///
506
    /// Trying at another exit might succeed, or the address might truly be
507
    /// unresolvable.
508
    #[display("remote hostname not found")]
509
    RemoteHostNotFound,
510

            
511
    /// The target hidden service (`.onion` service) was not found in the directory
512
    ///
513
    /// We successfully connected to at least one directory server,
514
    /// but it didn't have a record of the hidden service.
515
    ///
516
    /// This probably means that the hidden service is not running, or does not exist.
517
    /// (It might mean that the directory servers are faulty,
518
    /// and that the hidden service was unable to publish its descriptor.)
519
    #[display("Onion Service not found")]
520
    OnionServiceNotFound,
521

            
522
    /// The target hidden service (`.onion` service) seems to be down
523
    ///
524
    /// We successfully obtained a hidden service descriptor for the service,
525
    /// so we know it is supposed to exist,
526
    /// but we weren't able to communicate with it via any of its
527
    /// introduction points.
528
    ///
529
    /// This probably means that the hidden service is not running.
530
    /// (It might mean that the introduction point relays are faulty.)
531
    #[display("Onion Service not running")]
532
    OnionServiceNotRunning,
533

            
534
    /// Protocol trouble involving the target hidden service (`.onion` service)
535
    ///
536
    /// Something unexpected happened when trying to connect to the selected hidden service.
537
    /// It seems to have been due to the hidden service violating the Tor protocols somehow.
538
    #[display("Onion Service protocol failed (apparently due to service behaviour)")]
539
    OnionServiceProtocolViolation,
540

            
541
    /// The target hidden service (`.onion` service) is running but we couldn't connect to it,
542
    /// and we aren't sure whose fault that is
543
    ///
544
    /// This might be due to malfunction on the part of the service,
545
    /// or a relay being used as an introduction point or relay,
546
    /// or failure of the underlying Tor network.
547
    #[display("Onion Service not reachable (due to service, or Tor network, behaviour)")]
548
    OnionServiceConnectionFailed,
549

            
550
    /// We tried to connect to an onion service without authentication,
551
    /// but it apparently requires authentication.
552
    #[display("Onion service required authentication, but none was provided.")]
553
    OnionServiceMissingClientAuth,
554

            
555
    /// We tried to connect to an onion service that requires authentication, and
556
    /// ours is wrong.
557
    ///
558
    /// This likely means that we need to use a different key for talking to
559
    /// this onion service, or that it has revoked our permissions to reach it.
560
    #[display("Onion service required authentication, but provided authentication was incorrect.")]
561
    OnionServiceWrongClientAuth,
562

            
563
    /// We tried to parse a `.onion` address, and found that it was not valid.
564
    ///
565
    /// This likely means that it was corrupted somewhere along its way from its
566
    /// origin to our API surface.  It may be the wrong length, have invalid
567
    /// characters, have an invalid version number, or have an invalid checksum.
568
    #[display(".onion address was invalid.")]
569
    OnionServiceAddressInvalid,
570

            
571
    /// An resolve operation finished with an error.
572
    ///
573
    /// Contrary to [`RemoteHostNotFound`](ErrorKind::RemoteHostNotFound),
574
    /// this can't mean "this is not a hostname".
575
    /// This error should be retried.
576
    #[display("remote hostname lookup failure")]
577
    RemoteHostResolutionFailed,
578

            
579
    /// Trouble involving a protocol we're using with a peer on the far side of the Tor network
580
    ///
581
    /// We were using a higher-layer protocol over a Tor connection,
582
    /// and something went wrong.
583
    /// This might be an error reported by the remote host within that higher protocol,
584
    /// or a problem detected locally but relating to that higher protocol.
585
    ///
586
    /// The nature of the problem can vary:
587
    /// examples could include:
588
    /// failure to agree suitable parameters (incompatibility);
589
    /// authentication problems (eg, TLS certificate trouble);
590
    /// protocol violation by the peer;
591
    /// peer refusing to provide service;
592
    /// etc.
593
    #[display("remote protocol violation")]
594
    RemoteProtocolViolation,
595

            
596
    /// An operation failed, and the relay in question reported that it's too
597
    /// busy to answer our request.
598
    #[display("relay too busy")]
599
    RelayTooBusy,
600

            
601
    /// We were asked to make an anonymous connection to a malformed address.
602
    ///
603
    /// This is probably because of a bad input from a user.
604
    #[display("target address was invalid")]
605
    InvalidStreamTarget,
606

            
607
    /// We were asked to make an anonymous connection to a _locally_ disabled
608
    /// address.
609
    ///
610
    /// For example, this kind of error can happen when try to connect to (e.g.)
611
    /// `127.0.0.1` using a client that isn't configured with allow_local_addrs.
612
    ///
613
    /// Usually this means that you intended to reject the request as
614
    /// nonsensical; but if you didn't, it probably means you should change your
615
    /// configuration to allow what you want.
616
    #[display("target address disabled locally")]
617
    ForbiddenStreamTarget,
618

            
619
    /// An operation failed in a transient way.
620
    ///
621
    /// This kind of error indicates that some kind of operation failed in a way
622
    /// where retrying it again could likely have made it work.
623
    ///
624
    /// You should not generally see this kind of error returned directly to you
625
    /// for high-level functions.  It should only be returned from lower-level
626
    /// crates that do not automatically retry these failures.
627
    // Errors with this kind should generally not return a `HasRetryTime::retry_time()` of `Never`.
628
    #[display("un-retried transient failure")]
629
    TransientFailure,
630

            
631
    /// Bug, for example calling a function with an invalid argument.
632
    ///
633
    /// This kind of error is usually a programming mistake on the caller's part.
634
    /// This is usually a bug in code calling Arti, but it might be a bug in Arti itself.
635
    //
636
    // Usually, use `bad_api_usage!` and `into_bad_api_usage!` and thereby `InternalError`,
637
    // rather than inventing a new type with this kind.
638
    //
639
    // Errors with this kind should generally include a stack trace.  They are
640
    // very like InternalError, in that they represent a bug in the program.
641
    // The difference is that an InternalError, with kind `Internal`, represents
642
    // a bug in arti, whereas errors with kind BadArgument represent bugs which
643
    // could be (often, are likely to be) outside arti.
644
    #[display("bad API usage (bug)")]
645
    BadApiUsage,
646

            
647
    /// We asked a relay to create or extend a circuit, and it declined.
648
    ///
649
    /// Either it gave an error message indicating that it refused to perform
650
    /// the request, or the protocol gives it no room to explain what happened.
651
    ///
652
    /// This error is returned by higher-level functions only if it is the most informative
653
    /// error after appropriate retries etc.
654
    #[display("remote host refused our request")]
655
    CircuitRefused,
656

            
657
    /// We were unable to construct a path through the Tor network.
658
    ///
659
    /// Usually this indicates that there are too many user-supplied
660
    /// restrictions for us to comply with.
661
    ///
662
    /// On test networks, it likely indicates that there aren't enough relays,
663
    /// or that there aren't enough relays in distinct families.
664
    //
665
    // TODO: in the future, errors of this type should distinguish between
666
    // cases where this happens because of a user restriction and cases where it
667
    // happens because of a severely broken directory.
668
    //
669
    // The latter should be classified as TorDirectoryBroken.
670
    #[display("could not construct a path")]
671
    NoPath,
672

            
673
    /// We were unable to find an exit relay with a certain set of desired
674
    /// properties.
675
    ///
676
    /// Usually this indicates that there were too many user-supplied
677
    /// restrictions on the exit for us to comply with, or that there was no
678
    /// exit on the network supporting all of the ports that the user asked for.
679
    //
680
    // TODO: same as for NoPath.
681
    #[display("no exit available for path")]
682
    NoExit,
683

            
684
    /// The Tor consensus directory is broken or unsuitable
685
    ///
686
    /// This could occur when running very old software
687
    /// against the current Tor network,
688
    /// so that the newer network is incompatible.
689
    ///
690
    /// It might also mean a catastrophic failure of the Tor network,
691
    /// or that a deficient test network is in use.
692
    ///
693
    /// Currently some instances of this kind of problem
694
    /// are reported as `NoPath` or `NoExit`.
695
    #[display("Tor network consensus directory is not usable")]
696
    TorDirectoryUnusable,
697

            
698
    /// An operation failed because of _possible_ clock skew.
699
    ///
700
    /// The broken clock may be ours, or it may belong to another party on the
701
    /// network. It's also possible that somebody else is lying about the time,
702
    /// caching documents for far too long, or something like that.
703
    #[display("possible clock skew detected")]
704
    ClockSkew,
705

            
706
    /// Internal error (bug) in Arti.
707
    ///
708
    /// A supposedly impossible problem has arisen.  This indicates a bug in
709
    /// Arti; if the Arti version is relatively recent, please report the bug on
710
    /// our [bug tracker](https://gitlab.torproject.org/tpo/core/arti/-/issues).
711
    #[display("internal error (bug)")]
712
    Internal,
713

            
714
    /// Unclassified error
715
    ///
716
    /// Some other error occurred, which does not fit into any of the other kinds.
717
    ///
718
    /// This kind is provided for use by external code
719
    /// hooking into or replacing parts of Arti.
720
    /// It is never returned by the code in Arti (`arti-*` and `tor-*` crates).
721
    #[display("unclassified error")]
722
    Other,
723
}
724

            
725
/// Errors that can be categorized as belonging to an [`ErrorKind`]
726
///
727
/// The most important implementation of this trait is
728
/// `arti_client::TorError`; however, other internal errors throughout Arti
729
/// also implement it.
730
pub trait HasKind {
731
    /// Return the kind of this error.
732
    fn kind(&self) -> ErrorKind;
733
}
734

            
735
#[cfg(feature = "futures")]
736
impl HasKind for futures::task::SpawnError {
737
69
    fn kind(&self) -> ErrorKind {
738
        use ErrorKind as EK;
739
69
        if self.is_shutdown() {
740
69
            EK::ReactorShuttingDown
741
        } else {
742
            EK::Internal
743
        }
744
69
    }
745
}
746

            
747
impl HasKind for void::Void {
748
    fn kind(&self) -> ErrorKind {
749
        void::unreachable(*self)
750
    }
751
}
752

            
753
impl HasKind for std::convert::Infallible {
754
    fn kind(&self) -> ErrorKind {
755
        unreachable!()
756
    }
757
}
758

            
759
/// Sealed
760
mod sealed {
761
    /// Sealed
762
    pub trait Sealed {}
763
}