summaryrefslogtreecommitdiff
path: root/smoketest/scripts/cli/test_nat.py
blob: 43392bde32dcab803e436aff188f65ddb535a5e9 (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
#!/usr/bin/env python3
#
# Copyright (C) 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 jmespath
import json
import unittest

from vyos.configsession import ConfigSession
from vyos.configsession import ConfigSessionError
from vyos.util import cmd
from vyos.util import dict_search

base_path = ['nat']
src_path = base_path + ['source']
dst_path = base_path + ['destination']

class TestNAT(unittest.TestCase):
    def setUp(self):
        # ensure we can also run this test on a live system - so lets clean
        # out the current configuration :)
        self.session = ConfigSession(os.getpid())
        self.session.delete(base_path)

    def tearDown(self):
        self.session.delete(base_path)
        self.session.commit()

    def test_snat(self):
        """ Test source NAT (SNAT) rules """

        rules = ['100', '110', '120', '130', '200', '210', '220', '230']
        outbound_iface_100 = 'eth0'
        outbound_iface_200 = 'eth1'
        for rule in rules:
            network = f'192.168.{rule}.0/24'
            # depending of rule order we check either for source address for NAT
            # or configured destination address for NAT
            if int(rule) < 200:
                self.session.set(src_path + ['rule', rule, 'source', 'address', network])
                self.session.set(src_path + ['rule', rule, 'outbound-interface', outbound_iface_100])
                self.session.set(src_path + ['rule', rule, 'translation', 'address', 'masquerade'])
            else:
                self.session.set(src_path + ['rule', rule, 'destination', 'address', network])
                self.session.set(src_path + ['rule', rule, 'outbound-interface', outbound_iface_200])
                self.session.set(src_path + ['rule', rule, 'exclude'])

        self.session.commit()

        tmp = cmd('sudo nft -j list table nat')
        data_json = jmespath.search('nftables[?rule].rule[?chain]', json.loads(tmp))

        for idx in range(0, len(data_json)):
            rule = str(rules[idx])
            data = data_json[idx]
            network = f'192.168.{rule}.0/24'

            self.assertEqual(data['chain'], 'POSTROUTING')
            self.assertEqual(data['comment'], f'SRC-NAT-{rule}')
            self.assertEqual(data['family'], 'ip')
            self.assertEqual(data['table'], 'nat')

            iface = dict_search('match.right', data['expr'][0])
            direction = dict_search('match.left.payload.field', data['expr'][1])
            address = dict_search('match.right.prefix.addr', data['expr'][1])
            mask = dict_search('match.right.prefix.len', data['expr'][1])

            if int(rule) < 200:
                self.assertEqual(direction, 'saddr')
                self.assertEqual(iface, outbound_iface_100)
                # check for masquerade keyword
                self.assertIn('masquerade', data['expr'][3])
            else:
                self.assertEqual(direction, 'daddr')
                self.assertEqual(iface, outbound_iface_200)
                # check for return keyword due to 'exclude'
                self.assertIn('return', data['expr'][3])

            self.assertEqual(f'{address}/{mask}', network)

    def test_dnat(self):
        """ Test destination NAT (DNAT) rules """

        rules = ['100', '110', '120', '130', '200', '210', '220', '230']
        inbound_iface_100 = 'eth0'
        inbound_iface_200 = 'eth1'
        inbound_proto_100 = 'udp'
        inbound_proto_200 = 'tcp'

        for rule in rules:
            port = f'10{rule}'
            self.session.set(dst_path + ['rule', rule, 'source', 'port', port])
            self.session.set(dst_path + ['rule', rule, 'translation', 'address', '192.0.2.1'])
            self.session.set(dst_path + ['rule', rule, 'translation', 'port', port])
            if int(rule) < 200:
                self.session.set(dst_path + ['rule', rule, 'protocol', inbound_proto_100])
                self.session.set(dst_path + ['rule', rule, 'inbound-interface', inbound_iface_100])
            else:
                self.session.set(dst_path + ['rule', rule, 'protocol', inbound_proto_200])
                self.session.set(dst_path + ['rule', rule, 'inbound-interface', inbound_iface_200])

        self.session.commit()

        tmp = cmd('sudo nft -j list table nat')
        data_json = jmespath.search('nftables[?rule].rule[?chain]', json.loads(tmp))

        for idx in range(0, len(data_json)):
            rule = str(rules[idx])
            data = data_json[idx]
            port = int(f'10{rule}')

            self.assertEqual(data['chain'], 'PREROUTING')
            self.assertEqual(data['comment'].split()[0], f'DST-NAT-{rule}')
            self.assertEqual(data['family'], 'ip')
            self.assertEqual(data['table'], 'nat')

            iface = dict_search('match.right', data['expr'][0])
            direction = dict_search('match.left.payload.field', data['expr'][1])
            protocol = dict_search('match.left.payload.protocol', data['expr'][1])
            dnat_addr = dict_search('dnat.addr', data['expr'][3])
            dnat_port = dict_search('dnat.port', data['expr'][3])

            self.assertEqual(direction, 'sport')
            self.assertEqual(dnat_addr, '192.0.2.1')
            self.assertEqual(dnat_port, port)
            if int(rule) < 200:
                self.assertEqual(iface, inbound_iface_100)
                self.assertEqual(protocol, inbound_proto_100)
            else:
                self.assertEqual(iface, inbound_iface_200)


    def test_validation_logic(self):
        """ T2813: Ensure translation address is specified """
        rule = '5'
        self.session.set(src_path + ['rule', rule, 'source', 'address', '192.0.2.0/24'])

        # check validate() - outbound-interface must be defined
        with self.assertRaises(ConfigSessionError):
            self.session.commit()
        self.session.set(src_path + ['rule', rule, 'outbound-interface', 'eth0'])

        # check validate() - translation address not specified
        with self.assertRaises(ConfigSessionError):
            self.session.commit()

        self.session.set(src_path + ['rule', rule, 'translation', 'address', 'masquerade'])
        self.session.commit()

if __name__ == '__main__':
    unittest.main()