Structures and functions for parsing, printing, masking and retrieving IP addresses. More...

#include <freeradius-devel/build.h>
#include <freeradius-devel/missing.h>
#include <freeradius-devel/util/talloc.h>
#include <arpa/inet.h>
#include <net/if.h>
#include <netinet/in.h>
#include <stdbool.h>

Include dependency graph for inet.h:

Go to the source code of this file.

Data Structures
struct	fr_ethernet_t
	Struct to represent an ethernet address. More...

struct	fr_ifid_t
	Struct to represent an interface id. More...

struct	fr_ipaddr_t
	IPv4/6 prefix. More...

union	fr_ipaddr_t.addr

Macros
#define	FR_IPADDR_PREFIX_STRLEN (FR_IPADDR_STRLEN + 1 + 4)
	Like FR_IPADDR_STRLEN but with space for a prefix. More...

#define	FR_IPADDR_STRLEN (INET6_ADDRSTRLEN + 1 + IFNAMSIZ)
	Like INET6_ADDRSTRLEN but includes space for the textual Zone ID. More...

Functions
int	fr_inet_hton (fr_ipaddr_t out, int af, char const hostname, bool fallback)
	Wrappers for IPv4/IPv6 host to IP address lookup. More...

char *	fr_inet_ifid_ntop (char out, size_t outlen, uint8_t const ifid)
	Print an interface-id in standard colon notation. More...

uint8_t *	fr_inet_ifid_pton (uint8_t out[static 8], char const *ifid_str)
	Convert interface-id in colon notation to 8 byte binary form. More...

char const *	fr_inet_ntoh (fr_ipaddr_t const src, char out, size_t outlen)
	Perform reverse resolution of an IP address. More...

char *	fr_inet_ntop (char out[static FR_IPADDR_STRLEN], size_t outlen, fr_ipaddr_t const *addr)
	Print the address portion of a fr_ipaddr_t. More...

char *	fr_inet_ntop_prefix (char out[static FR_IPADDR_PREFIX_STRLEN], size_t outlen, fr_ipaddr_t const *addr)
	Print a fr_ipaddr_t as a CIDR style network prefix. More...

int	fr_inet_pton (fr_ipaddr_t out, char const value, ssize_t inlen, int af, bool resolve, bool mask)
	Simple wrapper to decide whether an IP value is v4 or v6 and call the appropriate parser. More...

int	fr_inet_pton4 (fr_ipaddr_t out, char const value, ssize_t inlen, bool resolve, bool fallback, bool mask)
	Parse an IPv4 address or IPv4 prefix in presentation format (and others) More...

int	fr_inet_pton6 (fr_ipaddr_t out, char const value, ssize_t inlen, bool resolve, bool fallback, bool mask)
	Parse an IPv6 address or IPv6 prefix in presentation format (and others) More...

int	fr_inet_pton_port (fr_ipaddr_t out, uint16_t port_out, char const *value, ssize_t inlen, int af, bool resolve, bool mask)
	Parses IPv4/6 address + port, to fr_ipaddr_t and integer (port) More...

int	fr_interface_to_ethernet (char const interface, fr_ethernet_t ethernet)

int	fr_interface_to_ipaddr (char const interface, fr_ipaddr_t ipaddr, int af, bool link_local)

int8_t	fr_ipaddr_cmp (fr_ipaddr_t const a, fr_ipaddr_t const b)
	Compare two ip addresses. More...

int	fr_ipaddr_from_ifname (fr_ipaddr_t out, int af, char const name)

int	fr_ipaddr_from_sockaddr (fr_ipaddr_t ipaddr, uint16_t port, struct sockaddr_storage const *sa, socklen_t salen)
	Convert sockaddr to our internal ip address representation. More...

void	fr_ipaddr_get_scope_id (fr_ipaddr_t *ipaddr)

int	fr_ipaddr_is_inaddr_any (fr_ipaddr_t const *ipaddr)
	Determine if an address is the INADDR_ANY address for its address family. More...

