FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
ipsec_types.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 
17 option version = "3.0.0";
18 
19 import "vnet/ip/ip_types.api";
20 
21 /*
22  * @brief Support cryptographic algorithms
23  */
25 {
38 };
39 
40 /*
41  * @brief Supported Integrity Algorithms
42  */
44 {
46  /* RFC2403 */
48  /* RFC2404 */
50  /* draft-ietf-ipsec-ciph-sha-256-00 */
52  /* RFC4868 */
54  /* RFC4868 */
56  /* RFC4868 */
58 };
59 
61 {
63  /* Enable extended sequence numbers */
65  /* Enable Anti-replay */
67  /* IPsec tunnel mode if non-zero, else transport mode */
69  /* IPsec tunnel mode is IPv6 if non-zero,
70  * else IPv4 tunnel only valid if is_tunnel is non-zero */
72  /* enable UDP encapsulation for NAT traversal */
74  /* IPsec SA is for inbound traffic */
76 };
77 
79 {
82 };
83 
84 typedef key
85 {
86  /* the length of the key */
87  u8 length;
88  /* The data for the key */
89  u8 data[128];
90 };
91 
92 /** \brief IPsec: Security Association Database entry
93  @param client_index - opaque cookie to identify the sender
94  @param context - sender context, to match reply w/ request
95  @param is_add - add SAD entry if non-zero, else delete
96  @param sad_id - sad id
97  @param spi - security parameter index
98  @param protocol - 0 = AH, 1 = ESP
99  @param crypto_algorithm - a supported crypto algorithm
100  @param crypto_key - crypto keying material
101  @param integrity_algorithm - one of the supported algorithms
102  @param integrity_key - integrity keying material
103  @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
104  @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
105  @param tx_table_id - the FIB id used for encapsulated packets
106  @param salt - for use with counter mode ciphers
107  @param udp_src_port - If using UDP Encapsulation, use this source port for
108  TX. It is ignored for RX.
109  @param udp_dst_port - If using UDP Encapsulation, use this destination port
110  for TX. Expect traffic on this port for RX.
111  */
112 typedef ipsec_sad_entry
113 {
114  u32 sad_id;
115 
117 
118  vl_api_ipsec_proto_t protocol;
119 
120  vl_api_ipsec_crypto_alg_t crypto_algorithm;
121  vl_api_key_t crypto_key;
122 
123  vl_api_ipsec_integ_alg_t integrity_algorithm;
124  vl_api_key_t integrity_key;
125 
126  vl_api_ipsec_sad_flags_t flags;
127 
128  vl_api_address_t tunnel_src;
129  vl_api_address_t tunnel_dst;
132  u16 udp_src_port [default=4500];
133  u16 udp_dst_port [default=4500];
134 };
135 
136 /*
137  * Local Variables:
138  * eval: (c-set-style "gnu")
139  * End:
140  */
u32 spi
option version
Definition: ipsec_types.api:17
vl_api_address_t tunnel_dst
ipsec_proto
Definition: ipsec_types.api:78
vl_api_ipsec_sad_flags_t flags
vl_api_ipsec_proto_t protocol
u32 tx_table_id
vl_api_ipsec_integ_alg_t integrity_algorithm
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:89
u16 udp_dst_port[default=4500]
vl_api_ipsec_crypto_alg_t crypto_algorithm
u32 salt
unsigned int u32
Definition: types.h:88
u16 udp_src_port[default=4500]
vl_api_address_t tunnel_src
vl_api_key_t integrity_key
unsigned short u16
Definition: types.h:57
ipsec_sad_flags
Definition: ipsec_types.api:60
vl_api_key_t crypto_key
ipsec_crypto_alg
Definition: ipsec_types.api:24
typedef key
Definition: ipsec_types.api:85
typedef ipsec_sad_entry
IPsec: Security Association Database entry.
ipsec_integ_alg
Definition: ipsec_types.api:43