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";
22 * @brief Support cryptographic algorithms
26 IPSEC_API_CRYPTO_ALG_NONE = 0,
27 IPSEC_API_CRYPTO_ALG_AES_CBC_128,
28 IPSEC_API_CRYPTO_ALG_AES_CBC_192,
29 IPSEC_API_CRYPTO_ALG_AES_CBC_256,
30 IPSEC_API_CRYPTO_ALG_AES_CTR_128,
31 IPSEC_API_CRYPTO_ALG_AES_CTR_192,
32 IPSEC_API_CRYPTO_ALG_AES_CTR_256,
33 IPSEC_API_CRYPTO_ALG_AES_GCM_128,
34 IPSEC_API_CRYPTO_ALG_AES_GCM_192,
35 IPSEC_API_CRYPTO_ALG_AES_GCM_256,
36 IPSEC_API_CRYPTO_ALG_DES_CBC,
37 IPSEC_API_CRYPTO_ALG_3DES_CBC,
41 * @brief Supported Integrity Algorithms
45 IPSEC_API_INTEG_ALG_NONE = 0,
47 IPSEC_API_INTEG_ALG_MD5_96,
49 IPSEC_API_INTEG_ALG_SHA1_96,
50 /* draft-ietf-ipsec-ciph-sha-256-00 */
51 IPSEC_API_INTEG_ALG_SHA_256_96,
53 IPSEC_API_INTEG_ALG_SHA_256_128,
55 IPSEC_API_INTEG_ALG_SHA_384_192,
57 IPSEC_API_INTEG_ALG_SHA_512_256,
62 IPSEC_API_SAD_FLAG_NONE = 0,
63 /* Enable extended sequence numbers */
64 IPSEC_API_SAD_FLAG_USE_ESN = 0x01,
65 /* Enable Anti-replay */
66 IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02,
67 /* IPsec tunnel mode if non-zero, else transport mode */
68 IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04,
69 /* IPsec tunnel mode is IPv6 if non-zero,
70 * else IPv4 tunnel only valid if is_tunnel is non-zero */
71 IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08,
72 /* enable UDP encapsulation for NAT traversal */
73 IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10,
84 /* the length of the key */
86 /* The data for the key */
90 /** \brief IPsec: Security Association Database entry
91 @param client_index - opaque cookie to identify the sender
92 @param context - sender context, to match reply w/ request
93 @param is_add - add SAD entry if non-zero, else delete
94 @param sad_id - sad id
95 @param spi - security parameter index
96 @param protocol - 0 = AH, 1 = ESP
97 @param crypto_algorithm - a supported crypto algorithm
98 @param crypto_key - crypto keying material
99 @param integrity_algorithm - one of the supported algorithms
100 @param integrity_key - integrity keying material
101 @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
102 @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
103 @param tx_table_id - the FIB id used for encapsulated packets
104 @param salt - for use with counter mode ciphers
106 typedef ipsec_sad_entry
112 vl_api_ipsec_proto_t protocol;
114 vl_api_ipsec_crypto_alg_t crypto_algorithm;
115 vl_api_key_t crypto_key;
117 vl_api_ipsec_integ_alg_t integrity_algorithm;
118 vl_api_key_t integrity_key;
120 vl_api_ipsec_sad_flags_t flags;
122 vl_api_address_t tunnel_src;
123 vl_api_address_t tunnel_dst;
130 * eval: (c-set-style "gnu")