src/plugins/wireguard/wireguard.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   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:
   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 = "0.1.0";
  18
  19 import "vnet/interface_types.api";
  20 import "vnet/ip/ip_types.api";
  21
  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.
  30 */
  31 typedef wireguard_interface
  32 {
  33   u32 user_instance [default=0xffffffff];
  34   vl_api_interface_index_t sw_if_index;
  35   u8 private_key[32];
  36   u8 public_key[32];
  37   u16 port;
  38   vl_api_address_t src_ip;
  39 };
  40
  41 /** \brief Create an Wireguard interface
  42  */
  43 define wireguard_interface_create {
  44   u32 client_index;
  45   u32 context;
  46   vl_api_wireguard_interface_t interface;
  47   bool generate_key;
  48 };
  49
  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)
  54 */
  55 define wireguard_interface_create_reply
  56 {
  57   u32 context;
  58   i32 retval;
  59   vl_api_interface_index_t sw_if_index;
  60 };
  61
  62 autoreply define wireguard_interface_delete
  63 {
  64   u32 client_index;
  65   u32 context;
  66   vl_api_interface_index_t sw_if_index;
  67 };
  68
  69 define wireguard_interface_dump
  70 {
  71   u32 client_index;
  72   u32 context;
  73   bool show_private_key;
  74   vl_api_interface_index_t sw_if_index;
  75 };
  76
  77 define wireguard_interface_details
  78 {
  79   u32 context;
  80   vl_api_wireguard_interface_t interface;
  81 };
  82
  83 enum wireguard_peer_flags : u8
  84 {
  85   WIREGUARD_PEER_STATUS_DEAD = 0x1,
  86 };
  87
  88 /** \brief Create new peer
  89     @param public_key - public key (in binary format) of destination peer
  90     @param port - destination port
  91     @param table_id - The IP table in which 'endpoint' is reachable
  92     @param endpoint - destination ip
  93     @param allowed_ip - allowed incoming ip tunnel
  94     @param tun_sw_if_index - tunnel interface
  95     @param persistent_keepalive - keepalive packet timeout
  96 */
  97 typedef wireguard_peer
  98 {
  99   u8 public_key[32];
 100   u16 port;
 101   u16 persistent_keepalive;
 102   u32 table_id;
 103   vl_api_address_t endpoint;
 104   vl_api_interface_index_t sw_if_index;
 105   vl_api_wireguard_peer_flags_t flags;
 106   u8 n_allowed_ips;
 107   vl_api_prefix_t allowed_ips[n_allowed_ips];
 108 };
 109
 110 /** \brief Create new peer
 111     @param client_index - opaque cookie to identify the sender
 112     @param context - sender context, to match reply w/ request
 113     @param peer - peer to create
 114 */
 115 define wireguard_peer_add
 116 {
 117   u32 client_index;
 118   u32 context;
 119   vl_api_wireguard_peer_t peer;
 120 };
 121 define wireguard_peer_add_reply
 122 {
 123   u32 context;
 124   i32 retval;
 125   u32 peer_index;
 126 };
 127
 128 /** \brief Remove peer by public_key
 129     @param client_index - opaque cookie to identify the sender
 130     @param context - sender context, to match reply w/ request
 131     @param public_key
 132 */
 133 autoreply define wireguard_peer_remove
 134 {
 135   u32 client_index;
 136   u32 context;
 137   u32 peer_index;
 138 };
 139
 140 /** \brief Dump all peers
 141     @param client_index - opaque cookie to identify the sender
 142     @param context - sender context, to match reply w/ request
 143 */
 144 define wireguard_peers_dump {
 145   u32 client_index;
 146   u32 context;
 147 };
 148
 149 /** \brief Dump peers response
 150     @param context - sender context, to match reply w/ request
 151     @param is_dead - is peer valid yet
 152     @param public_key - peer public_key
 153     @param ip4_address - ip4 endpoint address
 154 */
 155 define wireguard_peers_details {
 156   u32 context;
 157   vl_api_wireguard_peer_t peer;
 158 };
 159
 160 /*
 161  * Local Variables:
 162  * eval: (c-set-style "gnu")
 163  * End:
 164  */