int	fr_ipaddr_is_multicast (fr_ipaddr_t const *ipaddr)
	Determine if an address is a multicast address. More...

int	fr_ipaddr_is_prefix (fr_ipaddr_t const *ipaddr)
	Determine if an address is a prefix. More...

void	fr_ipaddr_mask (fr_ipaddr_t *addr, uint8_t prefix)
	Zeroes out the host portion of an fr_ipaddr_t. More...

char *	fr_ipaddr_to_interface (TALLOC_CTX ctx, fr_ipaddr_t ipaddr)

int	fr_ipaddr_to_sockaddr (struct sockaddr_storage sa, socklen_t salen, fr_ipaddr_t const *ipaddr, uint16_t port)
	Convert our internal ip address representation to a sockaddr. More...

Variables
bool	fr_hostname_lookups
	hostname -> IP lookups? More...

struct in6_addr	fr_inet_link_local6

bool	fr_reverse_lookups
	IP -> hostname lookups? More...

Detailed Description

Structures and functions for parsing, printing, masking and retrieving IP addresses.

Author: Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Copyright: 2015 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Author: Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Copyright: 2023 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition in file inet.h.

Data Structure Documentation

◆ fr_ethernet_t

struct fr_ethernet_t

Struct to represent an ethernet address.

This is needed to represent ethernet addresses correctly in _Generic macros.

Definition at line 45 of file inet.h.

Data Fields
uint8_t	addr[6]	Ethernet address.

◆ fr_ifid_t

struct fr_ifid_t

Struct to represent an interface id.

This is needed to represent an interface id correctly in _Generic macros.

Definition at line 54 of file inet.h.

Data Fields
uint8_t	addr[8]	Interface ID.

◆ fr_ipaddr_t

struct fr_ipaddr_t

IPv4/6 prefix.

Abstraction around the standard in_addr/in6_addr structures to support address family agnostic functions.

Definition at line 272 of file merged_model.c.

Data Fields
union fr_ipaddr_t	addr
int	af	Address family.
uint8_t	prefix	Prefix length - Between 0-32 for IPv4 and 0-128 for IPv6.
uint32_t	scope_id	A host may have multiple link-local interfaces the scope ID allows the application to specify which of those interfaces the IP applies to. A special scope_id of zero means that any interface of a given scope can be used.

◆ fr_ipaddr_t.addr

union fr_ipaddr_t.addr

Definition at line 65 of file inet.h.

Data Fields
struct in_addr	v4	IPv4 address.
struct in6_addr	v6	IPv6 address.

Macro Definition Documentation

◆ FR_IPADDR_PREFIX_STRLEN

#define FR_IPADDR_PREFIX_STRLEN (FR_IPADDR_STRLEN + 1 + 4)

Like FR_IPADDR_STRLEN but with space for a prefix.

Definition at line 93 of file inet.h.

◆ FR_IPADDR_STRLEN

#define FR_IPADDR_STRLEN (INET6_ADDRSTRLEN + 1 + IFNAMSIZ)

Like INET6_ADDRSTRLEN but includes space for the textual Zone ID.

Definition at line 89 of file inet.h.

Function Documentation

◆ fr_inet_hton()

int fr_inet_hton	(	fr_ipaddr_t *	out,
		int	af,
		char const *	hostname,
		bool	fallback
	)

Wrappers for IPv4/IPv6 host to IP address lookup.

This function returns only one IP address, of the specified address family, or the first address (of whatever family), if AF_UNSPEC is used.

If fallback is specified and af is AF_INET, but not AF_INET records were found and a record for AF_INET6 exists that record will be returned.

If fallback is specified and af is AF_INET6, and a record with AF_INET4 exists that record will be returned inserted.

Parameters

[out]	out	Where to write result.
[in]	af	To search for in preference.
[in]	hostname	to search for.
[in]	fallback	to the other address family, if no records matching af, found.

Returns

0 on success.
-1 on failure.

Definition at line 240 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_ifid_ntop()

