1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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(
55
self.server.test_case_server._home_dir)
56
chroot_server = chroot.ChrootServer(backing)
57
chroot_server.start_server()
59
t = transport.get_transport(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.
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(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
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(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(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
288
if self.authorized():
289
return http_server.TestingHTTPRequestHandler.do_GET(self)
291
# Note that we must update test_case_server *before*
292
# sending the error or the client may try to read it
293
# before we have sent the whole error back.
294
tcs = self.server.test_case_server
295
tcs.auth_required_errors += 1
296
self.send_response(tcs.auth_error_code)
297
self.send_header_auth_reqed()
298
# We do not send a body
299
self.send_header('Content-Length', '0')
304
class BasicAuthRequestHandler(AuthRequestHandler):
305
"""Implements the basic authentication of a request"""
307
def authorized(self):
308
tcs = self.server.test_case_server
309
if tcs.auth_scheme != 'basic':
312
auth_header = self.headers.get(tcs.auth_header_recv, None)
314
scheme, raw_auth = auth_header.split(' ', 1)
315
if scheme.lower() == tcs.auth_scheme:
316
user, password = raw_auth.decode('base64').split(':')
317
return tcs.authorized(user, password)
321
def send_header_auth_reqed(self):
322
tcs = self.server.test_case_server
323
self.send_header(tcs.auth_header_sent,
324
'Basic realm="%s"' % tcs.auth_realm)
327
# FIXME: We could send an Authentication-Info header too when
328
# the authentication is succesful
330
class DigestAuthRequestHandler(AuthRequestHandler):
331
"""Implements the digest authentication of a request.
333
We need persistence for some attributes and that can't be
334
achieved here since we get instantiated for each request. We
335
rely on the DigestAuthServer to take care of them.
338
def authorized(self):
339
tcs = self.server.test_case_server
341
auth_header = self.headers.get(tcs.auth_header_recv, None)
342
if auth_header is None:
344
scheme, auth = auth_header.split(None, 1)
345
if scheme.lower() == tcs.auth_scheme:
346
auth_dict = urllib2.parse_keqv_list(urllib2.parse_http_list(auth))
348
return tcs.digest_authorized(auth_dict, self.command)
352
def send_header_auth_reqed(self):
353
tcs = self.server.test_case_server
354
header = 'Digest realm="%s", ' % tcs.auth_realm
355
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
357
self.send_header(tcs.auth_header_sent,header)
360
class DigestAndBasicAuthRequestHandler(DigestAuthRequestHandler):
361
"""Implements a digest and basic authentication of a request.
363
I.e. the server proposes both schemes and the client should choose the best
364
one it can handle, which, in that case, should be digest, the only scheme
368
def send_header_auth_reqed(self):
369
tcs = self.server.test_case_server
370
self.send_header(tcs.auth_header_sent,
371
'Basic realm="%s"' % tcs.auth_realm)
372
header = 'Digest realm="%s", ' % tcs.auth_realm
373
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
375
self.send_header(tcs.auth_header_sent,header)
378
class AuthServer(http_server.HttpServer):
379
"""Extends HttpServer with a dictionary of passwords.
381
This is used as a base class for various schemes which should
382
all use or redefined the associated AuthRequestHandler.
384
Note that no users are defined by default, so add_user should
385
be called before issuing the first request.
388
# The following attributes should be set dy daughter classes
389
# and are used by AuthRequestHandler.
390
auth_header_sent = None
391
auth_header_recv = None
392
auth_error_code = None
393
auth_realm = "Thou should not pass"
395
def __init__(self, request_handler, auth_scheme,
396
protocol_version=None):
397
http_server.HttpServer.__init__(self, request_handler,
398
protocol_version=protocol_version)
399
self.auth_scheme = auth_scheme
400
self.password_of = {}
401
self.auth_required_errors = 0
403
def add_user(self, user, password):
404
"""Declare a user with an associated password.
406
password can be empty, use an empty string ('') in that
409
self.password_of[user] = password
411
def authorized(self, user, password):
412
"""Check that the given user provided the right password"""
413
expected_password = self.password_of.get(user, None)
414
return expected_password is not None and password == expected_password
417
# FIXME: There is some code duplication with
418
# _urllib2_wrappers.py.DigestAuthHandler. If that duplication
419
# grows, it may require a refactoring. Also, we don't implement
420
# SHA algorithm nor MD5-sess here, but that does not seem worth
422
class DigestAuthServer(AuthServer):
423
"""A digest authentication server"""
427
def __init__(self, request_handler, auth_scheme,
428
protocol_version=None):
429
AuthServer.__init__(self, request_handler, auth_scheme,
430
protocol_version=protocol_version)
432
def digest_authorized(self, auth, command):
433
nonce = auth['nonce']
434
if nonce != self.auth_nonce:
436
realm = auth['realm']
437
if realm != self.auth_realm:
439
user = auth['username']
440
if not self.password_of.has_key(user):
442
algorithm= auth['algorithm']
443
if algorithm != 'MD5':
449
password = self.password_of[user]
451
# Recalculate the response_digest to compare with the one
453
A1 = '%s:%s:%s' % (user, realm, password)
454
A2 = '%s:%s' % (command, auth['uri'])
456
H = lambda x: osutils.md5(x).hexdigest()
457
KD = lambda secret, data: H("%s:%s" % (secret, data))
459
nonce_count = int(auth['nc'], 16)
461
ncvalue = '%08x' % nonce_count
463
cnonce = auth['cnonce']
464
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
465
response_digest = KD(H(A1), noncebit)
467
return response_digest == auth['response']
470
class HTTPAuthServer(AuthServer):
471
"""An HTTP server requiring authentication"""
473
def init_http_auth(self):
474
self.auth_header_sent = 'WWW-Authenticate'
475
self.auth_header_recv = 'Authorization'
476
self.auth_error_code = 401
479
class ProxyAuthServer(AuthServer):
480
"""A proxy server requiring authentication"""
482
def init_proxy_auth(self):
483
self.proxy_requests = True
484
self.auth_header_sent = 'Proxy-Authenticate'
485
self.auth_header_recv = 'Proxy-Authorization'
486
self.auth_error_code = 407
489
class HTTPBasicAuthServer(HTTPAuthServer):
490
"""An HTTP server requiring basic authentication"""
492
def __init__(self, protocol_version=None):
493
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
494
protocol_version=protocol_version)
495
self.init_http_auth()
498
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
499
"""An HTTP server requiring digest authentication"""
501
def __init__(self, protocol_version=None):
502
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
503
protocol_version=protocol_version)
504
self.init_http_auth()
507
class HTTPBasicAndDigestAuthServer(DigestAuthServer, HTTPAuthServer):
508
"""An HTTP server requiring basic or digest authentication"""
510
def __init__(self, protocol_version=None):
511
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
513
protocol_version=protocol_version)
514
self.init_http_auth()
515
# We really accept Digest only
516
self.auth_scheme = 'digest'
519
class ProxyBasicAuthServer(ProxyAuthServer):
520
"""A proxy server requiring basic authentication"""
522
def __init__(self, protocol_version=None):
523
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
524
protocol_version=protocol_version)
525
self.init_proxy_auth()
528
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
529
"""A proxy server requiring basic authentication"""
531
def __init__(self, protocol_version=None):
532
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
533
protocol_version=protocol_version)
534
self.init_proxy_auth()
537
class ProxyBasicAndDigestAuthServer(DigestAuthServer, ProxyAuthServer):
538
"""An proxy server requiring basic or digest authentication"""
540
def __init__(self, protocol_version=None):
541
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
543
protocol_version=protocol_version)
544
self.init_proxy_auth()
545
# We really accept Digest only
546
self.auth_scheme = 'digest'
added
removed
bzrlib/tests/http_utils.py
