gnunet_tun_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2010-2013 Christian Grothoff
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_TUN_LIB_H
#define GNUNET_TUN_LIB_H
 
 
/* see http://www.iana.org/assignments/ethernet-numbers */
#ifndef ETH_P_IPV4
#define ETH_P_IPV4 0x0800
#endif
 
#ifndef ETH_P_IPV6
#define ETH_P_IPV6 0x86DD
#endif
 
 
#define GNUNET_TUN_IPV4_REGEXLEN 16
 
 
#define GNUNET_TUN_IPV6_REGEXLEN 40
 
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_TUN_Layer2PacketHeader
{
  uint16_t flags GNUNET_PACKED;
 
  uint16_t proto GNUNET_PACKED;
};
 
 
struct GNUNET_TUN_IPv4Header
{
#if __BYTE_ORDER == __LITTLE_ENDIAN
  unsigned int header_length : 4 GNUNET_PACKED;
  unsigned int version : 4 GNUNET_PACKED;
#elif __BYTE_ORDER == __BIG_ENDIAN
  unsigned int version : 4 GNUNET_PACKED;
  unsigned int header_length : 4 GNUNET_PACKED;
#else
#error byteorder undefined
#endif
  uint8_t diff_serv;
 
  uint16_t total_length GNUNET_PACKED;
 
  uint16_t identification GNUNET_PACKED;
 
  unsigned int flags : 3 GNUNET_PACKED;
 
  unsigned int fragmentation_offset : 13 GNUNET_PACKED;
 
  uint8_t ttl;
 
  uint8_t protocol;
 
  uint16_t checksum GNUNET_PACKED;
 
  struct in_addr source_address;
 
  struct in_addr destination_address;
} GNUNET_GCC_STRUCT_LAYOUT;
 
 
struct GNUNET_TUN_IPv6Header
{
#if __BYTE_ORDER == __LITTLE_ENDIAN
  unsigned int traffic_class_h : 4 GNUNET_PACKED;
  unsigned int version : 4 GNUNET_PACKED;
  unsigned int traffic_class_l : 4 GNUNET_PACKED;
  unsigned int flow_label : 20 GNUNET_PACKED;
#elif __BYTE_ORDER == __BIG_ENDIAN
  unsigned int version : 4 GNUNET_PACKED;
  unsigned int traffic_class : 8 GNUNET_PACKED;
  unsigned int flow_label : 20 GNUNET_PACKED;
#else
#error byteorder undefined
#endif
  uint16_t payload_length GNUNET_PACKED;
 
  uint8_t next_header;
 
  uint8_t hop_limit;
 
  struct in6_addr source_address GNUNET_PACKED;
 
  struct in6_addr destination_address GNUNET_PACKED;
} GNUNET_GCC_STRUCT_LAYOUT;
 
 
#define GNUNET_TUN_TCP_FLAGS_FIN 1
#define GNUNET_TUN_TCP_FLAGS_SYN 2
#define GNUNET_TUN_TCP_FLAGS_RST 4
#define GNUNET_TUN_TCP_FLAGS_PSH 8
#define GNUNET_TUN_TCP_FLAGS_ACK 16
#define GNUNET_TUN_TCP_FLAGS_URG 32
#define GNUNET_TUN_TCP_FLAGS_ECE 64
#define GNUNET_TUN_TCP_FLAGS_CWR 128
 
struct GNUNET_TUN_TcpHeader
{
  uint16_t source_port GNUNET_PACKED;
 
  uint16_t destination_port GNUNET_PACKED;
 
  uint32_t seq GNUNET_PACKED;
 
  uint32_t ack GNUNET_PACKED;
#if __BYTE_ORDER == __LITTLE_ENDIAN
  unsigned int reserved : 4 GNUNET_PACKED;
  unsigned int off : 4 GNUNET_PACKED;
#elif __BYTE_ORDER == __BIG_ENDIAN
  unsigned int off : 4 GNUNET_PACKED;
  unsigned int reserved : 4 GNUNET_PACKED;
#else
#error byteorder undefined
#endif
 
  uint8_t flags;
 
  uint16_t window_size GNUNET_PACKED;
 
  uint16_t crc GNUNET_PACKED;
 
  uint16_t urgent_pointer GNUNET_PACKED;
} GNUNET_GCC_STRUCT_LAYOUT;
 
 
struct GNUNET_TUN_UdpHeader
{
  uint16_t source_port GNUNET_PACKED;
 
  uint16_t destination_port GNUNET_PACKED;
 
  uint16_t len GNUNET_PACKED;
 
