1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 option version = "3.0.0";
19 import "vnet/ip/ip_types.api";
21 /** \brief IPsec: Add/delete Security Policy Database
22 @param client_index - opaque cookie to identify the sender
23 @param context - sender context, to match reply w/ request
24 @param is_add - add SPD if non-zero, else delete
25 @param spd_id - SPD instance id (control plane allocated)
28 autoreply define ipsec_spd_add_del
36 /** \brief IPsec: Add/delete SPD from interface
38 @param client_index - opaque cookie to identify the sender
39 @param context - sender context, to match reply w/ request
40 @param is_add - add security mode if non-zero, else delete
41 @param sw_if_index - index of the interface
42 @param spd_id - SPD instance id to use for lookups
46 autoreply define ipsec_interface_add_del_spd
59 /* bypass - no IPsec processing */
60 IPSEC_API_SPD_ACTION_BYPASS = 0,
61 /* discard - discard packet with ICMP processing */
62 IPSEC_API_SPD_ACTION_DISCARD,
63 /* resolve - send request to control plane for SA resolving */
64 IPSEC_API_SPD_ACTION_RESOLVE,
65 /* protect - apply IPsec policy using following parameters */
66 IPSEC_API_SPD_ACTION_PROTECT,
69 /** \brief IPsec: Security Policy Database entry
71 See RFC 4301, 4.4.1.1 on how to match packet to selectors
73 @param spd_id - SPD instance id (control plane allocated)
74 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
75 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
76 @param remote_address_start - start of remote address range to match
77 @param remote_address_stop - end of remote address range to match
78 @param local_address_start - start of local address range to match
79 @param local_address_stop - end of local address range to match
80 @param protocol - protocol type to match [0 means any] otherwise IANA value
81 @param remote_port_start - start of remote port range to match ...
82 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
83 @param local_port_start - start of local port range to match ...
84 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
85 @param policy - action to perform on match
86 @param sa_id - SAD instance id (control plane allocated)
88 typedef ipsec_spd_entry
95 vl_api_ipsec_spd_action_t policy;
99 vl_api_address_t remote_address_start;
100 vl_api_address_t remote_address_stop;
101 vl_api_address_t local_address_start;
102 vl_api_address_t local_address_stop;
104 u16 remote_port_start;
105 u16 remote_port_stop;
106 u16 local_port_start;
110 /** \brief IPsec: Add/delete Security Policy Database entry
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param is_add - add SPD if non-zero, else delete
115 @param entry - Description of the entry to add/dell
117 define ipsec_spd_entry_add_del
122 vl_api_ipsec_spd_entry_t entry;
125 /** \brief IPsec: Reply Add/delete Security Policy Database entry
127 @param context - sender context, to match reply w/ request
128 @param retval - success/fail rutrun code
129 @param stat_index - An index for the policy in the stats segment @ /net/ipec/policy
131 define ipsec_spd_entry_add_del_reply
138 /** \brief Dump IPsec all SPD IDs
139 @param client_index - opaque cookie to identify the sender
140 @param context - sender context, to match reply w/ request
142 define ipsec_spds_dump {
147 /** \brief Dump IPsec all SPD IDs response
148 @param client_index - opaque cookie to identify the sender
149 @param spd_id - SPD instance id (control plane allocated)
150 @param npolicies - number of policies in SPD
152 define ipsec_spds_details {
158 /** \brief Dump ipsec policy database data
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
161 @param spd_id - SPD instance id
162 @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
164 define ipsec_spd_dump {
171 /** \brief IPsec policy database response
172 @param context - sender context which was passed in the request
173 €param entry - The SPD entry.
174 @param bytes - byte count of packets matching this policy
175 @param packets - count of packets matching this policy
177 define ipsec_spd_details {
179 vl_api_ipsec_spd_entry_t entry;
183 * @brief Support cryptographic algorithms
185 enum ipsec_crypto_alg
187 IPSEC_API_CRYPTO_ALG_NONE = 0,
188 IPSEC_API_CRYPTO_ALG_AES_CBC_128,
189 IPSEC_API_CRYPTO_ALG_AES_CBC_192,
190 IPSEC_API_CRYPTO_ALG_AES_CBC_256,
191 IPSEC_API_CRYPTO_ALG_AES_CTR_128,
192 IPSEC_API_CRYPTO_ALG_AES_CTR_192,
193 IPSEC_API_CRYPTO_ALG_AES_CTR_256,
194 IPSEC_API_CRYPTO_ALG_AES_GCM_128,
195 IPSEC_API_CRYPTO_ALG_AES_GCM_192,
196 IPSEC_API_CRYPTO_ALG_AES_GCM_256,
197 IPSEC_API_CRYPTO_ALG_DES_CBC,
198 IPSEC_API_CRYPTO_ALG_3DES_CBC,
202 * @brief Supported Integrity Algorithms
206 IPSEC_API_INTEG_ALG_NONE = 0,
208 IPSEC_API_INTEG_ALG_MD5_96,
210 IPSEC_API_INTEG_ALG_SHA1_96,
211 /* draft-ietf-ipsec-ciph-sha-256-00 */
212 IPSEC_API_INTEG_ALG_SHA_256_96,
214 IPSEC_API_INTEG_ALG_SHA_256_128,
216 IPSEC_API_INTEG_ALG_SHA_384_192,
218 IPSEC_API_INTEG_ALG_SHA_512_256,
223 IPSEC_API_SAD_FLAG_NONE = 0,
224 /* Enable extended sequence numbers */
225 IPSEC_API_SAD_FLAG_USE_EXTENDED_SEQ_NUM = 0x01,
226 /* Enable Anti-replay */
227 IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02,
228 /* IPsec tunnel mode if non-zero, else transport mode */
229 IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04,
230 /* IPsec tunnel mode is IPv6 if non-zero,
231 * else IPv4 tunnel only valid if is_tunnel is non-zero */
232 IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08,
233 /* enable UDP encapsulation for NAT traversal */
234 IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10,
236 /* come-on Ole please fix this */
237 IPSEC_API_SAD_COMBO_12 = 12,
238 IPSEC_API_SAD_COMBO_20 = 20,
249 /* the length of the key */
251 /* The data for the key */
255 /** \brief IPsec: Security Association Database entry
256 @param client_index - opaque cookie to identify the sender
257 @param context - sender context, to match reply w/ request
258 @param is_add - add SAD entry if non-zero, else delete
259 @param sad_id - sad id
260 @param spi - security parameter index
261 @param protocol - 0 = AH, 1 = ESP
262 @param crypto_algorithm - a supported crypto algorithm
263 @param crypto_key - crypto keying material
264 @param integrity_algorithm - one of the supported algorithms
265 @param integrity_key - integrity keying material
266 @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
267 @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
268 @param tx_table_id - the FIB id used for encapsulated packets
270 typedef ipsec_sad_entry
276 vl_api_ipsec_proto_t protocol;
278 vl_api_ipsec_crypto_alg_t crypto_algorithm;
279 vl_api_key_t crypto_key;
281 vl_api_ipsec_integ_alg_t integrity_algorithm;
282 vl_api_key_t integrity_key;
284 vl_api_ipsec_sad_flags_t flags;
286 vl_api_address_t tunnel_src;
287 vl_api_address_t tunnel_dst;
291 /** \brief IPsec: Add/delete Security Association Database entry
292 @param client_index - opaque cookie to identify the sender
293 @param context - sender context, to match reply w/ request
294 @param entry - Entry to add or delete
296 autoreply define ipsec_sad_entry_add_del
301 vl_api_ipsec_sad_entry_t entry;
304 /** \brief IPsec: Update Security Association keys
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
310 @param crypto_key - crypto keying material
311 @param integrity_key - integrity keying material
314 autoreply define ipsec_sa_set_key
321 vl_api_key_t crypto_key;
322 vl_api_key_t integrity_key;
325 /** \brief IKEv2: Add/delete profile
326 @param client_index - opaque cookie to identify the sender
327 @param context - sender context, to match reply w/ request
329 @param name - IKEv2 profile name
330 @param is_add - Add IKEv2 profile if non-zero, else delete
332 autoreply define ikev2_profile_add_del
341 /** \brief IKEv2: Set IKEv2 profile authentication method
342 @param client_index - opaque cookie to identify the sender
343 @param context - sender context, to match reply w/ request
345 @param name - IKEv2 profile name
346 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
347 @param is_hex - Authentication data in hex format if non-zero, else string
348 @param data_len - Authentication data length
349 @param data - Authentication data (for rsa-sig cert file path)
351 autoreply define ikev2_profile_set_auth
363 /** \brief IKEv2: Set IKEv2 profile local/remote identification
364 @param client_index - opaque cookie to identify the sender
365 @param context - sender context, to match reply w/ request
367 @param name - IKEv2 profile name
368 @param is_local - Identification is local if non-zero, else remote
369 @param id_type - Identification type
370 @param data_len - Identification data length
371 @param data - Identification data
373 autoreply define ikev2_profile_set_id
385 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
386 @param client_index - opaque cookie to identify the sender
387 @param context - sender context, to match reply w/ request
389 @param name - IKEv2 profile name
390 @param is_local - Traffic selector is local if non-zero, else remote
391 @param proto - Traffic selector IP protocol (if zero not relevant)
392 @param start_port - The smallest port number allowed by traffic selector
393 @param end_port - The largest port number allowed by traffic selector
394 @param start_addr - The smallest address included in traffic selector
395 @param end_addr - The largest address included in traffic selector
397 autoreply define ikev2_profile_set_ts
411 /** \brief IKEv2: Set IKEv2 local RSA private key
412 @param client_index - opaque cookie to identify the sender
413 @param context - sender context, to match reply w/ request
415 @param key_file - Key file absolute path
417 autoreply define ikev2_set_local_key
425 /** \brief IKEv2: Set IKEv2 responder interface and IP address
426 @param client_index - opaque cookie to identify the sender
427 @param context - sender context, to match reply w/ request
429 @param name - IKEv2 profile name
430 @param sw_if_index - interface index
431 @param address - interface address
433 autoreply define ikev2_set_responder
443 /** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296)
444 @param client_index - opaque cookie to identify the sender
445 @param context - sender context, to match reply w/ request
447 @param name - IKEv2 profile name
448 @param crypto_alg - encryption algorithm
449 @param crypto_key_size - encryption key size
450 @param integ_alg - integrity algorithm
451 @param dh_group - Diffie-Hellman group
454 autoreply define ikev2_set_ike_transforms
466 /** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296)
467 @param client_index - opaque cookie to identify the sender
468 @param context - sender context, to match reply w/ request
470 @param name - IKEv2 profile name
471 @param crypto_alg - encryption algorithm
472 @param crypto_key_size - encryption key size
473 @param integ_alg - integrity algorithm
474 @param dh_group - Diffie-Hellman group
477 autoreply define ikev2_set_esp_transforms
489 /** \brief IKEv2: Set Child SA lifetime, limited by time and/or data
490 @param client_index - opaque cookie to identify the sender
491 @param context - sender context, to match reply w/ request
493 @param name - IKEv2 profile name
494 @param lifetime - SA maximum life time in seconds (0 to disable)
495 @param lifetime_jitter - Jitter added to prevent simultaneous rekeying
496 @param handover - Hand over time
497 @param lifetime_maxdata - SA maximum life time in bytes (0 to disable)
500 autoreply define ikev2_set_sa_lifetime
509 u64 lifetime_maxdata;
512 /** \brief IKEv2: Initiate the SA_INIT exchange
513 @param client_index - opaque cookie to identify the sender
514 @param context - sender context, to match reply w/ request
516 @param name - IKEv2 profile name
519 autoreply define ikev2_initiate_sa_init
527 /** \brief IKEv2: Initiate the delete IKE SA exchange
528 @param client_index - opaque cookie to identify the sender
529 @param context - sender context, to match reply w/ request
531 @param ispi - IKE SA initiator SPI
534 autoreply define ikev2_initiate_del_ike_sa
542 /** \brief IKEv2: Initiate the delete Child SA exchange
543 @param client_index - opaque cookie to identify the sender
544 @param context - sender context, to match reply w/ request
546 @param ispi - Child SA initiator SPI
549 autoreply define ikev2_initiate_del_child_sa
557 /** \brief IKEv2: Initiate the rekey Child SA exchange
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
561 @param ispi - Child SA initiator SPI
564 autoreply define ikev2_initiate_rekey_child_sa
572 /** \brief IPsec: Get SPD interfaces
573 @param client_index - opaque cookie to identify the sender
574 @param context - sender context, to match reply w/ request
575 @param spd_index - SPD index
576 @param spd_index_valid - if 1 spd_index is used to filter
577 spd_index's, if 0 no filtering is done
579 define ipsec_spd_interface_dump {
586 /** \brief IPsec: SPD interface response
587 @param context - sender context which was passed in the request
588 @param spd_index - SPD index
589 @param sw_if_index - index of the interface
591 define ipsec_spd_interface_details {
597 /** \brief Add or delete IPsec tunnel interface
598 @param client_index - opaque cookie to identify the sender
599 @param context - sender context, to match reply w/ request
600 @param is_add - add IPsec tunnel interface if nonzero, else delete
601 @param esn - enable extended sequence numbers if nonzero, else disable
602 @param anti_replay - enable anti replay check if nonzero, else disable
603 @param local_ip - local IP address
604 @param remote_ip - IP address of remote IPsec peer
605 @param local_spi - SPI of outbound IPsec SA
606 @param remote_spi - SPI of inbound IPsec SA
607 @param crypto_alg - encryption algorithm ID
608 @param local_crypto_key_len - length of local crypto key in bytes
609 @param local_crypto_key - crypto key for outbound IPsec SA
610 @param remote_crypto_key_len - length of remote crypto key in bytes
611 @param remote_crypto_key - crypto key for inbound IPsec SA
612 @param integ_alg - integrity algorithm ID
613 @param local_integ_key_len - length of local integrity key in bytes
614 @param local_integ_key - integrity key for outbound IPsec SA
615 @param remote_integ_key_len - length of remote integrity key in bytes
616 @param remote_integ_key - integrity key for inbound IPsec SA
617 @param renumber - intf display name uses a specified instance if != 0
618 @param show_instance - instance to display for intf if renumber is set
619 @param udp_encap - enable UDP encapsulation for NAT traversal
620 @param tx_table_id - the FIB id used after packet encap
622 define ipsec_tunnel_if_add_del {
633 u8 local_crypto_key_len;
634 u8 local_crypto_key[128];
635 u8 remote_crypto_key_len;
636 u8 remote_crypto_key[128];
638 u8 local_integ_key_len;
639 u8 local_integ_key[128];
640 u8 remote_integ_key_len;
641 u8 remote_integ_key[128];
648 /** \brief Add/delete IPsec tunnel interface response
649 @param context - sender context, to match reply w/ request
650 @param retval - return status
651 @param sw_if_index - sw_if_index of new interface (for successful add)
653 define ipsec_tunnel_if_add_del_reply {
659 /** \brief Dump IPsec security association
660 @param client_index - opaque cookie to identify the sender
661 @param context - sender context, to match reply w/ request
662 @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD
664 define ipsec_sa_dump {
670 /** \brief IPsec security association database response
671 @param context - sender context which was passed in the request
672 @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0
673 @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0
674 @param spi - security parameter index
675 @param protocol - IPsec protocol (value from ipsec_protocol_t)
676 @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t)
677 @param crypto_key_len - length of crypto_key in bytes
678 @param crypto_key - crypto keying material
679 @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t)
680 @param integ_key_len - length of integ_key in bytes
681 @param integ_key - integrity keying material
682 @param use_esn - using extended sequence numbers when non-zero
683 @param use_anti_replay - using anti-replay window when non-zero
684 @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode
685 @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6
686 @param tunnel_src_addr - Tunnel source address if using tunnel mode
687 @param tunnel_dst_addr - Tunnel destination address is using tunnel mode
688 @param salt - 4 byte salt
689 @param seq - current sequence number for outbound
690 @param seq_hi - high 32 bits of ESN for outbound
691 @param last_seq - highest sequence number received inbound
692 @param last_seq_hi - high 32 bits of highest ESN received inbound
693 @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay
694 @param total_data_size - total bytes sent or received
695 @param udp_encap - 1 if UDP encap enabled, 0 otherwise
697 define ipsec_sa_details {
699 vl_api_ipsec_sad_entry_t entry;
704 u64 last_seq_inbound;
710 /** \brief Set key on IPsec interface
711 @param client_index - opaque cookie to identify the sender
712 @param context - sender context, to match reply w/ request
713 @param sw_if_index - index of tunnel interface
714 @param key_type - type of key being set
715 @param alg - algorithm used with key
716 @param key_len - length key in bytes
719 autoreply define ipsec_tunnel_if_set_key {
729 /** \brief Set new SA on IPsec interface
730 @param client_index - opaque cookie to identify the sender
731 @param context - sender context, to match reply w/ request
732 @param sw_if_index - index of tunnel interface
733 @param sa_id - ID of SA to use
734 @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote)
736 autoreply define ipsec_tunnel_if_set_sa {
744 /** \brief Dump IPsec backends
745 @param client_index - opaque cookie to identify the sender
746 @param context - sender context, to match reply w/ request
748 define ipsec_backend_dump {
753 /** \brief IPsec backend details
754 @param name - name of the backend
755 @param protocol - IPsec protocol (value from ipsec_protocol_t)
756 @param index - backend index
757 @param active - set to 1 if the backend is active, otherwise 0
759 define ipsec_backend_details {
762 vl_api_ipsec_proto_t protocol;
767 /** \brief Select IPsec backend
768 @param client_index - opaque cookie to identify the sender
769 @param context - sender context, to match reply w/ request
770 @param protocol - IPsec protocol (value from ipsec_protocol_t)
771 @param index - backend index
773 autoreply define ipsec_select_backend {
776 vl_api_ipsec_proto_t protocol;
782 * eval: (c-set-style "gnu")