summaryrefslogtreecommitdiff
path: root/crates/tor-socksproto
Commit message (Collapse)AuthorAgeFilesLines
* Bump all arti*, tor* crates to 0.2.0Nick Mathewson2022-04-011-3/+3
| | | | | | | | Not all of these strictly need to be bumped to 0.2.0; many could go to 0.1.1 instead. But since everything at the tor-rtcompat and higher layers has had breaking API changes, it seems not so useful to distinguish. (It seems unlikely that anybody at this stage is depending on e.g. tor-protover but not arti-client.)
* Merge branch 'clippy-allow-arc-clone' into 'main'Nick Mathewson2022-03-011-1/+0
|\ | | | | | | | | Disable clippy::clone_on_ref_ptr See merge request tpo/core/arti!352
| * Disable clippy::clone_on_ref_ptrIan Jackson2022-02-241-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lint is IMO inherently ill-conceived. I have looked for the reasons why this might be thought to be a good idea and there were basically two (and they are sort of contradictory): I. "Calling ‘.clone()` on an Rc, Arc, or Weak can obscure the fact that only the pointer is being cloned, not the underlying data." This is the wording from https://rust-lang.github.io/rust-clippy/v0.0.212/#clone_on_ref_ptr It is a bit terse; we are left to infer why it is a bad idea to obscure this fact. It seems to me that if it is bad to obscure some fact, that must be because the fact is a hazard. But why would it be a hazard to not copy the underlying data ? In other languages, faliing to copy the underlying data is a serious correctness hazard. There is a whose class of bugs where things were not copied, and then mutated and/or reused in multiple places in ways that were not what the programmer intended. In my experience, this is a very common bug when writing Python and Javascript. I'm told it's common in golang too. But in Rust this bug is much much harder to write. The data inside an Arc is immutable. To have this bug you'd have use interior mutability - ie mess around with Mutex or RefCell. That provides a good barrier to these kind of accidents. II. "The reason for writing Rc::clone and Arc::clone [is] to make it clear that only the pointer is being cloned, as opposed to the underlying data. The former is always fast, while the latter can be very expensive depending on what is being cloned." This is the reasoning found here https://github.com/rust-lang/rust-clippy/issues/2048 This is saying that *not* using Arc::clone is hazardous. Specifically, that a deep clone is a performance hazard. But for this argument, the lint is precisely backwards. It's linting the "good" case and asking for it to be written in a more explicit way; while the supposedly bad case can be written conveniently. Also, many objects (in our codebase, and in all the libraries we use) that are Clone are in fact simply handles. They contain Arc(s) (or similar) and are cheap to clone. Indeed, that is the usual case. It does not make sense to distinguish in the syntax we use to clone such a handle, whether the handle is a transparent Arc, or an opaque struct containing one or more other handles. Forcing Arc::clone to be written as such makes for code churn when a type is changed from Arc<Something> to Something: Clone, or vice versa.
* | Bump all crates to 0.1.0arti-v0.1.0Nick Mathewson2022-03-011-4/+4
|/
* tor-socksproto: Use bad_api_usage! rather than ad-hoc Invalid errorIan Jackson2022-02-152-8/+3
|
* Make Bug from InternalError, add bad_api_usage! and into_bad_api_usage!Ian Jackson2022-02-151-6/+6
| | | | Including supporting machinery, new kind field, etc.
* New name and semantics for BadAPIUsage (was BadArgument)Ian Jackson2022-02-151-1/+3
|
* Merge branch 'error-socksproto-autoconvert' into 'main'Nick Mathewson2022-02-142-14/+7
|\ | | | | | | | | Provide, and use From impl for InternalError See merge request tpo/core/arti!315
| * Run rustfmt.Nick Mathewson2022-02-141-12/+5
| |
| * Provide, and use From impl for InternalErrorIan Jackson2022-02-142-8/+8
| | | | | | | | | | | | | | | | Adding this autoconversion is quite safe since every error generation site is explicit and has its own context, and we don't really need to add more. This simplifies the code and will simplify future work.
* | Merge branch 'warn_not_deny' into 'main'eta2022-02-141-1/+1
|\ \ | | | | | | | | | | | | | | | | | | Change deny(clippy::all) to warn(clippy::all). Closes #338 See merge request tpo/core/arti!306
| * | Change deny(clippy::all) to warn(clippy::all).Nick Mathewson2022-02-141-1/+1
| |/ | | | | | | Closes #338.
* | Merge remote-tracking branch 'origin/mr/313'Nick Mathewson2022-02-141-2/+2
|\ \
| * | tor_socksproto::Error HasKind fix two delegationsIan Jackson2022-02-141-2/+2
| |/ | | | | | | | | | | | | | | | | | | We should not generally explicitly specify a kind for errors which contain a more detailed error which itself has a kind. Stating the kind literally is a latent bug, which becomes a real bug if the contained type's kind changes or starts to vary. (There may be exceptions to this principle but this isn't one of them.)
* | Merge branch 'error-kind-protocol' into 'main'Ian Jackson2022-02-141-1/+1
|\ \ | | | | | | | | | | | | Split up ErrorKind::ProtocolViolation See merge request tpo/core/arti!312
| * | Split up ErrorKind::ProtocolViolationIan Jackson2022-02-141-1/+1
| |/
* | ErrorKind::NotImplemented: fix two testsIan Jackson2022-02-142-2/+2
| |
* | Split up ErrorKind::NoSupportIan Jackson2022-02-143-6/+6
|/
* socksproto: fix one more error type.Nick Mathewson2022-02-111-1/+1
|
* socksproto: Simplify Truncated handlingNick Mathewson2022-02-112-20/+14
| | | | | | | | | | | | | Refactor the Error type to remove the yucky internal hidden Truncated variant. Instead, there's now an embedded tor_bytes::Error value. If that tor_bytes::Error is Truncated, we bubble it up when we convert our handshake result to the nested error struct. Thus there is still (sadly) a variant of tor_socksproto::Error that shouldn't be exposed to user code. But refactoring every inner method under handshake.rs seemed like a bad idea: once we're using Result<Result<..>>, the ? operator no longer helps us much.
* Move the Truncated error into tor-errors.Nick Mathewson2022-02-113-19/+5
|
* Try to resolve the "Truncated" error in tor-socksprotoNick Mathewson2022-02-113-47/+63
| | | | | I'm not in love with this solution; the others just seem a bit ugly too.
* tor-socksproto: Implement HasKindNick Mathewson2022-02-113-10/+67
| | | | | (This error isn't yet wrapped in TorError, but it will be eventually when we implement socks proxy and PT support.)
* Bump all crate versions to 0.0.3.Nick Mathewson2022-01-111-3/+3
|
* Minimize the required version for each dependency.Nick Mathewson2022-01-071-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I found these versions empirically, by using the following process: First, I used `cargo tree --depth 1 --kind all` to get a list of every immediate dependency we had. Then, I used `cargo upgrade --workspace package@version` to change each dependency to the earliest version with which (in theory) the current version is semver-compatible. IOW, if the current version was 3.2.3, I picked "3". If the current version was 0.12.8, I picked "0.12". Then, I used `cargo +nightly upgrade -Z minimal-versions` to downgrade Cargo.lock to the minimal listed version for each dependency. (I had to override a few packages; see .gitlab-ci.yml for details). Finally, I repeatedly increased the version of each of our dependencies until our code compiled and the tests passed. Here's what I found that we need: anyhow >= 1.0.5: Earlier versions break our hyper example. async-broadcast >= 0.3.2: Earlier versions fail our tests. async-compression 0.3.5: Earlier versions handled futures and tokio differently. async-trait >= 0.1.2: Earlier versions are too buggy to compile our code. clap 2.33.0: For Arg::default_value_os(). coarsetime >= 0.1.20: exposed as_ticks() function. curve25519-dalek >= 3.2: For is_identity(). generic-array 0.14.3: Earlier versions don't implement From<&[T; 32]> httparse >= 1.2: Earlier versions didn't implement Error. itertools at 0.10.1: For at_most_once. rusqlite >= 0.26.3: for backward compatibility with older rustc. serde 1.0.103: Older versions break our code. serde_json >= 1.0.50: Since we need its Value type to implement Eq. shellexpand >= 2.1: To avoid a broken dirs crate version. tokio >= 1.4: For Handle::block_on(). tracing >= 0.1.18: Previously, tracing_core and tracing had separate LevelFilter types. typenum >= 1.12: Compatibility with rust-crypto crates x25519-dalek >= 1.2.0: For was_contributory(). Closes #275.
* extend lints to include 'clippy::all'Daniel Eades2021-12-281-0/+1
|
* Idle hacking to get tor-socksproto line coverage over 90%Nick Mathewson2021-12-021-1/+1
| | | | This was just a matter of adding a call to one function.
* Bump every crate by one patch version.Nick Mathewson2021-11-291-3/+3
|
* add semicolons if nothing returnedDaniel Eades2021-11-251-0/+1
|
* Bump all crate versions to 0.0.1Nick Mathewson2021-10-291-3/+3
|
* enable checked_conversions lint.Nick Mathewson2021-10-091-0/+1
|
* fix/silence clippy lints in test modulesDaniel Eades2021-09-082-2/+4
|
* Update corpus and links.Nick Mathewson2021-09-071-1/+1
|
* Move all crates into a `crates` subdirectory.Nick Mathewson2021-08-2710-0/+1143
This will cause some pain for now, but now is really the best time to do this kind of thing.