session: first approximation implementation of tls
[vpp.git] / src / vnet / session / session.api
index e6f3b02..336b51c 100644 (file)
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-vl_api_version 1.0.0
+option version = "1.0.1";
 
 /** \brief client->vpp, attach application to session layer
     @param client_index - opaque cookie to identify the sender
@@ -51,6 +51,34 @@ define application_attach_reply {
     u8 segment_name[128];
 };
 
+/** \brief Application add TLS certificate
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param cert_len - certificate length
+    @param cert - certificate as a string
+*/
+autoreply define application_tls_cert_add {
+    u32 client_index;
+    u32 context;
+    u32 app_index;
+    u16 cert_len;
+    u8 cert[cert_len];
+};
+
+/** \brief Application add TLS key
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param key_len - certificate length
+    @param key - PEM encoded key as a string
+*/
+autoreply define application_tls_key_add {
+    u32 client_index;
+    u32 context;
+    u32 app_index;
+    u16 key_len;
+    u8 key[key_len];
+};
+
  /** \brief client->vpp, attach application to session layer
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -72,6 +100,17 @@ autoreply define map_another_segment {
     u8 segment_name[128];
 };
 
+/** \brief vpp->client unmap shared memory segment
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param segment_name - 
+*/
+autoreply define unmap_segment {
+    u32 client_index;
+    u32 context;
+    u8 segment_name[128];
+};
+
  /** \brief Bind to a given URI
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -122,10 +161,12 @@ autoreply define connect_uri {
     @param context - sender context, to match reply w/ request
     @param listener_handle - tells client which listener this pertains to
     @param handle - unique session identifier
-    @param session_thread_index - thread index of new session
     @param rx_fifo_address - rx (vpp -> vpp-client) fifo address 
     @param tx_fifo_address - tx (vpp-client -> vpp) fifo address 
-    @param vpp_event_queue_address - vpp's event queue address
+    @param vpp_event_queue_address - vpp's event queue address or client's
+                                                                       event queue for cut through
+    @param server_event_queue_address - server's event queue address for
+                                                                          cut through sessions
     @param port - remote port
     @param is_ip4 - 1 if the ip is ip4
     @param ip - remote ip
@@ -138,6 +179,7 @@ define accept_session {
   u64 server_rx_fifo;
   u64 server_tx_fifo;
   u64 vpp_event_queue_address;
+  u64 server_event_queue_address;
   u16 port;
   u8 is_ip4;
   u8 ip[16];
@@ -176,7 +218,6 @@ define disconnect_session {
     @param handle - session handle
 */
 define disconnect_session_reply {
-  u32 client_index;
   u32 context;
   i32 retval;
   u64 handle;
@@ -278,6 +319,9 @@ define bind_sock_reply {
   u64 handle;
   i32 retval;
   u64 server_event_queue_address;
+  u8 lcl_is_ip4;
+  u8 lcl_ip[16];
+  u16 lcl_port;
   u32 segment_size;
   u8 segment_name_length;
   u8 segment_name[128];
@@ -299,6 +343,7 @@ define connect_session {
     @param server_rx_fifo - rx (vpp -> vpp-client) fifo address 
     @param server_tx_fifo - tx (vpp-client -> vpp) fifo address 
     @param vpp_event_queue_address - vpp's event queue address
+    @param client_event_queue_address - client's event queue address
     @param segment_size - size of segment to be attached. Only for redirects.
     @param segment_name_length - non-zero if the client needs to attach to 
                                  the fifo segment
@@ -314,6 +359,7 @@ define connect_session_reply {
   u64 server_rx_fifo;
   u64 server_tx_fifo;
   u64 vpp_event_queue_address;
+  u64 client_event_queue_address;
   u32 segment_size;
   u8 segment_name_length;
   u8 segment_name[128];
@@ -348,7 +394,7 @@ autoreply define session_enable_disable {
     @param namespace_id_len - length of namespace id lower
     @param namespace_id - namespace id
 */
-autoreply define app_namespace_add_del {
+define app_namespace_add_del {
   u32 client_index;
   u32 context;
   u64 secret;
@@ -359,6 +405,18 @@ autoreply define app_namespace_add_del {
   u8 namespace_id[64];
 };
 
+/** \brief Reply for app namespace add/del
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param appns_index - app namespace index
+*/
+define app_namespace_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 appns_index;
+};
+
 /** \brief add/del session rule
     @param client_index - opaque cookie to identify the sender
                           client to vpp direction only
@@ -395,6 +453,52 @@ autoreply define session_rule_add_del {
   u8 is_add;
   u32 appns_index;
   u8 scope;
+  u8 tag[64];
+};
+
+/** \brief Dump session rules
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+ */
+define session_rules_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Session rules details
+       @param context - sender context, to match reply w/ request
+    @param transport_proto - transport protocol (0 - tcp 1 - udp)
+    @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
+    @param lcl_ip - local ip
+    @param lcl_plen - local prefix length
+    @param rmt_ip - remote ip
+    @param rmt_ple - remote prefix length
+    @param lcl_port - local port
+    @param rmt_port - remote port
+    @param action_index - the only action defined now is forward to
+                                                 application with index action_index
+       @param appns_index - application namespace where rule is to be applied
+                                                to
+       @param scope - flag that indicates scope of the rule: global or local.
+                                  If 0, default is global, 1 is global 2 is local, 3 is
+                                  both
+  */
+define session_rules_details
+{
+  u32 context;
+  u8 transport_proto;
+  u8 is_ip4;
+  u8 lcl_ip[16];
+  u8 lcl_plen;
+  u8 rmt_ip[16];
+  u8 rmt_plen;
+  u16 lcl_port;
+  u16 rmt_port;
+  u32 action_index;
+  u32 appns_index;
+  u8 scope;
+  u8 tag[64];
 };
 
 /*