src/vnet/session/session.api

   1 /*
   2  * Copyright (c) 2015-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "3.0.0";
  17
  18 import "vnet/interface_types.api";
  19 import "vnet/ip/ip_types.api";
  20
  21
  22 enum transport_proto : u8
  23 {
  24         TRANSPORT_PROTO_API_TCP,
  25         TRANSPORT_PROTO_API_UDP,
  26         TRANSPORT_PROTO_API_NONE,
  27         TRANSPORT_PROTO_API_TLS,
  28         TRANSPORT_PROTO_API_UDPC,
  29         TRANSPORT_PROTO_API_QUIC,
  30 };
  31
  32 /** \brief Application attach to session layer
  33     @param client_index - opaque cookie to identify the sender
  34     @param context - sender context, to match reply w/ request
  35     @param options - segment size, fifo sizes, etc.
  36     @param namespace_id - string
  37 */
  38  define app_attach {
  39     u32 client_index;
  40     u32 context;
  41     u64 options[17];
  42     string namespace_id[];
  43  };
  44
  45  /** \brief Application attach reply
  46     @param context - sender context, to match reply w/ request
  47     @param retval - return code for the request
  48     @param app_mq - app message queue
  49     @param vpp_ctrl_mq - vpp message queue for control events that should
  50                                          be handled in main thread, i.e., bind/connect
  51     @param vpp_ctrl_mq_thread_index - thread index of the ctrl mq
  52     @param app_index - index of the newly created app
  53     @param n_fds - number of fds exchanged
  54     @param fd_flags - set of flags that indicate which fds are to be expected
  55                                   over the socket (set only if socket transport available)
  56     @param segment_size - size of first shm segment
  57     @param segment_handle - handle for segment
  58     @param segment_name - name of segment client needs to attach to
  59 */
  60 define app_attach_reply {
  61     u32 context;
  62     i32 retval;
  63     u64 app_mq;
  64     u64 vpp_ctrl_mq;
  65     u8 vpp_ctrl_mq_thread;
  66     u32 app_index;
  67     u8 n_fds;
  68     u8 fd_flags;
  69     u32 segment_size;
  70     u64 segment_handle;
  71     string segment_name[];
  72 };
  73
  74  /** \brief client->vpp, attach application to session layer
  75     @param client_index - opaque cookie to identify the sender
  76     @param context - sender context, to match reply w/ request
  77 */
  78 autoreply define application_detach {
  79     u32 client_index;
  80     u32 context;
  81 };
  82
  83 /** \brief Add certificate and key
  84     @param client_index - opaque cookie to identify the sender
  85     @param context - sender context, to match reply w/ request
  86     @param engine - crypto engine
  87     @param cert_len - cert length (comes first)
  88     @param certkey_len - cert and key length
  89     @param certkey - cert & key data (due to API limitation)
  90 */
  91 define app_add_cert_key_pair {
  92     u32 client_index;
  93     u32 context;
  94     u16 cert_len;
  95     u16 certkey_len;
  96     u8 certkey[certkey_len];
  97 };
  98
  99 /** \brief Add certificate and key
 100     @param context - sender context, to match reply w/ request
 101     @param retval - return code for the request
 102     @param index - index in certificate store
 103 */
 104 define app_add_cert_key_pair_reply {
 105     u32 context;
 106     i32 retval;
 107     u32 index;
 108 };
 109
 110 /** \brief Delete certificate and key
 111     @param client_index - opaque cookie to identify the sender
 112     @param context - sender context, to match reply w/ request
 113     @param index - index in certificate store
 114 */
 115 autoreply define app_del_cert_key_pair {
 116     u32 client_index;
 117     u32 context;
 118     u32 index;
 119 };
 120
 121 /** \brief Application add TLS certificate
 122         ### WILL BE DEPRECATED POST 20.01 ###
 123     @param client_index - opaque cookie to identify the sender
 124     @param context - sender context, to match reply w/ request
 125     @param cert_len - certificate length
 126     @param cert - certificate as a string
 127 */
 128 autoreply define application_tls_cert_add {
 129     u32 client_index;
 130     u32 context;
 131     u32 app_index;
 132     u16 cert_len;
 133     u8 cert[cert_len];
 134 };
 135
 136 /** \brief Application add TLS key
 137         ### WILL BE DEPRECATED POST 20.01 ###
 138     @param client_index - opaque cookie to identify the sender
 139     @param context - sender context, to match reply w/ request
 140     @param key_len - certificate length
 141     @param key - PEM encoded key as a string
 142 */
 143 autoreply define application_tls_key_add {
 144     u32 client_index;
 145     u32 context;
 146     u32 app_index;
 147     u16 key_len;
 148     u8 key[key_len];
 149 };
 150
 151 /** \brief add/del application worker
 152     @param client_index - opaque cookie to identify the sender
 153                           client to vpp direction only
 154     @param context - sender context, to match reply w/ request
 155     @param app_index - application index
 156     @param wrk_index - worker index, if a delete
 157     @param is_add - set if an add
 158 */
 159 define app_worker_add_del
 160 {
 161   u32 client_index;
 162   u32 context;
 163   u32 app_index;
 164   u32 wrk_index;
 165   bool is_add [default=true];
 166 };
 167
 168 /** \brief Reply for app worker add/del
 169     @param context - returned sender context, to match reply w/ request
 170     @param retval - return code
 171     @param wrk_index - worker index, if add
 172     @param app_event_queue_address - vpp event queue address of new worker
 173     @param n_fds - number of fds exchanged
 174     @param fd_flags - set of flags that indicate which fds are to be expected
 175                                   over the socket (set only if socket transport available)
 176     @param segment_handle - handle for segment
 177     @param is_add - add if non zero, else delete
 178     @param segment_name - name of segment client needs to attach to
 179 */
 180 define app_worker_add_del_reply
 181 {
 182   u32 context;
 183   i32 retval;
 184   u32 wrk_index;
 185   u64 app_event_queue_address;
 186   u8 n_fds;
 187   u8 fd_flags;
 188   u64 segment_handle;
 189   bool is_add [default=true];
 190   string segment_name[];
 191 };
 192
 193 /** \brief enable/disable session layer
 194     @param client_index - opaque cookie to identify the sender
 195                           client to vpp direction only
 196     @param context - sender context, to match reply w/ request
 197     @param is_enable - disable session layer if 0, enable otherwise
 198 */
 199 autoreply define session_enable_disable {
 200   u32 client_index;
 201   u32 context;
 202   bool is_enable [default=true];
 203 };
 204
 205 /** \brief add/del application namespace
 206     @param client_index - opaque cookie to identify the sender
 207                           client to vpp direction only
 208     @param context - sender context, to match reply w/ request
 209     @param secret - secret shared between app and vpp
 210     @param sw_if_index - local interface that "supports" namespace. Set to
 211                          ~0 if no preference
 212     @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
 213                         if sw_if_index set.
 214     @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
 215                         if sw_if_index set.
 216     @param namespace_id - namespace id
 217 */
 218 define app_namespace_add_del {
 219   u32 client_index;
 220   u32 context;
 221   u64 secret;
 222   vl_api_interface_index_t sw_if_index;
 223   u32 ip4_fib_id;
 224   u32 ip6_fib_id;
 225   string namespace_id[];
 226 };
 227
 228 /** \brief Reply for app namespace add/del
 229     @param context - returned sender context, to match reply w/ request
 230     @param retval - return code
 231     @param appns_index - app namespace index
 232 */
 233 define app_namespace_add_del_reply
 234 {
 235   u32 context;
 236   i32 retval;
 237   u32 appns_index;
 238 };
 239
 240 enum session_rule_scope {
 241         SESSION_RULE_SCOPE_API_GLOBAL = 0,
 242         SESSION_RULE_SCOPE_API_LOCAL = 1,
 243         SESSION_RULE_SCOPE_API_BOTH = 2,
 244 };
 245
 246 /** \brief add/del session rule
 247     @param client_index - opaque cookie to identify the sender
 248                           client to vpp direction only
 249     @param context - sender context, to match reply w/ request
 250     @param transport_proto - transport protocol
 251     @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
 252     @param lcl_ip - local ip
 253     @param lcl_plen - local prefix length
 254     @param rmt_ip - remote ip
 255     @param rmt_ple - remote prefix length
 256     @param lcl_port - local port
 257     @param rmt_port - remote port
 258     @param action_index - the only action defined now is forward to
 259                           application with index action_index
 260     @param is_add - flag to indicate if add or del
 261     @param appns_index - application namespace where rule is to be applied to
 262     @param scope - enum that indicates scope of the rule: global or local.
 263                    If 0, default is global, 1 is global 2 is local, 3 is both
 264     @param tag - tag
 265 */
 266 autoreply define session_rule_add_del {
 267   u32 client_index;
 268   u32 context;
 269   vl_api_transport_proto_t transport_proto;
 270   vl_api_prefix_t lcl;
 271   vl_api_prefix_t rmt;
 272   u16 lcl_port;
 273   u16 rmt_port;
 274   u32 action_index;
 275   bool is_add [default=true];
 276   u32 appns_index;
 277   vl_api_session_rule_scope_t scope;
 278   string tag[64];
 279 };
 280
 281 /** \brief Dump session rules
 282     @param client_index - opaque cookie to identify the sender
 283     @param context - sender context, to match reply w/ request
 284  */
 285 define session_rules_dump
 286 {
 287   u32 client_index;
 288   u32 context;
 289 };
 290
 291 /** \brief Session rules details
 292     @param context - sender context, to match reply w/ request
 293     @param transport_proto - transport protocol
 294     @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
 295     @param lcl_ip - local ip
 296     @param lcl_plen - local prefix length
 297     @param rmt_ip - remote ip
 298     @param rmt_ple - remote prefix length
 299     @param lcl_port - local port
 300     @param rmt_port - remote port
 301     @param action_index - the only action defined now is forward to
 302                           application with index action_index
 303     @param appns_index - application namespace where rule is to be applied to
 304     @param scope - enum that indicates scope of the rule: global or local.
 305                    If 0, default is global, 1 is global 2 is local, 3 is both
 306     @param tag - tag
 307   */
 308 define session_rules_details
 309 {
 310   u32 context;
 311   vl_api_transport_proto_t transport_proto;
 312   vl_api_prefix_t lcl;
 313   vl_api_prefix_t rmt;
 314   u16 lcl_port;
 315   u16 rmt_port;
 316   u32 action_index;
 317   u32 appns_index;
 318   vl_api_session_rule_scope_t scope;
 319   string tag[64];
 320 };
 321
 322 /*
 323  * Local Variables:
 324  * eval: (c-set-style "gnu")
 325  * End:
 326  */