netsock2.c File Reference

Network socket handling. More...

#include "asterisk.h"
#include "asterisk/config.h"
#include "asterisk/netsock2.h"
#include "asterisk/utils.h"
#include "asterisk/threadstorage.h"

Include dependency graph for netsock2.c:

Go to the source code of this file.

Functions
static void	__init_ast_sockaddr_stringify_buf (void)
void	_ast_sockaddr_from_sin (struct ast_sockaddr *addr, const struct sockaddr_in *sin, const char *file, int line, const char *func)
uint16_t	_ast_sockaddr_port (const struct ast_sockaddr *addr, const char *file, int line, const char *func)
void	_ast_sockaddr_set_port (struct ast_sockaddr *addr, uint16_t port, const char *file, int line, const char *func)
int	_ast_sockaddr_to_sin (const struct ast_sockaddr *addr, struct sockaddr_in *sin, const char *file, int line, const char *func)
int	ast_accept (int sockfd, struct ast_sockaddr *addr)
	Wrapper around accept(2) that uses struct ast_sockaddr.
int	ast_bind (int sockfd, const struct ast_sockaddr *addr)
	Wrapper around bind(2) that uses struct ast_sockaddr.
int	ast_connect (int sockfd, const struct ast_sockaddr *addr)
	Wrapper around connect(2) that uses struct ast_sockaddr.
int	ast_getsockname (int sockfd, struct ast_sockaddr *addr)
	Wrapper around getsockname(2) that uses struct ast_sockaddr.
ssize_t	ast_recvfrom (int sockfd, void *buf, size_t len, int flags, struct ast_sockaddr *src_addr)
	Wrapper around recvfrom(2) that uses struct ast_sockaddr.
ssize_t	ast_sendto (int sockfd, const void *buf, size_t len, int flags, const struct ast_sockaddr *dest_addr)
	Wrapper around sendto(2) that uses ast_sockaddr.
int	ast_set_qos (int sockfd, int tos, int cos, const char *desc)
	Set type of service.
int	ast_sockaddr_cmp (const struct ast_sockaddr *a, const struct ast_sockaddr *b)
	Compares two ast_sockaddr structures.
int	ast_sockaddr_cmp_addr (const struct ast_sockaddr *a, const struct ast_sockaddr *b)
	Compares the addresses of two ast_sockaddr structures.
int	ast_sockaddr_hash (const struct ast_sockaddr *addr)
	Computes a hash value from the address. The port is ignored.
uint32_t	ast_sockaddr_ipv4 (const struct ast_sockaddr *addr)
	Get an IPv4 address of an ast_sockaddr.
int	ast_sockaddr_ipv4_mapped (const struct ast_sockaddr *addr, struct ast_sockaddr *ast_mapped)
	Convert an IPv4-mapped IPv6 address into an IPv4 address.
int	ast_sockaddr_is_any (const struct ast_sockaddr *addr)
	Determine if the address type is unspecified, or "any" address.
int	ast_sockaddr_is_ipv4 (const struct ast_sockaddr *addr)
	Determine if the address is an IPv4 address.
int	ast_sockaddr_is_ipv4_mapped (const struct ast_sockaddr *addr)
	Determine if this is an IPv4-mapped IPv6 address.
int	ast_sockaddr_is_ipv6 (const struct ast_sockaddr *addr)
	Determine if this is an IPv6 address.
int	ast_sockaddr_is_ipv6_link_local (const struct ast_sockaddr *addr)
	Determine if this is a link-local IPv6 address.
int	ast_sockaddr_parse (struct ast_sockaddr *addr, const char *str, int flags)
	Parse an IPv4 or IPv6 address string.
int	ast_sockaddr_resolve (struct ast_sockaddr **addrs, const char *str, int flags, int family)
	Parses a string with an IPv4 or IPv6 address and place results into an array.
int	ast_sockaddr_split_hostport (char *str, char **host, char **port, int flags)
	Splits a string into its host and port components.
char *	ast_sockaddr_stringify_fmt (const struct ast_sockaddr *sa, int format)
	Convert a socket address to a string.
Variables
static struct ast_threadstorage	ast_sockaddr_stringify_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_ast_sockaddr_stringify_buf , .custom_init = NULL , }

---

Detailed Description

Network socket handling.

Author:

Viagénie <asteriskv6@viagenie.ca>

Definition in file netsock2.c.

---

Function Documentation

static void __init_ast_sockaddr_stringify_buf

(

void

)

[static]

Definition at line 61 of file netsock2.c.

