Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
ss5(1)			     General Commands Manual			  ss5(1)

NAME
     ss5  -  A	daemon	that  implements the SOCKS v4 and v5 protocol to execute
	      proxy requests for a client

SYNOPSIS
     ss5 [options]

DESCRIPTION
     ss5 is a socks server that implements the SOCKS v4 and v5	protocol.  As  a
     proxy  server,  ss5 authenticates, profiles  and processes network requests
     for clients. It establishes connections to application hosts for client ap-
     plications. When the client attempts to access the network, the client con-
     nects to the ss5 daemon instead of the application host.

     Following authentication, clients request that ss5 perform network  activi-
     ties for the client. The activities might include:

	 CONNECT

	 BIND

	 UDP ASSOCIATE

     The  ss5  protocol  is independent of application protocols, and can assist
     with different networking services, including telnet, ftp,  finger,  whois,
     gopher, and WWW access.

     The ss5 daemon supports one authentication method:

	Username/Password -  Refer to ss5.passwd(5) or ss5.pam(5) for additional
			     information.

	The ss5 daemon supports two profiling methods:

	   File -  Refer to ss5.conf(5) for additional information.

				Ldap  -  Refer to ss5.conf(5) for additional in-
				formation.

	ss5 can run:

	   standalone -  the default

	   prefork processes -	include the -n option (not supported in threaded
	   mode)

	   threaded   -  if your operating system supports  POSIX  threads.  In-
			 clude the -t option to run ss5 in threaded mode.

OPTIONS
     Separate multiple options with white space.

     -b [host:port]|
	    host:port  specifies  the  host  and the port number on that host on
	    which ss5 runs, instead of the default port. When you omit host, ss5
	    uses 0.0.0.0 as the host value.

     -n  val
	    Run multiple instances of ss5. -n option control the number  of  in-
	    stances.

     -t     Run  ss5  in  threaded mode, if your operating system supports POSIX
	    threads.

     -u  val
	    Run ss5 with the specified user name.

     -v     Print a message containing the current ss5 version.

     -s     Use syslog instead of ss5.log log file.

     -c     Run syntax check for config file

     -m     Disable logging

VARIABLES
     To set the variables in the configuration file, use the syntax:

	  set variable [value]

     SS5_DNSORDER
	    order domain name answers for implementing failover.

     SS5_STIMEOUT val
	    val specifies the idle time in seconds, before closing a  connection
	    (0 for infinite).

     SS5_VERBOSE
	    enable verbose output to logfile.

     SS5_CONSOLE
	    enable web console.

     SS5_SRV
	    enable server manager command line tool.

     SS5_DEBUG
	    enable debug output to logfile.

     SS5_SYSLOG_FACILITY
	    set syslog facility

     SS5_SYSLOG_LEVEL
	    set syslog level

     SS5_PAM_AUTH
	    enable PAM authentication

     SS5_AUTHCACHEAGE
	    enable user authentication caching and set cache age

     SS5_AUTHOCACHEAGE
	    enable user authorization caching and set cache age

     SS5_LDAP_TIMEOUT
	    set timeout for ldap query for profiling

     SS5_LDAP_BASE
	    set  BASE  method for profiling (see PROFILING section in configura-
	    tion file)

     SS5_LDAP_FILTER
	    set FILTER method for profiling (see PROFILING section in configura-
	    tion file)

     set SS5_RADIUS_AUTH
	    enable RADIUS authentication

     SS5_RADIUS_INTERIM_INT
	    set interval beetwen interim update packet

     SS5_RADIUS_INTERIM_TIMEOUT
	    set interim response timeout

     SS5_STICKY_SESSION
	    set session feature for balanced connections. SS5  mantain	affinity
	    session between source client and destination server

     SS5_STICKYAGE
	    set expiration time for session affinity (in seconds)

     SS5_NETBIOS_DOMAIN
	    enable  netbios  domain  mapping with directory store, during autho-
	    rization process

     SS5_PROCESSLIFE
	    set number of requests ss5 process can  serv  before  closing  (only
	    preforked mode)

     SS5_SUPAKEY
	    set    SUPA    secret    key    (default	SS5_SERVER_S_KEY).   See
	    http://csocks.altervista.org

     SS5_ICACHESERVER
	    set internet address of ICP server

     SS5_GSS_PRINC
	    set gss service principal

ENVIRONMENT
     SS5_SOCKS_USER
	    sets the effective user ID of the ss5 process

     SS5_SOCKS_PORT
	    sets listen port

     SS5_SOCKS_ADDR
	    sets listen address

     SS5_CONFIG_FILE
	    sets absolute pathname of ss5 config file

     SS5_PASSWORD_FILE
	    sets absolute pathname of ss5 password file

     SS5_PROPAGATE_KEY
	    sets key value for configuration replica

     SS5_ROLE_SLAVE
	    sets role to slave to accept replica from master (default  value  is
	    ALONE)

     SS5_LOG_FILE
	    sets absolute pathname of ss5 log file

     SS5_PROFILE_PATH
	    sets absolute path of ss5 profile files

     SS5_LIB_PATH
	    sets absolute path of ss5 modules

REQUEST FOR COMMENTS
     RFC1928
	    SOCKS protocol Version 5

     RFC1929
	    Username/Password Authentication for SOCKS V5

     SEE ALSO
	    ss5(1),   ss5.conf(5),  ss5.pam(5),  ss5.passwd(5),  ss5.ha(5),
	    ss5srv(1), ss5_supa(5), ss5_gssapi(5)

AUTHOR
	 Matteo Ricchetti

     Send comments to matteo.ricchetti@libero.it

				   20 Jan 2009				  ss5(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ss5&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help