summaryrefslogtreecommitdiff
path: root/src/conf_mode/tftp_server.py
blob: 2409eec1f3e9f3f00f20394322e0331f02769255 (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
135
136
137
138
139
140
#!/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
import stat
import pwd

from copy import deepcopy
from glob import glob
from sys import exit

from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.template import render
from vyos.template import is_ipv4
from vyos.util import call
from vyos.util import chmod_755
from vyos.validate import is_addr_assigned
from vyos.xml import defaults
from vyos import ConfigError
from vyos import airbag
airbag.enable()

config_file = r'/etc/default/tftpd'

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()

    base = ['service', 'tftp-server']
    if not conf.exists(base):
        return None

    tftpd = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True)
    # 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)
    tftpd = dict_merge(default_values, tftpd)
    return tftpd

def verify(tftpd):
    # bail out early - looks like removal from running config
    if not tftpd:
        return None

    # Configuring allowed clients without a server makes no sense
    if 'directory' not in tftpd:
        raise ConfigError('TFTP root directory must be configured!')

    if 'listen_address' not in tftpd:
        raise ConfigError('TFTP server listen address must be configured!')

    for address in tftpd['listen_address']:
        if not is_addr_assigned(address):
            print(f'WARNING: TFTP server listen address "{address}" not ' \
                  'assigned to any interface!')

    return None

def generate(tftpd):
    # cleanup any available configuration file
    # files will be recreated on demand
    for i in glob(config_file + '*'):
        os.unlink(i)

    # bail out early - looks like removal from running config
    if tftpd is None:
        return None

    idx = 0
    for address in tftpd['listen_address']:
        config = deepcopy(tftpd)
        port = tftpd['port']
        if is_ipv4(address):
            config['listen_address'] = f'{address}:{port} -4'
        else:
            config['listen_address'] = f'[{address}]:{port} -6'

        file = config_file + str(idx)
        render(file, 'tftp-server/default.tmpl', config)
        idx = idx + 1

    return None

def apply(tftpd):
    # stop all services first - then we will decide
    call('systemctl stop tftpd@*.service')

    # bail out early - e.g. service deletion
    if tftpd is None:
        return None

    tftp_root = tftpd['directory']
    if not os.path.exists(tftp_root):
        os.makedirs(tftp_root)
        chmod_755(tftp_root)

    # get UNIX uid for user 'tftp'
    tftp_uid = pwd.getpwnam('tftp').pw_uid
    tftp_gid = pwd.getpwnam('tftp').pw_gid

    # get UNIX uid for tftproot directory
    dir_uid = os.stat(tftp_root).st_uid
    dir_gid = os.stat(tftp_root).st_gid

    # adjust uid/gid of tftproot directory if files don't belong to user tftp
    if (tftp_uid != dir_uid) or (tftp_gid != dir_gid):
        os.chown(tftp_root, tftp_uid, tftp_gid)

    idx = 0
    for address in tftpd['listen_address']:
        call(f'systemctl restart tftpd@{idx}.service')
        idx = idx + 1

    return None

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