From 18327be5d458f9f73c12d76e677ee5a068ec6b10 Mon Sep 17 00:00:00 2001 From: Ole Troan Date: Tue, 12 Jan 2021 21:49:38 +0100 Subject: nat: 1:1 policy NAT A NAT sub-plugin doing statically configured match/rewrite on IP4 input or output. It's stateless (no connection tracking). Currently it supports rewriting of SA, DA and TCP/UDP ports. It should be simple to add new rewrites if required. API: pnat_binding_add, pnat_binding_del, pnat_bindings_get, pnat_interfaces_get CLI: set pnat translation interface match <5-tuple> rewrite <5-tuple> {in|out} [del] show pnat translations show pnat interfaces Trying a new C based unit testing scheme. Where the graph node is tested in isolation. See pnat/pnat_test.c. Also added new cmake targets to generate coverage directly. E.g.: make test_pnat-ccov-report File '/vpp/sdnat/src/plugins/nat/pnat/pnat.c': Name Regions Miss Cover Lines Miss Cover ------------------------------------------------------------------------------------ pnat_interface_by_sw_if_index 39 8 79.49% 13 0 100.00% pnat_instructions_from_mask 9 0 100.00% 13 0 100.00% pnat_binding_add 64 8 87.50% 31 2 93.55% pnat_flow_lookup 4 4 0.00% 10 10 0.00% pnat_binding_attach 104 75 27.88% 33 6 81.82% pnat_binding_detach 30 5 83.33% 23 2 91.30% pnat_binding_del 97 33 65.98% 17 3 82.35% pnat.c:pnat_calc_key_from_5tuple 9 1 88.89% 14 1 92.86% pnat.c:pnat_interface_check_mask 10 2 80.00% 11 2 81.82% pnat.c:pnat_enable 5 0 100.00% 11 0 100.00% pnat.c:pnat_enable_interface 107 26 75.70% 60 15 75.00% pnat.c:pnat_disable_interface 91 30 67.03% 32 7 78.12% pnat.c:pnat_disable 7 2 71.43% 13 7 46.15% ------------------------------------------------------------------------------------ TOTAL 576 194 66.32% 281 55 80.43% File '/vpp/sdnat/src/plugins/nat/pnat/pnat_node.h': Name Regions Miss Cover Lines Miss Cover ------------------------------------------------------------------------------------ pnat_test.c:pnat_node_inline 67 11 83.58% 115 1 99.13% pnat_test.c:pnat_calc_key 9 2 77.78% 14 2 85.71% pnat_test.c:pnat_rewrite_ip4 55 11 80.00% 60 12 80.00% pnat_test.c:format_pnat_trace 1 1 0.00% 12 12 0.00% pnat_node.c:pnat_node_inline 63 63 0.00% 115 115 0.00% pnat_node.c:pnat_calc_key 9 9 0.00% 14 14 0.00% pnat_node.c:pnat_rewrite_ip4 55 55 0.00% 60 60 0.00% pnat_node.c:format_pnat_trace 5 5 0.00% 12 12 0.00% ------------------------------------------------------------------------------------ TOTAL 264 157 40.53% 402 228 43.28% Type: feature Change-Id: I9c897f833603054a8303e7369ebff6512517c9e0 Signed-off-by: Ole Troan --- src/plugins/nat/pnat/pnat_api.c | 207 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 207 insertions(+) create mode 100644 src/plugins/nat/pnat/pnat_api.c (limited to 'src/plugins/nat/pnat/pnat_api.c') diff --git a/src/plugins/nat/pnat/pnat_api.c b/src/plugins/nat/pnat/pnat_api.c new file mode 100644 index 00000000000..dad658c3e9e --- /dev/null +++ b/src/plugins/nat/pnat/pnat_api.c @@ -0,0 +1,207 @@ +/* + * Copyright (c) 2021 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#include "pnat.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* + * This file contains the API handlers for the pnat.api + */ + +#define REPLY_MSG_ID_BASE pm->msg_id_base +#include + +static void vl_api_pnat_binding_add_t_handler(vl_api_pnat_binding_add_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_binding_add_reply_t *rmp; + u32 binding_index; + int rv = pnat_binding_add(&mp->match, &mp->rewrite, &binding_index); + REPLY_MACRO2_END(VL_API_PNAT_BINDING_ADD_REPLY, + ({ rmp->binding_index = binding_index; })); +} + +static void +vl_api_pnat_binding_attach_t_handler(vl_api_pnat_binding_attach_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_binding_attach_reply_t *rmp; + int rv; + + /* Ensure that the interface exists */ + if (!vnet_sw_if_index_is_api_valid(mp->sw_if_index)) { + rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; + goto bad_sw_if_index; + } + + rv = + pnat_binding_attach(mp->sw_if_index, mp->attachment, mp->binding_index); + +bad_sw_if_index: + REPLY_MACRO_END(VL_API_PNAT_BINDING_ATTACH_REPLY); +} + +static void +vl_api_pnat_binding_detach_t_handler(vl_api_pnat_binding_detach_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_binding_detach_reply_t *rmp; + int rv; + + /* Ensure that the interface exists */ + if (!vnet_sw_if_index_is_api_valid(mp->sw_if_index)) { + rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; + goto bad_sw_if_index; + } + + rv = + pnat_binding_detach(mp->sw_if_index, mp->attachment, mp->binding_index); + +bad_sw_if_index: + REPLY_MACRO_END(VL_API_PNAT_BINDING_DETACH_REPLY); +} + +static void vl_api_pnat_binding_del_t_handler(vl_api_pnat_binding_del_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_binding_del_reply_t *rmp; + int rv = pnat_binding_del(mp->binding_index); + REPLY_MACRO_END(VL_API_PNAT_BINDING_DEL_REPLY); +} + +/* + * Workaround for a bug in vppapigen that doesn't register the endian handler + * for _details messages. When that's fixed it should be possible to use + * REPLY_MACRO_DETAILS4_END and not have to care about endian-ness in the + * handler itself. + */ +#define vl_endianfun +#include +#undef vl_endianfun +static void send_bindings_details(u32 index, vl_api_registration_t *rp, + u32 context) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_bindings_details_t *rmp; + pnat_translation_t *t = pool_elt_at_index(pm->translations, index); + + /* Make sure every field is initiated (or don't skip the clib_memset()) */ + + REPLY_MACRO_DETAILS4(VL_API_PNAT_BINDINGS_DETAILS, rp, context, ({ + rmp->match = t->match; + rmp->rewrite = t->rewrite; + + /* Endian hack until apigen registers _details + * endian functions */ + vl_api_pnat_bindings_details_t_endian(rmp); + rmp->_vl_msg_id = htons(rmp->_vl_msg_id); + rmp->context = htonl(rmp->context); + })); +} + +static void vl_api_pnat_bindings_get_t_handler(vl_api_pnat_bindings_get_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_bindings_get_reply_t *rmp; + + i32 rv = 0; + + if (pool_elts(pm->translations) == 0) { + REPLY_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY); + return; + } + + /* + * "cursor" comes from the get call, and allows client to continue a dump + */ + REPLY_AND_DETAILS_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY, pm->translations, ({ + send_bindings_details(cursor, rp, mp->context); + })); +} + +static void send_interfaces_details(u32 index, vl_api_registration_t *rp, + u32 context) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_interfaces_details_t *rmp; + pnat_interface_t *i = pool_elt_at_index(pm->interfaces, index); + + /* Make sure every field is initiated (or don't skip the clib_memset()) */ + + REPLY_MACRO_DETAILS4( + VL_API_PNAT_INTERFACES_DETAILS, rp, context, ({ + rmp->sw_if_index = i->sw_if_index; + clib_memcpy(rmp->enabled, i->enabled, PNAT_ATTACHMENT_POINT_MAX); + clib_memcpy(rmp->lookup_mask, i->lookup_mask, + sizeof(i->lookup_mask) * PNAT_ATTACHMENT_POINT_MAX); + + /* Endian hack until apigen registers _details + * endian functions */ + vl_api_pnat_interfaces_details_t_endian(rmp); + rmp->_vl_msg_id = htons(rmp->_vl_msg_id); + rmp->context = htonl(rmp->context); + })); +} + +static void +vl_api_pnat_interfaces_get_t_handler(vl_api_pnat_interfaces_get_t *mp) { + pnat_main_t *pm = &pnat_main; + vl_api_pnat_interfaces_get_reply_t *rmp; + + i32 rv = 0; + + if (pool_elts(pm->interfaces) == 0) { + REPLY_MACRO(VL_API_PNAT_INTERFACES_GET_REPLY); + return; + } + + /* + * "cursor" comes from the get call, and allows client to continue a dump + */ + REPLY_AND_DETAILS_MACRO( + VL_API_PNAT_INTERFACES_GET_REPLY, pm->interfaces, + ({ send_interfaces_details(cursor, rp, mp->context); })); +} + +/* API definitions */ +#include +#include + +/* Set up the API message handling tables */ +clib_error_t *pnat_plugin_api_hookup(vlib_main_t *vm) { + pnat_main_t *pm = &pnat_main; + + pm->msg_id_base = setup_message_id_table(); + + return 0; +} + +/* + * Register the plugin and hook up the API + */ +#include +VLIB_PLUGIN_REGISTER() = { + .version = "0.0.1", + .description = "Policy 1:1 NAT", +}; + +clib_error_t *pnat_init(vlib_main_t *vm) { + pnat_main_t *pm = &pnat_main; + memset(pm, 0, sizeof(*pm)); + + return pnat_plugin_api_hookup(vm); +} + +VLIB_INIT_FUNCTION(pnat_init); -- cgit 1.2.3-korg