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 vl_api_version 2.2.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
 347     @param local_port - local port number
 348     @param external_port - external port number
 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 */
 356 autoreply define nat44_add_del_static_mapping {
 357   u32 client_index;
 358   u32 context;
 359   u8 is_add;
 360   u8 addr_only;
 361   u8 local_ip_address[4];
 362   u8 external_ip_address[4];
 363   u8 protocol;
 364   u16 local_port;
 365   u16 external_port;
 366   u32 external_sw_if_index;
 367   u32 vrf_id;
 368   u8 twice_nat;
 369 };
 370
 371 /** \brief Dump NAT44 static mappings
 372     @param client_index - opaque cookie to identify the sender
 373     @param context - sender context, to match reply w/ request
 374 */
 375 define nat44_static_mapping_dump {
 376   u32 client_index;
 377   u32 context;
 378 };
 379
 380 /** \brief NAT44 static mapping details response
 381     @param context - sender context, to match reply w/ request
 382     @param addr_only - 1 if address only mapping
 383     @param local_ip_address - local IPv4 address
 384     @param external_ip_address - external IPv4 address
 385     @param protocol - IP protocol
 386     @param local_port - local port number
 387     @param external_port - external port number
 388     @param external_sw_if_index - external interface
 389     @param vfr_id - VRF ID
 390     @param twice_nat - if 1 translate external host address and port
 391 */
 392 define nat44_static_mapping_details {
 393   u32 context;
 394   u8 addr_only;
 395   u8 local_ip_address[4];
 396   u8 external_ip_address[4];
 397   u8 protocol;
 398   u16 local_port;
 399   u16 external_port;
 400   u32 external_sw_if_index;
 401   u32 vrf_id;
 402   u8 twice_nat;
 403 };
 404
 405 /** \brief Add/delete NAT44 identity mapping
 406     @param client_index - opaque cookie to identify the sender
 407     @param context - sender context, to match reply w/ request
 408     @param is_add - 1 if add, 0 if delete
 409     @param addr_only - 1 if address only mapping
 410     @param ip_address - IPv4 address
 411     @param protocol - IP protocol
 412     @param port - port number
 413     @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
 414                                     used)
 415     @param vfr_id - VRF ID (if ~0 use default VRF)
 416 */
 417 autoreply define nat44_add_del_identity_mapping {
 418   u32 client_index;
 419   u32 context;
 420   u8 is_add;
 421   u8 addr_only;
 422   u8 ip_address[4];
 423   u8 protocol;
 424   u16 port;
 425   u32 sw_if_index;
 426   u32 vrf_id;
 427 };
 428
 429 /** \brief Dump NAT44 identity mappings
 430     @param client_index - opaque cookie to identify the sender
 431     @param context - sender context, to match reply w/ request
 432 */
 433 define nat44_identity_mapping_dump {
 434   u32 client_index;
 435   u32 context;
 436 };
 437
 438 /** \brief NAT44 identity mapping details response
 439     @param context - sender context, to match reply w/ request
 440     @param addr_only - 1 if address only mapping
 441     @param ip_address - IPv4 address
 442     @param protocol - IP protocol
 443     @param port - port number
 444     @param sw_if_index - interface
 445     @param vfr_id - VRF ID
 446 */
 447 define nat44_identity_mapping_details {
 448   u32 context;
 449   u8 addr_only;
 450   u8 ip_address[4];
 451   u8 protocol;
 452   u16 port;
 453   u32 sw_if_index;
 454   u32 vrf_id;
 455 };
 456
 457 /** \brief Add/delete NAT44 pool address from specific interfce
 458     @param client_index - opaque cookie to identify the sender
 459     @param context - sender context, to match reply w/ request
 460     @param is_add - 1 if add, 0 if delete
 461     @param twice_nat - twice NAT address for extenal hosts
 462     @param sw_if_index - software index of the interface
 463 */
 464 autoreply define nat44_add_del_interface_addr {
 465   u32 client_index;
 466   u32 context;
 467   u8 is_add;
 468   u8 twice_nat;
 469   u32 sw_if_index;
 470 };
 471
 472 /** \brief Dump NAT44 pool addresses interfaces
 473     @param client_index - opaque cookie to identify the sender
 474     @param context - sender context, to match reply w/ request
 475 */
 476 define nat44_interface_addr_dump {
 477   u32 client_index;
 478   u32 context;
 479 };
 480
 481 /** \brief NAT44 pool addresses interfaces details response
 482     @param context - sender context, to match reply w/ request
 483     @param sw_if_index - software index of the interface
 484     @param twice_nat - twice NAT address for extenal hosts
 485 */
 486 define nat44_interface_addr_details {
 487   u32 context;
 488   u32 sw_if_index;
 489   u8 twice_nat;
 490 };
 491
 492 /** \brief Dump NAT44 users
 493     @param client_index - opaque cookie to identify the sender
 494     @param context - sender context, to match reply w/ request
 495 */
 496 define nat44_user_dump {
 497   u32 client_index;
 498   u32 context;
 499 };
 500
 501 /** \brief NAT44 users response
 502     @param context - sender context, to match reply w/ request
 503     @vrf_id - VRF ID
 504     @param ip_adress - IPv4 address
 505     @param nsessions - number of dynamic sessions
 506     @param nstaticsessions - number of static sessions
 507 */
 508 define nat44_user_details {
 509   u32 context;
 510   u32 vrf_id;
 511   u8 ip_address[4];
 512   u32 nsessions;
 513   u32 nstaticsessions;
 514 };
 515
 516 /** \brief NAT44 user's sessions
 517     @param client_index - opaque cookie to identify the sender
 518     @param context - sender context, to match reply w/ request
 519     @param is_ip4 - 1 if address type is IPv4
 520     @param user_ip - IP address of the user to dump
 521     @param vrf_id - VRF_ID
 522 */
 523 define nat44_user_session_dump {
 524   u32 client_index;
 525   u32 context;
 526   u8 ip_address[4];
 527   u32 vrf_id;
 528 };
 529
 530 /** \brief NAT44 user's sessions response
 531     @param context - sender context, to match reply w/ request
 532     @param outside_ip_address - outside IPv4 address
 533     @param outside_port - outside port
 534     @param inside_ip_address - inside IPv4 address
 535     @param inside_port - inside port
 536     @param protocol - protocol
 537     @param is_static - 1 if session is static
 538     @param last_heard - last heard timer
 539     @param total_bytes - count of bytes sent through session
 540     @param total_pkts - count of pakets sent through session
 541 */
 542 define nat44_user_session_details {
 543   u32 context;
 544   u8 outside_ip_address[4];
 545   u16 outside_port;
 546   u8 inside_ip_address[4];
 547   u16 inside_port;
 548   u16 protocol;
 549   u8 is_static;
 550   u64 last_heard;
 551   u64 total_bytes;
 552   u32 total_pkts;
 553 };
 554
 555 typeonly manual_endian define nat44_lb_addr_port {
 556   u8 addr[4];
 557   u16 port;
 558   u8 probability;
 559 };
 560
 561 autoreply manual_endian define nat44_add_del_lb_static_mapping {
 562   u32 client_index;
 563   u32 context;
 564   u8 is_add;
 565   u8 external_addr[4];
 566   u16 external_port;
 567   u8 protocol;
 568   u32 vrf_id;
 569   u8 twice_nat;
 570   u8 out2in_only;
 571   u8 local_num;
 572   vl_api_nat44_lb_addr_port_t locals[local_num];
 573 };
 574
 575 define nat44_lb_static_mapping_dump {
 576   u32 client_index;
 577   u32 context;
 578 };
 579
 580 manual_endian define nat44_lb_static_mapping_details {
 581   u32 context;
 582   u8 external_addr[4];
 583   u16 external_port;
 584   u8 protocol;
 585   u32 vrf_id;
 586   u8 twice_nat;
 587   u8 out2in_only;
 588   u8 local_num;
 589   vl_api_nat44_lb_addr_port_t locals[local_num];
 590 };
 591
 592 /** \brief Delete NAT44 session
 593     @param client_index - opaque cookie to identify the sender
 594     @param context - sender context, to match reply w/ request
 595     @param is_in - 1 if inside network addres and port pari, 0 if outside
 596     @param ip_address - IPv4 address
 597     @param protocol - IP protocol
 598     @param port - port number
 599     @param vfr_id - VRF ID
 600 */
 601 autoreply define nat44_del_session {
 602   u32 client_index;
 603   u32 context;
 604   u8 is_in;
 605   u8 address[4];
 606   u8 protocol;
 607   u16 port;
 608   u32 vrf_id;
 609 };
 610
 611 /** \brief Enable/disable forwarding for NAT44
 612     Forward packets which don't match existing translation
 613     or static mapping instead of dropping them.
 614     @param client_index - opaque cookie to identify the sender
 615     @param context - sender context, to match reply w/ request
 616     @param enable - 0 for enable, 1 for disable
 617 */
 618 autoreply define nat44_forwarding_enable_disable {
 619   u32 client_index;
 620   u32 context;
 621   u8 enable;
 622 };
 623
 624 /** \brief Check if forwarding is enabled or disabled
 625     @param client_index - opaque cookie to identify the sender
 626     @param context - sender context, to match reply w/ request
 627 */
 628 define nat44_forwarding_is_enabled {
 629   u32 client_index;
 630   u32 context;
 631 };
 632
 633 /** \brief Response to check if forwarding is enabled or disabled
 634     @param context - sender context, to match reply w/ request
 635     @param enabled - 1 if enabled, 0 if disabled
 636 */
 637 define nat44_forwarding_is_enabled_reply {
 638   u32 context;
 639   u8 enabled;
 640 };
 641
 642
 643 /*
 644  * Deterministic NAT (CGN) APIs
 645  */
 646
 647 /** \brief Add/delete NAT deterministic mapping
 648     @param client_index - opaque cookie to identify the sender
 649     @param context - sender context, to match reply w/ request
 650     @param is_add - 1 if add, 0 if delete
 651     @param is_nat44 - 1 if NAT44
 652     @param in_addr - inside IP address
 653     @param in_plen - inside IP address prefix length
 654     @param out_addr - outside IPv4 address
 655     @param out_addr - outside IPv4 address prefix length
 656 */
 657 autoreply define nat_det_add_del_map {
 658   u32 client_index;
 659   u32 context;
 660   u8 is_add;
 661   u8 is_nat44;
 662   u8 addr_only;
 663   u8 in_addr[16];
 664   u8 in_plen;
 665   u8 out_addr[4];
 666   u8 out_plen;
 667 };
 668
 669 /** \brief Get outside address and port range from inside address
 670     @param client_index - opaque cookie to identify the sender
 671     @param context - sender context, to match reply w/ request
 672     @param is_nat44 - 1 if NAT44
 673     @param in_addr - inside IP address
 674 */
 675 define nat_det_forward {
 676   u32 client_index;
 677   u32 context;
 678   u8 is_nat44;
 679   u8 in_addr[16];
 680 };
 681
 682 /** \brief Get outside address and port range from inside address
 683     @param context - sender context, to match reply w/ request
 684     @param retval - return code
 685     @param out_port_lo - outside port range start
 686     @param out_port_hi - outside port range end
 687     @param out_addr - outside IPv4 address
 688 */
 689 define nat_det_forward_reply {
 690   u32 context;
 691   i32 retval;
 692   u16 out_port_lo;
 693   u16 out_port_hi;
 694   u8 out_addr[4];
 695 };
 696
 697 /** \brief Get inside address from outside address and port
 698     @param client_index - opaque cookie to identify the sender
 699     @param context - sender context, to match reply w/ request
 700     @param out_port - outside port
 701     @param out_addr - outside IPv4 address
 702 */
 703 define nat_det_reverse {
 704   u32 client_index;
 705   u32 context;
 706   u16 out_port;
 707   u8 out_addr[4];
 708 };
 709
 710 /** \brief Get inside address from outside address and port reply
 711     @param context - sender context, to match reply w/ request
 712     @param retval - return code
 713     @param is_nat44 - 1 if NAT44
 714     @param in_addr - inside IP address
 715 */
 716 define nat_det_reverse_reply {
 717   u32 context;
 718   i32 retval;
 719   u8 is_nat44;
 720   u8 in_addr[16];
 721 };
 722
 723 /** \brief Dump NAT deterministic mappings
 724     @param client_index - opaque cookie to identify the sender
 725     @param context - sender context, to match reply w/ request
 726 */
 727 define nat_det_map_dump {
 728   u32 client_index;
 729   u32 context;
 730 };
 731
 732 /** \brief NAT users response
 733     @param context - sender context, to match reply w/ request
 734     @param is_nat44 - 1 if NAT44
 735     @param in_addr - inside IP address
 736     @param in_plen - inside IP address prefix length
 737     @param out_addr - outside IPv4 address
 738     @param out_plen - outside IPv4 address prefix length
 739     @param sharing_ratio - outside to inside address sharing ratio
 740     @param ports_per_host - number of ports available to a host
 741     @param ses_num - number of sessions belonging to this mapping
 742 */
 743 define nat_det_map_details {
 744   u32 context;
 745   u8 is_nat44;
 746   u8 in_addr[16];
 747   u8 in_plen;
 748   u8 out_addr[4];
 749   u8 out_plen;
 750   u32 sharing_ratio;
 751   u16 ports_per_host;
 752   u32 ses_num;
 753 };
 754
 755 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
 756     @param client_index - opaque cookie to identify the sender
 757     @param context - sender context, to match reply w/ request
 758     @param udp - UDP timeout (default 300sec)
 759     @param tcp_established - TCP established timeout (default 7440sec)
 760     @param tcp_transitory - TCP transitory timeout (default 240sec)
 761     @param icmp - ICMP timeout (default 60sec)
 762 */
 763 autoreply define nat_det_set_timeouts {
 764   u32 client_index;
 765   u32 context;
 766   u32 udp;
 767   u32 tcp_established;
 768   u32 tcp_transitory;
 769   u32 icmp;
 770 };
 771
 772 /** \brief Get values of timeouts for deterministic NAT (seconds)
 773     @param client_index - opaque cookie to identify the sender
 774     @param context - sender context, to match reply w/ request
 775 */
 776 define nat_det_get_timeouts {
 777   u32 client_index;
 778   u32 context;
 779 };
 780
 781 /** \brief Get values of timeouts for deterministic NAT reply
 782     @param context - sender context, to match reply w/ request
 783     @param retval - return code
 784     @param udp - UDP timeout (default 300sec)
 785     @param tcp_established - TCP established timeout (default 7440sec)
 786     @param tcp_transitory - TCP transitory timeout (default 240sec)
 787     @param icmp - ICMP timeout (default 60sec)
 788 */
 789 define nat_det_get_timeouts_reply {
 790   u32 context;
 791   i32 retval;
 792   u32 udp;
 793   u32 tcp_established;
 794   u32 tcp_transitory;
 795   u32 icmp;
 796 };
 797
 798 /** \brief Close deterministic NAT session by outside address and port
 799     @param client_index - opaque cookie to identify the sender
 800     @param context - sender context, to match reply w/ request
 801     @param out_addr - outside IPv4 address
 802     @param out_port - outside port
 803     @param ext_addr - external host IPv4 address
 804     @param ext_port - external host port
 805 */
 806 autoreply define nat_det_close_session_out {
 807   u32 client_index;
 808   u32 context;
 809   u8 out_addr[4];
 810   u16 out_port;
 811   u8 ext_addr[4];
 812   u16 ext_port;
 813 };
 814
 815 /** \brief Close deterministic NAT session by inside address and port
 816     @param client_index - opaque cookie to identify the sender
 817     @param context - sender context, to match reply w/ request
 818     @param is_nat44 - 1 if NAT44
 819     @param in_addr - inside IP address
 820     @param in_port - inside port
 821     @param ext_addr - external host IP address
 822     @param ext_port - external host port
 823 */
 824 autoreply define nat_det_close_session_in {
 825   u32 client_index;
 826   u32 context;
 827   u8 is_nat44;
 828   u8 in_addr[16];
 829   u16 in_port;
 830   u8 ext_addr[16];
 831   u16 ext_port;
 832 };
 833
 834 /** \brief Dump determinstic NAT sessions
 835     @param client_index - opaque cookie to identify the sender
 836     @param context - sender context, to match reply w/ request
 837     @param is_nat44 - 1 if NAT44
 838     @param user_addr - address of an inside user whose sessions to dump
 839 */
 840 define nat_det_session_dump {
 841   u32 client_index;
 842   u32 context;
 843   u8 is_nat44;
 844   u8 user_addr[16];
 845 };
 846
 847 /** \brief Deterministic NAT sessions reply
 848     @param context - sender context, to match reply w/ request
 849     @param in_port - inside port
 850     @param ext_addr - external host address
 851     @param ext_port - external host port
 852     @param out_port - outside NAT port
 853     @param state - session state
 854     @param expire - session expiration timestamp
 855 */
 856 define nat_det_session_details {
 857   u32 client_index;
 858   u32 context;
 859   u16 in_port;
 860   u8 ext_addr[4];
 861   u16 ext_port;
 862   u16 out_port;
 863   u8 state;
 864   u32 expire;
 865 };
 866
 867 /*
 868  * NAT64 APIs
 869  */
 870
 871 /** \brief Add/delete address range to NAT64 pool
 872     @param client_index - opaque cookie to identify the sender
 873     @param context - sender context, to match reply w/ request
 874     @param start_addr - start address of the range
 875     @param end_addr - end address of the range
 876     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 877     @param is_add - 1 if add, 0 if delete
 878 */
 879 autoreply define nat64_add_del_pool_addr_range {
 880   u32 client_index;
 881   u32 context;
 882   u8 start_addr[4];
 883   u8 end_addr[4];
 884   u32 vrf_id;
 885   u8 is_add;
 886 };
 887
 888 /** \brief Dump NAT64 pool addresses
 889     @param client_index - opaque cookie to identify the sender
 890     @param context - sender context, to match reply w/ request
 891 */
 892 define nat64_pool_addr_dump {
 893   u32 client_index;
 894   u32 context;
 895 };
 896
 897 /** \brief NAT64 pool address details response
 898     @param context - sender context, to match reply w/ request
 899     @param address - IPv4 address
 900     @param vfr_id - VRF id of tenant, ~0 means independent of VRF
 901 */
 902 define nat64_pool_addr_details {
 903   u32 context;
 904   u8 address[4];
 905   u32 vrf_id;
 906 };
 907
 908 /** \brief Enable/disable NAT64 feature on the interface
 909     @param client_index - opaque cookie to identify the sender
 910     @param context - sender context, to match reply w/ request
 911     @param sw_if_index - index of the interface
 912     @param is_inside - 1 if inside, 0 if outside
 913     @param is_add - 1 if add, 0 if delete
 914 */
 915 autoreply define nat64_add_del_interface {
 916   u32 client_index;
 917   u32 context;
 918   u32 sw_if_index;
 919   u8 is_inside;
 920   u8 is_add;
 921 };
 922
 923 /** \brief Dump interfaces with NAT64 feature
 924     @param client_index - opaque cookie to identify the sender
 925     @param context - sender context, to match reply w/ request
 926 */
 927 define nat64_interface_dump {
 928   u32 client_index;
 929   u32 context;
 930 };
 931
 932 /** \brief NAT64 interface details response
 933     @param context - sender context, to match reply w/ request
 934     @param is_inside - 1 if inside, 0 if outside
 935     @param sw_if_index - index of the interface
 936 */
 937 define nat64_interface_details {
 938   u32 context;
 939   u8 is_inside;
 940   u32 sw_if_index;
 941 };
 942
 943 /** \brief Add/delete NAT64 static BIB entry
 944     @param client_index - opaque cookie to identify the sender
 945     @param context - sender context, to match reply w/ request
 946     @param i_addr - inside IPv6 address
 947     @param o_addr - outside IPv4 address
 948     @param i_port - inside port number
 949     @param o_port - outside port number
 950     @param vrf_id - VRF id of tenant
 951     @param proto - protocol number
 952     @param is_add - 1 if add, 0 if delete
 953 */
 954  autoreply define nat64_add_del_static_bib {
 955   u32 client_index;
 956   u32 context;
 957   u8 i_addr[16];
 958   u8 o_addr[4];
 959   u16 i_port;
 960   u16 o_port;
 961   u32 vrf_id;
 962   u8 proto;
 963   u8 is_add;
 964 };
 965
 966 /** \brief Dump NAT64 BIB
 967     @param client_index - opaque cookie to identify the sender
 968     @param context - sender context, to match reply w/ request
 969     @param proto - protocol of the BIB: 255 - all BIBs
 970                                         6 - TCP BIB
 971                                         17 - UDP BIB
 972                                         1/58 - ICMP BIB
 973                                         otherwise - "unknown" protocol BIB
 974 */
 975 define nat64_bib_dump {
 976   u32 client_index;
 977   u32 context;
 978   u8 proto;
 979 };
 980
 981 /** \brief NAT64 BIB details response
 982     @param context - sender context, to match reply w/ request
 983     @param i_addr - inside IPv6 address
 984     @param o_addr - outside IPv4 address
 985     @param i_port - inside port number
 986     @param o_port - outside port number
 987     @param vrf_id - VRF id of tenant
 988     @param proto - protocol number
 989     @param is_static - 1 if static BIB entry, 0 if dynamic
 990     @param ses_num - number of sessions associated with the BIB entry
 991 */
 992 define nat64_bib_details {
 993   u32 context;
 994   u8 i_addr[16];
 995   u8 o_addr[4];
 996   u16 i_port;
 997   u16 o_port;
 998   u32 vrf_id;
 999   u8 proto;
1000   u8 is_static;
1001   u32 ses_num;
1002 };
1003
1004 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1005     @param client_index - opaque cookie to identify the sender
1006     @param context - sender context, to match reply w/ request
1007     @param udp - UDP timeout (default 300sec)
1008     @param icmp - ICMP timeout (default 60sec)
1009     @param tcp_trans - TCP transitory timeout (default 240sec)
1010     @param tcp_est - TCP established timeout (default 7440sec)
1011     @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1012 */
1013 autoreply define nat64_set_timeouts {
1014   u32 client_index;
1015   u32 context;
1016   u32 udp;
1017   u32 icmp;
1018   u32 tcp_trans;
1019   u32 tcp_est;
1020   u32 tcp_incoming_syn;
1021 };
1022
1023 /** \brief Get values of timeouts for NAT64 (seconds)
1024     @param client_index - opaque cookie to identify the sender
1025     @param context - sender context, to match reply w/ request
1026 */
1027 define nat64_get_timeouts {
1028   u32 client_index;
1029   u32 context;
1030 };
1031
1032 /** \brief Get values of timeouts for NAT64 reply
1033     @param context - sender context, to match reply w/ request
1034     @param retval - return code
1035     @param udp - UDP timeout
1036     @param icmp - ICMP timeout
1037     @param tcp_trans - TCP transitory timeout
1038     @param tcp_est - TCP established timeout
1039     @param tcp_incoming_syn - TCP incoming SYN timeout
1040 */
1041 define nat64_get_timeouts_reply {
1042   u32 context;
1043   i32 retval;
1044   u32 udp;
1045   u32 icmp;
1046   u32 tcp_trans;
1047   u32 tcp_est;
1048   u32 tcp_incoming_syn;
1049 };
1050
1051 /** \brief Dump NAT64 session table
1052     @param client_index - opaque cookie to identify the sender
1053     @param context - sender context, to match reply w/ request
1054     @param proto - protocol of the session table: 255 - all STs
1055                                                   6 - TCP ST
1056                                                   17 - UDP ST
1057                                                   1/58 - ICMP ST
1058                                                   otherwise - "unknown" proto ST
1059 */
1060 define nat64_st_dump {
1061   u32 client_index;
1062   u32 context;
1063   u8 proto;
1064 };
1065
1066 /** \brief NAT64 session table details response
1067     @param context - sender context, to match reply w/ request
1068     @param il_addr - inside IPv6 address of the local host
1069     @param ol_addr - outside IPv4 address of the local host
1070     @param il_port - inside port number id of the local host/inside ICMP id
1071     @param ol_port - outside port number of the local host/outside ICMP id
1072     @param il_addr - inside IPv6 address of the remote host
1073     @param ol_addr - outside IPv4 address of the remote host
1074     @param l_port - port number of the remote host (not used for ICMP)
1075     @param vrf_id - VRF id of tenant
1076     @param proto - protocol number
1077 */
1078 define nat64_st_details {
1079   u32 context;
1080   u8 il_addr[16];
1081   u8 ol_addr[4];
1082   u16 il_port;
1083   u16 ol_port;
1084   u8 ir_addr[16];
1085   u8 or_addr[4];
1086   u16 r_port;
1087   u32 vrf_id;
1088   u8 proto;
1089 };
1090
1091 /** \brief Add/del NAT64 prefix
1092     @param client_index - opaque cookie to identify the sender
1093     @param context - sender context, to match reply w/ request
1094     @param prefix - NAT64 prefix
1095     @param prefix - NAT64 prefix length
1096     @param vrf_id - VRF id of tenant
1097     @param is_add - 1 if add, 0 if delete
1098 */
1099 autoreply define nat64_add_del_prefix {
1100   u32 client_index;
1101   u32 context;
1102   u8 prefix[16];
1103   u8 prefix_len;
1104   u32 vrf_id;
1105   u8 is_add;
1106 };
1107
1108 /** \brief Dump NAT64 prefix
1109     @param client_index - opaque cookie to identify the sender
1110     @param context - sender context, to match reply w/ request
1111 */
1112 define nat64_prefix_dump {
1113   u32 client_index;
1114   u32 context;
1115 };
1116
1117 /** \brief Dump NAT64 prefix details response
1118     @param context - sender context, to match reply w/ request
1119     @param prefix - NAT64 prefix
1120     @param prefix - NAT64 prefix length
1121     @param vrf_id - VRF id of tenant
1122 */
1123 define nat64_prefix_details {
1124   u32 context;
1125   u8 prefix[16];
1126   u8 prefix_len;
1127   u32 vrf_id;
1128 };
1129
1130 /** \brief Add/delete NAT64 pool address from specific interfce
1131     @param client_index - opaque cookie to identify the sender
1132     @param context - sender context, to match reply w/ request
1133     @param is_add - 1 if add, 0 if delete
1134     @param sw_if_index - software index of the interface
1135 */
1136 autoreply define nat64_add_del_interface_addr {
1137   u32 client_index;
1138   u32 context;
1139   u8 is_add;
1140   u8 is_inside;
1141   u32 sw_if_index;
1142 };
1143
1144
1145 /*
1146  * DS-Lite APIs
1147  */
1148
1149 /** \brief Add/delete address range to DS-Lite pool
1150     @param client_index - opaque cookie to identify the sender
1151     @param context - sender context, to match reply w/ request
1152     @param start_addr - start address of the range
1153     @param end_addr - end address of the range
1154     @param is_add - 1 if add, 0 if delete
1155 */
1156 autoreply define dslite_add_del_pool_addr_range {
1157   u32 client_index;
1158   u32 context;
1159   u8 start_addr[4];
1160   u8 end_addr[4];
1161   u8 is_add;
1162 };
1163
1164 /** \brief Set AFTR IPv6 and IPv4 addresses
1165     @param client_index - opaque cookie to identify the sender
1166     @param context - sender context, to match reply w/ request
1167     @param ip4_addr - IPv4 address
1168     @param ip6_addr - IP64 address
1169 */
1170 autoreply define dslite_set_aftr_addr {
1171   u32 client_index;
1172   u32 context;
1173   u8 ip4_addr[4];
1174   u8 ip6_addr[16];
1175 };
1176
1177 /** \brief Get AFTR IPv6 and IPv4 addresses
1178     @param client_index - opaque cookie to identify the sender
1179     @param context - sender context, to match reply w/ request
1180 */
1181 define dslite_get_aftr_addr {
1182   u32 client_index;
1183   u32 context;
1184 };
1185
1186 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1187     @param context - sender context, to match reply w/ request
1188     @param retval - return code
1189     @param ip4_addr - IPv4 address
1190     @param ip6_addr - IP64 address
1191 */
1192 define dslite_get_aftr_addr_reply {
1193   u32 context;
1194   i32 retval;
1195   u8 ip4_addr[4];
1196   u8 ip6_addr[16];
1197 };
1198
1199 /** \brief Set B4 IPv6 and IPv4 addresses
1200     @param client_index - opaque cookie to identify the sender
1201     @param context - sender context, to match reply w/ request
1202     @param ip4_addr - IPv4 address
1203     @param ip6_addr - IP64 address
1204 */
1205 autoreply define dslite_set_b4_addr {
1206   u32 client_index;
1207   u32 context;
1208   u8 ip4_addr[4];
1209   u8 ip6_addr[16];
1210 };
1211
1212 /** \brief Get B4 IPv6 and IPv4 addresses
1213     @param client_index - opaque cookie to identify the sender
1214     @param context - sender context, to match reply w/ request
1215 */
1216 define dslite_get_b4_addr {
1217   u32 client_index;
1218   u32 context;
1219 };
1220
1221 /** \brief Response to get B4 IPv6 and IPv4 addresses
1222     @param context - sender context, to match reply w/ request
1223     @param retval - return code
1224     @param ip4_addr - IPv4 address
1225     @param ip6_addr - IP64 address
1226 */
1227 define dslite_get_b4_addr_reply {
1228   u32 context;
1229   i32 retval;
1230   u8 ip4_addr[4];
1231   u8 ip6_addr[16];
1232 };