summaryrefslogtreecommitdiff
path: root/src/conf_mode/service_console-server.py
blob: 60eff65430bfe049b14672334b77148406c0170b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
#!/usr/bin/env python3
#
# Copyright (C) 2018-2021 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 psutil import process_iter

from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.template import render
from vyos.util import call
from vyos.xml import defaults
from vyos import ConfigError

config_file = '/run/conserver/conserver.cf'
dropbear_systemd_file = '/run/systemd/system/dropbear@{port}.service.d/override.conf'

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()
    base = ['service', 'console-server']

    # Retrieve CLI representation as dictionary
    proxy = conf.get_config_dict(base, key_mangling=('-', '_'),
                                 get_first_key=True)
    # 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.
    default_values = defaults(base + ['device'])
    if 'device' in proxy:
        for device in proxy['device']:
            tmp = dict_merge(default_values, proxy['device'][device])
            proxy['device'][device] = tmp

    return proxy

def verify(proxy):
    if not proxy:
        return None

    aliases = []
    processes = process_iter(['name', 'cmdline'])
    if 'device' in proxy:
        for device, device_config in proxy['device'].items():
            for process in processes:
                if 'agetty' in process.name() and device in process.cmdline():
                    raise ConfigError(f'Port "{device}" already provides a '\
                                      'console used by "system console"!')

            if 'speed' not in device_config:
                raise ConfigError(f'Port "{device}" requires speed to be set!')

            if 'ssh' in device_config and 'port' not in device_config['ssh']:
                raise ConfigError(f'Port "{device}" requires SSH port to be set!')

            if 'alias' in device_config:
                if device_config['alias'] in aliases:
                    raise ConfigError("Console aliases must be unique")
                else:
                    aliases.append(device_config['alias'])

    return None

def generate(proxy):
    if not proxy:
        return None

    render(config_file, 'conserver/conserver.conf.j2', proxy)
    if 'device' in proxy:
        for device, device_config in proxy['device'].items():
            if 'ssh' not in device_config:
                continue

            tmp = {
                'device' : device,
                'port' : device_config['ssh']['port'],
            }
            render(dropbear_systemd_file.format(**tmp),
                   'conserver/dropbear@.service.j2', tmp)

    return None

def apply(proxy):
    call('systemctl daemon-reload')
    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')

    if 'device' in proxy:
        for device, device_config in proxy['device'].items():
            if 'ssh' not in device_config:
                continue
            port = device_config['ssh']['port']
            call(f'systemctl restart dropbear@{port}.service')

    return None

if __name__ == '__main__':
    try:
        c = get_config()
        verify(c)
        generate(c)
        apply(c)
    except ConfigError as e:
        print(e)
        exit(1)