1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 by 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
from urllib.request import (
24
except ImportError: # python < 3
37
from ..sixish import (
40
from ..bzr.smart import (
43
from . import http_server
44
from ..transport import chroot
47
class HTTPServerWithSmarts(http_server.HttpServer):
48
"""HTTPServerWithSmarts extends the HttpServer with POST methods that will
49
trigger a smart server to execute with a transport rooted at the rootdir of
53
def __init__(self, protocol_version=None):
54
http_server.HttpServer.__init__(self, SmartRequestHandler,
55
protocol_version=protocol_version)
58
class SmartRequestHandler(http_server.TestingHTTPRequestHandler):
59
"""Extend TestingHTTPRequestHandler to support smart client POSTs.
61
XXX: This duplicates a fair bit of the logic in breezy.transport.http.wsgi.
65
"""Hand the request off to a smart server instance."""
66
backing = transport.get_transport_from_path(
67
self.server.test_case_server._home_dir)
68
chroot_server = chroot.ChrootServer(backing)
69
chroot_server.start_server()
71
t = transport.get_transport_from_url(chroot_server.get_url())
74
chroot_server.stop_server()
76
def do_POST_inner(self, chrooted_transport):
77
self.send_response(200)
78
self.send_header("Content-type", "application/octet-stream")
79
if not self.path.endswith('.bzr/smart'):
81
'POST to path not ending in .bzr/smart: %r' % (self.path,))
82
t = chrooted_transport.clone(self.path[:-len('.bzr/smart')])
83
# if this fails, we should return 400 bad request, but failure is
84
# failure for now - RBC 20060919
85
data_length = int(self.headers['Content-Length'])
86
# TODO: We might like to support streaming responses. 1.0 allows no
87
# Content-length in this case, so for integrity we should perform our
88
# own chunking within the stream.
89
# 1.1 allows chunked responses, and in this case we could chunk using
90
# the HTTP chunking as this will allow HTTP persistence safely, even if
91
# we have to stop early due to error, but we would also have to use the
92
# HTTP trailer facility which may not be widely available.
93
request_bytes = self.rfile.read(data_length)
94
protocol_factory, unused_bytes = (
95
medium._get_protocol_factory_for_bytes(request_bytes))
96
out_buffer = BytesIO()
97
smart_protocol_request = protocol_factory(t, out_buffer.write, '/')
98
# Perhaps there should be a SmartServerHTTPMedium that takes care of
99
# feeding the bytes in the http request to the smart_protocol_request,
100
# but for now it's simpler to just feed the bytes directly.
101
smart_protocol_request.accept_bytes(unused_bytes)
102
if not (smart_protocol_request.next_read_size() == 0):
103
raise errors.SmartProtocolError(
104
"not finished reading, but all data sent to protocol.")
105
self.send_header("Content-Length", str(len(out_buffer.getvalue())))
107
self.wfile.write(out_buffer.getvalue())
110
class TestCaseWithWebserver(tests.TestCaseWithTransport):
111
"""A support class that provides readonly urls that are http://.
113
This is done by forcing the readonly server to be an http
114
one. This will currently fail if the primary transport is not
115
backed by regular disk files.
118
# These attributes can be overriden or parametrized by daughter clasess if
119
# needed, but must exist so that the create_transport_readonly_server()
120
# method (or any method creating an http(s) server) can propagate it.
121
_protocol_version = None
122
_url_protocol = 'http'
125
super(TestCaseWithWebserver, self).setUp()
126
self.transport_readonly_server = http_server.HttpServer
128
def create_transport_readonly_server(self):
129
server = self.transport_readonly_server(
130
protocol_version=self._protocol_version)
131
server._url_protocol = self._url_protocol
135
class TestCaseWithTwoWebservers(TestCaseWithWebserver):
136
"""A support class providing readonly urls on two servers that are http://.
138
We set up two webservers to allows various tests involving
139
proxies or redirections from one server to the other.
143
super(TestCaseWithTwoWebservers, self).setUp()
144
self.transport_secondary_server = http_server.HttpServer
145
self.__secondary_server = None
147
def create_transport_secondary_server(self):
148
"""Create a transport server from class defined at init.
150
This is mostly a hook for daughter classes.
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.
152
server = self.transport_secondary_server(
153
protocol_version=self._protocol_version)
154
server._url_protocol = self._url_protocol
157
def get_secondary_server(self):
158
"""Get the server instance for the secondary transport."""
159
if self.__secondary_server is None:
160
self.__secondary_server = self.create_transport_secondary_server()
161
self.start_server(self.__secondary_server)
162
return self.__secondary_server
164
def get_secondary_url(self, relpath=None):
165
base = self.get_secondary_server().get_url()
166
return self._adjust_url(base, relpath)
168
def get_secondary_transport(self, relpath=None):
169
t = transport.get_transport_from_url(self.get_secondary_url(relpath))
170
self.assertTrue(t.is_readonly())
174
class ProxyServer(http_server.HttpServer):
175
"""A proxy test server for http transports."""
177
proxy_requests = True
180
class RedirectRequestHandler(http_server.TestingHTTPRequestHandler):
181
"""Redirect all request to the specified server"""
183
def parse_request(self):
184
"""Redirect a single HTTP request to another host"""
185
valid = http_server.TestingHTTPRequestHandler.parse_request(self)
187
tcs = self.server.test_case_server
188
code, target = tcs.is_redirected(self.path)
189
if code is not None and target is not None:
190
# Redirect as instructed
191
self.send_response(code)
192
self.send_header('Location', target)
193
# We do not send a body
194
self.send_header('Content-Length', '0')
196
return False # The job is done
198
# We leave the parent class serve the request
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
# omitted for now because some tests look at the log of
49
# the server and expect to see no errors. see recent
50
# email thread. -- mbp 20051021.
51
## self.log_message('EAGAIN (%d) while reading from raw_requestline' % i)
57
if not self.raw_requestline:
58
self.close_connection = 1
60
if not self.parse_request(): # An error code has been sent, just exit
62
mname = 'do_' + self.command
63
if not hasattr(self, mname):
64
self.send_error(501, "Unsupported method (%r)" % self.command)
66
method = getattr(self, mname)
69
class TestingHTTPServer(BaseHTTPServer.HTTPServer):
70
def __init__(self, server_address, RequestHandlerClass, test_case):
71
BaseHTTPServer.HTTPServer.__init__(self, server_address,
73
self.test_case = test_case
76
class TestCaseWithWebserver(TestCaseInTempDir):
77
"""Derived class that starts a localhost-only webserver
78
(in addition to what TestCaseInTempDir does).
80
This is useful for testing RemoteBranch.
83
_HTTP_PORTS = range(13000, 0x8000)
85
def _http_start(self):
86
import SimpleHTTPServer, BaseHTTPServer, socket, errno
88
for port in self._HTTP_PORTS:
90
httpd = TestingHTTPServer(('localhost', port),
91
TestingHTTPRequestHandler,
93
except socket.error, e:
94
if e.args[0] == errno.EADDRINUSE:
96
print >>sys.stderr, "Cannot run webserver :-("
102
raise WebserverNotAvailable("Cannot run webserver :-( "
103
"no free ports in range %s..%s" %
104
(_HTTP_PORTS[0], _HTTP_PORTS[-1]))
106
self._http_base_url = 'http://localhost:%s/' % port
107
self._http_starting.release()
108
httpd.socket.settimeout(0.1)
110
while self._http_running:
112
httpd.handle_request()
113
except socket.timeout:
203
class HTTPServerRedirecting(http_server.HttpServer):
204
"""An HttpServer redirecting to another server """
206
def __init__(self, request_handler=RedirectRequestHandler,
207
protocol_version=None):
208
http_server.HttpServer.__init__(self, request_handler,
209
protocol_version=protocol_version)
210
# redirections is a list of tuples (source, target, code)
211
# - source is a regexp for the paths requested
212
# - target is a replacement for re.sub describing where
213
# the request will be redirected
214
# - code is the http error code associated to the
215
# redirection (301 permanent, 302 temporarry, etc
216
self.redirections = []
218
def redirect_to(self, host, port):
219
"""Redirect all requests to a specific host:port"""
220
self.redirections = [('(.*)',
221
r'http://%s:%s\1' % (host, port),
224
def is_redirected(self, path):
225
"""Is the path redirected by this server.
227
:param path: the requested relative path
229
:returns: a tuple (code, target) if a matching
230
redirection is found, (None, None) otherwise.
234
for (rsource, rtarget, rcode) in self.redirections:
235
target, match = re.subn(rsource, rtarget, path, count=1)
238
break # The first match wins
244
class TestCaseWithRedirectedWebserver(TestCaseWithTwoWebservers):
245
"""A support class providing redirections from one server to another.
247
We set up two webservers to allows various tests involving
249
The 'old' server is redirected to the 'new' server.
116
def get_remote_url(self, path):
119
path_parts = path.split(os.path.sep)
120
if os.path.isabs(path):
121
if path_parts[:len(self._local_path_parts)] != \
122
self._local_path_parts:
123
raise BadWebserverPath(path, self.test_dir)
124
remote_path = '/'.join(path_parts[len(self._local_path_parts):])
126
remote_path = '/'.join(path_parts)
128
self._http_starting.acquire()
129
self._http_starting.release()
130
return self._http_base_url + remote_path
253
super(TestCaseWithRedirectedWebserver, self).setUp()
254
# The redirections will point to the new server
255
self.new_server = self.get_readonly_server()
256
# The requests to the old server will be redirected to the new server
257
self.old_server = self.get_secondary_server()
259
def create_transport_secondary_server(self):
260
"""Create the secondary server redirecting to the primary server"""
261
new = self.get_readonly_server()
262
redirecting = HTTPServerRedirecting(
263
protocol_version=self._protocol_version)
264
redirecting.redirect_to(new.host, new.port)
265
redirecting._url_protocol = self._url_protocol
268
def get_old_url(self, relpath=None):
269
base = self.old_server.get_url()
270
return self._adjust_url(base, relpath)
272
def get_old_transport(self, relpath=None):
273
t = transport.get_transport_from_url(self.get_old_url(relpath))
274
self.assertTrue(t.is_readonly())
277
def get_new_url(self, relpath=None):
278
base = self.new_server.get_url()
279
return self._adjust_url(base, relpath)
281
def get_new_transport(self, relpath=None):
282
t = transport.get_transport_from_url(self.get_new_url(relpath))
283
self.assertTrue(t.is_readonly())
287
class AuthRequestHandler(http_server.TestingHTTPRequestHandler):
288
"""Requires an authentication to process requests.
290
This is intended to be used with a server that always and
291
only use one authentication scheme (implemented by daughter
295
# The following attributes should be defined in the server
296
# - auth_header_sent: the header name sent to require auth
297
# - auth_header_recv: the header received containing auth
298
# - auth_error_code: the error code to indicate auth required
300
def _require_authentication(self):
301
# Note that we must update test_case_server *before*
302
# sending the error or the client may try to read it
303
# before we have sent the whole error back.
304
tcs = self.server.test_case_server
305
tcs.auth_required_errors += 1
306
self.send_response(tcs.auth_error_code)
307
self.send_header_auth_reqed()
308
# We do not send a body
309
self.send_header('Content-Length', '0')
314
if self.authorized():
315
return http_server.TestingHTTPRequestHandler.do_GET(self)
317
return self._require_authentication()
320
if self.authorized():
321
return http_server.TestingHTTPRequestHandler.do_HEAD(self)
323
return self._require_authentication()
326
class BasicAuthRequestHandler(AuthRequestHandler):
327
"""Implements the basic authentication of a request"""
329
def authorized(self):
330
tcs = self.server.test_case_server
331
if tcs.auth_scheme != 'basic':
334
auth_header = self.headers.get(tcs.auth_header_recv, None)
336
scheme, raw_auth = auth_header.split(' ', 1)
337
if scheme.lower() == tcs.auth_scheme:
338
user, password = base64.b64decode(raw_auth).split(b':')
339
return tcs.authorized(user.decode('ascii'),
340
password.decode('ascii'))
344
def send_header_auth_reqed(self):
345
tcs = self.server.test_case_server
346
self.send_header(tcs.auth_header_sent,
347
'Basic realm="%s"' % tcs.auth_realm)
350
# FIXME: We could send an Authentication-Info header too when
351
# the authentication is succesful
353
class DigestAuthRequestHandler(AuthRequestHandler):
354
"""Implements the digest authentication of a request.
356
We need persistence for some attributes and that can't be
357
achieved here since we get instantiated for each request. We
358
rely on the DigestAuthServer to take care of them.
361
def authorized(self):
362
tcs = self.server.test_case_server
364
auth_header = self.headers.get(tcs.auth_header_recv, None)
365
if auth_header is None:
367
scheme, auth = auth_header.split(None, 1)
368
if scheme.lower() == tcs.auth_scheme:
369
auth_dict = parse_keqv_list(parse_http_list(auth))
371
return tcs.digest_authorized(auth_dict, self.command)
375
def send_header_auth_reqed(self):
376
tcs = self.server.test_case_server
377
header = 'Digest realm="%s", ' % tcs.auth_realm
378
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
380
self.send_header(tcs.auth_header_sent, header)
383
class DigestAndBasicAuthRequestHandler(DigestAuthRequestHandler):
384
"""Implements a digest and basic authentication of a request.
386
I.e. the server proposes both schemes and the client should choose the best
387
one it can handle, which, in that case, should be digest, the only scheme
391
def send_header_auth_reqed(self):
392
tcs = self.server.test_case_server
393
self.send_header(tcs.auth_header_sent,
394
'Basic realm="%s"' % tcs.auth_realm)
395
header = 'Digest realm="%s", ' % tcs.auth_realm
396
header += 'nonce="%s", algorithm="%s", qop="auth"' % (tcs.auth_nonce,
398
self.send_header(tcs.auth_header_sent, header)
401
class AuthServer(http_server.HttpServer):
402
"""Extends HttpServer with a dictionary of passwords.
404
This is used as a base class for various schemes which should
405
all use or redefined the associated AuthRequestHandler.
407
Note that no users are defined by default, so add_user should
408
be called before issuing the first request.
411
# The following attributes should be set dy daughter classes
412
# and are used by AuthRequestHandler.
413
auth_header_sent = None
414
auth_header_recv = None
415
auth_error_code = None
416
auth_realm = u"Thou should not pass"
418
def __init__(self, request_handler, auth_scheme,
419
protocol_version=None):
420
http_server.HttpServer.__init__(self, request_handler,
421
protocol_version=protocol_version)
422
self.auth_scheme = auth_scheme
423
self.password_of = {}
424
self.auth_required_errors = 0
426
def add_user(self, user, password):
427
"""Declare a user with an associated password.
429
password can be empty, use an empty string ('') in that
432
self.password_of[user] = password
434
def authorized(self, user, password):
435
"""Check that the given user provided the right password"""
436
expected_password = self.password_of.get(user, None)
437
return expected_password is not None and password == expected_password
440
# FIXME: There is some code duplication with
441
# _urllib2_wrappers.py.DigestAuthHandler. If that duplication
442
# grows, it may require a refactoring. Also, we don't implement
443
# SHA algorithm nor MD5-sess here, but that does not seem worth
445
class DigestAuthServer(AuthServer):
446
"""A digest authentication server"""
450
def __init__(self, request_handler, auth_scheme,
451
protocol_version=None):
452
AuthServer.__init__(self, request_handler, auth_scheme,
453
protocol_version=protocol_version)
455
def digest_authorized(self, auth, command):
456
nonce = auth['nonce']
457
if nonce != self.auth_nonce:
459
realm = auth['realm']
460
if realm != self.auth_realm:
462
user = auth['username']
463
if user not in self.password_of:
465
algorithm = auth['algorithm']
466
if algorithm != 'MD5':
472
password = self.password_of[user]
474
# Recalculate the response_digest to compare with the one
476
A1 = ('%s:%s:%s' % (user, realm, password)).encode('utf-8')
477
A2 = ('%s:%s' % (command, auth['uri'])).encode('utf-8')
480
return osutils.md5(x).hexdigest()
482
def KD(secret, data):
483
return H(("%s:%s" % (secret, data)).encode('utf-8'))
485
nonce_count = int(auth['nc'], 16)
487
ncvalue = '%08x' % nonce_count
489
cnonce = auth['cnonce']
490
noncebit = '%s:%s:%s:%s:%s' % (nonce, ncvalue, cnonce, qop, H(A2))
491
response_digest = KD(H(A1), noncebit)
493
return response_digest == auth['response']
496
class HTTPAuthServer(AuthServer):
497
"""An HTTP server requiring authentication"""
499
def init_http_auth(self):
500
self.auth_header_sent = 'WWW-Authenticate'
501
self.auth_header_recv = 'Authorization'
502
self.auth_error_code = 401
505
class ProxyAuthServer(AuthServer):
506
"""A proxy server requiring authentication"""
508
def init_proxy_auth(self):
509
self.proxy_requests = True
510
self.auth_header_sent = 'Proxy-Authenticate'
511
self.auth_header_recv = 'Proxy-Authorization'
512
self.auth_error_code = 407
515
class HTTPBasicAuthServer(HTTPAuthServer):
516
"""An HTTP server requiring basic authentication"""
518
def __init__(self, protocol_version=None):
519
HTTPAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
520
protocol_version=protocol_version)
521
self.init_http_auth()
524
class HTTPDigestAuthServer(DigestAuthServer, HTTPAuthServer):
525
"""An HTTP server requiring digest authentication"""
527
def __init__(self, protocol_version=None):
528
DigestAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
529
protocol_version=protocol_version)
530
self.init_http_auth()
533
class HTTPBasicAndDigestAuthServer(DigestAuthServer, HTTPAuthServer):
534
"""An HTTP server requiring basic or digest authentication"""
536
def __init__(self, protocol_version=None):
537
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
539
protocol_version=protocol_version)
540
self.init_http_auth()
541
# We really accept Digest only
542
self.auth_scheme = 'digest'
545
class ProxyBasicAuthServer(ProxyAuthServer):
546
"""A proxy server requiring basic authentication"""
548
def __init__(self, protocol_version=None):
549
ProxyAuthServer.__init__(self, BasicAuthRequestHandler, 'basic',
550
protocol_version=protocol_version)
551
self.init_proxy_auth()
554
class ProxyDigestAuthServer(DigestAuthServer, ProxyAuthServer):
555
"""A proxy server requiring basic authentication"""
557
def __init__(self, protocol_version=None):
558
ProxyAuthServer.__init__(self, DigestAuthRequestHandler, 'digest',
559
protocol_version=protocol_version)
560
self.init_proxy_auth()
563
class ProxyBasicAndDigestAuthServer(DigestAuthServer, ProxyAuthServer):
564
"""An proxy server requiring basic or digest authentication"""
566
def __init__(self, protocol_version=None):
567
DigestAuthServer.__init__(self, DigestAndBasicAuthRequestHandler,
569
protocol_version=protocol_version)
570
self.init_proxy_auth()
571
# We really accept Digest only
572
self.auth_scheme = 'digest'
133
TestCaseInTempDir.setUp(self)
135
self._local_path_parts = self.test_dir.split(os.path.sep)
136
self._http_starting = threading.Lock()
137
self._http_starting.acquire()
138
self._http_running = True
139
self._http_base_url = None
140
self._http_thread = threading.Thread(target=self._http_start)
141
self._http_thread.setDaemon(True)
142
self._http_thread.start()
143
self._http_proxy = os.environ.get("http_proxy")
144
if self._http_proxy is not None:
145
del os.environ["http_proxy"]
148
self._http_running = False
149
self._http_thread.join()
150
if self._http_proxy is not None:
152
os.environ["http_proxy"] = self._http_proxy
153
TestCaseInTempDir.tearDown(self)
added
removed
bzrlib/selftest/HTTPTestUtil.py
