1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
import BaseHTTPServer, SimpleHTTPServer, socket, errno, time
18
from bzrlib.selftest import TestCaseInTempDir
21
class WebserverNotAvailable(Exception):
24
class BadWebserverPath(ValueError):
26
return 'path %s is not in %s' % self.args
28
class TestingHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
29
def log_message(self, format, *args):
30
self.server.test_case.log("webserver - %s - - [%s] %s" %
31
(self.address_string(),
32
self.log_date_time_string(),
35
def handle_one_request(self):
36
"""Handle a single HTTP request.
38
You normally don't need to override this method; see the class
39
__doc__ string for information on how to handle specific HTTP
40
commands such as GET and POST.
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from cStringIO import StringIO
28
from bzrlib.smart import (
31
from bzrlib.tests import http_server
32
from bzrlib.transport import chroot
35
class HTTPServerWithSmarts(http_server.HttpServer):
36
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
37
trigger a smart server to execute with a transport rooted at the rootdir of
41
def __init__(self, protocol_version=None):
42
http_server.HttpServer.__init__(self, SmartRequestHandler,
43
protocol_version=protocol_version)
46
class SmartRequestHandler(http_server.TestingHTTPRequestHandler):
47
"""Extend TestingHTTPRequestHandler to support smart client POSTs.
49
XXX: This duplicates a fair bit of the logic in bzrlib.transport.http.wsgi.
53
"""Hand the request off to a smart server instance."""
54
backing = transport.get_transport_from_path(
55
self.server.test_case_server._home_dir)
56
chroot_server = chroot.ChrootServer(backing)
57
chroot_server.start_server()
59
t = transport.get_transport_from_url(chroot_server.get_url())
62
chroot_server.stop_server()
64
def do_POST_inner(self, chrooted_transport):
65
self.send_response(200)
66
self.send_header("Content-type", "application/octet-stream")
67
if not self.path.endswith('.bzr/smart'):
69
'POST to path not ending in .bzr/smart: %r' % (self.path,))
70
t = chrooted_transport.clone(self.path[:-len('.bzr/smart')])
71
# if this fails, we should return 400 bad request, but failure is
72
# failure for now - RBC 20060919
73
data_length = int(self.headers['Content-Length'])
74
# TODO: We might like to support streaming responses. 1.0 allows no
75
# Content-length in this case, so for integrity we should perform our
76
# own chunking within the stream.
77
# 1.1 allows chunked responses, and in this case we could chunk using
78
# the HTTP chunking as this will allow HTTP persistence safely, even if
79
# we have to stop early due to error, but we would also have to use the
80
# HTTP trailer facility which may not be widely available.
81
request_bytes = self.rfile.read(data_length)
82
protocol_factory, unused_bytes = medium._get_protocol_factory_for_bytes(
84
out_buffer = StringIO()
85
smart_protocol_request = protocol_factory(t, out_buffer.write, '/')
86
# Perhaps there should be a SmartServerHTTPMedium that takes care of
87
# feeding the bytes in the http request to the smart_protocol_request,
88
# but for now it's simpler to just feed the bytes directly.
89
smart_protocol_request.accept_bytes(unused_bytes)
90
if not (smart_protocol_request.next_read_size() == 0):
91
raise errors.SmartProtocolError(
92
"not finished reading, but all data sent to protocol.")
93
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
95
self.wfile.write(out_buffer.getvalue())
98
class TestCaseWithWebserver(tests.TestCaseWithTransport):
99
"""A support class that provides readonly urls that are http://.
101
This is done by forcing the readonly server to be an http
102
one. This will currently fail if the primary transport is not
103
backed by regular disk files.
106
# These attributes can be overriden or parametrized by daughter clasess if
107
# needed, but must exist so that the create_transport_readonly_server()
108
# method (or any method creating an http(s) server) can propagate it.
109
_protocol_version = None
110
_url_protocol = 'http'
113
super(TestCaseWithWebserver, self).setUp()
114
self.transport_readonly_server = http_server.HttpServer
116
def create_transport_readonly_server(self):
117
server = self.transport_readonly_server(
118
protocol_version=self._protocol_version)
119
server._url_protocol = self._url_protocol
123
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
124
"""A support class providing readonly urls on two servers that are http://.
126
We set up two webservers to allows various tests involving
127
proxies or redirections from one server to the other.
130
super(TestCaseWithTwoWebservers, self).setUp()
131
self.transport_secondary_server = http_server.HttpServer
132
self.__secondary_server = None
134
def create_transport_secondary_server(self):
135
"""Create a transport server from class defined at init.
137
This is mostly a hook for daughter classes.
43
for i in xrange(1,11): # Don't try more than 10 times
45
self.raw_requestline = self.rfile.readline()
46
except socket.error, e:
47
if e.args[0] == errno.EAGAIN:
48
self.log_message('EAGAIN (%d) while reading from raw_requestline' % i)
54
if not self.raw_requestline:
55
self.close_connection = 1
57
if not self.parse_request(): # An error code has been sent, just exit
59
mname = 'do_' + self.command
60
if not hasattr(self, mname):
61
self.send_error(501, "Unsupported method (%r)" % self.command)
63
method = getattr(self, mname)
66
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
67
def __init__(self, server_address, RequestHandlerClass, test_case):
68
BaseHTTPServer.HTTPServer.__init__(self, server_address,
70
self.test_case = test_case
73
class TestCaseWithWebserver(TestCaseInTempDir):
74
"""Derived class that starts a localhost-only webserver
75
(in addition to what TestCaseInTempDir does).
77
This is useful for testing RemoteBranch.
80
_HTTP_PORTS = range(13000, 0x8000)
82
def _http_start(self):
83
import SimpleHTTPServer, BaseHTTPServer, socket, errno
85
for port in self._HTTP_PORTS:
87
httpd = TestingHTTPServer(('localhost', port),
88
TestingHTTPRequestHandler,
90
except socket.error, e:
91
if e.args[0] == errno.EADDRINUSE:
93
print >>sys.stderr, "Cannot run webserver :-("
99
raise WebserverNotAvailable("Cannot run webserver :-( "
100
"no free ports in range %s..%s" %
101
(_HTTP_PORTS[0], _HTTP_PORTS[-1]))
103
self._http_base_url = 'http://localhost:%s/' % port
104
self._http_starting.release()
105
httpd.socket.settimeout(0.1)
107
while self._http_running:
109
httpd.handle_request()
110
except socket.timeout:
139
server = self.transport_secondary_server(
140
protocol_version=self._protocol_version)
141
server._url_protocol = self._url_protocol
144
def get_secondary_server(self):
145
"""Get the server instance for the secondary transport."""
146
if self.__secondary_server is None:
147
self.__secondary_server = self.create_transport_secondary_server()
148
self.start_server(self.__secondary_server)
149
return self.__secondary_server
151
def get_secondary_url(self, relpath=None):
152
base = self.get_secondary_server().get_url()
153
return self._adjust_url(base, relpath)
155
def get_secondary_transport(self, relpath=None):
156
t = transport.get_transport_from_url(self.get_secondary_url(relpath))
157
self.assertTrue(t.is_readonly())
161
class ProxyServer(http_server.HttpServer):
162
"""A proxy test server for http transports."""
164
proxy_requests = True
167
class RedirectRequestHandler(http_server.TestingHTTPRequestHandler):
168
"""Redirect all request to the specified server"""
170
def parse_request(self):
171
"""Redirect a single HTTP request to another host"""
172
valid = http_server.TestingHTTPRequestHandler.parse_request(self)
174
tcs = self.server.test_case_server
175
code, target = tcs.is_redirected(self.path)
176
if code is not None and target is not None:
177
# Redirect as instructed
178
self.send_response(code)
179
self.send_header('Location', target)
180
# We do not send a body
181
self.send_header('Content-Length', '0')
183
return False # The job is done
185
# We leave the parent class serve the request
113
def get_remote_url(self, path):
116
path_parts = path.split(os.path.sep)
117
if os.path.isabs(path):
118
if path_parts[:len(self._local_path_parts)] != \
119
self._local_path_parts:
120
raise BadWebserverPath(path, self.test_dir)
121
remote_path = '/'.join(path_parts[len(self._local_path_parts):])
123
remote_path = '/'.join(path_parts)
125
self._http_starting.acquire()
126
self._http_starting.release()
127
return self._http_base_url + remote_path
130
TestCaseInTempDir.setUp(self)
132
self._local_path_parts = self.test_dir.split(os.path.sep)
133
self._http_starting = threading.Lock()
134
self._http_starting.acquire()
135
self._http_running = True
136
self._http_base_url = None
137
self._http_thread = threading.Thread(target=self._http_start)
138
self._http_thread.setDaemon(True)
139
self._http_thread.start()
140
self._http_proxy = os.environ.get("http_proxy")
141
if self._http_proxy is not None:
142
del os.environ["http_proxy"]
145
self._http_running = False
146
self._http_thread.join()
147
if self._http_proxy is not None:
149
os.environ["http_proxy"] = self._http_proxy
150
TestCaseInTempDir.tearDown(self)
190
class HTTPServerRedirecting(http_server.HttpServer):
191
"""An HttpServer redirecting to another server """
193
def __init__(self, request_handler=RedirectRequestHandler,
194
protocol_version=None):
195
http_server.HttpServer.__init__(self, request_handler,
196
protocol_version=protocol_version)
197
# redirections is a list of tuples (source, target, code)
198
# - source is a regexp for the paths requested
199
# - target is a replacement for re.sub describing where
200
# the request will be redirected
201
# - code is the http error code associated to the
202
# redirection (301 permanent, 302 temporarry, etc
203
self.redirections = []
205
def redirect_to(self, host, port):
206
"""Redirect all requests to a specific host:port"""
207
self.redirections = [('(.*)',
208
r'http://%s:%s\1' % (host, port) ,
211
def is_redirected(self, path):
212
"""Is the path redirected by this server.
214
:param path: the requested relative path
216
:returns: a tuple (code, target) if a matching
217
redirection is found, (None, None) otherwise.
221
for (rsource, rtarget, rcode) in self.redirections:
222
target, match = re.subn(rsource, rtarget, path)
225
break # The first match wins
231
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
232
"""A support class providing redirections from one server to another.
234
We set up two webservers to allows various tests involving
236
The 'old' server is redirected to the 'new' server.
240
super(TestCaseWithRedirectedWebserver, self).setUp()
241
# The redirections will point to the new server
242
self.new_server = self.get_readonly_server()
243
# The requests to the old server will be redirected to the new server
244
self.old_server = self.get_secondary_server()
246
def create_transport_secondary_server(self):
247
"""Create the secondary server redirecting to the primary server"""
248
new = self.get_readonly_server()
249
redirecting = HTTPServerRedirecting(
250
protocol_version=self._protocol_version)
251
redirecting.redirect_to(new.host, new.port)
252
redirecting._url_protocol = self._url_protocol
255
def get_old_url(self, relpath=None):
256
base = self.old_server.get_url()
257
return self._adjust_url(base, relpath)
259
def get_old_transport(self, relpath=None):
260
t = transport.get_transport_from_url(self.get_old_url(relpath))
261
self.assertTrue(t.is_readonly())
264
def get_new_url(self, relpath=None):
265
base = self.new_server.get_url()
266
return self._adjust_url(base, relpath)
268
def get_new_transport(self, relpath=None):
269
t = transport.get_transport_from_url(self.get_new_url(relpath))
270
self.assertTrue(t.is_readonly())
274
class AuthRequestHandler(http_server.TestingHTTPRequestHandler):
275
"""Requires an authentication to process requests.
277
This is intended to be used with a server that always and
278
only use one authentication scheme (implemented by daughter
282
# The following attributes should be defined in the server
283
# - auth_header_sent: the header name sent to require auth
284
# - auth_header_recv: the header received containing auth
285
# - auth_error_code: the error code to indicate auth required
287
def _require_authentication(self):
288
# Note that we must update test_case_server *before*
289
# sending the error or the client may try to read it
290
# before we have sent the whole error back.
291
tcs = self.server.test_case_server
292
tcs.auth_required_errors += 1
293
self.send_response(tcs.auth_error_code)
294
self.send_header_auth_reqed()
295
# We do not send a body
296
self.send_header('Content-Length', '0')
301
if self.authorized():
302
return http_server.TestingHTTPRequestHandler.do_GET(self)
304
return self._require_authentication()
307
if self.authorized():
308
return http_server.TestingHTTPRequestHandler.do_HEAD(self)
310
return self._require_authentication()
313
class BasicAuthRequestHandler(AuthRequestHandler):
314
"""Implements the basic authentication of a request"""
316
def authorized(self):
317
tcs = self.server.test_case_server
318
if tcs.auth_scheme != 'basic':
321
auth_header = self.headers.get(tcs.auth_header_recv, None)
323
scheme, raw_auth = auth_header.split(' ', 1)
324
if scheme.lower() == tcs.auth_scheme:
325
user, password = raw_auth.decode('base64').split(':')
326
return tcs.authorized(user, password)
330
def send_header_auth_reqed(self):
331
tcs = self.server.test_case_server
332
self.send_header(tcs.auth_header_sent,
333
'Basic realm="%s"' % tcs.auth_realm)
336
# FIXME: We could send an Authentication-Info header too when
337
# the authentication is succesful
339
class DigestAuthRequestHandler(AuthRequestHandler):
340
"""Implements the digest authentication of a request.
342
We need persistence for some attributes and that can't be
343
achieved here since we get instantiated for each request. We
344
rely on the DigestAuthServer to take care of them.
347
def authorized(self):
348
tcs = self.server.test_case_server
350
auth_header = self.headers.get(tcs.auth_header_recv, None)
351
if auth_header is None:
353
scheme, auth = auth_header.split(None, 1)
354
if scheme.lower() == tcs.auth_scheme:
355
auth_dict = urllib2.parse_keqv_list(urllib2.parse_http_list(auth))
357
return tcs.digest_authorized(auth_dict, self.command)
361
def send_header_auth_reqed(self):
362
tcs = self.server.test_case_server
363
header = 'Digest realm="%s", ' % tcs.auth_realm
364
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
366
self.send_header(tcs.auth_header_sent,header)
369
class DigestAndBasicAuthRequestHandler(DigestAuthRequestHandler):
370
"""Implements a digest and basic authentication of a request.
372
I.e. the server proposes both schemes and the client should choose the best
373
one it can handle, which, in that case, should be digest, the only scheme
377
def send_header_auth_reqed(self):
378
tcs = self.server.test_case_server
379
self.send_header(tcs.auth_header_sent,
380
'Basic realm="%s"' % tcs.auth_realm)
381
header = 'Digest realm="%s", ' % tcs.auth_realm
382
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
384
self.send_header(tcs.auth_header_sent,header)
387
class AuthServer(http_server.HttpServer):
388
"""Extends HttpServer with a dictionary of passwords.
390
This is used as a base class for various schemes which should
391
all use or redefined the associated AuthRequestHandler.
393
Note that no users are defined by default, so add_user should
394
be called before issuing the first request.
397
# The following attributes should be set dy daughter classes
398
# and are used by AuthRequestHandler.
399
auth_header_sent = None
400
auth_header_recv = None
401
auth_error_code = None
402
auth_realm = "Thou should not pass"
404
def __init__(self, request_handler, auth_scheme,
405
protocol_version=None):
406
http_server.HttpServer.__init__(self, request_handler,
407
protocol_version=protocol_version)
408
self.auth_scheme = auth_scheme
409
self.password_of = {}
410
self.auth_required_errors = 0
412
def add_user(self, user, password):
413
"""Declare a user with an associated password.
415
password can be empty, use an empty string ('') in that
418
self.password_of[user] = password
420
def authorized(self, user, password):
421
"""Check that the given user provided the right password"""
422
expected_password = self.password_of.get(user, None)
423
return expected_password is not None and password == expected_password
426
# FIXME: There is some code duplication with
427
# _urllib2_wrappers.py.DigestAuthHandler. If that duplication
428
# grows, it may require a refactoring. Also, we don't implement
429
# SHA algorithm nor MD5-sess here, but that does not seem worth
431
class DigestAuthServer(AuthServer):
432
"""A digest authentication server"""
436
def __init__(self, request_handler, auth_scheme,
437
protocol_version=None):
438
AuthServer.__init__(self, request_handler, auth_scheme,
439
protocol_version=protocol_version)
441
def digest_authorized(self, auth, command):
442
nonce = auth['nonce']
443
if nonce != self.auth_nonce:
445
realm = auth['realm']
446
if realm != self.auth_realm:
448
user = auth['username']
449
if not self.password_of.has_key(user):
451
algorithm= auth['algorithm']
452
if algorithm != 'MD5':
458
password = self.password_of[user]
460
# Recalculate the response_digest to compare with the one
462
A1 = '%s:%s:%s' % (user, realm, password)
463
A2 = '%s:%s' % (command, auth['uri'])
465
H = lambda x: osutils.md5(x).hexdigest()
466
KD = lambda secret, data: H("%s:%s" % (secret, data))
468
nonce_count = int(auth['nc'], 16)
470
ncvalue = '%08x' % nonce_count
472
cnonce = auth['cnonce']
473
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
474
response_digest = KD(H(A1), noncebit)
476
return response_digest == auth['response']
479
class HTTPAuthServer(AuthServer):
480
"""An HTTP server requiring authentication"""
482
def init_http_auth(self):
483
self.auth_header_sent = 'WWW-Authenticate'
484
self.auth_header_recv = 'Authorization'
485
self.auth_error_code = 401
488
class ProxyAuthServer(AuthServer):
489
"""A proxy server requiring authentication"""
491
def init_proxy_auth(self):
492
self.proxy_requests = True
493
self.auth_header_sent = 'Proxy-Authenticate'
494
self.auth_header_recv = 'Proxy-Authorization'
495
self.auth_error_code = 407
498
class HTTPBasicAuthServer(HTTPAuthServer):
499
"""An HTTP server requiring basic authentication"""
501
def __init__(self, protocol_version=None):
502
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
503
protocol_version=protocol_version)
504
self.init_http_auth()
507
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
508
"""An HTTP server requiring digest authentication"""
510
def __init__(self, protocol_version=None):
511
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
512
protocol_version=protocol_version)
513
self.init_http_auth()
516
class HTTPBasicAndDigestAuthServer(DigestAuthServer, HTTPAuthServer):
517
"""An HTTP server requiring basic or digest authentication"""
519
def __init__(self, protocol_version=None):
520
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
522
protocol_version=protocol_version)
523
self.init_http_auth()
524
# We really accept Digest only
525
self.auth_scheme = 'digest'
528
class ProxyBasicAuthServer(ProxyAuthServer):
529
"""A proxy server requiring basic authentication"""
531
def __init__(self, protocol_version=None):
532
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
533
protocol_version=protocol_version)
534
self.init_proxy_auth()
537
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
538
"""A proxy server requiring basic authentication"""
540
def __init__(self, protocol_version=None):
541
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
542
protocol_version=protocol_version)
543
self.init_proxy_auth()
546
class ProxyBasicAndDigestAuthServer(DigestAuthServer, ProxyAuthServer):
547
"""An proxy server requiring basic or digest authentication"""
549
def __init__(self, protocol_version=None):
550
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
552
protocol_version=protocol_version)
553
self.init_proxy_auth()
554
# We really accept Digest only
555
self.auth_scheme = 'digest'
added
removed
bzrlib/tests/http_utils.py
