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.1";
19 import "vnet/ip/ip_types.api";
20 import "vnet/tunnel/tunnel_types.api";
23 * @brief Support cryptographic algorithms
27 IPSEC_API_CRYPTO_ALG_NONE = 0,
28 IPSEC_API_CRYPTO_ALG_AES_CBC_128,
29 IPSEC_API_CRYPTO_ALG_AES_CBC_192,
30 IPSEC_API_CRYPTO_ALG_AES_CBC_256,
31 IPSEC_API_CRYPTO_ALG_AES_CTR_128,
32 IPSEC_API_CRYPTO_ALG_AES_CTR_192,
33 IPSEC_API_CRYPTO_ALG_AES_CTR_256,
34 IPSEC_API_CRYPTO_ALG_AES_GCM_128,
35 IPSEC_API_CRYPTO_ALG_AES_GCM_192,
36 IPSEC_API_CRYPTO_ALG_AES_GCM_256,
37 IPSEC_API_CRYPTO_ALG_DES_CBC,
38 IPSEC_API_CRYPTO_ALG_3DES_CBC,
42 * @brief Supported Integrity Algorithms
46 IPSEC_API_INTEG_ALG_NONE = 0,
48 IPSEC_API_INTEG_ALG_MD5_96,
50 IPSEC_API_INTEG_ALG_SHA1_96,
51 /* draft-ietf-ipsec-ciph-sha-256-00 */
52 IPSEC_API_INTEG_ALG_SHA_256_96,
54 IPSEC_API_INTEG_ALG_SHA_256_128,
56 IPSEC_API_INTEG_ALG_SHA_384_192,
58 IPSEC_API_INTEG_ALG_SHA_512_256,
63 IPSEC_API_SAD_FLAG_NONE = 0,
64 /* Enable extended sequence numbers */
65 IPSEC_API_SAD_FLAG_USE_ESN = 0x01,
66 /* Enable Anti-replay */
67 IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02,
68 /* IPsec tunnel mode if non-zero, else transport mode */
69 IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04,
70 /* IPsec tunnel mode is IPv6 if non-zero,
71 * else IPv4 tunnel only valid if is_tunnel is non-zero */
72 IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08,
73 /* enable UDP encapsulation for NAT traversal */
74 IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10,
75 /* IPsec SA is for inbound traffic */
76 IPSEC_API_SAD_FLAG_IS_INBOUND = 0x40,
81 IPSEC_API_PROTO_ESP = 50,
82 IPSEC_API_PROTO_AH = 51,
87 /* the length of the key */
89 /* The data for the key */
93 /** \brief IPsec: Security Association Database entry
94 @param client_index - opaque cookie to identify the sender
95 @param context - sender context, to match reply w/ request
96 @param is_add - add SAD entry if non-zero, else delete
97 @param sad_id - sad id
98 @param spi - security parameter index
99 @param protocol - 0 = AH, 1 = ESP
100 @param crypto_algorithm - a supported crypto algorithm
101 @param crypto_key - crypto keying material
102 @param integrity_algorithm - one of the supported algorithms
103 @param integrity_key - integrity keying material
104 @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
105 @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
106 @param tx_table_id - the FIB id used for encapsulated packets
107 @param salt - for use with counter mode ciphers
108 @param udp_src_port - If using UDP Encapsulation, use this source port for
109 TX. It is ignored for RX.
110 @param udp_dst_port - If using UDP Encapsulation, use this destination port
111 for TX. Expect traffic on this port for RX.
112 @param tunnel_flags - Flags controlling the copying of encap/decap value
113 @param dscp - Fixed DSCP vaule for tunnel encap
115 typedef ipsec_sad_entry
121 vl_api_ipsec_proto_t protocol;
123 vl_api_ipsec_crypto_alg_t crypto_algorithm;
124 vl_api_key_t crypto_key;
126 vl_api_ipsec_integ_alg_t integrity_algorithm;
127 vl_api_key_t integrity_key;
129 vl_api_ipsec_sad_flags_t flags;
131 vl_api_address_t tunnel_src;
132 vl_api_address_t tunnel_dst;
135 u16 udp_src_port [default=4500];
136 u16 udp_dst_port [default=4500];
139 typedef ipsec_sad_entry_v2
145 vl_api_ipsec_proto_t protocol;
147 vl_api_ipsec_crypto_alg_t crypto_algorithm;
148 vl_api_key_t crypto_key;
150 vl_api_ipsec_integ_alg_t integrity_algorithm;
151 vl_api_key_t integrity_key;
153 vl_api_ipsec_sad_flags_t flags;
155 vl_api_address_t tunnel_src;
156 vl_api_address_t tunnel_dst;
157 vl_api_tunnel_encap_decap_flags_t tunnel_flags;
158 vl_api_ip_dscp_t dscp;
161 u16 udp_src_port [default=4500];
162 u16 udp_dst_port [default=4500];
165 typedef ipsec_sad_entry_v3
170 vl_api_ipsec_proto_t protocol;
172 vl_api_ipsec_crypto_alg_t crypto_algorithm;
173 vl_api_key_t crypto_key;
175 vl_api_ipsec_integ_alg_t integrity_algorithm;
176 vl_api_key_t integrity_key;
178 vl_api_ipsec_sad_flags_t flags;
180 vl_api_tunnel_t tunnel;
183 u16 udp_src_port [default=4500];
184 u16 udp_dst_port [default=4500];
190 * eval: (c-set-style "gnu")