1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """IPsec utilities library."""
16 from ipaddress import ip_network
20 from resources.libraries.python.VatExecutor import VatExecutor
21 from resources.libraries.python.topology import Topology
22 from resources.libraries.python.VatJsonUtil import VatJsonUtil
25 class PolicyAction(Enum):
31 def __init__(self, string):
35 class CryptoAlg(Enum):
36 """Encryption algorithms."""
37 AES_CBC_128 = ('aes-cbc-128', 'AES-CBC', 16)
38 AES_CBC_192 = ('aes-cbc-192', 'AES-CBC', 24)
39 AES_CBC_256 = ('aes-cbc-256', 'AES-CBC', 32)
41 def __init__(self, alg_name, scapy_name, key_len):
42 self.alg_name = alg_name
43 self.scapy_name = scapy_name
44 self.key_len = key_len
48 """Integrity algorithm."""
49 SHA1_96 = ('sha1-96', 'HMAC-SHA1-96', 20)
50 SHA_256_128 = ('sha-256-128', 'SHA2-256-128', 32)
51 SHA_384_192 = ('sha-384-192', 'SHA2-384-192', 48)
52 SHA_512_256 = ('sha-512-256', 'SHA2-512-256', 64)
54 def __init__(self, alg_name, scapy_name, key_len):
55 self.alg_name = alg_name
56 self.scapy_name = scapy_name
57 self.key_len = key_len
60 class IPsecUtil(object):
61 """IPsec utilities."""
64 def policy_action_bypass():
65 """Return policy action bypass.
67 :returns: PolicyAction enum BYPASS object.
70 return PolicyAction.BYPASS
73 def policy_action_discard():
74 """Return policy action discard.
76 :returns: PolicyAction enum DISCARD object.
79 return PolicyAction.DISCARD
82 def policy_action_protect():
83 """Return policy action protect.
85 :returns: PolicyAction enum PROTECT object.
88 return PolicyAction.PROTECT
91 def crypto_alg_aes_cbc_128():
92 """Return encryption algorithm aes-cbc-128.
94 :returns: CryptoAlg enum AES_CBC_128 object.
97 return CryptoAlg.AES_CBC_128
100 def crypto_alg_aes_cbc_192():
101 """Return encryption algorithm aes-cbc-192.
103 :returns: CryptoAlg enum AES_CBC_192 objec.
106 return CryptoAlg.AES_CBC_192
109 def crypto_alg_aes_cbc_256():
110 """Return encryption algorithm aes-cbc-256.
112 :returns: CryptoAlg enum AES_CBC_256 object.
115 return CryptoAlg.AES_CBC_256
118 def get_crypto_alg_key_len(crypto_alg):
119 """Return encryption algorithm key length.
121 :param crypto_alg: Encryption algorithm.
122 :type crypto_alg: CryptoAlg
123 :returns: Key length.
126 return crypto_alg.key_len
129 def get_crypto_alg_scapy_name(crypto_alg):
130 """Return encryption algorithm scapy name.
132 :param crypto_alg: Encryption algorithm.
133 :type crypto_alg: CryptoAlg
134 :returns: Algorithm scapy name.
137 return crypto_alg.scapy_name
140 def integ_alg_sha1_96():
141 """Return integrity algorithm SHA1-96.
143 :returns: IntegAlg enum SHA1_96 object.
146 return IntegAlg.SHA1_96
149 def integ_alg_sha_256_128():
150 """Return integrity algorithm SHA-256-128.
152 :returns: IntegAlg enum SHA_256_128 object.
155 return IntegAlg.SHA_256_128
158 def integ_alg_sha_384_192():
159 """Return integrity algorithm SHA-384-192.
161 :returns: IntegAlg enum SHA_384_192 object.
164 return IntegAlg.SHA_384_192
167 def integ_alg_sha_512_256():
168 """Return integrity algorithm SHA-512-256.
170 :returns: IntegAlg enum SHA_512_256 object.
173 return IntegAlg.SHA_512_256
176 def get_integ_alg_key_len(integ_alg):
177 """Return integrity algorithm key length.
179 :param integ_alg: Integrity algorithm.
180 :type integ_alg: IntegAlg
181 :returns: Key length.
184 return integ_alg.key_len
187 def get_integ_alg_scapy_name(integ_alg):
188 """Return integrity algorithm scapy name.
190 :param integ_alg: Integrity algorithm.
191 :type integ_alg: IntegAlg
192 :returns: Algorithm scapy name.
195 return integ_alg.scapy_name
198 def vpp_ipsec_add_sad_entry(node, sad_id, spi, crypto_alg, crypto_key,
199 integ_alg, integ_key, tunnel_src=None,
201 """Create Security Association Database entry on the VPP node.
203 :param node: VPP node to add SAD entry on.
204 :param sad_id: SAD entry ID.
205 :param spi: Security Parameter Index of this SAD entry.
206 :param crypto_alg: The encryption algorithm name.
207 :param crypto_key: The encryption key string.
208 :param integ_alg: The integrity algorithm name.
209 :param integ_key: The integrity key string.
210 :param tunnel_src: Tunnel header source IPv4 or IPv6 address. If not
211 specified ESP transport mode is used.
212 :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
213 not specified ESP transport mode is used.
217 :type crypto_alg: CryptoAlg
218 :type crypto_key: str
221 :type tunnel_src: str
222 :type tunnel_dst: str
224 ckey = crypto_key.encode('hex')
225 ikey = integ_key.encode('hex')
226 tunnel = 'tunnel_src {0} tunnel_dst {1}'.format(tunnel_src, tunnel_dst)\
227 if tunnel_src is not None and tunnel_dst is not None else ''
229 out = VatExecutor.cmd_from_template(node,
230 "ipsec/ipsec_sad_add_entry.vat",
231 sad_id=sad_id, spi=spi,
232 calg=crypto_alg.alg_name, ckey=ckey,
233 ialg=integ_alg.alg_name, ikey=ikey,
235 VatJsonUtil.verify_vat_retval(
237 err_msg='Add SAD entry failed on {0}'.format(node['host']))
240 def vpp_ipsec_sa_set_key(node, sa_id, crypto_key, integ_key):
241 """Update Security Association (SA) keys.
243 :param node: VPP node to update SA keys.
244 :param sa_id: SAD entry ID.
245 :param crypto_key: The encryption key string.
246 :param integ_key: The integrity key string.
249 :type crypto_key: str
252 ckey = crypto_key.encode('hex')
253 ikey = integ_key.encode('hex')
255 out = VatExecutor.cmd_from_template(node,
256 "ipsec/ipsec_sa_set_key.vat",
258 ckey=ckey, ikey=ikey)
259 VatJsonUtil.verify_vat_retval(
261 err_msg='Update SA key failed on {0}'.format(node['host']))
264 def vpp_ipsec_add_spd(node, spd_id):
265 """Create Security Policy Database on the VPP node.
267 :param node: VPP node to add SPD on.
268 :param spd_id: SPD ID.
272 out = VatExecutor.cmd_from_template(node, "ipsec/ipsec_spd_add.vat",
274 VatJsonUtil.verify_vat_retval(
276 err_msg='Add SPD {0} failed on {1}'.format(spd_id, node['host']))
279 def vpp_ipsec_spd_add_if(node, spd_id, interface):
280 """Add interface to the Security Policy Database.
282 :param node: VPP node.
283 :param spd_id: SPD ID to add interface on.
284 :param interface: Interface name or sw_if_index.
287 :type interface: str or int
289 sw_if_index = Topology.get_interface_sw_index(node, interface)\
290 if isinstance(interface, basestring) else interface
292 out = VatExecutor.cmd_from_template(node,
293 "ipsec/ipsec_interface_add_spd.vat",
294 spd_id=spd_id, sw_if_id=sw_if_index)
295 VatJsonUtil.verify_vat_retval(
297 err_msg='Add interface {0} to SPD {1} failed on {2}'.format(
298 interface, spd_id, node['host']))
301 def vpp_ipsec_spd_add_entry(node, spd_id, priority, action, inbound=True,
302 sa_id=None, laddr_range=None, raddr_range=None,
303 proto=None, lport_range=None, rport_range=None):
304 """Create Security Policy Database entry on the VPP node.
306 :param node: VPP node to add SPD entry on.
307 :param spd_id: SPD ID to add entry on.
308 :param priority: SPD entry priority, higher number = higher priority.
309 :param action: Policy action.
310 :param inbound: If True policy is for inbound traffic, otherwise
312 :param sa_id: SAD entry ID for protect action.
313 :param laddr_range: Policy selector local IPv4 or IPv6 address range in
314 format IP/prefix or IP/mask. If no mask is provided, it's considered
316 :param raddr_range: Policy selector remote IPv4 or IPv6 address range in
317 format IP/prefix or IP/mask. If no mask is provided, it's considered
319 :param proto: Policy selector next layer protocol number.
320 :param lport_range: Policy selector local TCP/UDP port range in format
321 <port_start>-<port_end>.
322 :param rport_range: Policy selector remote TCP/UDP port range in format
323 <port_start>-<port_end>.
327 :type action: PolicyAction
330 :type laddr_range: string
331 :type raddr_range: string
333 :type lport_range: string
334 :type rport_range: string
336 direction = 'inbound' if inbound else 'outbound'
338 act_str = action.value
339 if PolicyAction.PROTECT == action and sa_id is not None:
340 act_str += 'sa_id {0}'.format(sa_id)
343 if laddr_range is not None:
344 net = ip_network(unicode(laddr_range), strict=False)
345 selector += 'laddr_start {0} laddr_stop {1} '.format(
346 net.network_address, net.broadcast_address)
347 if raddr_range is not None:
348 net = ip_network(unicode(raddr_range), strict=False)
349 selector += 'raddr_start {0} raddr_stop {1} '.format(
350 net.network_address, net.broadcast_address)
351 if proto is not None:
352 selector += 'protocol {0} '.format(proto)
353 if lport_range is not None:
354 selector += 'lport_start {p[0]} lport_stop {p[1]} '.format(
355 p=lport_range.split('-'))
356 if rport_range is not None:
357 selector += 'rport_start {p[0]} rport_stop {p[1]} '.format(
358 p=rport_range.split('-'))
360 out = VatExecutor.cmd_from_template(node,
361 "ipsec/ipsec_spd_add_entry.vat",
362 spd_id=spd_id, priority=priority,
363 action=act_str, direction=direction,
365 VatJsonUtil.verify_vat_retval(
367 err_msg='Add entry to SPD {0} failed on {1}'.format(spd_id,
371 def vpp_ipsec_show(node):
372 """Run "show ipsec" debug CLI command.
374 :param node: Node to run command on.
377 VatExecutor().execute_script("ipsec/ipsec_show.vat", node,