  uint16_t crc GNUNET_PACKED;
};
 
 
#define GNUNET_TUN_DNS_CLASS_INTERNET 1
#define GNUNET_TUN_DNS_CLASS_CHAOS 3
#define GNUNET_TUN_DNS_CLASS_HESIOD 4
 
#define GNUNET_TUN_DNS_OPCODE_QUERY 0
#define GNUNET_TUN_DNS_OPCODE_INVERSE_QUERY 1
#define GNUNET_TUN_DNS_OPCODE_STATUS 2
 
 
#define GNUNET_TUN_DNS_RETURN_CODE_NO_ERROR 0
#define GNUNET_TUN_DNS_RETURN_CODE_FORMAT_ERROR 1
#define GNUNET_TUN_DNS_RETURN_CODE_SERVER_FAILURE 2
#define GNUNET_TUN_DNS_RETURN_CODE_NAME_ERROR 3
#define GNUNET_TUN_DNS_RETURN_CODE_NOT_IMPLEMENTED 4
#define GNUNET_TUN_DNS_RETURN_CODE_REFUSED 5
 
#define GNUNET_TUN_DNS_RETURN_CODE_YXDOMAIN 6
#define GNUNET_TUN_DNS_RETURN_CODE_YXRRSET 7
#define GNUNET_TUN_DNS_RETURN_CODE_NXRRSET 8
#define GNUNET_TUN_DNS_RETURN_CODE_NOT_AUTH 9
#define GNUNET_TUN_DNS_RETURN_CODE_NOT_ZONE 10
 
 
struct GNUNET_TUN_DnsFlags
{
#if __BYTE_ORDER == __LITTLE_ENDIAN
  unsigned int recursion_desired : 1 GNUNET_PACKED;
 
  unsigned int message_truncated : 1 GNUNET_PACKED;
 
  unsigned int authoritative_answer : 1 GNUNET_PACKED;
 
  unsigned int opcode : 4 GNUNET_PACKED;
 
  unsigned int query_or_response : 1 GNUNET_PACKED;
 
  unsigned int return_code : 4 GNUNET_PACKED;
 
  unsigned int checking_disabled : 1 GNUNET_PACKED;
 
  unsigned int authenticated_data : 1 GNUNET_PACKED;
 
  unsigned int zero : 1 GNUNET_PACKED;
 
  unsigned int recursion_available : 1 GNUNET_PACKED;
#elif __BYTE_ORDER == __BIG_ENDIAN
  unsigned int query_or_response : 1 GNUNET_PACKED;
 
  unsigned int opcode : 4 GNUNET_PACKED;
 
  unsigned int authoritative_answer : 1 GNUNET_PACKED;
 
  unsigned int message_truncated : 1 GNUNET_PACKED;
 
  unsigned int recursion_desired : 1 GNUNET_PACKED;
 
 
  unsigned int recursion_available : 1 GNUNET_PACKED;
 
  unsigned int zero : 1 GNUNET_PACKED;
 
  unsigned int authenticated_data : 1 GNUNET_PACKED;
 
  unsigned int checking_disabled : 1 GNUNET_PACKED;
 
  unsigned int return_code : 4 GNUNET_PACKED;
#else
#error byteorder undefined
#endif
} GNUNET_GCC_STRUCT_LAYOUT;
 
 
struct GNUNET_TUN_DnsHeader
{
  uint16_t id GNUNET_PACKED;
 
  struct GNUNET_TUN_DnsFlags flags;
 
  uint16_t query_count GNUNET_PACKED;
 
  uint16_t answer_rcount GNUNET_PACKED;
 
  uint16_t authority_rcount GNUNET_PACKED;
 
  uint16_t additional_rcount GNUNET_PACKED;
};
 
 
struct GNUNET_TUN_DnsSoaRecord
{
  uint32_t serial GNUNET_PACKED;
 
  uint32_t refresh GNUNET_PACKED;
 
  uint32_t retry GNUNET_PACKED;
 
  uint32_t expire GNUNET_PACKED;
 
  uint32_t minimum GNUNET_PACKED;
};
 
 
struct GNUNET_TUN_DnsSrvRecord
{
  uint16_t prio GNUNET_PACKED;
 
  uint16_t weight GNUNET_PACKED;
 
  uint16_t port GNUNET_PACKED;
 
  /* followed by 'target' name */
};
 
 
struct GNUNET_TUN_DnsUriRecord
{
  uint16_t prio GNUNET_PACKED;
 
  uint16_t weight GNUNET_PACKED;
 
  /* followed by 'target' name */
};
 
 
struct GNUNET_TUN_DnsCertRecord
{
  uint16_t cert_type;
 
  uint16_t cert_tag;
 
  uint8_t algorithm;
 
  /* Followed by the certificate */
};
 
 
struct GNUNET_TUN_DnsTlsaRecord
{
  uint8_t usage;
 
