zebra/rtadv.h

   1 /* Router advertisement
   2  * Copyright (C) 2005 6WIND <jean-mickael.guerin@6wind.com>
   3  * Copyright (C) 1999 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_RTADV_H
  23 #define _ZEBRA_RTADV_H
  24
  25 #include "vty.h"
  26 #include "zebra/interface.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* NB: RTADV is defined in zebra/interface.h above */
  33 #if defined(HAVE_RTADV)
  34
  35 /* Router advertisement prefix. */
  36 struct rtadv_prefix {
  37         /* Prefix to be advertised. */
  38         struct prefix_ipv6 prefix;
  39
  40         /* The prefix was manually/automatically defined. */
  41         int AdvPrefixCreate;
  42
  43         /* The value to be placed in the Valid Lifetime in the Prefix */
  44         uint32_t AdvValidLifetime;
  45 #define RTADV_VALID_LIFETIME 2592000
  46
  47         /* The value to be placed in the on-link flag */
  48         int AdvOnLinkFlag;
  49
  50         /* The value to be placed in the Preferred Lifetime in the Prefix
  51            Information option, in seconds.*/
  52         uint32_t AdvPreferredLifetime;
  53 #define RTADV_PREFERRED_LIFETIME 604800
  54
  55         /* The value to be placed in the Autonomous Flag. */
  56         int AdvAutonomousFlag;
  57
  58         /* The value to be placed in the Router Address Flag [RFC6275 7.2]. */
  59         int AdvRouterAddressFlag;
  60 #ifndef ND_OPT_PI_FLAG_RADDR
  61 #define ND_OPT_PI_FLAG_RADDR         0x20
  62 #endif
  63 };
  64
  65 /* RFC4861 minimum delay between RAs  */
  66 #ifndef MIN_DELAY_BETWEEN_RAS
  67 #define MIN_DELAY_BETWEEN_RAS        3000
  68 #endif
  69
  70 /* RFC4584 Extension to Sockets API for Mobile IPv6 */
  71
  72 #ifndef ND_OPT_ADV_INTERVAL
  73 #define ND_OPT_ADV_INTERVAL     7   /* Adv Interval Option */
  74 #endif
  75 #ifndef ND_OPT_HA_INFORMATION
  76 #define ND_OPT_HA_INFORMATION   8   /* HA Information Option */
  77 #endif
  78
  79 #ifndef HAVE_STRUCT_ND_OPT_ADV_INTERVAL
  80 struct nd_opt_adv_interval { /* Advertisement interval option */
  81         uint8_t nd_opt_ai_type;
  82         uint8_t nd_opt_ai_len;
  83         uint16_t nd_opt_ai_reserved;
  84         uint32_t nd_opt_ai_interval;
  85 } __attribute__((__packed__));
  86 #else
  87 #ifndef HAVE_STRUCT_ND_OPT_ADV_INTERVAL_ND_OPT_AI_TYPE
  88 /* fields may have to be renamed */
  89 #define nd_opt_ai_type          nd_opt_adv_interval_type
  90 #define nd_opt_ai_len           nd_opt_adv_interval_len
  91 #define nd_opt_ai_reserved      nd_opt_adv_interval_reserved
  92 #define nd_opt_ai_interval      nd_opt_adv_interval_ival
  93 #endif
  94 #endif
  95
  96 #ifndef HAVE_STRUCT_ND_OPT_HOMEAGENT_INFO
  97 struct nd_opt_homeagent_info { /* Home Agent info */
  98         uint8_t nd_opt_hai_type;
  99         uint8_t nd_opt_hai_len;
 100         uint16_t nd_opt_hai_reserved;
 101         uint16_t nd_opt_hai_preference;
 102         uint16_t nd_opt_hai_lifetime;
 103 } __attribute__((__packed__));
 104 #endif
 105
 106 #ifndef ND_OPT_RDNSS
 107 #define ND_OPT_RDNSS 25
 108 #endif
 109 #ifndef ND_OPT_DNSSL
 110 #define ND_OPT_DNSSL 31
 111 #endif
 112
 113 #ifndef HAVE_STRUCT_ND_OPT_RDNSS
 114 struct nd_opt_rdnss { /* Recursive DNS server option [RFC8106 5.1] */
 115         uint8_t nd_opt_rdnss_type;
 116         uint8_t nd_opt_rdnss_len;
 117         uint16_t nd_opt_rdnss_reserved;
 118         uint32_t nd_opt_rdnss_lifetime;
 119         /* Followed by one or more IPv6 addresses */
 120 } __attribute__((__packed__));
 121 #endif
 122
 123 #ifndef HAVE_STRUCT_ND_OPT_DNSSL
 124 struct nd_opt_dnssl { /* DNS search list option [RFC8106 5.2] */
 125         uint8_t nd_opt_dnssl_type;
 126         uint8_t nd_opt_dnssl_len;
 127         uint16_t nd_opt_dnssl_reserved;
 128         uint32_t nd_opt_dnssl_lifetime;
 129         /*
 130          * Followed by one or more domain names encoded as in [RFC1035 3.1].
 131          * Multiple domain names are concatenated after encoding. In any case,
 132          * the result is zero-padded to a multiple of 8 octets.
 133          */
 134 } __attribute__((__packed__));
 135 #endif
 136
 137 #endif /* HAVE_RTADV */
 138
 139 /*
 140  * ipv6 nd prefixes can be manually defined, derived from the kernel interface
 141  * configs or both.  If both, manual flag/timer settings are used.
 142  */
 143 enum ipv6_nd_prefix_source {
 144         PREFIX_SRC_NONE = 0,
 145         PREFIX_SRC_MANUAL,
 146         PREFIX_SRC_AUTO,
 147         PREFIX_SRC_BOTH,
 148 };
 149
 150 enum ipv6_nd_suppress_ra_status {
 151         RA_ENABLE = 0,
 152         RA_SUPPRESS,
 153 };
 154
 155 extern void rtadv_vrf_init(struct zebra_vrf *zvrf);
 156 extern void rtadv_vrf_terminate(struct zebra_vrf *zvrf);
 157 extern void rtadv_stop_ra(struct interface *ifp);
 158 extern void rtadv_stop_ra_all(void);
 159 extern void rtadv_cmd_init(void);
 160 extern void zebra_interface_radv_disable(ZAPI_HANDLER_ARGS);
 161 extern void zebra_interface_radv_enable(ZAPI_HANDLER_ARGS);
 162 extern void rtadv_add_prefix(struct zebra_if *zif, const struct prefix_ipv6 *p);
 163 extern void rtadv_delete_prefix(struct zebra_if *zif, const struct prefix *p);
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168
 169 #endif /* _ZEBRA_RTADV_H */