1
# Copyright (C) 2005-2010 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
32
from bzrlib.smart import medium, protocol
33
from bzrlib.tests import http_server
34
from bzrlib.transport import (
40
class HTTPServerWithSmarts(http_server.HttpServer):
41
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
42
trigger a smart server to execute with a transport rooted at the rootdir of
46
def __init__(self, protocol_version=None):
47
http_server.HttpServer.__init__(self, SmartRequestHandler,
48
protocol_version=protocol_version)
51
class SmartRequestHandler(http_server.TestingHTTPRequestHandler):
52
"""Extend TestingHTTPRequestHandler to support smart client POSTs.
54
XXX: This duplicates a fair bit of the logic in bzrlib.transport.http.wsgi.
58
"""Hand the request off to a smart server instance."""
59
backing = get_transport(self.server.test_case_server._home_dir)
60
chroot_server = chroot.ChrootServer(backing)
61
chroot_server.start_server()
63
t = get_transport(chroot_server.get_url())
66
chroot_server.stop_server()
68
def do_POST_inner(self, chrooted_transport):
69
self.send_response(200)
70
self.send_header("Content-type", "application/octet-stream")
71
if not self.path.endswith('.bzr/smart'):
73
'POST to path not ending in .bzr/smart: %r' % (self.path,))
74
t = chrooted_transport.clone(self.path[:-len('.bzr/smart')])
75
# if this fails, we should return 400 bad request, but failure is
76
# failure for now - RBC 20060919
77
data_length = int(self.headers['Content-Length'])
78
# TODO: We might like to support streaming responses. 1.0 allows no
79
# Content-length in this case, so for integrity we should perform our
80
# own chunking within the stream.
81
# 1.1 allows chunked responses, and in this case we could chunk using
82
# the HTTP chunking as this will allow HTTP persistence safely, even if
83
# we have to stop early due to error, but we would also have to use the
84
# HTTP trailer facility which may not be widely available.
85
request_bytes = self.rfile.read(data_length)
86
protocol_factory, unused_bytes = medium._get_protocol_factory_for_bytes(
88
out_buffer = StringIO()
89
smart_protocol_request = protocol_factory(t, out_buffer.write, '/')
90
# Perhaps there should be a SmartServerHTTPMedium that takes care of
91
# feeding the bytes in the http request to the smart_protocol_request,
92
# but for now it's simpler to just feed the bytes directly.
93
smart_protocol_request.accept_bytes(unused_bytes)
94
if not (smart_protocol_request.next_read_size() == 0):
95
raise errors.SmartProtocolError(
96
"not finished reading, but all data sent to protocol.")
97
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
99
self.wfile.write(out_buffer.getvalue())
102
class TestCaseWithWebserver(tests.TestCaseWithTransport):
103
"""A support class that provides readonly urls that are http://.
105
This is done by forcing the readonly server to be an http
106
one. This will currently fail if the primary transport is not
107
backed by regular disk files.
110
# This can be overriden or parametrized by daughter clasess if needed, but
111
# it must exist so that the create_transport_readonly_server() method can
113
_protocol_version = None
116
super(TestCaseWithWebserver, self).setUp()
117
self.transport_readonly_server = http_server.HttpServer
119
def create_transport_readonly_server(self):
120
return self.transport_readonly_server(
121
protocol_version=self._protocol_version)
124
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
125
"""A support class providing readonly urls on two servers that are http://.
127
We set up two webservers to allows various tests involving
128
proxies or redirections from one server to the other.
131
super(TestCaseWithTwoWebservers, self).setUp()
132
self.transport_secondary_server = http_server.HttpServer
133
self.__secondary_server = None
135
def create_transport_secondary_server(self):
136
"""Create a transport server from class defined at init.
138
This is mostly a hook for daughter classes.
140
return self.transport_secondary_server(
141
protocol_version=self._protocol_version)
143
def get_secondary_server(self):
144
"""Get the server instance for the secondary transport."""
145
if self.__secondary_server is None:
146
self.__secondary_server = self.create_transport_secondary_server()
147
self.start_server(self.__secondary_server)
148
return self.__secondary_server
151
class ProxyServer(http_server.HttpServer):
152
"""A proxy test server for http transports."""
154
proxy_requests = True
157
class RedirectRequestHandler(http_server.TestingHTTPRequestHandler):
158
"""Redirect all request to the specified server"""
160
def parse_request(self):
161
"""Redirect a single HTTP request to another host"""
162
valid = http_server.TestingHTTPRequestHandler.parse_request(self)
164
tcs = self.server.test_case_server
165
code, target = tcs.is_redirected(self.path)
166
if code is not None and target is not None:
167
# Redirect as instructed
168
self.send_response(code)
169
self.send_header('Location', target)
170
# We do not send a body
171
self.send_header('Content-Length', '0')
173
return False # The job is done
175
# We leave the parent class serve the request
180
class HTTPServerRedirecting(http_server.HttpServer):
181
"""An HttpServer redirecting to another server """
183
def __init__(self, request_handler=RedirectRequestHandler,
184
protocol_version=None):
185
http_server.HttpServer.__init__(self, request_handler,
186
protocol_version=protocol_version)
187
# redirections is a list of tuples (source, target, code)
188
# - source is a regexp for the paths requested
189
# - target is a replacement for re.sub describing where
190
# the request will be redirected
191
# - code is the http error code associated to the
192
# redirection (301 permanent, 302 temporarry, etc
193
self.redirections = []
195
def redirect_to(self, host, port):
196
"""Redirect all requests to a specific host:port"""
197
self.redirections = [('(.*)',
198
r'http://%s:%s\1' % (host, port) ,
201
def is_redirected(self, path):
202
"""Is the path redirected by this server.
204
:param path: the requested relative path
206
:returns: a tuple (code, target) if a matching
207
redirection is found, (None, None) otherwise.
211
for (rsource, rtarget, rcode) in self.redirections:
212
target, match = re.subn(rsource, rtarget, path)
215
break # The first match wins
221
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
222
"""A support class providing redirections from one server to another.
224
We set up two webservers to allows various tests involving
226
The 'old' server is redirected to the 'new' server.
229
def create_transport_secondary_server(self):
230
"""Create the secondary server redirecting to the primary server"""
231
new = self.get_readonly_server()
232
redirecting = HTTPServerRedirecting(
233
protocol_version=self._protocol_version)
234
redirecting.redirect_to(new.host, new.port)
238
super(TestCaseWithRedirectedWebserver, self).setUp()
239
# The redirections will point to the new server
240
self.new_server = self.get_readonly_server()
241
# The requests to the old server will be redirected
242
self.old_server = self.get_secondary_server()
245
class AuthRequestHandler(http_server.TestingHTTPRequestHandler):
246
"""Requires an authentication to process requests.
248
This is intended to be used with a server that always and
249
only use one authentication scheme (implemented by daughter
253
# The following attributes should be defined in the server
254
# - auth_header_sent: the header name sent to require auth
255
# - auth_header_recv: the header received containing auth
256
# - auth_error_code: the error code to indicate auth required
259
if self.authorized():
260
return http_server.TestingHTTPRequestHandler.do_GET(self)
262
# Note that we must update test_case_server *before*
263
# sending the error or the client may try to read it
264
# before we have sent the whole error back.
265
tcs = self.server.test_case_server
266
tcs.auth_required_errors += 1
267
self.send_response(tcs.auth_error_code)
268
self.send_header_auth_reqed()
269
# We do not send a body
270
self.send_header('Content-Length', '0')
275
class BasicAuthRequestHandler(AuthRequestHandler):
276
"""Implements the basic authentication of a request"""
278
def authorized(self):
279
tcs = self.server.test_case_server
280
if tcs.auth_scheme != 'basic':
283
auth_header = self.headers.get(tcs.auth_header_recv, None)
285
scheme, raw_auth = auth_header.split(' ', 1)
286
if scheme.lower() == tcs.auth_scheme:
287
user, password = raw_auth.decode('base64').split(':')
288
return tcs.authorized(user, password)
292
def send_header_auth_reqed(self):
293
tcs = self.server.test_case_server
294
self.send_header(tcs.auth_header_sent,
295
'Basic realm="%s"' % tcs.auth_realm)
298
# FIXME: We could send an Authentication-Info header too when
299
# the authentication is succesful
301
class DigestAuthRequestHandler(AuthRequestHandler):
302
"""Implements the digest authentication of a request.
304
We need persistence for some attributes and that can't be
305
achieved here since we get instantiated for each request. We
306
rely on the DigestAuthServer to take care of them.
309
def authorized(self):
310
tcs = self.server.test_case_server
312
auth_header = self.headers.get(tcs.auth_header_recv, None)
313
if auth_header is None:
315
scheme, auth = auth_header.split(None, 1)
316
if scheme.lower() == tcs.auth_scheme:
317
auth_dict = urllib2.parse_keqv_list(urllib2.parse_http_list(auth))
319
return tcs.digest_authorized(auth_dict, self.command)
323
def send_header_auth_reqed(self):
324
tcs = self.server.test_case_server
325
header = 'Digest realm="%s", ' % tcs.auth_realm
326
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
328
self.send_header(tcs.auth_header_sent,header)
331
class DigestAndBasicAuthRequestHandler(DigestAuthRequestHandler):
332
"""Implements a digest and basic authentication of a request.
334
I.e. the server proposes both schemes and the client should choose the best
335
one it can handle, which, in that case, should be digest, the only scheme
339
def send_header_auth_reqed(self):
340
tcs = self.server.test_case_server
341
self.send_header(tcs.auth_header_sent,
342
'Basic realm="%s"' % tcs.auth_realm)
343
header = 'Digest realm="%s", ' % tcs.auth_realm
344
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
346
self.send_header(tcs.auth_header_sent,header)
349
class AuthServer(http_server.HttpServer):
350
"""Extends HttpServer with a dictionary of passwords.
352
This is used as a base class for various schemes which should
353
all use or redefined the associated AuthRequestHandler.
355
Note that no users are defined by default, so add_user should
356
be called before issuing the first request.
359
# The following attributes should be set dy daughter classes
360
# and are used by AuthRequestHandler.
361
auth_header_sent = None
362
auth_header_recv = None
363
auth_error_code = None
364
auth_realm = "Thou should not pass"
366
def __init__(self, request_handler, auth_scheme,
367
protocol_version=None):
368
http_server.HttpServer.__init__(self, request_handler,
369
protocol_version=protocol_version)
370
self.auth_scheme = auth_scheme
371
self.password_of = {}
372
self.auth_required_errors = 0
374
def add_user(self, user, password):
375
"""Declare a user with an associated password.
377
password can be empty, use an empty string ('') in that
380
self.password_of[user] = password
382
def authorized(self, user, password):
383
"""Check that the given user provided the right password"""
384
expected_password = self.password_of.get(user, None)
385
return expected_password is not None and password == expected_password
388
# FIXME: There is some code duplication with
389
# _urllib2_wrappers.py.DigestAuthHandler. If that duplication
390
# grows, it may require a refactoring. Also, we don't implement
391
# SHA algorithm nor MD5-sess here, but that does not seem worth
393
class DigestAuthServer(AuthServer):
394
"""A digest authentication server"""
398
def __init__(self, request_handler, auth_scheme,
399
protocol_version=None):
400
AuthServer.__init__(self, request_handler, auth_scheme,
401
protocol_version=protocol_version)
403
def digest_authorized(self, auth, command):
404
nonce = auth['nonce']
405
if nonce != self.auth_nonce:
407
realm = auth['realm']
408
if realm != self.auth_realm:
410
user = auth['username']
411
if not self.password_of.has_key(user):
413
algorithm= auth['algorithm']
414
if algorithm != 'MD5':
420
password = self.password_of[user]
422
# Recalculate the response_digest to compare with the one
424
A1 = '%s:%s:%s' % (user, realm, password)
425
A2 = '%s:%s' % (command, auth['uri'])
427
H = lambda x: osutils.md5(x).hexdigest()
428
KD = lambda secret, data: H("%s:%s" % (secret, data))
430
nonce_count = int(auth['nc'], 16)
432
ncvalue = '%08x' % nonce_count
434
cnonce = auth['cnonce']
435
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
436
response_digest = KD(H(A1), noncebit)
438
return response_digest == auth['response']
441
class HTTPAuthServer(AuthServer):
442
"""An HTTP server requiring authentication"""
444
def init_http_auth(self):
445
self.auth_header_sent = 'WWW-Authenticate'
446
self.auth_header_recv = 'Authorization'
447
self.auth_error_code = 401
450
class ProxyAuthServer(AuthServer):
451
"""A proxy server requiring authentication"""
453
def init_proxy_auth(self):
454
self.proxy_requests = True
455
self.auth_header_sent = 'Proxy-Authenticate'
456
self.auth_header_recv = 'Proxy-Authorization'
457
self.auth_error_code = 407
460
class HTTPBasicAuthServer(HTTPAuthServer):
461
"""An HTTP server requiring basic authentication"""
463
def __init__(self, protocol_version=None):
464
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
465
protocol_version=protocol_version)
466
self.init_http_auth()
469
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
470
"""An HTTP server requiring digest authentication"""
472
def __init__(self, protocol_version=None):
473
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
474
protocol_version=protocol_version)
475
self.init_http_auth()
478
class HTTPBasicAndDigestAuthServer(DigestAuthServer, HTTPAuthServer):
479
"""An HTTP server requiring basic or digest authentication"""
481
def __init__(self, protocol_version=None):
482
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
484
protocol_version=protocol_version)
485
self.init_http_auth()
486
# We really accept Digest only
487
self.auth_scheme = 'digest'
490
class ProxyBasicAuthServer(ProxyAuthServer):
491
"""A proxy server requiring basic authentication"""
493
def __init__(self, protocol_version=None):
494
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
495
protocol_version=protocol_version)
496
self.init_proxy_auth()
499
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
500
"""A proxy server requiring basic authentication"""
502
def __init__(self, protocol_version=None):
503
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
504
protocol_version=protocol_version)
505
self.init_proxy_auth()
508
class ProxyBasicAndDigestAuthServer(DigestAuthServer, ProxyAuthServer):
509
"""An proxy server requiring basic or digest authentication"""
511
def __init__(self, protocol_version=None):
512
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
514
protocol_version=protocol_version)
515
self.init_proxy_auth()
516
# We really accept Digest only
517
self.auth_scheme = 'digest'
added
removed
bzrlib/tests/http_utils.py
