« back to all changes in this revision
Viewing changes to SocksiPy/README
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Ulises Vitulli
- Date: 2011-04-16 23:35:04 UTC
- Revision ID: james.westby@ubuntu.com-20110416233504-j4dulunjoc224vfp
Tags: upstream-0.9.9.534
Import upstream version 0.9.9.534
- files added:
- SocksiPy
- Tor
- icons
- translations
added
removed
SocksiPy/README
1
SocksiPy version 1.00
2
A Python SOCKS module.
3
(C) 2006 Dan-Haim. All rights reserved.
4
See LICENSE file for details.
5
6
7
WHAT IS A SOCKS PROXY?
8
A SOCKS proxy is a proxy server at the TCP level. In other words, it acts as
9
a tunnel, relaying all traffic going through it without modifying it.
10
SOCKS proxies can be used to relay traffic using any network protocol that
11
uses TCP.
12
13
WHAT IS SOCKSIPY?
14
This Python module allows you to create TCP connections through a SOCKS
15
proxy without any special effort.
16
17
PROXY COMPATIBILITY
18
SocksiPy is compatible with three different types of proxies:
19
1. SOCKS Version 4 (Socks4), including the Socks4a extension.
20
2. SOCKS Version 5 (Socks5).
21
3. HTTP Proxies which support tunneling using the CONNECT method.
22
23
SYSTEM REQUIREMENTS
24
Being written in Python, SocksiPy can run on any platform that has a Python
25
interpreter and TCP/IP support.
26
This module has been tested with Python 2.3 and should work with greater versions
27
just as well.
28
29
30
INSTALLATION
31
-------------
32
33
Simply copy the file "socks.py" to your Python's lib/site-packages directory,
34
and you're ready to go.
35
36
37
USAGE
38
------
39
40
First load the socks module with the command:
41
42
>>> import socks
43
>>>
44
45
The socks module provides a class called "socksocket", which is the base to
46
all of the module's functionality.
47
The socksocket object has the same initialization parameters as the normal socket
48
object to ensure maximal compatibility, however it should be noted that socksocket
49
will only function with family being AF_INET and type being SOCK_STREAM.
50
Generally, it is best to initialize the socksocket object with no parameters
51
52
>>> s = socks.socksocket()
53
>>>
54
55
The socksocket object has an interface which is very similiar to socket's (in fact
56
the socksocket class is derived from socket) with a few extra methods.
57
To select the proxy server you would like to use, use the setproxy method, whose
58
syntax is:
59
60
setproxy(proxytype, addr[, port[, rdns[, username[, password]]]])
61
62
Explaination of the parameters:
63
64
proxytype - The type of the proxy server. This can be one of three possible
65
choices: PROXY_TYPE_SOCKS4, PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP for Socks4,
66
Socks5 and HTTP servers respectively.
67
68
addr - The IP address or DNS name of the proxy server.
69
70
port - The port of the proxy server. Defaults to 1080 for socks and 8080 for http.
71
72
rdns - This is a boolean flag than modifies the behavior regarding DNS resolving.
73
If it is set to True, DNS resolving will be preformed remotely, on the server.
74
If it is set to False, DNS resolving will be preformed locally. Please note that
75
setting this to True with Socks4 servers actually use an extension to the protocol,
76
called Socks4a, which may not be supported on all servers (Socks5 and http servers
77
always support DNS). The default is True.
78
79
username - For Socks5 servers, this allows simple username / password authentication
80
with the server. For Socks4 servers, this parameter will be sent as the userid.
81
This parameter is ignored if an HTTP server is being used. If it is not provided,
82
authentication will not be used (servers may accept unauthentication requests).
83
84
password - This parameter is valid only for Socks5 servers and specifies the
85
respective password for the username provided.
86
87
Example of usage:
88
89
>>> s.setproxy(socks.PROXY_TYPE_SOCKS5,"socks.example.com")
90
>>>
91
92
After the setproxy method has been called, simply call the connect method with the
93
traditional parameters to establish a connection through the proxy:
94
95
>>> s.connect(("www.sourceforge.net",80))
96
>>>
97
98
Connection will take a bit longer to allow negotiation with the proxy server.
99
Please note that calling connect without calling setproxy earlier will connect
100
without a proxy (just like a regular socket).
101
102
Errors: Any errors in the connection process will trigger exceptions. The exception
103
may either be generated by the underlying socket layer or may be custom module
104
exceptions, whose details follow:
105
106
class ProxyError - This is a base exception class. It is not raised directly but
107
rather all other exception classes raised by this module are derived from it.
108
This allows an easy way to catch all proxy-related errors.
109
110
class GeneralProxyError - When thrown, it indicates a problem which does not fall
111
into another category. The parameter is a tuple containing an error code and a
112
description of the error, from the following list:
113
1 - invalid data - This error means that unexpected data has been received from
114
the server. The most common reason is that the server specified as the proxy is
115
not really a Socks4/Socks5/HTTP proxy, or maybe the proxy type specified is wrong.
116
4 - bad proxy type - This will be raised if the type of the proxy supplied to the
117
setproxy function was not PROXY_TYPE_SOCKS4/PROXY_TYPE_SOCKS5/PROXY_TYPE_HTTP.
118
5 - bad input - This will be raised if the connect method is called with bad input
119
parameters.
120
121
class Socks5AuthError - This indicates that the connection through a Socks5 server
122
failed due to an authentication problem. The parameter is a tuple containing a
123
code and a description message according to the following list:
124
125
1 - authentication is required - This will happen if you use a Socks5 server which
126
requires authentication without providing a username / password at all.
127
2 - all offered authentication methods were rejected - This will happen if the proxy
128
requires a special authentication method which is not supported by this module.
129
3 - unknown username or invalid password - Self descriptive.
130
131
class Socks5Error - This will be raised for Socks5 errors which are not related to
132
authentication. The parameter is a tuple containing a code and a description of the
133
error, as given by the server. The possible errors, according to the RFC are:
134
135
1 - General SOCKS server failure - If for any reason the proxy server is unable to
136
fulfill your request (internal server error).
137
2 - connection not allowed by ruleset - If the address you're trying to connect to
138
is blacklisted on the server or requires authentication.
139
3 - Network unreachable - The target could not be contacted. A router on the network
140
had replied with a destination net unreachable error.
141
4 - Host unreachable - The target could not be contacted. A router on the network
142
had replied with a destination host unreachable error.
143
5 - Connection refused - The target server has actively refused the connection
144
(the requested port is closed).
145
6 - TTL expired - The TTL value of the SYN packet from the proxy to the target server
146
has expired. This usually means that there are network problems causing the packet
147
to be caught in a router-to-router "ping-pong".
148
7 - Command not supported - The client has issued an invalid command. When using this
149
module, this error should not occur.
150
8 - Address type not supported - The client has provided an invalid address type.
151
When using this module, this error should not occur.
152
153
class Socks4Error - This will be raised for Socks4 errors. The parameter is a tuple
154
containing a code and a description of the error, as given by the server. The
155
possible error, according to the specification are:
156
157
1 - Request rejected or failed - Will be raised in the event of an failure for any
158
reason other then the two mentioned next.
159
2 - request rejected because SOCKS server cannot connect to identd on the client -
160
The Socks server had tried an ident lookup on your computer and has failed. In this
161
case you should run an identd server and/or configure your firewall to allow incoming
162
connections to local port 113 from the remote server.
163
3 - request rejected because the client program and identd report different user-ids -
164
The Socks server had performed an ident lookup on your computer and has received a
165
different userid than the one you have provided. Change your userid (through the
166
username parameter of the setproxy method) to match and try again.
167
168
class HTTPError - This will be raised for HTTP errors. The parameter is a tuple
169
containing the HTTP status code and the description of the server.
170
171
172
After establishing the connection, the object behaves like a standard socket.
173
Call the close method to close the connection.
174
175
In addition to the socksocket class, an additional function worth mentioning is the
176
setdefaultproxy function. The parameters are the same as the setproxy method.
177
This function will set default proxy settings for newly created socksocket objects,
178
in which the proxy settings haven't been changed via the setproxy method.
179
This is quite useful if you wish to force 3rd party modules to use a socks proxy,
180
by overriding the socket object.
181
For example:
182
183
>>> socks.setdefaultproxy(socks.PROXY_TYPE_SOCKS5,"socks.example.com")
184
>>> socket.socket = socks.socksocket
185
>>> urllib.urlopen("http://www.sourceforge.net/")
186
187
188
PROBLEMS
189
---------
190
191
If you have any problems using this module, please first refer to the BUGS file
192
(containing current bugs and issues). If your problem is not mentioned you may
193
contact the author at the following E-Mail address:
194
195
negativeiq@users.sourceforge.net
196
197
Please allow some time for your question to be received and handled.
198
199
200
Dan-Haim,
201
Author.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1