From 03c9155cd012a56c9454b396c5db7785abb80b0a Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 18 Apr 2020 15:27:28 +0200 Subject: router-advert: rename XML/Python files for a common pattern --- interface-definitions/service-router-advert.xml.in | 266 --------------------- interface-definitions/service_router-advert.xml.in | 266 +++++++++++++++++++++ src/conf_mode/service-router-advert.py | 169 ------------- src/conf_mode/service_router-advert.py | 169 +++++++++++++ 4 files changed, 435 insertions(+), 435 deletions(-) delete mode 100644 interface-definitions/service-router-advert.xml.in create mode 100644 interface-definitions/service_router-advert.xml.in delete mode 100755 src/conf_mode/service-router-advert.py create mode 100755 src/conf_mode/service_router-advert.py diff --git a/interface-definitions/service-router-advert.xml.in b/interface-definitions/service-router-advert.xml.in deleted file mode 100644 index bd63b15a3..000000000 --- a/interface-definitions/service-router-advert.xml.in +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - - IPv6 Router Advertisements (RAs) service - 900 - - - - - Interface to send DDNS updates for [REQUIRED] - - - - - - - - Set Hop Count field of the IP header for outgoing packets (default: 64) - - 1-255 - Value should represent current diameter of the Internet - - - 0 - Unspecified (by this router) - - - - - Hop count must be between 0 and 255 - - - - - Lifetime associated with the default router in units of seconds - - 4-9000 - Router Lifetime in seconds - - - 0 - Not a default router - - - - - Default router livetime bust be 0 or between 4 and 9000 - - - - - Preference associated with the default router, - - low medium high - - - low - Default router has low preference - - - medium - Default router has medium preference (default) - - - high - Default router has high preference - - - (low|medium|high) - - Default preference must be low, medium or high - - - - - DNS search list - - - - - - Link MTU value placed in RAs, exluded in RAs if unset - - 1280-9000 - Link MTU value in RAs - - - - - Link MTU must be between 1280 and 9000 - - - - - Hosts use the administered (stateful) protocol for address autoconfiguration in addition to any addresses autoconfigured using SLAAC - - - - - - Set interval between unsolicited multicast RAs - - - - - Maximum interval between unsolicited multicast RAs (default: 600) - - 4-1800 - Maximum interval in seconds - - - - - Maximum interval must be between 4 and 1800 seconds - - - - - Minimum interval between unsolicited multicast RAs - - 3-1350 - Minimum interval in seconds - - - - - Minimum interval must be between 3 and 1350 seconds - - - - - - - IPv6 address of recursive DNS server - - ipv6 - IPv6 address of DNS name server - - - - - - - - - - Hosts use the administered (stateful) protocol for autoconfiguration of other (non-address) information - - - - - - IPv6 prefix to be advertised in Router Advertisements (RAs) - - ipv6net - IPv6 prefix to be advertized - - - - - - - - - Prefix can not be used for stateless address auto-configuration - - - - - - Prefix can not be used for on-link determination - - - - - - Time in seconds that the prefix will remain preferred (default 4 hours) - - infinity - - - 0-4294967295 - Time in seconds that the prefix will remain preferred - - - infinity - Prefix will remain preferred forever - - - - (infinity) - - - - - - Time in seconds that the prefix will remain valid (default: 30 days) - - infinity - - - 1-4294967295 - Time in seconds that the prefix will remain valid - - - infinity - Prefix will remain preferred forever - - - - (infinity) - - - - - - - - Time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation - - 1-3600000 - Reachable Time value in RAs (in milliseconds) - - - 0 - Reachable Time unspecified by this router - - - - - Reachable time must be 0 or between 1 and 3600000 milliseconds - - - - - Time in milliseconds between retransmitted Neighbor Solicitation messages - - 1-4294967295 - Minimum interval in milliseconds - - - 0 - Time, in milliseconds, between retransmitted Neighbor Solicitation messages - - - - - Retransmit interval must be 0 or between 1 and 4294967295 milliseconds - - - - - Do not send router adverts - - - - - - - - - - diff --git a/interface-definitions/service_router-advert.xml.in b/interface-definitions/service_router-advert.xml.in new file mode 100644 index 000000000..6a4706ab7 --- /dev/null +++ b/interface-definitions/service_router-advert.xml.in @@ -0,0 +1,266 @@ + + + + + + + IPv6 Router Advertisements (RAs) service + 900 + + + + + Interface to send DDNS updates for [REQUIRED] + + + + + + + + Set Hop Count field of the IP header for outgoing packets (default: 64) + + 1-255 + Value should represent current diameter of the Internet + + + 0 + Unspecified (by this router) + + + + + Hop count must be between 0 and 255 + + + + + Lifetime associated with the default router in units of seconds + + 4-9000 + Router Lifetime in seconds + + + 0 + Not a default router + + + + + Default router livetime bust be 0 or between 4 and 9000 + + + + + Preference associated with the default router, + + low medium high + + + low + Default router has low preference + + + medium + Default router has medium preference (default) + + + high + Default router has high preference + + + (low|medium|high) + + Default preference must be low, medium or high + + + + + DNS search list + + + + + + Link MTU value placed in RAs, exluded in RAs if unset + + 1280-9000 + Link MTU value in RAs + + + + + Link MTU must be between 1280 and 9000 + + + + + Hosts use the administered (stateful) protocol for address autoconfiguration in addition to any addresses autoconfigured using SLAAC + + + + + + Set interval between unsolicited multicast RAs + + + + + Maximum interval between unsolicited multicast RAs (default: 600) + + 4-1800 + Maximum interval in seconds + + + + + Maximum interval must be between 4 and 1800 seconds + + + + + Minimum interval between unsolicited multicast RAs + + 3-1350 + Minimum interval in seconds + + + + + Minimum interval must be between 3 and 1350 seconds + + + + + + + IPv6 address of recursive DNS server + + ipv6 + IPv6 address of DNS name server + + + + + + + + + + Hosts use the administered (stateful) protocol for autoconfiguration of other (non-address) information + + + + + + IPv6 prefix to be advertised in Router Advertisements (RAs) + + ipv6net + IPv6 prefix to be advertized + + + + + + + + + Prefix can not be used for stateless address auto-configuration + + + + + + Prefix can not be used for on-link determination + + + + + + Time in seconds that the prefix will remain preferred (default 4 hours) + + infinity + + + 0-4294967295 + Time in seconds that the prefix will remain preferred + + + infinity + Prefix will remain preferred forever + + + + (infinity) + + + + + + Time in seconds that the prefix will remain valid (default: 30 days) + + infinity + + + 1-4294967295 + Time in seconds that the prefix will remain valid + + + infinity + Prefix will remain preferred forever + + + + (infinity) + + + + + + + + Time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation + + 1-3600000 + Reachable Time value in RAs (in milliseconds) + + + 0 + Reachable Time unspecified by this router + + + + + Reachable time must be 0 or between 1 and 3600000 milliseconds + + + + + Time in milliseconds between retransmitted Neighbor Solicitation messages + + 1-4294967295 + Minimum interval in milliseconds + + + 0 + Time, in milliseconds, between retransmitted Neighbor Solicitation messages + + + + + Retransmit interval must be 0 or between 1 and 4294967295 milliseconds + + + + + Do not send router adverts + + + + + + + + + + diff --git a/src/conf_mode/service-router-advert.py b/src/conf_mode/service-router-advert.py deleted file mode 100755 index 620f3eacf..000000000 --- a/src/conf_mode/service-router-advert.py +++ /dev/null @@ -1,169 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (C) 2018-2019 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 - -from stat import S_IRUSR, S_IWUSR, S_IRGRP -from sys import exit - -from vyos.config import Config -from vyos import ConfigError -from vyos.util import call -from vyos.template import render - - -config_file = r'/etc/radvd.conf' - -default_config_data = { - 'interfaces': [] -} - -def get_config(): - rtradv = default_config_data - conf = Config() - base_level = ['service', 'router-advert'] - - if not conf.exists(base_level): - return rtradv - - for interface in conf.list_nodes(base_level + ['interface']): - intf = { - 'name': interface, - 'hop_limit' : '64', - 'default_lifetime': '', - 'default_preference': 'medium', - 'dnssl': [], - 'link_mtu': '', - 'managed_flag': 'off', - 'interval_max': '600', - 'interval_min': '', - 'name_server': [], - 'other_config_flag': 'off', - 'prefixes' : [], - 'reachable_time': '0', - 'retrans_timer': '0', - 'send_advert': 'on' - } - - # set config level first to reduce boilerplate code - conf.set_level(base_level + ['interface', interface]) - - if conf.exists(['hop-limit']): - intf['hop_limit'] = conf.return_value(['hop-limit']) - - if conf.exists(['default-lifetim']): - intf['default_lifetime'] = conf.return_value(['default-lifetim']) - - if conf.exists(['default-preference']): - intf['default_preference'] = conf.return_value(['default-preference']) - - if conf.exists(['dnssl']): - intf['dnssl'] = conf.return_values(['dnssl']) - - if conf.exists(['link-mtu']): - intf['link_mtu'] = conf.return_value(['link-mtu']) - - if conf.exists(['managed-flag']): - intf['managed_flag'] = 'on' - - if conf.exists(['interval', 'max']): - intf['interval_max'] = conf.return_value(['interval', 'max']) - - if conf.exists(['interval', 'min']): - intf['interval_min'] = conf.return_value(['interval', 'min']) - - if conf.exists(['name-server']): - intf['name_server'] = conf.return_values(['name-server']) - - if conf.exists(['other-config-flag']): - intf['other_config_flag'] = 'on' - - if conf.exists(['reachable-time']): - intf['reachable_time'] = conf.return_value(['reachable-time']) - - if conf.exists(['retrans-timer']): - intf['retrans_timer'] = conf.return_value(['retrans-timer']) - - if conf.exists(['no-send-advert']): - intf['send_advert'] = 'off' - - for prefix in conf.list_nodes(['prefix']): - tmp = { - 'prefix' : prefix, - 'autonomous_flag' : 'on', - 'on_link' : 'on', - 'preferred_lifetime': '14400', - 'valid_lifetime' : '2592000' - - } - - # set config level first to reduce boilerplate code - conf.set_level(base_level + ['interface', interface, 'prefix', prefix]) - - if conf.exists(['no-autonomous-flag']): - tmp['autonomous_flag'] = 'off' - - if conf.exists(['no-on-link-flag']): - tmp['on_link'] = 'off' - - if conf.exists(['preferred-lifetime']): - tmp['preferred_lifetime'] = conf.return_value(['preferred-lifetime']) - - if conf.exists(['valid-lifetime']): - tmp['valid_lifetime'] = conf.return_value(['valid-lifetime']) - - intf['prefixes'].append(tmp) - - rtradv['interfaces'].append(intf) - - return rtradv - -def verify(rtradv): - return None - -def generate(rtradv): - if not rtradv['interfaces']: - return None - - render(config_file, 'router-advert/radvd.conf.tmpl', rtradv, trim_blocks=True) - - # adjust file permissions of new configuration file - if os.path.exists(config_file): - os.chmod(config_file, S_IRUSR | S_IWUSR | S_IRGRP) - - return None - -def apply(rtradv): - if not rtradv['interfaces']: - # bail out early - looks like removal from running config - call('systemctl stop radvd.service') - if os.path.exists(config_file): - os.unlink(config_file) - - return None - - call('systemctl restart radvd.service') - return None - -if __name__ == '__main__': - try: - c = get_config() - verify(c) - generate(c) - apply(c) - except ConfigError as e: - print(e) - exit(1) diff --git a/src/conf_mode/service_router-advert.py b/src/conf_mode/service_router-advert.py new file mode 100755 index 000000000..620f3eacf --- /dev/null +++ b/src/conf_mode/service_router-advert.py @@ -0,0 +1,169 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2018-2019 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 + +from stat import S_IRUSR, S_IWUSR, S_IRGRP +from sys import exit + +from vyos.config import Config +from vyos import ConfigError +from vyos.util import call +from vyos.template import render + + +config_file = r'/etc/radvd.conf' + +default_config_data = { + 'interfaces': [] +} + +def get_config(): + rtradv = default_config_data + conf = Config() + base_level = ['service', 'router-advert'] + + if not conf.exists(base_level): + return rtradv + + for interface in conf.list_nodes(base_level + ['interface']): + intf = { + 'name': interface, + 'hop_limit' : '64', + 'default_lifetime': '', + 'default_preference': 'medium', + 'dnssl': [], + 'link_mtu': '', + 'managed_flag': 'off', + 'interval_max': '600', + 'interval_min': '', + 'name_server': [], + 'other_config_flag': 'off', + 'prefixes' : [], + 'reachable_time': '0', + 'retrans_timer': '0', + 'send_advert': 'on' + } + + # set config level first to reduce boilerplate code + conf.set_level(base_level + ['interface', interface]) + + if conf.exists(['hop-limit']): + intf['hop_limit'] = conf.return_value(['hop-limit']) + + if conf.exists(['default-lifetim']): + intf['default_lifetime'] = conf.return_value(['default-lifetim']) + + if conf.exists(['default-preference']): + intf['default_preference'] = conf.return_value(['default-preference']) + + if conf.exists(['dnssl']): + intf['dnssl'] = conf.return_values(['dnssl']) + + if conf.exists(['link-mtu']): + intf['link_mtu'] = conf.return_value(['link-mtu']) + + if conf.exists(['managed-flag']): + intf['managed_flag'] = 'on' + + if conf.exists(['interval', 'max']): + intf['interval_max'] = conf.return_value(['interval', 'max']) + + if conf.exists(['interval', 'min']): + intf['interval_min'] = conf.return_value(['interval', 'min']) + + if conf.exists(['name-server']): + intf['name_server'] = conf.return_values(['name-server']) + + if conf.exists(['other-config-flag']): + intf['other_config_flag'] = 'on' + + if conf.exists(['reachable-time']): + intf['reachable_time'] = conf.return_value(['reachable-time']) + + if conf.exists(['retrans-timer']): + intf['retrans_timer'] = conf.return_value(['retrans-timer']) + + if conf.exists(['no-send-advert']): + intf['send_advert'] = 'off' + + for prefix in conf.list_nodes(['prefix']): + tmp = { + 'prefix' : prefix, + 'autonomous_flag' : 'on', + 'on_link' : 'on', + 'preferred_lifetime': '14400', + 'valid_lifetime' : '2592000' + + } + + # set config level first to reduce boilerplate code + conf.set_level(base_level + ['interface', interface, 'prefix', prefix]) + + if conf.exists(['no-autonomous-flag']): + tmp['autonomous_flag'] = 'off' + + if conf.exists(['no-on-link-flag']): + tmp['on_link'] = 'off' + + if conf.exists(['preferred-lifetime']): + tmp['preferred_lifetime'] = conf.return_value(['preferred-lifetime']) + + if conf.exists(['valid-lifetime']): + tmp['valid_lifetime'] = conf.return_value(['valid-lifetime']) + + intf['prefixes'].append(tmp) + + rtradv['interfaces'].append(intf) + + return rtradv + +def verify(rtradv): + return None + +def generate(rtradv): + if not rtradv['interfaces']: + return None + + render(config_file, 'router-advert/radvd.conf.tmpl', rtradv, trim_blocks=True) + + # adjust file permissions of new configuration file + if os.path.exists(config_file): + os.chmod(config_file, S_IRUSR | S_IWUSR | S_IRGRP) + + return None + +def apply(rtradv): + if not rtradv['interfaces']: + # bail out early - looks like removal from running config + call('systemctl stop radvd.service') + if os.path.exists(config_file): + os.unlink(config_file) + + return None + + call('systemctl restart radvd.service') + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) -- cgit v1.2.3