1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/* Hey Emacs use -*- mode: C -*- */
/*
* Copyright (c) 2018 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The IPIP module implements IP{v4,v6} over IP{v4,v6} tunnelling as
* described in RFC2473 and to some extent the largely historical
* RFC1853. The module also supports an IPv4 over IPv6 automatic
* tunnelling mechanism called 6RD (RFC5969).
*
* The IPIP API module supports a CRD model for adding, deleting and
* listing tunnels. A tunnel is represented as an interface in
* VPP. The "handle" representing a tunnel is the sw_if_index. As any
* interface, the user must configure an IPv4 and/or IPv6 address on
* the interface. This is the inner or payload protocol.
*
* Tunnel MTU: The tunnel MTU (the payload MTU) is configurable per
* protocol. If a tunnel MTU is larger than the path MTU, the outer
* packet will be fragmented. Fragmentation support is configurable,
* as it can have severe performance issues, and might be used as an
* attack vector (the remote side must reassemble.)
*
* Traffic class / TOS field can either be configured to a fixed
* value, or can be copied from the inner to the outer header.
* (For now we have stolen ~0 to indicate copy).
*
* Note:
*
* - The Tunnel encapsulation limit described in RFC2473 is not
* implemented.
*
* - ICMP proxying, as in a tunnel head-end receiving ICMP erors on
* the outer packet is currently not relayed to the original source
* of the packet.
*
* - PMTUD / MTU probing and tunnel keepalives are not yet implemented.
*
*/
option version = "2.0.2";
import "vnet/interface_types.api";
import "vnet/ip/ip_types.api";
import "vnet/tunnel/tunnel_types.api";
/**
* An IP{v4,v6} over IP{v4,v6} tunnel.
*/
typedef ipip_tunnel
{
u32 instance; /* If non-~0, specifies a custom dev instance */
vl_api_address_t src;
vl_api_address_t dst;
vl_api_interface_index_t sw_if_index; /* ignored on create, set in
details/dump */
u32 table_id;
vl_api_tunnel_encap_decap_flags_t flags;
vl_api_tunnel_mode_t mode;
vl_api_ip_dscp_t dscp; /* DSCP value for the tunnel encap,
ignored if ECNAP_COPY_DSCP flag is set */
};
/**
* Create an IP{v4,v6} over IP{v4,v6} tunnel.
*/
define ipip_add_tunnel
{
u32 client_index;
u32 context;
vl_api_ipip_tunnel_t tunnel;
};
define ipip_add_tunnel_reply
{
u32 context;
i32 retval;
vl_api_interface_index_t sw_if_index;
};
/**
* Delete an IP{v4,v6} over IP{v4,v6} tunnel.
*/
autoreply define ipip_del_tunnel
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
};
/**
* Create an IPv4 over IPv6 automatic tunnel (6RD)
*/
define ipip_6rd_add_tunnel
{
u32 client_index;
u32 context;
u32 ip6_table_id;
u32 ip4_table_id;
vl_api_ip6_prefix_t ip6_prefix;
vl_api_ip4_prefix_t ip4_prefix;
vl_api_ip4_address_t ip4_src;
bool security_check;
u8 tc_tos; /* If ~0, the TOS/TC value is copied from
inner packet, otherwise set to value */
};
define ipip_6rd_add_tunnel_reply
{
u32 context;
i32 retval;
vl_api_interface_index_t sw_if_index;
};
/**
* Delete an IPv4 over IPv6 automatic tunnel (6RD)
*/
autoreply define ipip_6rd_del_tunnel
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
};
/**
* List all IPIP tunnels
*/
define ipip_tunnel_dump
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
};
define ipip_tunnel_details
{
u32 context;
vl_api_ipip_tunnel_t tunnel;
};
|
