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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from robot.api import logger
from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
class Classify(object):
"""Classify utilities."""
@staticmethod
def vpp_create_classify_table(node, ip_version, direction):
"""Create classify table.
:param node: VPP node to create classify table.
:param ip_version: Version of IP protocol.
:param direction: Direction of traffic - src/dst.
:type node: dict
:type ip_version: str
:type direction: str
:return (table_index, skip_n, match_n)
table_index: Classify table index.
skip_n: Number of skip vectors.
match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
output = VatExecutor.cmd_from_template(node, "classify_add_table.vat",
ip_version=ip_version,
direction=direction)
if output[0]["retval"] == 0:
table_index = output[0]["new_table_index"]
skip_n = output[0]["skip_n_vectors"]
match_n = output[0]["match_n_vectors"]
logger.trace('Classify table with table_index {} created on node {}'
.format(table_index, node['host']))
else:
raise RuntimeError('Unable to create classify table on node {}'
.format(node['host']))
return table_index, skip_n, match_n
@staticmethod
def vpp_create_classify_table_hex(node, hex_mask):
"""Create classify table with hex mask.
:param node: VPP node to create classify table based on hex mask.
:param hex_mask: Classify hex mask.
:type node: dict
:type hex_mask: str
:return (table_index, skip_n, match_n)
table_index: Classify table index.
skip_n: Number of skip vectors.
match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
output = VatExecutor.cmd_from_template(node,
"classify_add_table_hex.vat",
hex_mask=hex_mask)
if output[0]["retval"] == 0:
table_index = output[0]["new_table_index"]
skip_n = output[0]["skip_n_vectors"]
match_n = output[0]["match_n_vectors"]
logger.trace('Classify table with table_index {} created on node {}'
.format(table_index, node['host']))
else:
raise RuntimeError('Unable to create classify table on node {}'
.format(node['host']))
return table_index, skip_n, match_n
@staticmethod
def vpp_configure_classify_session(node, acl_method, table_index, skip_n,
match_n, ip_version, direction, address):
"""Configuration of classify session.
:param node: VPP node to setup classify session.
:param acl_method: ACL method - deny/permit.
:param table_index: Classify table index.
:param skip_n: Number of skip vectors based on mask.
:param match_n: Number of match vectors based on mask.
:param ip_version: Version of IP protocol.
:param direction: Direction of traffic - src/dst.
:param address: IPv4 or IPv6 address.
:type node: dict
:type acl_method: str
:type table_index: int
:type skip_n: int
:type match_n: int
:type ip_version: str
:type direction: str
:type address: str
"""
with VatTerminal(node) as vat:
vat.vat_terminal_exec_cmd_from_template("classify_add_session.vat",
acl_method=acl_method,
table_index=table_index,
skip_n=skip_n,
match_n=match_n,
ip_version=ip_version,
direction=direction,
address=address)
@staticmethod
def vpp_configure_classify_session_hex(node, acl_method, table_index,
skip_n, match_n, hex_value):
"""Configuration of classify session with hex value.
:param node: VPP node to setup classify session.
:param acl_method: ACL method - deny/permit.
:param table_index: Classify table index.
:param skip_n: Number of skip vectors based on mask.
:param match_n: Number of match vectors based on mask.
:param hex_value: Classify hex value.
:type node: dict
:type acl_method: str
:type table_index: int
:type skip_n: int
:type match_n: int
:type hex_value: str
"""
with VatTerminal(node) as vat:
vat.vat_terminal_exec_cmd_from_template(
"classify_add_session_hex.vat",
acl_method=acl_method,
table_index=table_index,
skip_n=skip_n,
match_n=match_n,
hex_value=hex_value)
@staticmethod
def compute_classify_hex_mask(ip_version, protocol, direction):
"""Compute classify hex mask for TCP or UDP packet matching.
:param ip_version: Version of IP protocol.
:param protocol: Type of protocol.
:param direction: Traffic direction.
:type ip_version: str
:type protocol: str
:type direction: str
:return: Classify hex mask.
:rtype : str
:raises ValueError: If protocol is not TCP or UDP.
:raises ValueError: If direction is not source or destination or
source + destination.
"""
if protocol == 'TCP' or protocol == 'UDP':
base_mask = Classify._compute_base_mask(ip_version)
if direction == 'source':
return base_mask + 'FFFF0000'
elif direction == 'destination':
return base_mask + '0000FFFF'
elif direction == 'source + destination':
return base_mask + 'FFFFFFFF'
else:
raise ValueError("Invalid direction!")
else:
raise ValueError("Invalid protocol!")
@staticmethod
def compute_classify_hex_value(hex_mask, source_port, destination_port):
"""Compute classify hex value for TCP or UDP packet matching.
:param hex_mask: Classify hex mask.
:param source_port: Source TCP/UDP port.
:param destination_port: Destination TCP/UDP port.
:type hex_mask: str
:type source_port: str
:type destination_port: str
:return: Classify hex value.
:rtype: str
"""
source_port_hex = Classify._port_convert(source_port)
destination_port_hex = Classify._port_convert(destination_port)
return hex_mask[:-8] + source_port_hex + destination_port_hex
@staticmethod
def _port_convert(port):
"""Convert port number for classify hex table format.
:param port: TCP/UDP port number.
:type port: str
:return: TCP/UDP port number in 4-digit hexadecimal format.
:rtype: str
"""
return '{0:04x}'.format(int(port))
@staticmethod
def _compute_base_mask(ip_version):
"""Compute base classify hex mask based on IP version.
:param ip_version: Version of IP protocol.
:type ip_version: str
:return: Base hex mask.
:rtype: str
"""
if ip_version == 'ip4':
return 68 * '0'
# base value of classify hex table for IPv4 TCP/UDP ports
elif ip_version == 'ip6':
return 108 * '0'
# base value of classify hex table for IPv6 TCP/UDP ports
else:
raise ValueError("Invalid IP version!")
|
