FD.io VPP  v21.01.1
Vector Packet Processing
session.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2020 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.2.0";
17 
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
20 
21 
23 {
29 };
30 
31 /** \brief Application attach to session layer
32  @param client_index - opaque cookie to identify the sender
33  @param context - sender context, to match reply w/ request
34  @param options - segment size, fifo sizes, etc.
35  @param namespace_id - string
36 */
37  define app_attach {
40  u64 options[18];
41  string namespace_id[];
42  };
43 
44 /** \brief Application attach reply
45  @param context - sender context, to match reply w/ request
46  @param retval - return code for the request
47  @param app_mq - app message queue
48  @param vpp_ctrl_mq - vpp message queue for control events that should
49  be handled in main thread, i.e., bind/connect
50  @param vpp_ctrl_mq_thread_index - thread index of the ctrl mq
51  @param app_index - index of the newly created app
52  @param n_fds - number of fds exchanged
53  @param fd_flags - set of flags that indicate which fds are to be expected
54  over the socket (set only if socket transport available)
55  @param segment_size - size of first shm segment
56  @param segment_handle - handle for segment
57  @param segment_name - name of segment client needs to attach to
58 */
59 define app_attach_reply {
70  string segment_name[];
71 };
72 
73 /** \brief Application detach from session layer
74  @param client_index - opaque cookie to identify the sender
75  @param context - sender context, to match reply w/ request
76 */
77 autoreply define application_detach {
80 };
81 
82 /** \brief Add certificate and key
83  @param client_index - opaque cookie to identify the sender
84  @param context - sender context, to match reply w/ request
85  @param engine - crypto engine
86  @param cert_len - cert length (comes first)
87  @param certkey_len - cert and key length
88  @param certkey - cert & key data (due to API limitation)
89 */
90 define app_add_cert_key_pair {
95  u8 certkey[certkey_len];
96 };
97 
98 /** \brief Add certificate and key
99  @param context - sender context, to match reply w/ request
100  @param retval - return code for the request
101  @param index - index in certificate store
102 */
103 define app_add_cert_key_pair_reply {
107 };
108 
109 /** \brief Delete certificate and key
110  @param client_index - opaque cookie to identify the sender
111  @param context - sender context, to match reply w/ request
112  @param index - index in certificate store
113 */
114 autoreply define app_del_cert_key_pair {
118 };
119 
120 /** \brief Application add TLS certificate
121  ### WILL BE DEPRECATED POST 20.01 ###
122  @param client_index - opaque cookie to identify the sender
123  @param context - sender context, to match reply w/ request
124  @param cert_len - certificate length
125  @param cert - certificate as a string
126 */
127 autoreply define application_tls_cert_add {
132  u8 cert[cert_len];
133 };
134 
135 /** \brief Application add TLS key
136  ### WILL BE DEPRECATED POST 20.01 ###
137  @param client_index - opaque cookie to identify the sender
138  @param context - sender context, to match reply w/ request
139  @param key_len - certificate length
140  @param key - PEM encoded key as a string
141 */
142 autoreply define application_tls_key_add {
148 };
149 
150 /** \brief add/del application worker
151  @param client_index - opaque cookie to identify the sender
152  client to vpp direction only
153  @param context - sender context, to match reply w/ request
154  @param app_index - application index
155  @param wrk_index - worker index, if a delete
156  @param is_add - set if an add
157 */
158 define app_worker_add_del
159 {
164  bool is_add [default=true];
165 };
166 
167 /** \brief Reply for app worker add/del
168  @param context - returned sender context, to match reply w/ request
169  @param retval - return code
170  @param wrk_index - worker index, if add
171  @param app_event_queue_address - vpp event queue address of new worker
172  @param n_fds - number of fds exchanged
173  @param fd_flags - set of flags that indicate which fds are to be expected
174  over the socket (set only if socket transport available)
175  @param segment_handle - handle for segment
176  @param is_add - add if non zero, else delete
177  @param segment_name - name of segment client needs to attach to
178 */
179 define app_worker_add_del_reply
180 {
188  bool is_add [default=true];
189  string segment_name[];
190 };
191 
192 /** \brief enable/disable session layer
193  @param client_index - opaque cookie to identify the sender
194  client to vpp direction only
195  @param context - sender context, to match reply w/ request
196  @param is_enable - disable session layer if 0, enable otherwise
197 */
198 autoreply define session_enable_disable {
201  bool is_enable [default=true];
202 };
203 
204 /** \brief add/del application namespace
205  @param client_index - opaque cookie to identify the sender
206  client to vpp direction only
207  @param context - sender context, to match reply w/ request
208  @param secret - secret shared between app and vpp
209  @param sw_if_index - local interface that "supports" namespace. Set to
210  ~0 if no preference
211  @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
212  if sw_if_index set.
213  @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
214  if sw_if_index set.
215  @param namespace_id - namespace id
216 */
217 define app_namespace_add_del {
221  vl_api_interface_index_t sw_if_index [default=0xffffffff];
224  string namespace_id[];
225 };
226 
227 /** \brief Reply for app namespace add/del
228  @param context - returned sender context, to match reply w/ request
229  @param retval - return code
230  @param appns_index - app namespace index
231 */
232 define app_namespace_add_del_reply
233 {
237 };
238 
243 };
244 
245 /** \brief add/del session rule
246  @param client_index - opaque cookie to identify the sender
247  client to vpp direction only
248  @param context - sender context, to match reply w/ request
249  @param transport_proto - transport protocol
250  @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
251  @param lcl_ip - local ip
252  @param lcl_plen - local prefix length
253  @param rmt_ip - remote ip
254  @param rmt_ple - remote prefix length
255  @param lcl_port - local port
256  @param rmt_port - remote port
257  @param action_index - the only action defined now is forward to
258  application with index action_index
259  @param is_add - flag to indicate if add or del
260  @param appns_index - application namespace where rule is to be applied to
261  @param scope - enum that indicates scope of the rule: global or local.
262  If 0, default is global, 1 is global 2 is local, 3 is both
263  @param tag - tag
264 */
265 autoreply define session_rule_add_del {
268  vl_api_transport_proto_t transport_proto;
269  vl_api_prefix_t lcl;
270  vl_api_prefix_t rmt;
274  bool is_add [default=true];
276  vl_api_session_rule_scope_t scope;
277  string tag[64];
278 };
279 
280 /** \brief Dump session rules
281  @param client_index - opaque cookie to identify the sender
282  @param context - sender context, to match reply w/ request
283  */
284 define session_rules_dump
285 {
288 };
289 
290 /** \brief Session rules details
291  @param context - sender context, to match reply w/ request
292  @param transport_proto - transport protocol
293  @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
294  @param lcl_ip - local ip
295  @param lcl_plen - local prefix length
296  @param rmt_ip - remote ip
297  @param rmt_ple - remote prefix length
298  @param lcl_port - local port
299  @param rmt_port - remote port
300  @param action_index - the only action defined now is forward to
301  application with index action_index
302  @param appns_index - application namespace where rule is to be applied to
303  @param scope - enum that indicates scope of the rule: global or local.
304  If 0, default is global, 1 is global 2 is local, 3 is both
305  @param tag - tag
306  */
307 define session_rules_details
308 {
310  vl_api_transport_proto_t transport_proto;
311  vl_api_prefix_t lcl;
312  vl_api_prefix_t rmt;
317  vl_api_session_rule_scope_t scope;
318  string tag[64];
319 };
320 
321 /*
322  * Local Variables:
323  * eval: (c-set-style "gnu")
324  * End:
325  */
transport_proto
Definition: session.api:22
vl_api_transport_proto_t transport_proto
Definition: session.api:310
unsigned long u64
Definition: types.h:89
vl_api_transport_proto_t transport_proto
Definition: session.api:268
vl_api_session_rule_scope_t scope
Definition: session.api:276
u16 key_len
Definition: ikev2_types.api:95
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
option version
Definition: session.api:16
unsigned short u16
Definition: types.h:57
signed int i32
Definition: types.h:77
vl_api_session_rule_scope_t scope
Definition: session.api:317
typedef key
Definition: ipsec_types.api:86
session_rule_scope
Definition: session.api:239
static struct option options[]
Definition: main.c:52
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34