summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-06-18 18:55:22 +0200
committerChristian Poessinger <christian@poessinger.com>2020-06-18 21:46:13 +0200
commitb242e24af4d870e936155bdbd965858bdd39aa98 (patch)
tree1f71fcc56ba12fe3bc3ad9633bf5e611607bf9d6
parenta1ba7bae02673aca63a7006cf683ad5d541a5054 (diff)
downloadvyos-1x-b242e24af4d870e936155bdbd965858bdd39aa98.tar.gz
vyos-1x-b242e24af4d870e936155bdbd965858bdd39aa98.zip
console-server: T2490: move CLI parsing to get_config_dict()
For more examples on the new get_config_dict() approach migrate this implementation as it is not yet in production use. Also this serves as proof of concept code for further migrations.
-rw-r--r--data/templates/conserver/conserver.conf.tmpl38
-rw-r--r--data/templates/ser2net/ser2net.conf.tmpl76
-rw-r--r--interface-definitions/service_serial-proxy.xml.in2
-rw-r--r--op-mode-definitions/connect-disconnect.xml2
-rwxr-xr-xsrc/conf_mode/service_serial-proxy.py101
-rwxr-xr-xsrc/conf_mode/system_serial-proxy.py117
-rw-r--r--src/etc/systemd/system/conserver-server.service.d/override.conf3
7 files changed, 144 insertions, 195 deletions
diff --git a/data/templates/conserver/conserver.conf.tmpl b/data/templates/conserver/conserver.conf.tmpl
new file mode 100644
index 000000000..ec0eca5f0
--- /dev/null
+++ b/data/templates/conserver/conserver.conf.tmpl
@@ -0,0 +1,38 @@
+### Autogenerated by service_serial-proxy.py ###
+
+# See https://www.conserver.com/docs/conserver.cf.man.html for additional options
+
+config * {
+}
+
+default * {
+ motd "VyOS Console Server"
+ # The character '&' in logfile names are substituted with the console name.
+ logfile /var/log/conserver/&.log;
+ timestamp "30m";
+ rw *;
+}
+
+##
+## list of consoles we serve
+##
+{% for key, value in device.items() %}
+{# Depending on our USB serial console we could require a path adjustment #}
+{% set path = '/dev' if key.startswith('ttyS') else '/dev/serial/by-bus' %}
+console {{ key }} {
+ master localhost;
+ type device;
+ device {{ path }}/{{ key }};
+ baud {{ value.speed }};
+ parity {{ value.parity }};
+ options {{ "!" if value.stop_bits == "1" }}cstopb;
+}
+{% endfor %}
+
+##
+## list of clients we allow
+##
+access * {
+ trusted 127.0.0.1;
+ allowed 127.0.0.1;
+}
diff --git a/data/templates/ser2net/ser2net.conf.tmpl b/data/templates/ser2net/ser2net.conf.tmpl
deleted file mode 100644
index 0e946e84e..000000000
--- a/data/templates/ser2net/ser2net.conf.tmpl
+++ /dev/null
@@ -1,76 +0,0 @@
-### Autogenerated by ser2net.py ###
-
-# This is the configuration file for ser2net. It has the following format:
-# <TCP port>:<state>:<timeout>:<device>:<options>
-# TCP port
-# Name or number of the TCP/IP port to accept con-
-# nections from for this device. A port number may
-# be of the form [host,]port, such as 127.0.0.1,2000
-# or localhost,2000. If this is specified, it will
-# only bind to the IP address specified. Otherwise
-# it will bind to all the ports on the machine.
-#
-# state Either raw or rawlp or telnet or off. off disables
-# the port from accepting connections. It can be
-# turned on later from the control port. raw enables
-# the port and transfers all data as-is between the
-# port and the long. rawlp enables the port and
-# transfers all input data to device, device is open
-# without any termios setting. It allow to use
-# /dev/lpX devices and printers connected to them.
-# telnet enables the port and runs the telnet proto-
-# col on the port to set up telnet parameters. This
-# is most useful for using telnet.
-#
-# timeout
-# The time (in seconds) before the port will be dis-
-# connected if there is no activity on it. A zero
-# value disables this funciton.
-#
-# device The name of the device to connect to. This
-# must be in the form of /dev/<device>.
-#
-# options
-# Sets operational parameters for the serial port.
-# Options 300, 1200, 2400, 4800, 9600, 19200, 38400,
-# 57600, 115200 set the various baud rates. EVEN,
-# ODD, NONE set the parity. 1STOPBIT, 2STOPBITS set
-# the number of stop bits. 7DATABITS, 8DATABITS set
-# the number of data bits. [-]XONXOFF turns on (-
-# off) XON/XOFF support. [-]RTSCTS turns on (- off)
-# hardware flow control, [-]LOCAL turns off (- on)
-# monitoring of the modem lines, and
-# [-]HANGUP_WHEN_DONE turns on (- off) lowering the
-# modem control lines when the connextion is done.
-# NOBREAK disables automatic setting of the break
-# setting of the serial port.
-# The "remctl" option allow remote control (ala RFC
-# 2217) of serial-port configuration. A banner name
-# may also be specified, that banner will be printed
-# for the line. If no banner is given, then no
-# banner is printed.
-#
-# or...
-
-# BANNER:<banner name>:banner
-# This will create a banner, if the banner name is given in the
-# options of a line, that banner will be printed. This takes the
-# standard "C" \x characters (\r is carraige return, \n is newline,
-# etc.). It also accepts \d, which prints the device name, \p,
-# which prints the TCP port number, and \s which prints the serial
-# parameters (eg 9600N81). Banners can span lines if the last
-# character on a line is '\'. Note that you *must* use \r\n to
-# start a new line.
-#
-# Note that the same device can be listed multiple times under different
-# ports, this allows the same serial port to have both telnet and raw
-# protocols.
-
-# The original config file shipped with the upstream sources can be
-# found in /usr/share/doc/ser2net/examples
-
-BANNER:banner:\r\nConnected to serial proxy device \d [\s]\r\n\r\n
-
-{% for d in devices %}
-localhost,{{ d.port }}:telnet:{{ d.timeout }}:{{ d.serial_port }}:{{ d.speed }} {{ d.data_bits}}DATABITS {{ d.parity | upper }} {{ d.stop_bits}}STOPBIT banner
-{% endfor %}
diff --git a/interface-definitions/service_serial-proxy.xml.in b/interface-definitions/service_serial-proxy.xml.in
index b027752b9..ca93fcac3 100644
--- a/interface-definitions/service_serial-proxy.xml.in
+++ b/interface-definitions/service_serial-proxy.xml.in
@@ -2,7 +2,7 @@
<interfaceDefinition>
<node name="service">
<children>
- <node name="serial-proxy" owner="${vyos_conf_scripts_dir}/system_serial-proxy.py">
+ <node name="serial-proxy" owner="${vyos_conf_scripts_dir}/service_serial-proxy.py">
<properties>
<help>Serial to Network</help>
</properties>
diff --git a/op-mode-definitions/connect-disconnect.xml b/op-mode-definitions/connect-disconnect.xml
index 3d9262335..a394e9b91 100644
--- a/op-mode-definitions/connect-disconnect.xml
+++ b/op-mode-definitions/connect-disconnect.xml
@@ -22,7 +22,7 @@
<path>service serial-proxy device</path>
</completionHelp>
</properties>
- <command>/usr/bin/telnet localhost $(cli-shell-api returnActiveValue service serial-proxy device "$3" port)</command>
+ <command>/usr/bin/console "$3"</command>
</tagNode>
</children>
</node>
diff --git a/src/conf_mode/service_serial-proxy.py b/src/conf_mode/service_serial-proxy.py
new file mode 100755
index 000000000..85fcfed08
--- /dev/null
+++ b/src/conf_mode/service_serial-proxy.py
@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2018-2020 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from sys import exit
+
+from vyos.config import Config
+from vyos.configdict import dict_merge
+from vyos.template import render
+from vyos.util import call
+from vyos import ConfigError
+
+config_file = r'/etc/conserver/conserver.cf'
+
+# Default values are necessary until the implementation of T2588 is completed
+default_values = {
+ 'data_bits': '8',
+ 'parity': 'none',
+ 'stop_bits': '1'
+}
+
+def get_config():
+ conf = Config()
+ base = ['service', 'serial-proxy']
+
+ if not conf.exists(base):
+ return None
+
+ # Retrieve CLI representation as dictionary
+ proxy = conf.get_config_dict(base, key_mangling=('-', '_'))
+ # The retrieved dictionary will look something like this:
+ #
+ # {'device': {'usb0b2.4p1.0': {'speed': '9600'},
+ # 'usb0b2.4p1.1': {'data_bits': '8',
+ # 'parity': 'none',
+ # 'speed': '115200',
+ # 'stop_bits': '2'}}}
+
+ # We have gathered the dict representation of the CLI, but there are default
+ # options which we need to update into the dictionary retrived.
+ for device in proxy['device'].keys():
+ tmp = dict_merge(default_values, proxy['device'][device])
+ proxy['device'][device] = tmp
+
+ return proxy
+
+def verify(proxy):
+ if not proxy:
+ return None
+
+ for tmp in proxy['device']:
+ device = proxy['device'][tmp]
+ if not device['speed']:
+ raise ConfigError(f'Speed must be defined!')
+
+ if device['ssh']:
+ if not device['ssh']['port']:
+ raise ConfigError(f'SSH port must be defined!')
+
+ return None
+
+def generate(proxy):
+ if not proxy:
+ return None
+
+ render(config_file, 'conserver/conserver.conf.tmpl', proxy)
+ return None
+
+def apply(proxy):
+ if not proxy:
+ call('systemctl stop conserver-server.service')
+ if os.path.isfile(config_file):
+ os.unlink(config_file)
+ return None
+
+ call('systemctl restart conserver-server.service')
+ return None
+
+if __name__ == '__main__':
+ try:
+ c = get_config()
+ verify(c)
+ generate(c)
+ apply(c)
+ except ConfigError as e:
+ print(e)
+ exit(1)
diff --git a/src/conf_mode/system_serial-proxy.py b/src/conf_mode/system_serial-proxy.py
deleted file mode 100755
index 007277918..000000000
--- a/src/conf_mode/system_serial-proxy.py
+++ /dev/null
@@ -1,117 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2018-2020 VyOS maintainers and contributors
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 or later as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-import os
-
-from copy import deepcopy
-from sys import exit
-
-from vyos.config import Config
-from vyos.template import render
-from vyos.util import call
-from vyos import ConfigError
-
-config_file = r'/run/ser2net/ser2net.conf'
-
-default_config_data = {
- 'devices': [],
-}
-
-def get_config():
- proxy = deepcopy(default_config_data)
- conf = Config()
- base = ['service', 'serial-proxy']
-
- if not conf.exists(base):
- return None
- else:
- conf.set_level(base)
-
- for serial_port in conf.list_nodes(['device']):
- conf.set_level(base + ['device', serial_port])
- serial = {
- 'data_bits': '8',
- 'parity': 'none',
- 'port': '',
- 'serial_port': '/dev/serial/by-bus/' + serial_port,
- 'speed': '',
- 'stop_bits': '1',
- 'timeout': '600'
- }
-
- if conf.exists(['data-bits']):
- serial['data_bits'] = conf.return_value(['data-bits'])
-
- if conf.exists(['stop-bits']):
- serial['stop_bits'] = conf.return_value(['stop-bits'])
-
- if conf.exists(['parity']):
- serial['parity'] = conf.return_value(['parity'])
-
- if conf.exists(['port']):
- serial['port'] = conf.return_value(['port'])
-
- if conf.exists(['speed']):
- serial['speed'] = conf.return_value(['speed'])
-
- proxy['devices'].append(serial)
-
- return proxy
-
-def verify(proxy):
- if not proxy:
- return None
-
- for device in proxy['devices']:
- if not os.path.exists('{serial_port}'.format(**device)):
- raise ConfigError('Serial interface "{serial_port} does not exist"'
- .format(**device))
-
- if not device['port']:
- raise ConfigError(f'Port must be defined!')
-
- if not device['speed']:
- raise ConfigError(f'Speed must be defined!')
-
- return None
-
-def generate(proxy):
- if not proxy:
- return None
-
- render(config_file, 'ser2net/ser2net.conf.tmpl', proxy)
- return None
-
-def apply(proxy):
- if not proxy:
- call('systemctl stop ser2net.service')
- if os.path.isfile(config_file):
- os.unlink(config_file)
-
- return None
-
- call('systemctl start ser2net.service')
- return None
-
-if __name__ == '__main__':
- try:
- c = get_config()
- verify(c)
- generate(c)
- apply(c)
- except ConfigError as e:
- print(e)
- exit(1)
diff --git a/src/etc/systemd/system/conserver-server.service.d/override.conf b/src/etc/systemd/system/conserver-server.service.d/override.conf
new file mode 100644
index 000000000..1be5cec81
--- /dev/null
+++ b/src/etc/systemd/system/conserver-server.service.d/override.conf
@@ -0,0 +1,3 @@
+[Unit]
+After=
+After=vyos-router.service