Mercurial > libervia-backend

comparison sat/plugins/plugin_dbg_manhole.py @ 2755:12d1ca646af1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin manhole: manhole debug plugin, first draft: this plugin open a telnet server which open a Python interpreter and allows to inspect the backend while it is running. To enable it, the settings "manhole_debug_dangerous_port_int" must be set to the desired TCP port in [DEFAULT] section of sat.conf. A warning will be logged if the server is enabled. Currently only a telnet server is available, and no login is required. This may change in the futur to enable login/password and ssh access, or even an XMPP access. This is a debugging feature and must only be used during development. Once in the Python interpreter, the "host" variable is accessible.
author Goffi <goffi@goffi.org>
date Fri, 04 Jan 2019 18:59:24 +0100
parents
children e2005dd39c92
comparison
equal deleted inserted replaced
2754:3bea6b5ae972 2755:12d1ca646af1
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin for debugging, using a manhole
5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 from sat.core.i18n import _
21 from sat.core.constants import Const as C
22 from sat.core.log import getLogger
23 from twisted.conch.insults import insults
24 from twisted.conch.telnet import TelnetTransport, TelnetBootstrapProtocol
25 from twisted.internet import reactor, protocol
26 from twisted.conch.manhole import ColoredManhole
27
28 log = getLogger(__name__)
29
30 PLUGIN_INFO = {
31 C.PI_NAME: u"Manhole debug plugin",
32 C.PI_IMPORT_NAME: u"manhole",
33 C.PI_TYPE: u"DEBUG",
34 C.PI_PROTOCOLS: [],
35 C.PI_DEPENDENCIES: [],
36 C.PI_MAIN: u"Manhole",
37 C.PI_HANDLER: u"no",
38 C.PI_DESCRIPTION: _(u"""Debug plugin to have a telnet server"""),
39 }
40
41
42
43 class Manhole(object):
44
45 def __init__(self, host):
46 self.host = host
47 port = int(host.memory.getConfig(None, "manhole_debug_dangerous_port_int"))
48 if port:
49 self.startManhole(port)
50
51 def startManhole(self, port):
52 log.warning(_(u"/!\\ Manhole debug server activated, be sure to not use it in "
53 u"production, this is dangerous /!\\"))
54 log.info(_(u"You can connect to manhole server using telnet on port {port}")
55 .format(port=port))
56 f = protocol.ServerFactory()
57 namespace = {
58 u"host": self.host,
59 }
60 f.protocol = lambda: TelnetTransport(TelnetBootstrapProtocol,
61 insults.ServerProtocol,
62 ColoredManhole,
63 namespace=namespace,
64 )
65 reactor.listenTCP(port, f)