FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
ipsec.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 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 = "2.0.0";
17 
18 /** \brief IPsec: Add/delete Security Policy Database
19  @param client_index - opaque cookie to identify the sender
20  @param context - sender context, to match reply w/ request
21  @param is_add - add SPD if non-zero, else delete
22  @param spd_id - SPD instance id (control plane allocated)
23 */
24 
25 autoreply define ipsec_spd_add_del
26 {
31 };
32 
33 /** \brief IPsec: Add/delete SPD from interface
34 
35  @param client_index - opaque cookie to identify the sender
36  @param context - sender context, to match reply w/ request
37  @param is_add - add security mode if non-zero, else delete
38  @param sw_if_index - index of the interface
39  @param spd_id - SPD instance id to use for lookups
40 */
41 
42 
43 autoreply define ipsec_interface_add_del_spd
44 {
47 
51 };
52 
53 /** \brief IPsec: Add/delete Security Policy Database entry
54 
55  See RFC 4301, 4.4.1.1 on how to match packet to selectors
56 
57  @param client_index - opaque cookie to identify the sender
58  @param context - sender context, to match reply w/ request
59  @param is_add - add SPD if non-zero, else delete
60  @param spd_id - SPD instance id (control plane allocated)
61  @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
62  @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
63  @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
64  @param remote_address_start - start of remote address range to match
65  @param remote_address_stop - end of remote address range to match
66  @param local_address_start - start of local address range to match
67  @param local_address_stop - end of local address range to match
68  @param protocol - protocol type to match [0 means any]
69  @param remote_port_start - start of remote port range to match ...
70  @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
71  @param local_port_start - start of local port range to match ...
72  @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
73  @param policy - 0 = bypass (no IPsec processing), 1 = discard (discard packet with ICMP processing), 2 = resolve (send request to control plane for SA resolving, and discard without ICMP processing), 3 = protect (apply IPsec policy using following parameters)
74  @param sa_id - SAD instance id (control plane allocated)
75 
76 */
77 
78 autoreply define ipsec_spd_add_del_entry
79 {
83 
87 
88  // Selector
91  u8 remote_address_start[16];
92  u8 remote_address_stop[16];
93  u8 local_address_start[16];
94  u8 local_address_stop[16];
95 
97 
102 
103  // Policy
106 };
107 
108 /** \brief IPsec: Add/delete Security Association Database entry
109  @param client_index - opaque cookie to identify the sender
110  @param context - sender context, to match reply w/ request
111  @param is_add - add SAD entry if non-zero, else delete
112 
113  @param sad_id - sad id
114 
115  @param spi - security parameter index
116 
117  @param protocol - 0 = AH, 1 = ESP
118 
119  @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
120  @param crypto_key_length - length of crypto_key in bytes
121  @param crypto_key - crypto keying material
122 
123  @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
124  @param integrity_key_length - length of integrity_key in bytes
125  @param integrity_key - integrity keying material
126 
127  @param use_extended_sequence_number - use ESN when non-zero
128 
129  @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
130  @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
131  @param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
132  @param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
133  @param udp_encap - enable UDP encapsulation for NAT traversal
134 
135  To be added:
136  Anti-replay
137  IPsec tunnel address copy mode (to support GDOI)
138  */
139 
140 autoreply define ipsec_sad_add_del_entry
141 {
145 
147 
149 
151 
154  u8 crypto_key[128];
155 
158  u8 integrity_key[128];
159 
162 
165  u8 tunnel_src_address[16];
166  u8 tunnel_dst_address[16];
168 };
169 
170 /** \brief IPsec: Update Security Association keys
171  @param client_index - opaque cookie to identify the sender
172  @param context - sender context, to match reply w/ request
173 
174  @param sa_id - sa id
175 
176  @param crypto_key_length - length of crypto_key in bytes
177  @param crypto_key - crypto keying material
178 
179  @param integrity_key_length - length of integrity_key in bytes
180  @param integrity_key - integrity keying material
181 */
182 
183 autoreply define ipsec_sa_set_key
184 {
187 
189 
191  u8 crypto_key[128];
192 
194  u8 integrity_key[128];
195 };
196 
197 /** \brief IKEv2: Add/delete profile
198  @param client_index - opaque cookie to identify the sender
199  @param context - sender context, to match reply w/ request
200 
201  @param name - IKEv2 profile name
202  @param is_add - Add IKEv2 profile if non-zero, else delete
203 */
204 autoreply define ikev2_profile_add_del
205 {
208 
209  u8 name[64];
211 };
212 
213 /** \brief IKEv2: Set IKEv2 profile authentication method
214  @param client_index - opaque cookie to identify the sender
215  @param context - sender context, to match reply w/ request
216 
217  @param name - IKEv2 profile name
218  @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
219  @param is_hex - Authentication data in hex format if non-zero, else string
220  @param data_len - Authentication data length
221  @param data - Authentication data (for rsa-sig cert file path)
222 */
223 autoreply define ikev2_profile_set_auth
224 {
227 
228  u8 name[64];
232  u8 data[data_len];
233 };
234 
235 /** \brief IKEv2: Set IKEv2 profile local/remote identification
236  @param client_index - opaque cookie to identify the sender
237  @param context - sender context, to match reply w/ request
238 
239  @param name - IKEv2 profile name
240  @param is_local - Identification is local if non-zero, else remote
241  @param id_type - Identification type
242  @param data_len - Identification data length
243  @param data - Identification data
244 */
245 autoreply define ikev2_profile_set_id
246 {
249 
250  u8 name[64];
254  u8 data[data_len];
255 };
256 
257 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
258  @param client_index - opaque cookie to identify the sender
259  @param context - sender context, to match reply w/ request
260 
261  @param name - IKEv2 profile name
262  @param is_local - Traffic selector is local if non-zero, else remote
263  @param proto - Traffic selector IP protocol (if zero not relevant)
264  @param start_port - The smallest port number allowed by traffic selector
265  @param end_port - The largest port number allowed by traffic selector
266  @param start_addr - The smallest address included in traffic selector
267  @param end_addr - The largest address included in traffic selector
268 */
269 autoreply define ikev2_profile_set_ts
270 {
273 
274  u8 name[64];
281 };
282 
283 /** \brief IKEv2: Set IKEv2 local RSA private key
284  @param client_index - opaque cookie to identify the sender
285  @param context - sender context, to match reply w/ request
286 
287  @param key_file - Key file absolute path
288 */
289 autoreply define ikev2_set_local_key
290 {
293 
294  u8 key_file[256];
295 };
296 
297 /** \brief IKEv2: Set IKEv2 responder interface and IP address
298  @param client_index - opaque cookie to identify the sender
299  @param context - sender context, to match reply w/ request
300 
301  @param name - IKEv2 profile name
302  @param sw_if_index - interface index
303  @param address - interface address
304 */
305 autoreply define ikev2_set_responder
306 {
309 
310  u8 name[64];
313 };
314 
315 /** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296)
316  @param client_index - opaque cookie to identify the sender
317  @param context - sender context, to match reply w/ request
318 
319  @param name - IKEv2 profile name
320  @param crypto_alg - encryption algorithm
321  @param crypto_key_size - encryption key size
322  @param integ_alg - integrity algorithm
323  @param dh_group - Diffie-Hellman group
324 
325 */
326 autoreply define ikev2_set_ike_transforms
327 {
330 
331  u8 name[64];
336 };
337 
338 /** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296)
339  @param client_index - opaque cookie to identify the sender
340  @param context - sender context, to match reply w/ request
341 
342  @param name - IKEv2 profile name
343  @param crypto_alg - encryption algorithm
344  @param crypto_key_size - encryption key size
345  @param integ_alg - integrity algorithm
346  @param dh_group - Diffie-Hellman group
347 
348 */
349 autoreply define ikev2_set_esp_transforms
350 {
353 
354  u8 name[64];
359 };
360 
361 /** \brief IKEv2: Set Child SA lifetime, limited by time and/or data
362  @param client_index - opaque cookie to identify the sender
363  @param context - sender context, to match reply w/ request
364 
365  @param name - IKEv2 profile name
366  @param lifetime - SA maximum life time in seconds (0 to disable)
367  @param lifetime_jitter - Jitter added to prevent simultaneous rekeying
368  @param handover - Hand over time
369  @param lifetime_maxdata - SA maximum life time in bytes (0 to disable)
370 
371 */
372 autoreply define ikev2_set_sa_lifetime
373 {
376 
377  u8 name[64];
382 };
383 
384 /** \brief IKEv2: Initiate the SA_INIT exchange
385  @param client_index - opaque cookie to identify the sender
386  @param context - sender context, to match reply w/ request
387 
388  @param name - IKEv2 profile name
389 
390 */
391 autoreply define ikev2_initiate_sa_init
392 {
395 
396  u8 name[64];
397 };
398 
399 /** \brief IKEv2: Initiate the delete IKE SA exchange
400  @param client_index - opaque cookie to identify the sender
401  @param context - sender context, to match reply w/ request
402 
403  @param ispi - IKE SA initiator SPI
404 
405 */
406 autoreply define ikev2_initiate_del_ike_sa
407 {
410 
412 };
413 
414 /** \brief IKEv2: Initiate the delete Child SA exchange
415  @param client_index - opaque cookie to identify the sender
416  @param context - sender context, to match reply w/ request
417 
418  @param ispi - Child SA initiator SPI
419 
420 */
421 autoreply define ikev2_initiate_del_child_sa
422 {
425 
427 };
428 
429 /** \brief IKEv2: Initiate the rekey Child SA exchange
430  @param client_index - opaque cookie to identify the sender
431  @param context - sender context, to match reply w/ request
432 
433  @param ispi - Child SA initiator SPI
434 
435 */
437 {
440 
442 };
443 
444 /** \brief Dump IPsec all SPD IDs
445  @param client_index - opaque cookie to identify the sender
446  @param context - sender context, to match reply w/ request
447 */
448 define ipsec_spds_dump {
451 };
452 
453 /** \brief Dump IPsec all SPD IDs response
454  @param client_index - opaque cookie to identify the sender
455  @param spd_id - SPD instance id (control plane allocated)
456  @param npolicies - number of policies in SPD
457 */
458 define ipsec_spds_details {
462 };
463 
464 /** \brief Dump ipsec policy database data
465  @param client_index - opaque cookie to identify the sender
466  @param context - sender context, to match reply w/ request
467  @param spd_id - SPD instance id
468  @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
469 */
470 define ipsec_spd_dump {
475 };
476 
477 /** \brief IPsec policy database response
478  @param context - sender context which was passed in the request
479  @param spd_id - SPD instance id
480  @param priority - numeric value to control policy evaluation order
481  @param is_outbound - [1|0] to indicate if direction is [out|in]bound
482  @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
483  @param local_start_addr - first address in local traffic selector range
484  @param local_stop_addr - last address in local traffic selector range
485  @param local_start_port - first port in local traffic selector range
486  @param local_stop_port - last port in local traffic selector range
487  @param remote_start_addr - first address in remote traffic selector range
488  @param remote_stop_addr - last address in remote traffic selector range
489  @param remote_start_port - first port in remote traffic selector range
490  @param remote_stop_port - last port in remote traffic selector range
491  @param protocol - traffic selector protocol
492  @param policy - policy action
493  @param sa_id - SA id
494  @param bytes - byte count of packets matching this policy
495  @param packets - count of packets matching this policy
496 */
497 define ipsec_spd_details {
503  u8 local_start_addr[16];
504  u8 local_stop_addr[16];
507  u8 remote_start_addr[16];
508  u8 remote_stop_addr[16];
516 };
517 
518 /** \brief IPsec: Get SPD interfaces
519  @param client_index - opaque cookie to identify the sender
520  @param context - sender context, to match reply w/ request
521  @param spd_index - SPD index
522  @param spd_index_valid - if 1 spd_index is used to filter
523  spd_index's, if 0 no filtering is done
524 */
525 define ipsec_spd_interface_dump {
530 };
531 
532 /** \brief IPsec: SPD interface response
533  @param context - sender context which was passed in the request
534  @param spd_index - SPD index
535  @param sw_if_index - index of the interface
536 */
537 define ipsec_spd_interface_details {
541 };
542 
543 /** \brief Add or delete IPsec tunnel interface
544  @param client_index - opaque cookie to identify the sender
545  @param context - sender context, to match reply w/ request
546  @param is_add - add IPsec tunnel interface if nonzero, else delete
547  @param esn - enable extended sequence numbers if nonzero, else disable
548  @param anti_replay - enable anti replay check if nonzero, else disable
549  @param local_ip - local IP address
550  @param remote_ip - IP address of remote IPsec peer
551  @param local_spi - SPI of outbound IPsec SA
552  @param remote_spi - SPI of inbound IPsec SA
553  @param crypto_alg - encryption algorithm ID
554  @param local_crypto_key_len - length of local crypto key in bytes
555  @param local_crypto_key - crypto key for outbound IPsec SA
556  @param remote_crypto_key_len - length of remote crypto key in bytes
557  @param remote_crypto_key - crypto key for inbound IPsec SA
558  @param integ_alg - integrity algorithm ID
559  @param local_integ_key_len - length of local integrity key in bytes
560  @param local_integ_key - integrity key for outbound IPsec SA
561  @param remote_integ_key_len - length of remote integrity key in bytes
562  @param remote_integ_key - integrity key for inbound IPsec SA
563  @param renumber - intf display name uses a specified instance if != 0
564  @param show_instance - instance to display for intf if renumber is set
565  @param udp_encap - enable UDP encapsulation for NAT traversal
566 */
567 define ipsec_tunnel_if_add_del {
573  u8 local_ip[4];
574  u8 remote_ip[4];
579  u8 local_crypto_key[128];
581  u8 remote_crypto_key[128];
584  u8 local_integ_key[128];
586  u8 remote_integ_key[128];
590 };
591 
592 /** \brief Add/delete IPsec tunnel interface response
593  @param context - sender context, to match reply w/ request
594  @param retval - return status
595  @param sw_if_index - sw_if_index of new interface (for successful add)
596 */
597 define ipsec_tunnel_if_add_del_reply {
601 };
602 
603 /** \brief Dump IPsec security association
604  @param client_index - opaque cookie to identify the sender
605  @param context - sender context, to match reply w/ request
606  @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD
607 */
608 define ipsec_sa_dump {
612 };
613 
614 /** \brief IPsec security association database response
615  @param context - sender context which was passed in the request
616  @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0
617  @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0
618  @param spi - security parameter index
619  @param protocol - IPsec protocol (value from ipsec_protocol_t)
620  @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t)
621  @param crypto_key_len - length of crypto_key in bytes
622  @param crypto_key - crypto keying material
623  @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t)
624  @param integ_key_len - length of integ_key in bytes
625  @param integ_key - integrity keying material
626  @param use_esn - using extended sequence numbers when non-zero
627  @param use_anti_replay - using anti-replay window when non-zero
628  @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode
629  @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6
630  @param tunnel_src_addr - Tunnel source address if using tunnel mode
631  @param tunnel_dst_addr - Tunnel destination address is using tunnel mode
632  @param salt - 4 byte salt
633  @param seq - current sequence number for outbound
634  @param seq_hi - high 32 bits of ESN for outbound
635  @param last_seq - highest sequence number received inbound
636  @param last_seq_hi - high 32 bits of highest ESN received inbound
637  @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay
638  @param total_data_size - total bytes sent or received
639  @param udp_encap - 1 if UDP encap enabled, 0 otherwise
640 */
641 define ipsec_sa_details {
645 
648 
651  u8 crypto_key[128];
652 
655  u8 integ_key[128];
656 
659 
662  u8 tunnel_src_addr[16];
663  u8 tunnel_dst_addr[16];
664 
669 
672 };
673 
674 /** \brief Set key on IPsec interface
675  @param client_index - opaque cookie to identify the sender
676  @param context - sender context, to match reply w/ request
677  @param sw_if_index - index of tunnel interface
678  @param key_type - type of key being set
679  @param alg - algorithm used with key
680  @param key_len - length key in bytes
681  @param key - key
682 */
683 autoreply define ipsec_tunnel_if_set_key {
690  u8 key[128];
691 };
692 
693 /** \brief Set new SA on IPsec interface
694  @param client_index - opaque cookie to identify the sender
695  @param context - sender context, to match reply w/ request
696  @param sw_if_index - index of tunnel interface
697  @param sa_id - ID of SA to use
698  @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote)
699 */
700 autoreply define ipsec_tunnel_if_set_sa {
706 };
707 
708 /*
709  * Local Variables:
710  * eval: (c-set-style "gnu")
711  * End:
712  */
713 
u8 crypto_algorithm
Definition: ipsec.api:152
typedef address
Definition: ip_types.api:35
u8 use_extended_sequence_number
Definition: ipsec.api:160
u32 sa_id
Definition: ipsec.api:105
u8 integrity_key_length
Definition: ipsec.api:157
u16 local_port_start
Definition: ipsec.api:100
unsigned long u64
Definition: types.h:89
u8 is_add
Definition: ipsec.api:82
u8 policy
Definition: ipsec.api:104
u16 remote_port_stop
Definition: ipsec.api:99
unsigned char u8
Definition: types.h:56
u8 protocol
Definition: ipsec.api:96
u8 udp_encap
Definition: ipsec.api:167
u32 spd_id
Definition: ipsec.api:84
u8 is_tunnel
Definition: ipsec.api:163
u8 crypto_key_length
Definition: ipsec.api:153
u32 sad_id
Definition: ipsec.api:146
clib_error_t * ikev2_initiate_sa_init(vlib_main_t *vm, u8 *name)
Definition: ikev2.c:2918
unsigned int u32
Definition: types.h:88
i32 priority
Definition: ipsec.api:85
unsigned short u16
Definition: types.h:57
u8 is_add
Definition: ipsec.api:144
u16 local_port_stop
Definition: ipsec.api:101
u8 name[64]
Definition: memclnt.api:151
clib_error_t * ikev2_set_local_key(vlib_main_t *vm, u8 *file)
Definition: ikev2.c:2671
u32 client_index
Definition: ipsec.api:142
clib_error_t * ikev2_initiate_rekey_child_sa(vlib_main_t *vm, u32 ispi)
Definition: ikev2.c:3252
u16 remote_port_start
Definition: ipsec.api:98
u32 client_index
Definition: ipsec.api:80
signed int i32
Definition: types.h:77
u32 spi
Definition: ipsec.api:148
option version
Definition: ipsec.api:16
u8 use_anti_replay
Definition: ipsec.api:161
u32 context
Definition: ipsec.api:81
u8 integrity_algorithm
Definition: ipsec.api:156
u8 is_tunnel_ipv6
Definition: ipsec.api:164
u32 context
Definition: ipsec.api:143
u8 is_outbound
Definition: ipsec.api:86
u8 is_ipv6
Definition: ipsec.api:89
u8 protocol
Definition: ipsec.api:150
u8 is_ip_any
Definition: ipsec.api:90