char* fr_inet_ifid_ntop	(	char *	out,
		size_t	outlen,
		uint8_t const *	ifid
	)

Print an interface-id in standard colon notation.

Parameters

[out]	out	Where to write the resulting interface-id string.
[in]	outlen	of output buffer.
[in]	ifid	to print.

Returns: a pointer to out.

Definition at line 1085 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_ifid_pton()

uint8_t* fr_inet_ifid_pton	(	uint8_t	out[static 8],
		char const *	ifid_str
	)

Convert interface-id in colon notation to 8 byte binary form.

Parameters

[out]	out	Where to write the binary interface-id.
[in]	ifid_str	to parse.

Returns: a pointer to out.

Definition at line 1099 of file inet.c.

Here is the caller graph for this function:

◆ fr_inet_ntoh()

char const* fr_inet_ntoh	(	fr_ipaddr_t const *	src,
		char *	out,
		size_t	outlen
	)

Perform reverse resolution of an IP address.

Attempt to resolve an IP address to a DNS record (if dns lookups are enabled).

Parameters

[in]	src	address to resolve.
[out]	out	Where to write the resulting hostname.
[in]	outlen	length of the output buffer.

Definition at line 341 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_ntop()

char* fr_inet_ntop	(	char	out[static FR_IPADDR_STRLEN],
		size_t	outlen,
		fr_ipaddr_t const *	addr
	)

Print the address portion of a fr_ipaddr_t.

Note: Includes the textual scope_id name (eth0, en0 etc...) if supported.

Parameters

[out]	out	Where to write the resulting IP string. Should be at least FR_IPADDR_STRLEN bytes.
[in]	outlen	of output buffer.
[in]	addr	to convert to presentation format.

Returns

NULL on error (use fr_syserror(errno)).
a pointer to out on success.

Definition at line 1004 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_ntop_prefix()

char* fr_inet_ntop_prefix	(	char	out[static FR_IPADDR_PREFIX_STRLEN],
		size_t	outlen,
		fr_ipaddr_t const *	addr
	)

Print a fr_ipaddr_t as a CIDR style network prefix.

Parameters

[out]	out	Where to write the resulting prefix string. Should be at least FR_IPADDR_PREFIX_STRLEN bytes.
[in]	outlen	of output buffer.
[in]	addr	to convert to presentation format.

Returns

NULL on error (use fr_syserror(errno)).
a pointer to out on success.

Definition at line 1059 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_pton()

int fr_inet_pton	(	fr_ipaddr_t *	out,
		char const *	value,
		ssize_t	inlen,
		int	af,
		bool	resolve,
		bool	mask
	)

Simple wrapper to decide whether an IP value is v4 or v6 and call the appropriate parser.

Parameters

[out]	out	Where to write the ip address value.
[in]	value	to parse.
[in]	inlen	Length of value, if value is \0 terminated inlen may be -1.
[in]	resolve	If true and value doesn't look like an IP address, try and resolve value as a hostname.
[in]	af	If the address type is not obvious from the format, and resolve is true, the DNS record (A or AAAA) we require. Also controls which parser we pass the address to if we have no idea what it is. AF_UNSPEC - Use the server default IP family. AF_INET - Treat value as an IPv4 address. AF_INET6 - Treat value as in IPv6 address.
[in]	mask	If true, set address bits to zero.

Returns

0 if ip address was parsed successfully.
-1 on failure.

Definition at line 764 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_pton4()

int fr_inet_pton4	(	fr_ipaddr_t *	out,
		char const *	value,
		ssize_t	inlen,
		bool	resolve,
		bool	fallback,
		bool	mask_bits
	)

Parse an IPv4 address or IPv4 prefix in presentation format (and others)

Parameters

[out]	out	Where to write the ip address value.
[in]	value	to parse, may be: dotted quad [+ prefix] integer octal number '*' (INADDR_ANY) FQDN if resolve is true.
[in]	inlen	Length of value, if value is \0 terminated inlen may be -1.
[in]	resolve	If true and value doesn't look like an IP address, try and resolve value as a hostname.
[in]	fallback	to IPv6 resolution if no A records can be found.
[in]	mask_bits	If true, set address bits to zero.

