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.4.1";
  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 */
 562 define nat44_user_session_details {
 563   u32 context;
 564   u8 outside_ip_address[4];
 565   u16 outside_port;
 566   u8 inside_ip_address[4];
 567   u16 inside_port;
 568   u16 protocol;
 569   u8 is_static;
 570   u64 last_heard;
 571   u64 total_bytes;
 572   u32 total_pkts;
 573 };
 574
 575 /** \brief NAT44 load-balancing address and port pair
 576     @param addr - IPv4 address of the internal node
 577     @param port - L4 port number of the internal node
 578     @param probability - probability of the internal node to be randomly matched
 579 */
 580 typeonly manual_endian define nat44_lb_addr_port {
 581   u8 addr[4];
 582   u16 port;
 583   u8 probability;
 584 };
 585
 586 /** \brief Add/delete NAT44 load-balancing static mapping rule
 587     @param client_index - opaque cookie to identify the sender
 588     @param context - sender context, to match reply w/ request
 589     @param is_add - 1 if add, 0 if delete
 590     @param external_addr - external IPv4 address of the service
 591     @param external_port - external L4 port number of the service
 592     @param protocol - IP protocol number of the service
 593     @param vrf_id - internal network VRF ID
 594     @param twice_nat - if 1 translate external host address and port
 595     @param self_twice_nat - if 1 translate external host address and port
 596                             whenever external host address equals
 597                             local address of internal host
 598     @param out2in_only - if 1 rule match only out2in direction
 599     @param tag - opaque string tag
 600     @param local_num - number of local network nodes
 601     @param locals - local network nodes
 602 */
 603 autoreply manual_endian define nat44_add_del_lb_static_mapping {
 604   u32 client_index;
 605   u32 context;
 606   u8 is_add;
 607   u8 external_addr[4];
 608   u16 external_port;
 609   u8 protocol;
 610   u32 vrf_id;
 611   u8 twice_nat;
 612   u8 self_twice_nat;
 613   u8 out2in_only;
 614   u8 tag[64];
 615   u8 local_num;
 616   vl_api_nat44_lb_addr_port_t locals[local_num];
 617 };
 618
 619 /** \brief Dump NAT44 load-balancing static mapping rules
 620     @param client_index - opaque cookie to identify the sender
 621     @param context - sender context, to match reply w/ request
 622 */
 623 define nat44_lb_static_mapping_dump {
 624   u32 client_index;
 625   u32 context;
 626 };
 627
 628 /** \brief NAT44 load-balancing static mapping rule details response
 629     @param context - sender context, to match reply w/ request
 630     @param is_add - 1 if add, 0 if delete
 631     @param external_addr - external IPv4 address of the service
 632     @param external_port - external L4 port number of the service
 633     @param protocol - IP protocol number of the service
 634     @param vrf_id - internal network VRF ID
 635     @param twice_nat - if 1 translate external host address and port
 636     @param self_twice_nat - if 1 translate external host address and port
 637                             whenever external host address equals
 638                             local address of internal host
 639     @param out2in_only - if 1 rule match only out2in direction
 640     @param tag - opaque string tag
 641     @param local_num - number of local network nodes
 642     @param locals - local network nodes
 643 */
 644 manual_endian define nat44_lb_static_mapping_details {
 645   u32 context;
 646   u8 external_addr[4];
 647   u16 external_port;
 648   u8 protocol;
 649   u32 vrf_id;
 650   u8 twice_nat;
 651   u8 self_twice_nat;
 652   u8 out2in_only;
 653   u8 tag[64];
 654   u8 local_num;
 655   vl_api_nat44_lb_addr_port_t locals[local_num];
 656 };
 657
 658 /** \brief Delete NAT44 session
 659     @param client_index - opaque cookie to identify the sender
 660     @param context - sender context, to match reply w/ request
 661     @param is_in - 1 if inside network addres and port pari, 0 if outside
 662     @param ip_address - IPv4 address
 663     @param protocol - IP protocol
 664     @param port - port number
 665     @param vfr_id - VRF ID
 666 */
 667 autoreply define nat44_del_session {
 668   u32 client_index;
 669   u32 context;
 670   u8 is_in;
 671   u8 address[4];
 672   u8 protocol;
 673   u16 port;
 674   u32 vrf_id;
 675 };
 676
 677 /** \brief Enable/disable forwarding for NAT44
 678     Forward packets which don't match existing translation
 679     or static mapping instead of dropping them.
 680     @param client_index - opaque cookie to identify the sender
 681     @param context - sender context, to match reply w/ request
 682     @param enable - 0 for enable, 1 for disable
 683 */
 684 autoreply define nat44_forwarding_enable_disable {
 685   u32 client_index;
 686   u32 context;
 687   u8 enable;
 688 };
 689
 690 /** \brief Check if forwarding is enabled or disabled
 691     @param client_index - opaque cookie to identify the sender
 692     @param context - sender context, to match reply w/ request
 693 */
 694 define nat44_forwarding_is_enabled {
 695   u32 client_index;
 696   u32 context;
 697 };
 698
 699 /** \brief Response to check if forwarding is enabled or disabled
 700     @param context - sender context, to match reply w/ request
 701     @param enabled - 1 if enabled, 0 if disabled
 702 */
 703 define nat44_forwarding_is_enabled_reply {
 704   u32 context;
 705   u8 enabled;
 706 };
 707
 708
 709 /*
 710  * Deterministic NAT (CGN) APIs
 711  */
 712
 713 /** \brief Add/delete NAT deterministic mapping
 714     @param client_index - opaque cookie to identify the sender
 715     @param context - sender context, to match reply w/ request
 716     @param is_add - 1 if add, 0 if delete
 717     @param is_nat44 - 1 if NAT44
 718     @param in_addr - inside IP address
 719     @param in_plen - inside IP address prefix length
 720     @param out_addr - outside IPv4 address
 721     @param out_addr - outside IPv4 address prefix length
 722 */
 723 autoreply define nat_det_add_del_map {
 724   u32 client_index;
 725   u32 context;
 726   u8 is_add;
 727   u8 is_nat44;
 728   u8 addr_only;
 729   u8 in_addr[16];
 730   u8 in_plen;
 731   u8 out_addr[4];
 732   u8 out_plen;
 733 };
 734
 735 /** \brief Get outside address and port range from inside address
 736     @param client_index - opaque cookie to identify the sender
 737     @param context - sender context, to match reply w/ request
 738     @param is_nat44 - 1 if NAT44
 739     @param in_addr - inside IP address
 740 */
 741 define nat_det_forward {
 742   u32 client_index;
 743   u32 context;
 744   u8 is_nat44;
 745   u8 in_addr[16];
 746 };
 747
 748 /** \brief Get outside address and port range from inside address
 749     @param context - sender context, to match reply w/ request
 750     @param retval - return code
 751     @param out_port_lo - outside port range start
 752     @param out_port_hi - outside port range end
 753     @param out_addr - outside IPv4 address
 754 */
 755 define nat_det_forward_reply {
 756   u32 context;
 757   i32 retval;
 758   u16 out_port_lo;
 759   u16 out_port_hi;
 760   u8 out_addr[4];
 761 };
 762
 763 /** \brief Get inside address from outside address and port
 764     @param client_index - opaque cookie to identify the sender
 765     @param context - sender context, to match reply w/ request
 766     @param out_port - outside port
 767     @param out_addr - outside IPv4 address
 768 */
 769 define nat_det_reverse {
 770   u32 client_index;
 771   u32 context;
 772   u16 out_port;
 773   u8 out_addr[4];
 774 };
 775
 776 /** \brief Get inside address from outside address and port reply
 777     @param context - sender context, to match reply w/ request
 778     @param retval - return code
 779     @param is_nat44 - 1 if NAT44
 780     @param in_addr - inside IP address
 781 */
 782 define nat_det_reverse_reply {
 783   u32 context;
 784   i32 retval;
 785   u8 is_nat44;
 786   u8 in_addr[16];
 787 };
 788
 789 /** \brief Dump NAT deterministic mappings
 790     @param client_index - opaque cookie to identify the sender
 791     @param context - sender context, to match reply w/ request
 792 */
 793 define nat_det_map_dump {
 794   u32 client_index;
 795   u32 context;
 796 };
 797
 798 /** \brief NAT users response
 799     @param context - sender context, to match reply w/ request
 800     @param is_nat44 - 1 if NAT44
 801     @param in_addr - inside IP address
 802     @param in_plen - inside IP address prefix length
 803     @param out_addr - outside IPv4 address
 804     @param out_plen - outside IPv4 address prefix length
 805     @param sharing_ratio - outside to inside address sharing ratio
 806     @param ports_per_host - number of ports available to a host
 807     @param ses_num - number of sessions belonging to this mapping
 808 */
 809 define nat_det_map_details {
 810   u32 context;
 811   u8 is_nat44;
 812   u8 in_addr[16];
 813   u8 in_plen;
 814   u8 out_addr[4];
 815   u8 out_plen;
 816   u32 sharing_ratio;
 817   u16 ports_per_host;
 818   u32 ses_num;
 819 };
 820
 821 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
 822     @param client_index - opaque cookie to identify the sender
 823     @param context - sender context, to match reply w/ request
 824     @param udp - UDP timeout (default 300sec)
 825     @param tcp_established - TCP established timeout (default 7440sec)
 826     @param tcp_transitory - TCP transitory timeout (default 240sec)
 827     @param icmp - ICMP timeout (default 60sec)
 828 */
 829 autoreply define nat_det_set_timeouts {
 830   u32 client_index;
 831   u32 context;
 832   u32 udp;
 833   u32 tcp_established;
 834   u32 tcp_transitory;
 835   u32 icmp;
 836 };
 837
 838 /** \brief Get values of timeouts for deterministic NAT (seconds)
 839     @param client_index - opaque cookie to identify the sender
 840     @param context - sender context, to match reply w/ request
 841 */
 842 define nat_det_get_timeouts {
 843   u32 client_index;
 844   u32 context;
 845 };
 846
 847 /** \brief Get values of timeouts for deterministic NAT reply
 848     @param context - sender context, to match reply w/ request
 849     @param retval - return code
 850     @param udp - UDP timeout (default 300sec)
 851     @param tcp_established - TCP established timeout (default 7440sec)
 852     @param tcp_transitory - TCP transitory timeout (default 240sec)
 853     @param icmp - ICMP timeout (default 60sec)
 854 */
 855 define nat_det_get_timeouts_reply {
 856   u32 context;
 857   i32 retval;
 858   u32 udp;
 859   u32 tcp_established;
 860   u32 tcp_transitory;
 861   u32 icmp;
 862 };
 863
 864 /** \brief Close deterministic NAT session by outside address and port
 865     @param client_index - opaque cookie to identify the sender
 866     @param context - sender context, to match reply w/ request
 867     @param out_addr - outside IPv4 address
 868     @param out_port - outside port
 869     @param ext_addr - external host IPv4 address
 870     @param ext_port - external host port
 871 */
 872 autoreply define nat_det_close_session_out {
 873   u32 client_index;
 874   u32 context;
 875   u8 out_addr[4];
 876   u16 out_port;
 877   u8 ext_addr[4];
 878   u16 ext_port;
 879 };
 880
 881 /** \brief Close deterministic NAT session by inside address and port
 882     @param client_index - opaque cookie to identify the sender
 883     @param context - sender context, to match reply w/ request
 884     @param is_nat44 - 1 if NAT44
 885     @param in_addr - inside IP address
 886     @param in_port - inside port
 887     @param ext_addr - external host IP address
 888     @param ext_port - external host port
 889 */
 890 autoreply define nat_det_close_session_in {
 891   u32 client_index;
 892   u32 context;
 893   u8 is_nat44;
 894   u8 in_addr[16];
 895   u16 in_port;
 896   u8 ext_addr[16];
 897   u16 ext_port;
 898 };
 899
 900 /** \brief Dump determinstic NAT sessions
 901     @param client_index - opaque cookie to identify the sender
 902     @param context - sender context, to match reply w/ request
 903     @param is_nat44 - 1 if NAT44
 904     @param user_addr - address of an inside user whose sessions to dump
 905 */
 906 define nat_det_session_dump {
 907   u32 client_index;
 908   u32 context;
 909   u8 is_nat44;
 910   u8 user_addr[16];
 911 };
 912
 913 /** \brief Deterministic NAT sessions reply
 914     @param context - sender context, to match reply w/ request
 915     @param in_port - inside port
 916     @param ext_addr - external host address
 917     @param ext_port - external host port
 918     @param out_port - outside NAT port
 919     @param state - session state
 920     @param expire - session expiration timestamp
 921 */
 922 define nat_det_session_details {
 923   u32 client_index;
 924   u32 context;
 925   u16 in_port;
 926   u8 ext_addr[4];
 927   u16 ext_port;
 928   u16 out_port;
 929   u8 state;
 930   u32 expire;
 931 };
 932
 933 /*
 934  * NAT64 APIs
 935  */
 936
 937 /** \brief Add/delete address range to NAT64 pool
 938     @param client_index - opaque cookie to identify the sender
 939     @param context - sender context, to match reply w/ request
 940     @param start_addr - start address of the range
 941     @param end_addr - end address of the range
 942     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 943     @param is_add - 1 if add, 0 if delete
 944 */
 945 autoreply define nat64_add_del_pool_addr_range {
 946   u32 client_index;
 947   u32 context;
 948   u8 start_addr[4];
 949   u8 end_addr[4];
 950   u32 vrf_id;
 951   u8 is_add;
 952 };
 953
 954 /** \brief Dump NAT64 pool addresses
 955     @param client_index - opaque cookie to identify the sender
 956     @param context - sender context, to match reply w/ request
 957 */
 958 define nat64_pool_addr_dump {
 959   u32 client_index;
 960   u32 context;
 961 };
 962
 963 /** \brief NAT64 pool address details response
 964     @param context - sender context, to match reply w/ request
 965     @param address - IPv4 address
 966     @param vfr_id - VRF id of tenant, ~0 means independent of VRF
 967 */
 968 define nat64_pool_addr_details {
 969   u32 context;
 970   u8 address[4];
 971   u32 vrf_id;
 972 };
 973
 974 /** \brief Enable/disable NAT64 feature on the interface
 975     @param client_index - opaque cookie to identify the sender
 976     @param context - sender context, to match reply w/ request
 977     @param sw_if_index - index of the interface
 978     @param is_inside - 1 if inside, 0 if outside
 979     @param is_add - 1 if add, 0 if delete
 980 */
 981 autoreply define nat64_add_del_interface {
 982   u32 client_index;
 983   u32 context;
 984   u32 sw_if_index;
 985   u8 is_inside;
 986   u8 is_add;
 987 };
 988
 989 /** \brief Dump interfaces with NAT64 feature
 990     @param client_index - opaque cookie to identify the sender
 991     @param context - sender context, to match reply w/ request
 992 */
 993 define nat64_interface_dump {
 994   u32 client_index;
 995   u32 context;
 996 };
 997
 998 /** \brief NAT64 interface details response
 999     @param context - sender context, to match reply w/ request
1000     @param is_inside - 1 if inside, 0 if outside
1001     @param sw_if_index - index of the interface
1002 */
1003 define nat64_interface_details {
1004   u32 context;
1005   u8 is_inside;
1006   u32 sw_if_index;
1007 };
1008
1009 /** \brief Add/delete NAT64 static BIB entry
1010     @param client_index - opaque cookie to identify the sender
1011     @param context - sender context, to match reply w/ request
1012     @param i_addr - inside IPv6 address
1013     @param o_addr - outside IPv4 address
1014     @param i_port - inside port number
1015     @param o_port - outside port number
1016     @param vrf_id - VRF id of tenant
1017     @param proto - protocol number
1018     @param is_add - 1 if add, 0 if delete
1019 */
1020  autoreply define nat64_add_del_static_bib {
1021   u32 client_index;
1022   u32 context;
1023   u8 i_addr[16];
1024   u8 o_addr[4];
1025   u16 i_port;
1026   u16 o_port;
1027   u32 vrf_id;
1028   u8 proto;
1029   u8 is_add;
1030 };
1031
1032 /** \brief Dump NAT64 BIB
1033     @param client_index - opaque cookie to identify the sender
1034     @param context - sender context, to match reply w/ request
1035     @param proto - protocol of the BIB: 255 - all BIBs
1036                                         6 - TCP BIB
1037                                         17 - UDP BIB
1038                                         1/58 - ICMP BIB
1039                                         otherwise - "unknown" protocol BIB
1040 */
1041 define nat64_bib_dump {
1042   u32 client_index;
1043   u32 context;
1044   u8 proto;
1045 };
1046
1047 /** \brief NAT64 BIB details response
1048     @param context - sender context, to match reply w/ request
1049     @param i_addr - inside IPv6 address
1050     @param o_addr - outside IPv4 address
1051     @param i_port - inside port number
1052     @param o_port - outside port number
1053     @param vrf_id - VRF id of tenant
1054     @param proto - protocol number
1055     @param is_static - 1 if static BIB entry, 0 if dynamic
1056     @param ses_num - number of sessions associated with the BIB entry
1057 */
1058 define nat64_bib_details {
1059   u32 context;
1060   u8 i_addr[16];
1061   u8 o_addr[4];
1062   u16 i_port;
1063   u16 o_port;
1064   u32 vrf_id;
1065   u8 proto;
1066   u8 is_static;
1067   u32 ses_num;
1068 };
1069
1070 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1071     @param client_index - opaque cookie to identify the sender
1072     @param context - sender context, to match reply w/ request
1073     @param udp - UDP timeout (default 300sec)
1074     @param icmp - ICMP timeout (default 60sec)
1075     @param tcp_trans - TCP transitory timeout (default 240sec)
1076     @param tcp_est - TCP established timeout (default 7440sec)
1077     @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1078 */
1079 autoreply define nat64_set_timeouts {
1080   u32 client_index;
1081   u32 context;
1082   u32 udp;
1083   u32 icmp;
1084   u32 tcp_trans;
1085   u32 tcp_est;
1086   u32 tcp_incoming_syn;
1087 };
1088
1089 /** \brief Get values of timeouts for NAT64 (seconds)
1090     @param client_index - opaque cookie to identify the sender
1091     @param context - sender context, to match reply w/ request
1092 */
1093 define nat64_get_timeouts {
1094   u32 client_index;
1095   u32 context;
1096 };
1097
1098 /** \brief Get values of timeouts for NAT64 reply
1099     @param context - sender context, to match reply w/ request
1100     @param retval - return code
1101     @param udp - UDP timeout
1102     @param icmp - ICMP timeout
1103     @param tcp_trans - TCP transitory timeout
1104     @param tcp_est - TCP established timeout
1105     @param tcp_incoming_syn - TCP incoming SYN timeout
1106 */
1107 define nat64_get_timeouts_reply {
1108   u32 context;
1109   i32 retval;
1110   u32 udp;
1111   u32 icmp;
1112   u32 tcp_trans;
1113   u32 tcp_est;
1114   u32 tcp_incoming_syn;
1115 };
1116
1117 /** \brief Dump NAT64 session table
1118     @param client_index - opaque cookie to identify the sender
1119     @param context - sender context, to match reply w/ request
1120     @param proto - protocol of the session table: 255 - all STs
1121                                                   6 - TCP ST
1122                                                   17 - UDP ST
1123                                                   1/58 - ICMP ST
1124                                                   otherwise - "unknown" proto ST
1125 */
1126 define nat64_st_dump {
1127   u32 client_index;
1128   u32 context;
1129   u8 proto;
1130 };
1131
1132 /** \brief NAT64 session table details response
1133     @param context - sender context, to match reply w/ request
1134     @param il_addr - inside IPv6 address of the local host
1135     @param ol_addr - outside IPv4 address of the local host
1136     @param il_port - inside port number id of the local host/inside ICMP id
1137     @param ol_port - outside port number of the local host/outside ICMP id
1138     @param il_addr - inside IPv6 address of the remote host
1139     @param ol_addr - outside IPv4 address of the remote host
1140     @param l_port - port number of the remote host (not used for ICMP)
1141     @param vrf_id - VRF id of tenant
1142     @param proto - protocol number
1143 */
1144 define nat64_st_details {
1145   u32 context;
1146   u8 il_addr[16];
1147   u8 ol_addr[4];
1148   u16 il_port;
1149   u16 ol_port;
1150   u8 ir_addr[16];
1151   u8 or_addr[4];
1152   u16 r_port;
1153   u32 vrf_id;
1154   u8 proto;
1155 };
1156
1157 /** \brief Add/del NAT64 prefix
1158     @param client_index - opaque cookie to identify the sender
1159     @param context - sender context, to match reply w/ request
1160     @param prefix - NAT64 prefix
1161     @param prefix - NAT64 prefix length
1162     @param vrf_id - VRF id of tenant
1163     @param is_add - 1 if add, 0 if delete
1164 */
1165 autoreply define nat64_add_del_prefix {
1166   u32 client_index;
1167   u32 context;
1168   u8 prefix[16];
1169   u8 prefix_len;
1170   u32 vrf_id;
1171   u8 is_add;
1172 };
1173
1174 /** \brief Dump NAT64 prefix
1175     @param client_index - opaque cookie to identify the sender
1176     @param context - sender context, to match reply w/ request
1177 */
1178 define nat64_prefix_dump {
1179   u32 client_index;
1180   u32 context;
1181 };
1182
1183 /** \brief Dump NAT64 prefix details response
1184     @param context - sender context, to match reply w/ request
1185     @param prefix - NAT64 prefix
1186     @param prefix - NAT64 prefix length
1187     @param vrf_id - VRF id of tenant
1188 */
1189 define nat64_prefix_details {
1190   u32 context;
1191   u8 prefix[16];
1192   u8 prefix_len;
1193   u32 vrf_id;
1194 };
1195
1196 /** \brief Add/delete NAT64 pool address from specific interfce
1197     @param client_index - opaque cookie to identify the sender
1198     @param context - sender context, to match reply w/ request
1199     @param is_add - 1 if add, 0 if delete
1200     @param sw_if_index - software index of the interface
1201 */
1202 autoreply define nat64_add_del_interface_addr {
1203   u32 client_index;
1204   u32 context;
1205   u8 is_add;
1206   u8 is_inside;
1207   u32 sw_if_index;
1208 };
1209
1210
1211 /*
1212  * DS-Lite APIs
1213  */
1214
1215 /** \brief Add/delete address range to DS-Lite pool
1216     @param client_index - opaque cookie to identify the sender
1217     @param context - sender context, to match reply w/ request
1218     @param start_addr - start address of the range
1219     @param end_addr - end address of the range
1220     @param is_add - 1 if add, 0 if delete
1221 */
1222 autoreply define dslite_add_del_pool_addr_range {
1223   u32 client_index;
1224   u32 context;
1225   u8 start_addr[4];
1226   u8 end_addr[4];
1227   u8 is_add;
1228 };
1229
1230 /** \brief Dump DS-Lite addresses
1231     @param client_index - opaque cookie to identify the sender
1232     @param context - sender context, to match reply w/ request
1233 */
1234 define dslite_address_dump {
1235   u32 client_index;
1236   u32 context;
1237 };
1238
1239 /** \brief DS-Lite address details response
1240     @param context - sender context, to match reply w/ request
1241     @param ip_address - IPv4 address
1242 */
1243 define dslite_address_details {
1244   u32 context;
1245   u8 ip_address[4];
1246 };
1247
1248 /** \brief Set AFTR IPv6 and IPv4 addresses
1249     @param client_index - opaque cookie to identify the sender
1250     @param context - sender context, to match reply w/ request
1251     @param ip4_addr - IPv4 address
1252     @param ip6_addr - IP64 address
1253 */
1254 autoreply define dslite_set_aftr_addr {
1255   u32 client_index;
1256   u32 context;
1257   u8 ip4_addr[4];
1258   u8 ip6_addr[16];
1259 };
1260
1261 /** \brief Get AFTR IPv6 and IPv4 addresses
1262     @param client_index - opaque cookie to identify the sender
1263     @param context - sender context, to match reply w/ request
1264 */
1265 define dslite_get_aftr_addr {
1266   u32 client_index;
1267   u32 context;
1268 };
1269
1270 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1271     @param context - sender context, to match reply w/ request
1272     @param retval - return code
1273     @param ip4_addr - IPv4 address
1274     @param ip6_addr - IP64 address
1275 */
1276 define dslite_get_aftr_addr_reply {
1277   u32 context;
1278   i32 retval;
1279   u8 ip4_addr[4];
1280   u8 ip6_addr[16];
1281 };
1282
1283 /** \brief Set B4 IPv6 and IPv4 addresses
1284     @param client_index - opaque cookie to identify the sender
1285     @param context - sender context, to match reply w/ request
1286     @param ip4_addr - IPv4 address
1287     @param ip6_addr - IP64 address
1288 */
1289 autoreply define dslite_set_b4_addr {
1290   u32 client_index;
1291   u32 context;
1292   u8 ip4_addr[4];
1293   u8 ip6_addr[16];
1294 };
1295
1296 /** \brief Get B4 IPv6 and IPv4 addresses
1297     @param client_index - opaque cookie to identify the sender
1298     @param context - sender context, to match reply w/ request
1299 */
1300 define dslite_get_b4_addr {
1301   u32 client_index;
1302   u32 context;
1303 };
1304
1305 /** \brief Response to get B4 IPv6 and IPv4 addresses
1306     @param context - sender context, to match reply w/ request
1307     @param retval - return code
1308     @param ip4_addr - IPv4 address
1309     @param ip6_addr - IP64 address
1310 */
1311 define dslite_get_b4_addr_reply {
1312   u32 context;
1313   i32 retval;
1314   u8 ip4_addr[4];
1315   u8 ip6_addr[16];
1316 };
1317
1318 /*
1319  * NAT66 APIs
1320  */
1321 /** \brief Enable/disable NAT66 feature on the interface
1322     @param client_index - opaque cookie to identify the sender
1323     @param context - sender context, to match reply w/ request
1324     @param is_add - 1 if add, 0 if delete
1325     @param is_inside - 1 if inside, 0 if outside
1326     @param sw_if_index - software index of the interface
1327 */
1328 autoreply define nat66_add_del_interface {
1329   u32 client_index;
1330   u32 context;
1331   u8 is_add;
1332   u8 is_inside;
1333   u32 sw_if_index;
1334 };
1335
1336 /** \brief Dump interfaces with NAT66 feature
1337     @param client_index - opaque cookie to identify the sender
1338     @param context - sender context, to match reply w/ request
1339 */
1340 define nat66_interface_dump {
1341   u32 client_index;
1342   u32 context;
1343 };
1344
1345 /** \brief NAT66 interface details response
1346     @param context - sender context, to match reply w/ request
1347     @param is_inside - 1 if inside, 0 if outside
1348     @param sw_if_index - software index of the interface
1349 */
1350 define nat66_interface_details {
1351   u32 context;
1352   u8 is_inside;
1353   u32 sw_if_index;
1354 };
1355
1356 /** \brief Add/delete 1:1 NAT66
1357     @param client_index - opaque cookie to identify the sender
1358     @param context - sender context, to match reply w/ request
1359     @param is_add - 1 if add, 0 if delete
1360     @param local_ip_address - local IPv6 address
1361     @param external_ip_address - external IPv6 address
1362     @param vrf_id - VRF id of tenant
1363 */
1364 autoreply define nat66_add_del_static_mapping {
1365   u32 client_index;
1366   u32 context;
1367   u8 is_add;
1368   u8 local_ip_address[16];
1369   u8 external_ip_address[16];
1370   u32 vrf_id;
1371 };
1372
1373 /** \brief Dump NAT66 static mappings
1374     @param client_index - opaque cookie to identify the sender
1375     @param context - sender context, to match reply w/ request
1376 */
1377 define nat66_static_mapping_dump {
1378   u32 client_index;
1379   u32 context;
1380 };
1381
1382 /** \brief NAT66 static mapping details response
1383     @param context - sender context, to match reply w/ request
1384     @param local_ip_address - local IPv6 address
1385     @param external_ip_address - external IPv6 address
1386     @param vrf_id - VRF id of tenant
1387     @param total_bytes - count of bytes sent through static mapping
1388     @param total_pkts - count of pakets sent through static mapping
1389 */
1390 define nat66_static_mapping_details {
1391   u32 context;
1392   u8 local_ip_address[16];
1393   u8 external_ip_address[16];
1394   u32 vrf_id;
1395   u64 total_bytes;
1396   u64 total_pkts;
1397 };