Split out basic WebSocket server template
This commit is contained in:
parent
8a69762249
commit
e47591f4aa
|
@ -12,9 +12,9 @@ as taken from http://docs.python.org/dev/library/ssl.html#certificates
|
||||||
|
|
||||||
import os, sys, select, optparse, logging
|
import os, sys, select, optparse, logging
|
||||||
sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
|
sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
|
||||||
from websockify.websocketserver import WebSocketServer, WebSocketRequestHandler
|
from websockify.websockifyserver import WebSockifyServer, WebSockifyRequestHandler
|
||||||
|
|
||||||
class WebSocketEcho(WebSocketRequestHandler):
|
class WebSocketEcho(WebSockifyRequestHandler):
|
||||||
"""
|
"""
|
||||||
WebSockets server that echos back whatever is received from the
|
WebSockets server that echos back whatever is received from the
|
||||||
client. """
|
client. """
|
||||||
|
@ -71,6 +71,6 @@ if __name__ == '__main__':
|
||||||
logging.basicConfig(level=logging.INFO)
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
|
||||||
opts.web = "."
|
opts.web = "."
|
||||||
server = WebSocketServer(WebSocketEcho, **opts.__dict__)
|
server = WebSockifyServer(WebSocketEcho, **opts.__dict__)
|
||||||
server.start_server()
|
server.start_server()
|
||||||
|
|
||||||
|
|
|
@ -8,9 +8,9 @@ given a sequence number. Any errors are reported and counted.
|
||||||
|
|
||||||
import sys, os, select, random, time, optparse, logging
|
import sys, os, select, random, time, optparse, logging
|
||||||
sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
|
sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
|
||||||
from websockify.websocketserver import WebSocketServer, WebSocketRequestHandler
|
from websockify.websockifyserver import WebSockifyServer, WebSockifyRequestHandler
|
||||||
|
|
||||||
class WebSocketLoadServer(WebSocketServer):
|
class WebSocketLoadServer(WebSockifyServer):
|
||||||
|
|
||||||
recv_cnt = 0
|
recv_cnt = 0
|
||||||
send_cnt = 0
|
send_cnt = 0
|
||||||
|
@ -18,10 +18,10 @@ class WebSocketLoadServer(WebSocketServer):
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
self.delay = kwargs.pop('delay')
|
self.delay = kwargs.pop('delay')
|
||||||
|
|
||||||
WebSocketServer.__init__(self, *args, **kwargs)
|
WebSockifyServer.__init__(self, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
class WebSocketLoad(WebSocketRequestHandler):
|
class WebSocketLoad(WebSockifyRequestHandler):
|
||||||
|
|
||||||
max_packet_size = 10000
|
max_packet_size = 10000
|
||||||
|
|
||||||
|
|
|
@ -22,7 +22,7 @@ import socket
|
||||||
|
|
||||||
from mox3 import stubout
|
from mox3 import stubout
|
||||||
|
|
||||||
from websockify import websocketserver
|
from websockify import websockifyserver
|
||||||
from websockify import websocketproxy
|
from websockify import websocketproxy
|
||||||
from websockify import token_plugins
|
from websockify import token_plugins
|
||||||
from websockify import auth_plugins
|
from websockify import auth_plugins
|
||||||
|
@ -75,7 +75,7 @@ class ProxyRequestHandlerTestCase(unittest.TestCase):
|
||||||
FakeSocket(''), "127.0.0.1", FakeServer())
|
FakeSocket(''), "127.0.0.1", FakeServer())
|
||||||
self.handler.path = "https://localhost:6080/websockify?token=blah"
|
self.handler.path = "https://localhost:6080/websockify?token=blah"
|
||||||
self.handler.headers = None
|
self.handler.headers = None
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'socket',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'socket',
|
||||||
staticmethod(lambda *args, **kwargs: None))
|
staticmethod(lambda *args, **kwargs: None))
|
||||||
|
|
||||||
def tearDown(self):
|
def tearDown(self):
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
# License for the specific language governing permissions and limitations
|
# License for the specific language governing permissions and limitations
|
||||||
# under the License.
|
# under the License.
|
||||||
|
|
||||||
""" Unit tests for websocketserver """
|
""" Unit tests for websockifyserver """
|
||||||
import errno
|
import errno
|
||||||
import os
|
import os
|
||||||
import logging
|
import logging
|
||||||
|
@ -28,12 +28,12 @@ import tempfile
|
||||||
import unittest
|
import unittest
|
||||||
import socket
|
import socket
|
||||||
import signal
|
import signal
|
||||||
from websockify import websocketserver
|
from websockify import websockifyserver
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from SimpleHTTPServer import SimpleHTTPRequestHandler
|
from BaseHTTPServer import BaseHTTPRequestHandler
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from http.server import SimpleHTTPRequestHandler
|
from http.server import BaseHTTPRequestHandler
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from StringIO import StringIO
|
from StringIO import StringIO
|
||||||
|
@ -70,26 +70,26 @@ class FakeSocket(object):
|
||||||
return StringIO(self._data.decode('latin_1'))
|
return StringIO(self._data.decode('latin_1'))
|
||||||
|
|
||||||
|
|
||||||
class WebSocketRequestHandlerTestCase(unittest.TestCase):
|
class WebSockifyRequestHandlerTestCase(unittest.TestCase):
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
super(WebSocketRequestHandlerTestCase, self).setUp()
|
super(WebSockifyRequestHandlerTestCase, self).setUp()
|
||||||
self.stubs = stubout.StubOutForTesting()
|
self.stubs = stubout.StubOutForTesting()
|
||||||
self.tmpdir = tempfile.mkdtemp('-websockify-tests')
|
self.tmpdir = tempfile.mkdtemp('-websockify-tests')
|
||||||
# Mock this out cause it screws tests up
|
# Mock this out cause it screws tests up
|
||||||
self.stubs.Set(os, 'chdir', lambda *args, **kwargs: None)
|
self.stubs.Set(os, 'chdir', lambda *args, **kwargs: None)
|
||||||
self.stubs.Set(SimpleHTTPRequestHandler, 'send_response',
|
self.stubs.Set(BaseHTTPRequestHandler, 'send_response',
|
||||||
lambda *args, **kwargs: None)
|
lambda *args, **kwargs: None)
|
||||||
|
|
||||||
def tearDown(self):
|
def tearDown(self):
|
||||||
"""Called automatically after each test."""
|
"""Called automatically after each test."""
|
||||||
self.stubs.UnsetAll()
|
self.stubs.UnsetAll()
|
||||||
os.rmdir(self.tmpdir)
|
os.rmdir(self.tmpdir)
|
||||||
super(WebSocketRequestHandlerTestCase, self).tearDown()
|
super(WebSockifyRequestHandlerTestCase, self).tearDown()
|
||||||
|
|
||||||
def _get_server(self, handler_class=websocketserver.WebSocketRequestHandler,
|
def _get_server(self, handler_class=websockifyserver.WebSockifyRequestHandler,
|
||||||
**kwargs):
|
**kwargs):
|
||||||
web = kwargs.pop('web', self.tmpdir)
|
web = kwargs.pop('web', self.tmpdir)
|
||||||
return websocketserver.WebSocketServer(
|
return websockifyserver.WebSockifyServer(
|
||||||
handler_class, listen_host='localhost',
|
handler_class, listen_host='localhost',
|
||||||
listen_port=80, key=self.tmpdir, web=web,
|
listen_port=80, key=self.tmpdir, web=web,
|
||||||
record=self.tmpdir, daemon=False, ssl_only=0, idle_timeout=1,
|
record=self.tmpdir, daemon=False, ssl_only=0, idle_timeout=1,
|
||||||
|
@ -97,13 +97,13 @@ class WebSocketRequestHandlerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
def test_normal_get_with_only_upgrade_returns_error(self):
|
def test_normal_get_with_only_upgrade_returns_error(self):
|
||||||
server = self._get_server(web=None)
|
server = self._get_server(web=None)
|
||||||
handler = websocketserver.WebSocketRequestHandler(
|
handler = websockifyserver.WebSockifyRequestHandler(
|
||||||
FakeSocket('GET /tmp.txt HTTP/1.1'), '127.0.0.1', server)
|
FakeSocket('GET /tmp.txt HTTP/1.1'), '127.0.0.1', server)
|
||||||
|
|
||||||
def fake_send_response(self, code, message=None):
|
def fake_send_response(self, code, message=None):
|
||||||
self.last_code = code
|
self.last_code = code
|
||||||
|
|
||||||
self.stubs.Set(SimpleHTTPRequestHandler, 'send_response',
|
self.stubs.Set(BaseHTTPRequestHandler, 'send_response',
|
||||||
fake_send_response)
|
fake_send_response)
|
||||||
|
|
||||||
handler.do_GET()
|
handler.do_GET()
|
||||||
|
@ -111,13 +111,13 @@ class WebSocketRequestHandlerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
def test_list_dir_with_file_only_returns_error(self):
|
def test_list_dir_with_file_only_returns_error(self):
|
||||||
server = self._get_server(file_only=True)
|
server = self._get_server(file_only=True)
|
||||||
handler = websocketserver.WebSocketRequestHandler(
|
handler = websockifyserver.WebSockifyRequestHandler(
|
||||||
FakeSocket('GET / HTTP/1.1'), '127.0.0.1', server)
|
FakeSocket('GET / HTTP/1.1'), '127.0.0.1', server)
|
||||||
|
|
||||||
def fake_send_response(self, code, message=None):
|
def fake_send_response(self, code, message=None):
|
||||||
self.last_code = code
|
self.last_code = code
|
||||||
|
|
||||||
self.stubs.Set(SimpleHTTPRequestHandler, 'send_response',
|
self.stubs.Set(BaseHTTPRequestHandler, 'send_response',
|
||||||
fake_send_response)
|
fake_send_response)
|
||||||
|
|
||||||
handler.path = '/'
|
handler.path = '/'
|
||||||
|
@ -125,9 +125,9 @@ class WebSocketRequestHandlerTestCase(unittest.TestCase):
|
||||||
self.assertEqual(handler.last_code, 404)
|
self.assertEqual(handler.last_code, 404)
|
||||||
|
|
||||||
|
|
||||||
class WebSocketServerTestCase(unittest.TestCase):
|
class WebSockifyServerTestCase(unittest.TestCase):
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
super(WebSocketServerTestCase, self).setUp()
|
super(WebSockifyServerTestCase, self).setUp()
|
||||||
self.stubs = stubout.StubOutForTesting()
|
self.stubs = stubout.StubOutForTesting()
|
||||||
self.tmpdir = tempfile.mkdtemp('-websockify-tests')
|
self.tmpdir = tempfile.mkdtemp('-websockify-tests')
|
||||||
# Mock this out cause it screws tests up
|
# Mock this out cause it screws tests up
|
||||||
|
@ -137,11 +137,11 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
"""Called automatically after each test."""
|
"""Called automatically after each test."""
|
||||||
self.stubs.UnsetAll()
|
self.stubs.UnsetAll()
|
||||||
os.rmdir(self.tmpdir)
|
os.rmdir(self.tmpdir)
|
||||||
super(WebSocketServerTestCase, self).tearDown()
|
super(WebSockifyServerTestCase, self).tearDown()
|
||||||
|
|
||||||
def _get_server(self, handler_class=websocketserver.WebSocketRequestHandler,
|
def _get_server(self, handler_class=websockifyserver.WebSockifyRequestHandler,
|
||||||
**kwargs):
|
**kwargs):
|
||||||
return websocketserver.WebSocketServer(
|
return websockifyserver.WebSockifyServer(
|
||||||
handler_class, listen_host='localhost',
|
handler_class, listen_host='localhost',
|
||||||
listen_port=80, key=self.tmpdir, web=self.tmpdir,
|
listen_port=80, key=self.tmpdir, web=self.tmpdir,
|
||||||
record=self.tmpdir, **kwargs)
|
record=self.tmpdir, **kwargs)
|
||||||
|
@ -174,7 +174,7 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
self.assertRaises(
|
self.assertRaises(
|
||||||
websocketserver.WebSocketServer.EClose, server.do_handshake,
|
websockifyserver.WebSockifyServer.EClose, server.do_handshake,
|
||||||
FakeSocket(), '127.0.0.1')
|
FakeSocket(), '127.0.0.1')
|
||||||
|
|
||||||
def test_empty_handshake_fails(self):
|
def test_empty_handshake_fails(self):
|
||||||
|
@ -187,7 +187,7 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
self.assertRaises(
|
self.assertRaises(
|
||||||
websocketserver.WebSocketServer.EClose, server.do_handshake,
|
websockifyserver.WebSockifyServer.EClose, server.do_handshake,
|
||||||
sock, '127.0.0.1')
|
sock, '127.0.0.1')
|
||||||
|
|
||||||
def test_handshake_policy_request(self):
|
def test_handshake_policy_request(self):
|
||||||
|
@ -204,7 +204,7 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
self.assertRaises(
|
self.assertRaises(
|
||||||
websocketserver.WebSocketServer.EClose, server.do_handshake,
|
websockifyserver.WebSockifyServer.EClose, server.do_handshake,
|
||||||
sock, '127.0.0.1')
|
sock, '127.0.0.1')
|
||||||
|
|
||||||
def test_do_handshake_no_ssl(self):
|
def test_do_handshake_no_ssl(self):
|
||||||
|
@ -247,7 +247,7 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
|
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
self.assertRaises(
|
self.assertRaises(
|
||||||
websocketserver.WebSocketServer.EClose, server.do_handshake,
|
websockifyserver.WebSockifyServer.EClose, server.do_handshake,
|
||||||
sock, '127.0.0.1')
|
sock, '127.0.0.1')
|
||||||
|
|
||||||
def test_do_handshake_ssl_error_eof_raises_close_error(self):
|
def test_do_handshake_ssl_error_eof_raises_close_error(self):
|
||||||
|
@ -264,7 +264,7 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
self.stubs.Set(ssl, 'wrap_socket', fake_wrap_socket)
|
self.stubs.Set(ssl, 'wrap_socket', fake_wrap_socket)
|
||||||
self.assertRaises(
|
self.assertRaises(
|
||||||
websocketserver.WebSocketServer.EClose, server.do_handshake,
|
websockifyserver.WebSockifyServer.EClose, server.do_handshake,
|
||||||
sock, '127.0.0.1')
|
sock, '127.0.0.1')
|
||||||
|
|
||||||
def test_fallback_sigchld_handler(self):
|
def test_fallback_sigchld_handler(self):
|
||||||
|
@ -278,9 +278,9 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
def fake_select(rlist, wlist, xlist, timeout=None):
|
def fake_select(rlist, wlist, xlist, timeout=None):
|
||||||
raise Exception("fake error")
|
raise Exception("fake error")
|
||||||
|
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'socket',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'socket',
|
||||||
lambda *args, **kwargs: sock)
|
lambda *args, **kwargs: sock)
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'daemonize',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'daemonize',
|
||||||
lambda *args, **kwargs: None)
|
lambda *args, **kwargs: None)
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
server.start_server()
|
server.start_server()
|
||||||
|
@ -292,9 +292,9 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
def fake_select(rlist, wlist, xlist, timeout=None):
|
def fake_select(rlist, wlist, xlist, timeout=None):
|
||||||
raise KeyboardInterrupt
|
raise KeyboardInterrupt
|
||||||
|
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'socket',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'socket',
|
||||||
lambda *args, **kwargs: sock)
|
lambda *args, **kwargs: sock)
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'daemonize',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'daemonize',
|
||||||
lambda *args, **kwargs: None)
|
lambda *args, **kwargs: None)
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
server.start_server()
|
server.start_server()
|
||||||
|
@ -306,9 +306,9 @@ class WebSocketServerTestCase(unittest.TestCase):
|
||||||
def fake_select(rlist, wlist, xlist, timeout=None):
|
def fake_select(rlist, wlist, xlist, timeout=None):
|
||||||
sys.exit()
|
sys.exit()
|
||||||
|
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'socket',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'socket',
|
||||||
lambda *args, **kwargs: sock)
|
lambda *args, **kwargs: sock)
|
||||||
self.stubs.Set(websocketserver.WebSocketServer, 'daemonize',
|
self.stubs.Set(websockifyserver.WebSockifyServer, 'daemonize',
|
||||||
lambda *args, **kwargs: None)
|
lambda *args, **kwargs: None)
|
||||||
self.stubs.Set(select, 'select', fake_select)
|
self.stubs.Set(select, 'select', fake_select)
|
||||||
server.start_server()
|
server.start_server()
|
|
@ -17,7 +17,7 @@ except: from SocketServer import ForkingMixIn
|
||||||
try: from http.server import HTTPServer
|
try: from http.server import HTTPServer
|
||||||
except: from BaseHTTPServer import HTTPServer
|
except: from BaseHTTPServer import HTTPServer
|
||||||
import select
|
import select
|
||||||
from websockify import websocketserver
|
from websockify import websockifyserver
|
||||||
from websockify import auth_plugins as auth
|
from websockify import auth_plugins as auth
|
||||||
try:
|
try:
|
||||||
from urllib.parse import parse_qs, urlparse
|
from urllib.parse import parse_qs, urlparse
|
||||||
|
@ -25,7 +25,7 @@ except:
|
||||||
from cgi import parse_qs
|
from cgi import parse_qs
|
||||||
from urlparse import urlparse
|
from urlparse import urlparse
|
||||||
|
|
||||||
class ProxyRequestHandler(websocketserver.WebSocketRequestHandler):
|
class ProxyRequestHandler(websockifyserver.WebSockifyRequestHandler):
|
||||||
|
|
||||||
buffer_size = 65536
|
buffer_size = 65536
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ Traffic Legend:
|
||||||
msg += " (using SSL)"
|
msg += " (using SSL)"
|
||||||
self.log_message(msg)
|
self.log_message(msg)
|
||||||
|
|
||||||
tsock = websocketserver.WebSocketServer.socket(self.server.target_host,
|
tsock = websockifyserver.WebSockifyServer.socket(self.server.target_host,
|
||||||
self.server.target_port,
|
self.server.target_port,
|
||||||
connect=True,
|
connect=True,
|
||||||
use_ssl=self.server.ssl_target,
|
use_ssl=self.server.ssl_target,
|
||||||
|
@ -221,7 +221,7 @@ Traffic Legend:
|
||||||
cqueue.append(buf)
|
cqueue.append(buf)
|
||||||
self.print_traffic("{")
|
self.print_traffic("{")
|
||||||
|
|
||||||
class WebSocketProxy(websocketserver.WebSocketServer):
|
class WebSocketProxy(websockifyserver.WebSockifyServer):
|
||||||
"""
|
"""
|
||||||
Proxy traffic to and from a WebSockets client to a normal TCP
|
Proxy traffic to and from a WebSockets client to a normal TCP
|
||||||
socket server target.
|
socket server target.
|
||||||
|
@ -274,7 +274,7 @@ class WebSocketProxy(websocketserver.WebSocketServer):
|
||||||
"REBIND_OLD_PORT": str(kwargs['listen_port']),
|
"REBIND_OLD_PORT": str(kwargs['listen_port']),
|
||||||
"REBIND_NEW_PORT": str(self.target_port)})
|
"REBIND_NEW_PORT": str(self.target_port)})
|
||||||
|
|
||||||
websocketserver.WebSocketServer.__init__(self, RequestHandlerClass, *args, **kwargs)
|
websockifyserver.WebSockifyServer.__init__(self, RequestHandlerClass, *args, **kwargs)
|
||||||
|
|
||||||
def run_wrap_cmd(self):
|
def run_wrap_cmd(self):
|
||||||
self.msg("Starting '%s'", " ".join(self.wrap_cmd))
|
self.msg("Starting '%s'", " ".join(self.wrap_cmd))
|
||||||
|
@ -469,7 +469,7 @@ def websockify_init():
|
||||||
if len(args) > 2:
|
if len(args) > 2:
|
||||||
parser.error("Too many arguments")
|
parser.error("Too many arguments")
|
||||||
|
|
||||||
if not websocketserver.ssl and opts.ssl_target:
|
if not websockifyserver.ssl and opts.ssl_target:
|
||||||
parser.error("SSL target requested and Python SSL module not loaded.");
|
parser.error("SSL target requested and Python SSL module not loaded.");
|
||||||
|
|
||||||
if opts.ssl_only and not os.path.exists(opts.cert):
|
if opts.ssl_only and not os.path.exists(opts.cert):
|
||||||
|
|
|
@ -1,819 +1,95 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
|
|
||||||
'''
|
'''
|
||||||
Python WebSocket server base with support for "wss://" encryption.
|
Python WebSocket server base
|
||||||
Copyright 2011 Joel Martin
|
Copyright 2011 Joel Martin
|
||||||
Copyright 2016 Pierre Ossman
|
Copyright 2016 Pierre Ossman
|
||||||
Licensed under LGPL version 3 (see docs/LICENSE.LGPL-3)
|
Licensed under LGPL version 3 (see docs/LICENSE.LGPL-3)
|
||||||
|
|
||||||
You can make a cert/key with openssl using:
|
|
||||||
openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem
|
|
||||||
as taken from http://docs.python.org/dev/library/ssl.html#certificates
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os, sys, time, errno, signal, socket, select, logging
|
import sys
|
||||||
import multiprocessing
|
|
||||||
|
|
||||||
# Imports that vary by python version
|
|
||||||
|
|
||||||
# python 3.0 differences
|
# python 3.0 differences
|
||||||
if sys.hexversion > 0x3000000:
|
try: from http.server import BaseHTTPRequestHandler, HTTPServer
|
||||||
s2b = lambda s: s.encode('latin_1')
|
except: from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
|
||||||
else:
|
|
||||||
s2b = lambda s: s # No-op
|
|
||||||
try: from http.server import SimpleHTTPRequestHandler
|
|
||||||
except: from SimpleHTTPServer import SimpleHTTPRequestHandler
|
|
||||||
|
|
||||||
# Degraded functionality if these imports are missing
|
|
||||||
for mod, msg in [('ssl', 'TLS/SSL/wss is disabled'),
|
|
||||||
('resource', 'daemonizing is disabled')]:
|
|
||||||
try:
|
|
||||||
globals()[mod] = __import__(mod)
|
|
||||||
except ImportError:
|
|
||||||
globals()[mod] = None
|
|
||||||
print("WARNING: no '%s' module, %s" % (mod, msg))
|
|
||||||
|
|
||||||
if sys.platform == 'win32':
|
|
||||||
# make sockets pickle-able/inheritable
|
|
||||||
import multiprocessing.reduction
|
|
||||||
|
|
||||||
from websockify.websocket import WebSocket, WebSocketWantReadError, WebSocketWantWriteError
|
from websockify.websocket import WebSocket, WebSocketWantReadError, WebSocketWantWriteError
|
||||||
|
|
||||||
# HTTP handler with WebSocket upgrade support
|
class WebSocketRequestHandler(BaseHTTPRequestHandler):
|
||||||
class WebSocketRequestHandler(SimpleHTTPRequestHandler):
|
"""WebSocket request handler base class.
|
||||||
|
|
||||||
|
This class forms the base for a server that wishes to handle
|
||||||
|
WebSocket requests. It functions exactly as BastHTTPRequestHandler,
|
||||||
|
except that WebSocket requests are intercepted and the methods
|
||||||
|
handle_upgrade() and handle_websocket() are called. The standard
|
||||||
|
do_GET() will be called for normal requests.
|
||||||
|
|
||||||
|
The class instance SocketClass can be overridden with the class to
|
||||||
|
use for the WebSocket connection.
|
||||||
"""
|
"""
|
||||||
WebSocket Request Handler Class, derived from SimpleHTTPRequestHandler.
|
|
||||||
Must be sub-classed with new_websocket_client method definition.
|
|
||||||
The request handler can be configured by setting optional
|
|
||||||
attributes on the server object:
|
|
||||||
|
|
||||||
* only_upgrade: If true, SimpleHTTPRequestHandler will not be enabled,
|
SocketClass = WebSocket
|
||||||
only websocket is allowed.
|
|
||||||
* verbose: If true, verbose logging is activated.
|
|
||||||
* daemon: Running as daemon, do not write to console etc
|
|
||||||
* record: Record raw frame data as JavaScript array into specified filename
|
|
||||||
* run_once: Handle a single request
|
|
||||||
* handler_id: A sequence number for this connection, appended to record filename
|
|
||||||
"""
|
|
||||||
server_version = "WebSockify"
|
|
||||||
|
|
||||||
protocol_version = "HTTP/1.1"
|
def __init__(self, request, client_address, server):
|
||||||
|
BaseHTTPRequestHandler.__init__(self, request, client_address, server)
|
||||||
|
|
||||||
# An exception while the WebSocket client was connected
|
def handle_one_request(self):
|
||||||
class CClose(Exception):
|
"""Extended request handler
|
||||||
pass
|
|
||||||
|
|
||||||
def __init__(self, req, addr, server):
|
This is where WebSocketRequestHandler redirects requests to the
|
||||||
# Retrieve a few configuration variables from the server
|
new methods. Any sub-classes must call this method in order for
|
||||||
self.only_upgrade = getattr(server, "only_upgrade", False)
|
the calls to function.
|
||||||
self.verbose = getattr(server, "verbose", False)
|
"""
|
||||||
self.daemon = getattr(server, "daemon", False)
|
self._real_do_GET = self.do_GET
|
||||||
self.record = getattr(server, "record", False)
|
self.do_GET = self._websocket_do_GET
|
||||||
self.run_once = getattr(server, "run_once", False)
|
|
||||||
self.rec = None
|
|
||||||
self.handler_id = getattr(server, "handler_id", False)
|
|
||||||
self.file_only = getattr(server, "file_only", False)
|
|
||||||
self.traffic = getattr(server, "traffic", False)
|
|
||||||
|
|
||||||
self.logger = getattr(server, "logger", None)
|
|
||||||
if self.logger is None:
|
|
||||||
self.logger = WebSocketServer.get_logger()
|
|
||||||
|
|
||||||
SimpleHTTPRequestHandler.__init__(self, req, addr, server)
|
|
||||||
|
|
||||||
def log_message(self, format, *args):
|
|
||||||
self.logger.info("%s - - [%s] %s" % (self.address_string(), self.log_date_time_string(), format % args))
|
|
||||||
|
|
||||||
#
|
|
||||||
# WebSocketRequestHandler logging/output functions
|
|
||||||
#
|
|
||||||
|
|
||||||
def print_traffic(self, token="."):
|
|
||||||
""" Show traffic flow mode. """
|
|
||||||
if self.traffic:
|
|
||||||
sys.stdout.write(token)
|
|
||||||
sys.stdout.flush()
|
|
||||||
|
|
||||||
def msg(self, msg, *args, **kwargs):
|
|
||||||
""" Output message with handler_id prefix. """
|
|
||||||
prefix = "% 3d: " % self.handler_id
|
|
||||||
self.logger.log(logging.INFO, "%s%s" % (prefix, msg), *args, **kwargs)
|
|
||||||
|
|
||||||
def vmsg(self, msg, *args, **kwargs):
|
|
||||||
""" Same as msg() but as debug. """
|
|
||||||
prefix = "% 3d: " % self.handler_id
|
|
||||||
self.logger.log(logging.INFO, "%s%s" % (prefix, msg), *args, **kwargs)
|
|
||||||
|
|
||||||
def warn(self, msg, *args, **kwargs):
|
|
||||||
""" Same as msg() but as warning. """
|
|
||||||
prefix = "% 3d: " % self.handler_id
|
|
||||||
self.logger.log(logging.WARN, "%s%s" % (prefix, msg), *args, **kwargs)
|
|
||||||
|
|
||||||
#
|
|
||||||
# Main WebSocketRequestHandler methods
|
|
||||||
#
|
|
||||||
def send_frames(self, bufs=None):
|
|
||||||
""" Encode and send WebSocket frames. Any frames already
|
|
||||||
queued will be sent first. If buf is not set then only queued
|
|
||||||
frames will be sent. Returns True if any frames could not be
|
|
||||||
fully sent, in which case the caller should call again when
|
|
||||||
the socket is ready. """
|
|
||||||
|
|
||||||
tdelta = int(time.time()*1000) - self.start_time
|
|
||||||
|
|
||||||
if bufs:
|
|
||||||
for buf in bufs:
|
|
||||||
if self.rec:
|
|
||||||
self.rec.write("%s,\n" % repr("{%s{" % tdelta + buf))
|
|
||||||
self.send_parts.append(buf)
|
|
||||||
|
|
||||||
# Flush any previously queued data
|
|
||||||
try:
|
try:
|
||||||
self.request.sendmsg('')
|
BaseHTTPRequestHandler.handle_one_request(self)
|
||||||
except WebSocketWantWriteError:
|
finally:
|
||||||
return True
|
self.do_GET = self._real_do_GET
|
||||||
|
|
||||||
while self.send_parts:
|
def _websocket_do_GET(self):
|
||||||
# Send pending frames
|
# Checks if it is a websocket request and redirects
|
||||||
buf = self.send_parts.pop(0)
|
self.do_GET = self._real_do_GET
|
||||||
try:
|
|
||||||
self.request.sendmsg(buf)
|
|
||||||
except WebSocketWantWriteError:
|
|
||||||
self.print_traffic("<.")
|
|
||||||
return True
|
|
||||||
self.print_traffic("<")
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
def recv_frames(self):
|
|
||||||
""" Receive and decode WebSocket frames.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
(bufs_list, closed_string)
|
|
||||||
"""
|
|
||||||
|
|
||||||
closed = False
|
|
||||||
bufs = []
|
|
||||||
tdelta = int(time.time()*1000) - self.start_time
|
|
||||||
|
|
||||||
while True:
|
|
||||||
try:
|
|
||||||
buf = self.request.recvmsg()
|
|
||||||
except WebSocketWantReadError:
|
|
||||||
self.print_traffic("}.")
|
|
||||||
break
|
|
||||||
|
|
||||||
if len(buf) == 0:
|
|
||||||
closed = {'code': self.request.close_code,
|
|
||||||
'reason': self.request.close_reason}
|
|
||||||
return bufs, closed
|
|
||||||
|
|
||||||
self.print_traffic("}")
|
|
||||||
|
|
||||||
if self.rec:
|
|
||||||
self.rec.write("%s,\n" % repr("}%s}" % tdelta + buf))
|
|
||||||
|
|
||||||
bufs.append(buf)
|
|
||||||
|
|
||||||
if not self.request.pending():
|
|
||||||
break
|
|
||||||
|
|
||||||
return bufs, closed
|
|
||||||
|
|
||||||
def send_close(self, code=1000, reason=''):
|
|
||||||
""" Send a WebSocket orderly close frame. """
|
|
||||||
self.request.shutdown(code, reason)
|
|
||||||
|
|
||||||
def send_pong(self, data=''):
|
|
||||||
""" Send a WebSocket pong frame. """
|
|
||||||
self.request.pong(data)
|
|
||||||
|
|
||||||
def send_ping(self, data=''):
|
|
||||||
""" Send a WebSocket ping frame. """
|
|
||||||
self.request.ping(data)
|
|
||||||
|
|
||||||
def handle_websocket(self):
|
|
||||||
"""Upgrade a connection to Websocket, if requested. If this succeeds,
|
|
||||||
new_websocket_client() will be called. Otherwise, False is returned.
|
|
||||||
"""
|
|
||||||
|
|
||||||
if (self.headers.get('upgrade') and
|
if (self.headers.get('upgrade') and
|
||||||
self.headers.get('upgrade').lower() == 'websocket'):
|
self.headers.get('upgrade').lower() == 'websocket'):
|
||||||
|
self.handle_upgrade()
|
||||||
# ensure connection is authorized, and determine the target
|
|
||||||
self.validate_connection()
|
|
||||||
|
|
||||||
websocket = WebSocket()
|
|
||||||
try:
|
|
||||||
websocket.accept(self.request, self.headers)
|
|
||||||
except Exception:
|
|
||||||
exc = sys.exc_info()[1]
|
|
||||||
self.send_error(400, str(exc))
|
|
||||||
return False
|
|
||||||
|
|
||||||
self.request = websocket
|
|
||||||
|
|
||||||
# Other requests cannot follow Websocket data
|
|
||||||
self.close_connection = True
|
|
||||||
|
|
||||||
# Indicate to server that a Websocket upgrade was done
|
|
||||||
self.server.ws_connection = True
|
|
||||||
# Initialize per client settings
|
|
||||||
self.send_parts = []
|
|
||||||
self.recv_part = None
|
|
||||||
self.start_time = int(time.time()*1000)
|
|
||||||
|
|
||||||
# client_address is empty with, say, UNIX domain sockets
|
|
||||||
client_addr = ""
|
|
||||||
is_ssl = False
|
|
||||||
try:
|
|
||||||
client_addr = self.client_address[0]
|
|
||||||
is_ssl = self.client_address[2]
|
|
||||||
except IndexError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
if is_ssl:
|
|
||||||
self.stype = "SSL/TLS (wss://)"
|
|
||||||
else:
|
|
||||||
self.stype = "Plain non-SSL (ws://)"
|
|
||||||
|
|
||||||
self.log_message("%s: %s WebSocket connection", client_addr,
|
|
||||||
self.stype)
|
|
||||||
if self.path != '/':
|
|
||||||
self.log_message("%s: Path: '%s'", client_addr, self.path)
|
|
||||||
|
|
||||||
if self.record:
|
|
||||||
# Record raw frame data as JavaScript array
|
|
||||||
fname = "%s.%s" % (self.record,
|
|
||||||
self.handler_id)
|
|
||||||
self.log_message("opening record file: %s", fname)
|
|
||||||
self.rec = open(fname, 'w+')
|
|
||||||
self.rec.write("var VNC_frame_data = [\n")
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.new_websocket_client()
|
|
||||||
except self.CClose:
|
|
||||||
# Close the client
|
|
||||||
_, exc, _ = sys.exc_info()
|
|
||||||
self.send_close(exc.args[0], exc.args[1])
|
|
||||||
return True
|
|
||||||
else:
|
else:
|
||||||
return False
|
self.do_GET()
|
||||||
|
|
||||||
def do_GET(self):
|
def handle_upgrade(self):
|
||||||
"""Handle GET request. Calls handle_websocket(). If unsuccessful,
|
"""Initial handler for a WebSocket request
|
||||||
and web server is enabled, SimpleHTTPRequestHandler.do_GET will be called."""
|
|
||||||
if not self.handle_websocket():
|
|
||||||
if self.only_upgrade:
|
|
||||||
self.send_error(405, "Method Not Allowed")
|
|
||||||
else:
|
|
||||||
SimpleHTTPRequestHandler.do_GET(self)
|
|
||||||
|
|
||||||
def list_directory(self, path):
|
This method is called when a WebSocket is requested. By default
|
||||||
if self.file_only:
|
it will create a WebSocket object and perform the negotiation.
|
||||||
self.send_error(404, "No such file")
|
The WebSocket object will then replace the request object and
|
||||||
else:
|
handle_websocket() will be called.
|
||||||
return SimpleHTTPRequestHandler.list_directory(self, path)
|
|
||||||
|
|
||||||
def new_websocket_client(self):
|
|
||||||
""" Do something with a WebSockets client connection. """
|
|
||||||
raise Exception("WebSocketRequestHandler.new_websocket_client() must be overloaded")
|
|
||||||
|
|
||||||
def validate_connection(self):
|
|
||||||
""" Ensure that the connection is a valid connection, and set the target. """
|
|
||||||
pass
|
|
||||||
|
|
||||||
def do_HEAD(self):
|
|
||||||
if self.only_upgrade:
|
|
||||||
self.send_error(405, "Method Not Allowed")
|
|
||||||
else:
|
|
||||||
SimpleHTTPRequestHandler.do_HEAD(self)
|
|
||||||
|
|
||||||
def finish(self):
|
|
||||||
if self.rec:
|
|
||||||
self.rec.write("'EOF'];\n")
|
|
||||||
self.rec.close()
|
|
||||||
|
|
||||||
def handle(self):
|
|
||||||
# When using run_once, we have a single process, so
|
|
||||||
# we cannot loop in BaseHTTPRequestHandler.handle; we
|
|
||||||
# must return and handle new connections
|
|
||||||
if self.run_once:
|
|
||||||
self.handle_one_request()
|
|
||||||
else:
|
|
||||||
SimpleHTTPRequestHandler.handle(self)
|
|
||||||
|
|
||||||
def log_request(self, code='-', size='-'):
|
|
||||||
if self.verbose:
|
|
||||||
SimpleHTTPRequestHandler.log_request(self, code, size)
|
|
||||||
|
|
||||||
|
|
||||||
class WebSocketServer(object):
|
|
||||||
"""
|
|
||||||
WebSockets server class.
|
|
||||||
As an alternative, the standard library SocketServer can be used
|
|
||||||
"""
|
|
||||||
|
|
||||||
policy_response = """<cross-domain-policy><allow-access-from domain="*" to-ports="*" /></cross-domain-policy>\n"""
|
|
||||||
log_prefix = "websocket"
|
|
||||||
|
|
||||||
# An exception before the WebSocket connection was established
|
|
||||||
class EClose(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
class Terminate(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def __init__(self, RequestHandlerClass, listen_host='',
|
|
||||||
listen_port=None, source_is_ipv6=False,
|
|
||||||
verbose=False, cert='', key='', ssl_only=None,
|
|
||||||
daemon=False, record='', web='',
|
|
||||||
file_only=False,
|
|
||||||
run_once=False, timeout=0, idle_timeout=0, traffic=False,
|
|
||||||
tcp_keepalive=True, tcp_keepcnt=None, tcp_keepidle=None,
|
|
||||||
tcp_keepintvl=None):
|
|
||||||
|
|
||||||
# settings
|
|
||||||
self.RequestHandlerClass = RequestHandlerClass
|
|
||||||
self.verbose = verbose
|
|
||||||
self.listen_host = listen_host
|
|
||||||
self.listen_port = listen_port
|
|
||||||
self.prefer_ipv6 = source_is_ipv6
|
|
||||||
self.ssl_only = ssl_only
|
|
||||||
self.daemon = daemon
|
|
||||||
self.run_once = run_once
|
|
||||||
self.timeout = timeout
|
|
||||||
self.idle_timeout = idle_timeout
|
|
||||||
self.traffic = traffic
|
|
||||||
self.file_only = file_only
|
|
||||||
|
|
||||||
self.launch_time = time.time()
|
|
||||||
self.ws_connection = False
|
|
||||||
self.handler_id = 1
|
|
||||||
|
|
||||||
self.logger = self.get_logger()
|
|
||||||
self.tcp_keepalive = tcp_keepalive
|
|
||||||
self.tcp_keepcnt = tcp_keepcnt
|
|
||||||
self.tcp_keepidle = tcp_keepidle
|
|
||||||
self.tcp_keepintvl = tcp_keepintvl
|
|
||||||
|
|
||||||
# Make paths settings absolute
|
|
||||||
self.cert = os.path.abspath(cert)
|
|
||||||
self.key = self.web = self.record = ''
|
|
||||||
if key:
|
|
||||||
self.key = os.path.abspath(key)
|
|
||||||
if web:
|
|
||||||
self.web = os.path.abspath(web)
|
|
||||||
if record:
|
|
||||||
self.record = os.path.abspath(record)
|
|
||||||
|
|
||||||
if self.web:
|
|
||||||
os.chdir(self.web)
|
|
||||||
self.only_upgrade = not self.web
|
|
||||||
|
|
||||||
# Sanity checks
|
|
||||||
if not ssl and self.ssl_only:
|
|
||||||
raise Exception("No 'ssl' module and SSL-only specified")
|
|
||||||
if self.daemon and not resource:
|
|
||||||
raise Exception("Module 'resource' required to daemonize")
|
|
||||||
|
|
||||||
# Show configuration
|
|
||||||
self.msg("WebSocket server settings:")
|
|
||||||
self.msg(" - Listen on %s:%s",
|
|
||||||
self.listen_host, self.listen_port)
|
|
||||||
self.msg(" - Flash security policy server")
|
|
||||||
if self.web:
|
|
||||||
if self.file_only:
|
|
||||||
self.msg(" - Web server (no directory listings). Web root: %s", self.web)
|
|
||||||
else:
|
|
||||||
self.msg(" - Web server. Web root: %s", self.web)
|
|
||||||
if ssl:
|
|
||||||
if os.path.exists(self.cert):
|
|
||||||
self.msg(" - SSL/TLS support")
|
|
||||||
if self.ssl_only:
|
|
||||||
self.msg(" - Deny non-SSL/TLS connections")
|
|
||||||
else:
|
|
||||||
self.msg(" - No SSL/TLS support (no cert file)")
|
|
||||||
else:
|
|
||||||
self.msg(" - No SSL/TLS support (no 'ssl' module)")
|
|
||||||
if self.daemon:
|
|
||||||
self.msg(" - Backgrounding (daemon)")
|
|
||||||
if self.record:
|
|
||||||
self.msg(" - Recording to '%s.*'", self.record)
|
|
||||||
|
|
||||||
#
|
|
||||||
# WebSocketServer static methods
|
|
||||||
#
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_logger():
|
|
||||||
return logging.getLogger("%s.%s" % (
|
|
||||||
WebSocketServer.log_prefix,
|
|
||||||
WebSocketServer.__class__.__name__))
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def socket(host, port=None, connect=False, prefer_ipv6=False,
|
|
||||||
unix_socket=None, use_ssl=False, tcp_keepalive=True,
|
|
||||||
tcp_keepcnt=None, tcp_keepidle=None, tcp_keepintvl=None):
|
|
||||||
""" Resolve a host (and optional port) to an IPv4 or IPv6
|
|
||||||
address. Create a socket. Bind to it if listen is set,
|
|
||||||
otherwise connect to it. Return the socket.
|
|
||||||
"""
|
"""
|
||||||
flags = 0
|
websocket = self.SocketClass()
|
||||||
if host == '':
|
try:
|
||||||
host = None
|
websocket.accept(self.request, self.headers)
|
||||||
if connect and not (port or unix_socket):
|
except Exception:
|
||||||
raise Exception("Connect mode requires a port")
|
exc = sys.exc_info()[1]
|
||||||
if not connect and use_ssl:
|
self.send_error(400, str(exc))
|
||||||
raise Exception("SSL only supported in connect mode (for now)")
|
return
|
||||||
if not connect:
|
|
||||||
flags = flags | socket.AI_PASSIVE
|
|
||||||
|
|
||||||
if not unix_socket:
|
self.log_request(101)
|
||||||
addrs = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM,
|
|
||||||
socket.IPPROTO_TCP, flags)
|
|
||||||
if not addrs:
|
|
||||||
raise Exception("Could not resolve host '%s'" % host)
|
|
||||||
addrs.sort(key=lambda x: x[0])
|
|
||||||
if prefer_ipv6:
|
|
||||||
addrs.reverse()
|
|
||||||
sock = socket.socket(addrs[0][0], addrs[0][1])
|
|
||||||
|
|
||||||
if tcp_keepalive:
|
self.request = websocket
|
||||||
sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
|
|
||||||
if tcp_keepcnt:
|
|
||||||
if hasattr(socket, 'TCP_KEEPCNT'):
|
|
||||||
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPCNT,
|
|
||||||
tcp_keepcnt)
|
|
||||||
else:
|
|
||||||
self.msg('tcp_keepcnt not available on your system')
|
|
||||||
if tcp_keepidle:
|
|
||||||
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPIDLE,
|
|
||||||
tcp_keepidle)
|
|
||||||
if tcp_keepintvl:
|
|
||||||
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPINTVL,
|
|
||||||
tcp_keepintvl)
|
|
||||||
|
|
||||||
if connect:
|
# Other requests cannot follow Websocket data
|
||||||
sock.connect(addrs[0][4])
|
self.close_connection = True
|
||||||
if use_ssl:
|
|
||||||
sock = ssl.wrap_socket(sock)
|
|
||||||
else:
|
|
||||||
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
||||||
sock.bind(addrs[0][4])
|
|
||||||
sock.listen(100)
|
|
||||||
else:
|
|
||||||
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
|
||||||
sock.connect(unix_socket)
|
|
||||||
|
|
||||||
return sock
|
self.handle_websocket()
|
||||||
|
|
||||||
@staticmethod
|
def handle_websocket(self):
|
||||||
def daemonize(keepfd=None, chdir='/'):
|
"""Handle a WebSocket connection.
|
||||||
|
|
||||||
if keepfd is None:
|
This is called when the WebSocket is ready to be used. A
|
||||||
keepfd = []
|
sub-class should perform the necessary communication here and
|
||||||
|
return once done.
|
||||||
os.umask(0)
|
|
||||||
if chdir:
|
|
||||||
os.chdir(chdir)
|
|
||||||
else:
|
|
||||||
os.chdir('/')
|
|
||||||
os.setgid(os.getgid()) # relinquish elevations
|
|
||||||
os.setuid(os.getuid()) # relinquish elevations
|
|
||||||
|
|
||||||
# Double fork to daemonize
|
|
||||||
if os.fork() > 0: os._exit(0) # Parent exits
|
|
||||||
os.setsid() # Obtain new process group
|
|
||||||
if os.fork() > 0: os._exit(0) # Parent exits
|
|
||||||
|
|
||||||
# Signal handling
|
|
||||||
signal.signal(signal.SIGTERM, signal.SIG_IGN)
|
|
||||||
signal.signal(signal.SIGINT, signal.SIG_IGN)
|
|
||||||
|
|
||||||
# Close open files
|
|
||||||
maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
|
|
||||||
if maxfd == resource.RLIM_INFINITY: maxfd = 256
|
|
||||||
for fd in reversed(range(maxfd)):
|
|
||||||
try:
|
|
||||||
if fd not in keepfd:
|
|
||||||
os.close(fd)
|
|
||||||
except OSError:
|
|
||||||
_, exc, _ = sys.exc_info()
|
|
||||||
if exc.errno != errno.EBADF: raise
|
|
||||||
|
|
||||||
# Redirect I/O to /dev/null
|
|
||||||
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stdin.fileno())
|
|
||||||
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stdout.fileno())
|
|
||||||
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stderr.fileno())
|
|
||||||
|
|
||||||
def do_handshake(self, sock, address):
|
|
||||||
"""
|
"""
|
||||||
do_handshake does the following:
|
|
||||||
- Peek at the first few bytes from the socket.
|
|
||||||
- If the connection is Flash policy request then answer it,
|
|
||||||
close the socket and return.
|
|
||||||
- If the connection is an HTTPS/SSL/TLS connection then SSL
|
|
||||||
wrap the socket.
|
|
||||||
- Read from the (possibly wrapped) socket.
|
|
||||||
- If we have received a HTTP GET request and the webserver
|
|
||||||
functionality is enabled, answer it, close the socket and
|
|
||||||
return.
|
|
||||||
- Assume we have a WebSockets connection, parse the client
|
|
||||||
handshake data.
|
|
||||||
- Send a WebSockets handshake server response.
|
|
||||||
- Return the socket for this WebSocket client.
|
|
||||||
"""
|
|
||||||
ready = select.select([sock], [], [], 3)[0]
|
|
||||||
|
|
||||||
|
|
||||||
if not ready:
|
|
||||||
raise self.EClose("ignoring socket not ready")
|
|
||||||
# Peek, but do not read the data so that we have a opportunity
|
|
||||||
# to SSL wrap the socket first
|
|
||||||
handshake = sock.recv(1024, socket.MSG_PEEK)
|
|
||||||
#self.msg("Handshake [%s]" % handshake)
|
|
||||||
|
|
||||||
if not handshake:
|
|
||||||
raise self.EClose("ignoring empty handshake")
|
|
||||||
|
|
||||||
elif handshake.startswith(s2b("<policy-file-request/>")):
|
|
||||||
# Answer Flash policy request
|
|
||||||
handshake = sock.recv(1024)
|
|
||||||
sock.send(s2b(self.policy_response))
|
|
||||||
raise self.EClose("Sending flash policy response")
|
|
||||||
|
|
||||||
elif handshake[0] in ("\x16", "\x80", 22, 128):
|
|
||||||
# SSL wrap the connection
|
|
||||||
if not ssl:
|
|
||||||
raise self.EClose("SSL connection but no 'ssl' module")
|
|
||||||
if not os.path.exists(self.cert):
|
|
||||||
raise self.EClose("SSL connection but '%s' not found"
|
|
||||||
% self.cert)
|
|
||||||
retsock = None
|
|
||||||
try:
|
|
||||||
retsock = ssl.wrap_socket(
|
|
||||||
sock,
|
|
||||||
server_side=True,
|
|
||||||
certfile=self.cert,
|
|
||||||
keyfile=self.key)
|
|
||||||
except ssl.SSLError:
|
|
||||||
_, x, _ = sys.exc_info()
|
|
||||||
if x.args[0] == ssl.SSL_ERROR_EOF:
|
|
||||||
if len(x.args) > 1:
|
|
||||||
raise self.EClose(x.args[1])
|
|
||||||
else:
|
|
||||||
raise self.EClose("Got SSL_ERROR_EOF")
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
elif self.ssl_only:
|
|
||||||
raise self.EClose("non-SSL connection received but disallowed")
|
|
||||||
|
|
||||||
else:
|
|
||||||
retsock = sock
|
|
||||||
|
|
||||||
# If the address is like (host, port), we are extending it
|
|
||||||
# with a flag indicating SSL. Not many other options
|
|
||||||
# available...
|
|
||||||
if len(address) == 2:
|
|
||||||
address = (address[0], address[1], (retsock != sock))
|
|
||||||
|
|
||||||
self.RequestHandlerClass(retsock, address, self)
|
|
||||||
|
|
||||||
# Return the WebSockets socket which may be SSL wrapped
|
|
||||||
return retsock
|
|
||||||
|
|
||||||
#
|
|
||||||
# WebSocketServer logging/output functions
|
|
||||||
#
|
|
||||||
|
|
||||||
def msg(self, *args, **kwargs):
|
|
||||||
""" Output message as info """
|
|
||||||
self.logger.log(logging.INFO, *args, **kwargs)
|
|
||||||
|
|
||||||
def vmsg(self, *args, **kwargs):
|
|
||||||
""" Same as msg() but as debug. """
|
|
||||||
self.logger.log(logging.INFO, *args, **kwargs)
|
|
||||||
|
|
||||||
def warn(self, *args, **kwargs):
|
|
||||||
""" Same as msg() but as warning. """
|
|
||||||
self.logger.log(logging.WARN, *args, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Events that can/should be overridden in sub-classes
|
|
||||||
#
|
|
||||||
def started(self):
|
|
||||||
""" Called after WebSockets startup """
|
|
||||||
self.vmsg("WebSockets server started")
|
|
||||||
|
|
||||||
def poll(self):
|
|
||||||
""" Run periodically while waiting for connections. """
|
|
||||||
#self.vmsg("Running poll()")
|
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def terminate(self):
|
class WebSocketServer(HTTPServer):
|
||||||
raise self.Terminate()
|
pass
|
||||||
|
|
||||||
def multiprocessing_SIGCHLD(self, sig, stack):
|
|
||||||
# TODO: figure out a way to actually log this information without
|
|
||||||
# calling `log` in the signal handlers
|
|
||||||
multiprocessing.active_children()
|
|
||||||
|
|
||||||
def fallback_SIGCHLD(self, sig, stack):
|
|
||||||
# Reap zombies when using os.fork() (python 2.4)
|
|
||||||
# TODO: figure out a way to actually log this information without
|
|
||||||
# calling `log` in the signal handlers
|
|
||||||
try:
|
|
||||||
result = os.waitpid(-1, os.WNOHANG)
|
|
||||||
while result[0]:
|
|
||||||
self.vmsg("Reaped child process %s" % result[0])
|
|
||||||
result = os.waitpid(-1, os.WNOHANG)
|
|
||||||
except (OSError):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def do_SIGINT(self, sig, stack):
|
|
||||||
# TODO: figure out a way to actually log this information without
|
|
||||||
# calling `log` in the signal handlers
|
|
||||||
self.terminate()
|
|
||||||
|
|
||||||
def do_SIGTERM(self, sig, stack):
|
|
||||||
# TODO: figure out a way to actually log this information without
|
|
||||||
# calling `log` in the signal handlers
|
|
||||||
self.terminate()
|
|
||||||
|
|
||||||
def top_new_client(self, startsock, address):
|
|
||||||
""" Do something with a WebSockets client connection. """
|
|
||||||
# handler process
|
|
||||||
client = None
|
|
||||||
try:
|
|
||||||
try:
|
|
||||||
client = self.do_handshake(startsock, address)
|
|
||||||
except self.EClose:
|
|
||||||
_, exc, _ = sys.exc_info()
|
|
||||||
# Connection was not a WebSockets connection
|
|
||||||
if exc.args[0]:
|
|
||||||
self.msg("%s: %s" % (address[0], exc.args[0]))
|
|
||||||
except WebSocketServer.Terminate:
|
|
||||||
raise
|
|
||||||
except Exception:
|
|
||||||
_, exc, _ = sys.exc_info()
|
|
||||||
self.msg("handler exception: %s" % str(exc))
|
|
||||||
self.vmsg("exception", exc_info=True)
|
|
||||||
finally:
|
|
||||||
|
|
||||||
if client and client != startsock:
|
|
||||||
# Close the SSL wrapped socket
|
|
||||||
# Original socket closed by caller
|
|
||||||
client.close()
|
|
||||||
|
|
||||||
def get_log_fd(self):
|
|
||||||
"""
|
|
||||||
Get file descriptors for the loggers.
|
|
||||||
They should not be closed when the process is forked.
|
|
||||||
"""
|
|
||||||
descriptors = []
|
|
||||||
for handler in self.logger.parent.handlers:
|
|
||||||
if isinstance(handler, logging.FileHandler):
|
|
||||||
descriptors.append(handler.stream.fileno())
|
|
||||||
|
|
||||||
return descriptors
|
|
||||||
|
|
||||||
def start_server(self):
|
|
||||||
"""
|
|
||||||
Daemonize if requested. Listen for for connections. Run
|
|
||||||
do_handshake() method for each connection. If the connection
|
|
||||||
is a WebSockets client then call new_websocket_client() method (which must
|
|
||||||
be overridden) for each new client connection.
|
|
||||||
"""
|
|
||||||
lsock = self.socket(self.listen_host, self.listen_port, False,
|
|
||||||
self.prefer_ipv6,
|
|
||||||
tcp_keepalive=self.tcp_keepalive,
|
|
||||||
tcp_keepcnt=self.tcp_keepcnt,
|
|
||||||
tcp_keepidle=self.tcp_keepidle,
|
|
||||||
tcp_keepintvl=self.tcp_keepintvl)
|
|
||||||
|
|
||||||
if self.daemon:
|
|
||||||
keepfd = self.get_log_fd()
|
|
||||||
keepfd.append(lsock.fileno())
|
|
||||||
self.daemonize(keepfd=keepfd, chdir=self.web)
|
|
||||||
|
|
||||||
self.started() # Some things need to happen after daemonizing
|
|
||||||
|
|
||||||
# Allow override of signals
|
|
||||||
original_signals = {
|
|
||||||
signal.SIGINT: signal.getsignal(signal.SIGINT),
|
|
||||||
signal.SIGTERM: signal.getsignal(signal.SIGTERM),
|
|
||||||
signal.SIGCHLD: signal.getsignal(signal.SIGCHLD),
|
|
||||||
}
|
|
||||||
signal.signal(signal.SIGINT, self.do_SIGINT)
|
|
||||||
signal.signal(signal.SIGTERM, self.do_SIGTERM)
|
|
||||||
# make sure that _cleanup is called when children die
|
|
||||||
# by calling active_children on SIGCHLD
|
|
||||||
signal.signal(signal.SIGCHLD, self.multiprocessing_SIGCHLD)
|
|
||||||
|
|
||||||
last_active_time = self.launch_time
|
|
||||||
try:
|
|
||||||
while True:
|
|
||||||
try:
|
|
||||||
try:
|
|
||||||
startsock = None
|
|
||||||
pid = err = 0
|
|
||||||
child_count = 0
|
|
||||||
|
|
||||||
# Collect zombie child processes
|
|
||||||
child_count = len(multiprocessing.active_children())
|
|
||||||
|
|
||||||
time_elapsed = time.time() - self.launch_time
|
|
||||||
if self.timeout and time_elapsed > self.timeout:
|
|
||||||
self.msg('listener exit due to --timeout %s'
|
|
||||||
% self.timeout)
|
|
||||||
break
|
|
||||||
|
|
||||||
if self.idle_timeout:
|
|
||||||
idle_time = 0
|
|
||||||
if child_count == 0:
|
|
||||||
idle_time = time.time() - last_active_time
|
|
||||||
else:
|
|
||||||
idle_time = 0
|
|
||||||
last_active_time = time.time()
|
|
||||||
|
|
||||||
if idle_time > self.idle_timeout and child_count == 0:
|
|
||||||
self.msg('listener exit due to --idle-timeout %s'
|
|
||||||
% self.idle_timeout)
|
|
||||||
break
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.poll()
|
|
||||||
|
|
||||||
ready = select.select([lsock], [], [], 1)[0]
|
|
||||||
if lsock in ready:
|
|
||||||
startsock, address = lsock.accept()
|
|
||||||
else:
|
|
||||||
continue
|
|
||||||
except self.Terminate:
|
|
||||||
raise
|
|
||||||
except Exception:
|
|
||||||
_, exc, _ = sys.exc_info()
|
|
||||||
if hasattr(exc, 'errno'):
|
|
||||||
err = exc.errno
|
|
||||||
elif hasattr(exc, 'args'):
|
|
||||||
err = exc.args[0]
|
|
||||||
else:
|
|
||||||
err = exc[0]
|
|
||||||
if err == errno.EINTR:
|
|
||||||
self.vmsg("Ignoring interrupted syscall")
|
|
||||||
continue
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
if self.run_once:
|
|
||||||
# Run in same process if run_once
|
|
||||||
self.top_new_client(startsock, address)
|
|
||||||
if self.ws_connection :
|
|
||||||
self.msg('%s: exiting due to --run-once'
|
|
||||||
% address[0])
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
self.vmsg('%s: new handler Process' % address[0])
|
|
||||||
p = multiprocessing.Process(
|
|
||||||
target=self.top_new_client,
|
|
||||||
args=(startsock, address))
|
|
||||||
p.start()
|
|
||||||
# child will not return
|
|
||||||
|
|
||||||
# parent process
|
|
||||||
self.handler_id += 1
|
|
||||||
|
|
||||||
except (self.Terminate, SystemExit, KeyboardInterrupt):
|
|
||||||
self.msg("In exit")
|
|
||||||
# terminate all child processes
|
|
||||||
if not self.run_once:
|
|
||||||
children = multiprocessing.active_children()
|
|
||||||
|
|
||||||
for child in children:
|
|
||||||
self.msg("Terminating child %s" % child.pid)
|
|
||||||
child.terminate()
|
|
||||||
|
|
||||||
break
|
|
||||||
except Exception:
|
|
||||||
exc = sys.exc_info()[1]
|
|
||||||
self.msg("handler exception: %s", str(exc))
|
|
||||||
self.vmsg("exception", exc_info=True)
|
|
||||||
|
|
||||||
finally:
|
|
||||||
if startsock:
|
|
||||||
startsock.close()
|
|
||||||
finally:
|
|
||||||
# Close listen port
|
|
||||||
self.vmsg("Closing socket listening at %s:%s",
|
|
||||||
self.listen_host, self.listen_port)
|
|
||||||
lsock.close()
|
|
||||||
|
|
||||||
# Restore signals
|
|
||||||
for sig, func in original_signals.items():
|
|
||||||
signal.signal(sig, func)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,796 @@
|
||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
'''
|
||||||
|
Python WebSocket server base with support for "wss://" encryption.
|
||||||
|
Copyright 2011 Joel Martin
|
||||||
|
Copyright 2016 Pierre Ossman
|
||||||
|
Licensed under LGPL version 3 (see docs/LICENSE.LGPL-3)
|
||||||
|
|
||||||
|
You can make a cert/key with openssl using:
|
||||||
|
openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem
|
||||||
|
as taken from http://docs.python.org/dev/library/ssl.html#certificates
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
import os, sys, time, errno, signal, socket, select, logging
|
||||||
|
import multiprocessing
|
||||||
|
|
||||||
|
# Imports that vary by python version
|
||||||
|
|
||||||
|
# python 3.0 differences
|
||||||
|
if sys.hexversion > 0x3000000:
|
||||||
|
s2b = lambda s: s.encode('latin_1')
|
||||||
|
else:
|
||||||
|
s2b = lambda s: s # No-op
|
||||||
|
try: from http.server import SimpleHTTPRequestHandler
|
||||||
|
except: from SimpleHTTPServer import SimpleHTTPRequestHandler
|
||||||
|
|
||||||
|
# Degraded functionality if these imports are missing
|
||||||
|
for mod, msg in [('ssl', 'TLS/SSL/wss is disabled'),
|
||||||
|
('resource', 'daemonizing is disabled')]:
|
||||||
|
try:
|
||||||
|
globals()[mod] = __import__(mod)
|
||||||
|
except ImportError:
|
||||||
|
globals()[mod] = None
|
||||||
|
print("WARNING: no '%s' module, %s" % (mod, msg))
|
||||||
|
|
||||||
|
if sys.platform == 'win32':
|
||||||
|
# make sockets pickle-able/inheritable
|
||||||
|
import multiprocessing.reduction
|
||||||
|
|
||||||
|
from websockify.websocket import WebSocket, WebSocketWantReadError, WebSocketWantWriteError
|
||||||
|
from websockify.websocketserver import WebSocketRequestHandler
|
||||||
|
|
||||||
|
# HTTP handler with WebSocket upgrade support
|
||||||
|
class WebSockifyRequestHandler(WebSocketRequestHandler, SimpleHTTPRequestHandler):
|
||||||
|
"""
|
||||||
|
WebSocket Request Handler Class, derived from SimpleHTTPRequestHandler.
|
||||||
|
Must be sub-classed with new_websocket_client method definition.
|
||||||
|
The request handler can be configured by setting optional
|
||||||
|
attributes on the server object:
|
||||||
|
|
||||||
|
* only_upgrade: If true, SimpleHTTPRequestHandler will not be enabled,
|
||||||
|
only websocket is allowed.
|
||||||
|
* verbose: If true, verbose logging is activated.
|
||||||
|
* daemon: Running as daemon, do not write to console etc
|
||||||
|
* record: Record raw frame data as JavaScript array into specified filename
|
||||||
|
* run_once: Handle a single request
|
||||||
|
* handler_id: A sequence number for this connection, appended to record filename
|
||||||
|
"""
|
||||||
|
server_version = "WebSockify"
|
||||||
|
|
||||||
|
protocol_version = "HTTP/1.1"
|
||||||
|
|
||||||
|
# An exception while the WebSocket client was connected
|
||||||
|
class CClose(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def __init__(self, req, addr, server):
|
||||||
|
# Retrieve a few configuration variables from the server
|
||||||
|
self.only_upgrade = getattr(server, "only_upgrade", False)
|
||||||
|
self.verbose = getattr(server, "verbose", False)
|
||||||
|
self.daemon = getattr(server, "daemon", False)
|
||||||
|
self.record = getattr(server, "record", False)
|
||||||
|
self.run_once = getattr(server, "run_once", False)
|
||||||
|
self.rec = None
|
||||||
|
self.handler_id = getattr(server, "handler_id", False)
|
||||||
|
self.file_only = getattr(server, "file_only", False)
|
||||||
|
self.traffic = getattr(server, "traffic", False)
|
||||||
|
|
||||||
|
self.logger = getattr(server, "logger", None)
|
||||||
|
if self.logger is None:
|
||||||
|
self.logger = WebSockifyServer.get_logger()
|
||||||
|
|
||||||
|
WebSocketRequestHandler.__init__(self, req, addr, server)
|
||||||
|
|
||||||
|
def log_message(self, format, *args):
|
||||||
|
self.logger.info("%s - - [%s] %s" % (self.address_string(), self.log_date_time_string(), format % args))
|
||||||
|
|
||||||
|
#
|
||||||
|
# WebSocketRequestHandler logging/output functions
|
||||||
|
#
|
||||||
|
|
||||||
|
def print_traffic(self, token="."):
|
||||||
|
""" Show traffic flow mode. """
|
||||||
|
if self.traffic:
|
||||||
|
sys.stdout.write(token)
|
||||||
|
sys.stdout.flush()
|
||||||
|
|
||||||
|
def msg(self, msg, *args, **kwargs):
|
||||||
|
""" Output message with handler_id prefix. """
|
||||||
|
prefix = "% 3d: " % self.handler_id
|
||||||
|
self.logger.log(logging.INFO, "%s%s" % (prefix, msg), *args, **kwargs)
|
||||||
|
|
||||||
|
def vmsg(self, msg, *args, **kwargs):
|
||||||
|
""" Same as msg() but as debug. """
|
||||||
|
prefix = "% 3d: " % self.handler_id
|
||||||
|
self.logger.log(logging.DEBUG, "%s%s" % (prefix, msg), *args, **kwargs)
|
||||||
|
|
||||||
|
def warn(self, msg, *args, **kwargs):
|
||||||
|
""" Same as msg() but as warning. """
|
||||||
|
prefix = "% 3d: " % self.handler_id
|
||||||
|
self.logger.log(logging.WARN, "%s%s" % (prefix, msg), *args, **kwargs)
|
||||||
|
|
||||||
|
#
|
||||||
|
# Main WebSocketRequestHandler methods
|
||||||
|
#
|
||||||
|
def send_frames(self, bufs=None):
|
||||||
|
""" Encode and send WebSocket frames. Any frames already
|
||||||
|
queued will be sent first. If buf is not set then only queued
|
||||||
|
frames will be sent. Returns True if any frames could not be
|
||||||
|
fully sent, in which case the caller should call again when
|
||||||
|
the socket is ready. """
|
||||||
|
|
||||||
|
tdelta = int(time.time()*1000) - self.start_time
|
||||||
|
|
||||||
|
if bufs:
|
||||||
|
for buf in bufs:
|
||||||
|
if self.rec:
|
||||||
|
self.rec.write("%s,\n" % repr("{%s{" % tdelta + buf))
|
||||||
|
self.send_parts.append(buf)
|
||||||
|
|
||||||
|
# Flush any previously queued data
|
||||||
|
try:
|
||||||
|
self.request.sendmsg('')
|
||||||
|
except WebSocketWantWriteError:
|
||||||
|
return True
|
||||||
|
|
||||||
|
while self.send_parts:
|
||||||
|
# Send pending frames
|
||||||
|
buf = self.send_parts.pop(0)
|
||||||
|
try:
|
||||||
|
self.request.sendmsg(buf)
|
||||||
|
except WebSocketWantWriteError:
|
||||||
|
self.print_traffic("<.")
|
||||||
|
return True
|
||||||
|
self.print_traffic("<")
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
def recv_frames(self):
|
||||||
|
""" Receive and decode WebSocket frames.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(bufs_list, closed_string)
|
||||||
|
"""
|
||||||
|
|
||||||
|
closed = False
|
||||||
|
bufs = []
|
||||||
|
tdelta = int(time.time()*1000) - self.start_time
|
||||||
|
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
buf = self.request.recvmsg()
|
||||||
|
except WebSocketWantReadError:
|
||||||
|
self.print_traffic("}.")
|
||||||
|
break
|
||||||
|
|
||||||
|
if len(buf) == 0:
|
||||||
|
closed = {'code': self.request.close_code,
|
||||||
|
'reason': self.request.close_reason}
|
||||||
|
return bufs, closed
|
||||||
|
|
||||||
|
self.print_traffic("}")
|
||||||
|
|
||||||
|
if self.rec:
|
||||||
|
self.rec.write("%s,\n" % repr("}%s}" % tdelta + buf))
|
||||||
|
|
||||||
|
bufs.append(buf)
|
||||||
|
|
||||||
|
if not self.request.pending():
|
||||||
|
break
|
||||||
|
|
||||||
|
return bufs, closed
|
||||||
|
|
||||||
|
def send_close(self, code=1000, reason=''):
|
||||||
|
""" Send a WebSocket orderly close frame. """
|
||||||
|
self.request.shutdown(socket.SHUT_RDWR, code, reason)
|
||||||
|
|
||||||
|
def send_pong(self, data=''):
|
||||||
|
""" Send a WebSocket pong frame. """
|
||||||
|
self.request.pong(data)
|
||||||
|
|
||||||
|
def send_ping(self, data=''):
|
||||||
|
""" Send a WebSocket ping frame. """
|
||||||
|
self.request.ping(data)
|
||||||
|
|
||||||
|
def handle_upgrade(self):
|
||||||
|
# ensure connection is authorized, and determine the target
|
||||||
|
self.validate_connection()
|
||||||
|
|
||||||
|
WebSocketRequestHandler.handle_upgrade(self)
|
||||||
|
|
||||||
|
def handle_websocket(self):
|
||||||
|
# Indicate to server that a Websocket upgrade was done
|
||||||
|
self.server.ws_connection = True
|
||||||
|
# Initialize per client settings
|
||||||
|
self.send_parts = []
|
||||||
|
self.recv_part = None
|
||||||
|
self.start_time = int(time.time()*1000)
|
||||||
|
|
||||||
|
# client_address is empty with, say, UNIX domain sockets
|
||||||
|
client_addr = ""
|
||||||
|
is_ssl = False
|
||||||
|
try:
|
||||||
|
client_addr = self.client_address[0]
|
||||||
|
is_ssl = self.client_address[2]
|
||||||
|
except IndexError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
if is_ssl:
|
||||||
|
self.stype = "SSL/TLS (wss://)"
|
||||||
|
else:
|
||||||
|
self.stype = "Plain non-SSL (ws://)"
|
||||||
|
|
||||||
|
self.log_message("%s: %s WebSocket connection", client_addr,
|
||||||
|
self.stype)
|
||||||
|
if self.path != '/':
|
||||||
|
self.log_message("%s: Path: '%s'", client_addr, self.path)
|
||||||
|
|
||||||
|
if self.record:
|
||||||
|
# Record raw frame data as JavaScript array
|
||||||
|
fname = "%s.%s" % (self.record,
|
||||||
|
self.handler_id)
|
||||||
|
self.log_message("opening record file: %s", fname)
|
||||||
|
self.rec = open(fname, 'w+')
|
||||||
|
self.rec.write("var VNC_frame_data = [\n")
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.new_websocket_client()
|
||||||
|
except self.CClose:
|
||||||
|
# Close the client
|
||||||
|
_, exc, _ = sys.exc_info()
|
||||||
|
self.send_close(exc.args[0], exc.args[1])
|
||||||
|
|
||||||
|
def do_GET(self):
|
||||||
|
if self.only_upgrade:
|
||||||
|
self.send_error(405, "Method Not Allowed")
|
||||||
|
else:
|
||||||
|
SimpleHTTPRequestHandler.do_GET(self)
|
||||||
|
|
||||||
|
def list_directory(self, path):
|
||||||
|
if self.file_only:
|
||||||
|
self.send_error(404, "No such file")
|
||||||
|
else:
|
||||||
|
return SimpleHTTPRequestHandler.list_directory(self, path)
|
||||||
|
|
||||||
|
def new_websocket_client(self):
|
||||||
|
""" Do something with a WebSockets client connection. """
|
||||||
|
raise Exception("WebSocketRequestHandler.new_websocket_client() must be overloaded")
|
||||||
|
|
||||||
|
def validate_connection(self):
|
||||||
|
""" Ensure that the connection is a valid connection, and set the target. """
|
||||||
|
pass
|
||||||
|
|
||||||
|
def do_HEAD(self):
|
||||||
|
if self.only_upgrade:
|
||||||
|
self.send_error(405, "Method Not Allowed")
|
||||||
|
else:
|
||||||
|
SimpleHTTPRequestHandler.do_HEAD(self)
|
||||||
|
|
||||||
|
def finish(self):
|
||||||
|
if self.rec:
|
||||||
|
self.rec.write("'EOF'];\n")
|
||||||
|
self.rec.close()
|
||||||
|
|
||||||
|
def handle(self):
|
||||||
|
# When using run_once, we have a single process, so
|
||||||
|
# we cannot loop in BaseHTTPRequestHandler.handle; we
|
||||||
|
# must return and handle new connections
|
||||||
|
if self.run_once:
|
||||||
|
self.handle_one_request()
|
||||||
|
else:
|
||||||
|
SimpleHTTPRequestHandler.handle(self)
|
||||||
|
|
||||||
|
def log_request(self, code='-', size='-'):
|
||||||
|
if self.verbose:
|
||||||
|
SimpleHTTPRequestHandler.log_request(self, code, size)
|
||||||
|
|
||||||
|
|
||||||
|
class WebSockifyServer(object):
|
||||||
|
"""
|
||||||
|
WebSockets server class.
|
||||||
|
As an alternative, the standard library SocketServer can be used
|
||||||
|
"""
|
||||||
|
|
||||||
|
policy_response = """<cross-domain-policy><allow-access-from domain="*" to-ports="*" /></cross-domain-policy>\n"""
|
||||||
|
log_prefix = "websocket"
|
||||||
|
|
||||||
|
# An exception before the WebSocket connection was established
|
||||||
|
class EClose(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class Terminate(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def __init__(self, RequestHandlerClass, listen_host='',
|
||||||
|
listen_port=None, source_is_ipv6=False,
|
||||||
|
verbose=False, cert='', key='', ssl_only=None,
|
||||||
|
daemon=False, record='', web='',
|
||||||
|
file_only=False,
|
||||||
|
run_once=False, timeout=0, idle_timeout=0, traffic=False,
|
||||||
|
tcp_keepalive=True, tcp_keepcnt=None, tcp_keepidle=None,
|
||||||
|
tcp_keepintvl=None):
|
||||||
|
|
||||||
|
# settings
|
||||||
|
self.RequestHandlerClass = RequestHandlerClass
|
||||||
|
self.verbose = verbose
|
||||||
|
self.listen_host = listen_host
|
||||||
|
self.listen_port = listen_port
|
||||||
|
self.prefer_ipv6 = source_is_ipv6
|
||||||
|
self.ssl_only = ssl_only
|
||||||
|
self.daemon = daemon
|
||||||
|
self.run_once = run_once
|
||||||
|
self.timeout = timeout
|
||||||
|
self.idle_timeout = idle_timeout
|
||||||
|
self.traffic = traffic
|
||||||
|
self.file_only = file_only
|
||||||
|
|
||||||
|
self.launch_time = time.time()
|
||||||
|
self.ws_connection = False
|
||||||
|
self.handler_id = 1
|
||||||
|
|
||||||
|
self.logger = self.get_logger()
|
||||||
|
self.tcp_keepalive = tcp_keepalive
|
||||||
|
self.tcp_keepcnt = tcp_keepcnt
|
||||||
|
self.tcp_keepidle = tcp_keepidle
|
||||||
|
self.tcp_keepintvl = tcp_keepintvl
|
||||||
|
|
||||||
|
# Make paths settings absolute
|
||||||
|
self.cert = os.path.abspath(cert)
|
||||||
|
self.key = self.web = self.record = ''
|
||||||
|
if key:
|
||||||
|
self.key = os.path.abspath(key)
|
||||||
|
if web:
|
||||||
|
self.web = os.path.abspath(web)
|
||||||
|
if record:
|
||||||
|
self.record = os.path.abspath(record)
|
||||||
|
|
||||||
|
if self.web:
|
||||||
|
os.chdir(self.web)
|
||||||
|
self.only_upgrade = not self.web
|
||||||
|
|
||||||
|
# Sanity checks
|
||||||
|
if not ssl and self.ssl_only:
|
||||||
|
raise Exception("No 'ssl' module and SSL-only specified")
|
||||||
|
if self.daemon and not resource:
|
||||||
|
raise Exception("Module 'resource' required to daemonize")
|
||||||
|
|
||||||
|
# Show configuration
|
||||||
|
self.msg("WebSocket server settings:")
|
||||||
|
self.msg(" - Listen on %s:%s",
|
||||||
|
self.listen_host, self.listen_port)
|
||||||
|
self.msg(" - Flash security policy server")
|
||||||
|
if self.web:
|
||||||
|
if self.file_only:
|
||||||
|
self.msg(" - Web server (no directory listings). Web root: %s", self.web)
|
||||||
|
else:
|
||||||
|
self.msg(" - Web server. Web root: %s", self.web)
|
||||||
|
if ssl:
|
||||||
|
if os.path.exists(self.cert):
|
||||||
|
self.msg(" - SSL/TLS support")
|
||||||
|
if self.ssl_only:
|
||||||
|
self.msg(" - Deny non-SSL/TLS connections")
|
||||||
|
else:
|
||||||
|
self.msg(" - No SSL/TLS support (no cert file)")
|
||||||
|
else:
|
||||||
|
self.msg(" - No SSL/TLS support (no 'ssl' module)")
|
||||||
|
if self.daemon:
|
||||||
|
self.msg(" - Backgrounding (daemon)")
|
||||||
|
if self.record:
|
||||||
|
self.msg(" - Recording to '%s.*'", self.record)
|
||||||
|
|
||||||
|
#
|
||||||
|
# WebSockifyServer static methods
|
||||||
|
#
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_logger():
|
||||||
|
return logging.getLogger("%s.%s" % (
|
||||||
|
WebSockifyServer.log_prefix,
|
||||||
|
WebSockifyServer.__class__.__name__))
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def socket(host, port=None, connect=False, prefer_ipv6=False,
|
||||||
|
unix_socket=None, use_ssl=False, tcp_keepalive=True,
|
||||||
|
tcp_keepcnt=None, tcp_keepidle=None, tcp_keepintvl=None):
|
||||||
|
""" Resolve a host (and optional port) to an IPv4 or IPv6
|
||||||
|
address. Create a socket. Bind to it if listen is set,
|
||||||
|
otherwise connect to it. Return the socket.
|
||||||
|
"""
|
||||||
|
flags = 0
|
||||||
|
if host == '':
|
||||||
|
host = None
|
||||||
|
if connect and not (port or unix_socket):
|
||||||
|
raise Exception("Connect mode requires a port")
|
||||||
|
if use_ssl and not ssl:
|
||||||
|
raise Exception("SSL socket requested but Python SSL module not loaded.");
|
||||||
|
if not connect and use_ssl:
|
||||||
|
raise Exception("SSL only supported in connect mode (for now)")
|
||||||
|
if not connect:
|
||||||
|
flags = flags | socket.AI_PASSIVE
|
||||||
|
|
||||||
|
if not unix_socket:
|
||||||
|
addrs = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM,
|
||||||
|
socket.IPPROTO_TCP, flags)
|
||||||
|
if not addrs:
|
||||||
|
raise Exception("Could not resolve host '%s'" % host)
|
||||||
|
addrs.sort(key=lambda x: x[0])
|
||||||
|
if prefer_ipv6:
|
||||||
|
addrs.reverse()
|
||||||
|
sock = socket.socket(addrs[0][0], addrs[0][1])
|
||||||
|
|
||||||
|
if tcp_keepalive:
|
||||||
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
|
||||||
|
if tcp_keepcnt:
|
||||||
|
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPCNT,
|
||||||
|
tcp_keepcnt)
|
||||||
|
if tcp_keepidle:
|
||||||
|
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPIDLE,
|
||||||
|
tcp_keepidle)
|
||||||
|
if tcp_keepintvl:
|
||||||
|
sock.setsockopt(socket.SOL_TCP, socket.TCP_KEEPINTVL,
|
||||||
|
tcp_keepintvl)
|
||||||
|
|
||||||
|
if connect:
|
||||||
|
sock.connect(addrs[0][4])
|
||||||
|
if use_ssl:
|
||||||
|
sock = ssl.wrap_socket(sock)
|
||||||
|
else:
|
||||||
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||||
|
sock.bind(addrs[0][4])
|
||||||
|
sock.listen(100)
|
||||||
|
else:
|
||||||
|
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||||
|
sock.connect(unix_socket)
|
||||||
|
|
||||||
|
return sock
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def daemonize(keepfd=None, chdir='/'):
|
||||||
|
|
||||||
|
if keepfd is None:
|
||||||
|
keepfd = []
|
||||||
|
|
||||||
|
os.umask(0)
|
||||||
|
if chdir:
|
||||||
|
os.chdir(chdir)
|
||||||
|
else:
|
||||||
|
os.chdir('/')
|
||||||
|
os.setgid(os.getgid()) # relinquish elevations
|
||||||
|
os.setuid(os.getuid()) # relinquish elevations
|
||||||
|
|
||||||
|
# Double fork to daemonize
|
||||||
|
if os.fork() > 0: os._exit(0) # Parent exits
|
||||||
|
os.setsid() # Obtain new process group
|
||||||
|
if os.fork() > 0: os._exit(0) # Parent exits
|
||||||
|
|
||||||
|
# Signal handling
|
||||||
|
signal.signal(signal.SIGTERM, signal.SIG_IGN)
|
||||||
|
signal.signal(signal.SIGINT, signal.SIG_IGN)
|
||||||
|
|
||||||
|
# Close open files
|
||||||
|
maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
|
||||||
|
if maxfd == resource.RLIM_INFINITY: maxfd = 256
|
||||||
|
for fd in reversed(range(maxfd)):
|
||||||
|
try:
|
||||||
|
if fd not in keepfd:
|
||||||
|
os.close(fd)
|
||||||
|
except OSError:
|
||||||
|
_, exc, _ = sys.exc_info()
|
||||||
|
if exc.errno != errno.EBADF: raise
|
||||||
|
|
||||||
|
# Redirect I/O to /dev/null
|
||||||
|
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stdin.fileno())
|
||||||
|
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stdout.fileno())
|
||||||
|
os.dup2(os.open(os.devnull, os.O_RDWR), sys.stderr.fileno())
|
||||||
|
|
||||||
|
def do_handshake(self, sock, address):
|
||||||
|
"""
|
||||||
|
do_handshake does the following:
|
||||||
|
- Peek at the first few bytes from the socket.
|
||||||
|
- If the connection is Flash policy request then answer it,
|
||||||
|
close the socket and return.
|
||||||
|
- If the connection is an HTTPS/SSL/TLS connection then SSL
|
||||||
|
wrap the socket.
|
||||||
|
- Read from the (possibly wrapped) socket.
|
||||||
|
- If we have received a HTTP GET request and the webserver
|
||||||
|
functionality is enabled, answer it, close the socket and
|
||||||
|
return.
|
||||||
|
- Assume we have a WebSockets connection, parse the client
|
||||||
|
handshake data.
|
||||||
|
- Send a WebSockets handshake server response.
|
||||||
|
- Return the socket for this WebSocket client.
|
||||||
|
"""
|
||||||
|
ready = select.select([sock], [], [], 3)[0]
|
||||||
|
|
||||||
|
|
||||||
|
if not ready:
|
||||||
|
raise self.EClose("ignoring socket not ready")
|
||||||
|
# Peek, but do not read the data so that we have a opportunity
|
||||||
|
# to SSL wrap the socket first
|
||||||
|
handshake = sock.recv(1024, socket.MSG_PEEK)
|
||||||
|
#self.msg("Handshake [%s]" % handshake)
|
||||||
|
|
||||||
|
if not handshake:
|
||||||
|
raise self.EClose("ignoring empty handshake")
|
||||||
|
|
||||||
|
elif handshake.startswith(s2b("<policy-file-request/>")):
|
||||||
|
# Answer Flash policy request
|
||||||
|
handshake = sock.recv(1024)
|
||||||
|
sock.send(s2b(self.policy_response))
|
||||||
|
raise self.EClose("Sending flash policy response")
|
||||||
|
|
||||||
|
elif handshake[0] in ("\x16", "\x80", 22, 128):
|
||||||
|
# SSL wrap the connection
|
||||||
|
if not ssl:
|
||||||
|
raise self.EClose("SSL connection but no 'ssl' module")
|
||||||
|
if not os.path.exists(self.cert):
|
||||||
|
raise self.EClose("SSL connection but '%s' not found"
|
||||||
|
% self.cert)
|
||||||
|
retsock = None
|
||||||
|
try:
|
||||||
|
retsock = ssl.wrap_socket(
|
||||||
|
sock,
|
||||||
|
server_side=True,
|
||||||
|
certfile=self.cert,
|
||||||
|
keyfile=self.key)
|
||||||
|
except ssl.SSLError:
|
||||||
|
_, x, _ = sys.exc_info()
|
||||||
|
if x.args[0] == ssl.SSL_ERROR_EOF:
|
||||||
|
if len(x.args) > 1:
|
||||||
|
raise self.EClose(x.args[1])
|
||||||
|
else:
|
||||||
|
raise self.EClose("Got SSL_ERROR_EOF")
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
elif self.ssl_only:
|
||||||
|
raise self.EClose("non-SSL connection received but disallowed")
|
||||||
|
|
||||||
|
else:
|
||||||
|
retsock = sock
|
||||||
|
|
||||||
|
# If the address is like (host, port), we are extending it
|
||||||
|
# with a flag indicating SSL. Not many other options
|
||||||
|
# available...
|
||||||
|
if len(address) == 2:
|
||||||
|
address = (address[0], address[1], (retsock != sock))
|
||||||
|
|
||||||
|
self.RequestHandlerClass(retsock, address, self)
|
||||||
|
|
||||||
|
# Return the WebSockets socket which may be SSL wrapped
|
||||||
|
return retsock
|
||||||
|
|
||||||
|
#
|
||||||
|
# WebSockifyServer logging/output functions
|
||||||
|
#
|
||||||
|
|
||||||
|
def msg(self, *args, **kwargs):
|
||||||
|
""" Output message as info """
|
||||||
|
self.logger.log(logging.INFO, *args, **kwargs)
|
||||||
|
|
||||||
|
def vmsg(self, *args, **kwargs):
|
||||||
|
""" Same as msg() but as debug. """
|
||||||
|
self.logger.log(logging.DEBUG, *args, **kwargs)
|
||||||
|
|
||||||
|
def warn(self, *args, **kwargs):
|
||||||
|
""" Same as msg() but as warning. """
|
||||||
|
self.logger.log(logging.WARN, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Events that can/should be overridden in sub-classes
|
||||||
|
#
|
||||||
|
def started(self):
|
||||||
|
""" Called after WebSockets startup """
|
||||||
|
self.vmsg("WebSockets server started")
|
||||||
|
|
||||||
|
def poll(self):
|
||||||
|
""" Run periodically while waiting for connections. """
|
||||||
|
#self.vmsg("Running poll()")
|
||||||
|
pass
|
||||||
|
|
||||||
|
def terminate(self):
|
||||||
|
raise self.Terminate()
|
||||||
|
|
||||||
|
def multiprocessing_SIGCHLD(self, sig, stack):
|
||||||
|
# TODO: figure out a way to actually log this information without
|
||||||
|
# calling `log` in the signal handlers
|
||||||
|
multiprocessing.active_children()
|
||||||
|
|
||||||
|
def fallback_SIGCHLD(self, sig, stack):
|
||||||
|
# Reap zombies when using os.fork() (python 2.4)
|
||||||
|
# TODO: figure out a way to actually log this information without
|
||||||
|
# calling `log` in the signal handlers
|
||||||
|
try:
|
||||||
|
result = os.waitpid(-1, os.WNOHANG)
|
||||||
|
while result[0]:
|
||||||
|
self.vmsg("Reaped child process %s" % result[0])
|
||||||
|
result = os.waitpid(-1, os.WNOHANG)
|
||||||
|
except (OSError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def do_SIGINT(self, sig, stack):
|
||||||
|
# TODO: figure out a way to actually log this information without
|
||||||
|
# calling `log` in the signal handlers
|
||||||
|
self.terminate()
|
||||||
|
|
||||||
|
def do_SIGTERM(self, sig, stack):
|
||||||
|
# TODO: figure out a way to actually log this information without
|
||||||
|
# calling `log` in the signal handlers
|
||||||
|
self.terminate()
|
||||||
|
|
||||||
|
def top_new_client(self, startsock, address):
|
||||||
|
""" Do something with a WebSockets client connection. """
|
||||||
|
# handler process
|
||||||
|
client = None
|
||||||
|
try:
|
||||||
|
try:
|
||||||
|
client = self.do_handshake(startsock, address)
|
||||||
|
except self.EClose:
|
||||||
|
_, exc, _ = sys.exc_info()
|
||||||
|
# Connection was not a WebSockets connection
|
||||||
|
if exc.args[0]:
|
||||||
|
self.msg("%s: %s" % (address[0], exc.args[0]))
|
||||||
|
except WebSockifyServer.Terminate:
|
||||||
|
raise
|
||||||
|
except Exception:
|
||||||
|
_, exc, _ = sys.exc_info()
|
||||||
|
self.msg("handler exception: %s" % str(exc))
|
||||||
|
self.vmsg("exception", exc_info=True)
|
||||||
|
finally:
|
||||||
|
|
||||||
|
if client and client != startsock:
|
||||||
|
# Close the SSL wrapped socket
|
||||||
|
# Original socket closed by caller
|
||||||
|
client.close()
|
||||||
|
|
||||||
|
def get_log_fd(self):
|
||||||
|
"""
|
||||||
|
Get file descriptors for the loggers.
|
||||||
|
They should not be closed when the process is forked.
|
||||||
|
"""
|
||||||
|
descriptors = []
|
||||||
|
for handler in self.logger.parent.handlers:
|
||||||
|
if isinstance(handler, logging.FileHandler):
|
||||||
|
descriptors.append(handler.stream.fileno())
|
||||||
|
|
||||||
|
return descriptors
|
||||||
|
|
||||||
|
def start_server(self):
|
||||||
|
"""
|
||||||
|
Daemonize if requested. Listen for for connections. Run
|
||||||
|
do_handshake() method for each connection. If the connection
|
||||||
|
is a WebSockets client then call new_websocket_client() method (which must
|
||||||
|
be overridden) for each new client connection.
|
||||||
|
"""
|
||||||
|
lsock = self.socket(self.listen_host, self.listen_port, False,
|
||||||
|
self.prefer_ipv6,
|
||||||
|
tcp_keepalive=self.tcp_keepalive,
|
||||||
|
tcp_keepcnt=self.tcp_keepcnt,
|
||||||
|
tcp_keepidle=self.tcp_keepidle,
|
||||||
|
tcp_keepintvl=self.tcp_keepintvl)
|
||||||
|
|
||||||
|
if self.daemon:
|
||||||
|
keepfd = self.get_log_fd()
|
||||||
|
keepfd.append(lsock.fileno())
|
||||||
|
self.daemonize(keepfd=keepfd, chdir=self.web)
|
||||||
|
|
||||||
|
self.started() # Some things need to happen after daemonizing
|
||||||
|
|
||||||
|
# Allow override of signals
|
||||||
|
original_signals = {
|
||||||
|
signal.SIGINT: signal.getsignal(signal.SIGINT),
|
||||||
|
signal.SIGTERM: signal.getsignal(signal.SIGTERM),
|
||||||
|
signal.SIGCHLD: signal.getsignal(signal.SIGCHLD),
|
||||||
|
}
|
||||||
|
signal.signal(signal.SIGINT, self.do_SIGINT)
|
||||||
|
signal.signal(signal.SIGTERM, self.do_SIGTERM)
|
||||||
|
# make sure that _cleanup is called when children die
|
||||||
|
# by calling active_children on SIGCHLD
|
||||||
|
signal.signal(signal.SIGCHLD, self.multiprocessing_SIGCHLD)
|
||||||
|
|
||||||
|
last_active_time = self.launch_time
|
||||||
|
try:
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
try:
|
||||||
|
startsock = None
|
||||||
|
pid = err = 0
|
||||||
|
child_count = 0
|
||||||
|
|
||||||
|
# Collect zombie child processes
|
||||||
|
child_count = len(multiprocessing.active_children())
|
||||||
|
|
||||||
|
time_elapsed = time.time() - self.launch_time
|
||||||
|
if self.timeout and time_elapsed > self.timeout:
|
||||||
|
self.msg('listener exit due to --timeout %s'
|
||||||
|
% self.timeout)
|
||||||
|
break
|
||||||
|
|
||||||
|
if self.idle_timeout:
|
||||||
|
idle_time = 0
|
||||||
|
if child_count == 0:
|
||||||
|
idle_time = time.time() - last_active_time
|
||||||
|
else:
|
||||||
|
idle_time = 0
|
||||||
|
last_active_time = time.time()
|
||||||
|
|
||||||
|
if idle_time > self.idle_timeout and child_count == 0:
|
||||||
|
self.msg('listener exit due to --idle-timeout %s'
|
||||||
|
% self.idle_timeout)
|
||||||
|
break
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.poll()
|
||||||
|
|
||||||
|
ready = select.select([lsock], [], [], 1)[0]
|
||||||
|
if lsock in ready:
|
||||||
|
startsock, address = lsock.accept()
|
||||||
|
else:
|
||||||
|
continue
|
||||||
|
except self.Terminate:
|
||||||
|
raise
|
||||||
|
except Exception:
|
||||||
|
_, exc, _ = sys.exc_info()
|
||||||
|
if hasattr(exc, 'errno'):
|
||||||
|
err = exc.errno
|
||||||
|
elif hasattr(exc, 'args'):
|
||||||
|
err = exc.args[0]
|
||||||
|
else:
|
||||||
|
err = exc[0]
|
||||||
|
if err == errno.EINTR:
|
||||||
|
self.vmsg("Ignoring interrupted syscall")
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
if self.run_once:
|
||||||
|
# Run in same process if run_once
|
||||||
|
self.top_new_client(startsock, address)
|
||||||
|
if self.ws_connection :
|
||||||
|
self.msg('%s: exiting due to --run-once'
|
||||||
|
% address[0])
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
self.vmsg('%s: new handler Process' % address[0])
|
||||||
|
p = multiprocessing.Process(
|
||||||
|
target=self.top_new_client,
|
||||||
|
args=(startsock, address))
|
||||||
|
p.start()
|
||||||
|
# child will not return
|
||||||
|
|
||||||
|
# parent process
|
||||||
|
self.handler_id += 1
|
||||||
|
|
||||||
|
except (self.Terminate, SystemExit, KeyboardInterrupt):
|
||||||
|
self.msg("In exit")
|
||||||
|
# terminate all child processes
|
||||||
|
if not self.run_once:
|
||||||
|
children = multiprocessing.active_children()
|
||||||
|
|
||||||
|
for child in children:
|
||||||
|
self.msg("Terminating child %s" % child.pid)
|
||||||
|
child.terminate()
|
||||||
|
|
||||||
|
break
|
||||||
|
except Exception:
|
||||||
|
exc = sys.exc_info()[1]
|
||||||
|
self.msg("handler exception: %s", str(exc))
|
||||||
|
self.vmsg("exception", exc_info=True)
|
||||||
|
|
||||||
|
finally:
|
||||||
|
if startsock:
|
||||||
|
startsock.close()
|
||||||
|
finally:
|
||||||
|
# Close listen port
|
||||||
|
self.vmsg("Closing socket listening at %s:%s",
|
||||||
|
self.listen_host, self.listen_port)
|
||||||
|
lsock.close()
|
||||||
|
|
||||||
|
# Restore signals
|
||||||
|
for sig, func in original_signals.items():
|
||||||
|
signal.signal(sig, func)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue