#!/usr/bin/env python3 # # Copyright (C) 2018-2023 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 . import os import time from sys import exit from ipaddress import ip_interface from ipaddress import IPv4Interface from ipaddress import IPv6Interface from vyos.config import Config from vyos.configdict import dict_merge from vyos.configdict import leaf_node_changed from vyos.ifconfig.vrrp import VRRP from vyos.template import render from vyos.template import is_ipv4 from vyos.template import is_ipv6 from vyos.util import call from vyos.util import is_ipv6_tentative from vyos.util import is_systemd_service_running from vyos.xml import defaults from vyos import ConfigError from vyos import airbag airbag.enable() systemd_override = r'/run/systemd/system/keepalived.service.d/10-override.conf' def get_config(config=None): if config: conf = config else: conf = Config() base = ['high-availability', 'vrrp'] if not conf.exists(base): return None vrrp = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True, no_tag_node_value_mangle=True) # We have gathered the dict representation of the CLI, but there are default # options which we need to update into the dictionary retrived. if 'group' in vrrp: default_values = defaults(base + ['group']) if 'garp' in default_values: del default_values['garp'] for group in vrrp['group']: vrrp['group'][group] = dict_merge(default_values, vrrp['group'][group]) ## Get the sync group used for conntrack-sync conntrack_path = ['service', 'conntrack-sync', 'failover-mechanism', 'vrrp', 'sync-group'] if conf.exists(conntrack_path): vrrp['conntrack_sync_group'] = conf.return_value(conntrack_path) if leaf_node_changed(conf, base + ['snmp']): vrrp.update({'restart_required': {}}) return vrrp def verify(vrrp): if not vrrp: return None used_vrid_if = [] if 'group' in vrrp: for group, group_config in vrrp['group'].items(): # Check required fields if 'vrid' not in group_config: raise ConfigError(f'VRID is required but not set in VRRP group "{group}"') if 'interface' not in group_config: raise ConfigError(f'Interface is required but not set in VRRP group "{group}"') if 'virtual_address' not in group_config: raise ConfigError(f'Virtual IP address is required but not set in VRRP group "{group}"') if 'authentication' in group_config: if not {'password', 'type'} <= set(group_config['authentication']): raise ConfigError(f'Authentication requires both type and passwortd to be set in VRRP group "{group}"') # We can not use a VRID once per interface interface = group_config['interface'] vrid = group_config['vrid'] tmp = {'interface': interface, 'vrid': vrid} if tmp in used_vrid_if: raise ConfigError(f'VRID "{vrid}" can only be used once on interface "{interface}"!') used_vrid_if.append(tmp) # Keepalived doesn't allow mixing IPv4 and IPv6 in one group, so we mirror that restriction # XXX: filter on map object is destructive, so we force it to list. # Additionally, filter objects always evaluate to True, empty or not, # so we force them to lists as well. vaddrs = list(map(lambda i: ip_interface(i), group_config['virtual_address'])) vaddrs4 = list(filter(lambda x: isinstance(x, IPv4Interface), vaddrs)) vaddrs6 = list(filter(lambda x: isinstance(x, IPv6Interface), vaddrs)) if vaddrs4 and vaddrs6: raise ConfigError(f'VRRP group "{group}" mixes IPv4 and IPv6 virtual addresses, this is not allowed.\n' \ 'Create individual groups for IPv4 and IPv6!') if vaddrs4: if 'hello_source_address' in group_config: if is_ipv6(group_config['hello_source_address']): raise ConfigError(f'VRRP group "{group}" uses IPv4 but hello-source-address is IPv6!') if 'peer_address' in group_config: for peer_address in group_config['peer_address']: if is_ipv6(peer_address): raise ConfigError(f'VRRP group "{group}" uses IPv4 but peer-address is IPv6!') if vaddrs6: if 'hello_source_address' in group_config: if is_ipv4(group_config['hello_source_address']): raise ConfigError(f'VRRP group "{group}" uses IPv6 but hello-source-address is IPv4!') if 'peer_address' in group_config: for peer_address in group_config['peer_address']: if is_ipv4(peer_address): raise ConfigError(f'VRRP group "{group}" uses IPv6 but peer-address is IPv4!') # Warn the user about the deprecated mode-force option if 'transition_script' in group_config and 'mode_force' in group_config['transition_script']: print('Warning: "transition-script mode-force" VRRP option is deprecated and will be removed in VyOS 1.4.') print('It is no longer necessary, so you can safely remove it from your config now.') # Check sync groups if 'sync_group' in vrrp: for sync_group, sync_config in vrrp['sync_group'].items(): if 'member' in sync_config: for member in sync_config['member']: if member not in vrrp['group']: raise ConfigError(f'VRRP sync-group "{sync_group}" refers to VRRP group "{member}", '\ 'but it does not exist!') def generate(vrrp): if not vrrp: if os.path.isfile(systemd_override): os.unlink(systemd_override) return None render(VRRP.location['config'], 'vrrp/keepalived.conf.tmpl', vrrp) render(systemd_override, 'vrrp/10-override.conf.j2', vrrp) return None def apply(vrrp): service_name = 'keepalived.service' call('systemctl daemon-reload') if not vrrp: call(f'systemctl stop {service_name}') return None # Check if IPv6 address is tentative T5533 for group, group_config in vrrp['group'].items(): if 'hello_source_address' in group_config: if is_ipv6(group_config['hello_source_address']): ipv6_address = group_config['hello_source_address'] interface = group_config['interface'] checks = 20 interval = 0.1 for _ in range(checks): if is_ipv6_tentative(interface, ipv6_address): time.sleep(interval) # XXX: T3944 - reload keepalived configuration if service is already running # to not cause any service disruption when applying changes. systemd_action = 'reload-or-restart' if 'restart_required' in vrrp: systemd_action = 'restart' call(f'systemctl {systemd_action} {service_name}') return None if __name__ == '__main__': try: c = get_config() verify(c) generate(c) apply(c) except ConfigError as e: print(e) exit(1)