ffho_net.py 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475
  1. #!/usr/bin/python
  2. import collections
  3. from functools import cmp_to_key
  4. import ipaddress
  5. import re
  6. from copy import deepcopy
  7. mac_prefix = "f2"
  8. # VRF configuration map
  9. vrf_info = {
  10. 'vrf_external' : {
  11. 'table' : 1023,
  12. 'fwmark' : [ '0x1', '0x1023' ],
  13. },
  14. }
  15. #
  16. # Default parameters added to any given bonding interface,
  17. # if not specified at the interface configuration.
  18. default_bond_config = {
  19. 'bond-mode': '802.3ad',
  20. 'bond-min-links': '1',
  21. 'bond-xmit-hash-policy': 'layer3+4'
  22. }
  23. #
  24. # Default parameters added to any given bridge interface,
  25. # if not specified at the interface configuration.
  26. default_bridge_config = {
  27. 'bridge-fd' : '0',
  28. 'bridge-stp' : 'no'
  29. }
  30. #
  31. # Hop penalty to be set if none is explicitly specified.
  32. # Check if one of these roles is configured for any given node, use first match.
  33. default_hop_penalty_by_role = {
  34. 'bbr' : 5,
  35. 'bras' : 50,
  36. 'batman_gw' : 50,
  37. 'batman_ext': 50,
  38. }
  39. batman_role_evaluation_order = [ 'bbr', 'batman_gw', 'bras' ]
  40. default_batman_iface_penalty_by_role = {
  41. 'local_wired' : 5,
  42. 'local_wired_backup' : 10,
  43. 'WBBL' : 10,
  44. 'WBBL_backup' : 15,
  45. 'DCI' : 15,
  46. 'VPN_intergw' : 50,
  47. 'VPN_node' : 50,
  48. }
  49. #
  50. # Default interface attributes to be added to GRE interface to AS201701 when
  51. # not already present in pillar interface configuration.
  52. GRE_FFRL_attrs = {
  53. 'mode' : 'gre',
  54. 'method' : 'tunnel',
  55. 'mtu' : '1400',
  56. 'ttl' : '64',
  57. }
  58. # The IPv4/IPv6 prefix used for Loopback IPs
  59. loopback_prefix = {
  60. 'v4' : '10.132.255.',
  61. 'v6' : '2a03:2260:2342:ffff::',
  62. }
  63. # The DNS zone base names used for generating zone files from IP address
  64. # configured on nodes interfaces.
  65. DNS_zone_names = {
  66. 'forward' : 'ffho.net',
  67. 'rev_v4' : [
  68. '132.10.in-addr.arpa',
  69. '30.172.in-addr.arpa',
  70. ],
  71. 'rev_v6' : [
  72. '2.4.3.2.0.6.2.2.3.0.a.2.ip6.arpa',
  73. ]
  74. }
  75. # MTU configuration
  76. MTU = {
  77. # The default MTU for any interface which does not have a MTU configured
  78. # explicitly in the pillar node config or does not get a MTU configured
  79. # by any means of this SDN stuff here.
  80. 'default' : 1500,
  81. # A batman underlay device, probably a VXLAN or VLAN interface.
  82. #
  83. # 1500
  84. # + 60 B.A.T.M.A.N. adv header + network coding (activated by default by Debian)
  85. 'batman_underlay_iface' : 1560,
  86. # VXLAN underlay device, probably a VLAN within $POP or between two BBRs.
  87. #
  88. # 1560
  89. # + 14 Inner Ethernet Frame
  90. # + 8 VXLAN Header
  91. # + 8 UDP Header
  92. # + 20 IPv4 Header
  93. 'vxlan_underlay_iface' : 1610,
  94. }
  95. ################################################################################
  96. # #
  97. # Internal data types and functions #
  98. # #
  99. # Touching anything below will void any warranty you never had ;) #
  100. # #
  101. ################################################################################
  102. ################################################################################
  103. # Data types #
  104. ################################################################################
  105. class Prefix (object):
  106. """An internet address with a prefix length.
  107. The given address is expected to be of format ip/plen in CIDR notation.
  108. The IP as well as the prefix length and address family will be stored
  109. in attributes.
  110. .. code-block:: pycon
  111. >>> a = Prefix ('10.132.23.42/24')
  112. >>> str (a.ip)
  113. '10.132.23.42'
  114. >>> str (a.af)
  115. '4'
  116. >>> str (a.plen)
  117. '24'
  118. >>> str (a.netmask)
  119. '255.255.255.0'
  120. >>> str (a.network_address)
  121. '10.132.23.0'
  122. """
  123. def __init__ (self, prefix):
  124. self.prefix = prefix
  125. self.ip_network = ipaddress.ip_network (u'%s' % prefix, strict = False)
  126. def __eq__ (self, other):
  127. if isinstance (other, Prefix):
  128. return self.ip_network == other.ip_network
  129. return NotImplemented
  130. def __lt__ (self, other):
  131. if isinstance (other, Prefix):
  132. return self.ip_network < other.ip_network
  133. return NotImplemented
  134. def __str__ (self):
  135. return self.prefix
  136. @property
  137. def ip (self):
  138. return self.prefix.split ('/')[0]
  139. @property
  140. def af (self):
  141. return self.ip_network.version
  142. @property
  143. def plen (self):
  144. return self.ip_network.prefixlen
  145. @property
  146. def netmask (self):
  147. return self.ip_network.netmask
  148. @property
  149. def network_address (self):
  150. return self.ip_network.network_address
  151. ################################################################################
  152. # Functions #
  153. ################################################################################
  154. sites = None
  155. def _get_site_no (sites_config, site_name):
  156. global sites
  157. if sites == None:
  158. sites = {}
  159. for site in sites_config:
  160. if site.startswith ("_"):
  161. continue
  162. sites[site] = sites_config[site].get ("site_no", -2)
  163. return sites.get (site_name, -1)
  164. #
  165. # Generate a MAC address after the format f2:dd:dd:ss:nn:nn where
  166. # dd:dd is the hexadecimal reprensentation of the nodes device_id
  167. # ff:ff representing the gluon nodes
  168. #
  169. # ss is the hexadecimal reprensentation of the site_id the interface is connected to
  170. #
  171. # nn:nn is the decimal representation of the network the interface is connected to, with
  172. # 00:00 being the BATMAN interface
  173. # 00:0d being the dummy interface
  174. # 00:0f being the VEth internal side interface
  175. # 00:e0 being an external instance BATMAN interface
  176. # 00:ed being an external instance dummy interface
  177. # 00:e1 being an inter-gw-vpn interface
  178. # 00:e4 being an nodes fastd tunnel interface of IPv4 transport
  179. # 00:e6 being an nodes fastd tunnel interface of IPv6 transport
  180. # 00:ef being an extenral instance VEth interface side
  181. # 02:xx being a connection to local Vlan 2xx
  182. # xx:xx being a VXLAN tunnel for site ss, with xx being the underlay VLAN ID (1xyz, 2xyz)
  183. # ff:ff being the gluon next-node interface
  184. def gen_batman_iface_mac (site_no, device_no, network):
  185. net_type_map = {
  186. 'bat' : "00:00",
  187. 'dummy' : "00:0d",
  188. 'int2ext' : "00:0f",
  189. 'bat-e' : "00:e0",
  190. 'intergw' : "00:e1",
  191. 'nodes4' : "00:e4",
  192. 'nodes6' : "00:e6",
  193. 'dummy-e' : "00:ed",
  194. 'ext2int' : "00:ef",
  195. }
  196. # Well-known network type?
  197. if network in net_type_map:
  198. last = net_type_map[network]
  199. elif type (network) == int:
  200. last = re.sub (r'(\d{2})(\d{2})', '\g<1>:\g<2>', "%04d" % network)
  201. else:
  202. last = "ee:ee"
  203. # Convert device_no to hex, format number to 4 digits with leading zeros and : betwwen 2nd and 3rd digit
  204. device_no_hex = re.sub (r'([0-9a-fA-F]{2})([0-9a-fA-F]{2})', '\g<1>:\g<2>', "%04x" % int (device_no))
  205. # Format site_no to two digit number with leading zero
  206. site_no_hex = "%02d" % int (site_no)
  207. return "%s:%s:%s:%s" % (mac_prefix, device_no_hex, site_no_hex, last)
  208. # Gather B.A.T.M.A.N. related config options for real batman devices (e.g. bat0)
  209. # as well as for batman member interfaces (e.g. eth0.100, fastd ifaces etc.)
  210. def _update_batman_config (node_config, iface, sites_config):
  211. try:
  212. node_batman_hop_penalty = int (node_config['batman']['hop-penalty'])
  213. except (KeyError,ValueError):
  214. node_batman_hop_penalty = None
  215. iface_config = node_config['ifaces'][iface]
  216. iface_type = iface_config.get ('type', 'inet')
  217. batman_config = {}
  218. for item in list (iface_config.keys ()):
  219. value = iface_config.get (item)
  220. if item.startswith ('batman-'):
  221. batman_config[item] = value
  222. iface_config.pop (item)
  223. # B.A.T.M.A.N. device (e.g. bat0)
  224. if iface_type == 'batman':
  225. if 'batman-hop-penalty' not in batman_config:
  226. # If there's a hop penalty set for the node, but not for the interface
  227. # apply the nodes hop penalty
  228. if node_batman_hop_penalty:
  229. batman_config['batman-hop-penalty'] = node_batman_hop_penalty
  230. # If there's no hop penalty set for the node, use a default hop penalty
  231. # for the roles the node might have, if any
  232. else:
  233. node_roles = node_config.get ('roles', [])
  234. for role in batman_role_evaluation_order:
  235. if role in node_roles:
  236. batman_config['batman-hop-penalty'] = default_hop_penalty_by_role[role]
  237. break
  238. if 'batman_ext' in node_roles and iface.endswith('-ext'):
  239. batman_config['batman-hop-penalty'] = default_hop_penalty_by_role['batman_ext']
  240. # If batman ifaces were specified as a list - which they should -
  241. # generate a sorted list of interface names as string representation
  242. if 'batman-ifaces' in batman_config and type (batman_config['batman-ifaces']) == list:
  243. batman_iface_str = " ".join (sorted (batman_config['batman-ifaces']))
  244. batman_config['batman-ifaces'] = batman_iface_str
  245. # B.A.T.M.A.N. member interface (e.g. eth.100, fastd ifaces, etc.)
  246. elif iface_type == 'batman_iface':
  247. # Generate unique MAC address for every batman iface, as B.A.T.M.A.N.
  248. # will get puzzled with multiple interfaces having the same MAC and
  249. # do nasty things.
  250. site = iface_config.get ('site')
  251. site_no = _get_site_no (sites_config, site)
  252. device_no = node_config.get ('id')
  253. network = 1234
  254. # Generate a unique BATMAN-MAC for this interfaces
  255. match = re.search (r'^vlan(\d+)', iface)
  256. if match:
  257. network = int (match.group (1))
  258. iface_config['hwaddress'] = gen_batman_iface_mac (site_no, device_no, network)
  259. iface_config['batman'] = batman_config
  260. # Mangle bond specific config items with default values and store them in
  261. # separate sub-dict for easier access and configuration.
  262. def _update_bond_config (config):
  263. bond_config = default_bond_config.copy ()
  264. to_pop = []
  265. for item, value in config.items ():
  266. if item.startswith ('bond-'):
  267. bond_config[item] = value
  268. to_pop.append (item)
  269. for item in to_pop:
  270. config.pop (item)
  271. if bond_config['bond-mode'] not in ['2', 'balance-xor', '4', '802.3ad']:
  272. bond_config.pop ('bond-xmit-hash-policy')
  273. config['bond'] = bond_config
  274. # Mangle bridge specific config items with default values and store them in
  275. # separate sub-dict for easier access and configuration.
  276. def _update_bridge_config (config):
  277. bridge_config = default_bridge_config.copy ()
  278. for item in list (config.keys ()):
  279. value = config.get (item)
  280. if item.startswith ('bridge-'):
  281. bridge_config[item] = value
  282. config.pop (item)
  283. # Fix and salt mangled string interpretation back to real string.
  284. if type (value) == bool:
  285. bridge_config[item] = "yes" if value else "no"
  286. # If bridge ports were specified as a list - which they should -
  287. # generate a sorted list of interface names as string representation
  288. if 'bridge-ports' in bridge_config and type (bridge_config['bridge-ports']) == list:
  289. bridge_ports_str = " ".join (sorted (bridge_config['bridge-ports']))
  290. bridge_config['bridge-ports'] = bridge_ports_str
  291. config['bridge'] = bridge_config
  292. # Move vlan specific config items into a sub-dict for easier access and pretty-printing
  293. # in the configuration file
  294. def _update_vlan_config (config):
  295. vlan_config = {}
  296. for item in list (config.keys ()):
  297. value = config.get (item)
  298. if item.startswith ('vlan-'):
  299. vlan_config[item] = value
  300. config.pop (item)
  301. config['vlan'] = vlan_config
  302. # Pimp Veth interfaces
  303. # * Add peer interface name IF not present
  304. # * Add link-type veth IF not present
  305. def _update_veth_config (interface, config):
  306. veth_peer_name = {
  307. 'veth_ext2int' : 'veth_int2ext',
  308. 'veth_int2ext' : 'veth_ext2int'
  309. }
  310. if interface not in veth_peer_name:
  311. return
  312. if 'link-type' not in config:
  313. config['link-type'] = 'veth'
  314. if 'veth-peer-name' not in config:
  315. config['veth-peer-name'] = veth_peer_name[interface]
  316. # The given MTU to the given interface - presented by it's interface config dict -
  317. # IFF no MTU has already been set in the node pillar.
  318. #
  319. # @param ifaces: All interface configuration (as dict)
  320. # @param iface_name: Name of the interface to set MTU for
  321. # @param mtu: The MTU value to set (integer)
  322. # When <mtu> is <= 0, the <mtu> configured for <iface_name>
  323. # will be used to set the MTU of the upper interface, and the
  324. # default MTU if none is configured explicitly.
  325. def _set_mtu_to_iface_and_upper (ifaces, iface_name, mtu):
  326. iface_config = ifaces.get (iface_name)
  327. # By default we assume that we should set the given MTU value as the 'automtu'
  328. # attribute to allow distinction between manually set and autogenerated MTU
  329. # values.
  330. set_automtu = True
  331. # If a mtu values <= 0 is given, use the MTU configured for this interface
  332. # or, if none is set, the default value when configuring the vlan-raw-device.
  333. if mtu <= 0:
  334. set_automtu = False
  335. mtu = iface_config.get ('mtu', MTU['default'])
  336. # If this interface already has a MTU set - probably because someone manually
  337. # specified one in the node pillar - we do not touch the MTU of this interface.
  338. # Nevertheless it's worth looking at any underlying interface.
  339. if 'mtu' in iface_config:
  340. set_automtu = False
  341. # There might be - read: "we have" - a situation where on top of e.g. bond0
  342. # there are vlans holding VXLAN communicaton as well as VLANs directly carrying
  343. # BATMAN traffic. Now depending on which interface is evaluated first, the upper
  344. # MTU is either correct, or maybe to small.
  345. #
  346. # If any former autogenerated MTU is greater-or-equal than the one we want to
  347. # set now, we'll ignore it, and go for the greater one.
  348. elif 'automtu' in iface_config and iface_config['automtu'] >= mtu:
  349. set_automtu = False
  350. # If we still consider this a good move, set given MTU to this device.
  351. if set_automtu:
  352. iface_config['automtu'] = mtu
  353. # If this is a VLAN - which it probably is - fix the MTU of the underlying interface, too.
  354. # Check for 'vlan-raw-device' in iface_config and in vlan subconfig (yeah, that's not ideal).
  355. vlan_raw_device = None
  356. if 'vlan-raw-device' in iface_config:
  357. vlan_raw_device = iface_config['vlan-raw-device']
  358. elif 'vlan' in iface_config and 'vlan-raw-device' in iface_config['vlan']:
  359. vlan_raw_device = iface_config['vlan']['vlan-raw-device']
  360. if vlan_raw_device:
  361. vlan_raw_device_config = ifaces.get (vlan_raw_device, None)
  362. # vlan-raw-device might point to ethX which usually isn't configured explicitly
  363. # as ifupdown2 simply will bring it up anyway by itself. To set the MTU of such
  364. # an interface we have to add a configuration stanza for it here.
  365. if vlan_raw_device_config == None:
  366. vlan_raw_device_config = {}
  367. ifaces[vlan_raw_device] = vlan_raw_device_config
  368. # If there is a manually set MTU for this device, we don't do nothin'
  369. if 'mtu' in vlan_raw_device_config:
  370. return
  371. if 'automtu' in vlan_raw_device_config and vlan_raw_device_config['automtu'] >= mtu:
  372. return
  373. vlan_raw_device_config['automtu'] = mtu
  374. #
  375. #
  376. #
  377. def _get_batman_iface_penalty (iface):
  378. if iface.startswith ('vlan'):
  379. vid = int (re.sub ('vlan', '', iface))
  380. if 1000 <= vid < 1100:
  381. return default_batman_iface_penalty_by_role.get ('local_wired')
  382. if 1400 <= vid < 1500:
  383. return default_batman_iface_penalty_by_role.get ('DCI')
  384. if 2000 <= vid < 2100:
  385. return default_batman_iface_penalty_by_role.get ('WBBL')
  386. if 2200 <= vid < 2300:
  387. return default_batman_iface_penalty_by_role.get ('WBBL_backup')
  388. if 'intergw' in iface:
  389. return default_batman_iface_penalty_by_role.get ('VPN_intergw')
  390. if 'nodes' in iface:
  391. return default_batman_iface_penalty_by_role.get ('VPN_node')
  392. return None
  393. # Generate configuration entries for any batman related interfaces not
  394. # configured explicitly, but asked for implicitly by role batman and a
  395. # (list of) site(s) specified in the node config.
  396. def _generate_batman_interface_config (node_config, ifaces, sites_config):
  397. # No role 'batman', nothing to do
  398. roles = node_config.get ('roles', [])
  399. if 'batman' not in roles:
  400. return
  401. # Should there be a 2nd external BATMAN instance?
  402. batman_ext = 'batman_ext' in roles or 'bras' in roles
  403. device_no = node_config.get ('id', -1)
  404. for site in node_config.get ('sites', []):
  405. site_no = _get_site_no (sites_config, site)
  406. # Predefine interface names for regular/external BATMAN instance
  407. # and possible VEth link pair for connecting both instances.
  408. bat_site_if = "bat-%s" % site
  409. dummy_site_if = "dummy-%s" % site
  410. bat_site_if_ext = "bat-%s-ext" % site
  411. dummy_site_if_ext = "dummy-%s-e" % site
  412. int2ext_site_if = "i2e-%s" % site
  413. ext2int_site_if = "e2i-%s" % site
  414. site_ifaces = {
  415. # Regular BATMAN interface, always present
  416. bat_site_if : {
  417. 'type' : 'batman',
  418. # int2ext_site_if will be added automagically if requred
  419. 'batman-ifaces' : [ dummy_site_if ],
  420. 'batman-ifaces-ignore-regex': '.*_.*',
  421. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'bat'),
  422. },
  423. # Dummy interface always present in regular BATMAN instance
  424. dummy_site_if : {
  425. 'link-type' : 'dummy',
  426. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'dummy'),
  427. 'mtu' : MTU['batman_underlay_iface'],
  428. },
  429. # Optional 2nd "external" BATMAN instance
  430. bat_site_if_ext : {
  431. 'type' : 'batman',
  432. 'batman-ifaces' : [ dummy_site_if_ext, ext2int_site_if ],
  433. 'batman-ifaces-ignore-regex': '.*_.*',
  434. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'bat-e'),
  435. 'ext_only' : True,
  436. },
  437. # Optional dummy interface always present in 2nd "external" BATMAN instance
  438. dummy_site_if_ext : {
  439. 'link-type' : 'dummy',
  440. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'dummy-e'),
  441. 'ext_only' : True,
  442. 'mtu' : MTU['batman_underlay_iface'],
  443. },
  444. # Optional VEth interface pair - internal side
  445. int2ext_site_if : {
  446. 'link-type' : 'veth',
  447. 'veth-peer-name' : ext2int_site_if,
  448. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'int2ext'),
  449. 'mtu' : MTU['batman_underlay_iface'],
  450. 'ext_only' : True,
  451. },
  452. # Optional VEth interface pair - "external" side
  453. ext2int_site_if : {
  454. 'link-type' : 'veth',
  455. 'veth-peer-name' : int2ext_site_if,
  456. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, 'ext2int'),
  457. 'mtu' : MTU['batman_underlay_iface'],
  458. 'ext_only' : True,
  459. },
  460. }
  461. for iface, iface_config_tmpl in site_ifaces.items ():
  462. # Ignore any interface only relevant when role batman_ext is set
  463. # but it isn't
  464. if not batman_ext and iface_config_tmpl.get ('ext_only', False):
  465. continue
  466. # Remove ext_only key so we don't leak it into ifaces dict
  467. if 'ext_only' in iface_config_tmpl:
  468. del iface_config_tmpl['ext_only']
  469. # If there is no trace of the desired iface config yet...
  470. if iface not in ifaces:
  471. # ... just place our template there.
  472. ifaces[iface] = iface_config_tmpl
  473. # If there should be an 2nd external BATMAN instance make sure
  474. # the internal side of the VEth iface pair is connected to the
  475. # internal BATMAN instance.
  476. if batman_ext and iface == bat_site_if:
  477. iface_config_tmpl['batman-ifaces'].append (int2ext_site_if)
  478. # If there already is an interface configuration try to enhance it with
  479. # meaningful values from our template and force correct hwaddress to be
  480. # used.
  481. else:
  482. iface_config = ifaces[iface]
  483. # Force hwaddress to be what we expect.
  484. if 'hwaddress' in iface_config_tmpl:
  485. iface_config['hwaddress'] = iface_config_tmpl['hwaddress']
  486. # Copy every attribute of the config template missing in iface config
  487. for attr in iface_config_tmpl:
  488. if attr not in iface_config:
  489. iface_config[attr] = iface_config_tmpl[attr]
  490. # Configure bat_site_if to be part of br-<site>, if present
  491. site_bridge = "br-%s" % site
  492. if site_bridge in ifaces:
  493. bridge_config = ifaces.get (site_bridge)
  494. bridge_ports = bridge_config.get ('bridge-ports', None)
  495. # There are bridge-ports configured already, but bat_site_if is not present
  496. if bridge_ports and bat_site_if not in bridge_ports:
  497. if type (bridge_ports) == list:
  498. bridge_ports.append (bat_site_if)
  499. else:
  500. bridge_config['bridge-ports'] += ' ' + bat_site_if
  501. # There are no bridge-ports configured
  502. if not bridge_ports:
  503. bridge_config['bridge-ports'] = bat_site_if
  504. # Make sure there is a bridge present for every site where a mesh_breakout
  505. # interface should be configured.
  506. for iface in list (ifaces.keys ()):
  507. config = ifaces.get (iface)
  508. iface_type = config.get ('type', 'inet')
  509. if iface_type not in ['mesh_breakout', 'batman_iface']:
  510. continue
  511. site = config.get ('site')
  512. site_bridge = "br-%s" % site
  513. batman_site_if = "bat-%s" % site
  514. if iface_type == 'mesh_breakout':
  515. # If the bridge has already been defined (with an IP maybe) make
  516. # sure that the corresbonding batman device is part of the bridge-
  517. # ports.
  518. if site_bridge in ifaces:
  519. bridge_config = ifaces.get (site_bridge)
  520. # If there already is/are (a) bridge-port(s) defined, add
  521. # the batman and the breakout interfaces if not present...
  522. bridge_ports = bridge_config.get ('bridge-ports', None)
  523. if bridge_ports:
  524. for dev in (batman_site_if, iface):
  525. if not dev in bridge_ports:
  526. if type (bridge_ports) == list:
  527. bridge_ports.append (dev)
  528. else:
  529. bridge_config['bridge-ports'] += ' ' + dev
  530. # ...if there is no bridge-port defined yet, just used
  531. # the batman and breakout iface.
  532. else:
  533. bridge_config['bridge-ports'] = [ iface, batman_site_if ]
  534. # If the bridge isn't present alltogether, add it.
  535. else:
  536. ifaces[site_bridge] = {
  537. 'bridge-ports' : [ iface, batman_site_if ],
  538. }
  539. elif iface_type == 'batman_iface':
  540. batman_ifaces = ifaces[batman_site_if]['batman-ifaces']
  541. if iface not in batman_ifaces:
  542. if type (batman_ifaces) == list:
  543. batman_ifaces.append (iface)
  544. else:
  545. batman_ifaces += ' ' + iface
  546. # Use the MTU configured for this interface or, if none is set,
  547. # the default value for batman underlay iface.
  548. mtu = config.get('mtu', MTU['batman_underlay_iface'])
  549. _set_mtu_to_iface_and_upper (ifaces, iface, mtu)
  550. #
  551. # Generate any implicitly defined VXLAN interfaces defined in the nodes iface
  552. # defined in pillar.
  553. # The keyword "batman_connect_sites" on an interface will trigger the
  554. # generation of a VXLAN overlay interfaces.
  555. def _generate_vxlan_interface_config (node_config, ifaces, sites_config):
  556. # No role 'batman', nothing to do
  557. if 'batman' not in node_config.get ('roles', []):
  558. return
  559. # Sites configured on this node. Nothing to do, if none.
  560. my_sites = node_config.get ('sites', [])
  561. if len (my_sites) == 0:
  562. return
  563. # As we're still here we can now safely assume that a B.A.T.M.A.N.
  564. # device has been configured for every site specified in sites list.
  565. device_no = node_config.get ('id', -1)
  566. for iface in list (ifaces.keys ()):
  567. iface_config = ifaces.get (iface)
  568. batman_connect_sites = iface_config.get ('batman_connect_sites', [])
  569. iface_has_prefixes = len (iface_config.get ('prefixes', {})) != 0
  570. # If we got a string, convert it to a list with a single element
  571. if type (batman_connect_sites) == str:
  572. batman_connect_sites = [ batman_connect_sites ]
  573. # If the list of sites to connect is empty, there's nothing to do here.
  574. if len (batman_connect_sites) == 0:
  575. continue
  576. # Set the MTU of this (probably) VLAN device to the MTU required for a VXLAN underlay
  577. # device, where B.A.T.M.A.N. adv. is to be expected within the VXLAN overlay.
  578. _set_mtu_to_iface_and_upper (ifaces, iface, MTU['vxlan_underlay_iface'])
  579. # If the string 'all' is part of the list, blindly use all sites configured for this node
  580. if 'all' in batman_connect_sites:
  581. batman_connect_sites = my_sites
  582. for site in batman_connect_sites:
  583. # Silenty ignore sites not configured on this node
  584. if site not in my_sites:
  585. continue
  586. # iface_name := vx_<last 5 chars of underlay iface>_<site> stripped to 15 chars
  587. vx_iface = ("vx_%s_%s" % (re.sub ('vlan', 'v', iface)[-5:], re.sub (r'[_-]', '', site)))[:15]
  588. site_no = _get_site_no (sites_config, site)
  589. bat_iface = "bat-%s" % site
  590. # If there's no batman interface for this site, there's no point
  591. # in setting up a VXLAN interfaces
  592. if bat_iface not in ifaces:
  593. continue
  594. # bail out if VXLAN tunnel already configured
  595. if vx_iface in ifaces:
  596. continue
  597. try:
  598. iface_id = int (re.sub ('vlan', '', iface))
  599. # Gather interface specific mcast address.
  600. # The address is derived from the vlan-id of the underlying interface,
  601. # assuming that it in fact is a vlan interface.
  602. # Mangle the vlan-id into two 2 digit values, eliminating any leading zeros.
  603. iface_id_4digit = "%04d" % iface_id
  604. octet2 = int (iface_id_4digit[0:2])
  605. octet3 = int (iface_id_4digit[2:4])
  606. vni = octet2 * 256 * 256 + octet3 * 256 + site_no
  607. vtep_config = {
  608. 'vxlan-id' : vni,
  609. 'vxlan-physdev' : iface,
  610. }
  611. # If there are prefixes configured on this underlay interface go for legacy IPv4 Multicast (for now)
  612. if iface_has_prefixes:
  613. vtep_config['vxlan-svcnodeip'] = "225.%s.%s.%s" % (octet2, octet3, site_no)
  614. else:
  615. vtep_config['vxlan-remote-group'] = "ff42:%s::%s" % (iface_id, site_no)
  616. except ValueError as v:
  617. vtep_config = {
  618. 'vxlan-config-error' : str (v),
  619. }
  620. iface_id = 9999
  621. mcast_ip = "225.0.0.%s" % site_no
  622. vni = site_no
  623. # Add the VXLAN interface
  624. ifaces[vx_iface] = {
  625. 'vxlan' : vtep_config,
  626. 'hwaddress' : gen_batman_iface_mac (site_no, device_no, iface_id),
  627. 'mtu' : MTU['batman_underlay_iface'],
  628. }
  629. iface_penalty = _get_batman_iface_penalty (iface)
  630. if iface_penalty:
  631. ifaces[vx_iface]['batman'] = {
  632. 'batman-hop-penalty' : iface_penalty
  633. }
  634. # If the batman interface for this site doesn't have any interfaces
  635. # set up - which basicly cannot happen - add this VXLAN tunnel as
  636. # the first in the list.
  637. if not 'batman-ifaces' in ifaces[bat_iface]:
  638. ifaces[bat_iface]['batman-ifaces'] = [ vx_iface ]
  639. continue
  640. # In the hope there already are interfaces for batman set up already
  641. # add this VXLAN tunnel to the list
  642. batman_ifaces = ifaces[bat_iface]['batman-ifaces']
  643. if vx_iface not in batman_ifaces:
  644. if type (batman_ifaces) == list:
  645. batman_ifaces.append (vx_iface)
  646. else:
  647. batman_ifaces += ' ' + vx_iface
  648. #
  649. # Generate implicitly defined VRFs according to the vrf_info dict at the top
  650. # of this file
  651. def _generate_vrfs (ifaces):
  652. for iface in list (ifaces.keys ()):
  653. iface_config = ifaces.get (iface)
  654. vrf = iface_config.get ('vrf', None)
  655. if vrf and vrf not in ifaces:
  656. conf = vrf_info.get (vrf, {})
  657. table = conf.get ('table', 1234)
  658. fwmark = conf.get ('fwmark', None)
  659. ifaces[vrf] = {
  660. 'vrf-table' : table,
  661. }
  662. # Create ip rule's for any fwmarks defined
  663. if fwmark:
  664. up = []
  665. # Make sure we are dealing with a list even if there is only one mark to be set up
  666. if type (fwmark) in (str, int):
  667. fwmark = [ fwmark ]
  668. # Create ip rule entries for IPv4 and IPv6 for every fwmark
  669. for mark in fwmark:
  670. up.append ("ip rule add fwmark %s table %s" % (mark, table))
  671. up.append ("ip -6 rule add fwmark %s table %s" % (mark, table))
  672. ifaces[vrf]['up'] = up
  673. def _generate_ffrl_gre_tunnels (ifaces):
  674. for iface, iface_config in ifaces.items ():
  675. # We only care for GRE_FFRL type interfaces
  676. if iface_config.get ('type', '') != 'GRE_FFRL':
  677. continue
  678. # Copy default values to interface config
  679. for attr, val in GRE_FFRL_attrs.items ():
  680. if not attr in iface_config:
  681. iface_config[attr] = val
  682. # Guesstimate local IPv4 tunnel endpoint address from tunnel-physdev
  683. if not 'local' in iface_config and 'tunnel-physdev' in iface_config:
  684. try:
  685. physdev_prefixes = [p.split ('/')[0] for p in ifaces[iface_config['tunnel-physdev']]['prefixes'] if '.' in p]
  686. if len (physdev_prefixes) == 1:
  687. iface_config['local'] = physdev_prefixes[0]
  688. except KeyError:
  689. pass
  690. def _generate_loopback_ips (ifaces, node_config, node_id):
  691. # If this node has primary_ips set and filled there are either IPs
  692. # configured on lo or IPs on another interface - possibly ones on
  693. # the only interface present - are considered as primary IPs.
  694. if node_config.get ('primary_ips', False):
  695. return
  696. v4_ip = "%s/32" % get_primary_ip (node_config, 'v4').ip
  697. v6_ip = "%s/128" % get_primary_ip (node_config, 'v6').ip
  698. # Interface lo already present?
  699. if 'lo' not in ifaces:
  700. ifaces['lo'] = { 'prefixes' : [] }
  701. # Add 'prefixes' list if not present
  702. if 'prefixes' not in ifaces['lo']:
  703. ifaces['lo']['prefixes'] = []
  704. prefixes = ifaces['lo']['prefixes']
  705. if v4_ip not in prefixes:
  706. prefixes.append (v4_ip)
  707. if v6_ip not in prefixes:
  708. prefixes.append (v6_ip)
  709. # Generate interface descriptions / aliases for auto generated or manually
  710. # created interfaces. Currently this only is done for bridges associated
  711. # with BATMAN instanzes.
  712. #
  713. # @param node_config: The configuration of the given node (as dict)
  714. # @param sites_config Global sites configuration (as dict)
  715. def _update_interface_desc (node_config, sites_config):
  716. # Currently we only care for nodes with batman role.
  717. if 'batman' not in node_config.get ('roles', []):
  718. return
  719. for iface, iface_config in node_config.get ('ifaces', {}).items ():
  720. if 'desc' in sites_config:
  721. continue
  722. # If the interface name looks like a bridge for a BATMAN instance
  723. # try to get the name of the corresponding site
  724. match = re.search (r'^br-([a-z_-]+)$', iface)
  725. if match and match.group (1) in sites_config:
  726. try:
  727. iface_config['desc'] = sites_config[match.group (1)]['name']
  728. except KeyError:
  729. pass
  730. ################################################################################
  731. # Public functions #
  732. ################################################################################
  733. # Generate network interface configuration for given node.
  734. #
  735. # This function will read the network configuration from pillar and will
  736. # * enhance it with all default values configured at the top this file
  737. # * auto generate any implicitly configured
  738. # * VRFs
  739. # * B.A.T.M.A.N. instances and interfaces
  740. # * VXLAN interfaces to connect B.A.T.M.A.N. sites
  741. # * Loopback IPs derived from numeric node ID
  742. #
  743. # @param: node_config Pillar node configuration (as dict)
  744. # @param: sites_config Pillar sites configuration (as dict)
  745. # @param: node_id Minion name / Pillar node configuration key
  746. def get_interface_config (node_config, sites_config, node_id = ""):
  747. # Make a copy of the node_config dictionary to suppress side-effects.
  748. # This function deletes some keys from the node_config which will break
  749. # any re-run of this function or other functions relying on the node_config
  750. # to be complete.
  751. node_config = deepcopy (node_config)
  752. # Get config of this node and dict of all configured ifaces
  753. ifaces = node_config.get ('ifaces', {})
  754. # Generate configuration entries for any batman related interfaces not
  755. # configured explicitly, but asked for implicitly by role <batman> and
  756. # a (list of) site(s) specified in the node config.
  757. _generate_batman_interface_config (node_config, ifaces, sites_config)
  758. # Generate VXLAN tunnels for every interfaces specifying 'batman_connect_sites'
  759. _generate_vxlan_interface_config (node_config, ifaces, sites_config)
  760. # Enhance ifaces configuration with some meaningful defaults for
  761. # bonding, bridge and vlan interfaces, MAC address for batman ifaces, etc.
  762. for interface in list (ifaces.keys ()):
  763. config = ifaces.get (interface)
  764. iface_type = config.get ('type', 'inet')
  765. # Remove any disable interfaces here as they aren't relevant for /e/n/i
  766. if config.get ('enabled', True) == False:
  767. del ifaces[interface]
  768. continue
  769. if 'batman-ifaces' in config or iface_type.startswith ('batman'):
  770. _update_batman_config (node_config, interface, sites_config)
  771. if 'bond-slaves' in config:
  772. _update_bond_config (config)
  773. # FIXME: This maybe will not match on bridges without any member ports configured!
  774. if 'bridge-ports' in config or interface.startswith ('br-'):
  775. _update_bridge_config (config)
  776. if 'vlan-raw-device' in config or 'vlan-id' in config:
  777. _update_vlan_config (config)
  778. _set_mtu_to_iface_and_upper (ifaces, interface, 0)
  779. # Pimp configuration for VEth link pairs
  780. if interface.startswith ('veth_'):
  781. _update_veth_config (interface, config)
  782. # Auto generate Loopback IPs IFF not present
  783. _generate_loopback_ips (ifaces, node_config, node_id)
  784. # Auto generated VRF devices for any VRF found in ifaces and not already configured.
  785. _generate_vrfs (ifaces)
  786. # Pimp GRE_FFRL type inteface configuration with default values
  787. _generate_ffrl_gre_tunnels (ifaces)
  788. # Drop any config parameters used in node interface configuration not
  789. # relevant anymore for config file generation.
  790. for interface, config in ifaces.items ():
  791. # Set default MTU if not already set manually or by any earlier function
  792. if interface != 'lo' and ('mtu' not in config):
  793. # Set the MTU value of this interface to the autogenerated value (if any)
  794. # or set the default, when no automtu is present.
  795. config['mtu'] = config.get ('automtu', MTU['default'])
  796. for key in [ 'automtu', 'enabled', 'batman_connect_sites', 'has_gateway', 'ospf', 'site', 'type', 'tagged_vlans' ]:
  797. if key in config:
  798. config.pop (key)
  799. # Remove route metric on non-router nodes
  800. if 'metric' in config and not 'router' in node_config.get ('roles', []):
  801. config.pop ('metric')
  802. # This leaves 'auto', 'prefixes' and 'desc' as keys which should not be directly
  803. # printed into the remaining configuration. These are handled within the jinja
  804. # interface template.
  805. # Generate meaningful interface descriptions / aliases where useful
  806. _update_interface_desc (node_config, sites_config)
  807. return ifaces
  808. vlan_vxlan_iface_re = re.compile (r'^vlan(\d+)|^vx_v(\d+)_(\w+)')
  809. def _cmp (x, y):
  810. if x < y:
  811. return -1
  812. elif x == y:
  813. return 0
  814. else:
  815. return 1
  816. def _iface_sort (iface_a, iface_b):
  817. a = vlan_vxlan_iface_re.search (iface_a)
  818. b = vlan_vxlan_iface_re.search (iface_b)
  819. # At least one interface didn't match, do regular comparison
  820. if not a or not b:
  821. return _cmp (iface_a, iface_b)
  822. # Extract VLAN ID from VLAN interface (if given) or VXLAN
  823. vid_a = a.group (1) if a.group (1) else a.group (2)
  824. vid_b = b.group (1) if b.group (1) else b.group (2)
  825. # If it's different type of interfaces (one VLAN, one VXLAN), do regular comparison
  826. if (a.group (1) == None) != (b.group (1) == None):
  827. return _cmp (iface_a, iface_b)
  828. # Ok, t's two VLAN or two VXLAN interfaces
  829. # If it's VXLAN interfaces and the VLAN ID is the same, sort by site name
  830. if a.group (2) and vid_a == vid_b:
  831. return _cmp (a.groups (2), b.groups (2))
  832. # If it's two VLANs or two VXLANs with different VLAN IDs, sort by VLAN ID
  833. else:
  834. return _cmp (int (vid_a), int (vid_b))
  835. def get_interface_list (ifaces):
  836. iface_list = []
  837. for iface in sorted (ifaces.keys (), key = cmp_to_key (_iface_sort)):
  838. iface_list.append (iface)
  839. return iface_list
  840. # Generate entries for /etc/bat-hosts for every batman interface we will configure on any node.
  841. # For readability purposes superflous/redundant information is being stripped/supressed.
  842. # As these names will only show up in batctl calls with a specific site, site_names in interfaces
  843. # are stripped. Dummy interfaces are stripped as well.
  844. def gen_bat_hosts (nodes_config, sites_config):
  845. bat_hosts = {}
  846. for node_id in sorted (nodes_config.keys ()):
  847. node_config = nodes_config.get (node_id)
  848. node_name = node_id.split ('.')[0]
  849. if 'batman' not in node_config['roles']:
  850. continue
  851. ifaces = get_interface_config (node_config, sites_config, node_id)
  852. for iface in sorted (ifaces):
  853. iface_config = ifaces.get (iface)
  854. hwaddress = iface_config.get ('hwaddress', None)
  855. if hwaddress == None:
  856. continue
  857. entry_name = node_name
  858. match = re.search (r'^dummy-(.+)(-e)?$', iface)
  859. if match:
  860. if match.group (2):
  861. entry_name += "-e"
  862. # Append site to make name unique
  863. entry_name += "/%s" % match.group (1)
  864. else:
  865. entry_name += "/%s" % re.sub (r'^(vx_.*|i2e|e2i)[_-](.*)$', '\g<1>/\g<2>', iface)
  866. bat_hosts[hwaddress] = entry_name
  867. if 'fastd' in node_config.get ('roles', []):
  868. device_no = node_config.get ('id')
  869. for site in node_config.get ('sites', []):
  870. site_no = _get_site_no (sites_config, site)
  871. for network in ('intergw', 'nodes4', 'nodes6'):
  872. hwaddress = gen_batman_iface_mac (site_no, device_no, network)
  873. bat_hosts[hwaddress] = "%s/%s/%s" % (node_name, network, site)
  874. return bat_hosts
  875. # Generate eBGP session parameters for FFRL Transit from nodes pillar information.
  876. def get_ffrl_bgp_config (ifaces, proto):
  877. _generate_ffrl_gre_tunnels (ifaces)
  878. sessions = {}
  879. for iface in sorted (ifaces):
  880. # We only care for GRE tunnels to the FFRL Backbone
  881. if not iface.startswith ('gre_ffrl_'):
  882. continue
  883. iface_config = ifaces.get (iface)
  884. # Search for IPv4/IPv6 prefix as defined by proto parameter
  885. local = None
  886. neighbor = None
  887. for prefix in iface_config.get ('prefixes', []):
  888. if (proto == 'v4' and '.' in prefix) or (proto == 'v6' and ':' in prefix):
  889. local = prefix.split ('/')[0]
  890. # Calculate neighbor IP as <local IP> - 1
  891. neighbor = str (ipaddress.ip_address (u'%s' % local) - 1)
  892. break
  893. # Strip gre_ prefix iface name and use it as identifier for the eBGP session.
  894. name = re.sub ('gre_ffrl_', 'ffrl_', iface)
  895. sessions[name] = {
  896. 'local' : local,
  897. 'neighbor' : neighbor,
  898. 'bgp_local_pref' : iface_config.get ('bgp_local_pref', None),
  899. }
  900. return sessions
  901. # Get list of IP address configured on given interface on given node.
  902. #
  903. # @param: node_config Pillar node configuration (as dict)
  904. # @param: iface_name Name of the interface defined in pillar node config
  905. # OR name of VRF ("vrf_<something>") whichs ifaces are
  906. # to be examined.
  907. # @param: with_mask Don't strip the netmask from the prefix. (Default false)
  908. def get_node_iface_ips (node_config, iface_name, with_mask = False):
  909. ips = {
  910. 'v4' : [],
  911. 'v6' : [],
  912. }
  913. ifaces = node_config.get ('ifaces', {})
  914. ifaces_names = [ iface_name ]
  915. if iface_name.startswith ('vrf_'):
  916. # Reset list of ifaces_names to consider
  917. ifaces_names = []
  918. vrf = iface_name
  919. for iface, iface_config in ifaces.items ():
  920. # Ignore any iface NOT in the given VRF
  921. if iface_config.get ('vrf', None) != vrf:
  922. continue
  923. # Ignore any VEth pairs
  924. if iface.startswith ('veth'):
  925. continue
  926. ifaces_names.append (iface)
  927. try:
  928. for iface in ifaces_names:
  929. for prefix in ifaces[iface]['prefixes']:
  930. ip_ver = 'v6' if ':' in prefix else 'v4'
  931. if not with_mask:
  932. prefix = prefix.split ('/')[0]
  933. ips[ip_ver].append (prefix)
  934. except KeyError:
  935. pass
  936. return ips
  937. #
  938. # Get the primary IP(s) of the given node
  939. #
  940. # @param node_config: Pillar node configuration (as dict)
  941. # @param af: Address family
  942. def get_primary_ip (node_config, af):
  943. # Compatility glue
  944. if 'primary_ips' not in node_config:
  945. return Prefix ("%s%s" % (loopback_prefix[af], node_config['id']))
  946. return Prefix (node_config['primary_ips'][af])
  947. #
  948. # Get the router id (read: IPv4 Lo-IP) out of the given node config.
  949. def get_router_id (node_config, node_id):
  950. return get_primary_ip (node_config, 'v4').ip
  951. # Compute minions OSPF interface configuration according to FFHO routing policy
  952. # See https://wiki.ffho.net/infrastruktur:vlans for information about Vlans
  953. #
  954. # Costs are based on the following reference values:
  955. #
  956. # Iface speed | Cost
  957. # ------------+---------
  958. # 100 Gbit/s | 1
  959. # 40 Gbit/s | 2
  960. # 25 Gbit/s | 4
  961. # 20 Gbit/s | 5
  962. # 10 Gbit/s | 10
  963. # 1 Gbit/s | 100
  964. # 100 Mbit/s | 1000
  965. # VPN | 10000
  966. #
  967. def get_ospf_interface_config (node_config, grains_id):
  968. ospf_node_config = node_config.get ('ospf', {})
  969. ospf_interfaces = {}
  970. for iface, iface_config in node_config.get ('ifaces', {}).items ():
  971. # By default we don't speak OSPF on interfaces
  972. ospf_on = False
  973. # Defaults for OSPF interfaces
  974. ospf_config = {
  975. 'stub' : True, # Active/Passive interface
  976. 'cost' : 12345,
  977. # 'type' # Area type
  978. }
  979. # OSPF configuration for interface present?
  980. ospf_config_pillar = iface_config.get ('ospf', {})
  981. # Should be completely ignore this interface?
  982. if ospf_config_pillar.get ('ignore', False):
  983. continue
  984. # Ignore interfaces without any IPs configured
  985. if not iface_config.get ('prefixes'):
  986. continue
  987. # Wireless Local Links (WLL)
  988. if re.search (r'^vlan90\d$', iface):
  989. ospf_on = True
  990. ospf_config['stub'] = True
  991. ospf_config['cost'] = 10
  992. ospf_config['desc'] = "Wireless Local Link (WLL)"
  993. # Local Gigabit Ethernet based connections (PTP or L2 subnets), cost 10
  994. elif re.search (r'^(br-?|br\d+\.|vlan)10\d\d$', iface):
  995. ospf_on = True
  996. ospf_config['stub'] = False
  997. ospf_config['cost'] = 100
  998. ospf_config['desc'] = "Wired Gigabit connection"
  999. # 10/20 Gbit/s Dark Fiber connection
  1000. elif re.search (r'^vlan12\d\d$', iface):
  1001. ospf_on = True
  1002. ospf_config['stub'] = False
  1003. ospf_config['cost'] = 10
  1004. ospf_config['desc'] = "Wired 10Gb/s connection"
  1005. # VLL connection
  1006. elif re.search (r'^vlan15\d\d$', iface):
  1007. ospf_on = True
  1008. ospf_config['stub'] = False
  1009. ospf_config['cost'] = 200
  1010. ospf_config['desc'] = "VLL connection"
  1011. # WBBL connection
  1012. elif re.search (r'^vlan20\d\d$', iface):
  1013. ospf_on = True
  1014. ospf_config['stub'] = False
  1015. ospf_config['cost'] = 1000
  1016. ospf_config['desc'] = "WBBL connection"
  1017. # Legacy WBBL connection
  1018. elif re.search (r'^vlan22\d\d$', iface):
  1019. ospf_on = True
  1020. ospf_config['stub'] = False
  1021. ospf_config['cost'] = 1000
  1022. ospf_config['desc'] = "WBBL connection"
  1023. # Management Vlans
  1024. elif re.search (r'^vlan30\d\d$', iface):
  1025. ospf_on = True
  1026. ospf_config['stub'] = True
  1027. ospf_config['cost'] = 10
  1028. # OPS Vlans
  1029. elif re.search (r'^vlan39\d\d$', iface):
  1030. ospf_on = True
  1031. ospf_config['stub'] = True
  1032. ospf_config['cost'] = 10
  1033. # Active OSPF on OpenVPN tunnels, cost 10000
  1034. elif iface.startswith ('ovpn-'):
  1035. ospf_on = True
  1036. ospf_config['stub'] = False
  1037. ospf_config['cost'] = 10000
  1038. # Inter-Core links should have cost 5000
  1039. if iface.startswith ('ovpn-cr') and grains_id.startswith ('cr'):
  1040. ospf_config['cost'] = 5000
  1041. # OpenVPN tunnels to EdgeRouters
  1042. elif iface.startswith ('ovpn-er-'):
  1043. ospf_config['type'] = 'broadcast'
  1044. # Active OSPF on Wireguard tunnels, cost 10000
  1045. elif iface.startswith ('wg-'):
  1046. ospf_on = True
  1047. ospf_config['stub'] = False
  1048. ospf_config['cost'] = 10000
  1049. # Inter-Core links should have cost 5000
  1050. if iface.startswith ('wg-cr') and grains_id.startswith ('cr'):
  1051. ospf_config['cost'] = 5000
  1052. # OSPF explicitly enabled for interface
  1053. elif 'ospf' in iface_config:
  1054. ospf_on = True
  1055. # iface ospf parameters will be applied later
  1056. # Go on if OSPF should not be actived
  1057. if not ospf_on:
  1058. continue
  1059. # Explicit OSPF interface configuration parameters take precendence over generated ones
  1060. for attr, val in ospf_config_pillar.items ():
  1061. ospf_config[attr] = val
  1062. # Store interface configuration
  1063. ospf_interfaces[iface] = ospf_config
  1064. return ospf_interfaces
  1065. # Return (possibly empty) subset of Traffic Engineering entries from 'te' pillar entry
  1066. # relevenant for this minion and protocol (IPv4 / IPv6)
  1067. def get_te_prefixes (te_node_config, grains_id, proto):
  1068. te_config = {}
  1069. for prefix, prefix_config in te_node_config.get ('prefixes', {}).items ():
  1070. prefix_proto = 'v6' if ':' in prefix else 'v4'
  1071. # Should this TE policy be applied on this node and is the prefix
  1072. # of the proto we are looking for?
  1073. if grains_id in prefix_config.get ('nodes', []) and prefix_proto == proto:
  1074. te_config[prefix] = prefix_config
  1075. return te_config
  1076. def generate_DNS_entries (nodes_config, sites_config):
  1077. forward_zone_name = ""
  1078. forward_zone = []
  1079. zones = {
  1080. # <forward_zone_name>: [],
  1081. # <rev_zone1_name>: [],
  1082. # <rev_zone2_name>: [],
  1083. # ...
  1084. }
  1085. # Fill zones dict with zones configured in DNS_zone_names at the top of this file.
  1086. # Make sure the zone base names provided start with a leading . so the string
  1087. # operations later can be done easily and safely. Proceed with fingers crossed.
  1088. for entry, value in DNS_zone_names.items ():
  1089. if entry == "forward":
  1090. zone = value
  1091. if not zone.startswith ('.'):
  1092. zone = ".%s" % zone
  1093. zones[zone] = forward_zone
  1094. forward_zone_name = zone
  1095. if entry in [ 'rev_v4', 'rev_v6' ]:
  1096. for zone in value:
  1097. if not zone.startswith ('.'):
  1098. zone = ".%s" % zone
  1099. zones[zone] = []
  1100. # Process all interfaace of all nodes defined in pillar and generate forward
  1101. # and reverse entries for all zones defined in DNS_zone_names. Automagically
  1102. # put reverse entries into correct zone.
  1103. for node_id in sorted (nodes_config):
  1104. node_config = nodes_config.get (node_id)
  1105. ifaces = get_interface_config (node_config, sites_config, node_id)
  1106. for iface in sorted (ifaces):
  1107. iface_config = ifaces.get (iface)
  1108. # We only care for interfaces with IPs configured
  1109. prefixes = iface_config.get ("prefixes", None)
  1110. if prefixes == None:
  1111. continue
  1112. # Ignore any interface in $VRF
  1113. if iface_config.get ('vrf', "") in [ 'vrf_external' ]:
  1114. continue
  1115. for prefix in sorted (prefixes):
  1116. ip = ipaddress.ip_address (u'%s' % prefix.split ('/')[0])
  1117. proto = 'v%s' % ip.version
  1118. # The entry name is
  1119. # <node_id> when interface 'lo'
  1120. # <node_name>.srv.<residual> when interface 'srv' (or magically detected internal srv record)
  1121. # <interface>.<node_id> else
  1122. entry_name = node_id
  1123. if iface != "lo":
  1124. entry_name = "%s.%s" % (iface, node_id)
  1125. elif iface == 'srv' or re.search (r'^(10.132.251|2a03:2260:2342:f251:)', prefix):
  1126. entry_name = re.sub (r'^([^.]+)\.(.+)$', r'\g<1>.srv.\g<2>', entry_name)
  1127. # Strip forward zone name from entry_name and store forward entry
  1128. # with correct entry type for found IP address.
  1129. forward_entry_name = re.sub (forward_zone_name, "", entry_name)
  1130. forward_entry_name = re.sub (forward_zone_name, "", entry_name)
  1131. forward_entry_typ = "A" if ip.version == 4 else "AAAA"
  1132. forward_zone.append ("%s IN %s %s" % (forward_entry_name, forward_entry_typ, ip))
  1133. # Find correct reverse zone, if configured and strip reverse zone name
  1134. # from calculated reverse pointer name. Store reverse entry if we found
  1135. # a zone for it. If no configured reverse zone did match, this reverse
  1136. # entry will be ignored.
  1137. for zone in zones:
  1138. if ip.reverse_pointer.find (zone) > 0:
  1139. PTR_entry = re.sub (zone, "", ip.reverse_pointer)
  1140. zones[zone].append ("%s IN PTR %s." % (PTR_entry, entry_name))
  1141. break
  1142. return zones
  1143. # Convert the CIDR network from the given prefix into a dotted netmask
  1144. def cidr_to_dotted_mask (prefix):
  1145. from ipcalc import Network
  1146. return str (Network (prefix).netmask ())
  1147. def is_subprefix (prefix, subprefix):
  1148. from ipcalc import Network
  1149. return subprefix in Network(prefix)
  1150. # Return the network address of the given prefix
  1151. def get_network_address (prefix, with_prefixlen = False):
  1152. net_h = ipaddress.ip_network (u'%s' % prefix, strict = False)
  1153. network = str (net_h.network_address)
  1154. if with_prefixlen:
  1155. network += "/%s" % net_h.prefixlen
  1156. return network