/* * util/net_help.h - network help functions * * Copyright (c) 2007, NLnet Labs. All rights reserved. * * This software is open source. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * Neither the name of the NLNET LABS nor the names of its contributors may * be used to endorse or promote products derived from this software without * specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ /** * \file * * This file contains functions to perform network related tasks. */ #ifndef NET_HELP_H #define NET_HELP_H #include "util/log.h" /** DNS constants for uint16_t style flag manipulation. host byteorder. */ /** AA flag */ #define BIT_AA 0x0400 /** RD flag */ #define BIT_RD 0x0100 /** RA flag */ #define BIT_RA 0x0080 /** CD flag */ #define BIT_CD 0x0010 /** QR flag */ #define BIT_QR 0x8000 /** get RCODE bits from uint16 flags */ #define FLAGS_GET_RCODE(f) ((f) & 0xf) /** timeout in seconds for UDP queries to auth servers. */ #define UDP_QUERY_TIMEOUT 4 /** timeout in seconds for TCP queries to auth servers. */ #define TCP_QUERY_TIMEOUT 30 /** Advertised version of EDNS capabilities */ #define EDNS_ADVERTISED_VERSION 0 /** Advertised size of EDNS capabilities */ #define EDNS_ADVERTISED_SIZE 4096 /** bits for EDNS bitfield */ #define EDNS_DO 0x8000 /* Dnssec Ok */ /** byte size of ip4 address */ #define INET_SIZE 4 /** byte size of ip6 address */ #define INET6_SIZE 16 /** * See if string is ip4 or ip6. * @param str: IP specification. * @return: true if string addr is an ip6 specced address. */ int str_is_ip6(const char* str); /** * Write (blocking) to a nonblocking socket. * @param s: fd. * @param buf: data buffer. * @param size: length of data to send. * @return: 0 on error. errno is set. */ int write_socket(int s, const void *buf, size_t size); /** * Set fd nonblocking. * @param s: file descriptor. * @return: 0 on error (error is printed to log). */ int fd_set_nonblock(int s); /** * See if number is a power of 2. * @param num: the value. * @return: true if the number is a power of 2. */ int is_pow2(size_t num); /** * Write iov vector into a buffer. * @param buffer: to write data into. * @param iov: iov vector * @param iovlen: length of iov vector */ void write_iov_buffer(ldns_buffer* buffer, struct iovec* iov, size_t iovlen); /** * Allocate memory and copy over contents. * @param data: what to copy over. * @param len: length of data. * @return: NULL on malloc failure, or newly malloced data. */ void* memdup(void* data, size_t len); /** * Prints the sockaddr in readable format with log_info. Debug helper. * @param str: descriptive string printed with it. * @param addr: the sockaddr to print. Can be ip4 or ip6. * @param addrlen: length of addr. */ void log_addr(const char* str, struct sockaddr_storage* addr, socklen_t addrlen); /** * Prints zone name and sockaddr in readable format with log_info. Debug. * @param v: at what verbosity level to print this. * @param str: descriptive string printed with it. * @param zone: DNS domain name, uncompressed wireformat. * @param addr: the sockaddr to print. Can be ip4 or ip6. * @param addrlen: length of addr. */ void log_name_addr(enum verbosity_value v, const char* str, uint8_t* zone, struct sockaddr_storage* addr, socklen_t addrlen); /** * Convert address string, with "@port" appendix, to sockaddr. * Uses DNS port by default. * @param str: the string * @param addr: where to store sockaddr. * @param addrlen: length of stored sockaddr is returned. * @return 0 on error. */ int extstrtoaddr(const char* str, struct sockaddr_storage* addr, socklen_t* addrlen); /** * Convert ip address string and port to sockaddr. * @param ip: ip4 or ip6 address string. * @param port: port number, host format. * @param addr: where to store sockaddr. * @param addrlen: length of stored sockaddr is returned. * @return 0 on error. */ int ipstrtoaddr(const char* ip, int port, struct sockaddr_storage* addr, socklen_t* addrlen); /** * Print string with neat domain name, type and class. * @param v: at what verbosity level to print this. * @param str: string of message. * @param name: domain name uncompressed wireformat. * @param type: host format RR type. * @param dclass: host format RR class. */ void log_nametypeclass(enum verbosity_value v, const char* str, uint8_t* name, uint16_t type, uint16_t dclass); /** * Compare two sockaddrs. Imposes an ordering on the addresses. * @param addr1: address 1. * @param len1: lengths of addr1. * @param addr2: address 2. * @param len2: lengths of addr2. * @return: 0 if addr1 == addr2. -1 if addr1 is smaller, +1 if larger. */ int sockaddr_cmp(struct sockaddr_storage* addr1, socklen_t len1, struct sockaddr_storage* addr2, socklen_t len2); /** * Checkout address family. * @param addr: the sockaddr to examine. * return: true if sockaddr is ip6. */ int addr_is_ip6(struct sockaddr_storage* addr); #endif /* NET_HELP_H */