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 GNUNET_PACKED;
  60
  61   /**
  62    * Here we get an ETH_P_-number.
  63    */
  64   uint16_t proto GNUNET_PACKED;
  65 };
  66
  67
  68 /**
  69  * Standard IPv4 header.
  70  */
  71 struct GNUNET_TUN_IPv4Header
  72 {
  73 #if __BYTE_ORDER == __LITTLE_ENDIAN
  74   unsigned int header_length:4 GNUNET_PACKED;
  75   unsigned int version:4 GNUNET_PACKED;
  76 #elif __BYTE_ORDER == __BIG_ENDIAN
  77   unsigned int version:4 GNUNET_PACKED;
  78   unsigned int header_length:4 GNUNET_PACKED;
  79 #else
  80   #error byteorder undefined
  81 #endif
  82   uint8_t diff_serv;
  83
  84   /**
  85    * Length of the packet, including this header.
  86    */
  87   uint16_t total_length GNUNET_PACKED;
  88
  89   /**
  90    * Unique random ID for matching up fragments.
  91    */
  92   uint16_t identification GNUNET_PACKED;
  93
  94   unsigned int flags:3 GNUNET_PACKED;
  95
  96   unsigned int fragmentation_offset:13 GNUNET_PACKED;
  97
  98   /**
  99    * How many more hops can this packet be forwarded?
 100    */
 101   uint8_t ttl;
 102
 103   /**
 104    * L4-protocol, for example, IPPROTO_UDP or IPPROTO_TCP.
 105    */
 106   uint8_t protocol;
 107
 108   /**
 109    * Checksum.
 110    */
 111   uint16_t checksum GNUNET_PACKED;
 112
 113   /**
 114    * Origin of the packet.
 115    */
 116   struct in_addr source_address GNUNET_PACKED;
 117
 118   /**
 119    * Destination of the packet.
 120    */
 121   struct in_addr destination_address GNUNET_PACKED;
 122 } GNUNET_GCC_STRUCT_LAYOUT;
 123
 124
 125 /**
 126  * Standard IPv6 header.
 127  */
 128 struct GNUNET_TUN_IPv6Header
 129 {
 130 #if __BYTE_ORDER == __LITTLE_ENDIAN
 131   unsigned int traffic_class_h:4 GNUNET_PACKED;
 132   unsigned int version:4 GNUNET_PACKED;
 133   unsigned int traffic_class_l:4 GNUNET_PACKED;
 134   unsigned int flow_label:20 GNUNET_PACKED;
 135 #elif __BYTE_ORDER == __BIG_ENDIAN
 136   unsigned int version:4 GNUNET_PACKED;
 137   unsigned int traffic_class:8 GNUNET_PACKED;
 138   unsigned int flow_label:20 GNUNET_PACKED;
 139 #else
 140   #error byteorder undefined
 141 #endif
 142   /**
 143    * Length of the payload, excluding this header.
 144    */
 145   uint16_t payload_length GNUNET_PACKED;
 146
 147   /**
 148    * For example, IPPROTO_UDP or IPPROTO_TCP.
 149    */
 150   uint8_t next_header;
 151
 152   /**
 153    * How many more hops can this packet be forwarded?
 154    */
 155   uint8_t hop_limit;
 156
 157   /**
 158    * Origin of the packet.
 159    */
 160   struct in6_addr source_address GNUNET_PACKED;
 161
 162   /**
 163    * Destination of the packet.
 164    */
 165   struct in6_addr destination_address GNUNET_PACKED;
 166 } GNUNET_GCC_STRUCT_LAYOUT;
 167
 168
 169 /**
 170  * TCP packet header.
 171  */
 172 struct GNUNET_TUN_TcpHeader
 173 {
 174   uint16_t source_port GNUNET_PACKED;
 175   uint16_t destination_port GNUNET_PACKED;
 176
 177   /**
 178    * Sequence number.
 179    */
 180   uint32_t seq GNUNET_PACKED;
 181
 182   /**
 183    * Acknowledgement number.
 184    */
 185   uint32_t ack GNUNET_PACKED;
 186 #if __BYTE_ORDER == __LITTLE_ENDIAN
 187   /**
 188    * Reserved.  Must be zero.
 189    */
 190   unsigned int reserved : 4 GNUNET_PACKED;
 191   /**
 192    * Number of 32-bit words in TCP header.
 193    */
 194   unsigned int off : 4 GNUNET_PACKED;
 195 #elif __BYTE_ORDER == __BIG_ENDIAN
 196   /**
 197    * Number of 32-bit words in TCP header.
 198    */
 199   unsigned int off : 4 GNUNET_PACKED;
 200   /**
 201    * Reserved.  Must be zero.
 202    */
 203   unsigned int reserved : 4 GNUNET_PACKED;
 204 #else
 205   #error byteorder undefined
 206 #endif
 207
 208   /**
 209    * Flags (SYN, FIN, ACK, etc.)
 210    */
 211   uint8_t flags;
 212
 213   /**
 214    * Window size.
 215    */
 216   uint16_t window_size GNUNET_PACKED;
 217
 218   /**
 219    * Checksum.
 220    */
 221   uint16_t crc GNUNET_PACKED;
 222
 223   /**
 224    * Urgent pointer.
 225    */
 226   uint16_t urgent_pointer GNUNET_PACKED;
 227 } GNUNET_GCC_STRUCT_LAYOUT;
 228
 229
 230 /**
 231  * UDP packet header.
 232  */
 233 struct GNUNET_TUN_UdpHeader
 234 {
 235   uint16_t source_port GNUNET_PACKED;
 236   uint16_t destination_port GNUNET_PACKED;
 237   uint16_t len GNUNET_PACKED;
 238   uint16_t crc GNUNET_PACKED;
 239 };
 240
 241
 242 /**
 243  * DNS header.
 244  */
 245 struct GNUNET_TUN_DnsHeader
 246 {
 247   uint16_t id GNUNET_PACKED;
 248   uint16_t flags GNUNET_PACKED;
 249   uint16_t qdcount GNUNET_PACKED;
 250   uint16_t ancount GNUNET_PACKED;
 251   uint16_t nscount GNUNET_PACKED;
 252   uint16_t arcount GNUNET_PACKED;
 253 };
 254
 255 #define GNUNET_TUN_ICMPTYPE_ECHO_REPLY 0
 256 #define GNUNET_TUN_ICMPTYPE_DESTINATION_UNREACHABLE 3
 257 #define GNUNET_TUN_ICMPTYPE_SOURCE_QUENCH 4
 258 #define GNUNET_TUN_ICMPTYPE_REDIRECT_MESSAGE 5
 259 #define GNUNET_TUN_ICMPTYPE_ECHO_REQUEST 8
 260 #define GNUNET_TUN_ICMPTYPE_ROUTER_ADVERTISEMENT 9
 261 #define GNUNET_TUN_ICMPTYPE_ROUTER_SOLICITATION 10
 262 #define GNUNET_TUN_ICMPTYPE_TIME_EXCEEDED 11
 263
 264 #define GNUNET_TUN_ICMPTYPE6_DESTINATION_UNREACHABLE 1
 265 #define GNUNET_TUN_ICMPTYPE6_PACKET_TOO_BIG 2
 266 #define GNUNET_TUN_ICMPTYPE6_TIME_EXCEEDED 3
 267 #define GNUNET_TUN_ICMPTYPE6_PARAMETER_PROBLEM 4
 268 #define GNUNET_TUN_ICMPTYPE6_ECHO_REQUEST 128
 269 #define GNUNET_TUN_ICMPTYPE6_ECHO_REPLY 129
 270
 271
 272 /**
 273  * ICMP header.
 274  */
 275 struct GNUNET_TUN_IcmpHeader {
 276   uint8_t type;
 277   uint8_t code;
 278   uint16_t crc GNUNET_PACKED;
 279
 280   union {
 281     /**
 282      * ICMP Echo (request/reply)
 283      */
 284     struct {
 285       uint16_t  identifier GNUNET_PACKED;
 286       uint16_t  sequence_number GNUNET_PACKED;
 287     } echo;
 288
 289     /**
 290      * ICMP Destination Unreachable (RFC 1191)
 291      */
 292     struct ih_pmtu {
 293       uint16_t empty GNUNET_PACKED;
 294       uint16_t next_hop_mtu GNUNET_PACKED;
 295       /* followed by original IP header + first 8 bytes of original IP datagram */
 296     } destination_unreachable;
 297
 298     /**
 299      * ICMP Redirect
 300      */
 301     struct in_addr redirect_gateway_address GNUNET_PACKED;
 302
 303     /**
 304      * MTU for packets that are too big (IPv6).
 305      */
 306     uint32_t packet_too_big_mtu GNUNET_PACKED;
 307
 308   } quench;
 309
 310 };
 311
 312
 313 GNUNET_NETWORK_STRUCT_END
 314
 315
 316 /**
 317  * Initialize an IPv4 header.
 318  *
 319  * @param ip header to initialize
 320  * @param protocol protocol to use (i.e. IPPROTO_UDP)
 321  * @param payload_length number of bytes of payload that follow (excluding IPv4 header)
 322  * @param src source IP address to use
 323  * @param dst destination IP address to use
 324  */
 325 void
 326 GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip,
 327                                    uint8_t protocol,
 328                                    uint16_t payload_length,
 329                                    const struct in_addr *src,
 330                                    const struct in_addr *dst);
 331
 332
 333 /**
 334  * Initialize an IPv6 header.
 335  *
 336  * @param ip header to initialize
 337  * @param protocol protocol to use (i.e. IPPROTO_UDP)
 338  * @param payload_length number of bytes of payload that follow (excluding IPv4 header)
 339  * @param src source IP address to use
 340  * @param dst destination IP address to use
 341  */
 342 void
 343 GNUNET_TUN_initialize_ipv6_header (struct GNUNET_TUN_IPv6Header *ip,
 344                                    uint8_t protocol,
 345                                    uint16_t payload_length,
 346                                    const struct in6_addr *src,
 347                                    const struct in6_addr *dst);
 348
 349 /**
 350  * Calculate IPv4 TCP checksum.
 351  *
 352  * @param ip ipv4 header fully initialized
 353  * @param tcp TCP header (initialized except for CRC)
 354  * @param payload the TCP payload
 355  * @param payload_length number of bytes of TCP payload
 356  */
 357 void
 358 GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 359                                     struct GNUNET_TUN_TcpHeader *tcp,
 360                                     const void *payload,
 361                                     uint16_t payload_length);
 362
 363 /**
 364  * Calculate IPv6 TCP checksum.
 365  *
 366  * @param ip ipv6 header fully initialized
 367  * @param tcp TCP header (initialized except for CRC)
 368  * @param payload the TCP payload
 369  * @param payload_length number of bytes of TCP payload
 370  */
 371 void
 372 GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 373                                     struct GNUNET_TUN_TcpHeader *tcp,
 374                                     const void *payload,
 375                                     uint16_t payload_length);
 376
 377 /**
 378  * Calculate IPv4 UDP checksum.
 379  *
 380  * @param ip ipv4 header fully initialized
 381  * @param udp UDP header (initialized except for CRC)
 382  * @param payload the UDP payload
 383  * @param payload_length number of bytes of UDP payload
 384  */
 385 void
 386 GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 387                                     struct GNUNET_TUN_UdpHeader *udp,
 388                                     const void *payload,
 389                                     uint16_t payload_length);
 390
 391
 392 /**
 393  * Calculate IPv6 UDP checksum.
 394  *
 395  * @param ip ipv6 header fully initialized
 396  * @param udp UDP header (initialized except for CRC)
 397  * @param payload the UDP payload
 398  * @param payload_length number of bytes of UDP payload
 399  */
 400 void
 401 GNUNET_TUN_calculate_udp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 402                                     struct GNUNET_TUN_UdpHeader *udp,
 403                                     const void *payload,
 404                                     uint16_t payload_length);
 405
 406
 407 /**
 408  * Calculate ICMP checksum.
 409  *
 410  * @param icmp IMCP header (initialized except for CRC)
 411  * @param payload the ICMP payload
 412  * @param payload_length number of bytes of ICMP payload
 413  */
 414 void
 415 GNUNET_TUN_calculate_icmp_checksum (struct GNUNET_TUN_IcmpHeader *icmp,
 416                                     const void *payload,
 417                                     uint16_t payload_length);
 418
 419
 420 #endif