diff --git a/lib/libc/net/inet.3 b/lib/libc/net/inet.3 index a36cb313f7d3..cb44394d0a0c 100644 --- a/lib/libc/net/inet.3 +++ b/lib/libc/net/inet.3 @@ -1,305 +1,301 @@ .\" Copyright (c) 1983, 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. 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. .\" 3. Neither the name of the University 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 REGENTS 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. .\" .\" From: @(#)inet.3 8.1 (Berkeley) 6/4/93 .\" $FreeBSD$ .\" -.Dd June 14, 2007 +.Dd November 9, 2021 .Dt INET 3 .Os .Sh NAME .Nm inet_aton , .Nm inet_addr , .Nm inet_network , .Nm inet_ntoa , .Nm inet_ntoa_r , .Nm inet_ntop , .Nm inet_pton , .Nm inet_makeaddr , .Nm inet_lnaof , .Nm inet_netof .Nd Internet address manipulation routines .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netinet/in.h .In arpa/inet.h .Ft int .Fn inet_aton "const char *cp" "struct in_addr *pin" .Ft in_addr_t .Fn inet_addr "const char *cp" .Ft in_addr_t .Fn inet_network "const char *cp" .Ft char * .Fn inet_ntoa "struct in_addr in" .Ft char * .Fo inet_ntoa_r .Fa "struct in_addr in" .Fa "char *buf" .Fa "socklen_t size" .Fc .Ft const char * .Fo inet_ntop .Fa "int af" .Fa "const void * restrict src" .Fa "char * restrict dst" .Fa "socklen_t size" .Fc .Ft int .Fn inet_pton "int af" "const char * restrict src" "void * restrict dst" .Ft struct in_addr .Fn inet_makeaddr "in_addr_t net" "in_addr_t lna" .Ft in_addr_t .Fn inet_lnaof "struct in_addr in" .Ft in_addr_t .Fn inet_netof "struct in_addr in" .Sh DESCRIPTION The routines .Fn inet_aton , .Fn inet_addr and .Fn inet_network interpret character strings representing numbers expressed in the Internet standard .Ql .\& notation. .Pp The .Fn inet_pton function converts a presentation format address (that is, printable form as held in a character string) to network format (usually a .Ft struct in_addr or some other internal binary representation, in network byte order). It returns 1 if the address was valid for the specified address family, or 0 if the address was not parseable in the specified address family, or -1 if some system error occurred (in which case .Va errno will have been set). This function is presently valid for .Dv AF_INET and .Dv AF_INET6 . .Pp The .Fn inet_aton routine interprets the specified character string as an Internet address, placing the address into the structure provided. It returns 1 if the string was successfully interpreted, or 0 if the string is invalid. The .Fn inet_addr and .Fn inet_network functions return numbers suitable for use as Internet addresses and Internet network numbers, respectively. .Pp The function .Fn inet_ntop converts an address .Fa *src from network format (usually a .Ft struct in_addr or some other binary form, in network byte order) to presentation format (suitable for external display purposes). The .Fa size argument specifies the size, in bytes, of the buffer .Fa *dst . .Dv INET_ADDRSTRLEN and .Dv INET6_ADDRSTRLEN define the maximum size required to convert an address of the respective type. It returns NULL if a system error occurs (in which case, .Va errno will have been set), or it returns a pointer to the destination string. This function is presently valid for .Dv AF_INET and .Dv AF_INET6 . .Pp The routine .Fn inet_ntoa takes an Internet address and returns an .Tn ASCII string representing the address in .Ql .\& notation. The routine .Fn inet_ntoa_r is the reentrant version of .Fn inet_ntoa . -The routine +The deprecated routine .Fn inet_makeaddr takes an Internet network number and a local -network address and constructs an Internet address +host address on that network, and constructs an Internet address from it. -The routines +It should only be assumed to work for historical class A/B/C networks. +The deprecated routines .Fn inet_netof and .Fn inet_lnaof break apart Internet host addresses, returning -the network number and local network address part, -respectively. +the network number and local host address part, +respectively, +assuming the historical class A/B/C network masks. .Pp All Internet addresses are returned in network order (bytes ordered from left to right). All network numbers and local address parts are returned as machine byte order integer values. .Sh INTERNET ADDRESSES Values specified using the .Ql .\& notation take one of the following forms: .Bd -literal -offset indent a.b.c.d a.b.c a.b a .Ed .Pp When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, to the four bytes of an Internet address. Note that when an Internet address is viewed as a 32-bit integer quantity on the .Tn VAX the bytes referred to above appear as .Dq Li d.c.b.a . That is, .Tn VAX bytes are ordered from right to left. .Pp When a three part address is specified, the last part is interpreted as a 16-bit quantity and placed -in the right-most two bytes of the network address. -This makes the three part address format convenient -for specifying Class B network addresses as -.Dq Li 128.net.host . +in the least significant two bytes of the network address. .Pp When a two part address is supplied, the last part is interpreted as a 24-bit quantity and placed in -the right most three bytes of the network address. -This makes the two part address format convenient -for specifying Class A network addresses as -.Dq Li net.host . +the least significant three bytes of the network address. .Pp When only one part is given, the value is stored directly in the network address without any byte rearrangement. .Pp All numbers supplied as .Dq parts in a .Ql .\& notation may be decimal, octal, or hexadecimal, as specified in the C language (i.e., a leading 0x or 0X implies hexadecimal; otherwise, a leading 0 implies octal; otherwise, the number is interpreted as decimal). .Sh DIAGNOSTICS The constant .Dv INADDR_NONE is returned by .Fn inet_addr and .Fn inet_network for malformed requests. .Sh ERRORS The .Fn inet_ntop call fails if: .Bl -tag -width Er .It Bq Er ENOSPC .Fa size was not large enough to store the presentation form of the address. .It Bq Er EAFNOSUPPORT .Fa *src was not an .Dv AF_INET or .Dv AF_INET6 family address. .El .Sh SEE ALSO .Xr byteorder 3 , .Xr getaddrinfo 3 , .Xr gethostbyname 3 , .Xr getnameinfo 3 , .Xr getnetent 3 , .Xr inet_net 3 , .Xr hosts 5 , .Xr networks 5 .Rs .%R RFC .%N 2373 .%D July 1998 .%T "IP Version 6 Addressing Architecture" .Re .Sh STANDARDS The .Fn inet_ntop and .Fn inet_pton functions conform to .St -xns5.2 . Note that .Fn inet_pton does not accept 1-, 2-, or 3-part dotted addresses; all four parts must be specified and are interpreted only as decimal values. This is a narrower input set than that accepted by .Fn inet_aton . .Sh HISTORY These functions appeared in .Bx 4.2 . .Sh BUGS The value .Dv INADDR_NONE (0xffffffff) is a valid broadcast address, but .Fn inet_addr cannot return that value without indicating failure. The newer .Fn inet_aton function does not share this problem. The problem of host byte ordering versus network byte ordering is confusing. The string returned by .Fn inet_ntoa resides in a static memory area. .Pp The .Fn inet_addr function should return a .Fa struct in_addr . diff --git a/lib/libc/net/inet_net.3 b/lib/libc/net/inet_net.3 index f0721729ff05..4028984bd09b 100644 --- a/lib/libc/net/inet_net.3 +++ b/lib/libc/net/inet_net.3 @@ -1,161 +1,155 @@ .\" $NetBSD: inet_net.3,v 1.4 1999/03/22 19:44:52 garbled Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. .\" All rights reserved. .\" .\" This code is derived from software contributed to The NetBSD Foundation .\" by Luke Mewburn. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. 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. .\" 3. Neither the name of The NetBSD Foundation 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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. .\" .\" $FreeBSD$ .\" -.Dd August 18, 2016 +.Dd November 9, 2021 .Dt INET_NET 3 .Os .Sh NAME .Nm inet_net_ntop , .Nm inet_net_pton .Nd Internet network number manipulation routines .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/socket.h .In netinet/in.h .In arpa/inet.h .Ft char * .Fn inet_net_ntop "int af" "const void *src" "int bits" "char *dst" "size_t size" .Ft int .Fn inet_net_pton "int af" "const char *src" "void *dst" "size_t size" .Sh DESCRIPTION The .Fn inet_net_ntop function converts an Internet network number from network format (usually a .Vt "struct in_addr" or some other binary form, in network byte order) to CIDR presentation format (suitable for external display purposes). The .Fa bits argument is the number of bits in .Fa src that are the network number. It returns .Dv NULL if a system error occurs (in which case, .Va errno will have been set), or it returns a pointer to the destination string. .Pp The .Fn inet_net_pton function converts a presentation format Internet network number (that is, printable form as held in a character string) to network format (usually a .Vt "struct in_addr" or some other internal binary representation, in network byte order). It returns the number of bits (either computed based on the class, or specified with /CIDR), or \-1 if a failure occurred (in which case .Va errno will have been set. It will be set to .Er ENOENT if the Internet network number was not valid). .Pp The currently supported values for .Fa af are .Dv AF_INET and .Dv AF_INET6 . The .Fa size argument is the size of the result buffer .Fa dst . .Sh NETWORK NUMBERS (IP VERSION 4) Internet network numbers may be specified in one of the following forms: .Bd -literal -offset indent a.b.c.d/bits a.b.c.d a.b.c a.b a .Ed .Pp When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, to the four bytes of an Internet network number. Note that when an Internet network number is viewed as a 32-bit integer quantity on a system that uses little-endian byte order (such as the .Tn Intel 386 , 486 , and .Tn Pentium processors) the bytes referred to above appear as .Dq Li d.c.b.a . That is, little-endian bytes are ordered from right to left. .Pp When a three part number is specified, the last part is interpreted as a 16-bit quantity and placed -in the rightmost two bytes of the Internet network number. -This makes the three part number format convenient -for specifying Class B network numbers as -.Dq Li 128.net.host . +in the least significant two bytes of the Internet network number. .Pp When a two part number is supplied, the last part is interpreted as a 24-bit quantity and placed in -the rightmost three bytes of the Internet network number. -This makes the two part number format convenient -for specifying Class A network numbers as -.Dq Li net.host . +the least significant three bytes of the Internet network number. .Pp When only one part is given, the value is stored directly in the Internet network number without any byte rearrangement. .Pp All numbers supplied as .Dq parts in a .Ql \&. notation may be decimal, octal, or hexadecimal, as specified in the C language (i.e., a leading 0x or 0X implies hexadecimal; otherwise, a leading 0 implies octal; otherwise, the number is interpreted as decimal). .\" .\" .Sh NETWORK NUMBERS (IP VERSION 6) .\" XXX - document this! .\" .Sh SEE ALSO .Xr byteorder 3 , .Xr inet 3 , .Xr networks 5 .Sh HISTORY The .Fn inet_net_ntop and .Fn inet_net_pton functions appeared in BIND 4.9.4. diff --git a/share/man/man5/resolver.5 b/share/man/man5/resolver.5 index cc439f123442..21e1f8f99131 100644 --- a/share/man/man5/resolver.5 +++ b/share/man/man5/resolver.5 @@ -1,234 +1,235 @@ .\" Copyright (c) 1986, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. 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. .\" 3. Neither the name of the University 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 REGENTS 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. .\" .\" @(#)resolver.5 8.1 (Berkeley) 6/5/93 .\" $FreeBSD$ .\" -.Dd August 16, 2018 +.Dd November 9, 2021 .Dt RESOLVER 5 .Os .Sh NAME .Nm resolver .Nd resolver configuration file .Sh SYNOPSIS .Nm resolv.conf .Sh DESCRIPTION The .Xr resolver 3 is a set of routines in the C library which provide access to the Internet Domain Name System. The resolver configuration file contains information that is read by the resolver routines the first time they are invoked by a process. The file is designed to be human readable and contains a list of keywords with values that provide various types of resolver information. .Pp On a normally configured system this file should not be necessary. The only name server to be queried will be on the local machine, the domain name is determined from the host name, and the domain search path is constructed from the domain name. .Pp The different configuration options are: .Bl -tag -width nameserver .It Sy nameserver Internet address (in dot notation) of a name server that the resolver should query. Up to .Dv MAXNS (currently 3) name servers may be listed, one per keyword. If there are multiple servers, the resolver library queries them in the order listed. If no .Sy nameserver entries are present, the default is to use the name server on the local machine. (The algorithm used is to try a name server, and if the query times out, try the next, until out of name servers, then repeat trying all the name servers until a maximum number of retries are made). .It Sy domain Local domain name. Most queries for names within this domain can use short names relative to the local domain. If no .Sy domain entry is present, the domain is determined from the local host name returned by .Xr gethostname 3 ; the domain part is taken to be everything after the first .Ql \&. . Finally, if the host name does not contain a domain part, the root domain is assumed. .It Sy search Search list for host-name lookup. The search list is normally determined from the local domain name; by default, it contains only the local domain name. This may be changed by listing the desired domain search path following the .Sy search keyword with spaces or tabs separating the names. Most resolver queries will be attempted using each component of the search path in turn until a match is found. Note that this process may be slow and will generate a lot of network traffic if the servers for the listed domains are not local, and that queries will time out if no server is available for one of the domains. .Pp The search list is currently limited to six domains with a total of 256 characters. .It Sy sortlist Sortlist allows addresses returned by gethostbyname to be sorted. A sortlist is specified by IP address netmask pairs. -The netmask is -optional and defaults to the natural netmask of the net. +If the netmask is not specified, +it defaults to the historical Class A/B/C netmask of the net; +this usage is deprecated. The IP address -and optional network pairs are separated by slashes. +and network pairs are separated by slashes. Up to 10 pairs may be specified. E.g., .Pp -.Dl "sortlist 130.155.160.0/255.255.240.0 130.155.0.0" +.Dl "sortlist 10.9.1.0/255.255.240.0 10.9.0.0/255.255.0.0" .It Sy options Options allows certain internal resolver variables to be modified. The syntax is .Pp \fBoptions\fP \fIoption\fP \fI...\fP .Pp where .Sy option is one of the following: .Bl -tag -width no_tld_query .It Sy debug sets .Dv RES_DEBUG in _res.options. .It Sy usevc sets .Dv RES_USEVC to use TCP instead of UDP for queries. .It Sy ndots: Ns Ar n sets a threshold for the number of dots which must appear in a name given to .Fn res_query (see .Xr resolver 3 ) before an .Em initial absolute query will be made. The default for .Em n is .Dq 1 , meaning that if there are any dots in a name, the name will be tried first as an absolute name before any .Em search list elements are appended to it. .It Sy timeout: Ns Ar n sets the initial amount of time the resolver will wait for a response from a remote name server before retrying the query via a different name server. The resolver may wait longer during subsequent retries of the current query since an exponential back-off is applied to the timeout value. Measured in seconds, the default is .Dv RES_TIMEOUT , the allowed maximum is .Dv RES_MAXRETRANS (see .In resolv.h ) . .It Sy attempts: Ns Ar n sets the number of times the resolver will send a query to each of its name servers before giving up and returning an error to the calling application. The default is .Dv RES_DFLRETRY , the allowed maximum is .Dv RES_MAXRETRY (see .In resolv.h ) . .It Sy no_tld_query tells the resolver not to attempt to resolve a top level domain name, that is, a name that contains no dots. Use of this option does not prevent the resolver from obeying the standard .Sy domain and .Sy search rules with the given name. .It Sy reload-period: Ns Ar n The resolver checks the modification time of .Pa /etc/resolv.conf every .Ar n seconds. If .Pa /etc/resolv.conf has changed, it is automatically reloaded. The default for .Ar n is two seconds. Setting it to zero disables the file check. .El .Pp Options may also be specified as a space or tab separated list using the .Dv RES_OPTIONS environment variable. .El .Pp The .Sy domain and .Sy search keywords are mutually exclusive. If more than one instance of these keywords is present, the last instance will override. .Pp The keyword and value must appear on a single line, and the keyword .Pq for example, Sy nameserver must start the line. The value follows the keyword, separated by white space. .Sh FILES .Bl -tag -width /etc/resolv.conf -compact .It Pa /etc/resolv.conf The file .Nm resolv.conf resides in .Pa /etc . .El .Sh SEE ALSO .Xr gethostbyname 3 , .Xr resolver 3 , .Xr hostname 7 , .Xr resolvconf 8 .Rs .%T "Name Server Operations Guide for BIND" .Re .Sh HISTORY The .Nm resolv.conf file format appeared in .Bx 4.3 .