/* network.h
*
* Datatypes, functions and includes for the core networking.
*
* Copyright (C) 2013 Tox project All Rights Reserved.
*
* This file is part of Tox.
*
* Tox is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Tox 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Tox. If not, see .
*
*/
#ifndef NETWORK_H
#define NETWORK_H
#include
#include
#include
#include
#include
#ifdef WIN32 /* Put win32 includes here */
#ifndef WINVER
//Windows XP
#define WINVER 0x0501
#endif
#include
#include
#include
typedef unsigned int sock_t;
#else // Linux includes
#include
#include
#include
#include
#include
#include
#include
#include
#include
typedef int sock_t;
#endif
#ifndef VANILLA_NACL
/* We use libsodium by default. */
#include
#else
#include
#define crypto_box_MACBYTES (crypto_box_ZEROBYTES - crypto_box_BOXZEROBYTES)
#endif
#define MAX_UDP_PACKET_SIZE 65507
#define NET_PACKET_PING_REQUEST 0 /* Ping request packet ID. */
#define NET_PACKET_PING_RESPONSE 1 /* Ping response packet ID. */
#define NET_PACKET_GET_NODES 2 /* Get nodes request packet ID. */
#define NET_PACKET_SEND_NODES 3 /* Send nodes response packet ID for IPv4 addresses. */
#define NET_PACKET_SEND_NODES_EX 4 /* Send nodes response packet ID for other addresses. */
#define NET_PACKET_HANDSHAKE 16 /* Handshake packet ID. */
#define NET_PACKET_SYNC 17 /* SYNC packet ID. */
#define NET_PACKET_DATA 18 /* Data packet ID. */
#define NET_PACKET_CRYPTO 32 /* Encrypted data packet ID. */
#define NET_PACKET_LAN_DISCOVERY 33 /* LAN discovery packet ID. */
/* Current time, unix format */
#define unix_time() ((uint64_t)time(NULL))
typedef union {
uint8_t uint8[4];
uint16_t uint16[2];
uint32_t uint32;
struct in_addr in_addr;
} IP4;
typedef struct in6_addr IP6;
typedef struct {
sa_family_t family;
union {
IP4 ip4;
IP6 ip6;
};
} IPAny;
typedef union {
struct {
IP4 ip;
uint16_t port;
/* Not used for anything right now. */
uint16_t padding;
};
uint8_t uint8[8];
} IP4_Port;
/* will replace IP_Port as soon as the complete infrastructure is in place
* removed the unused union and padding also */
typedef struct {
IPAny ip;
uint16_t port;
} IPAny_Port;
#undef TOX_ENABLE_IPV6
/* #define TOX_ENABLE_IPV6 */
#ifdef TOX_ENABLE_IPV6
#define TOX_ENABLE_IPV6_DEFAULT 1
typedef IPAny IP;
typedef IPAny_Port IP_Port;
#else
#define TOX_ENABLE_IPV6_DEFAULT 0
typedef IP4 IP;
typedef IP4_Port IP_Port;
#endif
/* ip_ntoa
* converts ip into a string
* uses a static buffer, so mustn't used multiple times in the same output
*/
const char *ip_ntoa(IP *ip);
/* ip_equal
* compares two IPAny structures
* unset means unequal
*
* returns 0 when not equal or when uninitialized
*/
int ip_equal(IP *a, IP *b);
/* ipport_equal
* compares two IPAny_Port structures
* unset means unequal
*
* returns 0 when not equal or when uninitialized
*/
int ipport_equal(IP_Port *a, IP_Port *b);
/* nulls out ip */
void ip_reset(IP *ip);
/* nulls out ip, sets family according to flag */
void ip_init(IP *ip, uint8_t ipv6enabled);
/* checks if ip is valid */
int ip_isset(IP *ip);
/* checks if ip is valid */
int ipport_isset(IP_Port *ipport);
/* copies an ip structure */
void ip_copy(IP *target, IP *source);
/* copies an ip_port structure */
void ipport_copy(IP_Port *target, IP_Port *source);
/*
* addr_resolve():
* uses getaddrinfo to resolve an address into an IP address
* uses the first IPv4/IPv6 addresses returned by getaddrinfo
*
* input
* address: a hostname (or something parseable to an IP address)
* ip: ip.family MUST be initialized, either set to a specific IP version
* (AF_INET/AF_INET6) or to the unspecified AF_UNSPEC (= 0), if both
* IP versions are acceptable
*
* returns in ip a valid IPAny (v4/v6),
* prefers v6 if ip.family was AF_UNSPEC and both available
* returns 0 on failure
*/
int addr_resolve(const char *address, IP *to);
/*
* addr_resolve_or_parse_ip
* resolves string into an IP address
*
* to->family MUST be set (AF_UNSPEC, AF_INET, AF_INET6)
* returns 1 on success, 0 on failure
*/
int addr_resolve_or_parse_ip(const char *address, IP *to);
/* Function to receive data, ip and port of sender is put into ip_port.
* Packet data is put into data.
* Packet length is put into length.
*/
typedef int (*packet_handler_callback)(void *object, IP_Port ip_port, uint8_t *data, uint32_t len);
typedef struct {
packet_handler_callback function;
void *object;
} Packet_Handles;
typedef struct {
Packet_Handles packethandlers[256];
/* Our UDP socket. */
sa_family_t family;
uint16_t port;
sock_t sock;
} Networking_Core;
/* return current time in milleseconds since the epoch. */
uint64_t current_time(void);
/* return a random number.
* NOTE: this function should probably not be used where cryptographic randomness is absolutely necessary.
*/
uint32_t random_int(void);
/* Basic network functions: */
/* Function to send packet(data) of length length to ip_port. */
int sendpacket(Networking_Core *net, IP_Port ip_port, uint8_t *data, uint32_t length);
/* Function to call when packet beginning with byte is received. */
void networking_registerhandler(Networking_Core *net, uint8_t byte, packet_handler_callback cb, void *object);
/* Call this several times a second. */
void networking_poll(Networking_Core *net);
/* Initialize networking.
* bind to ip and port.
* ip must be in network order EX: 127.0.0.1 = (7F000001).
* port is in host byte order (this means don't worry about it).
*
* return 0 if no problems.
* return -1 if there were problems.
*/
Networking_Core *new_networking(IP ip, uint16_t port);
/* Function to cleanup networking stuff (doesn't do much right now). */
void kill_networking(Networking_Core *net);
#endif