Returns

0 if ip address was parsed successfully.
-1 on failure.

Definition at line 275 of file merged_model.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_pton6()

int fr_inet_pton6	(	fr_ipaddr_t *	out,
		char const *	value,
		ssize_t	inlen,
		bool	resolve,
		bool	fallback,
		bool	mask
	)

Parse an IPv6 address or IPv6 prefix in presentation format (and others)

Parameters

[out]	out	Where to write the ip address value.
[in]	value	to parse, may be: IPv6 hexits [+ prefix]. '*' wildcard. FQDN if resolve is true.
[in]	inlen	Length of value, if value is \0 terminated inlen may be -1.
[in]	resolve	If true and value doesn't look like an IP address, try and resolve value as a hostname.
[in]	fallback	to IPv4 resolution if no AAAA records can be found.
[in]	mask	If true, set address bits to zero.

Returns

0 if ip address was parsed successfully.
-1 on failure.

Definition at line 615 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_inet_pton_port()

int fr_inet_pton_port	(	fr_ipaddr_t *	out,
		uint16_t *	port_out,
		char const *	value,
		ssize_t	inlen,
		int	af,
		bool	resolve,
		bool	mask
	)

Parses IPv4/6 address + port, to fr_ipaddr_t and integer (port)

Parameters

[out]	out	Where to write the ip address value.
[out]	port_out	Where to write the port (0 if no port found).
[in]	value	to parse.
[in]	inlen	Length of value, if value is \0 terminated inlen may be -1.
[in]	resolve	If true and value doesn't look like an IP address, try and resolve value as a hostname.
[in]	af	If the address type is not obvious from the format, and resolve is true, the DNS record (A or AAAA) we require. Also controls which parser we pass the address to if we have no idea what it is. AF_UNSPEC - Use the server default IP family. AF_INET - Treat value as an IPv4 address. AF_INET6 - Treat value as in IPv6 address.
[in]	mask	If true, set address bits to zero.

Returns

0 if ip address was parsed successfully.
-1 on failure.

Definition at line 923 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_interface_to_ethernet()

int fr_interface_to_ethernet	(	char const *	interface,
		fr_ethernet_t *	ethernet
	)

Definition at line 1604 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_interface_to_ipaddr()

int fr_interface_to_ipaddr	(	char const *	interface,
		fr_ipaddr_t *	ipaddr,
		int	af,
		bool	link_local
	)

Definition at line 1559 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_ipaddr_cmp()

int8_t fr_ipaddr_cmp	(	fr_ipaddr_t const *	a,
		fr_ipaddr_t const *	b
	)

Compare two ip addresses.

Parameters

[in]	a	First ip to compare.
[in]	b	Second ip to compare.

Returns

1 if a > b
0 if a == b
-1 if a < b
-2 on error.

Definition at line 1332 of file inet.c.

Here is the caller graph for this function:

◆ fr_ipaddr_from_ifname()

int fr_ipaddr_from_ifname	(	fr_ipaddr_t *	out,
		int	af,
		char const *	name
	)

◆ fr_ipaddr_from_sockaddr()

int fr_ipaddr_from_sockaddr	(	fr_ipaddr_t *	ipaddr,
		uint16_t *	port,
		struct sockaddr_storage const *	sa,
		socklen_t	salen
	)

Convert sockaddr to our internal ip address representation.

Parameters

[out]	ipaddr	Where to write the ipaddr.
[out]	port	Where to write the port.
[in]	sa	struct to convert.
[in]	salen	Length of the sockaddr struct.

Returns

0 on success.
-1 on failure.

Definition at line 1427 of file inet.c.

Here is the caller graph for this function:

◆ fr_ipaddr_get_scope_id()

void fr_ipaddr_get_scope_id ( fr_ipaddr_t * ipaddr )

Definition at line 1472 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_ipaddr_is_inaddr_any()

