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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "2.0.0";
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)
25 autoreply define ipsec_spd_add_del
33 /** \brief IPsec: Add/delete SPD from interface
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
43 autoreply define ipsec_interface_add_del_spd
53 /** \brief IPsec: Add/delete Security Policy Database entry
55 See RFC 4301, 4.4.1.1 on how to match packet to selectors
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)
78 autoreply define ipsec_spd_add_del_entry
91 u8 remote_address_start[16];
92 u8 remote_address_stop[16];
93 u8 local_address_start[16];
94 u8 local_address_stop[16];
98 u16 remote_port_start;
100 u16 local_port_start;
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
113 @param sad_id - sad id
115 @param spi - security parameter index
117 @param protocol - 0 = AH, 1 = ESP
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
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
127 @param use_extended_sequence_number - use ESN when non-zero
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
137 IPsec tunnel address copy mode (to support GDOI)
140 autoreply define ipsec_sad_add_del_entry
153 u8 crypto_key_length;
156 u8 integrity_algorithm;
157 u8 integrity_key_length;
158 u8 integrity_key[128];
160 u8 use_extended_sequence_number;
165 u8 tunnel_src_address[16];
166 u8 tunnel_dst_address[16];
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
176 @param crypto_key_length - length of crypto_key in bytes
177 @param crypto_key - crypto keying material
179 @param integrity_key_length - length of integrity_key in bytes
180 @param integrity_key - integrity keying material
183 autoreply define ipsec_sa_set_key
190 u8 crypto_key_length;
193 u8 integrity_key_length;
194 u8 integrity_key[128];
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
201 @param name - IKEv2 profile name
202 @param is_add - Add IKEv2 profile if non-zero, else delete
204 autoreply define ikev2_profile_add_del
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
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)
223 autoreply define ikev2_profile_set_auth
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
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
245 autoreply define ikev2_profile_set_id
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
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
269 autoreply define ikev2_profile_set_ts
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
287 @param key_file - Key file absolute path
289 autoreply define ikev2_set_local_key
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
301 @param name - IKEv2 profile name
302 @param sw_if_index - interface index
303 @param address - interface address
305 autoreply define ikev2_set_responder
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
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
326 autoreply define ikev2_set_ike_transforms
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
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
349 autoreply define ikev2_set_esp_transforms
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
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)
372 autoreply define ikev2_set_sa_lifetime
381 u64 lifetime_maxdata;
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
388 @param name - IKEv2 profile name
391 autoreply define ikev2_initiate_sa_init
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
403 @param ispi - IKE SA initiator SPI
406 autoreply define ikev2_initiate_del_ike_sa
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
418 @param ispi - Child SA initiator SPI
421 autoreply define ikev2_initiate_del_child_sa
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
433 @param ispi - Child SA initiator SPI
436 autoreply define ikev2_initiate_rekey_child_sa
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
448 define ipsec_spds_dump {
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
458 define ipsec_spds_details {
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
470 define ipsec_spd_dump {
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
494 @param bytes - byte count of packets matching this policy
495 @param packets - count of packets matching this policy
497 define ipsec_spd_details {
503 u8 local_start_addr[16];
504 u8 local_stop_addr[16];
505 u16 local_start_port;
507 u8 remote_start_addr[16];
508 u8 remote_stop_addr[16];
509 u16 remote_start_port;
510 u16 remote_stop_port;
518 /** \brief Add or delete IPsec tunnel interface
519 @param client_index - opaque cookie to identify the sender
520 @param context - sender context, to match reply w/ request
521 @param is_add - add IPsec tunnel interface if nonzero, else delete
522 @param esn - enable extended sequence numbers if nonzero, else disable
523 @param anti_replay - enable anti replay check if nonzero, else disable
524 @param local_ip - local IP address
525 @param remote_ip - IP address of remote IPsec peer
526 @param local_spi - SPI of outbound IPsec SA
527 @param remote_spi - SPI of inbound IPsec SA
528 @param crypto_alg - encryption algorithm ID
529 @param local_crypto_key_len - length of local crypto key in bytes
530 @param local_crypto_key - crypto key for outbound IPsec SA
531 @param remote_crypto_key_len - length of remote crypto key in bytes
532 @param remote_crypto_key - crypto key for inbound IPsec SA
533 @param integ_alg - integrity algorithm ID
534 @param local_integ_key_len - length of local integrity key in bytes
535 @param local_integ_key - integrity key for outbound IPsec SA
536 @param remote_integ_key_len - length of remote integrity key in bytes
537 @param remote_integ_key - integrity key for inbound IPsec SA
538 @param renumber - intf display name uses a specified instance if != 0
539 @param show_instance - instance to display for intf if renumber is set
541 define ipsec_tunnel_if_add_del {
552 u8 local_crypto_key_len;
553 u8 local_crypto_key[128];
554 u8 remote_crypto_key_len;
555 u8 remote_crypto_key[128];
557 u8 local_integ_key_len;
558 u8 local_integ_key[128];
559 u8 remote_integ_key_len;
560 u8 remote_integ_key[128];
565 /** \brief Add/delete IPsec tunnel interface response
566 @param context - sender context, to match reply w/ request
567 @param retval - return status
568 @param sw_if_index - sw_if_index of new interface (for successful add)
570 define ipsec_tunnel_if_add_del_reply {
576 /** \brief Dump IPsec security association
577 @param client_index - opaque cookie to identify the sender
578 @param context - sender context, to match reply w/ request
579 @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD
581 define ipsec_sa_dump {
587 /** \brief IPsec security association database response
588 @param context - sender context which was passed in the request
589 @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0
590 @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0
591 @param spi - security parameter index
592 @param protocol - IPsec protocol (value from ipsec_protocol_t)
593 @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t)
594 @param crypto_key_len - length of crypto_key in bytes
595 @param crypto_key - crypto keying material
596 @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t)
597 @param integ_key_len - length of integ_key in bytes
598 @param integ_key - integrity keying material
599 @param use_esn - using extended sequence numbers when non-zero
600 @param use_anti_replay - using anti-replay window when non-zero
601 @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode
602 @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6
603 @param tunnel_src_addr - Tunnel source address if using tunnel mode
604 @param tunnel_dst_addr - Tunnel destination address is using tunnel mode
605 @param salt - 4 byte salt
606 @param seq - current sequence number for outbound
607 @param seq_hi - high 32 bits of ESN for outbound
608 @param last_seq - highest sequence number received inbound
609 @param last_seq_hi - high 32 bits of highest ESN received inbound
610 @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay
611 @param total_data_size - total bytes sent or received
612 @param udp_encap - 1 if UDP encap enabled, 0 otherwise
614 define ipsec_sa_details {
635 u8 tunnel_src_addr[16];
636 u8 tunnel_dst_addr[16];
640 u64 last_seq_inbound;
647 /** \brief Set key on IPsec interface
648 @param client_index - opaque cookie to identify the sender
649 @param context - sender context, to match reply w/ request
650 @param sw_if_index - index of tunnel interface
651 @param key_type - type of key being set
652 @param alg - algorithm used with key
653 @param key_len - length key in bytes
656 autoreply define ipsec_tunnel_if_set_key {
666 /** \brief Set new SA on IPsec interface
667 @param client_index - opaque cookie to identify the sender
668 @param context - sender context, to match reply w/ request
669 @param sw_if_index - index of tunnel interface
670 @param sa_id - ID of SA to use
671 @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote)
673 autoreply define ipsec_tunnel_if_set_sa {
683 * eval: (c-set-style "gnu")