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