wireprotoserver.py
811 lines
| 27.2 KiB
| text/x-python
|
PythonLexer
/ mercurial / wireprotoserver.py
|
r35874 | # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net> | ||
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
from __future__ import absolute_import | ||||
|
r36083 | import contextlib | ||
|
r35874 | import struct | ||
|
r35877 | import sys | ||
|
r36540 | import threading | ||
|
r35874 | |||
|
r35877 | from .i18n import _ | ||
|
r37575 | from .thirdparty import ( | ||
cbor, | ||||
) | ||||
|
r35874 | from . import ( | ||
|
r35877 | encoding, | ||
|
r35874 | error, | ||
|
r35877 | hook, | ||
|
r35874 | pycompat, | ||
util, | ||||
|
r36090 | wireprototypes, | ||
|
r37803 | wireprotov1server, | ||
|
r37563 | wireprotov2server, | ||
|
r35874 | ) | ||
|
r37138 | from .utils import ( | ||
|
r37828 | interfaceutil, | ||
|
r37138 | procutil, | ||
) | ||||
|
r35874 | |||
stringio = util.stringio | ||||
urlerr = util.urlerr | ||||
urlreq = util.urlreq | ||||
|
r35876 | HTTP_OK = 200 | ||
|
r35874 | HGTYPE = 'application/mercurial-0.1' | ||
HGTYPE2 = 'application/mercurial-0.2' | ||||
HGERRTYPE = 'application/hg-error' | ||||
|
r36553 | SSHV1 = wireprototypes.SSHV1 | ||
SSHV2 = wireprototypes.SSHV2 | ||||
|
r35994 | |||
|
r36862 | def decodevaluefromheaders(req, headerprefix): | ||
|
r35874 | """Decode a long value from multiple HTTP request headers. | ||
Returns the value as a bytes, not a str. | ||||
""" | ||||
chunks = [] | ||||
i = 1 | ||||
while True: | ||||
|
r36862 | v = req.headers.get(b'%s-%d' % (headerprefix, i)) | ||
|
r35874 | if v is None: | ||
break | ||||
chunks.append(pycompat.bytesurl(v)) | ||||
i += 1 | ||||
return ''.join(chunks) | ||||
|
r37828 | @interfaceutil.implementer(wireprototypes.baseprotocolhandler) | ||
|
r37312 | class httpv1protocolhandler(object): | ||
|
r36883 | def __init__(self, req, ui, checkperm): | ||
|
r36862 | self._req = req | ||
|
r35884 | self._ui = ui | ||
|
r36819 | self._checkperm = checkperm | ||
|
r37411 | self._protocaps = None | ||
|
r35891 | |||
@property | ||||
def name(self): | ||||
|
r36241 | return 'http-v1' | ||
|
r35874 | |||
def getargs(self, args): | ||||
knownargs = self._args() | ||||
data = {} | ||||
keys = args.split() | ||||
for k in keys: | ||||
if k == '*': | ||||
star = {} | ||||
for key in knownargs.keys(): | ||||
if key != 'cmd' and key not in keys: | ||||
star[key] = knownargs[key][0] | ||||
data['*'] = star | ||||
else: | ||||
data[k] = knownargs[k][0] | ||||
return [data[k] for k in keys] | ||||
|
r35881 | |||
|
r35874 | def _args(self): | ||
|
r36878 | args = self._req.qsparams.asdictoflists() | ||
|
r36862 | postlen = int(self._req.headers.get(b'X-HgArgs-Post', 0)) | ||
|
r35874 | if postlen: | ||
|
r36094 | args.update(urlreq.parseqs( | ||
|
r36873 | self._req.bodyfh.read(postlen), keep_blank_values=True)) | ||
|
r35874 | return args | ||
|
r36862 | argvalue = decodevaluefromheaders(self._req, b'X-HgArg') | ||
|
r36094 | args.update(urlreq.parseqs(argvalue, keep_blank_values=True)) | ||
|
r35874 | return args | ||
|
r35881 | |||
|
r37411 | def getprotocaps(self): | ||
if self._protocaps is None: | ||||
|
r37608 | value = decodevaluefromheaders(self._req, b'X-HgProto') | ||
|
r37411 | self._protocaps = set(value.split(' ')) | ||
return self._protocaps | ||||
|
r37432 | def getpayload(self): | ||
|
r36863 | # Existing clients *always* send Content-Length. | ||
length = int(self._req.headers[b'Content-Length']) | ||||
|
r35874 | # If httppostargs is used, we need to read Content-Length | ||
# minus the amount that was consumed by args. | ||||
|
r36862 | length -= int(self._req.headers.get(b'X-HgArgs-Post', 0)) | ||
|
r37432 | return util.filechunkiter(self._req.bodyfh, limit=length) | ||
|
r35881 | |||
|
r36083 | @contextlib.contextmanager | ||
def mayberedirectstdio(self): | ||||
oldout = self._ui.fout | ||||
olderr = self._ui.ferr | ||||
out = util.stringio() | ||||
try: | ||||
self._ui.fout = out | ||||
self._ui.ferr = out | ||||
yield out | ||||
finally: | ||||
self._ui.fout = oldout | ||||
self._ui.ferr = olderr | ||||
|
r36086 | def client(self): | ||
|
r35874 | return 'remote:%s:%s:%s' % ( | ||
|
r36883 | self._req.urlscheme, | ||
urlreq.quote(self._req.remotehost or ''), | ||||
urlreq.quote(self._req.remoteuser or '')) | ||||
|
r35874 | |||
|
r36631 | def addcapabilities(self, repo, caps): | ||
|
r37071 | caps.append(b'batch') | ||
|
r36631 | caps.append('httpheader=%d' % | ||
repo.ui.configint('server', 'maxhttpheaderlen')) | ||||
if repo.ui.configbool('experimental', 'httppostargs'): | ||||
caps.append('httppostargs') | ||||
# FUTURE advertise 0.2rx once support is implemented | ||||
# FUTURE advertise minrx and mintx after consulting config option | ||||
caps.append('httpmediatype=0.1rx,0.1tx,0.2tx') | ||||
|
r37801 | compengines = wireprototypes.supportedcompengines(repo.ui, | ||
util.SERVERROLE) | ||||
|
r36631 | if compengines: | ||
comptypes = ','.join(urlreq.quote(e.wireprotosupport().name) | ||||
for e in compengines) | ||||
caps.append('compression=%s' % comptypes) | ||||
return caps | ||||
|
r36819 | def checkperm(self, perm): | ||
return self._checkperm(perm) | ||||
|
r36249 | # This method exists mostly so that extensions like remotefilelog can | ||
# disable a kludgey legacy method only over http. As of early 2018, | ||||
# there are no other known users, so with any luck we can discard this | ||||
# hook if remotefilelog becomes a first-party extension. | ||||
|
r35874 | def iscmd(cmd): | ||
|
r37803 | return cmd in wireprotov1server.commands | ||
|
r35874 | |||
|
r36893 | def handlewsgirequest(rctx, req, res, checkperm): | ||
|
r36830 | """Possibly process a wire protocol request. | ||
|
r36002 | |||
|
r36830 | If the current request is a wire protocol request, the request is | ||
processed by this function. | ||||
|
r36002 | |||
|
r36828 | ``req`` is a ``parsedrequest`` instance. | ||
|
r36877 | ``res`` is a ``wsgiresponse`` instance. | ||
|
r36830 | |||
|
r36877 | Returns a bool indicating if the request was serviced. If set, the caller | ||
should stop processing the request, as a response has already been issued. | ||||
|
r36002 | """ | ||
|
r36830 | # Avoid cycle involving hg module. | ||
from .hgweb import common as hgwebcommon | ||||
|
r36819 | repo = rctx.repo | ||
|
r36002 | # HTTP version 1 wire protocol requests are denoted by a "cmd" query | ||
# string parameter. If it isn't present, this isn't a wire protocol | ||||
# request. | ||||
|
r36878 | if 'cmd' not in req.qsparams: | ||
|
r36877 | return False | ||
|
r36002 | |||
|
r36878 | cmd = req.qsparams['cmd'] | ||
|
r36002 | |||
# The "cmd" request parameter is used by both the wire protocol and hgweb. | ||||
# While not all wire protocol commands are available for all transports, | ||||
# if we see a "cmd" value that resembles a known wire protocol command, we | ||||
# route it to a protocol handler. This is better than routing possible | ||||
# wire protocol requests to hgweb because it prevents hgweb from using | ||||
# known wire protocol commands and it is less confusing for machine | ||||
# clients. | ||||
|
r36249 | if not iscmd(cmd): | ||
|
r36877 | return False | ||
|
r36830 | |||
# The "cmd" query string argument is only valid on the root path of the | ||||
# repo. e.g. ``/?cmd=foo``, ``/repo?cmd=foo``. URL paths within the repo | ||||
# like ``/blah?cmd=foo`` are not allowed. So don't recognize the request | ||||
# in this case. We send an HTTP 404 for backwards compatibility reasons. | ||||
if req.dispatchpath: | ||||
|
r36877 | res.status = hgwebcommon.statusmessage(404) | ||
res.headers['Content-Type'] = HGTYPE | ||||
# TODO This is not a good response to issue for this request. This | ||||
# is mostly for BC for now. | ||||
res.setbodybytes('0\n%s\n' % b'Not Found') | ||||
return True | ||||
|
r36002 | |||
|
r36883 | proto = httpv1protocolhandler(req, repo.ui, | ||
|
r36893 | lambda perm: checkperm(rctx, req, perm)) | ||
|
r35874 | |||
|
r36830 | # The permissions checker should be the only thing that can raise an | ||
# ErrorResponse. It is kind of a layer violation to catch an hgweb | ||||
# exception here. So consider refactoring into a exception type that | ||||
# is associated with the wire protocol. | ||||
try: | ||||
|
r36883 | _callhttp(repo, req, res, proto, cmd) | ||
|
r36830 | except hgwebcommon.ErrorResponse as e: | ||
|
r36877 | for k, v in e.headers: | ||
res.headers[k] = v | ||||
res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e)) | ||||
# TODO This response body assumes the failed command was | ||||
# "unbundle." That assumption is not always valid. | ||||
res.setbodybytes('0\n%s\n' % pycompat.bytestr(e)) | ||||
|
r36830 | |||
|
r36877 | return True | ||
|
r36002 | |||
|
r37575 | def _availableapis(repo): | ||
apis = set() | ||||
# Registered APIs are made available via config options of the name of | ||||
# the protocol. | ||||
for k, v in API_HANDLERS.items(): | ||||
section, option = v['config'] | ||||
if repo.ui.configbool(section, option): | ||||
apis.add(k) | ||||
return apis | ||||
|
r37064 | def handlewsgiapirequest(rctx, req, res, checkperm): | ||
"""Handle requests to /api/*.""" | ||||
assert req.dispatchparts[0] == b'api' | ||||
repo = rctx.repo | ||||
# This whole URL space is experimental for now. But we want to | ||||
# reserve the URL space. So, 404 all URLs if the feature isn't enabled. | ||||
if not repo.ui.configbool('experimental', 'web.apiserver'): | ||||
res.status = b'404 Not Found' | ||||
res.headers[b'Content-Type'] = b'text/plain' | ||||
res.setbodybytes(_('Experimental API server endpoint not enabled')) | ||||
return | ||||
# The URL space is /api/<protocol>/*. The structure of URLs under varies | ||||
# by <protocol>. | ||||
|
r37575 | availableapis = _availableapis(repo) | ||
|
r37064 | |||
# Requests to /api/ list available APIs. | ||||
if req.dispatchparts == [b'api']: | ||||
res.status = b'200 OK' | ||||
res.headers[b'Content-Type'] = b'text/plain' | ||||
lines = [_('APIs can be accessed at /api/<name>, where <name> can be ' | ||||
'one of the following:\n')] | ||||
if availableapis: | ||||
lines.extend(sorted(availableapis)) | ||||
else: | ||||
lines.append(_('(no available APIs)\n')) | ||||
res.setbodybytes(b'\n'.join(lines)) | ||||
return | ||||
proto = req.dispatchparts[1] | ||||
if proto not in API_HANDLERS: | ||||
res.status = b'404 Not Found' | ||||
res.headers[b'Content-Type'] = b'text/plain' | ||||
res.setbodybytes(_('Unknown API: %s\nKnown APIs: %s') % ( | ||||
proto, b', '.join(sorted(availableapis)))) | ||||
return | ||||
if proto not in availableapis: | ||||
res.status = b'404 Not Found' | ||||
res.headers[b'Content-Type'] = b'text/plain' | ||||
res.setbodybytes(_('API %s not enabled\n') % proto) | ||||
return | ||||
API_HANDLERS[proto]['handler'](rctx, req, res, checkperm, | ||||
req.dispatchparts[2:]) | ||||
# Maps API name to metadata so custom API can be registered. | ||||
|
r37575 | # Keys are: | ||
# | ||||
# config | ||||
# Config option that controls whether service is enabled. | ||||
# handler | ||||
# Callable receiving (rctx, req, res, checkperm, urlparts) that is called | ||||
# when a request to this API is received. | ||||
# apidescriptor | ||||
# Callable receiving (req, repo) that is called to obtain an API | ||||
# descriptor for this service. The response must be serializable to CBOR. | ||||
|
r37064 | API_HANDLERS = { | ||
|
r37662 | wireprotov2server.HTTP_WIREPROTO_V2: { | ||
|
r37064 | 'config': ('experimental', 'web.api.http-v2'), | ||
|
r37563 | 'handler': wireprotov2server.handlehttpv2request, | ||
|
r37575 | 'apidescriptor': wireprotov2server.httpv2apidescriptor, | ||
|
r37064 | }, | ||
} | ||||
|
r37411 | def _httpresponsetype(ui, proto, prefer_uncompressed): | ||
|
r36089 | """Determine the appropriate response type and compression settings. | ||
Returns a tuple of (mediatype, compengine, engineopts). | ||||
""" | ||||
# Determine the response media type and compression engine based | ||||
# on the request parameters. | ||||
|
r37411 | if '0.2' in proto.getprotocaps(): | ||
|
r36089 | # All clients are expected to support uncompressed data. | ||
if prefer_uncompressed: | ||||
return HGTYPE2, util._noopengine(), {} | ||||
# Now find an agreed upon compression format. | ||||
|
r37803 | compformats = wireprotov1server.clientcompressionsupport(proto) | ||
|
r37801 | for engine in wireprototypes.supportedcompengines(ui, util.SERVERROLE): | ||
|
r36089 | if engine.wireprotosupport().name in compformats: | ||
opts = {} | ||||
level = ui.configint('server', '%slevel' % engine.name()) | ||||
if level is not None: | ||||
opts['level'] = level | ||||
return HGTYPE2, engine, opts | ||||
# No mutually supported compression format. Fall back to the | ||||
# legacy protocol. | ||||
# Don't allow untrusted settings because disabling compression or | ||||
# setting a very high compression level could lead to flooding | ||||
# the server's network or CPU. | ||||
opts = {'level': ui.configint('server', 'zliblevel')} | ||||
return HGTYPE, util.compengines['zlib'], opts | ||||
|
r37575 | def processcapabilitieshandshake(repo, req, res, proto): | ||
"""Called during a ?cmd=capabilities request. | ||||
If the client is advertising support for a newer protocol, we send | ||||
a CBOR response with information about available services. If no | ||||
advertised services are available, we don't handle the request. | ||||
""" | ||||
# Fall back to old behavior unless the API server is enabled. | ||||
if not repo.ui.configbool('experimental', 'web.apiserver'): | ||||
return False | ||||
clientapis = decodevaluefromheaders(req, b'X-HgUpgrade') | ||||
protocaps = decodevaluefromheaders(req, b'X-HgProto') | ||||
if not clientapis or not protocaps: | ||||
return False | ||||
# We currently only support CBOR responses. | ||||
protocaps = set(protocaps.split(' ')) | ||||
if b'cbor' not in protocaps: | ||||
return False | ||||
descriptors = {} | ||||
for api in sorted(set(clientapis.split()) & _availableapis(repo)): | ||||
handler = API_HANDLERS[api] | ||||
descriptorfn = handler.get('apidescriptor') | ||||
if not descriptorfn: | ||||
continue | ||||
descriptors[api] = descriptorfn(req, repo) | ||||
|
r37803 | v1caps = wireprotov1server.dispatch(repo, proto, 'capabilities') | ||
|
r37575 | assert isinstance(v1caps, wireprototypes.bytesresponse) | ||
m = { | ||||
# TODO allow this to be configurable. | ||||
'apibase': 'api/', | ||||
'apis': descriptors, | ||||
'v1capabilities': v1caps.data, | ||||
} | ||||
res.status = b'200 OK' | ||||
res.headers[b'Content-Type'] = b'application/mercurial-cbor' | ||||
res.setbodybytes(cbor.dumps(m, canonical=True)) | ||||
return True | ||||
|
r36883 | def _callhttp(repo, req, res, proto, cmd): | ||
|
r36877 | # Avoid cycle involving hg module. | ||
from .hgweb import common as hgwebcommon | ||||
|
r35874 | def genversion2(gen, engine, engineopts): | ||
# application/mercurial-0.2 always sends a payload header | ||||
# identifying the compression engine. | ||||
name = engine.wireprotosupport().name | ||||
assert 0 < len(name) < 256 | ||||
yield struct.pack('B', len(name)) | ||||
yield name | ||||
for chunk in gen: | ||||
yield chunk | ||||
|
r36877 | def setresponse(code, contenttype, bodybytes=None, bodygen=None): | ||
if code == HTTP_OK: | ||||
res.status = '200 Script output follows' | ||||
else: | ||||
res.status = hgwebcommon.statusmessage(code) | ||||
res.headers['Content-Type'] = contenttype | ||||
if bodybytes is not None: | ||||
res.setbodybytes(bodybytes) | ||||
if bodygen is not None: | ||||
res.setbodygen(bodygen) | ||||
|
r37803 | if not wireprotov1server.commands.commandavailable(cmd, proto): | ||
|
r36877 | setresponse(HTTP_OK, HGERRTYPE, | ||
_('requested wire protocol command is not available over ' | ||||
'HTTP')) | ||||
return | ||||
|
r36000 | |||
|
r37803 | proto.checkperm(wireprotov1server.commands[cmd].permission) | ||
|
r36817 | |||
|
r37575 | # Possibly handle a modern client wanting to switch protocols. | ||
if (cmd == 'capabilities' and | ||||
processcapabilitieshandshake(repo, req, res, proto)): | ||||
return | ||||
|
r37803 | rsp = wireprotov1server.dispatch(repo, proto, cmd) | ||
|
r36816 | |||
|
r35874 | if isinstance(rsp, bytes): | ||
|
r36877 | setresponse(HTTP_OK, HGTYPE, bodybytes=rsp) | ||
|
r36091 | elif isinstance(rsp, wireprototypes.bytesresponse): | ||
|
r36877 | setresponse(HTTP_OK, HGTYPE, bodybytes=rsp.data) | ||
|
r36090 | elif isinstance(rsp, wireprototypes.streamreslegacy): | ||
|
r36877 | setresponse(HTTP_OK, HGTYPE, bodygen=rsp.gen) | ||
|
r36090 | elif isinstance(rsp, wireprototypes.streamres): | ||
|
r35874 | gen = rsp.gen | ||
# This code for compression should not be streamres specific. It | ||||
# is here because we only compress streamres at the moment. | ||||
|
r36089 | mediatype, engine, engineopts = _httpresponsetype( | ||
|
r37411 | repo.ui, proto, rsp.prefer_uncompressed) | ||
|
r35874 | gen = engine.compressstream(gen, engineopts) | ||
if mediatype == HGTYPE2: | ||||
gen = genversion2(gen, engine, engineopts) | ||||
|
r36877 | setresponse(HTTP_OK, mediatype, bodygen=gen) | ||
|
r36090 | elif isinstance(rsp, wireprototypes.pushres): | ||
|
r36084 | rsp = '%d\n%s' % (rsp.res, rsp.output) | ||
|
r36877 | setresponse(HTTP_OK, HGTYPE, bodybytes=rsp) | ||
|
r36090 | elif isinstance(rsp, wireprototypes.pusherr): | ||
|
r35874 | rsp = '0\n%s\n' % rsp.res | ||
|
r36877 | res.drain = True | ||
setresponse(HTTP_OK, HGTYPE, bodybytes=rsp) | ||||
|
r36090 | elif isinstance(rsp, wireprototypes.ooberror): | ||
|
r36877 | setresponse(HTTP_OK, HGERRTYPE, bodybytes=rsp.message) | ||
else: | ||||
raise error.ProgrammingError('hgweb.protocol internal failure', rsp) | ||||
|
r36004 | |||
|
r36081 | def _sshv1respondbytes(fout, value): | ||
"""Send a bytes response for protocol version 1.""" | ||||
fout.write('%d\n' % len(value)) | ||||
fout.write(value) | ||||
fout.flush() | ||||
def _sshv1respondstream(fout, source): | ||||
write = fout.write | ||||
for chunk in source.gen: | ||||
write(chunk) | ||||
fout.flush() | ||||
def _sshv1respondooberror(fout, ferr, rsp): | ||||
ferr.write(b'%s\n-\n' % rsp) | ||||
ferr.flush() | ||||
fout.write(b'\n') | ||||
fout.flush() | ||||
|
r37828 | @interfaceutil.implementer(wireprototypes.baseprotocolhandler) | ||
|
r37312 | class sshv1protocolhandler(object): | ||
|
r36082 | """Handler for requests services via version 1 of SSH protocol.""" | ||
def __init__(self, ui, fin, fout): | ||||
|
r35888 | self._ui = ui | ||
|
r36082 | self._fin = fin | ||
self._fout = fout | ||||
|
r37411 | self._protocaps = set() | ||
|
r35877 | |||
|
r35891 | @property | ||
def name(self): | ||||
|
r36553 | return wireprototypes.SSHV1 | ||
|
r35891 | |||
|
r35877 | def getargs(self, args): | ||
data = {} | ||||
keys = args.split() | ||||
for n in xrange(len(keys)): | ||||
|
r35888 | argline = self._fin.readline()[:-1] | ||
|
r35877 | arg, l = argline.split() | ||
if arg not in keys: | ||||
raise error.Abort(_("unexpected parameter %r") % arg) | ||||
if arg == '*': | ||||
star = {} | ||||
for k in xrange(int(l)): | ||||
|
r35888 | argline = self._fin.readline()[:-1] | ||
|
r35877 | arg, l = argline.split() | ||
|
r35888 | val = self._fin.read(int(l)) | ||
|
r35877 | star[arg] = val | ||
data['*'] = star | ||||
else: | ||||
|
r35888 | val = self._fin.read(int(l)) | ||
|
r35877 | data[arg] = val | ||
return [data[k] for k in keys] | ||||
|
r37411 | def getprotocaps(self): | ||
return self._protocaps | ||||
|
r37432 | def getpayload(self): | ||
|
r36390 | # We initially send an empty response. This tells the client it is | ||
# OK to start sending data. If a client sees any other response, it | ||||
# interprets it as an error. | ||||
_sshv1respondbytes(self._fout, b'') | ||||
|
r36087 | # The file is in the form: | ||
# | ||||
# <chunk size>\n<chunk> | ||||
# ... | ||||
# 0\n | ||||
|
r35888 | count = int(self._fin.readline()) | ||
|
r35877 | while count: | ||
|
r37432 | yield self._fin.read(count) | ||
|
r35888 | count = int(self._fin.readline()) | ||
|
r35877 | |||
|
r36083 | @contextlib.contextmanager | ||
def mayberedirectstdio(self): | ||||
yield None | ||||
|
r36086 | def client(self): | ||
|
r36082 | client = encoding.environ.get('SSH_CLIENT', '').split(' ', 1)[0] | ||
return 'remote:ssh:' + client | ||||
|
r36631 | def addcapabilities(self, repo, caps): | ||
|
r37411 | if self.name == wireprototypes.SSHV1: | ||
caps.append(b'protocaps') | ||||
|
r37071 | caps.append(b'batch') | ||
|
r36631 | return caps | ||
|
r36819 | def checkperm(self, perm): | ||
pass | ||||
|
r36233 | class sshv2protocolhandler(sshv1protocolhandler): | ||
"""Protocol handler for version 2 of the SSH protocol.""" | ||||
|
r36628 | @property | ||
def name(self): | ||||
return wireprototypes.SSHV2 | ||||
|
r37551 | def addcapabilities(self, repo, caps): | ||
return caps | ||||
|
r36540 | def _runsshserver(ui, repo, fin, fout, ev): | ||
|
r36233 | # This function operates like a state machine of sorts. The following | ||
# states are defined: | ||||
# | ||||
# protov1-serving | ||||
# Server is in protocol version 1 serving mode. Commands arrive on | ||||
# new lines. These commands are processed in this state, one command | ||||
# after the other. | ||||
# | ||||
# protov2-serving | ||||
# Server is in protocol version 2 serving mode. | ||||
# | ||||
# upgrade-initial | ||||
# The server is going to process an upgrade request. | ||||
# | ||||
# upgrade-v2-filter-legacy-handshake | ||||
# The protocol is being upgraded to version 2. The server is expecting | ||||
# the legacy handshake from version 1. | ||||
# | ||||
# upgrade-v2-finish | ||||
# The upgrade to version 2 of the protocol is imminent. | ||||
# | ||||
# shutdown | ||||
# The server is shutting down, possibly in reaction to a client event. | ||||
# | ||||
# And here are their transitions: | ||||
# | ||||
# protov1-serving -> shutdown | ||||
# When server receives an empty request or encounters another | ||||
# error. | ||||
# | ||||
# protov1-serving -> upgrade-initial | ||||
# An upgrade request line was seen. | ||||
# | ||||
# upgrade-initial -> upgrade-v2-filter-legacy-handshake | ||||
# Upgrade to version 2 in progress. Server is expecting to | ||||
# process a legacy handshake. | ||||
# | ||||
# upgrade-v2-filter-legacy-handshake -> shutdown | ||||
# Client did not fulfill upgrade handshake requirements. | ||||
# | ||||
# upgrade-v2-filter-legacy-handshake -> upgrade-v2-finish | ||||
# Client fulfilled version 2 upgrade requirements. Finishing that | ||||
# upgrade. | ||||
# | ||||
# upgrade-v2-finish -> protov2-serving | ||||
# Protocol upgrade to version 2 complete. Server can now speak protocol | ||||
# version 2. | ||||
# | ||||
# protov2-serving -> protov1-serving | ||||
# Ths happens by default since protocol version 2 is the same as | ||||
# version 1 except for the handshake. | ||||
|
r36232 | state = 'protov1-serving' | ||
proto = sshv1protocolhandler(ui, fin, fout) | ||||
|
r36233 | protoswitched = False | ||
|
r36232 | |||
|
r36540 | while not ev.is_set(): | ||
|
r36232 | if state == 'protov1-serving': | ||
# Commands are issued on new lines. | ||||
request = fin.readline()[:-1] | ||||
# Empty lines signal to terminate the connection. | ||||
if not request: | ||||
state = 'shutdown' | ||||
continue | ||||
|
r36233 | # It looks like a protocol upgrade request. Transition state to | ||
# handle it. | ||||
if request.startswith(b'upgrade '): | ||||
if protoswitched: | ||||
_sshv1respondooberror(fout, ui.ferr, | ||||
b'cannot upgrade protocols multiple ' | ||||
b'times') | ||||
state = 'shutdown' | ||||
continue | ||||
state = 'upgrade-initial' | ||||
continue | ||||
|
r37803 | available = wireprotov1server.commands.commandavailable( | ||
request, proto) | ||||
|
r36232 | |||
# This command isn't available. Send an empty response and go | ||||
# back to waiting for a new command. | ||||
if not available: | ||||
_sshv1respondbytes(fout, b'') | ||||
continue | ||||
|
r37803 | rsp = wireprotov1server.dispatch(repo, proto, request) | ||
|
r36232 | |||
if isinstance(rsp, bytes): | ||||
_sshv1respondbytes(fout, rsp) | ||||
elif isinstance(rsp, wireprototypes.bytesresponse): | ||||
_sshv1respondbytes(fout, rsp.data) | ||||
elif isinstance(rsp, wireprototypes.streamres): | ||||
_sshv1respondstream(fout, rsp) | ||||
elif isinstance(rsp, wireprototypes.streamreslegacy): | ||||
_sshv1respondstream(fout, rsp) | ||||
elif isinstance(rsp, wireprototypes.pushres): | ||||
_sshv1respondbytes(fout, b'') | ||||
_sshv1respondbytes(fout, b'%d' % rsp.res) | ||||
elif isinstance(rsp, wireprototypes.pusherr): | ||||
_sshv1respondbytes(fout, rsp.res) | ||||
elif isinstance(rsp, wireprototypes.ooberror): | ||||
_sshv1respondooberror(fout, ui.ferr, rsp.message) | ||||
else: | ||||
raise error.ProgrammingError('unhandled response type from ' | ||||
'wire protocol command: %s' % rsp) | ||||
|
r36233 | # For now, protocol version 2 serving just goes back to version 1. | ||
elif state == 'protov2-serving': | ||||
state = 'protov1-serving' | ||||
continue | ||||
elif state == 'upgrade-initial': | ||||
# We should never transition into this state if we've switched | ||||
# protocols. | ||||
assert not protoswitched | ||||
|
r36553 | assert proto.name == wireprototypes.SSHV1 | ||
|
r36233 | |||
# Expected: upgrade <token> <capabilities> | ||||
# If we get something else, the request is malformed. It could be | ||||
# from a future client that has altered the upgrade line content. | ||||
# We treat this as an unknown command. | ||||
try: | ||||
token, caps = request.split(b' ')[1:] | ||||
except ValueError: | ||||
_sshv1respondbytes(fout, b'') | ||||
state = 'protov1-serving' | ||||
continue | ||||
# Send empty response if we don't support upgrading protocols. | ||||
if not ui.configbool('experimental', 'sshserver.support-v2'): | ||||
_sshv1respondbytes(fout, b'') | ||||
state = 'protov1-serving' | ||||
continue | ||||
try: | ||||
caps = urlreq.parseqs(caps) | ||||
except ValueError: | ||||
_sshv1respondbytes(fout, b'') | ||||
state = 'protov1-serving' | ||||
continue | ||||
# We don't see an upgrade request to protocol version 2. Ignore | ||||
# the upgrade request. | ||||
wantedprotos = caps.get(b'proto', [b''])[0] | ||||
if SSHV2 not in wantedprotos: | ||||
_sshv1respondbytes(fout, b'') | ||||
state = 'protov1-serving' | ||||
continue | ||||
# It looks like we can honor this upgrade request to protocol 2. | ||||
# Filter the rest of the handshake protocol request lines. | ||||
state = 'upgrade-v2-filter-legacy-handshake' | ||||
continue | ||||
elif state == 'upgrade-v2-filter-legacy-handshake': | ||||
# Client should have sent legacy handshake after an ``upgrade`` | ||||
# request. Expected lines: | ||||
# | ||||
# hello | ||||
# between | ||||
# pairs 81 | ||||
# 0000...-0000... | ||||
ok = True | ||||
for line in (b'hello', b'between', b'pairs 81'): | ||||
request = fin.readline()[:-1] | ||||
if request != line: | ||||
_sshv1respondooberror(fout, ui.ferr, | ||||
b'malformed handshake protocol: ' | ||||
b'missing %s' % line) | ||||
ok = False | ||||
state = 'shutdown' | ||||
break | ||||
if not ok: | ||||
continue | ||||
request = fin.read(81) | ||||
if request != b'%s-%s' % (b'0' * 40, b'0' * 40): | ||||
_sshv1respondooberror(fout, ui.ferr, | ||||
b'malformed handshake protocol: ' | ||||
b'missing between argument value') | ||||
state = 'shutdown' | ||||
continue | ||||
state = 'upgrade-v2-finish' | ||||
continue | ||||
elif state == 'upgrade-v2-finish': | ||||
# Send the upgrade response. | ||||
fout.write(b'upgraded %s %s\n' % (token, SSHV2)) | ||||
|
r37803 | servercaps = wireprotov1server.capabilities(repo, proto) | ||
|
r36233 | rsp = b'capabilities: %s' % servercaps.data | ||
fout.write(b'%d\n%s\n' % (len(rsp), rsp)) | ||||
fout.flush() | ||||
proto = sshv2protocolhandler(ui, fin, fout) | ||||
protoswitched = True | ||||
state = 'protov2-serving' | ||||
continue | ||||
|
r36232 | elif state == 'shutdown': | ||
break | ||||
else: | ||||
raise error.ProgrammingError('unhandled ssh server state: %s' % | ||||
state) | ||||
|
r36082 | class sshserver(object): | ||
|
r36543 | def __init__(self, ui, repo, logfh=None): | ||
|
r36082 | self._ui = ui | ||
self._repo = repo | ||||
self._fin = ui.fin | ||||
self._fout = ui.fout | ||||
|
r36543 | # Log write I/O to stdout and stderr if configured. | ||
if logfh: | ||||
self._fout = util.makeloggingfileobject( | ||||
logfh, self._fout, 'o', logdata=True) | ||||
ui.ferr = util.makeloggingfileobject( | ||||
logfh, ui.ferr, 'e', logdata=True) | ||||
|
r36082 | hook.redirect(True) | ||
ui.fout = repo.ui.fout = ui.ferr | ||||
# Prevent insertion/deletion of CRs | ||||
|
r37138 | procutil.setbinary(self._fin) | ||
procutil.setbinary(self._fout) | ||||
|
r36082 | |||
|
r35877 | def serve_forever(self): | ||
|
r36540 | self.serveuntil(threading.Event()) | ||
|
r35877 | sys.exit(0) | ||
|
r36540 | |||
def serveuntil(self, ev): | ||||
"""Serve until a threading.Event is set.""" | ||||
_runsshserver(self._ui, self._repo, self._fin, self._fout, ev) | ||||