src/plugins/nat/nat.api

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "2.5.0";
  17
  18 /**
  19  * @file nat.api
  20  * @brief VPP control-plane API messages.
  21  *
  22  * This file defines VPP control-plane API messages which are generally
  23  * called through a shared memory interface.
  24  */
  25
  26 /*
  27  * Common NAT plugin APIs
  28  */
  29
  30 /** \brief Control ping from client to api server request
  31     @param client_index - opaque cookie to identify the sender
  32     @param context - sender context, to match reply w/ request
  33 */
  34 define nat_control_ping
  35 {
  36   u32 client_index;
  37   u32 context;
  38 };
  39
  40 /** \brief Control ping from the client to the server response
  41     @param client_index - opaque cookie to identify the sender
  42     @param context - sender context, to match reply w/ request
  43     @param retval - return code for the request
  44     @param vpe_pid - the pid of the vpe, returned by the server
  45 */
  46 define nat_control_ping_reply
  47 {
  48   u32 context;
  49   i32 retval;
  50   u32 client_index;
  51   u32 vpe_pid;
  52 };
  53
  54 /** \brief Show NAT plugin startup config
  55     @param client_index - opaque cookie to identify the sender
  56     @param context - sender context, to match reply w/ request
  57 */
  58 define nat_show_config
  59 {
  60   u32 client_index;
  61   u32 context;
  62 };
  63
  64 /** \brief Show NAT plugin startup config reply
  65     @param context - sender context, to match reply w/ request
  66     @param retval - return code for the request
  67     @param static_mapping_only - if 1 dynamic translations disabled
  68     @param static_mapping_connection_tracking - if 1 create session data
  69     @param deterministic - if 1 deterministic mapping
  70     @param translation_buckets - number of translation hash buckets
  71     @param translation_memory_size - translation hash memory size
  72     @param user_buckets - number of user hash buckets
  73     @param user_memory_size - user hash memory size
  74     @param max_translations_per_user - maximum number of translations per user
  75     @param outside_vrf_id - outside VRF id
  76     @param inside_vrf_id - default inside VRF id
  77 */
  78 define nat_show_config_reply
  79 {
  80   u32 context;
  81   i32 retval;
  82   u8 static_mapping_only;
  83   u8 static_mapping_connection_tracking;
  84   u8 deterministic;
  85   u32 translation_buckets;
  86   u32 translation_memory_size;
  87   u32 user_buckets;
  88   u32 user_memory_size;
  89   u32 max_translations_per_user;
  90   u32 outside_vrf_id;
  91   u32 inside_vrf_id;
  92 };
  93
  94 /** \brief Set NAT workers
  95     @param client_index - opaque cookie to identify the sender
  96     @param context - sender context, to match reply w/ request
  97     @param worker_mask - NAT workers mask
  98 */
  99 autoreply define nat_set_workers {
 100   u32 client_index;
 101   u32 context;
 102   u64 worker_mask;
 103 };
 104
 105 /** \brief Dump NAT workers
 106     @param client_index - opaque cookie to identify the sender
 107     @param context - sender context, to match reply w/ request
 108 */
 109 define nat_worker_dump {
 110   u32 client_index;
 111   u32 context;
 112 };
 113
 114 /** \brief NAT workers details response
 115     @param context - sender context, to match reply w/ request
 116     @param worker_index - worker index
 117     @param lcore_id - lcore ID
 118     @param name - worker name
 119 */
 120 define nat_worker_details {
 121   u32 context;
 122   u32 worker_index;
 123   u32 lcore_id;
 124   u8 name[64];
 125 };
 126
 127 /** \brief Enable/disable NAT IPFIX logging
 128     @param client_index - opaque cookie to identify the sender
 129     @param context - sender context, to match reply w/ request
 130     @param domain_id - observation domain ID
 131     @param src_port - source port number
 132     @param enable - 1 if enable, 0 if disable
 133 */
 134 autoreply define nat_ipfix_enable_disable {
 135   u32 client_index;
 136   u32 context;
 137   u32 domain_id;
 138   u16 src_port;
 139   u8 enable;
 140 };
 141
 142 /** \brief Set NAT virtual fragmentation reassembly
 143     @param client_index - opaque cookie to identify the sender
 144     @param context - sender context, to match reply w/ request
 145     @param timeout - reassembly timeout
 146     @param max_reass - maximum number of concurrent reassemblies
 147     @param max_frag - maximum number of fragmets per reassembly
 148     @param drop_frag - if 0 translate fragments, otherwise drop fragments
 149     @param is_ip6 - 1 if IPv6, 0 if IPv4
 150 */
 151 autoreply define nat_set_reass {
 152   u32 client_index;
 153   u32 context;
 154   u32 timeout;
 155   u16 max_reass;
 156   u8  max_frag;
 157   u8  drop_frag;
 158   u8  is_ip6;
 159 };
 160
 161 /** \brief Get NAT virtual fragmentation reassembly configuration
 162     @param client_index - opaque cookie to identify the sender
 163     @param context - sender context, to match reply w/ request
 164 */
 165 define nat_get_reass {
 166   u32 client_index;
 167   u32 context;
 168 };
 169
 170 /** \brief Get NAT virtual fragmentation reassembly configuration reply
 171     @param context - sender context, to match reply w/ request
 172     @param retval - return code
 173     @param ip4_timeout - reassembly timeout
 174     @param ip4_max_reass - maximum number of concurrent reassemblies
 175     @param ip4_max_frag - maximum number of fragmets per reassembly
 176     @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments
 177     @param ip6_timeout - reassembly timeout
 178     @param ip6_max_reass - maximum number of concurrent reassemblies
 179     @param ip6_max_frag - maximum number of fragmets per reassembly
 180     @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments
 181 */
 182 define nat_get_reass_reply {
 183   u32 context;
 184   i32 retval;
 185   u32 ip4_timeout;
 186   u16 ip4_max_reass;
 187   u8  ip4_max_frag;
 188   u8  ip4_drop_frag;
 189   u32 ip6_timeout;
 190   u16 ip6_max_reass;
 191   u8  ip6_max_frag;
 192   u8  ip6_drop_frag;
 193 };
 194
 195 /** \brief Dump NAT virtual fragmentation reassemblies
 196     @param client_index - opaque cookie to identify the sender
 197     @param context - sender context, to match reply w/ request
 198 */
 199 define nat_reass_dump {
 200   u32 client_index;
 201   u32 context;
 202 };
 203
 204 /** \brief NAT virtual fragmentation reassemblies response
 205     @param context - sender context, to match reply w/ request
 206     @param is_ip4 - 1 if address type is IPv4
 207     @param src_addr - source IP address
 208     @param dst_addr - destination IP address
 209     @param frag_id - fragment ID
 210     @param proto - protocol
 211     @param frag_n - number of cached fragments
 212 */
 213 define nat_reass_details {
 214   u32 context;
 215   u8 is_ip4;
 216   u8 src_addr[16];
 217   u8 dst_addr[16];
 218   u32 frag_id;
 219   u8 proto;
 220   u8 frag_n;
 221 };
 222
 223 /*
 224  * NAT44 APIs
 225  */
 226
 227 /** \brief Add/del NAT44 address range
 228     @param client_index - opaque cookie to identify the sender
 229     @param context - sender context, to match reply w/ request
 230     @param first_ip_address - first IPv4 address
 231     @param last_ip_address - last IPv4 address
 232     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 233     @param twice_nat - twice NAT address range for extenal hosts
 234     @param is_add - 1 if add, 0 if delete
 235 */
 236 autoreply define nat44_add_del_address_range {
 237   u32 client_index;
 238   u32 context;
 239   u8 first_ip_address[4];
 240   u8 last_ip_address[4];
 241   u32 vrf_id;
 242   u8 twice_nat;
 243   u8 is_add;
 244 };
 245
 246 /** \brief Dump NAT44 addresses
 247     @param client_index - opaque cookie to identify the sender
 248     @param context - sender context, to match reply w/ request
 249 */
 250 define nat44_address_dump {
 251   u32 client_index;
 252   u32 context;
 253 };
 254
 255 /** \brief NAT44 address details response
 256     @param context - sender context, to match reply w/ request
 257     @param ip_address - IPv4 address
 258     @param twice_nat - twice NAT address range for extenal hosts
 259     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 260 */
 261 define nat44_address_details {
 262   u32 context;
 263   u8 ip_address[4];
 264   u8 twice_nat;
 265   u32 vrf_id;
 266 };
 267
 268 /** \brief Enable/disable NAT44 feature on the interface
 269     @param client_index - opaque cookie to identify the sender
 270     @param context - sender context, to match reply w/ request
 271     @param is_add - 1 if add, 0 if delete
 272     @param is_inside - 1 if inside, 0 if outside
 273     @param sw_if_index - software index of the interface
 274 */
 275 autoreply define nat44_interface_add_del_feature {
 276   u32 client_index;
 277   u32 context;
 278   u8 is_add;
 279   u8 is_inside;
 280   u32 sw_if_index;
 281 };
 282
 283 /** \brief Dump interfaces with NAT44 feature
 284     @param client_index - opaque cookie to identify the sender
 285     @param context - sender context, to match reply w/ request
 286 */
 287 define nat44_interface_dump {
 288   u32 client_index;
 289   u32 context;
 290 };
 291
 292 /** \brief NAT44 interface details response
 293     @param context - sender context, to match reply w/ request
 294     @param is_inside - 1 if inside, 0 if outside, 2 if inside and outside
 295     @param sw_if_index - software index of the interface
 296 */
 297 define nat44_interface_details {
 298   u32 context;
 299   u8 is_inside;
 300   u32 sw_if_index;
 301 };
 302
 303 /** \brief Enable/disbale NAT44 as an interface output feature (postrouting
 304            in2out translation)
 305     @param client_index - opaque cookie to identify the sender
 306     @param context - sender context, to match reply w/ request
 307     @param is_add - 1 if add, 0 if delete
 308     @param is_inside - 1 if inside, 0 if outside
 309     @param sw_if_index - software index of the interface
 310 */
 311 autoreply define nat44_interface_add_del_output_feature {
 312   u32 client_index;
 313   u32 context;
 314   u8 is_add;
 315   u8 is_inside;
 316   u32 sw_if_index;
 317 };
 318
 319 /** \brief Dump interfaces with NAT44 output feature
 320     @param client_index - opaque cookie to identify the sender
 321     @param context - sender context, to match reply w/ request
 322 */
 323 define nat44_interface_output_feature_dump {
 324   u32 client_index;
 325   u32 context;
 326 };
 327
 328 /** \brief NAT44 interface with output feature details response
 329     @param context - sender context, to match reply w/ request
 330     @param is_inside - 1 if inside, 0 if outside
 331     @param sw_if_index - software index of the interface
 332 */
 333 define nat44_interface_output_feature_details {
 334   u32 context;
 335   u8 is_inside;
 336   u32 sw_if_index;
 337 };
 338
 339 /** \brief Add/delete NAT44 static mapping
 340     @param client_index - opaque cookie to identify the sender
 341     @param context - sender context, to match reply w/ request
 342     @param is_add - 1 if add, 0 if delete
 343     @param addr_only - 1 if address only mapping
 344     @param local_ip_address - local IPv4 address
 345     @param external_ip_address - external IPv4 address
 346     @param protocol - IP protocol, used only if addr_only=0
 347     @param local_port - local port number, used only if addr_only=0
 348     @param external_port - external port number, used only if addr_only=0
 349     @param external_sw_if_index - external interface (if set
 350                                   external_ip_address is ignored, ~0 means not
 351                                   used)
 352     @param vfr_id - VRF ID
 353     @param twice_nat - if 1 translate external host address and port, only for
 354                        1:1 NAPT (addr_only must be 0)
 355     @param self_twice_nat - if 1 translate external host address and port
 356                             whenever external host address equals
 357                             local address of internal host
 358     @param out2in_only - if 1 rule match only out2in direction
 359     @param tag - opaque string tag
 360 */
 361 autoreply define nat44_add_del_static_mapping {
 362   u32 client_index;
 363   u32 context;
 364   u8 is_add;
 365   u8 addr_only;
 366   u8 local_ip_address[4];
 367   u8 external_ip_address[4];
 368   u8 protocol;
 369   u16 local_port;
 370   u16 external_port;
 371   u32 external_sw_if_index;
 372   u32 vrf_id;
 373   u8 twice_nat;
 374   u8 self_twice_nat;
 375   u8 out2in_only;
 376   u8 tag[64];
 377 };
 378
 379 /** \brief Dump NAT44 static mappings
 380     @param client_index - opaque cookie to identify the sender
 381     @param context - sender context, to match reply w/ request
 382 */
 383 define nat44_static_mapping_dump {
 384   u32 client_index;
 385   u32 context;
 386 };
 387
 388 /** \brief NAT44 static mapping details response
 389     @param context - sender context, to match reply w/ request
 390     @param addr_only - 1 if address only mapping
 391     @param local_ip_address - local IPv4 address
 392     @param external_ip_address - external IPv4 address
 393     @param protocol - IP protocol, valid only if addr_only=0
 394     @param local_port - local port number, valid only if addr_only=0
 395     @param external_port - external port number, valid only if addr_only=0
 396     @param external_sw_if_index - external interface
 397     @param vfr_id - VRF ID
 398     @param twice_nat - if 1 translate external host address and port
 399     @param self_twice_nat - if 1 translate external host address and port
 400                             whenever external host address equals
 401                             local address of internal host
 402     @param out2in_only - if 1 rule match only out2in direction
 403     @param tag - opaque string tag
 404 */
 405 define nat44_static_mapping_details {
 406   u32 context;
 407   u8 addr_only;
 408   u8 local_ip_address[4];
 409   u8 external_ip_address[4];
 410   u8 protocol;
 411   u16 local_port;
 412   u16 external_port;
 413   u32 external_sw_if_index;
 414   u32 vrf_id;
 415   u8 twice_nat;
 416   u8 self_twice_nat;
 417   u8 out2in_only;
 418   u8 tag[64];
 419 };
 420
 421 /** \brief Add/delete NAT44 identity mapping
 422     @param client_index - opaque cookie to identify the sender
 423     @param context - sender context, to match reply w/ request
 424     @param is_add - 1 if add, 0 if delete
 425     @param addr_only - 1 if address only mapping
 426     @param ip_address - IPv4 address
 427     @param protocol - IP protocol
 428     @param port - port number
 429     @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
 430                                     used)
 431     @param vfr_id - VRF ID (if ~0 use default VRF)
 432     @param tag - opaque string tag
 433 */
 434 autoreply define nat44_add_del_identity_mapping {
 435   u32 client_index;
 436   u32 context;
 437   u8 is_add;
 438   u8 addr_only;
 439   u8 ip_address[4];
 440   u8 protocol;
 441   u16 port;
 442   u32 sw_if_index;
 443   u32 vrf_id;
 444   u8 tag[64];
 445 };
 446
 447 /** \brief Dump NAT44 identity mappings
 448     @param client_index - opaque cookie to identify the sender
 449     @param context - sender context, to match reply w/ request
 450 */
 451 define nat44_identity_mapping_dump {
 452   u32 client_index;
 453   u32 context;
 454 };
 455
 456 /** \brief NAT44 identity mapping details response
 457     @param context - sender context, to match reply w/ request
 458     @param addr_only - 1 if address only mapping
 459     @param ip_address - IPv4 address
 460     @param protocol - IP protocol
 461     @param port - port number
 462     @param sw_if_index - interface
 463     @param vfr_id - VRF ID
 464     @param tag - opaque string tag
 465 */
 466 define nat44_identity_mapping_details {
 467   u32 context;
 468   u8 addr_only;
 469   u8 ip_address[4];
 470   u8 protocol;
 471   u16 port;
 472   u32 sw_if_index;
 473   u32 vrf_id;
 474   u8 tag[64];
 475 };
 476
 477 /** \brief Add/delete NAT44 pool address from specific interfce
 478     @param client_index - opaque cookie to identify the sender
 479     @param context - sender context, to match reply w/ request
 480     @param is_add - 1 if add, 0 if delete
 481     @param twice_nat - twice NAT address for extenal hosts
 482     @param sw_if_index - software index of the interface
 483 */
 484 autoreply define nat44_add_del_interface_addr {
 485   u32 client_index;
 486   u32 context;
 487   u8 is_add;
 488   u8 twice_nat;
 489   u32 sw_if_index;
 490 };
 491
 492 /** \brief Dump NAT44 pool addresses interfaces
 493     @param client_index - opaque cookie to identify the sender
 494     @param context - sender context, to match reply w/ request
 495 */
 496 define nat44_interface_addr_dump {
 497   u32 client_index;
 498   u32 context;
 499 };
 500
 501 /** \brief NAT44 pool addresses interfaces details response
 502     @param context - sender context, to match reply w/ request
 503     @param sw_if_index - software index of the interface
 504     @param twice_nat - twice NAT address for extenal hosts
 505 */
 506 define nat44_interface_addr_details {
 507   u32 context;
 508   u32 sw_if_index;
 509   u8 twice_nat;
 510 };
 511
 512 /** \brief Dump NAT44 users
 513     @param client_index - opaque cookie to identify the sender
 514     @param context - sender context, to match reply w/ request
 515 */
 516 define nat44_user_dump {
 517   u32 client_index;
 518   u32 context;
 519 };
 520
 521 /** \brief NAT44 users response
 522     @param context - sender context, to match reply w/ request
 523     @vrf_id - VRF ID
 524     @param ip_adress - IPv4 address
 525     @param nsessions - number of dynamic sessions
 526     @param nstaticsessions - number of static sessions
 527 */
 528 define nat44_user_details {
 529   u32 context;
 530   u32 vrf_id;
 531   u8 ip_address[4];
 532   u32 nsessions;
 533   u32 nstaticsessions;
 534 };
 535
 536 /** \brief NAT44 user's sessions
 537     @param client_index - opaque cookie to identify the sender
 538     @param context - sender context, to match reply w/ request
 539     @param is_ip4 - 1 if address type is IPv4
 540     @param user_ip - IP address of the user to dump
 541     @param vrf_id - VRF_ID
 542 */
 543 define nat44_user_session_dump {
 544   u32 client_index;
 545   u32 context;
 546   u8 ip_address[4];
 547   u32 vrf_id;
 548 };
 549
 550 /** \brief NAT44 user's sessions response
 551     @param context - sender context, to match reply w/ request
 552     @param outside_ip_address - outside IPv4 address
 553     @param outside_port - outside port
 554     @param inside_ip_address - inside IPv4 address
 555     @param inside_port - inside port
 556     @param protocol - protocol
 557     @param is_static - 1 if session is static
 558     @param last_heard - last heard timer
 559     @param total_bytes - count of bytes sent through session
 560     @param total_pkts - count of pakets sent through session
 561     @param is_closed - 1 if TCP session is closed
 562 */
 563 define nat44_user_session_details {
 564   u32 context;
 565   u8 outside_ip_address[4];
 566   u16 outside_port;
 567   u8 inside_ip_address[4];
 568   u16 inside_port;
 569   u16 protocol;
 570   u8 is_static;
 571   u64 last_heard;
 572   u64 total_bytes;
 573   u32 total_pkts;
 574   u8 is_closed;
 575 };
 576
 577 /** \brief NAT44 load-balancing address and port pair
 578     @param addr - IPv4 address of the internal node
 579     @param port - L4 port number of the internal node
 580     @param probability - probability of the internal node to be randomly matched
 581 */
 582 typeonly manual_endian define nat44_lb_addr_port {
 583   u8 addr[4];
 584   u16 port;
 585   u8 probability;
 586 };
 587
 588 /** \brief Add/delete NAT44 load-balancing static mapping rule
 589     @param client_index - opaque cookie to identify the sender
 590     @param context - sender context, to match reply w/ request
 591     @param is_add - 1 if add, 0 if delete
 592     @param external_addr - external IPv4 address of the service
 593     @param external_port - external L4 port number of the service
 594     @param protocol - IP protocol number of the service
 595     @param vrf_id - internal network VRF ID
 596     @param twice_nat - if 1 translate external host address and port
 597     @param self_twice_nat - if 1 translate external host address and port
 598                             whenever external host address equals
 599                             local address of internal host
 600     @param out2in_only - if 1 rule match only out2in direction
 601     @param tag - opaque string tag
 602     @param local_num - number of local network nodes
 603     @param locals - local network nodes
 604 */
 605 autoreply manual_endian define nat44_add_del_lb_static_mapping {
 606   u32 client_index;
 607   u32 context;
 608   u8 is_add;
 609   u8 external_addr[4];
 610   u16 external_port;
 611   u8 protocol;
 612   u32 vrf_id;
 613   u8 twice_nat;
 614   u8 self_twice_nat;
 615   u8 out2in_only;
 616   u8 tag[64];
 617   u8 local_num;
 618   vl_api_nat44_lb_addr_port_t locals[local_num];
 619 };
 620
 621 /** \brief Dump NAT44 load-balancing static mapping rules
 622     @param client_index - opaque cookie to identify the sender
 623     @param context - sender context, to match reply w/ request
 624 */
 625 define nat44_lb_static_mapping_dump {
 626   u32 client_index;
 627   u32 context;
 628 };
 629
 630 /** \brief NAT44 load-balancing static mapping rule details response
 631     @param context - sender context, to match reply w/ request
 632     @param is_add - 1 if add, 0 if delete
 633     @param external_addr - external IPv4 address of the service
 634     @param external_port - external L4 port number of the service
 635     @param protocol - IP protocol number of the service
 636     @param vrf_id - internal network VRF ID
 637     @param twice_nat - if 1 translate external host address and port
 638     @param self_twice_nat - if 1 translate external host address and port
 639                             whenever external host address equals
 640                             local address of internal host
 641     @param out2in_only - if 1 rule match only out2in direction
 642     @param tag - opaque string tag
 643     @param local_num - number of local network nodes
 644     @param locals - local network nodes
 645 */
 646 manual_endian define nat44_lb_static_mapping_details {
 647   u32 context;
 648   u8 external_addr[4];
 649   u16 external_port;
 650   u8 protocol;
 651   u32 vrf_id;
 652   u8 twice_nat;
 653   u8 self_twice_nat;
 654   u8 out2in_only;
 655   u8 tag[64];
 656   u8 local_num;
 657   vl_api_nat44_lb_addr_port_t locals[local_num];
 658 };
 659
 660 /** \brief Delete NAT44 session
 661     @param client_index - opaque cookie to identify the sender
 662     @param context - sender context, to match reply w/ request
 663     @param is_in - 1 if inside network addres and port pari, 0 if outside
 664     @param ip_address - IPv4 address
 665     @param protocol - IP protocol
 666     @param port - port number
 667     @param vfr_id - VRF ID
 668 */
 669 autoreply define nat44_del_session {
 670   u32 client_index;
 671   u32 context;
 672   u8 is_in;
 673   u8 address[4];
 674   u8 protocol;
 675   u16 port;
 676   u32 vrf_id;
 677 };
 678
 679 /** \brief Enable/disable forwarding for NAT44
 680     Forward packets which don't match existing translation
 681     or static mapping instead of dropping them.
 682     @param client_index - opaque cookie to identify the sender
 683     @param context - sender context, to match reply w/ request
 684     @param enable - 0 for enable, 1 for disable
 685 */
 686 autoreply define nat44_forwarding_enable_disable {
 687   u32 client_index;
 688   u32 context;
 689   u8 enable;
 690 };
 691
 692 /** \brief Check if forwarding is enabled or disabled
 693     @param client_index - opaque cookie to identify the sender
 694     @param context - sender context, to match reply w/ request
 695 */
 696 define nat44_forwarding_is_enabled {
 697   u32 client_index;
 698   u32 context;
 699 };
 700
 701 /** \brief Response to check if forwarding is enabled or disabled
 702     @param context - sender context, to match reply w/ request
 703     @param enabled - 1 if enabled, 0 if disabled
 704 */
 705 define nat44_forwarding_is_enabled_reply {
 706   u32 context;
 707   u8 enabled;
 708 };
 709
 710
 711 /*
 712  * Deterministic NAT (CGN) APIs
 713  */
 714
 715 /** \brief Add/delete NAT deterministic mapping
 716     @param client_index - opaque cookie to identify the sender
 717     @param context - sender context, to match reply w/ request
 718     @param is_add - 1 if add, 0 if delete
 719     @param is_nat44 - 1 if NAT44
 720     @param in_addr - inside IP address
 721     @param in_plen - inside IP address prefix length
 722     @param out_addr - outside IPv4 address
 723     @param out_addr - outside IPv4 address prefix length
 724 */
 725 autoreply define nat_det_add_del_map {
 726   u32 client_index;
 727   u32 context;
 728   u8 is_add;
 729   u8 is_nat44;
 730   u8 addr_only;
 731   u8 in_addr[16];
 732   u8 in_plen;
 733   u8 out_addr[4];
 734   u8 out_plen;
 735 };
 736
 737 /** \brief Get outside address and port range from inside address
 738     @param client_index - opaque cookie to identify the sender
 739     @param context - sender context, to match reply w/ request
 740     @param is_nat44 - 1 if NAT44
 741     @param in_addr - inside IP address
 742 */
 743 define nat_det_forward {
 744   u32 client_index;
 745   u32 context;
 746   u8 is_nat44;
 747   u8 in_addr[16];
 748 };
 749
 750 /** \brief Get outside address and port range from inside address
 751     @param context - sender context, to match reply w/ request
 752     @param retval - return code
 753     @param out_port_lo - outside port range start
 754     @param out_port_hi - outside port range end
 755     @param out_addr - outside IPv4 address
 756 */
 757 define nat_det_forward_reply {
 758   u32 context;
 759   i32 retval;
 760   u16 out_port_lo;
 761   u16 out_port_hi;
 762   u8 out_addr[4];
 763 };
 764
 765 /** \brief Get inside address from outside address and port
 766     @param client_index - opaque cookie to identify the sender
 767     @param context - sender context, to match reply w/ request
 768     @param out_port - outside port
 769     @param out_addr - outside IPv4 address
 770 */
 771 define nat_det_reverse {
 772   u32 client_index;
 773   u32 context;
 774   u16 out_port;
 775   u8 out_addr[4];
 776 };
 777
 778 /** \brief Get inside address from outside address and port reply
 779     @param context - sender context, to match reply w/ request
 780     @param retval - return code
 781     @param is_nat44 - 1 if NAT44
 782     @param in_addr - inside IP address
 783 */
 784 define nat_det_reverse_reply {
 785   u32 context;
 786   i32 retval;
 787   u8 is_nat44;
 788   u8 in_addr[16];
 789 };
 790
 791 /** \brief Dump NAT deterministic mappings
 792     @param client_index - opaque cookie to identify the sender
 793     @param context - sender context, to match reply w/ request
 794 */
 795 define nat_det_map_dump {
 796   u32 client_index;
 797   u32 context;
 798 };
 799
 800 /** \brief NAT users response
 801     @param context - sender context, to match reply w/ request
 802     @param is_nat44 - 1 if NAT44
 803     @param in_addr - inside IP address
 804     @param in_plen - inside IP address prefix length
 805     @param out_addr - outside IPv4 address
 806     @param out_plen - outside IPv4 address prefix length
 807     @param sharing_ratio - outside to inside address sharing ratio
 808     @param ports_per_host - number of ports available to a host
 809     @param ses_num - number of sessions belonging to this mapping
 810 */
 811 define nat_det_map_details {
 812   u32 context;
 813   u8 is_nat44;
 814   u8 in_addr[16];
 815   u8 in_plen;
 816   u8 out_addr[4];
 817   u8 out_plen;
 818   u32 sharing_ratio;
 819   u16 ports_per_host;
 820   u32 ses_num;
 821 };
 822
 823 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
 824     @param client_index - opaque cookie to identify the sender
 825     @param context - sender context, to match reply w/ request
 826     @param udp - UDP timeout (default 300sec)
 827     @param tcp_established - TCP established timeout (default 7440sec)
 828     @param tcp_transitory - TCP transitory timeout (default 240sec)
 829     @param icmp - ICMP timeout (default 60sec)
 830 */
 831 autoreply define nat_det_set_timeouts {
 832   u32 client_index;
 833   u32 context;
 834   u32 udp;
 835   u32 tcp_established;
 836   u32 tcp_transitory;
 837   u32 icmp;
 838 };
 839
 840 /** \brief Get values of timeouts for deterministic NAT (seconds)
 841     @param client_index - opaque cookie to identify the sender
 842     @param context - sender context, to match reply w/ request
 843 */
 844 define nat_det_get_timeouts {
 845   u32 client_index;
 846   u32 context;
 847 };
 848
 849 /** \brief Get values of timeouts for deterministic NAT reply
 850     @param context - sender context, to match reply w/ request
 851     @param retval - return code
 852     @param udp - UDP timeout (default 300sec)
 853     @param tcp_established - TCP established timeout (default 7440sec)
 854     @param tcp_transitory - TCP transitory timeout (default 240sec)
 855     @param icmp - ICMP timeout (default 60sec)
 856 */
 857 define nat_det_get_timeouts_reply {
 858   u32 context;
 859   i32 retval;
 860   u32 udp;
 861   u32 tcp_established;
 862   u32 tcp_transitory;
 863   u32 icmp;
 864 };
 865
 866 /** \brief Close deterministic NAT session by outside address and port
 867     @param client_index - opaque cookie to identify the sender
 868     @param context - sender context, to match reply w/ request
 869     @param out_addr - outside IPv4 address
 870     @param out_port - outside port
 871     @param ext_addr - external host IPv4 address
 872     @param ext_port - external host port
 873 */
 874 autoreply define nat_det_close_session_out {
 875   u32 client_index;
 876   u32 context;
 877   u8 out_addr[4];
 878   u16 out_port;
 879   u8 ext_addr[4];
 880   u16 ext_port;
 881 };
 882
 883 /** \brief Close deterministic NAT session by inside address and port
 884     @param client_index - opaque cookie to identify the sender
 885     @param context - sender context, to match reply w/ request
 886     @param is_nat44 - 1 if NAT44
 887     @param in_addr - inside IP address
 888     @param in_port - inside port
 889     @param ext_addr - external host IP address
 890     @param ext_port - external host port
 891 */
 892 autoreply define nat_det_close_session_in {
 893   u32 client_index;
 894   u32 context;
 895   u8 is_nat44;
 896   u8 in_addr[16];
 897   u16 in_port;
 898   u8 ext_addr[16];
 899   u16 ext_port;
 900 };
 901
 902 /** \brief Dump determinstic NAT sessions
 903     @param client_index - opaque cookie to identify the sender
 904     @param context - sender context, to match reply w/ request
 905     @param is_nat44 - 1 if NAT44
 906     @param user_addr - address of an inside user whose sessions to dump
 907 */
 908 define nat_det_session_dump {
 909   u32 client_index;
 910   u32 context;
 911   u8 is_nat44;
 912   u8 user_addr[16];
 913 };
 914
 915 /** \brief Deterministic NAT sessions reply
 916     @param context - sender context, to match reply w/ request
 917     @param in_port - inside port
 918     @param ext_addr - external host address
 919     @param ext_port - external host port
 920     @param out_port - outside NAT port
 921     @param state - session state
 922     @param expire - session expiration timestamp
 923 */
 924 define nat_det_session_details {
 925   u32 client_index;
 926   u32 context;
 927   u16 in_port;
 928   u8 ext_addr[4];
 929   u16 ext_port;
 930   u16 out_port;
 931   u8 state;
 932   u32 expire;
 933 };
 934
 935 /*
 936  * NAT64 APIs
 937  */
 938
 939 /** \brief Add/delete address range to NAT64 pool
 940     @param client_index - opaque cookie to identify the sender
 941     @param context - sender context, to match reply w/ request
 942     @param start_addr - start address of the range
 943     @param end_addr - end address of the range
 944     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 945     @param is_add - 1 if add, 0 if delete
 946 */
 947 autoreply define nat64_add_del_pool_addr_range {
 948   u32 client_index;
 949   u32 context;
 950   u8 start_addr[4];
 951   u8 end_addr[4];
 952   u32 vrf_id;
 953   u8 is_add;
 954 };
 955
 956 /** \brief Dump NAT64 pool addresses
 957     @param client_index - opaque cookie to identify the sender
 958     @param context - sender context, to match reply w/ request
 959 */
 960 define nat64_pool_addr_dump {
 961   u32 client_index;
 962   u32 context;
 963 };
 964
 965 /** \brief NAT64 pool address details response
 966     @param context - sender context, to match reply w/ request
 967     @param address - IPv4 address
 968     @param vfr_id - VRF id of tenant, ~0 means independent of VRF
 969 */
 970 define nat64_pool_addr_details {
 971   u32 context;
 972   u8 address[4];
 973   u32 vrf_id;
 974 };
 975
 976 /** \brief Enable/disable NAT64 feature on the interface
 977     @param client_index - opaque cookie to identify the sender
 978     @param context - sender context, to match reply w/ request
 979     @param sw_if_index - index of the interface
 980     @param is_inside - 1 if inside, 0 if outside
 981     @param is_add - 1 if add, 0 if delete
 982 */
 983 autoreply define nat64_add_del_interface {
 984   u32 client_index;
 985   u32 context;
 986   u32 sw_if_index;
 987   u8 is_inside;
 988   u8 is_add;
 989 };
 990
 991 /** \brief Dump interfaces with NAT64 feature
 992     @param client_index - opaque cookie to identify the sender
 993     @param context - sender context, to match reply w/ request
 994 */
 995 define nat64_interface_dump {
 996   u32 client_index;
 997   u32 context;
 998 };
 999