  uint8_t selector;
 
  uint8_t matching_type;
 
};
 
 
struct GNUNET_TUN_GnsVpnRecord
{
  struct GNUNET_PeerIdentity peer;
 
  uint16_t proto;
 
  /* followed by the servicename */
};
 
 
struct GNUNET_TUN_DnsQueryLine
{
  uint16_t type GNUNET_PACKED;
 
  uint16_t dns_traffic_class GNUNET_PACKED;
};
 
 
struct GNUNET_TUN_DnsRecordLine
{
  uint16_t type GNUNET_PACKED;
 
  uint16_t dns_traffic_class GNUNET_PACKED;
 
  uint32_t ttl GNUNET_PACKED;
 
  uint16_t data_len GNUNET_PACKED;
};
 
 
#define GNUNET_TUN_ICMPTYPE_ECHO_REPLY 0
#define GNUNET_TUN_ICMPTYPE_DESTINATION_UNREACHABLE 3
#define GNUNET_TUN_ICMPTYPE_SOURCE_QUENCH 4
#define GNUNET_TUN_ICMPTYPE_REDIRECT_MESSAGE 5
#define GNUNET_TUN_ICMPTYPE_ECHO_REQUEST 8
#define GNUNET_TUN_ICMPTYPE_ROUTER_ADVERTISEMENT 9
#define GNUNET_TUN_ICMPTYPE_ROUTER_SOLICITATION 10
#define GNUNET_TUN_ICMPTYPE_TIME_EXCEEDED 11
 
#define GNUNET_TUN_ICMPTYPE6_DESTINATION_UNREACHABLE 1
#define GNUNET_TUN_ICMPTYPE6_PACKET_TOO_BIG 2
#define GNUNET_TUN_ICMPTYPE6_TIME_EXCEEDED 3
#define GNUNET_TUN_ICMPTYPE6_PARAMETER_PROBLEM 4
#define GNUNET_TUN_ICMPTYPE6_ECHO_REQUEST 128
#define GNUNET_TUN_ICMPTYPE6_ECHO_REPLY 129
 
 
struct GNUNET_TUN_IcmpHeader
{
  uint8_t type;
  uint8_t code;
  uint16_t crc GNUNET_PACKED;
 
  union
  {
    struct
    {
      uint16_t identifier GNUNET_PACKED;
      uint16_t sequence_number GNUNET_PACKED;
    } echo;
 
    struct ih_pmtu
    {
      uint16_t empty GNUNET_PACKED;
      uint16_t next_hop_mtu GNUNET_PACKED;
      /* followed by original IP header + first 8 bytes of original IP datagram
       */
    } destination_unreachable;
 
    struct in_addr redirect_gateway_address;
 
    uint32_t packet_too_big_mtu GNUNET_PACKED;
  } quench;
};
 
 
GNUNET_NETWORK_STRUCT_END
 
 
void
GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip,
                                   uint8_t protocol,
                                   uint16_t payload_length,
                                   const struct in_addr *src,
                                   const struct in_addr *dst);
 
 
void
GNUNET_TUN_initialize_ipv6_header (struct GNUNET_TUN_IPv6Header *ip,
                                   uint8_t protocol,
                                   uint16_t payload_length,
                                   const struct in6_addr *src,
                                   const struct in6_addr *dst);
 
void
GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
                                    struct GNUNET_TUN_TcpHeader *tcp,
                                    const void *payload,
                                    uint16_t payload_length);
 
void
GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
                                    struct GNUNET_TUN_TcpHeader *tcp,
                                    const void *payload,
                                    uint16_t payload_length);
 
void
GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
                                    struct GNUNET_TUN_UdpHeader *udp,
                                    const void *payload,
                                    uint16_t payload_length);
 
 
void
GNUNET_TUN_calculate_udp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
                                    struct GNUNET_TUN_UdpHeader *udp,
                                    const void *payload,
                                    uint16_t payload_length);
 
 
void
GNUNET_TUN_calculate_icmp_checksum (struct GNUNET_TUN_IcmpHeader *icmp,
                                    const void *payload,
                                    uint16_t payload_length);
 
 
void
GNUNET_TUN_service_name_to_hash (const char *service_name,
                                 struct GNUNET_HashCode *hc);
 
 
int
GNUNET_TUN_sockaddr_cmp (const struct sockaddr *sa,
                         const struct sockaddr *sb,
                         int include_port);
 
 
void
GNUNET_TUN_compute_service_cadet_port (const struct GNUNET_HashCode *desc,
                                       uint16_t ip_port,
                                       struct GNUNET_HashCode *cadet_port);
 
#endif
 /* end of group */
 /* end of group addition */