1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2020 Doc.ai 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 = "0.3.0";
19 import "vnet/interface_types.api";
20 import "vnet/ip/ip_types.api";
22 /** \brief Create wireguard interface
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param private_key - private key in binary format of this device
26 @param public_key - public key in binary format of this device
27 @param port - port of this device
28 @param src_ip - packet sent through this interface us this
29 address as the IP source.
31 typedef wireguard_interface
33 u32 user_instance [default=0xffffffff];
34 vl_api_interface_index_t sw_if_index;
38 vl_api_address_t src_ip;
41 /** \brief Create an Wireguard interface
43 define wireguard_interface_create {
46 vl_api_wireguard_interface_t interface;
50 /** \brief Add Wireguard interface interface response
51 @param context - sender context, to match reply w/ request
52 @param retval - return status
53 @param sw_if_index - sw_if_index of new interface (for successful add)
55 define wireguard_interface_create_reply
59 vl_api_interface_index_t sw_if_index;
62 autoreply define wireguard_interface_delete
66 vl_api_interface_index_t sw_if_index;
69 define wireguard_interface_dump
73 bool show_private_key;
74 vl_api_interface_index_t sw_if_index;
77 define wireguard_interface_details
80 vl_api_wireguard_interface_t interface;
83 enum wireguard_peer_flags : u8
85 WIREGUARD_PEER_STATUS_DEAD = 0x1,
86 WIREGUARD_PEER_ESTABLISHED = 0x2,
89 /** \brief Peer structure
90 @param peer_index - peer pool index
91 @param public_key - public key (in binary format) of destination peer
92 @param port - destination port
93 @param persistent_keepalive - keepalive packet timeout
94 @param table_id - The IP table in which 'endpoint' is reachable
95 @param endpoint - destination ip
96 @param sw_if_index - tunnel SW interface
97 @param flags - peer status flags
98 @param n_allowed_ips - number of prefixes in allowed_ips
99 @param allowed_ips - allowed incoming tunnel prefixes
101 typedef wireguard_peer
106 u16 persistent_keepalive;
108 vl_api_address_t endpoint;
109 vl_api_interface_index_t sw_if_index;
110 vl_api_wireguard_peer_flags_t flags;
112 vl_api_prefix_t allowed_ips[n_allowed_ips];
116 rpc want_wireguard_peer_events returns want_wireguard_peer_events_reply
117 events wireguard_peer_event;
119 /** \brief Register for wireguard peer events
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
122 @param sw_if_index - index of the interface to dump peer info on, ~0 if on all
123 @param peer_index - index of the peer to dump info on, ~0 if on all
124 @param enable_disable - 1 => register for events, 0 => cancel registration
125 @param pid - sender's pid
127 autoreply define want_wireguard_peer_events
131 vl_api_interface_index_t sw_if_index [default=0xFFFFFFFF];
132 u32 peer_index [default=0xFFFFFFFF];
136 /** \brief Interface Event generated by want_wireguard_peer_events
137 @param client_index - opaque cookie to identify the sender
138 @param pid - client pid registered to receive notification
139 @param peer_index - index of the peer for this event
140 @param deleted - interface was deleted
142 define wireguard_peer_event
147 vl_api_wireguard_peer_flags_t flags;
150 /** \brief Create new peer
151 @param client_index - opaque cookie to identify the sender
152 @param context - sender context, to match reply w/ request
153 @param peer - peer to create
155 define wireguard_peer_add
159 vl_api_wireguard_peer_t peer;
162 /** \brief Create new peer
163 @param context - sender context, to match reply w/ request
164 @param retval - return status
165 @param peer_index - Created or existing peer pool index
167 define wireguard_peer_add_reply
174 /** \brief Remove peer
175 @param client_index - opaque cookie to identify the sender
176 @param context - sender context, to match reply w/ request
177 @param peer_index - peer to be removed
179 autoreply define wireguard_peer_remove
186 /** \brief Dump all peers
187 @param client_index - opaque cookie to identify the sender
188 @param context - sender context, to match reply w/ request
189 @param peer_index - peer index to be dumped. If 0xFFFFFFFF dumps all peers
191 define wireguard_peers_dump {
194 u32 peer_index [default=0xFFFFFFFF];
197 /** \brief Dump peer details
198 @param context - sender context, to match reply w/ request
199 @param peer - peer details
201 define wireguard_peers_details {
203 vl_api_wireguard_peer_t peer;
206 /** \brief Wireguard Set Async mode
207 @param client_index - opaque cookie to identify the sender
208 @param context - sender context, to match reply w/ request
209 @param async_enable - wireguard async mode on or off
211 autoreply define wg_set_async_mode {
219 * eval: (c-set-style "gnu")