FD.io VPP  v21.06-3-gbb25fbf28
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 = "4.0.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 {
128  option deprecated="to be removed post 21.06";
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  option deprecated="to be removed post 21.06";
150 };
151 
152 /** \brief add/del application worker
153  @param client_index - opaque cookie to identify the sender
154  client to vpp direction only
155  @param context - sender context, to match reply w/ request
156  @param app_index - application index
157  @param wrk_index - worker index, if a delete
158  @param is_add - set if an add
159 */
160 define app_worker_add_del
161 {
166  bool is_add [default=true];
167 };
168 
169 /** \brief Reply for app worker add/del
170  @param context - returned sender context, to match reply w/ request
171  @param retval - return code
172  @param wrk_index - worker index, if add
173  @param app_event_queue_address - vpp event queue address of new worker
174  @param n_fds - number of fds exchanged
175  @param fd_flags - set of flags that indicate which fds are to be expected
176  over the socket (set only if socket transport available)
177  @param segment_handle - handle for segment
178  @param is_add - add if non zero, else delete
179  @param segment_name - name of segment client needs to attach to
180 */
181 define app_worker_add_del_reply
182 {
190  bool is_add [default=true];
191  string segment_name[];
192 };
193 
194 /** \brief enable/disable session layer
195  @param client_index - opaque cookie to identify the sender
196  client to vpp direction only
197  @param context - sender context, to match reply w/ request
198  @param is_enable - disable session layer if 0, enable otherwise
199 */
200 autoreply define session_enable_disable {
203  bool is_enable [default=true];
204 };
205 
206 /** \brief add/del application namespace
207  @param client_index - opaque cookie to identify the sender
208  client to vpp direction only
209  @param context - sender context, to match reply w/ request
210  @param secret - secret shared between app and vpp
211  @param sw_if_index - local interface that "supports" namespace. Set to
212  ~0 if no preference
213  @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
214  if sw_if_index set.
215  @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
216  if sw_if_index set.
217  @param namespace_id - namespace id
218 */
219 define app_namespace_add_del {
223  vl_api_interface_index_t sw_if_index [default=0xffffffff];
226  string namespace_id[];
227 };
228 
229 /** \brief Reply for app namespace add/del
230  @param context - returned sender context, to match reply w/ request
231  @param retval - return code
232  @param appns_index - app namespace index
233 */
234 define app_namespace_add_del_reply
235 {
239 };
240 
245 };
246 
247 /** \brief add/del session rule
248  @param client_index - opaque cookie to identify the sender
249  client to vpp direction only
250  @param context - sender context, to match reply w/ request
251  @param transport_proto - transport protocol
252  @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
253  @param lcl_ip - local ip
254  @param lcl_plen - local prefix length
255  @param rmt_ip - remote ip
256  @param rmt_ple - remote prefix length
257  @param lcl_port - local port
258  @param rmt_port - remote port
259  @param action_index - the only action defined now is forward to
260  application with index action_index
261  @param is_add - flag to indicate if add or del
262  @param appns_index - application namespace where rule is to be applied to
263  @param scope - enum that indicates scope of the rule: global or local.
264  If 0, default is global, 1 is global 2 is local, 3 is both
265  @param tag - tag
266 */
267 autoreply define session_rule_add_del {
270  vl_api_transport_proto_t transport_proto;
271  vl_api_prefix_t lcl;
272  vl_api_prefix_t rmt;
276  bool is_add [default=true];
278  vl_api_session_rule_scope_t scope;
279  string tag[64];
280 };
281 
282 /** \brief Dump session rules
283  @param client_index - opaque cookie to identify the sender
284  @param context - sender context, to match reply w/ request
285  */
286 define session_rules_dump
287 {
290 };
291 
292 /** \brief Session rules details
293  @param context - sender context, to match reply w/ request
294  @param transport_proto - transport protocol
295  @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
296  @param lcl_ip - local ip
297  @param lcl_plen - local prefix length
298  @param rmt_ip - remote ip
299  @param rmt_ple - remote prefix length
300  @param lcl_port - local port
301  @param rmt_port - remote port
302  @param action_index - the only action defined now is forward to
303  application with index action_index
304  @param appns_index - application namespace where rule is to be applied to
305  @param scope - enum that indicates scope of the rule: global or local.
306  If 0, default is global, 1 is global 2 is local, 3 is both
307  @param tag - tag
308  */
309 define session_rules_details
310 {
312  vl_api_transport_proto_t transport_proto;
313  vl_api_prefix_t lcl;
314  vl_api_prefix_t rmt;
319  vl_api_session_rule_scope_t scope;
320  string tag[64];
321 };
322 
323 /*
324  * Local Variables:
325  * eval: (c-set-style "gnu")
326  * End:
327  */
vl_api_app_worker_add_del_reply_t::segment_name
string segment_name[]
Definition: session.api:191
vl_api_application_tls_cert_add_t::deprecated
option deprecated
Definition: session.api:128
vl_api_session_rules_details_t
Session rules details.
Definition: session.api:309
vl_api_session_rules_details_t::transport_proto
vl_api_transport_proto_t transport_proto
Definition: session.api:312
vl_api_app_attach_t::namespace_id
string namespace_id[]
Definition: session.api:41
vl_api_session_rules_dump_t
Dump session rules.
Definition: session.api:286
SESSION_RULE_SCOPE_API_GLOBAL
@ SESSION_RULE_SCOPE_API_GLOBAL
Definition: session.api:242
vl_api_session_rule_add_del_t::tag
string tag[64]
Definition: session.api:279
vl_api_app_worker_add_del_reply_t::segment_handle
u64 segment_handle
Definition: session.api:189
vl_api_app_add_cert_key_pair_t
Add certificate and key.
Definition: session.api:90
vl_api_application_detach_t
Application detach from session layer.
Definition: session.api:77
vl_api_session_rule_add_del_t::rmt
vl_api_prefix_t rmt
Definition: session.api:272
vl_api_application_tls_key_add_t::deprecated
option deprecated
Definition: session.api:144
vl_api_application_detach_t::context
u32 context
Definition: session.api:79
vl_api_app_worker_add_del_t::client_index
u32 client_index
Definition: session.api:162
vl_api_app_attach_reply_t::segment_handle
u64 segment_handle
Definition: session.api:69
vl_api_app_add_cert_key_pair_t::client_index
u32 client_index
Definition: session.api:91
vl_api_session_rule_add_del_t::is_add
bool is_add[default=true]
Definition: session.api:276
vl_api_app_attach_t::context
u32 context
Definition: session.api:39
vl_api_app_namespace_add_del_t::sw_if_index
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: session.api:223
vl_api_app_attach_reply_t::retval
i32 retval
Definition: session.api:61
vl_api_session_rule_add_del_t
add/del session rule
Definition: session.api:267
vl_api_session_rules_details_t::rmt_port
u16 rmt_port
Definition: session.api:316
vl_api_app_worker_add_del_t::context
u32 context
Definition: session.api:163
vl_api_app_worker_add_del_reply_t::fd_flags
u8 fd_flags
Definition: session.api:188
vl_api_app_add_cert_key_pair_t::certkey_len
u16 certkey_len
Definition: session.api:94
TRANSPORT_PROTO_API_QUIC
@ TRANSPORT_PROTO_API_QUIC
Definition: session.api:28
vl_api_app_del_cert_key_pair_t::index
u32 index
Definition: session.api:117
vl_api_app_worker_add_del_reply_t
Reply for app worker add/del.
Definition: session.api:181
vl_api_app_add_cert_key_pair_t::context
u32 context
Definition: session.api:92
vl_api_app_add_cert_key_pair_t::certkey
u8 certkey[certkey_len]
Definition: session.api:95
u16
unsigned short u16
Definition: types.h:57
vl_api_app_namespace_add_del_t::ip4_fib_id
u32 ip4_fib_id
Definition: session.api:224
vl_api_session_rules_details_t::context
u32 context
Definition: session.api:311
vl_api_application_tls_cert_add_t::client_index
u32 client_index
Definition: session.api:129
vl_api_app_add_cert_key_pair_reply_t::retval
i32 retval
Definition: session.api:105
vl_api_session_rules_dump_t::context
u32 context
Definition: session.api:289
vl_api_app_attach_reply_t::app_mq
u64 app_mq
Definition: session.api:62
TRANSPORT_PROTO_API_NONE
@ TRANSPORT_PROTO_API_NONE
Definition: session.api:26
vl_api_app_del_cert_key_pair_t::context
u32 context
Definition: session.api:116
vl_api_application_tls_key_add_t::key_len
u16 key_len
Definition: session.api:148
vl_api_session_rules_details_t::appns_index
u32 appns_index
Definition: session.api:318
TRANSPORT_PROTO_API_TLS
@ TRANSPORT_PROTO_API_TLS
Definition: session.api:27
key
typedef key
Definition: ipsec_types.api:88
i32
signed int i32
Definition: types.h:77
vl_api_application_detach_t::client_index
u32 client_index
Definition: session.api:78
vl_api_session_rules_details_t::rmt
vl_api_prefix_t rmt
Definition: session.api:314
vl_api_session_rule_add_del_t::action_index
u32 action_index
Definition: session.api:275
vl_api_application_tls_key_add_t::app_index
u32 app_index
Definition: session.api:147
vl_api_app_namespace_add_del_t::secret
u64 secret
Definition: session.api:222
vl_api_app_attach_t
Application attach to session layer.
Definition: session.api:37
vl_api_application_tls_key_add_t::context
u32 context
Definition: session.api:146
vl_api_app_attach_reply_t::app_index
u32 app_index
Definition: session.api:65
vl_api_app_namespace_add_del_t::context
u32 context
Definition: session.api:221
vl_api_app_worker_add_del_reply_t::context
u32 context
Definition: session.api:183
vl_api_app_namespace_add_del_reply_t::appns_index
u32 appns_index
Definition: session.api:238
vl_api_app_attach_reply_t::vpp_ctrl_mq_thread
u8 vpp_ctrl_mq_thread
Definition: session.api:64
vl_api_session_rule_add_del_t::client_index
u32 client_index
Definition: session.api:268
vl_api_session_rules_dump_t::client_index
u32 client_index
Definition: session.api:288
vl_api_session_rule_add_del_t::rmt_port
u16 rmt_port
Definition: session.api:274
vl_api_app_namespace_add_del_t::namespace_id
string namespace_id[]
Definition: session.api:226
vl_api_app_add_cert_key_pair_t::cert_len
u16 cert_len
Definition: session.api:93
vl_api_app_namespace_add_del_t::client_index
u32 client_index
Definition: session.api:220
vl_api_session_rules_details_t::action_index
u32 action_index
Definition: session.api:317
vl_api_application_tls_key_add_t::client_index
u32 client_index
Definition: session.api:145
SESSION_RULE_SCOPE_API_LOCAL
@ SESSION_RULE_SCOPE_API_LOCAL
Definition: session.api:243
vl_api_application_tls_cert_add_t::app_index
u32 app_index
Definition: session.api:131
SESSION_RULE_SCOPE_API_BOTH
@ SESSION_RULE_SCOPE_API_BOTH
Definition: session.api:244
vl_api_app_namespace_add_del_reply_t::retval
i32 retval
Definition: session.api:237
vl_api_session_rules_details_t::tag
string tag[64]
Definition: session.api:320
vl_api_app_worker_add_del_reply_t::retval
i32 retval
Definition: session.api:184
vl_api_app_del_cert_key_pair_t
Delete certificate and key.
Definition: session.api:114
session_rule_scope
session_rule_scope
Definition: session.api:241
vl_api_app_attach_reply_t::vpp_ctrl_mq
u64 vpp_ctrl_mq
Definition: session.api:63
vl_api_app_worker_add_del_t::is_add
bool is_add[default=true]
Definition: session.api:166
vl_api_session_rules_details_t::scope
vl_api_session_rule_scope_t scope
Definition: session.api:319
vl_api_app_namespace_add_del_reply_t::context
u32 context
Definition: session.api:236
vl_api_app_worker_add_del_t::wrk_index
u32 wrk_index
Definition: session.api:165
u64
unsigned long u64
Definition: types.h:89
vl_api_app_worker_add_del_t::app_index
u32 app_index
Definition: session.api:164
vl_api_application_tls_cert_add_t::context
u32 context
Definition: session.api:130
vl_api_app_worker_add_del_reply_t::wrk_index
u32 wrk_index
Definition: session.api:185
u32
unsigned int u32
Definition: types.h:88
vl_api_app_worker_add_del_reply_t::is_add
bool is_add[default=true]
Definition: session.api:190
vl_api_session_rule_add_del_t::lcl_port
u16 lcl_port
Definition: session.api:273
options
static struct option options[]
Definition: main.c:52
vl_api_session_rules_details_t::lcl_port
u16 lcl_port
Definition: session.api:315
vl_api_app_attach_t::client_index
u32 client_index
Definition: session.api:38
vl_api_session_enable_disable_t
enable/disable session layer
Definition: session.api:200
vl_api_app_attach_reply_t::segment_name
string segment_name[]
Definition: session.api:70
vl_api_app_attach_t::options
u64 options[18]
Definition: session.api:40
vl_api_session_rule_add_del_t::appns_index
u32 appns_index
Definition: session.api:277
vl_api_app_add_cert_key_pair_reply_t::index
u32 index
Definition: session.api:106
vl_api_app_attach_reply_t::context
u32 context
Definition: session.api:60
vl_api_application_tls_key_add_t::key
u8 key[key_len]
Definition: session.api:149
vl_api_app_namespace_add_del_t
add/del application namespace
Definition: session.api:219
vl_api_app_add_cert_key_pair_reply_t
Add certificate and key.
Definition: session.api:103
vl_api_session_enable_disable_t::client_index
u32 client_index
Definition: session.api:201
vl_api_session_rule_add_del_t::transport_proto
vl_api_transport_proto_t transport_proto
Definition: session.api:270
TRANSPORT_PROTO_API_UDP
@ TRANSPORT_PROTO_API_UDP
Definition: session.api:25
vl_api_app_attach_reply_t::n_fds
u8 n_fds
Definition: session.api:66
u8
unsigned char u8
Definition: types.h:56
vl_api_app_del_cert_key_pair_t::client_index
u32 client_index
Definition: session.api:115
vl_api_app_attach_reply_t::segment_size
u32 segment_size
Definition: session.api:68
vl_api_session_rule_add_del_t::scope
vl_api_session_rule_scope_t scope
Definition: session.api:278
vl_api_app_attach_reply_t::fd_flags
u8 fd_flags
Definition: session.api:67
vl_api_application_tls_cert_add_t
Application add TLS certificate.
Definition: session.api:127
vl_api_session_rules_details_t::lcl
vl_api_prefix_t lcl
Definition: session.api:313
vl_api_app_attach_reply_t
Application attach reply.
Definition: session.api:59
key_len
u16 key_len
Definition: ikev2_types.api:95
vl_api_app_namespace_add_del_reply_t
Reply for app namespace add/del.
Definition: session.api:234
transport_proto
transport_proto
Definition: session.api:22
vl_api_app_worker_add_del_reply_t::n_fds
u8 n_fds
Definition: session.api:187
TRANSPORT_PROTO_API_TCP
@ TRANSPORT_PROTO_API_TCP
Definition: session.api:24
vl_api_app_namespace_add_del_t::ip6_fib_id
u32 ip6_fib_id
Definition: session.api:225
vl_api_session_rule_add_del_t::context
u32 context
Definition: session.api:269
vl_api_session_enable_disable_t::context
u32 context
Definition: session.api:202
vl_api_app_add_cert_key_pair_reply_t::context
u32 context
Definition: session.api:104
vl_api_session_rule_add_del_t::lcl
vl_api_prefix_t lcl
Definition: session.api:271
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vl_api_application_tls_key_add_t
Application add TLS key.
Definition: session.api:143
vl_api_app_worker_add_del_t
add/del application worker
Definition: session.api:160
vl_api_application_tls_cert_add_t::cert
u8 cert[cert_len]
Definition: session.api:133
vl_api_application_tls_cert_add_t::cert_len
u16 cert_len
Definition: session.api:132
vl_api_app_worker_add_del_reply_t::app_event_queue_address
u64 app_event_queue_address
Definition: session.api:186
version
option version
Definition: session.api:16
vl_api_session_enable_disable_t::is_enable
bool is_enable[default=true]
Definition: session.api:203