src/plugins/cnat/cnat_api.c

   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 #include <stddef.h>
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/plugin/plugin.h>
  20 #include <cnat/cnat_translation.h>
  21 #include <cnat/cnat_session.h>
  22 #include <cnat/cnat_client.h>
  23 #include <cnat/cnat_snat.h>
  24
  25 #include <vnet/ip/ip_types_api.h>
  26
  27 #include <vpp/app/version.h>
  28
  29 #include <vlibapi/api.h>
  30 #include <vlibmemory/api.h>
  31
  32 /* define message IDs */
  33 #include <vnet/format_fns.h>
  34 #include <cnat/cnat.api_enum.h>
  35 #include <cnat/cnat.api_types.h>
  36
  37 /**
  38  * Base message ID fot the plugin
  39  */
  40 static u32 cnat_base_msg_id;
  41
  42 #define REPLY_MSG_ID_BASE cnat_base_msg_id
  43
  44 #include <vlibapi/api_helper_macros.h>
  45
  46 static int
  47 cnat_endpoint_decode (const vl_api_cnat_endpoint_t * in,
  48                       cnat_endpoint_t * out)
  49 {
  50   int rv = 0;
  51   out->ce_port = clib_net_to_host_u16 (in->port);
  52   out->ce_sw_if_index = clib_net_to_host_u32 (in->sw_if_index);
  53   out->ce_flags = 0;
  54   if (out->ce_sw_if_index == INDEX_INVALID)
  55     ip_address_decode2 (&in->addr, &out->ce_ip);
  56   else
  57     rv = ip_address_family_decode (in->if_af, &out->ce_ip.version);
  58   return rv;
  59 }
  60
  61 static int
  62 cnat_endpoint_tuple_decode (const vl_api_cnat_endpoint_tuple_t * in,
  63                             cnat_endpoint_tuple_t * out)
  64 {
  65   int rv = 0;
  66   rv = cnat_endpoint_decode (&in->src_ep, &out->src_ep);
  67   if (rv)
  68     return rv;
  69   rv = cnat_endpoint_decode (&in->dst_ep, &out->dst_ep);
  70   return rv;
  71 }
  72
  73 static void
  74 cnat_endpoint_encode (const cnat_endpoint_t * in,
  75                       vl_api_cnat_endpoint_t * out)
  76 {
  77   out->port = clib_net_to_host_u16 (in->ce_port);
  78   out->sw_if_index = clib_net_to_host_u32 (in->ce_sw_if_index);
  79   out->if_af = ip_address_family_encode (in->ce_ip.version);
  80   if (in->ce_flags & CNAT_EP_FLAG_RESOLVED)
  81     ip_address_encode2 (&in->ce_ip, &out->addr);
  82   else
  83     clib_memset ((void *) &in->ce_ip, 0, sizeof (in->ce_ip));
  84 }
  85
  86 static void
  87 vl_api_cnat_translation_update_t_handler (vl_api_cnat_translation_update_t
  88                                           * mp)
  89 {
  90   vl_api_cnat_translation_update_reply_t *rmp;
  91   cnat_endpoint_t vip;
  92   cnat_endpoint_tuple_t *paths = NULL, *path;
  93   ip_protocol_t ip_proto;
  94   u32 id = ~0;
  95   u8 flags;
  96   int rv = 0;
  97   u32 pi, n_paths;
  98
  99   rv = ip_proto_decode (mp->translation.ip_proto, &ip_proto);
 100
 101   if (rv)
 102     goto done;
 103
 104   n_paths = clib_net_to_host_u32 (mp->translation.n_paths);
 105   vec_validate (paths, n_paths - 1);
 106
 107   for (pi = 0; pi < n_paths; pi++)
 108     {
 109       path = &paths[pi];
 110       rv = cnat_endpoint_tuple_decode (&mp->translation.paths[pi], path);
 111       if (rv)
 112         goto done;
 113     }
 114
 115   rv = cnat_endpoint_decode (&mp->translation.vip, &vip);
 116   if (rv)
 117     goto done;
 118
 119   flags = mp->translation.flags;
 120   if (!mp->translation.is_real_ip)
 121     flags |= CNAT_FLAG_EXCLUSIVE;
 122   id = cnat_translation_update (&vip, ip_proto, paths, flags);
 123
 124   vec_free (paths);
 125
 126 done:
 127   REPLY_MACRO2 (VL_API_CNAT_TRANSLATION_UPDATE_REPLY,
 128   ({
 129     rmp->id = htonl (id);
 130   }));
 131 }
 132
 133 static void
 134 vl_api_cnat_translation_del_t_handler (vl_api_cnat_translation_del_t * mp)
 135 {
 136   vl_api_cnat_translation_del_reply_t *rmp;
 137   int rv;
 138
 139   rv = cnat_translation_delete (ntohl (mp->id));
 140
 141   REPLY_MACRO (VL_API_CNAT_TRANSLATION_DEL_REPLY);
 142 }
 143
 144 typedef struct cnat_dump_walk_ctx_t_
 145 {
 146   vl_api_registration_t *rp;
 147   u32 context;
 148 } cnat_dump_walk_ctx_t;
 149
 150 static walk_rc_t
 151 cnat_translation_send_details (u32 cti, void *args)
 152 {
 153   vl_api_cnat_translation_details_t *mp;
 154   cnat_dump_walk_ctx_t *ctx;
 155   cnat_ep_trk_t *trk;
 156   vl_api_cnat_endpoint_tuple_t *path;
 157   size_t msg_size;
 158   cnat_translation_t *ct;
 159   u32 n_paths;
 160
 161   ctx = args;
 162   ct = cnat_translation_get (cti);
 163   n_paths = vec_len (ct->ct_paths);
 164   msg_size = sizeof (*mp) + sizeof (mp->translation.paths[0]) * n_paths;
 165
 166   mp = vl_msg_api_alloc_zero (msg_size);
 167   mp->_vl_msg_id = ntohs (VL_API_CNAT_TRANSLATION_DETAILS + cnat_base_msg_id);
 168
 169   /* fill in the message */
 170   mp->context = ctx->context;
 171   mp->translation.n_paths = clib_host_to_net_u32 (n_paths);
 172   mp->translation.id = clib_host_to_net_u32 (cti);
 173   cnat_endpoint_encode (&ct->ct_vip, &mp->translation.vip);
 174   mp->translation.ip_proto = ip_proto_encode (ct->ct_proto);
 175
 176   path = mp->translation.paths;
 177   vec_foreach (trk, ct->ct_paths)
 178   {
 179     cnat_endpoint_encode (&trk->ct_ep[VLIB_TX], &path->dst_ep);
 180     cnat_endpoint_encode (&trk->ct_ep[VLIB_RX], &path->src_ep);
 181     path++;
 182   }
 183
 184   vl_api_send_msg (ctx->rp, (u8 *) mp);
 185
 186   return (WALK_CONTINUE);
 187 }
 188
 189 static void
 190 vl_api_cnat_translation_dump_t_handler (vl_api_cnat_translation_dump_t * mp)
 191 {
 192   vl_api_registration_t *rp;
 193
 194   rp = vl_api_client_index_to_registration (mp->client_index);
 195   if (rp == 0)
 196     return;
 197
 198   cnat_dump_walk_ctx_t ctx = {
 199     .rp = rp,
 200     .context = mp->context,
 201   };
 202
 203   cnat_translation_walk (cnat_translation_send_details, &ctx);
 204 }
 205
 206 static void
 207 ip_address2_from_46 (const ip46_address_t * nh,
 208                      ip_address_family_t af, ip_address_t * ip)
 209 {
 210   ip_addr_46 (ip) = *nh;
 211   ip_addr_version (ip) = af;
 212 }
 213
 214 static walk_rc_t
 215 cnat_session_send_details (const cnat_session_t * session, void *args)
 216 {
 217   vl_api_cnat_session_details_t *mp;
 218   cnat_dump_walk_ctx_t *ctx;
 219   cnat_endpoint_t ep;
 220
 221   ctx = args;
 222
 223   mp = vl_msg_api_alloc_zero (sizeof (*mp));
 224   mp->_vl_msg_id = ntohs (VL_API_CNAT_SESSION_DETAILS + cnat_base_msg_id);
 225
 226   /* fill in the message */
 227   mp->context = ctx->context;
 228
 229   ep.ce_sw_if_index = INDEX_INVALID;
 230   ep.ce_flags = CNAT_EP_FLAG_RESOLVED;
 231   ip_address2_from_46 (&session->value.cs_ip[VLIB_TX], session->key.cs_af,
 232                        &ep.ce_ip);
 233   ep.ce_port = clib_host_to_net_u16 (session->value.cs_port[VLIB_TX]);
 234   cnat_endpoint_encode (&ep, &mp->session.new);
 235
 236   ip_address2_from_46 (&session->key.cs_ip[VLIB_RX], session->key.cs_af,
 237                        &ep.ce_ip);
 238   ep.ce_port = clib_host_to_net_u16 (session->key.cs_port[VLIB_RX]);
 239   cnat_endpoint_encode (&ep, &mp->session.src);
 240
 241   ip_address2_from_46 (&session->key.cs_ip[VLIB_TX], session->key.cs_af,
 242                        &ep.ce_ip);
 243   ep.ce_port = clib_host_to_net_u16 (session->key.cs_port[VLIB_TX]);
 244   cnat_endpoint_encode (&ep, &mp->session.dst);
 245
 246   mp->session.ip_proto = ip_proto_encode (session->key.cs_proto);
 247   mp->session.location = session->key.cs_loc;
 248
 249   vl_api_send_msg (ctx->rp, (u8 *) mp);
 250
 251   return (WALK_CONTINUE);
 252 }
 253
 254 static void
 255 vl_api_cnat_session_dump_t_handler (vl_api_cnat_session_dump_t * mp)
 256 {
 257   vl_api_registration_t *rp;
 258
 259   rp = vl_api_client_index_to_registration (mp->client_index);
 260   if (rp == 0)
 261     return;
 262
 263   cnat_dump_walk_ctx_t ctx = {
 264     .rp = rp,
 265     .context = mp->context,
 266   };
 267
 268   cnat_session_walk (cnat_session_send_details, &ctx);
 269 }
 270
 271 static void
 272 vl_api_cnat_session_purge_t_handler (vl_api_cnat_session_purge_t * mp)
 273 {
 274   vl_api_cnat_session_purge_reply_t *rmp;
 275   int rv;
 276
 277   cnat_client_throttle_pool_process ();
 278   rv = cnat_session_purge ();
 279   rv |= cnat_translation_purge ();
 280
 281   REPLY_MACRO (VL_API_CNAT_SESSION_PURGE_REPLY);
 282 }
 283
 284 static void
 285 vl_api_cnat_get_snat_addresses_t_handler (vl_api_cnat_get_snat_addresses_t
 286                                           * mp)
 287 {
 288   vl_api_cnat_get_snat_addresses_reply_t *rmp;
 289   int rv = 0;
 290
 291   REPLY_MACRO2 (VL_API_CNAT_GET_SNAT_ADDRESSES_REPLY,
 292   ({
 293     ip6_address_encode (&ip_addr_v6(&cnat_main.snat_ip6.ce_ip), rmp->snat_ip6);
 294     ip4_address_encode (&ip_addr_v4(&cnat_main.snat_ip4.ce_ip), rmp->snat_ip4);
 295     rmp->sw_if_index = clib_host_to_net_u32 (cnat_main.snat_ip6.ce_sw_if_index);
 296   }));
 297 }
 298
 299 static void
 300 vl_api_cnat_set_snat_addresses_t_handler (vl_api_cnat_set_snat_addresses_t
 301                                           * mp)
 302 {
 303   vl_api_cnat_set_snat_addresses_reply_t *rmp;
 304   u32 sw_if_index = clib_net_to_host_u32 (mp->sw_if_index);
 305   ip4_address_t ip4;
 306   ip6_address_t ip6;
 307   int rv = 0;
 308
 309   ip4_address_decode (mp->snat_ip4, &ip4);
 310   ip6_address_decode (mp->snat_ip6, &ip6);
 311
 312   cnat_set_snat (&ip4, &ip6, sw_if_index);
 313
 314   REPLY_MACRO (VL_API_CNAT_SET_SNAT_ADDRESSES_REPLY);
 315 }
 316
 317 static void
 318   vl_api_cnat_add_del_snat_prefix_t_handler
 319   (vl_api_cnat_add_del_snat_prefix_t * mp)
 320 {
 321   vl_api_cnat_add_del_snat_prefix_reply_t *rmp;
 322   ip_prefix_t pfx;
 323   int rv;
 324
 325   ip_prefix_decode2 (&mp->prefix, &pfx);
 326   if (mp->is_add)
 327     rv = cnat_add_snat_prefix (&pfx);
 328   else
 329     rv = cnat_del_snat_prefix (&pfx);
 330
 331   REPLY_MACRO (VL_API_CNAT_ADD_DEL_SNAT_PREFIX_REPLY);
 332 }
 333
 334 #include <cnat/cnat.api.c>
 335
 336 static clib_error_t *
 337 cnat_api_init (vlib_main_t * vm)
 338 {
 339   /* Ask for a correctly-sized block of API message decode slots */
 340   cnat_base_msg_id = setup_message_id_table ();
 341
 342   return 0;
 343 }
 344
 345 VLIB_INIT_FUNCTION (cnat_api_init);
 346
 347 VLIB_PLUGIN_REGISTER () = {
 348     .version = VPP_BUILD_VER,
 349     .description = "CNat Translate",
 350 };
 351
 352 /*
 353  * fd.io coding-style-patch-verification: ON
 354  *
 355  * Local Variables:
 356  * eval: (c-set-style "gnu")
 357  * End:
 358  */