1000 /** \brief NAT64 interface details response
1001     @param context - sender context, to match reply w/ request
1002     @param is_inside - 1 if inside, 0 if outside
1003     @param sw_if_index - index of the interface
1004 */
1005 define nat64_interface_details {
1006   u32 context;
1007   u8 is_inside;
1008   u32 sw_if_index;
1009 };
1010
1011 /** \brief Add/delete NAT64 static BIB entry
1012     @param client_index - opaque cookie to identify the sender
1013     @param context - sender context, to match reply w/ request
1014     @param i_addr - inside IPv6 address
1015     @param o_addr - outside IPv4 address
1016     @param i_port - inside port number
1017     @param o_port - outside port number
1018     @param vrf_id - VRF id of tenant
1019     @param proto - protocol number
1020     @param is_add - 1 if add, 0 if delete
1021 */
1022  autoreply define nat64_add_del_static_bib {
1023   u32 client_index;
1024   u32 context;
1025   u8 i_addr[16];
1026   u8 o_addr[4];
1027   u16 i_port;
1028   u16 o_port;
1029   u32 vrf_id;
1030   u8 proto;
1031   u8 is_add;
1032 };
1033
1034 /** \brief Dump NAT64 BIB
1035     @param client_index - opaque cookie to identify the sender
1036     @param context - sender context, to match reply w/ request
1037     @param proto - protocol of the BIB: 255 - all BIBs
1038                                         6 - TCP BIB
1039                                         17 - UDP BIB
1040                                         1/58 - ICMP BIB
1041                                         otherwise - "unknown" protocol BIB
1042 */
1043 define nat64_bib_dump {
1044   u32 client_index;
1045   u32 context;
1046   u8 proto;
1047 };
1048
1049 /** \brief NAT64 BIB details response
1050     @param context - sender context, to match reply w/ request
1051     @param i_addr - inside IPv6 address
1052     @param o_addr - outside IPv4 address
1053     @param i_port - inside port number
1054     @param o_port - outside port number
1055     @param vrf_id - VRF id of tenant
1056     @param proto - protocol number
1057     @param is_static - 1 if static BIB entry, 0 if dynamic
1058     @param ses_num - number of sessions associated with the BIB entry
1059 */
1060 define nat64_bib_details {
1061   u32 context;
1062   u8 i_addr[16];
1063   u8 o_addr[4];
1064   u16 i_port;
1065   u16 o_port;
1066   u32 vrf_id;
1067   u8 proto;
1068   u8 is_static;
1069   u32 ses_num;
1070 };
1071
1072 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1073     @param client_index - opaque cookie to identify the sender
1074     @param context - sender context, to match reply w/ request
1075     @param udp - UDP timeout (default 300sec)
1076     @param icmp - ICMP timeout (default 60sec)
1077     @param tcp_trans - TCP transitory timeout (default 240sec)
1078     @param tcp_est - TCP established timeout (default 7440sec)
1079     @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1080 */
1081 autoreply define nat64_set_timeouts {
1082   u32 client_index;
1083   u32 context;
1084   u32 udp;
1085   u32 icmp;
1086   u32 tcp_trans;
1087   u32 tcp_est;
1088   u32 tcp_incoming_syn;
1089 };
1090
1091 /** \brief Get values of timeouts for NAT64 (seconds)
1092     @param client_index - opaque cookie to identify the sender
1093     @param context - sender context, to match reply w/ request
1094 */
1095 define nat64_get_timeouts {
1096   u32 client_index;
1097   u32 context;
1098 };
1099
1100 /** \brief Get values of timeouts for NAT64 reply
1101     @param context - sender context, to match reply w/ request
1102     @param retval - return code
1103     @param udp - UDP timeout
1104     @param icmp - ICMP timeout
1105     @param tcp_trans - TCP transitory timeout
1106     @param tcp_est - TCP established timeout
1107     @param tcp_incoming_syn - TCP incoming SYN timeout
1108 */
1109 define nat64_get_timeouts_reply {
1110   u32 context;
1111   i32 retval;
1112   u32 udp;
1113   u32 icmp;
1114   u32 tcp_trans;
1115   u32 tcp_est;
1116   u32 tcp_incoming_syn;
1117 };
1118
1119 /** \brief Dump NAT64 session table
1120     @param client_index - opaque cookie to identify the sender
1121     @param context - sender context, to match reply w/ request
1122     @param proto - protocol of the session table: 255 - all STs
1123                                                   6 - TCP ST
1124                                                   17 - UDP ST
1125                                                   1/58 - ICMP ST
1126                                                   otherwise - "unknown" proto ST
1127 */
1128 define nat64_st_dump {
1129   u32 client_index;
1130   u32 context;
1131   u8 proto;
1132 };
1133
1134 /** \brief NAT64 session table details response
1135     @param context - sender context, to match reply w/ request
1136     @param il_addr - inside IPv6 address of the local host
1137     @param ol_addr - outside IPv4 address of the local host
1138     @param il_port - inside port number id of the local host/inside ICMP id
1139     @param ol_port - outside port number of the local host/outside ICMP id
1140     @param il_addr - inside IPv6 address of the remote host
1141     @param ol_addr - outside IPv4 address of the remote host
1142     @param l_port - port number of the remote host (not used for ICMP)
1143     @param vrf_id - VRF id of tenant
1144     @param proto - protocol number
1145 */
1146 define nat64_st_details {
1147   u32 context;
1148   u8 il_addr[16];
1149   u8 ol_addr[4];
1150   u16 il_port;
1151   u16 ol_port;
1152   u8 ir_addr[16];
1153   u8 or_addr[4];
1154   u16 r_port;
1155   u32 vrf_id;
1156   u8 proto;
1157 };
1158
1159 /** \brief Add/del NAT64 prefix
1160     @param client_index - opaque cookie to identify the sender
1161     @param context - sender context, to match reply w/ request
1162     @param prefix - NAT64 prefix
1163     @param prefix - NAT64 prefix length
1164     @param vrf_id - VRF id of tenant
1165     @param is_add - 1 if add, 0 if delete
1166 */
1167 autoreply define nat64_add_del_prefix {
1168   u32 client_index;
1169   u32 context;
1170   u8 prefix[16];
1171   u8 prefix_len;
1172   u32 vrf_id;
1173   u8 is_add;
1174 };
1175
1176 /** \brief Dump NAT64 prefix
1177     @param client_index - opaque cookie to identify the sender
1178     @param context - sender context, to match reply w/ request
1179 */
1180 define nat64_prefix_dump {
1181   u32 client_index;
1182   u32 context;
1183 };
1184
1185 /** \brief Dump NAT64 prefix details response
1186     @param context - sender context, to match reply w/ request
1187     @param prefix - NAT64 prefix
1188     @param prefix - NAT64 prefix length
1189     @param vrf_id - VRF id of tenant
1190 */
1191 define nat64_prefix_details {
1192   u32 context;
1193   u8 prefix[16];
1194   u8 prefix_len;
1195   u32 vrf_id;
1196 };
1197
1198 /** \brief Add/delete NAT64 pool address from specific interfce
1199     @param client_index - opaque cookie to identify the sender
1200     @param context - sender context, to match reply w/ request
1201     @param is_add - 1 if add, 0 if delete
1202     @param sw_if_index - software index of the interface
1203 */
1204 autoreply define nat64_add_del_interface_addr {
1205   u32 client_index;
1206   u32 context;
1207   u8 is_add;
1208   u8 is_inside;
1209   u32 sw_if_index;
1210 };
1211
1212
1213 /*
1214  * DS-Lite APIs
1215  */
1216
1217 /** \brief Add/delete address range to DS-Lite pool
1218     @param client_index - opaque cookie to identify the sender
1219     @param context - sender context, to match reply w/ request
1220     @param start_addr - start address of the range
1221     @param end_addr - end address of the range
1222     @param is_add - 1 if add, 0 if delete
1223 */
1224 autoreply define dslite_add_del_pool_addr_range {
1225   u32 client_index;
1226   u32 context;
1227   u8 start_addr[4];
1228   u8 end_addr[4];
1229   u8 is_add;
1230 };
1231
1232 /** \brief Dump DS-Lite addresses
1233     @param client_index - opaque cookie to identify the sender
1234     @param context - sender context, to match reply w/ request
1235 */
1236 define dslite_address_dump {
1237   u32 client_index;
1238   u32 context;
1239 };
1240
1241 /** \brief DS-Lite address details response
1242     @param context - sender context, to match reply w/ request
1243     @param ip_address - IPv4 address
1244 */
1245 define dslite_address_details {
1246   u32 context;
1247   u8 ip_address[4];
1248 };
1249
1250 /** \brief Set AFTR IPv6 and IPv4 addresses
1251     @param client_index - opaque cookie to identify the sender
1252     @param context - sender context, to match reply w/ request
1253     @param ip4_addr - IPv4 address
1254     @param ip6_addr - IP64 address
1255 */
1256 autoreply define dslite_set_aftr_addr {
1257   u32 client_index;
1258   u32 context;
1259   u8 ip4_addr[4];
1260   u8 ip6_addr[16];
1261 };
1262
1263 /** \brief Get AFTR IPv6 and IPv4 addresses
1264     @param client_index - opaque cookie to identify the sender
1265     @param context - sender context, to match reply w/ request
1266 */
1267 define dslite_get_aftr_addr {
1268   u32 client_index;
1269   u32 context;
1270 };
1271
1272 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1273     @param context - sender context, to match reply w/ request
1274     @param retval - return code
1275     @param ip4_addr - IPv4 address
1276     @param ip6_addr - IP64 address
1277 */
1278 define dslite_get_aftr_addr_reply {
1279   u32 context;
1280   i32 retval;
1281   u8 ip4_addr[4];
1282   u8 ip6_addr[16];
1283 };
1284
1285 /** \brief Set B4 IPv6 and IPv4 addresses
1286     @param client_index - opaque cookie to identify the sender
1287     @param context - sender context, to match reply w/ request
1288     @param ip4_addr - IPv4 address
1289     @param ip6_addr - IP64 address
1290 */
1291 autoreply define dslite_set_b4_addr {
1292   u32 client_index;
1293   u32 context;
1294   u8 ip4_addr[4];
1295   u8 ip6_addr[16];
1296 };
1297
1298 /** \brief Get B4 IPv6 and IPv4 addresses
1299     @param client_index - opaque cookie to identify the sender
1300     @param context - sender context, to match reply w/ request
1301 */
1302 define dslite_get_b4_addr {
1303   u32 client_index;
1304   u32 context;
1305 };
1306
1307 /** \brief Response to get B4 IPv6 and IPv4 addresses
1308     @param context - sender context, to match reply w/ request
1309     @param retval - return code
1310     @param ip4_addr - IPv4 address
1311     @param ip6_addr - IP64 address
1312 */
1313 define dslite_get_b4_addr_reply {
1314   u32 context;
1315   i32 retval;
1316   u8 ip4_addr[4];
1317   u8 ip6_addr[16];
1318 };
1319
1320 /*
1321  * NAT66 APIs
1322  */
1323 /** \brief Enable/disable NAT66 feature on the interface
1324     @param client_index - opaque cookie to identify the sender
1325     @param context - sender context, to match reply w/ request
1326     @param is_add - 1 if add, 0 if delete
1327     @param is_inside - 1 if inside, 0 if outside
1328     @param sw_if_index - software index of the interface
1329 */
1330 autoreply define nat66_add_del_interface {
1331   u32 client_index;
1332   u32 context;
1333   u8 is_add;
1334   u8 is_inside;
1335   u32 sw_if_index;
1336 };
1337
1338 /** \brief Dump interfaces with NAT66 feature
1339     @param client_index - opaque cookie to identify the sender
1340     @param context - sender context, to match reply w/ request
1341 */
1342 define nat66_interface_dump {
1343   u32 client_index;
1344   u32 context;
1345 };
1346
1347 /** \brief NAT66 interface details response
1348     @param context - sender context, to match reply w/ request
1349     @param is_inside - 1 if inside, 0 if outside
1350     @param sw_if_index - software index of the interface
1351 */
1352 define nat66_interface_details {
1353   u32 context;
1354   u8 is_inside;
1355   u32 sw_if_index;
1356 };
1357
1358 /** \brief Add/delete 1:1 NAT66
1359     @param client_index - opaque cookie to identify the sender
1360     @param context - sender context, to match reply w/ request
1361     @param is_add - 1 if add, 0 if delete
1362     @param local_ip_address - local IPv6 address
1363     @param external_ip_address - external IPv6 address
1364     @param vrf_id - VRF id of tenant
1365 */
1366 autoreply define nat66_add_del_static_mapping {
1367   u32 client_index;
1368   u32 context;
1369   u8 is_add;
1370   u8 local_ip_address[16];
1371   u8 external_ip_address[16];
1372   u32 vrf_id;
1373 };
1374
1375 /** \brief Dump NAT66 static mappings
1376     @param client_index - opaque cookie to identify the sender
1377     @param context - sender context, to match reply w/ request
1378 */
1379 define nat66_static_mapping_dump {
1380   u32 client_index;
1381   u32 context;
1382 };
1383
1384 /** \brief NAT66 static mapping details response
1385     @param context - sender context, to match reply w/ request
1386     @param local_ip_address - local IPv6 address
1387     @param external_ip_address - external IPv6 address
1388     @param vrf_id - VRF id of tenant
1389     @param total_bytes - count of bytes sent through static mapping
1390     @param total_pkts - count of pakets sent through static mapping
1391 */
1392 define nat66_static_mapping_details {
1393   u32 context;
1394   u8 local_ip_address[16];
1395   u8 external_ip_address[16];
1396   u32 vrf_id;
1397   u64 total_bytes;
1398   u64 total_pkts;
1399 };