src/transport/plugin_transport_wlan.h

   1 /*
   2    This file is part of GNUnet
   3    Copyright (C) 2010, 2011 GNUnet e.V.
   4
   5    GNUnet is free software: you can redistribute it and/or modify it
   6    under the terms of the GNU Affero General Public License as published
   7    by the Free Software Foundation, either version 3 of the License,
   8    or (at your option) any later version.
   9
  10    GNUnet is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Affero General Public License for more details.
  14
  15    You should have received a copy of the GNU Affero General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file transport/plugin_transport_wlan.h
  23  * @brief header for transport plugin and the helper for wlan
  24  * @author David Brodski
  25  */
  26 #ifndef PLUGIN_TRANSPORT_WLAN
  27 #define PLUGIN_TRANSPORT_WLAN
  28
  29 #include "gnunet_crypto_lib.h"
  30 #include "gnunet_common.h"
  31
  32 /**
  33  * Number fo bytes in a mac address.
  34  */
  35 #define MAC_ADDR_SIZE 6
  36
  37 /**
  38  * Value for "Management" in the 'frame_control' field of the
  39  * struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame.
  40  */
  41 #define IEEE80211_FC0_TYPE_MGT                  0x00
  42
  43 /**
  44  * Value for "Control" in the 'frame_control' field of the
  45  * struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame.
  46  */
  47 #define IEEE80211_FC0_TYPE_CTL                  0x04
  48
  49 /**
  50  * Value for DATA in the 'frame_control' field of the
  51  * struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame.
  52  */
  53 #define IEEE80211_FC0_TYPE_DATA                 0x08
  54
  55
  56 GNUNET_NETWORK_STRUCT_BEGIN
  57
  58 /**
  59  * A MAC Address.
  60  */
  61 struct GNUNET_TRANSPORT_WLAN_MacAddress
  62 {
  63   uint8_t mac[MAC_ADDR_SIZE];
  64 };
  65
  66 /**
  67  * Format of a WLAN Control Message.
  68  */
  69 struct GNUNET_TRANSPORT_WLAN_HelperControlMessage
  70 {
  71   /**
  72    * Message header.  Type is
  73    * GNUNET_MESSAGE_TYPE_WLAN_HELPER_CONTROL
  74    */
  75   struct GNUNET_MessageHeader hdr;
  76
  77   /**
  78    * MAC Address of the local WLAN interface.
  79    */
  80   struct GNUNET_TRANSPORT_WLAN_MacAddress mac;
  81 };
  82
  83 /**
  84  * generic definitions for IEEE 802.3 frames
  85  */
  86 struct GNUNET_TRANSPORT_WLAN_Ieee8023Frame
  87 {
  88   /**
  89    * Address 1: destination address in ad-hoc mode or AP, BSSID if station,
  90    */
  91   struct GNUNET_TRANSPORT_WLAN_MacAddress dst;
  92
  93   /**
  94    * Address 2: source address if in ad-hoc-mode or station, BSSID if AP
  95    */
  96   struct GNUNET_TRANSPORT_WLAN_MacAddress src;
  97
  98   /**
  99    * Packet type ID.
 100    */
 101   uint16_t type;
 102 };
 103
 104
 105 /**
 106  * generic definitions for IEEE 802.11 frames
 107  */
 108 struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame
 109 {
 110   /**
 111    * 802.11 Frame Control field.  A bitmask.  The overall field is a
 112    * 16-bit mask of the respecitve fields.  The lowest two bits should
 113    * be 0, then comes the "type" (2 bits, see IEEE80211_FC0_TYPE_*
 114    * constants), followed by 4-bit subtype (all zeros for ad-hoc),
 115    * followed by various flags (to DS, from DS, more frag, retry,
 116    * power management, more data, WEP, strict), all of which we also
 117    * keep at zero.
 118    */
 119   uint16_t frame_control GNUNET_PACKED;
 120
 121   /**
 122    * Microseconds to reserve link (duration), 0 by default
 123    */
 124   uint16_t duration GNUNET_PACKED;
 125
 126   /**
 127    * Address 1: destination address in ad-hoc mode or AP, BSSID if station,
 128    */
 129   struct GNUNET_TRANSPORT_WLAN_MacAddress addr1;
 130
 131   /**
 132    * Address 2: source address if in ad-hoc-mode or station, BSSID if AP
 133    */
 134   struct GNUNET_TRANSPORT_WLAN_MacAddress addr2;
 135
 136   /**
 137    * Address 3: BSSID in ad-hoc mode, Destination if station, source if AP
 138    */
 139   struct GNUNET_TRANSPORT_WLAN_MacAddress addr3;
 140
 141   /**
 142    * 802.11 sequence control field; contains fragment number an sequence
 143    * number (we set this to all zeros).
 144    */
 145   uint16_t sequence_control GNUNET_PACKED;
 146
 147   /**
 148    * Link layer control (LLC).  Set to a GNUnet-specific value.
 149    */
 150   u_int8_t llc[4];
 151
 152   /* payload */
 153 } GNUNET_PACKED;
 154
 155
 156
 157 /**
 158  * Message from the plugin to the WLAN helper: send the given message with the
 159  * given connection parameters.
 160  */
 161 struct GNUNET_TRANSPORT_WLAN_RadiotapSendMessage
 162 {
 163   /**
 164    * Type is 'GNUNET_MESSAGE_TYPE_WLAN_DATA_TO_HELPER'.
 165    */
 166   struct GNUNET_MessageHeader header;
 167
 168   /**
 169    * wlan send rate
 170    */
 171   uint8_t rate;
 172
 173   /**
 174    * Antenna; the first antenna is 0.
 175    */
 176   uint8_t antenna;
 177
 178   /**
 179    * Transmit power expressed as unitless distance from max power set at factory calibration.
 180    * 0 is max power. Monotonically nondecreasing with lower power levels.
 181    */
 182   uint16_t tx_power GNUNET_PACKED;
 183
 184   /**
 185    * IEEE Frame to transmit (the sender MAC address will be overwritten by the helper as it does not
 186    * trust the plugin to set it correctly).
 187    */
 188   struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame frame;
 189
 190   /* actual payload follows */
 191 };
 192
 193
 194 /**
 195  * Message from the WLAN helper to the plugin: we have received the given message with the
 196  * given performance characteristics.
 197  */
 198 /**
 199  * struct to represent infos gathered form the radiotap fields, see RadiotapHeader for more Infos
 200  */
 201 struct GNUNET_TRANSPORT_WLAN_RadiotapReceiveMessage
 202 {
 203   /**
 204    * Type is 'GNUNET_MESSAGE_TYPE_WLAN_DATA_FROM_HELPER'.
 205    */
 206   struct GNUNET_MessageHeader header;
 207
 208   /**
 209    * Information about which of the fields below are actually valid.
 210    * 0 for none.  FIXME: not properly initialized so far (always zero).
 211    */
 212   uint32_t ri_present GNUNET_PACKED;
 213
 214   /**
 215    * IEEE80211_RADIOTAP_TSFT, 0 if unknown.
 216    */
 217   uint64_t ri_mactime GNUNET_PACKED;
 218
 219   /**
 220    * from radiotap
 221    * either IEEE80211_RADIOTAP_DBM_ANTSIGNAL
 222    * or IEEE80211_RADIOTAP_DB_ANTSIGNAL, 0 if unknown.
 223    */
 224   int32_t ri_power GNUNET_PACKED;
 225
 226   /**
 227    * either IEEE80211_RADIOTAP_DBM_ANTNOISE
 228    * or IEEE80211_RADIOTAP_DB_ANTNOISE, 0 if unknown.
 229    */
 230   int32_t ri_noise GNUNET_PACKED;
 231
 232   /**
 233    * IEEE80211_RADIOTAP_CHANNEL, 0 if unknown.
 234    */
 235   uint32_t ri_channel GNUNET_PACKED;
 236
 237   /**
 238    * Frequency we use.  0 if unknown.
 239    */
 240   uint32_t ri_freq GNUNET_PACKED;
 241
 242   /**
 243    * IEEE80211_RADIOTAP_RATE * 50000, 0 if unknown.
 244    */
 245   uint32_t ri_rate GNUNET_PACKED;
 246
 247   /**
 248    * IEEE80211_RADIOTAP_ANTENNA, 0 if unknown.
 249    */
 250   uint32_t ri_antenna GNUNET_PACKED;
 251
 252   /**
 253    * IEEE Frame.
 254    */
 255   struct GNUNET_TRANSPORT_WLAN_Ieee80211Frame frame;
 256
 257   /* followed by payload */
 258 };
 259
 260 GNUNET_NETWORK_STRUCT_END
 261
 262 /**
 263  * GNUnet bssid
 264  */
 265 static const struct GNUNET_TRANSPORT_WLAN_MacAddress mac_bssid_gnunet = {
 266   { 0x13, 0x22, 0x33, 0x44, 0x55, 0x66 }
 267 };
 268
 269
 270 /**
 271  * Broadcast MAC
 272  */
 273 static const struct GNUNET_TRANSPORT_WLAN_MacAddress bc_all_mac = {
 274   { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }
 275 };
 276
 277 #endif