{

void _ast_sockaddr_from_sin	(	struct ast_sockaddr *	addr,
		const struct sockaddr_in *	sin,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 551 of file netsock2.c.

References __LOG_DEBUG, ast_log(), ast_sockaddr::len, option_debug, and ast_sockaddr::ss.

{
   memcpy(&addr->ss, sin, sizeof(*sin));

   if (addr->ss.ss_family != AF_INET && option_debug >= 1) {
      ast_log(__LOG_DEBUG, file, line, func, "Address family is not AF_INET\n");
   }

   addr->len = sizeof(*sin);
}

uint16_t _ast_sockaddr_port	(	const struct ast_sockaddr *	addr,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 355 of file netsock2.c.

References __LOG_DEBUG, ast_log(), ast_sockaddr::len, option_debug, and ast_sockaddr::ss.

{
   if (addr->ss.ss_family == AF_INET &&
       addr->len == sizeof(struct sockaddr_in)) {
      return ntohs(((struct sockaddr_in *)&addr->ss)->sin_port);
   } else if (addr->ss.ss_family == AF_INET6 &&
       addr->len == sizeof(struct sockaddr_in6)) {
      return ntohs(((struct sockaddr_in6 *)&addr->ss)->sin6_port);
   }
   if (option_debug >= 1) {
      ast_log(__LOG_DEBUG, file, line, func, "Not an IPv4 nor IPv6 address, cannot get port.\n");
   }
   return 0;
}

void _ast_sockaddr_set_port	(	struct ast_sockaddr *	addr,
		uint16_t	port,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 370 of file netsock2.c.

References __LOG_DEBUG, ast_log(), ast_sockaddr::len, option_debug, and ast_sockaddr::ss.

{
   if (addr->ss.ss_family == AF_INET &&
       addr->len == sizeof(struct sockaddr_in)) {
      ((struct sockaddr_in *)&addr->ss)->sin_port = htons(port);
   } else if (addr->ss.ss_family == AF_INET6 &&
       addr->len == sizeof(struct sockaddr_in6)) {
      ((struct sockaddr_in6 *)&addr->ss)->sin6_port = htons(port);
   } else if (option_debug >= 1) {
      ast_log(__LOG_DEBUG, file, line, func,
         "Not an IPv4 nor IPv6 address, cannot set port.\n");
   }
}

int _ast_sockaddr_to_sin	(	const struct ast_sockaddr *	addr,
		struct sockaddr_in *	sin,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 530 of file netsock2.c.

References __LOG_DEBUG, __LOG_ERROR, ast_log(), ast_sockaddr_isnull(), ast_sockaddr::len, option_debug, and ast_sockaddr::ss.

{
   if (ast_sockaddr_isnull(addr)) {
      memset(sin, 0, sizeof(*sin));
      return 1;
   }

   if (addr->len != sizeof(*sin)) {
      ast_log(__LOG_ERROR, file, line, func, "Bad address cast to IPv4\n");
      return 0;
   }

   if (addr->ss.ss_family != AF_INET && option_debug >= 1) {
      ast_log(__LOG_DEBUG, file, line, func, "Address family is not AF_INET\n");
   }

   *sin = *(struct sockaddr_in *)&addr->ss;
   return 1;
}

int ast_accept	(	int	sockfd,
		struct ast_sockaddr *	addr
	)

Wrapper around accept(2) that uses struct ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for accept(2).

Definition at line 446 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by ast_tcptls_server_root().

{
   addr->len = sizeof(addr->ss);
   return accept(sockfd, (struct sockaddr *)&addr->ss, &addr->len);
}

int ast_bind	(	int	sockfd,
		const struct ast_sockaddr *	addr
	)

Wrapper around bind(2) that uses struct ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for bind(2).

Definition at line 452 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by ast_rtp_new(), ast_rtp_prop_set(), ast_tcptls_client_create(), ast_tcptls_server_start(), ast_udptl_new_with_bindaddr(), and reload_config().

{
   return bind(sockfd, (const struct sockaddr *)&addr->ss, addr->len);
}

int ast_connect	(	int	sockfd,
		const struct ast_sockaddr *	addr
	)

Wrapper around connect(2) that uses struct ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for connect(2).

Definition at line 457 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by ast_ouraddrfor(), ast_tcptls_client_start(), gtalk_update_externip(), and stun_monitor_request().

{
   return connect(sockfd, (const struct sockaddr *)&addr->ss, addr->len);
}

int ast_getsockname	(	int	sockfd,
		struct ast_sockaddr *	addr
	)

Wrapper around getsockname(2) that uses struct ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for getsockname(2).

Definition at line 462 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by ast_ouraddrfor(), and ast_set_qos().

{
   addr->len = sizeof(addr->ss);
   return getsockname(sockfd, (struct sockaddr *)&addr->ss, &addr->len);
}

ssize_t ast_recvfrom	(	int	sockfd,
		void *	buf,
		size_t	len,
		int	flags,
		struct ast_sockaddr *	src_addr
	)

Wrapper around recvfrom(2) that uses struct ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for recvfrom(2).

Definition at line 468 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by __rtp_recvfrom(), ast_udptl_read(), and sipsock_read().

{
   src_addr->len = sizeof(src_addr->ss);
   return recvfrom(sockfd, buf, len, flags,
         (struct sockaddr *)&src_addr->ss, &src_addr->len);
}

ssize_t ast_sendto	(	int	sockfd,
		const void *	buf,
		size_t	len,
		int	flags,
		const struct ast_sockaddr *	dest_addr
	)

Wrapper around sendto(2) that uses ast_sockaddr.

Since:

1.8

For parameter and return information, see the man page for sendto(2)

Definition at line 476 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by __rtp_sendto(), __sip_xmit(), ast_udptl_write(), multicast_rtp_write(), and multicast_send_control_packet().

{
   return sendto(sockfd, buf, len, flags,
            (const struct sockaddr *)&dest_addr->ss, dest_addr->len);
}

int ast_set_qos	(	int	sockfd,
		int	tos,
		int	cos,
		const char *	desc
	)

Set type of service.

Since:

1.8

Set ToS ("Type of Service for IPv4 and "Traffic Class for IPv6) and CoS (Linux's SO_PRIORITY)

Parameters:

sockfd	File descriptor for socket on which to set the parameters
tos	The type of service for the socket
cos	The cost of service for the socket
desc	A text description of the socket in question.

Return values:

0	Success
-1	Error, with errno set to an appropriate value

Definition at line 483 of file netsock2.c.

References ast_getsockname(), ast_log(), ast_sockaddr_is_any(), ast_sockaddr_is_ipv6(), ast_verb, errno, and LOG_WARNING.

Referenced by ast_rtp_qos_set(), and reload_config().

{
   int res = 0;
   int set_tos;
   int set_tclass;
   struct ast_sockaddr addr;

   /* If the sock address is IPv6, the TCLASS field must be set. */
   set_tclass = !ast_getsockname(sockfd, &addr) && ast_sockaddr_is_ipv6(&addr) ? 1 : 0;

   /* If the the sock address is IPv4 or (IPv6 set to any address [::]) set TOS bits */
   set_tos = (!set_tclass || (set_tclass && ast_sockaddr_is_any(&addr))) ? 1 : 0;

   if (set_tos) {
      if ((res = setsockopt(sockfd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)))) {
         ast_log(LOG_WARNING, "Unable to set %s DSCP TOS value to %d (may be you have no "
            "root privileges): %s\n", desc, tos, strerror(errno));
      } else if (tos) {
         ast_verb(2, "Using %s TOS bits %d\n", desc, tos);
      }
   }

#if defined(IPV6_TCLASS) && defined(IPPROTO_IPV6)
   if (set_tclass) {
      if (!ast_getsockname(sockfd, &addr) && ast_sockaddr_is_ipv6(&addr)) {
         if ((res = setsockopt(sockfd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof(tos)))) {
            ast_log(LOG_WARNING, "Unable to set %s DSCP TCLASS field to %d (may be you have no "
               "root privileges): %s\n", desc, tos, strerror(errno));
         } else if (tos) {
            ast_verb(2, "Using %s TOS bits %d in TCLASS field.\n", desc, tos);
         }
      }
   }
#endif

#ifdef linux
   if (setsockopt(sockfd, SOL_SOCKET, SO_PRIORITY, &cos, sizeof(cos))) {
      ast_log(LOG_WARNING, "Unable to set %s CoS to %d: %s\n", desc, cos,
         strerror(errno));
   } else if (cos) {
      ast_verb(2, "Using %s CoS mark %d\n", desc, cos);
   }
#endif

   return res;
}

int ast_sockaddr_cmp	(	const struct ast_sockaddr *	a,
		const struct ast_sockaddr *	b
	)

Compares two ast_sockaddr structures.

Since:

1.8

Return values:

-1	a is lexicographically smaller than b
0	a is equal to b
1	b is lexicographically smaller than a

Definition at line 290 of file netsock2.c.

References ast_sockaddr_ipv4_mapped(), ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by add_sdp(), ast_rtcp_read(), ast_rtp_instance_get_and_cmp_local_address(), ast_rtp_instance_get_and_cmp_remote_address(), ast_rtp_read(), ast_tcptls_client_create(), ast_tcptls_server_start(), ast_udptl_bridge(), ast_udptl_read(), dnsmgr_refresh(), parse_register_contact(), realtime_peer_by_name(), reload_config(), remote_bridge_loop(), rtcp_debug_test_addr(), rtp_debug_test_addr(), sip_debug_test_addr(), threadinfo_locate_cb(), udptl_debug_test_addr(), and update_registry().

{
   const struct ast_sockaddr *a_tmp, *b_tmp;
   struct ast_sockaddr ipv4_mapped;

   a_tmp = a;
   b_tmp = b;

   if (a_tmp->len != b_tmp->len) {
      if (ast_sockaddr_ipv4_mapped(a, &ipv4_mapped)) {
         a_tmp = &ipv4_mapped;
      } else if (ast_sockaddr_ipv4_mapped(b, &ipv4_mapped)) {
         b_tmp = &ipv4_mapped;
      }
   }

   if (a_tmp->len < b_tmp->len) {
      return -1;
   } else if (a_tmp->len > b_tmp->len) {
      return 1;
   }

   return memcmp(&a_tmp->ss, &b_tmp->ss, a_tmp->len);
}

int ast_sockaddr_cmp_addr	(	const struct ast_sockaddr *	a,
		const struct ast_sockaddr *	b
	)

Compares the addresses of two ast_sockaddr structures.

Since:

1.8

Return values:

-1	a is lexicographically smaller than b
0	a is equal to b
1	b is lexicographically smaller than a

Definition at line 315 of file netsock2.c.

References ast_sockaddr_ipv4_mapped(), ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by addr_range_cmp_cb(), ast_apply_ha(), get_our_media_address(), peer_ipcmp_cb(), rtcp_debug_test_addr(), rtp_debug_test_addr(), sip_debug_test_addr(), and udptl_debug_test_addr().

{
   const struct ast_sockaddr *a_tmp, *b_tmp;
   struct ast_sockaddr ipv4_mapped;
   const struct in_addr *ip4a, *ip4b;
   const struct in6_addr *ip6a, *ip6b;
   int ret = -1;

   a_tmp = a;
   b_tmp = b;

   if (a_tmp->len != b_tmp->len) {
      if (ast_sockaddr_ipv4_mapped(a, &ipv4_mapped)) {
         a_tmp = &ipv4_mapped;
      } else if (ast_sockaddr_ipv4_mapped(b, &ipv4_mapped)) {
         b_tmp = &ipv4_mapped;
      }
   }

   if (a->len < b->len) {
      ret = -1;
   } else if (a->len > b->len) {
      ret = 1;
   }

   switch (a_tmp->ss.ss_family) {
   case AF_INET:
      ip4a = &((const struct sockaddr_in*)&a_tmp->ss)->sin_addr;
      ip4b = &((const struct sockaddr_in*)&b_tmp->ss)->sin_addr;
      ret = memcmp(ip4a, ip4b, sizeof(*ip4a));
      break;
   case AF_INET6:
      ip6a = &((const struct sockaddr_in6*)&a_tmp->ss)->sin6_addr;
      ip6b = &((const struct sockaddr_in6*)&b_tmp->ss)->sin6_addr;
      ret = memcmp(ip6a, ip6b, sizeof(*ip6a));
      break;
   }
   return ret;
}

int ast_sockaddr_hash

(

const struct ast_sockaddr *

addr

)

Computes a hash value from the address. The port is ignored.

Since:

1.8

Return values:

0	Unknown address family
other	A 32-bit hash derived from the address

Definition at line 428 of file netsock2.c.

References ast_log(), LOG_ERROR, and ast_sockaddr::ss.

Referenced by peer_iphash_cb(), and threadt_hash_cb().

{
   /*
    * For IPv4, return the IP address as-is. For IPv6, return the last 32
    * bits.
    */
   switch (addr->ss.ss_family) {
   case AF_INET:
      return ((const struct sockaddr_in *)&addr->ss)->sin_addr.s_addr;
   case AF_INET6:
      return ((uint32_t *)&((const struct sockaddr_in6 *)&addr->ss)->sin6_addr)[3];
   default:
      ast_log(LOG_ERROR, "Unknown address family '%d'.\n",
         addr->ss.ss_family);
      return 0;
   }
}

uint32_t ast_sockaddr_ipv4

(

const struct ast_sockaddr *

addr

)

Get an IPv4 address of an ast_sockaddr.

Since:

1.8

Warning:

You should rarely need this function. Only use if you know what you're doing.

Returns:

IPv4 address in network byte order

Definition at line 384 of file netsock2.c.

References ast_sockaddr::ss.

Referenced by addr_is_multicast(), iax2_devicestate(), iax2_do_register(), iax2_poke_peer(), jingle_create_candidates(), load_module(), and multicast_send_control_packet().

{
   const struct sockaddr_in *sin = (struct sockaddr_in *)&addr->ss;
   return ntohl(sin->sin_addr.s_addr);
}

int ast_sockaddr_ipv4_mapped	(	const struct ast_sockaddr *	addr,
		struct ast_sockaddr *	ast_mapped
	)

Convert an IPv4-mapped IPv6 address into an IPv4 address.

Warning:

You should rarely need this function. Only call this if you know what you're doing.

Parameters:

addr	The IPv4-mapped address to convert
mapped_addr	The resulting IPv4 address

Return values:

0	Unable to make the conversion
1	Successful conversion

Definition at line 35 of file netsock2.c.

References ast_sockaddr_from_sin, ast_sockaddr_is_ipv4_mapped(), ast_sockaddr_is_ipv6(), and ast_sockaddr::ss.

Referenced by ast_append_ha(), ast_apply_ha(), ast_rtp_read(), ast_sockaddr_cmp(), ast_sockaddr_cmp_addr(), and ast_sockaddr_stringify_fmt().

{
   const struct sockaddr_in6 *sin6;
   struct sockaddr_in sin4;

   if (!ast_sockaddr_is_ipv6(addr)) {
      return 0;
   }

   if (!ast_sockaddr_is_ipv4_mapped(addr)) {
      return 0;
   }

   sin6 = (const struct sockaddr_in6*)&addr->ss;

   memset(&sin4, 0, sizeof(sin4));
   sin4.sin_family = AF_INET;
   sin4.sin_port = sin6->sin6_port;
   sin4.sin_addr.s_addr = ((uint32_t *)&sin6->sin6_addr)[3];

   ast_sockaddr_from_sin(ast_mapped, &sin4);

   return 1;
}

int ast_sockaddr_is_any

(

const struct ast_sockaddr *

addr

)

Determine if the address type is unspecified, or "any" address.

Since:

1.8

For IPv4, this would be the address 0.0.0.0, and for IPv6, this would be the address ::. The port number is ignored.

Return values:

1	This is an "any" address
0	This is not an "any" address

Definition at line 414 of file netsock2.c.

References ast_sockaddr_is_ipv4(), ast_sockaddr_is_ipv6(), and ast_sockaddr::ss.

Referenced by ast_find_ourip(), ast_set_qos(), ast_sip_ouraddrfor(), get_address_family_filter(), get_our_media_address(), gtalk_get_local_ip(), reload_config(), sip_show_settings(), and sockaddr_is_null_or_any().

{
   union {
      struct sockaddr_storage ss;
      struct sockaddr_in sin;
      struct sockaddr_in6 sin6;
   } tmp_addr = {
      .ss = addr->ss,
   };

   return (ast_sockaddr_is_ipv4(addr) && (tmp_addr.sin.sin_addr.s_addr == INADDR_ANY)) ||
       (ast_sockaddr_is_ipv6(addr) && IN6_IS_ADDR_UNSPECIFIED(&tmp_addr.sin6.sin6_addr));
}

int ast_sockaddr_is_ipv4

(

const struct ast_sockaddr *

addr

)

Determine if the address is an IPv4 address.

Since:

1.8

Warning:

You should rarely need this function. Only use if you know what you're doing.

Return values:

1	This is an IPv4 address
0	This is an IPv6 or IPv4-mapped IPv6 address

Definition at line 390 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by apply_netmask(), ast_append_ha(), ast_apply_ha(), ast_rtp_new(), ast_rtp_prop_set(), ast_rtp_read(), and ast_sockaddr_is_any().

{
   return addr->ss.ss_family == AF_INET &&
       addr->len == sizeof(struct sockaddr_in);
}

int ast_sockaddr_is_ipv4_mapped

(

const struct ast_sockaddr *

addr

)

Determine if this is an IPv4-mapped IPv6 address.

Since:

1.8

Warning:

You should rarely need this function. Only use if you know what you're doing.

Return values:

1	This is an IPv4-mapped IPv6 address.
0	This is not an IPv4-mapped IPv6 address.

Definition at line 396 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by add_sdp(), ast_apply_ha(), ast_rtp_instance_bridge(), and ast_sockaddr_ipv4_mapped().

{
   const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&addr->ss;
   return addr->len && IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr);
}

int ast_sockaddr_is_ipv6

(

const struct ast_sockaddr *

addr

)

Determine if this is an IPv6 address.

Since:

1.8

Warning:

You should rarely need this function. Only use if you know what you're doing.

Return values:

1	This is an IPv6 or IPv4-mapped IPv6 address.
0	This is an IPv4 address.

Definition at line 408 of file netsock2.c.

References ast_sockaddr::len, and ast_sockaddr::ss.

Referenced by add_sdp(), apply_netmask(), ast_apply_ha(), ast_ouraddrfor(), ast_rtp_new(), ast_rtp_prop_set(), ast_set_qos(), ast_sip_ouraddrfor(), ast_sockaddr_ipv4_mapped(), ast_sockaddr_is_any(), ast_sockaddr_is_ipv6_link_local(), ast_tcptls_client_create(), ast_tcptls_server_start(), ast_udptl_new_with_bindaddr(), get_address_family_filter(), multicast_send_control_packet(), reload_config(), and sip_show_settings().

{
   return addr->ss.ss_family == AF_INET6 &&
       addr->len == sizeof(struct sockaddr_in6);
}

int ast_sockaddr_is_ipv6_link_local

(

const struct ast_sockaddr *

addr

)

Determine if this is a link-local IPv6 address.

Since:

1.8

Warning:

You should rarely need this function. Only use if you know what you're doing.

Return values:

1	This is a link-local IPv6 address.
0	This is link-local IPv6 address.

Definition at line 402 of file netsock2.c.

References ast_sockaddr_is_ipv6(), and ast_sockaddr::ss.

Referenced by ast_sockaddr_stringify_fmt().

{
   const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&addr->ss;
   return ast_sockaddr_is_ipv6(addr) && IN6_IS_ADDR_LINKLOCAL(&sin6->sin6_addr);
}

int ast_sockaddr_parse	(	struct ast_sockaddr *	addr,
		const char *	str,
		int	flags
	)

Parse an IPv4 or IPv6 address string.

Since:

1.8

Parses a string containing an IPv4 or IPv6 address followed by an optional port (separated by a colon) into a struct ast_sockaddr. The allowed formats are the following:

a.b.c.d a.b.c.d:port a:b:c:...:d [a:b:c:...:d] [a:b:c:...:d]:port

Host names are NOT allowed.

Parameters:

[out]	addr	The resulting ast_sockaddr
	str	The string to parse
	flags	If set to zero, a port MAY be present. If set to PARSE_PORT_IGNORE, a port MAY be present but will be ignored. If set to PARSE_PORT_REQUIRE, a port MUST be present. If set to PARSE_PORT_FORBID, a port MUST NOT be present.

Return values:

1	Success
0	Failure

Definition at line 194 of file netsock2.c.

References ast_log(), ast_sockaddr_split_hostport(), ast_strdupa, ast_sockaddr::len, LOG_ERROR, LOG_WARNING, S_OR, and ast_sockaddr::ss.

Referenced by ast_append_ha(), ast_dnsmgr_lookup(), ast_parse_arg(), build_peer(), multicast_rtp_request(), proxy_update(), realtime_peer(), reg_source_db(), reload_config(), rtcp_do_debug_ip(), rtp_do_debug_ip(), and sip_sanitized_host().

{
   struct addrinfo hints;
   struct addrinfo   *res;
   char *s;
   char *host;
   char *port;
   int   e;

   s = ast_strdupa(str);
   if (!ast_sockaddr_split_hostport(s, &host, &port, flags)) {
      return 0;
   }

   memset(&hints, 0, sizeof(hints));
   /* Hint to get only one entry from getaddrinfo */
   hints.ai_socktype = SOCK_DGRAM;

#ifdef AI_NUMERICSERV
   hints.ai_flags = AI_NUMERICHOST | AI_NUMERICSERV;
#else
   hints.ai_flags = AI_NUMERICHOST;
#endif
   if ((e = getaddrinfo(host, port, &hints, &res))) {
      if (e != EAI_NONAME) { /* if this was just a host name rather than a ip address, don't print error */
         ast_log(LOG_ERROR, "getaddrinfo(\"%s\", \"%s\", ...): %s\n",
            host, S_OR(port, "(null)"), gai_strerror(e));
      }
      return 0;
   }

   /*
    * I don't see how this could be possible since we're not resolving host
    * names. But let's be careful...
    */
   if (res->ai_next != NULL) {
      ast_log(LOG_WARNING, "getaddrinfo() returned multiple "
         "addresses. Ignoring all but the first.\n");
   }

   addr->len = res->ai_addrlen;
   memcpy(&addr->ss, res->ai_addr, addr->len);

   freeaddrinfo(res);

   return 1;
}

int ast_sockaddr_resolve	(	struct ast_sockaddr **	addrs,
		const char *	str,
		int	flags,
		int	family
	)

Parses a string with an IPv4 or IPv6 address and place results into an array.

Since:

1.8

Parses a string containing a host name or an IPv4 or IPv6 address followed by an optional port (separated by a colon). The result is returned into a array of struct ast_sockaddr. Allowed formats for str are the following:

hostname:port host.example.com:port a.b.c.d a.b.c.d:port a:b:c:...:d [a:b:c:...:d] [a:b:c:...:d]:port

Parameters:

[out]	addrs	The resulting array of ast_sockaddrs
	str	The string to parse
	flags	If set to zero, a port MAY be present. If set to PARSE_PORT_IGNORE, a port MAY be present but will be ignored. If set to PARSE_PORT_REQUIRE, a port MUST be present. If set to PARSE_PORT_FORBID, a port MUST NOT be present.
	family	Only addresses of the given family will be returned. Use 0 or AST_SOCKADDR_UNSPEC to get addresses of all families.

Return values:

0	Failure
non-zero	The number of elements in addrs array.

Definition at line 242 of file netsock2.c.

References ast_log(), ast_malloc, ast_sockaddr_split_hostport(), ast_strdupa, cleanup(), LOG_ERROR, and S_OR.

Referenced by ast_sockaddr_resolve_first_af(), gtalk_get_local_ip(), handle_cli_udptl_set_debug(), realtime_peer_by_name(), and resolve_first().

{
   struct addrinfo hints, *res, *ai;
   char *s, *host, *port;
   int   e, i, res_cnt;

   if (!str) {
      return 0;
   }

   s = ast_strdupa(str);
   if (!ast_sockaddr_split_hostport(s, &host, &port, flags)) {
      return 0;
   }

   memset(&hints, 0, sizeof(hints));
   hints.ai_family = family;
   hints.ai_socktype = SOCK_DGRAM;

   if ((e = getaddrinfo(host, port, &hints, &res))) {
      ast_log(LOG_ERROR, "getaddrinfo(\"%s\", \"%s\", ...): %s\n",
         host, S_OR(port, "(null)"), gai_strerror(e));
      return 0;
   }

   res_cnt = 0;
   for (ai = res; ai; ai = ai->ai_next) {
      res_cnt++;
   }

   if ((*addrs = ast_malloc(res_cnt * sizeof(struct ast_sockaddr))) == NULL) {
      res_cnt = 0;
      goto cleanup;
   }

   i = 0;
   for (ai = res; ai; ai = ai->ai_next) {
      (*addrs)[i].len = ai->ai_addrlen;
      memcpy(&(*addrs)[i].ss, ai->ai_addr, ai->ai_addrlen);
      ++i;
   }

cleanup:
   freeaddrinfo(res);
   return res_cnt;
}

int ast_sockaddr_split_hostport	(	char *	str,
		char **	host,
		char **	port,
		int	flags
	)

Splits a string into its host and port components.

Since:

1.8

Parameters:

str[in]	The string to parse. May be modified by writing a NUL at the end of the host part.
host[out]	Pointer to the host component within str.
port[out]	Pointer to the port component within str.
flags	If set to zero, a port MAY be present. If set to PARSE_PORT_IGNORE, a port MAY be present but will be ignored. If set to PARSE_PORT_REQUIRE, a port MUST be present. If set to PARSE_PORT_FORBID, a port MUST NOT be present.

Return values:

1	Success
0	Failure

Definition at line 128 of file netsock2.c.

References ast_debug, ast_log(), LOG_WARNING, PARSE_PORT_FORBID, PARSE_PORT_IGNORE, PARSE_PORT_MASK, PARSE_PORT_REQUIRE, and str.

Referenced by ast_sockaddr_parse(), ast_sockaddr_resolve(), extract_host_from_hostport(), rtcp_do_debug_ip(), rtp_do_debug_ip(), and setup_stunaddr().

{
   char *s = str;
   char *orig_str = str;/* Original string in case the port presence is incorrect. */
   char *host_end = NULL;/* Delay terminating the host in case the port presence is incorrect. */

   ast_debug(5, "Splitting '%s' into...\n", str);
   *host = NULL;
   *port = NULL;
   if (*s == '[') {
      *host = ++s;
      for (; *s && *s != ']'; ++s) {
      }
      if (*s == ']') {
         host_end = s;
         ++s;
      }
      if (*s == ':') {
         *port = s + 1;
      }
   } else {
      *host = s;
      for (; *s; ++s) {
         if (*s == ':') {
            if (*port) {
               *port = NULL;
               break;
            } else {
               *port = s;
            }
         }
      }
      if (*port) {
         host_end = *port;
         ++*port;
      }
   }

   switch (flags & PARSE_PORT_MASK) {
   case PARSE_PORT_IGNORE:
      *port = NULL;
      break;
   case PARSE_PORT_REQUIRE:
      if (*port == NULL) {
         ast_log(LOG_WARNING, "Port missing in %s\n", orig_str);
         return 0;
      }
      break;
   case PARSE_PORT_FORBID:
      if (*port != NULL) {
         ast_log(LOG_WARNING, "Port disallowed in %s\n", orig_str);
         return 0;
      }
      break;
   }

   /* Can terminate the host string now if needed. */
   if (host_end) {
      *host_end = '\0';
   }
   ast_debug(5, "...host '%s' and port '%s'.\n", *host, *port ? *port : "");
   return 1;
}

char* ast_sockaddr_stringify_fmt	(	const struct ast_sockaddr *	addr,
		int	format
	)

Convert a socket address to a string.

Since:

1.8

This will be of the form a.b.c.d:xyz for IPv4 and [a:b:c:...:d]:xyz for IPv6.

This function is thread-safe. The returned string is on static thread-specific storage.

Parameters:

addr	The input to be stringified
format	one of the following: AST_SOCKADDR_STR_DEFAULT: a.b.c.d:xyz for IPv4 [a:b:c:...:d]:xyz for IPv6. AST_SOCKADDR_STR_ADDR: address only a.b.c.d for IPv4 a:b:c:...:d for IPv6. AST_SOCKADDR_STR_HOST: address only, suitable for a URL a.b.c.d for IPv4 [a:b:c:...:d] for IPv6. AST_SOCKADDR_STR_PORT: port only

Return values:

(null)	addr is null
""	An error occurred during processing
string	The stringified form of the address

Definition at line 63 of file netsock2.c.

References ast_log(), ast_sockaddr_ipv4_mapped(), ast_sockaddr_is_ipv6_link_local(), ast_sockaddr_isnull(), AST_SOCKADDR_STR_ADDR, AST_SOCKADDR_STR_DEFAULT, AST_SOCKADDR_STR_FORMAT_MASK, AST_SOCKADDR_STR_HOST, AST_SOCKADDR_STR_PORT, AST_SOCKADDR_STR_REMOTE, ast_sockaddr_stringify_buf, ast_str_buffer(), ast_str_set(), ast_str_thread_get(), ast_sockaddr::len, LOG_ERROR, ast_sockaddr::ss, and str.

Referenced by _sip_show_peers(), ast_sockaddr_stringify(), ast_sockaddr_stringify_addr(), ast_sockaddr_stringify_addr_remote(), ast_sockaddr_stringify_host(), ast_sockaddr_stringify_host_remote(), ast_sockaddr_stringify_port(), and ast_sockaddr_stringify_remote().

{
   struct ast_sockaddr sa_ipv4;
   const struct ast_sockaddr *sa_tmp;
   char host[NI_MAXHOST];
   char port[NI_MAXSERV];
   struct ast_str *str;
   int e;
   static const size_t size = sizeof(host) - 1 + sizeof(port) - 1 + 4;


   if (ast_sockaddr_isnull(sa)) {
      return "(null)";
   }

   if (!(str = ast_str_thread_get(&ast_sockaddr_stringify_buf, size))) {
      return "";
   }

   if (ast_sockaddr_ipv4_mapped(sa, &sa_ipv4)) {
      sa_tmp = &sa_ipv4;
   } else {
      sa_tmp = sa;
   }

   if ((e = getnameinfo((struct sockaddr *)&sa_tmp->ss, sa_tmp->len,
              format & AST_SOCKADDR_STR_ADDR ? host : NULL,
              format & AST_SOCKADDR_STR_ADDR ? sizeof(host) : 0,
              format & AST_SOCKADDR_STR_PORT ? port : 0,
              format & AST_SOCKADDR_STR_PORT ? sizeof(port): 0,
              NI_NUMERICHOST | NI_NUMERICSERV))) {
      ast_log(LOG_ERROR, "getnameinfo(): %s\n", gai_strerror(e));
      return "";
   }

   if ((format & AST_SOCKADDR_STR_REMOTE) == AST_SOCKADDR_STR_REMOTE) {
      char *p;
      if (ast_sockaddr_is_ipv6_link_local(sa) && (p = strchr(host, '%'))) {
         *p = '\0';
      }
   }

   switch ((format & AST_SOCKADDR_STR_FORMAT_MASK))  {
   case AST_SOCKADDR_STR_DEFAULT:
      ast_str_set(&str, 0, sa_tmp->ss.ss_family == AF_INET6 ?
            "[%s]:%s" : "%s:%s", host, port);
      break;
   case AST_SOCKADDR_STR_ADDR:
      ast_str_set(&str, 0, "%s", host);
      break;
   case AST_SOCKADDR_STR_HOST:
      ast_str_set(&str, 0,
             sa_tmp->ss.ss_family == AF_INET6 ? "[%s]" : "%s", host);
      break;
   case AST_SOCKADDR_STR_PORT:
      ast_str_set(&str, 0, "%s", port);
      break;
   default:
      ast_log(LOG_ERROR, "Invalid format\n");
      return "";
   }

   return ast_str_buffer(str);
}

---

Variable Documentation

struct ast_threadstorage ast_sockaddr_stringify_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_ast_sockaddr_stringify_buf , .custom_init = NULL , } [static]

Definition at line 61 of file netsock2.c.

Referenced by ast_sockaddr_stringify_fmt().