X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=b35267d28ed0a4b50908f1872231690888b7d6b0;hb=bb2e5221a;hp=19f007aeea7436b0986fd1b7ef31329a46763c78;hpb=0d056e5ede136cd0111dc3f9f41ef7b36a938027;p=vpp.git diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api index 19f007aeea7..b35267d28ed 100644 --- a/src/plugins/acl/acl.api +++ b/src/plugins/acl/acl.api @@ -19,7 +19,9 @@ used to control the ACL plugin */ -vl_api_version 1.0.0 +option version = "1.0.1"; + +import "plugins/acl/acl_types.api"; /** \brief Get the plugin version @param client_index - opaque cookie to identify the sender @@ -69,83 +71,25 @@ define acl_plugin_control_ping_reply u32 vpe_pid; }; -/** \brief Access List Rule entry - @param is_permit - deny (0), permit (1), or permit+reflect(2) action on this rule. - @param is_ipv6 - IP addresses in this rule are IPv6 (1) or IPv4 (0) - @param src_ip_addr - Source prefix value - @param src_ip_prefix_len - Source prefix length - @param dst_ip_addr - Destination prefix value - @param dst_ip_prefix_len - Destination prefix length - @param proto - L4 protocol (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) - @param srcport_or_icmptype_first - beginning of source port or ICMP4/6 type range - @param srcport_or_icmptype_last - end of source port or ICMP4/6 type range - @param dstport_or_icmpcode_first - beginning of destination port or ICMP4/6 code range - @param dstport_or_icmpcode_last - end of destination port or ICMP4/6 code range - @param tcp_flags_mask - if proto==6, match masked TCP flags with this value - @param tcp_flags_value - if proto==6, mask to AND the TCP flags in the packet with -*/ - -typeonly manual_print define acl_rule +/** \brief Get Connection table max entries + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ + +define acl_plugin_get_conn_table_max_entries { - u8 is_permit; - u8 is_ipv6; - u8 src_ip_addr[16]; - u8 src_ip_prefix_len; - u8 dst_ip_addr[16]; - u8 dst_ip_prefix_len; -/* - * L4 protocol. IANA number. 1 = ICMP, 58 = ICMPv6, 6 = TCP, 17 = UDP. - * 0 => ignore L4 and ignore the ports/tcpflags when matching. - */ - u8 proto; -/* - * If the L4 protocol is TCP or UDP, the below - * hold ranges of ports, else if the L4 is ICMP/ICMPv6 - * they hold ranges of ICMP(v6) types/codes. - * - * Ranges are inclusive, i.e. to match "any" TCP/UDP port, - * use first=0,last=65535. For ICMP(v6), - * use first=0,last=255. - */ - u16 srcport_or_icmptype_first; - u16 srcport_or_icmptype_last; - u16 dstport_or_icmpcode_first; - u16 dstport_or_icmpcode_last; -/* - * for proto = 6, this matches if the - * TCP flags in the packet, ANDed with tcp_flags_mask, - * is equal to tcp_flags_value. - */ - u8 tcp_flags_mask; - u8 tcp_flags_value; + u32 client_index; + u32 context; }; -/** \brief MACIP Access List Rule entry - @param is_permit - deny (0), permit (1) action on this rule. - @param is_ipv6 - IP addresses in this rule are IPv6 (1) or IPv4 (0) - @param src_mac - match masked source MAC address against this value - @param src_mac_mask - AND source MAC address with this value before matching - @param src_ip_addr - Source prefix value - @param src_ip_prefix_len - Source prefix length +/** \brief Reply to get connection table max entries + @param context - sender context, to match reply w/ request + @param conn_table_max_entries - the value of maximum entries of connection table */ - -typeonly manual_print define macip_acl_rule +define acl_plugin_get_conn_table_max_entries_reply { - u8 is_permit; - u8 is_ipv6; -/* - * The source mac of the packet ANDed with src_mac_mask. - * The source ip[46] address in the packet is matched - * against src_ip_addr, with src_ip_prefix_len set to 0. - * - * For better performance, minimize the number of - * (src_mac_mask, src_ip_prefix_len) combinations - * in a MACIP ACL. - */ - u8 src_mac[6]; - u8 src_mac_mask[6]; - u8 src_ip_addr[16]; - u8 src_ip_prefix_len; + u32 context; + u64 conn_table_max_entries; }; /** \brief Replace an existing ACL in-place or create a new ACL @@ -476,3 +420,65 @@ define macip_acl_interface_list_details u8 count; u32 acls[count]; }; + +/** \brief Set the ethertype whitelists on an interface. Takes effect when applying ACLs on the interface, so must be given prior. + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param sw_if_index - the interface to alter the list of ACLs on + @param count - total number of whitelisted ethertypes in the vector + @param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output + @param whitelist - vector of whitelisted ethertypes +*/ + +autoreply manual_print define acl_interface_set_etype_whitelist +{ + u32 client_index; + u32 context; + u32 sw_if_index; + u8 count; /* Total number of ethertypes in the whitelist */ + u8 n_input; /* first n_input ethertypes are input, the rest - output */ + u16 whitelist[count]; +}; + +/** \brief Dump the list(s) of Ethertype whitelists applied to specific or all interfaces + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param sw_if_index - interface to dump the ethertype whitelist for +*/ + +define acl_interface_etype_whitelist_dump +{ + u32 client_index; + u32 context; + u32 sw_if_index; /* ~0 for all interfaces */ +}; + +/** \brief Details about ethertype whitelist on a single interface + @param context - returned sender context, to match reply w/ request + @param sw_if_index - interface for which the list of MACIP ACLs is applied + @param count - total number of whitelisted ethertypes in the vector + @param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output + @param whitelist - vector of whitelisted ethertypes +*/ + +define acl_interface_etype_whitelist_details +{ + u32 context; + u32 sw_if_index; + u8 count; + u8 n_input; /* first n_input ethertypes are input, the rest - output */ + u16 whitelist[count]; +}; + +/** \brief Enable or disable incrementing ACL counters in stats segment by interface processing + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param enable - whether to enable or disable incrementing the counters +*/ + +autoreply define acl_stats_intf_counters_enable +{ + u32 client_index; + u32 context; + bool enable; +};