//! This is a binary running in the server environment //! //! You have to provide all needed configuration attributes via command line parameters, //! or you could specify a configuration file. The format of configuration file is defined //! in mod `config`. //! //! *It should be notice that the extented configuration file is not suitable for the server //! side.* use std::{net::IpAddr, process, time::Duration}; use clap::{clap_app, Arg}; use futures::future::{self, Either}; use log::info; use tokio::{self, runtime::Builder}; use shadowsocks_service::{ acl::AccessControl, config::{Config, ConfigType, ManagerConfig}, run_server, shadowsocks::{ config::{ManagerAddr, Mode, ServerAddr, ServerConfig}, crypto::v1::{available_ciphers, CipherKind}, plugin::PluginConfig, }, }; #[cfg(feature = "logging")] use self::common::logging; use self::common::{monitor, validator}; mod common; /// shadowsocks version const VERSION: &str = env!("CARGO_PKG_VERSION"); fn main() { let (config, runtime) = { #[allow(unused_mut)] let mut app = clap_app!(shadowsocks => (version: VERSION) (about: "A fast tunnel proxy that helps you bypass firewalls.") (@arg CONFIG: -c --config +takes_value required_unless("SERVER_ADDR") "Shadowsocks configuration file (https://shadowsocks.org/en/config/quick-guide.html)") (@arg BIND_ADDR: -b --("bind-addr") +takes_value {validator::validate_ip_addr} "Bind address, outbound socket will bind this address") (@arg SERVER_ADDR: -s --("server-addr") +takes_value {validator::validate_server_addr} requires[PASSWORD ENCRYPT_METHOD] "Server address") (@arg PASSWORD: -k --password +takes_value requires[SERVER_ADDR] "Server's password") (@arg ENCRYPT_METHOD: -m --("encrypt-method") +takes_value requires[SERVER_ADDR] possible_values(available_ciphers()) "Server's encryption method") (@arg TIMEOUT: --timeout +takes_value {validator::validate_u64} requires[SERVER_ADDR] "Server's timeout seconds for TCP relay") (@arg UDP_ONLY: -u conflicts_with[TCP_AND_UDP] requires[SERVER_ADDR] "Server mode UDP_ONLY") (@arg TCP_AND_UDP: -U requires[SERVER_ADDR] "Server mode TCP_AND_UDP") (@arg PLUGIN: --plugin +takes_value requires[SERVER_ADDR] "SIP003 (https://shadowsocks.org/en/spec/Plugin.html) plugin") (@arg PLUGIN_OPT: --("plugin-opts") +takes_value requires[PLUGIN] "Set SIP003 plugin options") (@arg MANAGER_ADDR: --("manager-addr") +takes_value alias("manager-address") "ShadowSocks Manager (ssmgr) address, could be \"IP:Port\", \"Domain:Port\" or \"/path/to/unix.sock\"") (@arg ACL: --acl +takes_value "Path to ACL (Access Control List)") (@arg DNS: --dns +takes_value "DNS nameservers, formatted like [(tcp|udp)://]host[:port][,host[:port]]..., or unix:///path/to/dns, or predefined keys like \"google\", \"cloudflare\"") (@arg TCP_NO_DELAY: --("tcp-no-delay") !takes_value alias("no-delay") "Set TCP_NODELAY option for socket") (@arg TCP_FAST_OPEN: --("tcp-fast-open") !takes_value alias("fast-open") "Enable TCP Fast Open (TFO)") (@arg TCP_KEEP_ALIVE: --("tcp-keep-alive") +takes_value {validator::validate_u64} "Set TCP keep alive timeout seconds") (@arg UDP_TIMEOUT: --("udp-timeout") +takes_value {validator::validate_u64} "Timeout seconds for UDP relay") (@arg UDP_MAX_ASSOCIATIONS: --("udp-max-associations") +takes_value {validator::validate_u64} "Maximum associations to be kept simultaneously for UDP relay") (@arg INBOUND_SEND_BUFFER_SIZE: --("inbound-send-buffer-size") +takes_value {validator::validate_u32} "Set inbound sockets' SO_SNDBUF option") (@arg INBOUND_RECV_BUFFER_SIZE: --("inbound-recv-buffer-size") +takes_value {validator::validate_u32} "Set inbound sockets' SO_RCVBUF option") (@arg OUTBOUND_SEND_BUFFER_SIZE: --("outbound-send-buffer-size") +takes_value {validator::validate_u32} "Set outbound sockets' SO_SNDBUF option") (@arg OUTBOUND_RECV_BUFFER_SIZE: --("outbound-recv-buffer-size") +takes_value {validator::validate_u32} "Set outbound sockets' SO_RCVBUF option") ); #[cfg(feature = "logging")] { app = clap_app!(@app (app) (@arg VERBOSE: -v ... "Set log level") (@arg LOG_WITHOUT_TIME: --("log-without-time") "Log without datetime prefix") (@arg LOG_CONFIG: --("log-config") +takes_value "log4rs configuration file") ); } #[cfg(unix)] { app = clap_app!(@app (app) (@arg DAEMONIZE: -d --("daemonize") "Daemonize") (@arg DAEMONIZE_PID_PATH: --("daemonize-pid") +takes_value "File path to store daemonized process's PID") ); } #[cfg(all(unix, not(target_os = "android")))] { app = clap_app!(@app (app) (@arg NOFILE: -n --nofile +takes_value "Set RLIMIT_NOFILE with both soft and hard limit") ); } #[cfg(any(target_os = "linux", target_os = "android"))] { app = clap_app!(@app (app) (@arg OUTBOUND_BIND_INTERFACE: --("outbound-bind-interface") +takes_value "Set SO_BINDTODEVICE option for outbound socket") (@arg OUTBOUND_FWMARK: --("outbound-fwmark") +takes_value {validator::validate_u32} "Set SO_MARK option for outbound socket") ); } #[cfg(any(target_os = "macos", target_os = "ios"))] { app = clap_app!(@app (app) (@arg OUTBOUND_BIND_INTERFACE: --("outbound-bind-interface") +takes_value "Set IP_BOUND_IF option for outbound socket") ); } #[cfg(feature = "multi-threaded")] { app = clap_app!(@app (app) (@arg SINGLE_THREADED: --("single-threaded") "Run the program all in one thread") (@arg WORKER_THREADS: --("worker-threads") +takes_value {validator::validate_usize} "Sets the number of worker threads the `Runtime` will use") ); } let matches = app .arg( Arg::with_name("IPV6_FIRST") .short("6") .help("Resolve hostname to IPv6 address first"), ) .get_matches(); #[cfg(feature = "logging")] match matches.value_of("LOG_CONFIG") { Some(path) => { logging::init_with_file(path); } None => { logging::init_with_config("ssserver", &matches); } } let mut config = match matches.value_of("CONFIG") { Some(cpath) => match Config::load_from_file(cpath, ConfigType::Server) { Ok(cfg) => cfg, Err(err) => { eprintln!("loading config \"{}\", {}", cpath, err); process::exit(common::EXIT_CODE_LOAD_CONFIG_FAILURE); } }, None => Config::new(ConfigType::Server), }; if let Some(svr_addr) = matches.value_of("SERVER_ADDR") { let password = matches.value_of("PASSWORD").expect("password"); let method = matches .value_of("ENCRYPT_METHOD") .expect("encrypt-method") .parse::() .expect("encryption method"); let svr_addr = svr_addr.parse::().expect("server-addr"); let timeout = matches .value_of("TIMEOUT") .map(|t| t.parse::().expect("timeout")) .map(Duration::from_secs); let mut sc = ServerConfig::new(svr_addr, password.to_owned(), method); if let Some(timeout) = timeout { sc.set_timeout(timeout); } if let Some(p) = matches.value_of("PLUGIN") { let plugin = PluginConfig { plugin: p.to_owned(), plugin_opts: matches.value_of("PLUGIN_OPT").map(ToOwned::to_owned), plugin_args: Vec::new(), }; sc.set_plugin(plugin); } if matches.is_present("UDP_ONLY") { sc.set_mode(Mode::UdpOnly); } if matches.is_present("TCP_AND_UDP") { sc.set_mode(Mode::TcpAndUdp); } config.server.push(sc); } if let Some(bind_addr) = matches.value_of("BIND_ADDR") { let bind_addr = bind_addr.parse::().expect("bind-addr"); config.local_addr = Some(bind_addr); } if matches.is_present("TCP_NO_DELAY") { config.no_delay = true; } if matches.is_present("TCP_FAST_OPEN") { config.fast_open = true; } if let Some(keep_alive) = matches.value_of("TCP_KEEP_ALIVE") { config.keep_alive = Some(Duration::from_secs( keep_alive .parse::() .expect("`tcp-keep-alive` is expecting an integer"), )); } #[cfg(any(target_os = "linux", target_os = "android"))] if let Some(mark) = matches.value_of("OUTBOUND_FWMARK") { config.outbound_fwmark = Some(mark.parse::().expect("an unsigned integer for `outbound-fwmark`")); } #[cfg(any(target_os = "linux", target_os = "android", target_os = "macos", target_os = "ios"))] if let Some(iface) = matches.value_of("OUTBOUND_BIND_INTERFACE") { config.outbound_bind_interface = Some(iface.to_owned()); } if let Some(m) = matches.value_of("MANAGER_ADDR") { config.manager = Some(ManagerConfig::new(m.parse::().expect("manager address"))); } #[cfg(all(unix, not(target_os = "android")))] if let Some(nofile) = matches.value_of("NOFILE") { config.nofile = Some(nofile.parse::().expect("an unsigned integer for `nofile`")); } if let Some(acl_file) = matches.value_of("ACL") { let acl = match AccessControl::load_from_file(acl_file) { Ok(acl) => acl, Err(err) => { eprintln!("loading ACL \"{}\", {}", acl_file, err); process::exit(common::EXIT_CODE_LOAD_ACL_FAILURE); } }; config.acl = Some(acl); } if let Some(dns) = matches.value_of("DNS") { config.set_dns_formatted(dns).expect("dns"); } if matches.is_present("IPV6_FIRST") { config.ipv6_first = true; } if let Some(udp_timeout) = matches.value_of("UDP_TIMEOUT") { config.udp_timeout = Some(Duration::from_secs(udp_timeout.parse::().expect("udp-timeout"))); } if let Some(udp_max_assoc) = matches.value_of("UDP_MAX_ASSOCIATIONS") { config.udp_max_associations = Some(udp_max_assoc.parse::().expect("udp-max-associations")); } if let Some(bs) = matches.value_of("INBOUND_SEND_BUFFER_SIZE") { config.inbound_send_buffer_size = Some(bs.parse::().expect("inbound-send-buffer-size")); } if let Some(bs) = matches.value_of("INBOUND_RECV_BUFFER_SIZE") { config.inbound_recv_buffer_size = Some(bs.parse::().expect("inbound-recv-buffer-size")); } if let Some(bs) = matches.value_of("OUTBOUND_SEND_BUFFER_SIZE") { config.outbound_send_buffer_size = Some(bs.parse::().expect("outbound-send-buffer-size")); } if let Some(bs) = matches.value_of("OUTBOUND_RECV_BUFFER_SIZE") { config.outbound_recv_buffer_size = Some(bs.parse::().expect("outbound-recv-buffer-size")); } // DONE READING options if config.server.is_empty() { eprintln!( "missing proxy servers, consider specifying it by \ --server-addr, --encrypt-method, --password command line option, \ or configuration file, check more details in https://shadowsocks.org/en/config/quick-guide.html" ); println!("{}", matches.usage()); return; } if let Err(err) = config.check_integrity() { eprintln!("config integrity check failed, {}", err); println!("{}", matches.usage()); return; } #[cfg(unix)] if matches.is_present("DAEMONIZE") { use self::common::daemonize; daemonize::daemonize(matches.value_of("DAEMONIZE_PID_PATH")); } info!("shadowsocks {}", VERSION); #[cfg(feature = "multi-threaded")] let mut builder = if matches.is_present("SINGLE_THREADED") { Builder::new_current_thread() } else { let mut builder = Builder::new_multi_thread(); if let Some(worker_threads) = matches.value_of("WORKER_THREADS") { builder.worker_threads(worker_threads.parse::().expect("worker-threads")); } builder }; #[cfg(not(feature = "multi-threaded"))] let mut builder = Builder::new_current_thread(); let runtime = builder.enable_all().build().expect("create tokio Runtime"); (config, runtime) }; runtime.block_on(async move { let abort_signal = monitor::create_signal_monitor(); let server = run_server(config); tokio::pin!(abort_signal); tokio::pin!(server); match future::select(server, abort_signal).await { // Server future resolved without an error. This should never happen. Either::Left((Ok(..), ..)) => { eprintln!("server exited unexpectly"); process::exit(common::EXIT_CODE_SERVER_EXIT_UNEXPECTLY); } // Server future resolved with error, which are listener errors in most cases Either::Left((Err(err), ..)) => { eprintln!("server aborted with {}", err); process::exit(common::EXIT_CODE_SERVER_ABORTED); } // The abort signal future resolved. Means we should just exit. Either::Right(_) => (), } }); }