mirror of
https://github.com/shadowsocks/shadowsocks-rust.git
synced 2026-11-15 08:15:31 +00:00
120 lines
3.0 KiB
Rust
120 lines
3.0 KiB
Rust
//! shadowsocks is a fast tunnel proxy that helps you bypass firewalls.
|
|
//!
|
|
//! Currently it supports SOCKS5 and HTTP Proxy protocol.
|
|
//!
|
|
//! ## Usage
|
|
//!
|
|
//! Build shadowsocks and you will get at least 2 binaries: `sslocal` and `ssserver`
|
|
//!
|
|
//! Write your servers in a configuration file. Format is defined in
|
|
//! [shadowsocks' documentation](https://github.com/shadowsocks/shadowsocks/wiki)
|
|
//!
|
|
//! For example:
|
|
//!
|
|
//! ```json
|
|
//! {
|
|
//! "server": "my_server_ip",
|
|
//! "server_port": 8388,
|
|
//! "local_address": "127.0.0.1",
|
|
//! "local_port": 1080,
|
|
//! "password": "mypassword",
|
|
//! "timeout": 300,
|
|
//! "method": "aes-256-cfb"
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! Save it in file `shadowsocks.json` and run local proxy server with
|
|
//!
|
|
//! ```bash
|
|
//! cargo run --bin sslocal -- -c shadowsocks.json
|
|
//! ```
|
|
//!
|
|
//! Now you can use SOCKS5 protocol to proxy your requests, for example:
|
|
//!
|
|
//! ```bash
|
|
//! curl --socks5-hostname 127.0.0.1:1080 https://www.google.com
|
|
//! ```
|
|
//!
|
|
//! On the server side, you can run the server with
|
|
//!
|
|
//! ```bash
|
|
//! cargo run --bin ssserver -- -c shadowsocks.json
|
|
//! ```
|
|
//!
|
|
//! Server should use the same configuration file as local, except the listen addresses for servers must be socket
|
|
//! addresses.
|
|
//!
|
|
//! Of course, you can also use `cargo install` to install binaries.
|
|
//!
|
|
//! ## API Usage
|
|
//!
|
|
//! Example to write a local server
|
|
//!
|
|
//! ```no_run
|
|
//! use shadowsocks::{run_local, Config, ConfigType};
|
|
//!
|
|
//! let config = Config::load_from_file("shadowsocks.json", ConfigType::Local).unwrap();
|
|
//! run_local(config).unwrap();
|
|
//! ```
|
|
//!
|
|
//! That's all! And let me show you how to run a proxy server
|
|
//!
|
|
//! ```no_run
|
|
//! use shadowsocks::{run_server, Config, ConfigType};
|
|
//!
|
|
//! let config = Config::load_from_file("shadowsocks.json", ConfigType::Server).unwrap();
|
|
//! run_server(config).unwrap();
|
|
//! ```
|
|
//!
|
|
|
|
#![crate_type = "lib"]
|
|
#![crate_name = "shadowsocks"]
|
|
|
|
extern crate base64;
|
|
extern crate byte_string;
|
|
extern crate byteorder;
|
|
extern crate bytes;
|
|
extern crate digest;
|
|
#[macro_use]
|
|
extern crate futures;
|
|
extern crate futures_cpupool;
|
|
#[macro_use]
|
|
extern crate lazy_static;
|
|
extern crate libc;
|
|
#[cfg(feature = "sodium")]
|
|
extern crate libsodium_ffi;
|
|
#[macro_use]
|
|
extern crate log;
|
|
extern crate md5;
|
|
#[cfg(feature = "miscreant")]
|
|
extern crate miscreant;
|
|
extern crate openssl;
|
|
extern crate rand;
|
|
extern crate ring;
|
|
#[macro_use]
|
|
extern crate scoped_tls;
|
|
extern crate serde_json;
|
|
extern crate serde_urlencoded;
|
|
extern crate subprocess;
|
|
extern crate tokio_core;
|
|
#[macro_use]
|
|
extern crate tokio_io;
|
|
#[cfg(any(unix, windows))]
|
|
extern crate tokio_signal;
|
|
extern crate typenum;
|
|
extern crate url;
|
|
|
|
/// ShadowSocks version
|
|
pub const VERSION: &'static str = env!("CARGO_PKG_VERSION");
|
|
|
|
pub use self::config::{ClientConfig, Config, ConfigType, ServerAddr, ServerConfig};
|
|
pub use self::relay::local::run as run_local;
|
|
pub use self::relay::server::run as run_server;
|
|
pub use self::relay::tcprelay::client::Socks5Client;
|
|
|
|
pub mod config;
|
|
pub mod relay;
|
|
pub mod crypto;
|
|
pub mod plugin;
|
|
mod monitor;
|