nhrpd/nhrpd.h

   1 /* NHRP daemon internal structures and function prototypes
   2  * Copyright (c) 2014-2015 Timo Teräs
   3  *
   4  * This file is free software: you may copy, redistribute and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  */
   9
  10 #ifndef NHRPD_H
  11 #define NHRPD_H
  12
  13 #include "zbuf.h"
  14 #include "zclient.h"
  15 #include "debug.h"
  16 #include "memory.h"
  17 #include "resolver.h"
  18
  19 DECLARE_MGROUP(NHRPD);
  20
  21 #define NHRPD_DEFAULT_HOLDTIME  7200
  22
  23 #define NHRP_VTY_PORT           2610
  24 #define NHRP_DEFAULT_CONFIG     "nhrpd.conf"
  25
  26 extern struct thread_master *master;
  27
  28 enum { NHRP_OK = 0,
  29        NHRP_ERR_FAIL,
  30        NHRP_ERR_NO_MEMORY,
  31        NHRP_ERR_UNSUPPORTED_INTERFACE,
  32        NHRP_ERR_NHRP_NOT_ENABLED,
  33        NHRP_ERR_ENTRY_EXISTS,
  34        NHRP_ERR_ENTRY_NOT_FOUND,
  35        NHRP_ERR_PROTOCOL_ADDRESS_MISMATCH,
  36        __NHRP_ERR_MAX };
  37 #define NHRP_ERR_MAX            (__NHRP_ERR_MAX - 1)
  38
  39 struct notifier_block;
  40
  41 typedef void (*notifier_fn_t)(struct notifier_block *, unsigned long);
  42
  43 PREDECL_DLIST(notifier_list);
  44
  45 struct notifier_block {
  46         struct notifier_list_item notifier_entry;
  47         notifier_fn_t action;
  48 };
  49
  50 DECLARE_DLIST(notifier_list, struct notifier_block, notifier_entry);
  51
  52 struct notifier_list {
  53         struct notifier_list_head head;
  54 };
  55
  56 #define NOTIFIER_LIST_INITIALIZER(l)                                           \
  57         {                                                                      \
  58                 .head = INIT_DLIST((l)->head)                                  \
  59         }
  60
  61 static inline void notifier_init(struct notifier_list *l)
  62 {
  63         notifier_list_init(&l->head);
  64 }
  65
  66 static inline void notifier_add(struct notifier_block *n,
  67                                 struct notifier_list *l, notifier_fn_t action)
  68 {
  69         n->action = action;
  70         notifier_list_add_tail(&l->head, n);
  71 }
  72
  73 static inline void notifier_del(struct notifier_block *n,
  74                                 struct notifier_list *l)
  75 {
  76         notifier_list_del(&l->head, n);
  77 }
  78
  79 static inline void notifier_call(struct notifier_list *l, int cmd)
  80 {
  81         struct notifier_block *n;
  82
  83         frr_each_safe (notifier_list, &l->head, n)
  84                 n->action(n, cmd);
  85 }
  86
  87 static inline int notifier_active(struct notifier_list *l)
  88 {
  89         return notifier_list_count(&l->head) > 0;
  90 }
  91
  92 extern struct hash *nhrp_gre_list;
  93
  94 void nhrp_zebra_init(void);
  95 void nhrp_zebra_terminate(void);
  96 void nhrp_send_zebra_configure_arp(struct interface *ifp, int family);
  97 void nhrp_send_zebra_nbr(union sockunion *in,
  98                          union sockunion *out,
  99                          struct interface *ifp);
 100
 101 void nhrp_send_zebra_gre_source_set(struct interface *ifp,
 102                                     unsigned int link_idx,
 103                                     vrf_id_t link_vrf_id);
 104
 105 extern int nhrp_send_zebra_gre_request(struct interface *ifp);
 106 extern struct nhrp_gre_info *nhrp_gre_info_alloc(struct nhrp_gre_info *p);
 107
 108 struct zbuf;
 109 struct nhrp_vc;
 110 struct nhrp_cache;
 111 struct nhrp_nhs;
 112 struct nhrp_interface;
 113
 114 #define MAX_ID_LENGTH                   64
 115 #define MAX_CERT_LENGTH                 2048
 116
 117 enum nhrp_notify_type {
 118         NOTIFY_INTERFACE_UP,
 119         NOTIFY_INTERFACE_DOWN,
 120         NOTIFY_INTERFACE_CHANGED,
 121         NOTIFY_INTERFACE_ADDRESS_CHANGED,
 122         NOTIFY_INTERFACE_NBMA_CHANGED,
 123         NOTIFY_INTERFACE_MTU_CHANGED,
 124         NOTIFY_INTERFACE_IPSEC_CHANGED,
 125
 126         NOTIFY_VC_IPSEC_CHANGED,
 127         NOTIFY_VC_IPSEC_UPDATE_NBMA,
 128
 129         NOTIFY_PEER_UP,
 130         NOTIFY_PEER_DOWN,
 131         NOTIFY_PEER_IFCONFIG_CHANGED,
 132         NOTIFY_PEER_MTU_CHANGED,
 133         NOTIFY_PEER_NBMA_CHANGING,
 134
 135         NOTIFY_CACHE_UP,
 136         NOTIFY_CACHE_DOWN,
 137         NOTIFY_CACHE_DELETE,
 138         NOTIFY_CACHE_USED,
 139         NOTIFY_CACHE_BINDING_CHANGE,
 140 };
 141
 142 struct nhrp_vc {
 143         struct notifier_list notifier_list;
 144         uint32_t ipsec;
 145         uint32_t ike_uniqueid;
 146         uint8_t updating;
 147         uint8_t abort_migration;
 148
 149         struct nhrp_vc_peer {
 150                 union sockunion nbma;
 151                 char id[MAX_ID_LENGTH];
 152                 uint16_t certlen;
 153                 uint8_t cert[MAX_CERT_LENGTH];
 154         } local, remote;
 155 };
 156
 157 enum nhrp_route_type {
 158         NHRP_ROUTE_BLACKHOLE,
 159         NHRP_ROUTE_LOCAL,
 160         NHRP_ROUTE_NBMA_NEXTHOP,
 161         NHRP_ROUTE_OFF_NBMA,
 162 };
 163
 164 struct nhrp_peer {
 165         unsigned int ref;
 166         unsigned online : 1;
 167         unsigned requested : 1;
 168         unsigned fallback_requested : 1;
 169         unsigned prio : 1;
 170         struct notifier_list notifier_list;
 171         struct interface *ifp;
 172         struct nhrp_vc *vc;
 173         struct thread *t_fallback;
 174         struct notifier_block vc_notifier, ifp_notifier;
 175         struct thread *t_timer;
 176 };
 177
 178 struct nhrp_packet_parser {
 179         struct interface *ifp;
 180         struct nhrp_afi_data *if_ad;
 181         struct nhrp_peer *peer;
 182         struct zbuf *pkt;
 183         struct zbuf payload;
 184         struct zbuf extensions;
 185         struct nhrp_packet_header *hdr;
 186         enum nhrp_route_type route_type;
 187         struct prefix route_prefix;
 188         union sockunion src_nbma, src_proto, dst_proto;
 189 };
 190
 191 struct nhrp_reqid_pool {
 192         struct hash *reqid_hash;
 193         uint32_t next_request_id;
 194 };
 195
 196 struct nhrp_reqid {
 197         uint32_t request_id;
 198         void (*cb)(struct nhrp_reqid *, void *);
 199 };
 200
 201 extern struct nhrp_reqid_pool nhrp_packet_reqid;
 202 extern struct nhrp_reqid_pool nhrp_event_reqid;
 203
 204 enum nhrp_cache_type {
 205         NHRP_CACHE_INVALID = 0,
 206         NHRP_CACHE_INCOMPLETE,
 207         NHRP_CACHE_NEGATIVE,
 208         NHRP_CACHE_CACHED,
 209         NHRP_CACHE_DYNAMIC,
 210         NHRP_CACHE_NHS,
 211         NHRP_CACHE_STATIC,
 212         NHRP_CACHE_LOCAL,
 213         NHRP_CACHE_NUM_TYPES
 214 };
 215
 216 extern const char *const nhrp_cache_type_str[];
 217 extern unsigned long nhrp_cache_counts[NHRP_CACHE_NUM_TYPES];
 218
 219 struct nhrp_cache_config {
 220         struct interface *ifp;
 221         union sockunion remote_addr;
 222         enum nhrp_cache_type type;
 223         union sockunion nbma;
 224 };
 225
 226 struct nhrp_cache {
 227         struct interface *ifp;
 228         union sockunion remote_addr;
 229
 230         unsigned map : 1;
 231         unsigned used : 1;
 232         unsigned route_installed : 1;
 233         unsigned nhrp_route_installed : 1;
 234
 235         struct notifier_block peer_notifier;
 236         struct notifier_block newpeer_notifier;
 237         struct notifier_list notifier_list;
 238         struct nhrp_reqid eventid;
 239         struct thread *t_timeout;
 240         struct thread *t_auth;
 241
 242         struct {
 243                 enum nhrp_cache_type type;
 244                 union sockunion remote_nbma_natoa;
 245                 union sockunion remote_nbma_claimed;
 246                 struct nhrp_peer *peer;
 247                 time_t expires;
 248                 uint32_t mtu;
 249                 int holding_time;
 250         } cur, new;
 251 };
 252
 253 struct nhrp_shortcut {
 254         struct prefix *p;
 255         union sockunion addr;
 256
 257         struct nhrp_reqid reqid;
 258         struct thread *t_timer;
 259
 260         enum nhrp_cache_type type;
 261         unsigned int holding_time;
 262         unsigned route_installed : 1;
 263         unsigned expiring : 1;
 264
 265         struct nhrp_cache *cache;
 266         struct notifier_block cache_notifier;
 267 };
 268
 269 PREDECL_DLIST(nhrp_nhslist);
 270 PREDECL_DLIST(nhrp_mcastlist);
 271 PREDECL_DLIST(nhrp_reglist);
 272
 273 struct nhrp_nhs {
 274         struct interface *ifp;
 275         struct nhrp_nhslist_item nhslist_entry;
 276
 277         unsigned hub : 1;
 278         afi_t afi;
 279         union sockunion proto_addr;
 280         const char *nbma_fqdn; /* IP-address or FQDN */
 281
 282         struct thread *t_resolve;
 283         struct resolver_query dns_resolve;
 284         struct nhrp_reglist_head reglist_head;
 285 };
 286
 287 DECLARE_DLIST(nhrp_nhslist, struct nhrp_nhs, nhslist_entry);
 288
 289 struct nhrp_multicast {
 290         struct interface *ifp;
 291         struct nhrp_mcastlist_item mcastlist_entry;
 292         afi_t afi;
 293         union sockunion nbma_addr; /* IP-address */
 294 };
 295
 296 DECLARE_DLIST(nhrp_mcastlist, struct nhrp_multicast, mcastlist_entry);
 297
 298 struct nhrp_registration {
 299         struct nhrp_reglist_item reglist_entry;
 300         struct thread *t_register;
 301         struct nhrp_nhs *nhs;
 302         struct nhrp_reqid reqid;
 303         unsigned int timeout;
 304         unsigned mark : 1;
 305         union sockunion proto_addr;
 306         struct nhrp_peer *peer;
 307         struct notifier_block peer_notifier;
 308 };
 309
 310 DECLARE_DLIST(nhrp_reglist, struct nhrp_registration, reglist_entry);
 311
 312 #define NHRP_IFF_SHORTCUT               0x0001
 313 #define NHRP_IFF_REDIRECT               0x0002
 314 #define NHRP_IFF_REG_NO_UNIQUE          0x0100
 315
 316 struct nhrp_interface {
 317         struct interface *ifp;
 318
 319         unsigned enabled : 1;
 320
 321         char *ipsec_profile, *ipsec_fallback_profile, *source;
 322         union sockunion nbma;
 323         union sockunion nat_nbma;
 324         unsigned int link_idx;
 325         unsigned int link_vrf_id;
 326         uint32_t i_grekey;
 327         uint32_t o_grekey;
 328
 329         struct hash *peer_hash;
 330         struct hash *cache_config_hash;
 331         struct hash *cache_hash;
 332
 333         struct notifier_list notifier_list;
 334
 335         struct interface *nbmaifp;
 336         struct notifier_block nbmanifp_notifier;
 337
 338         struct nhrp_afi_data {
 339                 unsigned flags;
 340                 unsigned short configured : 1;
 341                 union sockunion addr;
 342                 uint32_t network_id;
 343                 short configured_mtu;
 344                 unsigned short mtu;
 345                 unsigned int holdtime;
 346                 struct nhrp_nhslist_head nhslist_head;
 347                 struct nhrp_mcastlist_head mcastlist_head;
 348         } afi[AFI_MAX];
 349 };
 350
 351 struct nhrp_gre_info {
 352         ifindex_t ifindex;
 353         struct in_addr vtep_ip; /* IFLA_GRE_LOCAL */
 354         struct in_addr vtep_ip_remote; /* IFLA_GRE_REMOTE */
 355         uint32_t ikey;
 356         uint32_t okey;
 357         ifindex_t ifindex_link; /* Interface index of interface
 358                                  * linked with GRE
 359                                  */
 360         vrf_id_t vrfid_link;
 361 };
 362
 363 extern struct zebra_privs_t nhrpd_privs;
 364
 365 int sock_open_unix(const char *path);
 366
 367 void nhrp_interface_init(void);
 368 void nhrp_interface_update(struct interface *ifp);
 369 void nhrp_interface_update_mtu(struct interface *ifp, afi_t afi);
 370 void nhrp_interface_update_nbma(struct interface *ifp,
 371                                 struct nhrp_gre_info *gre_info);
 372
 373 int nhrp_interface_add(ZAPI_CALLBACK_ARGS);
 374 int nhrp_interface_delete(ZAPI_CALLBACK_ARGS);
 375 int nhrp_interface_up(ZAPI_CALLBACK_ARGS);
 376 int nhrp_interface_down(ZAPI_CALLBACK_ARGS);
 377 int nhrp_interface_address_add(ZAPI_CALLBACK_ARGS);
 378 int nhrp_interface_address_delete(ZAPI_CALLBACK_ARGS);
 379 int nhrp_neighbor_operation(ZAPI_CALLBACK_ARGS);
 380 int nhrp_gre_update(ZAPI_CALLBACK_ARGS);
 381
 382 void nhrp_interface_notify_add(struct interface *ifp, struct notifier_block *n,
 383                                notifier_fn_t fn);
 384 void nhrp_interface_notify_del(struct interface *ifp, struct notifier_block *n);
 385 void nhrp_interface_set_protection(struct interface *ifp, const char *profile,
 386                                    const char *fallback_profile);
 387 void nhrp_interface_set_source(struct interface *ifp, const char *ifname);
 388 extern int nhrp_ifp_create(struct interface *ifp);
 389 extern int nhrp_ifp_up(struct interface *ifp);
 390 extern int nhrp_ifp_down(struct interface *ifp);
 391 extern int nhrp_ifp_destroy(struct interface *ifp);
 392
 393 int nhrp_nhs_add(struct interface *ifp, afi_t afi, union sockunion *proto_addr,
 394                  const char *nbma_fqdn);
 395 int nhrp_nhs_del(struct interface *ifp, afi_t afi, union sockunion *proto_addr,
 396                  const char *nbma_fqdn);
 397 int nhrp_nhs_free(struct nhrp_interface *nifp, afi_t afi, struct nhrp_nhs *nhs);
 398 void nhrp_nhs_terminate(void);
 399 void nhrp_nhs_foreach(struct interface *ifp, afi_t afi,
 400                       void (*cb)(struct nhrp_nhs *, struct nhrp_registration *,
 401                                  void *),
 402                       void *ctx);
 403 void nhrp_nhs_interface_del(struct interface *ifp);
 404
 405 int nhrp_multicast_add(struct interface *ifp, afi_t afi,
 406                        union sockunion *nbma_addr);
 407 int nhrp_multicast_del(struct interface *ifp, afi_t afi,
 408                        union sockunion *nbma_addr);
 409 void nhrp_multicast_interface_del(struct interface *ifp);
 410 void nhrp_multicast_foreach(struct interface *ifp, afi_t afi,
 411                             void (*cb)(struct nhrp_multicast *, void *),
 412                             void *ctx);
 413 void netlink_mcast_set_nflog_group(int nlgroup);
 414
 415 void nhrp_route_update_nhrp(const struct prefix *p, struct interface *ifp);
 416 void nhrp_route_announce(int add, enum nhrp_cache_type type,
 417                          const struct prefix *p, struct interface *ifp,
 418                          const union sockunion *nexthop, uint32_t mtu);
 419 int nhrp_route_read(ZAPI_CALLBACK_ARGS);
 420 int nhrp_route_get_nexthop(const union sockunion *addr, struct prefix *p,
 421                            union sockunion *via, struct interface **ifp);
 422 enum nhrp_route_type nhrp_route_address(struct interface *in_ifp,
 423                                         union sockunion *addr, struct prefix *p,
 424                                         struct nhrp_peer **peer);
 425
 426 void nhrp_config_init(void);
 427
 428 void nhrp_shortcut_init(void);
 429 void nhrp_shortcut_terminate(void);
 430 void nhrp_shortcut_initiate(union sockunion *addr);
 431 void nhrp_shortcut_foreach(afi_t afi,
 432                            void (*cb)(struct nhrp_shortcut *, void *),
 433                            void *ctx);
 434 void nhrp_shortcut_purge(struct nhrp_shortcut *s, int force);
 435 void nhrp_shortcut_prefix_change(const struct prefix *p, int deleted);
 436
 437 void nhrp_cache_interface_del(struct interface *ifp);
 438 void nhrp_cache_config_free(struct nhrp_cache_config *c);
 439 struct nhrp_cache_config *nhrp_cache_config_get(struct interface *ifp,
 440                                                 union sockunion *remote_addr,
 441                                                 int create);
 442 struct nhrp_cache *nhrp_cache_get(struct interface *ifp,
 443                                   union sockunion *remote_addr, int create);
 444 void nhrp_cache_foreach(struct interface *ifp,
 445                         void (*cb)(struct nhrp_cache *, void *), void *ctx);
 446 void nhrp_cache_config_foreach(struct interface *ifp,
 447                                void (*cb)(struct nhrp_cache_config *, void *), void *ctx);
 448 void nhrp_cache_set_used(struct nhrp_cache *, int);
 449 int nhrp_cache_update_binding(struct nhrp_cache *, enum nhrp_cache_type type,
 450                               int holding_time, struct nhrp_peer *p,
 451                               uint32_t mtu, union sockunion *nbma_natoa,
 452                               union sockunion *claimed_nbma);
 453 void nhrp_cache_notify_add(struct nhrp_cache *c, struct notifier_block *,
 454                            notifier_fn_t);
 455 void nhrp_cache_notify_del(struct nhrp_cache *c, struct notifier_block *);
 456
 457 void nhrp_vc_init(void);
 458 void nhrp_vc_terminate(void);
 459 struct nhrp_vc *nhrp_vc_get(const union sockunion *src,
 460                             const union sockunion *dst, int create);
 461 int nhrp_vc_ipsec_updown(uint32_t child_id, struct nhrp_vc *vc);
 462 void nhrp_vc_notify_add(struct nhrp_vc *, struct notifier_block *,
 463                         notifier_fn_t);
 464 void nhrp_vc_notify_del(struct nhrp_vc *, struct notifier_block *);
 465 void nhrp_vc_foreach(void (*cb)(struct nhrp_vc *, void *), void *ctx);
 466 void nhrp_vc_reset(void);
 467
 468 void vici_init(void);
 469 void vici_terminate(void);
 470 void vici_terminate_vc_by_profile_name(char *profile_name);
 471 void vici_terminate_vc_by_ike_id(unsigned int ike_id);
 472 void vici_request_vc(const char *profile, union sockunion *src,
 473                      union sockunion *dst, int prio);
 474
 475 extern const char *nhrp_event_socket_path;
 476
 477 void evmgr_init(void);
 478 void evmgr_terminate(void);
 479 void evmgr_set_socket(const char *socket);
 480 void evmgr_notify(const char *name, struct nhrp_cache *c,
 481                   void (*cb)(struct nhrp_reqid *, void *));
 482
 483 struct nhrp_packet_header *nhrp_packet_push(struct zbuf *zb, uint8_t type,
 484                                             const union sockunion *src_nbma,
 485                                             const union sockunion *src_proto,
 486                                             const union sockunion *dst_proto);
 487 void nhrp_packet_complete(struct zbuf *zb, struct nhrp_packet_header *hdr);
 488 uint16_t nhrp_packet_calculate_checksum(const uint8_t *pdu, uint16_t len);
 489
 490 struct nhrp_packet_header *nhrp_packet_pull(struct zbuf *zb,
 491                                             union sockunion *src_nbma,
 492                                             union sockunion *src_proto,
 493                                             union sockunion *dst_proto);
 494
 495 struct nhrp_cie_header *nhrp_cie_push(struct zbuf *zb, uint8_t code,
 496                                       const union sockunion *nbma,
 497                                       const union sockunion *proto);
 498 struct nhrp_cie_header *nhrp_cie_pull(struct zbuf *zb,
 499                                       struct nhrp_packet_header *hdr,
 500                                       union sockunion *nbma,
 501                                       union sockunion *proto);
 502
 503 struct nhrp_extension_header *
 504 nhrp_ext_push(struct zbuf *zb, struct nhrp_packet_header *hdr, uint16_t type);
 505 void nhrp_ext_complete(struct zbuf *zb, struct nhrp_extension_header *ext);
 506 struct nhrp_extension_header *nhrp_ext_pull(struct zbuf *zb,
 507                                             struct zbuf *payload);
 508 void nhrp_ext_request(struct zbuf *zb, struct nhrp_packet_header *hdr,
 509                       struct interface *);
 510 int nhrp_ext_reply(struct zbuf *zb, struct nhrp_packet_header *hdr,
 511                    struct interface *ifp, struct nhrp_extension_header *ext,
 512                    struct zbuf *extpayload);
 513
 514 uint32_t nhrp_reqid_alloc(struct nhrp_reqid_pool *, struct nhrp_reqid *r,
 515                           void (*cb)(struct nhrp_reqid *, void *));
 516 void nhrp_reqid_free(struct nhrp_reqid_pool *, struct nhrp_reqid *r);
 517 struct nhrp_reqid *nhrp_reqid_lookup(struct nhrp_reqid_pool *, uint32_t reqid);
 518
 519 int nhrp_packet_init(void);
 520
 521 void nhrp_peer_interface_del(struct interface *ifp);
 522 struct nhrp_peer *nhrp_peer_get(struct interface *ifp,
 523                                 const union sockunion *remote_nbma);
 524 struct nhrp_peer *nhrp_peer_ref(struct nhrp_peer *p);
 525 void nhrp_peer_unref(struct nhrp_peer *p);
 526 int nhrp_peer_check(struct nhrp_peer *p, int establish);
 527 void nhrp_peer_notify_add(struct nhrp_peer *p, struct notifier_block *,
 528                           notifier_fn_t);
 529 void nhrp_peer_notify_del(struct nhrp_peer *p, struct notifier_block *);
 530 void nhrp_peer_recv(struct nhrp_peer *p, struct zbuf *zb);
 531 void nhrp_peer_send(struct nhrp_peer *p, struct zbuf *zb);
 532 void nhrp_peer_send_indication(struct interface *ifp, uint16_t, struct zbuf *);
 533
 534 int nhrp_nhs_match_ip(union sockunion *in_ip, struct nhrp_interface *nifp);
 535
 536 #endif