1 """ BFD protocol implementation """
3 from random import randint
4 from socket import AF_INET, AF_INET6, inet_pton
5 from scapy.all import bind_layers
6 from scapy.layers.inet import UDP
7 from scapy.packet import Packet
8 from scapy.fields import BitField, BitEnumField, XByteField, FlagsField,\
9 ConditionalField, StrField
10 from vpp_object import VppObject
11 from util import NumericConstant
14 class BFDDiagCode(NumericConstant):
15 """ BFD Diagnostic Code """
17 control_detection_time_expired = 1
18 echo_function_failed = 2
19 neighbor_signaled_session_down = 3
20 forwarding_plane_reset = 4
22 concatenated_path_down = 6
23 administratively_down = 7
24 reverse_concatenated_path_down = 8
27 no_diagnostic: "No diagnostic",
28 control_detection_time_expired: "Control Detection Time Expired",
29 echo_function_failed: "Echo Function Failed",
30 neighbor_signaled_session_down: "Neighbor Signaled Session Down",
31 forwarding_plane_reset: "Forwarding Plane Reset",
32 path_down: "Path Down",
33 concatenated_path_down: "Concatenated Path Down",
34 administratively_down: "Administratively Down",
35 reverse_concatenated_path_down: "Reverse Concatenated Path Down",
39 class BFDState(NumericConstant):
47 admin_down: "AdminDown",
54 class BFDAuthType(NumericConstant):
55 """ BFD Authentication Type """
59 meticulous_keyed_md5 = 3
61 meticulous_keyed_sha1 = 5
64 no_auth: "No authentication",
65 simple_pwd: "Simple Password",
66 keyed_md5: "Keyed MD5",
67 meticulous_keyed_md5: "Meticulous Keyed MD5",
68 keyed_sha1: "Keyed SHA1",
69 meticulous_keyed_sha1: "Meticulous Keyed SHA1",
73 def bfd_is_auth_used(pkt):
74 """ is packet authenticated? """
75 return "A" in pkt.sprintf("%BFD.flags%")
78 def bfd_is_simple_pwd_used(pkt):
79 """ is simple password authentication used? """
80 return bfd_is_auth_used(pkt) and pkt.auth_type == BFDAuthType.simple_pwd
83 def bfd_is_sha1_used(pkt):
84 """ is sha1 authentication used? """
85 return bfd_is_auth_used(pkt) and pkt.auth_type in \
86 (BFDAuthType.keyed_sha1, BFDAuthType.meticulous_keyed_sha1)
89 def bfd_is_md5_used(pkt):
90 """ is md5 authentication used? """
91 return bfd_is_auth_used(pkt) and pkt.auth_type in \
92 (BFDAuthType.keyed_md5, BFDAuthType.meticulous_keyed_md5)
95 def bfd_is_md5_or_sha1_used(pkt):
96 """ is md5 or sha1 used? """
97 return bfd_is_md5_used(pkt) or bfd_is_sha1_used(pkt)
101 """ BFD protocol layer for scapy """
103 udp_dport = 3784 #: BFD destination port per RFC 5881
104 udp_dport_echo = 3785 # : BFD destination port for ECHO per RFC 5881
105 udp_sport_min = 49152 #: BFD source port min value per RFC 5881
106 udp_sport_max = 65535 #: BFD source port max value per RFC 5881
107 bfd_pkt_len = 24 # : length of BFD pkt without authentication section
108 sha1_auth_len = 28 # : length of authentication section if SHA1 used
113 BitField("version", 1, 3),
114 BitEnumField("diag", 0, 5, BFDDiagCode.desc_dict),
115 BitEnumField("state", 0, 2, BFDState.desc_dict),
116 FlagsField("flags", 0, 6, ['M', 'D', 'A', 'C', 'F', 'P']),
117 XByteField("detect_mult", 0),
118 BitField("length", bfd_pkt_len, 8),
119 BitField("my_discriminator", 0, 32),
120 BitField("your_discriminator", 0, 32),
121 BitField("desired_min_tx_interval", 0, 32),
122 BitField("required_min_rx_interval", 0, 32),
123 BitField("required_min_echo_rx_interval", 0, 32),
125 BitEnumField("auth_type", 0, 8, BFDAuthType.desc_dict),
127 ConditionalField(BitField("auth_len", 0, 8), bfd_is_auth_used),
128 ConditionalField(BitField("auth_key_id", 0, 8), bfd_is_auth_used),
129 ConditionalField(BitField("auth_reserved", 0, 8),
130 bfd_is_md5_or_sha1_used),
132 BitField("auth_seq_num", 0, 32), bfd_is_md5_or_sha1_used),
133 ConditionalField(StrField("auth_key_hash", "0" * 16), bfd_is_md5_used),
135 StrField("auth_key_hash", "0" * 20), bfd_is_sha1_used),
139 return self.sprintf("BFD(my_disc=%BFD.my_discriminator%,"
140 "your_disc=%BFD.your_discriminator%)")
143 # glue the BFD packet class to scapy parser
144 bind_layers(UDP, BFD, dport=BFD.udp_dport)
147 class BFD_vpp_echo(Packet):
148 """ BFD echo packet as used by VPP (non-rfc, as rfc doesn't define one) """
150 udp_dport = 3785 #: BFD echo destination port per RFC 5881
151 name = "BFD_VPP_ECHO"
154 BitField("discriminator", 0, 32),
155 BitField("expire_time_clocks", 0, 64),
156 BitField("checksum", 0, 64)
161 "BFD_VPP_ECHO(disc=%BFD_VPP_ECHO.discriminator%,"
162 "expire_time_clocks=%BFD_VPP_ECHO.expire_time_clocks%)")
165 # glue the BFD echo packet class to scapy parser
166 bind_layers(UDP, BFD_vpp_echo, dport=BFD_vpp_echo.udp_dport)
169 class VppBFDAuthKey(VppObject):
170 """ Represents BFD authentication key in VPP """
172 def __init__(self, test, conf_key_id, auth_type, key):
175 self._auth_type = auth_type
176 test.assertIn(auth_type, BFDAuthType.desc_dict)
177 self._conf_key_id = conf_key_id
181 """ Test which created this key """
186 """ Authentication type for this key """
187 return self._auth_type
195 def key(self, value):
199 def conf_key_id(self):
200 """ configuration key ID """
201 return self._conf_key_id
203 def add_vpp_config(self):
204 self.test.vapi.bfd_auth_set_key(
205 self._conf_key_id, self._auth_type, self._key)
206 self._test.registry.register(self, self.test.logger)
208 def get_bfd_auth_keys_dump_entry(self):
209 """ get the entry in the auth keys dump corresponding to this key """
210 result = self.test.vapi.bfd_auth_keys_dump()
212 if k.conf_key_id == self._conf_key_id:
216 def query_vpp_config(self):
217 return self.get_bfd_auth_keys_dump_entry() is not None
219 def remove_vpp_config(self):
220 self.test.vapi.bfd_auth_del_key(self._conf_key_id)
223 return "bfd-auth-key-%s" % self._conf_key_id
226 return self.object_id()
229 class VppBFDUDPSession(VppObject):
230 """ Represents BFD UDP session in VPP """
232 def __init__(self, test, interface, peer_addr, local_addr=None, af=AF_INET,
233 desired_min_tx=300000, required_min_rx=300000, detect_mult=3,
234 sha1_key=None, bfd_key_id=None):
236 self._interface = interface
238 self._local_addr = local_addr
239 if local_addr is not None:
240 self._local_addr_n = inet_pton(af, local_addr)
242 self._local_addr_n = None
243 self._peer_addr = peer_addr
244 self._peer_addr_n = inet_pton(af, peer_addr)
245 self._desired_min_tx = desired_min_tx
246 self._required_min_rx = required_min_rx
247 self._detect_mult = detect_mult
248 self._sha1_key = sha1_key
249 if bfd_key_id is not None:
250 self._bfd_key_id = bfd_key_id
252 self._bfd_key_id = randint(0, 255)
256 """ Test which created this session """
261 """ Interface on which this session lives """
262 return self._interface
266 """ Address family - AF_INET or AF_INET6 """
270 def local_addr(self):
271 """ BFD session local address (VPP address) """
272 if self._local_addr is None:
273 if self.af == AF_INET:
274 return self._interface.local_ip4
275 elif self.af == AF_INET6:
276 return self._interface.local_ip6
278 raise Exception("Unexpected af '%s'" % self.af)
279 return self._local_addr
282 def local_addr_n(self):
283 """ BFD session local address (VPP address) - raw, suitable for API """
284 if self._local_addr is None:
285 if self.af == AF_INET:
286 return self._interface.local_ip4n
287 elif self.af == AF_INET6:
288 return self._interface.local_ip6n
290 raise Exception("Unexpected af '%s'" % self.af)
291 return self._local_addr_n
295 """ BFD session peer address """
296 return self._peer_addr
299 def peer_addr_n(self):
300 """ BFD session peer address - raw, suitable for API """
301 return self._peer_addr_n
303 def get_bfd_udp_session_dump_entry(self):
304 """ get the namedtuple entry from bfd udp session dump """
305 result = self.test.vapi.bfd_udp_session_dump()
307 self.test.logger.debug("session entry: %s" % str(s))
308 if s.sw_if_index == self.interface.sw_if_index:
309 if self.af == AF_INET \
311 and self.interface.local_ip4n == s.local_addr[:4] \
312 and self.interface.remote_ip4n == s.peer_addr[:4]:
314 if self.af == AF_INET6 \
316 and self.interface.local_ip6n == s.local_addr \
317 and self.interface.remote_ip6n == s.peer_addr:
323 """ BFD session state """
324 session = self.get_bfd_udp_session_dump_entry()
326 raise Exception("Could not find BFD session in VPP response")
330 def desired_min_tx(self):
331 """ desired minimum tx interval """
332 return self._desired_min_tx
335 def required_min_rx(self):
336 """ required minimum rx interval """
337 return self._required_min_rx
340 def detect_mult(self):
341 """ detect multiplier """
342 return self._detect_mult
347 return self._sha1_key
350 def bfd_key_id(self):
351 """ bfd key id in use """
352 return self._bfd_key_id
354 def activate_auth(self, key, bfd_key_id=None, delayed=False):
355 """ activate authentication for this session """
356 self._bfd_key_id = bfd_key_id if bfd_key_id else randint(0, 255)
358 is_ipv6 = 1 if AF_INET6 == self.af else 0
359 conf_key_id = self._sha1_key.conf_key_id
360 is_delayed = 1 if delayed else 0
361 self.test.vapi.bfd_udp_auth_activate(self._interface.sw_if_index,
365 bfd_key_id=self._bfd_key_id,
366 conf_key_id=conf_key_id,
367 is_delayed=is_delayed)
369 def deactivate_auth(self, delayed=False):
370 """ deactivate authentication """
371 self._bfd_key_id = None
372 self._sha1_key = None
373 is_delayed = 1 if delayed else 0
374 is_ipv6 = 1 if AF_INET6 == self.af else 0
375 self.test.vapi.bfd_udp_auth_deactivate(self._interface.sw_if_index,
379 is_delayed=is_delayed)
381 def modify_parameters(self,
384 required_min_rx=None):
385 """ modify session parameters """
387 self._detect_mult = detect_mult
389 self._desired_min_tx = desired_min_tx
391 self._required_min_rx = required_min_rx
392 is_ipv6 = 1 if AF_INET6 == self.af else 0
393 self.test.vapi.bfd_udp_mod(self._interface.sw_if_index,
395 self.required_min_rx,
401 def add_vpp_config(self):
402 is_ipv6 = 1 if AF_INET6 == self.af else 0
403 bfd_key_id = self._bfd_key_id if self._sha1_key else None
404 conf_key_id = self._sha1_key.conf_key_id if self._sha1_key else None
405 self.test.vapi.bfd_udp_add(self._interface.sw_if_index,
407 self.required_min_rx,
412 bfd_key_id=bfd_key_id,
413 conf_key_id=conf_key_id)
414 self._test.registry.register(self, self.test.logger)
416 def query_vpp_config(self):
417 session = self.get_bfd_udp_session_dump_entry()
418 return session is not None
420 def remove_vpp_config(self):
421 is_ipv6 = 1 if AF_INET6 == self._af else 0
422 self.test.vapi.bfd_udp_del(self._interface.sw_if_index,
428 return "bfd-udp-%s-%s-%s-%s" % (self._interface.sw_if_index,
434 return self.object_id()
437 """ set bfd session admin-up """
438 is_ipv6 = 1 if AF_INET6 == self._af else 0
439 self.test.vapi.bfd_udp_session_set_flags(1,
440 self._interface.sw_if_index,
445 def admin_down(self):
446 """ set bfd session admin-down """
447 is_ipv6 = 1 if AF_INET6 == self._af else 0
448 self.test.vapi.bfd_udp_session_set_flags(0,
449 self._interface.sw_if_index,