29 releases
0.8.0-alpha.5 | Oct 18, 2023 |
---|---|
0.8.0-alpha.4 | Feb 9, 2023 |
0.7.0 | Oct 29, 2022 |
0.5.0-alpha.5 | Mar 3, 2022 |
0.1.2 | Mar 2, 2021 |
#16 in #forwarding
32 downloads per month
390KB
10K
SLoC
SNOCAT-CLI
Streaming Network Overlay Connection Arbitration Tunnel
snocat-cli
is a command-line tool for TCP reverse
tunnelling over the QUIC protocol.
It allows small-scale port redirection akin to SSH Remote Forwarding.
Usage
Launching a server:
snocat-cli server \
--cert $SERVER_CERT_PUB_PEM \
--key $SERVER_CERT_PRIV_PEM \
--quic 127.0.0.1:9090 \
--ports 8080:8090
Binding to a server:
snocat-cli client \
--authority $AUTHORITY_CERT_PUB_PEM
--driver localhost:9090 \
--target $TARGET \
--san localhost
Certificate Generation
As QUIC
requires a certificate to operate, snocat-cli
includes a
tool for self-signed certificate generation, which- while intended for development,
can also be used in production when full WebPKI
is unnecessary for your use-case.
See snocat-cli cert --help
for self-signed certificate generation instructions.
snocat-cli
does not use the system certificate registry to verify certificates,
and only uses the certificate you provide as the authority.
Note that the authority can be a chain, with sequence of signers showing that the server's chosen cert is trusted by the given authority.
For anything beyond this tool's scope, openssl
is the de facto solution for
certificate generation and management. snocat-cli
operates on PEM
certificates.
Development
For debug usage, SSLKEYLOGFILE
and RUST_LOG
parameters are supported.
SSLKEYLOGFILE
allows interception with Wireshark
TLS Decryption and QUIC dissection.
For example usage, snocat-cli
debugging is often performed with a command-line such as the following:
SSLKEYLOGFILE=~/keylog.ssl.txt RUST_LOG="trace,quinn=warn,quinn_proto=warn" \
cargo run -- client --authority $SERVER_CERT \
--driver localhost:9090 \
--target $TARGET \
--san localhost
See CONTRIBUTING.md in the official project repository for further development and contribution guidance.
Third-Party Dependencies
Primary crates used include the Tokio stack and futures-rs for async-await capabilities, Quinn for its QUIC implementation.
Various other dependencies are included under their respective licenses, and may be found in Cargo.toml.
Notable exceptions from MIT or MIT OR Apache 2.0 licensing in dependencies are the following crates:
ring
for TLS, distributed under a BoringSSL-variant, ISC-style permissive licenseuntrusted
required byring
for parsing of TLS, distributed under an ISC-style permissive licensewebpki
for TLS WebPKI certificate handling, distributed under an ISC-style permissive licensememchr
,byteorder
,regex-automata
are licensed under Unlicense OR MITprost
,prost-types
,prost-derive
, andprost-build
, licensed solely under the Apache-2.0 licenseryu
required byserde_json
for floating point parsing from json, licensed under Apache-2.0 OR BSL-1.0
See NOTICE.md for license details of individual crates, and links to their project webpages.
Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Under the Contributor License Agreement, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~22–34MB
~611K SLoC