File: socksify.1

package info (click to toggle)
dante 1.4.3%2Bdfsg-3.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 12,032 kB
  • sloc: ansic: 60,061; sh: 11,180; yacc: 3,440; lex: 1,821; makefile: 369; awk: 220
file content (148 lines) | stat: -rwxr-xr-x 6,144 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
.\" $Id: socksify.1,v 1.17.4.3 2014/08/15 18:16:40 karls Exp $
.\"
.\" Copyright (c) 2009, 2011, 2012, 2013, 2014
.\"      Inferno Nettverk A/S, Norway.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. The above copyright notice, this list of conditions and the following
.\"    disclaimer must appear in all copies of the software, derivative works
.\"    or modified versions, and any portions thereof, aswell as in all
.\"    supporting documentation.
.\" 2. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed by
.\"      Inferno Nettverk A/S, Norway.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Inferno Nettverk A/S requests users of this software to return to
.\"
.\"  Software Distribution Coordinator  or  sdc@inet.no
.\"  Inferno Nettverk A/S
.\"  Oslo Research Park
.\"  Gaustadallen 21
.\"  NO-0349 Oslo
.\"  Norway
.\"
.\" any improvements or extensions that they make and grant Inferno Nettverk A/S
.\" the rights to redistribute these changes.
.\"
.TH SOCKSIFY 1 "July 6 2013"
.SH NAME
socksify \- runtime socksification of selected programs
.SH DESCRIPTION
The shell script socksify is meant to aid in using socks with
already compiled dynamic binaries.  This works by setting the
LD_PRELOAD environment variable to libdsocks.  It will then attempt
to wrap all networking-related system calls.

When used the script can socksify a program by simply prefixing
the given program and it's arguments with the the socksify script,
like in the example below.

$ socksify ftp ftp.example.org

.SH ENVIRONMENT
The socksify script, and the Dante socks library used by the socksify
script, can interpret several environment variables.
.TP
\fBSOCKS_CONF\fP
Gives the name of the socks.conf file.  Default is /etc/socks.conf, unless
it was changed when compiling the Dante libsocks libraries.

Creating a socks.conf is the recommended way to use socksify, but socksify
can also be used for most simple configurations without any socks.conf
file, as long as the proxy server to use is set in one of the supported
environment variables.
.TP
\fBSOCKS_DEBUG\fP
Enables debug logging.  The value given should be a number, one or up,
indicating the level of debugging provided.
.TP
\fBSOCKS_LOGOUTPUT\fP
This value controls where the client library sends logoutput.  It can
be either \fBsyslog\fP, \fBstdout\fP, \fBstderr\fP, a filename, or
a combination.  The default is nowhere.
.TP
\fBSOCKS_USERNAME\fP
Use the value of \fBSOCKS_USERNAME\fP as the username when doing
username authentication.
.TP
\fBSOCKS_PASSWORD\fP
Use the value of \fBSOCKS_PASSWORD\fP as the password when doing
username authentication.  Not recommended as other users on the system
might be able to see your password.
.TP
\fBSOCKS_SERVER\fP, \fBSOCKS4_SERVER\fP, \fBSOCKS5_SERVER\fP,
These variables allow the address of the server to be specified
without using a socks.conf file.  If a socks.conf-file is present, it is
ignored if any of these variables are set.

The accepted format is <ipaddress>:<port>.
If the \fBSOCKS_SERVER\fP value is set, it indicates the specified server
supports all socks versions supported by Dante.  If if either of the other
two variables are used, they indicate the given socks server supports only
the corresponding socks version, v4 or v5.
Note that if the socks server requires any form of authentication, you
need to use \fBSOCKS5_SERVER\fP, as v4 does not support authentication.
.TP
\fBHTTP_CONNECT_PROXY\fP
This variable can be used to specify the location of a HTTP proxy supporting
the connect request.  The format used to specify a HTTP proxy is
http://<ipaddress>:<port>.
.TP
\fBUPNP_IGD\fP
This variable can be used to specify the location of a UPNP enabled
IGD router.  There are three possible value for this variable: a
full URL, the interface name the router is reachable via, or the value
"broadcast" to search for the IGD on all appropriate interfaces.

.TP
\fINote that if any of the above environment variables, indicating the
\fIproxy server to use are set, the Dante client will not parse the
\fI\fBsocks.conf\fP file.\fP

.TP
\fBSOCKS_AUTOADD_LANROUTES\fP
If this variable is set to "no", the client will not try to auto-add
direct routes for all addresses on the LAN.  The default is to add
them.
.TP
\fBSOCKS_DISABLE_THREADLOCK\fP
If this variable is set, the client will not perform threadlocking.
The default is for the client to attempt to figure out for itself
whether the application to socksify needs threadlocking or not.
.TP
\fBSOCKS_DIRECTROUTE_FALLBACK\fP
If this is set to "yes", the client will fallback to attempting
a direct connection if the proxy route fails.  The default is
is "no".
.SH FILES
.I /etc/socks.conf
.SH AUTHORS
For inferno Nettverk A/S:
   Michael Shuldman
   Karl-Andre' Skevik
.SH SEE ALSO
socks.conf(5), sockd(8), sockd.conf(5)
.Pp
Information about new releases and other related issues can be found
on the
\fBDante\fP
WWW home page: http://www.inet.no/dante/
.SH BUGS
See the accompanying BUGS file.  New ones should be reported to
dante\-bugs@inet.no.