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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
from cStringIO import StringIO
19
from SimpleHTTPServer import SimpleHTTPRequestHandler
28
from bzrlib.smart import (
31
from bzrlib.tests import http_server
32
from bzrlib.transport import chroot
35
class HTTPServerWithSmarts(http_server.HttpServer):
24
from bzrlib.tests import TestCaseWithTransport
25
from bzrlib.tests.HttpServer import (
27
TestingHTTPRequestHandler,
29
from bzrlib.transport import (
35
class WallRequestHandler(TestingHTTPRequestHandler):
36
"""Whatever request comes in, close the connection"""
38
def handle_one_request(self):
39
"""Handle a single HTTP request, by abruptly closing the connection"""
40
self.close_connection = 1
43
class BadStatusRequestHandler(TestingHTTPRequestHandler):
44
"""Whatever request comes in, returns a bad status"""
46
def parse_request(self):
47
"""Fakes handling a single HTTP request, returns a bad status"""
48
ignored = TestingHTTPRequestHandler.parse_request(self)
50
self.send_response(0, "Bad status")
52
except socket.error, e:
53
# We don't want to pollute the test results with
54
# spurious server errors while test succeed. In our
55
# case, it may occur that the test has already read
56
# the 'Bad Status' and closed the socket while we are
57
# still trying to send some headers... So the test is
58
# ok, but if we raise the exception, the output is
59
# dirty. So we don't raise, but we close the
60
# connection, just to be safe :)
61
spurious = [errno.EPIPE,
65
if (len(e.args) > 0) and (e.args[0] in spurious):
66
self.close_connection = 1
73
class InvalidStatusRequestHandler(TestingHTTPRequestHandler):
74
"""Whatever request comes in, returns am invalid status"""
76
def parse_request(self):
77
"""Fakes handling a single HTTP request, returns a bad status"""
78
ignored = TestingHTTPRequestHandler.parse_request(self)
79
self.wfile.write("Invalid status line\r\n")
83
class BadProtocolRequestHandler(TestingHTTPRequestHandler):
84
"""Whatever request comes in, returns a bad protocol version"""
86
def parse_request(self):
87
"""Fakes handling a single HTTP request, returns a bad status"""
88
ignored = TestingHTTPRequestHandler.parse_request(self)
89
# Returns an invalid protocol version, but curl just
90
# ignores it and those cannot be tested.
91
self.wfile.write("%s %d %s\r\n" % ('HTTP/0.0',
93
'Look at my protocol version'))
97
class ForbiddenRequestHandler(TestingHTTPRequestHandler):
98
"""Whatever request comes in, returns a 403 code"""
100
def parse_request(self):
101
"""Handle a single HTTP request, by replying we cannot handle it"""
102
ignored = TestingHTTPRequestHandler.parse_request(self)
107
class HTTPServerWithSmarts(HttpServer):
36
108
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
37
109
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.
114
HttpServer.__init__(self, SmartRequestHandler)
117
class SmartRequestHandler(TestingHTTPRequestHandler):
118
"""Extend TestingHTTPRequestHandler to support smart client POSTs."""
52
120
def do_POST(self):
53
121
"""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
122
self.send_response(200)
66
123
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'])
124
transport = get_transport(self.server.test_case_server._home_dir)
74
125
# TODO: We might like to support streaming responses. 1.0 allows no
75
126
# Content-length in this case, so for integrity we should perform our
76
127
# own chunking within the stream.
78
129
# the HTTP chunking as this will allow HTTP persistence safely, even if
79
130
# we have to stop early due to error, but we would also have to use the
80
131
# 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
132
out_buffer = StringIO()
85
smart_protocol_request = protocol_factory(t, out_buffer.write, '/')
133
smart_protocol_request = smart.SmartServerRequestProtocolOne(
134
transport, out_buffer.write)
135
# if this fails, we should return 400 bad request, but failure is
136
# failure for now - RBC 20060919
137
data_length = int(self.headers['Content-Length'])
86
138
# Perhaps there should be a SmartServerHTTPMedium that takes care of
87
139
# feeding the bytes in the http request to the smart_protocol_request,
88
140
# 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.")
141
smart_protocol_request.accept_bytes(self.rfile.read(data_length))
142
assert smart_protocol_request.next_read_size() == 0, (
143
"not finished reading, but all data sent to protocol.")
93
144
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
94
145
self.end_headers()
95
146
self.wfile.write(out_buffer.getvalue())
98
class TestCaseWithWebserver(tests.TestCaseWithTransport):
149
class SingleRangeRequestHandler(TestingHTTPRequestHandler):
150
"""Always reply to range request as if they were single.
152
Don't be explicit about it, just to annoy the clients.
155
def get_multiple_ranges(self, file, file_size, ranges):
156
"""Answer as if it was a single range request and ignores the rest"""
157
(start, end) = ranges[0]
158
return self.get_single_range(file, file_size, start, end)
161
class NoRangeRequestHandler(TestingHTTPRequestHandler):
162
"""Ignore range requests without notice"""
164
# Just bypass the range handling done by TestingHTTPRequestHandler
165
do_GET = SimpleHTTPRequestHandler.do_GET
168
class TestCaseWithWebserver(TestCaseWithTransport):
99
169
"""A support class that provides readonly urls that are http://.
101
171
This is done by forcing the readonly server to be an http
102
172
one. This will currently fail if the primary transport is not
103
173
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
176
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
177
self.transport_readonly_server = HttpServer
123
180
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
137
194
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
196
return self.transport_secondary_server()
144
198
def get_secondary_server(self):
145
199
"""Get the server instance for the secondary transport."""
146
200
if self.__secondary_server is None:
147
201
self.__secondary_server = self.create_transport_secondary_server()
148
self.start_server(self.__secondary_server)
202
self.__secondary_server.setUp()
203
self.addCleanup(self.__secondary_server.tearDown)
149
204
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):
207
class FakeProxyRequestHandler(TestingHTTPRequestHandler):
208
"""Append a '-proxied' suffix to file served"""
210
def translate_path(self, path):
211
# We need to act as a proxy and accept absolute urls,
212
# which SimpleHTTPRequestHandler (grand parent) is not
213
# ready for. So we just drop the protocol://host:port
214
# part in front of the request-url (because we know we
215
# would not forward the request to *another* proxy).
217
# So we do what SimpleHTTPRequestHandler.translate_path
218
# do beginning with python 2.4.3: abandon query
219
# parameters, scheme, host port, etc (which ensure we
220
# provide the right behaviour on all python versions).
221
path = urlparse.urlparse(path)[2]
222
# And now, we can apply *our* trick to proxy files
223
self.path += '-proxied'
224
# An finally we leave our mother class do whatever it
225
# wants with the path
226
return TestingHTTPRequestHandler.translate_path(self, path)
229
class RedirectRequestHandler(TestingHTTPRequestHandler):
168
230
"""Redirect all request to the specified server"""
170
232
def parse_request(self):
171
233
"""Redirect a single HTTP request to another host"""
172
valid = http_server.TestingHTTPRequestHandler.parse_request(self)
234
valid = TestingHTTPRequestHandler.parse_request(self)
174
236
tcs = self.server.test_case_server
175
237
code, target = tcs.is_redirected(self.path)
236
294
The 'old' server is redirected to the 'new' server.
297
def create_transport_secondary_server(self):
298
"""Create the secondary server redirecting to the primary server"""
299
new = self.get_readonly_server()
300
redirecting = HTTPServerRedirecting()
301
redirecting.redirect_to(new.host, new.port)
240
305
super(TestCaseWithRedirectedWebserver, self).setUp()
241
306
# The redirections will point to the new server
242
307
self.new_server = self.get_readonly_server()
243
# The requests to the old server will be redirected to the new server
308
# The requests to the old server will be redirected
244
309
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/HTTPTestUtil.py
