1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
//! Declare an error type for tor_socksproto
use std::borrow::Cow;
use thiserror::Error;
use tor_error::{ErrorKind, HasKind};
/// An error that occurs while negotiating a SOCKS handshake.
#[derive(Clone, Error, Debug)]
#[non_exhaustive]
pub enum Error {
/// The SOCKS client didn't implement SOCKS correctly.
///
/// (Or, more likely, we didn't account for its behavior.)
#[error("SOCKS protocol syntax violation")]
Syntax,
/// Failed to decode a SOCKS message.
#[error("Error decoding SOCKS message")]
Decode(#[from] tor_bytes::Error),
/// The SOCKS client declared a SOCKS version number that isn't
/// one we support.
///
/// In all likelihood, this is somebody trying to use the port for
/// some protocol other than SOCKS.
#[error("Unrecognized SOCKS protocol version {0}")]
BadProtocol(u8),
/// The SOCKS client tried to use a SOCKS feature that we don't
/// support at all.
#[error("SOCKS feature ({0}) not implemented")]
NotImplemented(Cow<'static, str>),
/// Tried to progress the SOCKS handshake when it was already
/// finished. This is a programming error.
#[error("SOCKS handshake was finished; no need to call this again")]
AlreadyFinished(tor_error::Bug),
/// The SOCKS proxy refused our authentication.
#[error("SOCKS Authentication failed")]
AuthRejected,
/// The program (perhaps this module, perhaps Arti, perhaps the caller) is buggy
#[error("Bug while handling SOCKS handshake")]
Bug(#[from] tor_error::Bug),
}
// Note: at present, tor-socksproto isn't used in any settings where ErrorKind
// is used. This is provided for future-proofing, since someday we'll want to
// have SOCKS protocol support internally as well as in the `arti` proxy.
impl HasKind for Error {
fn kind(&self) -> ErrorKind {
use Error as E;
use ErrorKind as EK;
match self {
E::Decode(tor_bytes::Error::Truncated) => {
// This variant should always get converted before a user can
// see it.
EK::Internal
}
E::Syntax | E::Decode(_) | E::BadProtocol(_) => EK::LocalProtocolViolation,
E::NotImplemented(_) => EK::NotImplemented,
E::AuthRejected => EK::LocalProtocolViolation,
E::AlreadyFinished(e) => e.kind(),
E::Bug(e) => e.kind(),
}
}
}