X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=2dedea62123a0cbf61e8fb44944dbcb508aac86c;hb=e5d34919b;hp=0c230c5fd5477b4b824a7572d67926a6c0d0e233;hpb=f995c7122ba0d024b17bc3232e8edd18d5e25088;p=vpp.git diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api index 0c230c5fd54..2dedea62123 100644 --- a/src/plugins/acl/acl.api +++ b/src/plugins/acl/acl.api @@ -21,6 +21,8 @@ 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 @param context - sender context, to match reply w/ request @@ -90,85 +92,6 @@ define acl_plugin_get_conn_table_max_entries_reply u64 conn_table_max_entries; }; -/** \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 -{ - 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; -}; - -/** \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 -*/ - -typeonly manual_print define macip_acl_rule -{ - 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; -}; - /** \brief Replace an existing ACL in-place or create a new ACL @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -186,6 +109,7 @@ manual_print manual_endian define acl_add_replace u8 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 @@ -212,6 +136,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 */ @@ -237,6 +162,7 @@ autoreply manual_print define acl_interface_add_del u8 is_input; u32 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 @@ -256,6 +182,7 @@ autoreply manual_print define acl_interface_set_acl_list 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 @@ -274,6 +201,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 @@ -304,6 +232,7 @@ define acl_interface_list_dump u32 client_index; u32 context; u32 sw_if_index; /* ~0 for all interfaces */ + option vat_help = "[ | sw_if_index ]"; }; /** \brief Details about a single ACL contents @@ -338,6 +267,7 @@ manual_endian manual_print define macip_acl_add u8 tag[64]; u32 count; vl_api_macip_acl_rule_t r[count]; + option vat_help = "..."; }; /** \brief Reply to add MACIP ACL @@ -370,6 +300,7 @@ manual_endian manual_print define macip_acl_add_replace u8 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 @@ -396,6 +327,7 @@ 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 @@ -414,6 +346,7 @@ autoreply manual_print define macip_acl_interface_add_del /* MACIP ACLs are always input */ u32 sw_if_index; u32 acl_index; + option vat_help = " | sw_if_index [add|del] acl "; }; /** \brief Dump one or all defined MACIP ACLs @@ -427,6 +360,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 @@ -515,6 +449,7 @@ autoreply manual_print define acl_interface_set_etype_whitelist 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 @@ -528,6 +463,7 @@ define acl_interface_etype_whitelist_dump u32 client_index; u32 context; u32 sw_if_index; /* ~0 for all interfaces */ + option vat_help = "[ | sw_if_index ]"; }; /** \brief Details about ethertype whitelist on a single interface @@ -558,4 +494,5 @@ autoreply define acl_stats_intf_counters_enable u32 client_index; u32 context; bool enable; + option vat_help = "[disable]"; };