X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=f4f6c9cf4b98fa58e67aa225df6167528e52faf4;hb=2f8cd9145;hp=48d6aece3a926ab956c2ab91a6a60ed5d9b7cffa;hpb=de9fbf43d2b0293dde4f8a7fa50f7f7abbc7585f;p=vpp.git diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api index 48d6aece3a9..f4f6c9cf4b9 100644 --- a/src/plugins/acl/acl.api +++ b/src/plugins/acl/acl.api @@ -19,6 +19,10 @@ used to control the ACL plugin */ +option version = "2.0.0"; + +import "plugins/acl/acl_types.api"; +import "vnet/interface_types.api"; /** \brief Get the plugin version @param client_index - opaque cookie to identify the sender @@ -68,83 +72,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 @@ -161,9 +107,10 @@ manual_print manual_endian define acl_add_replace u32 client_index; u32 context; u32 acl_index; /* ~0 to add, existing ACL# to replace */ - u8 tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */ + string tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */ u32 count; vl_api_acl_rule_t r[count]; + option vat_help = " [] [src IP/plen] [dst IP/plen] [sport X-Y] [dport X-Y] [proto P] [tcpflags FL MASK], ... , ..."; }; /** \brief Reply to add/replace ACL @@ -190,6 +137,7 @@ autoreply manual_print define acl_del u32 client_index; u32 context; u32 acl_index; + option vat_help = ""; }; /* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */ @@ -207,14 +155,15 @@ autoreply manual_print define acl_interface_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add [default=true]; /* * is_input = 0 => ACL applied on interface egress * is_input = 1 => ACL applied on interface ingress */ - u8 is_input; - u32 sw_if_index; + bool is_input; + vl_api_interface_index_t sw_if_index; u32 acl_index; + option vat_help = " | sw_if_index [add|del] [input|output] acl "; }; /** \brief Set the vector of input/output ACLs checked for an interface @@ -230,10 +179,11 @@ autoreply manual_print define acl_interface_set_acl_list { u32 client_index; u32 context; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u8 count; u8 n_input; /* First n_input ACLs are set as a list of input ACLs, the rest are applied as output */ u32 acls[count]; + option vat_help = " | sw_if_index input [acl-idx list] output [acl-idx list]"; }; /** \brief Reply to set the ACL list on an interface @@ -252,6 +202,7 @@ define acl_dump u32 client_index; u32 context; u32 acl_index; /* ~0 for all ACLs */ + option vat_help = "[]"; }; /** \brief Details about a single ACL contents @@ -266,7 +217,7 @@ manual_endian manual_print define acl_details { u32 context; u32 acl_index; - u8 tag[64]; /* Same blob that was supplied to us when creating the ACL, one hopes. */ + string tag[64]; /* Same blob that was supplied to us when creating the ACL, one hopes. */ u32 count; vl_api_acl_rule_t r[count]; }; @@ -281,7 +232,8 @@ define acl_interface_list_dump { u32 client_index; u32 context; - u32 sw_if_index; /* ~0 for all interfaces */ + vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */ + option vat_help = "[ | sw_if_index ]"; }; /** \brief Details about a single ACL contents @@ -295,7 +247,7 @@ define acl_interface_list_dump define acl_interface_list_details { u32 context; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u8 count; u8 n_input; u32 acls[count]; @@ -305,7 +257,7 @@ define acl_interface_list_details @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param tag - descriptive value for this MACIP ACL - @param count - number of rules in this ACL + @param count - number of rules in this MACIP ACL @param r - vector of MACIP ACL rules */ @@ -313,14 +265,15 @@ manual_endian manual_print define macip_acl_add { u32 client_index; u32 context; - u8 tag[64]; + string tag[64]; u32 count; vl_api_macip_acl_rule_t r[count]; + option vat_help = "..."; }; /** \brief Reply to add MACIP ACL @param context - returned sender context, to match reply w/ request - @param acl_index - index of the newly created ACL + @param acl_index - index of the newly created MACIP ACL @param retval 0 - no error */ @@ -331,6 +284,39 @@ define macip_acl_add_reply i32 retval; }; +/** \brief Add/Replace a MACIP ACL + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param acl_index - an existing MACIP ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new MACIP ACL + @param tag - descriptive value for this MACIP ACL + @param count - number of rules in this MACIP ACL + @param r - vector of MACIP ACL rules +*/ + +manual_endian manual_print define macip_acl_add_replace +{ + u32 client_index; + u32 context; + u32 acl_index; /* ~0 to add, existing MACIP ACL# to replace */ + string tag[64]; + u32 count; + vl_api_macip_acl_rule_t r[count]; + option vat_help = " [] [count ] [src] ip mac mask , ... , ..."; +}; + +/** \brief Reply to add/replace MACIP ACL + @param context - returned sender context, to match reply w/ request + @param acl_index - index of the newly created MACIP ACL + @param retval 0 - no error +*/ + +define macip_acl_add_replace_reply +{ + u32 context; + u32 acl_index; + i32 retval; +}; + /** \brief Delete a MACIP ACL @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -342,12 +328,13 @@ autoreply manual_print define macip_acl_del u32 client_index; u32 context; u32 acl_index; + option vat_help = ""; }; /** \brief Add or delete a MACIP ACL to/from interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param is_add - add (1) or delete (0) ACL from being used on an interface + @param is_add - add (1) or delete (0) MACIP ACL from being used on an interface @param sw_if_index - interface to apply the action to @param acl_index - MACIP ACL index */ @@ -356,16 +343,17 @@ autoreply manual_print define macip_acl_interface_add_del { u32 client_index; u32 context; - u8 is_add; - /* macip ACLs are always input */ - u32 sw_if_index; + bool is_add [default=true]; + /* MACIP ACLs are always input */ + vl_api_interface_index_t sw_if_index; u32 acl_index; + option vat_help = " | sw_if_index [add|del] acl "; }; /** \brief Dump one or all defined MACIP ACLs @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param acl_index - MACIP ACL index or ~0 to dump all ACLs + @param acl_index - MACIP ACL index or ~0 to dump all MACIP ACLs */ define macip_acl_dump @@ -373,6 +361,7 @@ define macip_acl_dump u32 client_index; u32 context; u32 acl_index; /* ~0 for all ACLs */ + option vat_help = "[]"; }; /** \brief Details about one MACIP ACL @@ -380,14 +369,14 @@ define macip_acl_dump @param acl_index - index of this MACIP ACL @param tag - descriptive tag which was supplied during the creation @param count - length of the vector of MACIP ACL rules - @param r - rules comprising this ACL + @param r - rules comprising this MACIP ACL */ manual_endian manual_print define macip_acl_details { u32 context; u32 acl_index; - u8 tag[64]; + string tag[64]; u32 count; vl_api_macip_acl_rule_t r[count]; }; @@ -406,7 +395,7 @@ define macip_acl_interface_get /** \brief Reply with the vector of MACIP ACLs by sw_if_index @param context - returned sender context, to match reply w/ request @param count - total number of elements in the vector - @param acls - the vector of active MACACL indices per sw_if_index + @param acls - the vector of active MACIP ACL indices per sw_if_index */ define macip_acl_interface_get_reply @@ -419,27 +408,92 @@ define macip_acl_interface_get_reply /** \brief Dump the list(s) of MACIP ACLs 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 ACL list for + @param sw_if_index - interface to dump the MACIP ACL list for */ define macip_acl_interface_list_dump { u32 client_index; u32 context; - u32 sw_if_index; /* ~0 for all interfaces */ + vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */ }; /** \brief Details about a single MACIP ACL contents @param context - returned sender context, to match reply w/ request - @param sw_if_index - interface for which the list of ACLs is applied + @param sw_if_index - interface for which the list of MACIP ACLs is applied @param count - total length of acl indices vector - @param acls - the vector of ACL indices + @param acls - the vector of MACIP ACL indices */ define macip_acl_interface_list_details { u32 context; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; 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; + vl_api_interface_index_t 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]; + option vat_help = " | sw_if_index input [ethertype list] output [ethertype list]"; +}; + +/** \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; + vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */ + option vat_help = "[ | sw_if_index ]"; +}; + +/** \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; + vl_api_interface_index_t 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; + option vat_help = "[disable]"; +};