diff options
author | Christian Poessinger <christian@poessinger.com> | 2020-06-19 17:07:42 +0200 |
---|---|---|
committer | Christian Poessinger <christian@poessinger.com> | 2020-06-19 17:07:42 +0200 |
commit | e3fdb3c4f2b2b94e241ecd82dcb032020bbc1718 (patch) | |
tree | 43a869c1dc2f406d02bca7d55bacc1418dae3048 /src/conf_mode | |
parent | a686e090b2bd19ce27d3d09318d63208448e0707 (diff) | |
parent | 9130507c08a88a46325efe7e95ed74126ec6cec8 (diff) | |
download | vyos-1x-e3fdb3c4f2b2b94e241ecd82dcb032020bbc1718.tar.gz vyos-1x-e3fdb3c4f2b2b94e241ecd82dcb032020bbc1718.zip |
Merge branch 'console-server' of github.com:c-po/vyos-1x into current
* 'console-server' of github.com:c-po/vyos-1x:
console-server: T2490: set service priority to 990
op-mode: console-server: T2490: rename "connect console-server" to "connect console"
console-server: T2490: server must listen only on localhost
op-mode: add "show ip ports" to list local opened ports
console-server: T2490: add SSH support for direct device access
op-mode: console-server: T2490: get connection info
console-server: T2490: remove superfluous "port" node from XML definition
console-server: T2490: rename CLI to console-server
console-server: T2490: add SSH support
console-server: T2490: log to journald
console-server: T2490: move CLI parsing to get_config_dict()
console-server: T2490: replace ser2net with conserver
op-mode: T2490: add "connect serial-proxy" CLI command
console-server: T2490: add default CLI values
console-server: T2490: rename CLI to "serial-proxy"
console-server: T2490: use new USB ports "by-bus"
console-server: T2490: use "ls" for completion helper
console-server: T2490: initial support
Diffstat (limited to 'src/conf_mode')
-rwxr-xr-x | src/conf_mode/service_console-server.py | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/src/conf_mode/service_console-server.py b/src/conf_mode/service_console-server.py new file mode 100755 index 000000000..7f6967983 --- /dev/null +++ b/src/conf_mode/service_console-server.py @@ -0,0 +1,109 @@ +#!/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'/run/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', 'console-server'] + + 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 device in proxy['device']: + keys = proxy['device'][device].keys() + if 'speed' not in keys: + raise ConfigError(f'Serial port speed must be defined for "{tmp}"!') + + if 'ssh' in keys: + ssh_keys = proxy['device'][device]['ssh'].keys() + if 'port' not in ssh_keys: + raise ConfigError(f'SSH port must be defined for "{tmp}"!') + + return None + +def generate(proxy): + if not proxy: + return None + + render(config_file, 'conserver/conserver.conf.tmpl', proxy) + return None + +def apply(proxy): + call('systemctl stop dropbear@*.service conserver-server.service') + + if not proxy: + if os.path.isfile(config_file): + os.unlink(config_file) + return None + + call('systemctl restart conserver-server.service') + + for device in proxy['device']: + if 'ssh' in proxy['device'][device].keys(): + port = proxy['device'][device]['ssh']['port'] + call(f'systemctl restart dropbear@{device}.service') + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) |