X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Facl%2Facl.api;h=b58ed76673a834859af9437a2e2dc105cfae751a;hb=27fe75a;hp=58a5a17180e087efec829621368b2111e406a22e;hpb=cb034b9b374927c7552e36dcbc306d8456b2a0cb;p=vpp.git diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api index 58a5a17180e..b58ed76673a 100644 --- a/src/plugins/acl/acl.api +++ b/src/plugins/acl/acl.api @@ -19,6 +19,7 @@ used to control the ACL plugin */ +option version = "1.0.0"; /** \brief Get the plugin version @param client_index - opaque cookie to identify the sender @@ -44,6 +45,30 @@ define acl_plugin_get_version_reply u32 minor; }; +/** \brief Control ping from client to api server request + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define acl_plugin_control_ping +{ + u32 client_index; + u32 context; +}; + +/** \brief Control ping from the client to the server response + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param retval - return code for the request + @param vpe_pid - the pid of the vpe, returned by the server +*/ +define acl_plugin_control_ping_reply +{ + u32 context; + i32 retval; + u32 client_index; + 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) @@ -60,7 +85,7 @@ define acl_plugin_get_version_reply @param tcp_flags_value - if proto==6, mask to AND the TCP flags in the packet with */ -typeonly manual_print manual_endian define acl_rule +typeonly manual_print define acl_rule { u8 is_permit; u8 is_ipv6; @@ -104,7 +129,7 @@ typeonly manual_print manual_endian define acl_rule @param src_ip_prefix_len - Source prefix length */ -typeonly manual_print manual_endian define macip_acl_rule +typeonly manual_print define macip_acl_rule { u8 is_permit; u8 is_ipv6; @@ -161,24 +186,13 @@ define acl_add_replace_reply @param acl_index - ACL index to delete */ -define acl_del +autoreply manual_print define acl_del { u32 client_index; u32 context; u32 acl_index; }; -/** \brief Reply to delete the ACL - @param context - returned sender context, to match reply w/ request - @param retval 0 - no error -*/ - -define acl_del_reply -{ - u32 context; - i32 retval; -}; - /* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */ /** \brief Use acl_interface_set_acl_list instead Append/remove an ACL index to/from the list of ACLs checked for an interface @@ -190,7 +204,7 @@ define acl_del_reply @param acl_index - index of ACL for the operation */ -define acl_interface_add_del +autoreply manual_print define acl_interface_add_del { u32 client_index; u32 context; @@ -204,17 +218,6 @@ define acl_interface_add_del u32 acl_index; }; -/** \brief Reply to alter the ACL list - @param context - returned sender context, to match reply w/ request - @param retval 0 - no error -*/ - -define acl_interface_add_del_reply -{ - u32 context; - i32 retval; -}; - /** \brief Set the vector of input/output ACLs checked for an interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -224,7 +227,7 @@ define acl_interface_add_del_reply @param acls - vector of ACL indices */ -manual_endian define acl_interface_set_acl_list +autoreply manual_print define acl_interface_set_acl_list { u32 client_index; u32 context; @@ -239,12 +242,6 @@ manual_endian define acl_interface_set_acl_list @param retval 0 - no error */ -define acl_interface_set_acl_list_reply -{ - u32 context; - i32 retval; -}; - /** \brief Dump the specific ACL contents or all of the ACLs' contents @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -266,7 +263,7 @@ define acl_dump @param r - Array of rules within this ACL */ -manual_print manual_endian define acl_details +manual_endian manual_print define acl_details { u32 context; u32 acl_index; @@ -296,7 +293,7 @@ define acl_interface_list_dump @param acls - the vector of ACL indices */ -manual_endian define acl_interface_list_details +define acl_interface_list_details { u32 context; u32 sw_if_index; @@ -309,11 +306,11 @@ manual_endian 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 */ -manual_print manual_endian define macip_acl_add +manual_endian manual_print define macip_acl_add { u32 client_index; u32 context; @@ -324,7 +321,7 @@ manual_print manual_endian define macip_acl_add /** \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 */ @@ -335,63 +332,73 @@ define macip_acl_add_reply i32 retval; }; -/** \brief Delete a MACIP ACL +/** \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 - MACIP ACL index to delete + @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 */ -define macip_acl_del +manual_endian manual_print define macip_acl_add_replace { u32 client_index; u32 context; - u32 acl_index; + u32 acl_index; /* ~0 to add, existing MACIP ACL# to replace */ + u8 tag[64]; + u32 count; + vl_api_macip_acl_rule_t r[count]; }; -/** \brief Reply to delete the MACIP ACL +/** \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_del_reply +define macip_acl_add_replace_reply { u32 context; + u32 acl_index; i32 retval; }; -/** \brief Add or delete a MACIP ACL to/from interface +/** \brief Delete a MACIP ACL @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 sw_if_index - interface to apply the action to - @param acl_index - MACIP ACL index + @param acl_index - MACIP ACL index to delete */ -define macip_acl_interface_add_del +autoreply manual_print define macip_acl_del { u32 client_index; u32 context; - u8 is_add; - /* macip ACLs are always input */ - u32 sw_if_index; u32 acl_index; }; -/** \brief Reply to apply/unapply the MACIP ACL - @param context - returned sender context, to match reply w/ request - @param retval 0 - no error +/** \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) MACIP ACL from being used on an interface + @param sw_if_index - interface to apply the action to + @param acl_index - MACIP ACL index */ -define macip_acl_interface_add_del_reply +autoreply manual_print define macip_acl_interface_add_del { + u32 client_index; u32 context; - i32 retval; + u8 is_add; + /* MACIP ACLs are always input */ + u32 sw_if_index; + u32 acl_index; }; /** \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 @@ -406,10 +413,10 @@ 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_print manual_endian define macip_acl_details +manual_endian manual_print define macip_acl_details { u32 context; u32 acl_index; @@ -432,7 +439,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 @@ -442,3 +449,80 @@ define macip_acl_interface_get_reply u32 acls[count]; }; +/** \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 MACIP ACL list for +*/ + +define macip_acl_interface_list_dump +{ + u32 client_index; + u32 context; + u32 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 MACIP ACLs is applied + @param count - total length of acl indices vector + @param acls - the vector of MACIP ACL indices +*/ + +define macip_acl_interface_list_details +{ + u32 context; + u32 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; + 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]; +}; +