src/include/gnunet_tun_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010, 2011, 2012 Christian Grothoff
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_tun_lib.h
  23  * @brief standard TCP/IP network structs and IP checksum calculations for TUN interaction
  24  * @author Philipp Toelke
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_TUN_LIB_H
  28 #define GNUNET_TUN_LIB_H
  29
  30 #include "gnunet_util_lib.h"
  31
  32
  33 /* see http://www.iana.org/assignments/ethernet-numbers */
  34 #ifndef ETH_P_IPV4
  35 /**
  36  * Number for IPv4
  37  */
  38 #define ETH_P_IPV4 0x0800
  39 #endif
  40
  41 #ifndef ETH_P_IPV6
  42 /**
  43  * Number for IPv6
  44  */
  45 #define ETH_P_IPV6 0x86DD
  46 #endif
  47
  48
  49 GNUNET_NETWORK_STRUCT_BEGIN
  50
  51 /**
  52  * Header from Linux TUN interface.
  53  */
  54 struct GNUNET_TUN_Layer2PacketHeader
  55 {
  56   /**
  57    * Some flags (unused).
  58    */
  59   uint16_t flags;
  60
  61   /**
  62    * Here we get an ETH_P_-number.
  63    */
  64   uint16_t proto;
  65 };
  66
  67
  68 /**
  69  * Standard IPv4 header.
  70  */
  71 struct GNUNET_TUN_IPv4Header
  72 {
  73   unsigned header_length:4 GNUNET_PACKED;
  74   unsigned version:4 GNUNET_PACKED;
  75   uint8_t diff_serv;
  76   uint16_t total_length GNUNET_PACKED;
  77   uint16_t identification GNUNET_PACKED;
  78   unsigned flags:3 GNUNET_PACKED;
  79   unsigned fragmentation_offset:13 GNUNET_PACKED;
  80   uint8_t ttl;
  81   uint8_t protocol;
  82   uint16_t checksum GNUNET_PACKED;
  83   struct in_addr source_address GNUNET_PACKED;
  84   struct in_addr destination_address GNUNET_PACKED;
  85 };
  86
  87
  88 /**
  89  * Standard IPv6 header.
  90  */
  91 struct GNUNET_TUN_IPv6Header
  92 {
  93   unsigned traffic_class_h:4 GNUNET_PACKED;
  94   unsigned version:4 GNUNET_PACKED;
  95   unsigned traffic_class_l:4 GNUNET_PACKED;
  96   unsigned flow_label:20 GNUNET_PACKED;
  97   uint16_t payload_length GNUNET_PACKED;
  98   uint8_t next_header;
  99   uint8_t hop_limit;
 100   struct in6_addr source_address GNUNET_PACKED;
 101   struct in6_addr destination_address GNUNET_PACKED;
 102 };
 103
 104
 105 /**
 106  * TCP packet header (FIXME: rename!)
 107  */
 108 struct GNUNET_TUN_TcpHeader
 109 {
 110   unsigned spt:16 GNUNET_PACKED;
 111   unsigned dpt:16 GNUNET_PACKED;
 112   unsigned seq:32 GNUNET_PACKED;
 113   unsigned ack:32 GNUNET_PACKED;
 114   unsigned off:4 GNUNET_PACKED;
 115   unsigned rsv:4 GNUNET_PACKED;
 116   unsigned flg:8 GNUNET_PACKED;
 117   unsigned wsz:16 GNUNET_PACKED;
 118   unsigned crc:16 GNUNET_PACKED;
 119   unsigned urg:16 GNUNET_PACKED;
 120 };
 121
 122
 123 /**
 124  * UDP packet header  (FIXME: rename!)
 125  */
 126 struct GNUNET_TUN_UdpHeader
 127 {
 128   uint16_t spt GNUNET_PACKED;
 129   uint16_t dpt GNUNET_PACKED;
 130   uint16_t len GNUNET_PACKED;
 131   uint16_t crc GNUNET_PACKED;
 132 };
 133
 134
 135 /**
 136  * DNS header.
 137  */
 138 struct GNUNET_TUN_DnsHeader
 139 {
 140   uint16_t id GNUNET_PACKED;
 141   uint16_t flags GNUNET_PACKED;
 142   uint16_t qdcount GNUNET_PACKED;
 143   uint16_t ancount GNUNET_PACKED;
 144   uint16_t nscount GNUNET_PACKED;
 145   uint16_t arcount GNUNET_PACKED;
 146 };
 147
 148 #define GNUNET_TUN_ICMPTYPE_ECHO_REPLY 0
 149 #define GNUNET_TUN_ICMPTYPE_DESTINATION_UNREACHABLE 3
 150 #define GNUNET_TUN_ICMPTYPE_SOURCE_QUENCH 4
 151 #define GNUNET_TUN_ICMPTYPE_REDIRECT_MESSAGE 5
 152 #define GNUNET_TUN_ICMPTYPE_ECHO_REQUEST 8
 153 #define GNUNET_TUN_ICMPTYPE_ROUTER_ADVERTISEMENT 9
 154 #define GNUNET_TUN_ICMPTYPE_ROUTER_SOLICITATION 10
 155 #define GNUNET_TUN_ICMPTYPE_TIME_EXCEEDED 11
 156
 157 #define GNUNET_TUN_ICMPTYPE6_DESTINATION_UNREACHABLE 1
 158 #define GNUNET_TUN_ICMPTYPE6_PACKET_TOO_BIG 2
 159 #define GNUNET_TUN_ICMPTYPE6_TIME_EXCEEDED 3
 160 #define GNUNET_TUN_ICMPTYPE6_PARAMETER_PROBLEM 4
 161 #define GNUNET_TUN_ICMPTYPE6_ECHO_REQUEST 128
 162 #define GNUNET_TUN_ICMPTYPE6_ECHO_REPLY 129
 163
 164 /**
 165  * ICMP header.
 166  */
 167 struct GNUNET_TUN_IcmpHeader {
 168   uint8_t type;
 169   uint8_t code;
 170   uint16_t crc;
 171
 172   union {
 173     /**
 174      * ICMP Echo (request/reply)
 175      */
 176     struct {
 177       uint16_t  identifier;
 178       uint16_t  sequence_number;
 179     } echo;
 180
 181     /**
 182      * ICMP Destination Unreachable (RFC 1191)
 183      */
 184     struct ih_pmtu {
 185       uint16_t empty;
 186       uint16_t next_hop_mtu;
 187       /* followed by original IP header + first 8 bytes of original IP datagram */
 188     } destination_unreachable;
 189
 190     /**
 191      * ICMP Redirect
 192      */
 193     struct in_addr redirect_gateway_address;
 194
 195     /**
 196      * MTU for packets that are too big (IPv6).
 197      */
 198     uint32_t packet_too_big_mtu;
 199
 200   } quench;
 201
 202 };
 203
 204
 205 GNUNET_NETWORK_STRUCT_END
 206
 207
 208 /**
 209  * Initialize an IPv4 header.
 210  *
 211  * @param ip header to initialize
 212  * @param protocol protocol to use (i.e. IPPROTO_UDP)
 213  * @param payload_length number of bytes of payload that follow (excluding IPv4 header)
 214  * @param src source IP address to use
 215  * @param dst destination IP address to use
 216  */
 217 void
 218 GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip,
 219                                    uint8_t protocol,
 220                                    uint16_t payload_length,
 221                                    const struct in_addr *src,
 222                                    const struct in_addr *dst);
 223
 224
 225 /**
 226  * Initialize an IPv6 header.
 227  *
 228  * @param ip header to initialize
 229  * @param protocol protocol to use (i.e. IPPROTO_UDP)
 230  * @param payload_length number of bytes of payload that follow (excluding IPv4 header)
 231  * @param src source IP address to use
 232  * @param dst destination IP address to use
 233  */
 234 void
 235 GNUNET_TUN_initialize_ipv6_header (struct GNUNET_TUN_IPv6Header *ip,
 236                                    uint8_t protocol,
 237                                    uint16_t payload_length,
 238                                    const struct in6_addr *src,
 239                                    const struct in6_addr *dst);
 240
 241 /**
 242  * Calculate IPv4 TCP checksum.
 243  *
 244  * @param ipv4 header fully initialized
 245  * @param tcp TCP header (initialized except for CRC)
 246  * @param payload the TCP payload
 247  * @param payload_length number of bytes of TCP payload
 248  */
 249 void
 250 GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 251                                     struct GNUNET_TUN_TcpHeader *tcp,
 252                                     const void *payload,
 253                                     uint16_t payload_length);
 254
 255 /**
 256  * Calculate IPv6 TCP checksum.
 257  *
 258  * @param ipv6 header fully initialized
 259  * @param tcp TCP header (initialized except for CRC)
 260  * @param payload the TCP payload
 261  * @param payload_length number of bytes of TCP payload
 262  */
 263 void
 264 GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 265                                     struct GNUNET_TUN_TcpHeader *tcp,
 266                                     const void *payload,
 267                                     uint16_t payload_length);
 268
 269 /**
 270  * Calculate IPv4 UDP checksum.
 271  *
 272  * @param ipv4 header fully initialized
 273  * @param udp UDP header (initialized except for CRC)
 274  * @param payload the UDP payload
 275  * @param payload_length number of bytes of UDP payload
 276  */
 277 void
 278 GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 279                                     struct GNUNET_TUN_UdpHeader *udp,
 280                                     const void *payload,
 281                                     uint16_t payload_length);
 282
 283
 284 /**
 285  * Calculate IPv6 UDP checksum.
 286  *
 287  * @param ipv6 header fully initialized
 288  * @param udp UDP header (initialized except for CRC)
 289  * @param payload the UDP payload
 290  * @param payload_length number of bytes of UDP payload
 291  */
 292 void
 293 GNUNET_TUN_calculate_udp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 294                                     struct GNUNET_TUN_UdpHeader *udp,
 295                                     const void *payload,
 296                                     uint16_t payload_length);
 297
 298
 299 /**
 300  * Calculate ICMP checksum.
 301  *
 302  * @param icmp IMCP header (initialized except for CRC)
 303  * @param payload the ICMP payload
 304  * @param payload_length number of bytes of ICMP payload
 305  */
 306 void
 307 GNUNET_TUN_calculate_icmp_checksum (struct GNUNET_TUN_IcmpHeader *icmp,
 308                                     const void *payload,
 309                                     uint16_t payload_length);
 310
 311
 312 #endif