Mercurial > hg
annotate tests/test-sshserver.py @ 37048:fc5e261915b9
wireproto: require POST for all HTTPv2 requests
Wire protocol version 1 transfers argument data via request
headers by default. This has historically caused problems because
servers institute limits on the length of individual HTTP headers
as well as the total size of all request headers. Mercurial servers
can advertise the maximum length of an individual header. But
there's no guarantee any intermediate HTTP agents will accept
headers up to that length.
In the existing wire protocol, server operators typically also
key off the HTTP request method to implement authentication.
For example, GET requests translate to read-only requests and
can be allowed. But read-write commands must use POST and require
authentication. This has typically worked because the only wire
protocol commands that use POST modify the repo (e.g. the
"unbundle" command).
There is an experimental feature to enable clients to transmit
argument data via POST request bodies. This is technically a
better and more robust solution. But we can't enable it by default
because of servers assuming POST means write access.
In version 2 of the wire protocol, the permissions of a request
are encoded in the URL. And with it being a new protocol in a new
URL space, we're not constrained by backwards compatibility
requirements.
This commit adopts the technically superior mechanism of using
HTTP request bodies to send argument data by requiring POST for
all commands. Strictly speaking, it may be possible to send
request bodies on GET requests. But my experience is that not all
HTTP stacks support this. POST pretty much always works. Using POST
for read-only operations does sacrifice some RESTful design
purity. But this API cares about practicality, not about being
in Roy T. Fielding's REST ivory tower.
There's a chance we may relax this restriction in the future. But
for now, I want to see how far we can get with a POST only API.
Differential Revision: https://phab.mercurial-scm.org/D2837
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 13 Mar 2018 11:57:43 -0700 |
parents | 3b3a987bbbaa |
children | a8a902d7176e |
rev | line source |
---|---|
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
1 from __future__ import absolute_import, print_function |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
2 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
3 import io |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
4 import unittest |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
5 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
6 import silenttestrunner |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
7 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
8 from mercurial import ( |
35772
7764ff13318e
test-sshserver: stabilize for Windows
Matt Harbison <matt_harbison@yahoo.com>
parents:
35752
diff
changeset
|
9 util, |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
10 wireproto, |
35859
1bf5263fe5cc
wireprotoserver: move sshserver into module (API)
Gregory Szorc <gregory.szorc@gmail.com>
parents:
35772
diff
changeset
|
11 wireprotoserver, |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
12 ) |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
13 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
14 class SSHServerGetArgsTests(unittest.TestCase): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
15 def testparseknown(self): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
16 tests = [ |
36212
7a46f0735904
py3: add b'' to test-sshserver.py
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36065
diff
changeset
|
17 (b'* 0\nnodes 0\n', [b'', {}]), |
7a46f0735904
py3: add b'' to test-sshserver.py
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36065
diff
changeset
|
18 (b'* 0\nnodes 40\n1111111111111111111111111111111111111111\n', |
7a46f0735904
py3: add b'' to test-sshserver.py
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36065
diff
changeset
|
19 [b'1111111111111111111111111111111111111111', {}]), |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
20 ] |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
21 for input, expected in tests: |
36212
7a46f0735904
py3: add b'' to test-sshserver.py
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36065
diff
changeset
|
22 self.assertparse(b'known', input, expected) |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
23 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
24 def assertparse(self, cmd, input, expected): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
25 server = mockserver(input) |
36214
3b3a987bbbaa
wireprotoserver: move SSH server operation to a standalone function
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36212
diff
changeset
|
26 proto = wireprotoserver.sshv1protocolhandler(server._ui, |
3b3a987bbbaa
wireprotoserver: move SSH server operation to a standalone function
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36212
diff
changeset
|
27 server._fin, |
3b3a987bbbaa
wireprotoserver: move SSH server operation to a standalone function
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36212
diff
changeset
|
28 server._fout) |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
29 _func, spec = wireproto.commands[cmd] |
36214
3b3a987bbbaa
wireprotoserver: move SSH server operation to a standalone function
Gregory Szorc <gregory.szorc@gmail.com>
parents:
36212
diff
changeset
|
30 self.assertEqual(proto.getargs(spec), expected) |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
31 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
32 def mockserver(inbytes): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
33 ui = mockui(inbytes) |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
34 repo = mockrepo(ui) |
35859
1bf5263fe5cc
wireprotoserver: move sshserver into module (API)
Gregory Szorc <gregory.szorc@gmail.com>
parents:
35772
diff
changeset
|
35 return wireprotoserver.sshserver(ui, repo) |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
36 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
37 class mockrepo(object): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
38 def __init__(self, ui): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
39 self.ui = ui |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
40 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
41 class mockui(object): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
42 def __init__(self, inbytes): |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
43 self.fin = io.BytesIO(inbytes) |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
44 self.fout = io.BytesIO() |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
45 self.ferr = io.BytesIO() |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
46 |
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
47 if __name__ == '__main__': |
35772
7764ff13318e
test-sshserver: stabilize for Windows
Matt Harbison <matt_harbison@yahoo.com>
parents:
35752
diff
changeset
|
48 # Don't call into msvcrt to set BytesIO to binary mode |
7764ff13318e
test-sshserver: stabilize for Windows
Matt Harbison <matt_harbison@yahoo.com>
parents:
35752
diff
changeset
|
49 util.setbinary = lambda fp: True |
35752
047581ddb6ce
sshserver: add a couple of tests for argument parsing
Siddharth Agarwal <sid0@fb.com>
parents:
diff
changeset
|
50 silenttestrunner.main(__name__) |