int fr_ipaddr_is_inaddr_any ( fr_ipaddr_t const * ipaddr )

Determine if an address is the INADDR_ANY address for its address family.

Parameters

ipaddr to check.

Returns

0 if it's not.
1 if it is.
-1 on error.

Definition at line 62 of file inet.c.

Here is the caller graph for this function:

◆ fr_ipaddr_is_multicast()

int fr_ipaddr_is_multicast ( fr_ipaddr_t const * ipaddr )

Determine if an address is a multicast address.

Parameters

ipaddr to check.

Returns

0 if it's not.
1 if it is.
-1 on error.

Definition at line 94 of file inet.c.

Here is the caller graph for this function:

◆ fr_ipaddr_is_prefix()

int fr_ipaddr_is_prefix ( fr_ipaddr_t const * ipaddr )

Determine if an address is a prefix.

Parameters

ipaddr to check.

Returns

0 if it's not.
1 if it is.
-1 on error.

Definition at line 125 of file inet.c.

Here is the caller graph for this function:

◆ fr_ipaddr_mask()

void fr_ipaddr_mask	(	fr_ipaddr_t *	addr,
		uint8_t	prefix
	)

Zeroes out the host portion of an fr_ipaddr_t.

Parameters

[in,out]	addr	to mask
[in]	prefix	Length of the network portion.

Definition at line 203 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_ipaddr_to_interface()

char* fr_ipaddr_to_interface	(	TALLOC_CTX *	ctx,
		fr_ipaddr_t *	ipaddr
	)

Definition at line 1516 of file inet.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_ipaddr_to_sockaddr()

int fr_ipaddr_to_sockaddr	(	struct sockaddr_storage *	sa,
		socklen_t *	salen,
		fr_ipaddr_t const *	ipaddr,
		uint16_t	port
	)

Convert our internal ip address representation to a sockaddr.

Parameters

[out]	sa	where to write out the sockaddr, must be large enough to hold sizeof(s6).
[out]	salen	Length of the sockaddr struct.
[in]	ipaddr	IP address to convert.
[in]	port	Port to convert.

Returns

0 on success.
-1 on failure.

Definition at line 1378 of file inet.c.

Here is the caller graph for this function:

Variable Documentation

◆ fr_hostname_lookups

bool fr_hostname_lookups

extern

hostname -> IP lookups?

Definition at line 52 of file inet.c.

◆ fr_inet_link_local6

struct in6_addr fr_inet_link_local6

extern

◆ fr_reverse_lookups

bool fr_reverse_lookups

extern

IP -> hostname lookups?

Definition at line 51 of file inet.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Data Structure Documentation

◆ fr_ethernet_t

◆ fr_ifid_t

◆ fr_ipaddr_t

◆ fr_ipaddr_t.addr

Macro Definition Documentation

◆ FR_IPADDR_PREFIX_STRLEN

◆ FR_IPADDR_STRLEN

Function Documentation

◆ fr_inet_hton()

◆ fr_inet_ifid_ntop()

◆ fr_inet_ifid_pton()

◆ fr_inet_ntoh()

◆ fr_inet_ntop()

◆ fr_inet_ntop_prefix()

◆ fr_inet_pton()

◆ fr_inet_pton4()

◆ fr_inet_pton6()

◆ fr_inet_pton_port()

◆ fr_interface_to_ethernet()

◆ fr_interface_to_ipaddr()

◆ fr_ipaddr_cmp()

◆ fr_ipaddr_from_ifname()

◆ fr_ipaddr_from_sockaddr()

◆ fr_ipaddr_get_scope_id()

◆ fr_ipaddr_is_inaddr_any()

◆ fr_ipaddr_is_multicast()

◆ fr_ipaddr_is_prefix()

◆ fr_ipaddr_mask()

◆ fr_ipaddr_to_interface()

◆ fr_ipaddr_to_sockaddr()

Variable Documentation

◆ fr_hostname_lookups

◆ fr_inet_link_local6

◆ fr_reverse_lookups