diff --git a/lib/libc/net/resolver.3 b/lib/libc/net/resolver.3 index 684f2e8d98fc..6694845f0764 100644 --- a/lib/libc/net/resolver.3 +++ b/lib/libc/net/resolver.3 @@ -1,461 +1,458 @@ .\" Copyright (c) 1985, 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.3 8.1 (Berkeley) 6/4/93 .\" $FreeBSD$ .\" -.Dd May 29, 2009 +.Dd September 15, 2022 .Dt RESOLVER 3 .Os .Sh NAME .Nm res_query , .Nm res_search , .Nm res_mkquery , .Nm res_send , .Nm res_init , .Nm dn_comp , .Nm dn_expand , .Nm dn_skipname , .Nm ns_get16 , .Nm ns_get32 , .Nm ns_put16 , .Nm ns_put32 .Nd resolver routines .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In netinet/in.h .In arpa/nameser.h .In resolv.h .Ft int .Fo res_query .Fa "const char *dname" .Fa "int class" .Fa "int type" .Fa "u_char *answer" .Fa "int anslen" .Fc .Ft int .Fo res_search .Fa "const char *dname" .Fa "int class" .Fa "int type" .Fa "u_char *answer" .Fa "int anslen" .Fc .Ft int .Fo res_mkquery .Fa "int op" .Fa "const char *dname" .Fa "int class" .Fa "int type" .Fa "const u_char *data" .Fa "int datalen" .Fa "const u_char *newrr_in" .Fa "u_char *buf" .Fa "int buflen" .Fc .Ft int .Fo res_send .Fa "const u_char *msg" .Fa "int msglen" .Fa "u_char *answer" .Fa "int anslen" .Fc .Ft int .Fn res_init void .Ft int .Fo dn_comp .Fa "const char *exp_dn" .Fa "u_char *comp_dn" .Fa "int length" .Fa "u_char **dnptrs" .Fa "u_char **lastdnptr" .Fc .Ft int .Fo dn_expand .Fa "const u_char *msg" .Fa "const u_char *eomorig" .Fa "const u_char *comp_dn" .Fa "char *exp_dn" .Fa "int length" .Fc .Ft int .Fn dn_skipname "const u_char *comp_dn" "const u_char *eom" .Ft u_int .Fn ns_get16 "const u_char *src" .Ft u_long .Fn ns_get32 "const u_char *src" .Ft void .Fn ns_put16 "u_int src" "u_char *dst" .Ft void .Fn ns_put32 "u_long src" "u_char *dst" .Sh DESCRIPTION These routines are used for making, sending and interpreting query and reply messages with Internet domain name servers. .Pp Global configuration and state information that is used by the resolver routines is kept in the structure .Va _res . Most of the values have reasonable defaults and can be ignored. Options stored in .Va _res.options are defined in .In resolv.h and are as follows. Options are stored as a simple bit mask containing the bitwise ``or'' of the options enabled. .Bl -tag -width RES_USE_INET6 .It Dv RES_INIT True if the initial name server address and default domain name are initialized (i.e., .Fn res_init has been called). .It Dv RES_DEBUG Print debugging messages. .It Dv RES_AAONLY Accept authoritative answers only. With this option, .Fn res_send should continue until it finds an authoritative answer or finds an error. Currently this is not implemented. .It Dv RES_USEVC Use .Tn TCP connections for queries instead of .Tn UDP datagrams. .It Dv RES_STAYOPEN Used with .Dv RES_USEVC to keep the .Tn TCP connection open between queries. This is useful only in programs that regularly do many queries. .Tn UDP should be the normal mode used. .It Dv RES_IGNTC Unused currently (ignore truncation errors, i.e., do not retry with .Tn TCP ) . .It Dv RES_RECURSE Set the recursion-desired bit in queries. This is the default. .Pf ( Fn res_send does not do iterative queries and expects the name server to handle recursion.) .It Dv RES_DEFNAMES If set, .Fn res_search will append the default domain name to single-component names (those that do not contain a dot). This option is enabled by default. .It Dv RES_DNSRCH If this option is set, .Fn res_search will search for host names in the current domain and in parent domains; see .Xr hostname 7 . This is used by the standard host lookup routine .Xr gethostbyname 3 . This option is enabled by default. .It Dv RES_NOALIASES This option turns off the user level aliasing feature controlled by the .Dq Ev HOSTALIASES environment variable. Network daemons should set this option. .It Dv RES_USE_INET6 Enables support for IPv6-only applications. This causes IPv4 addresses to be returned as an IPv4 mapped address. For example, .Li 10.1.1.1 will be returned as .Li ::ffff:10.1.1.1 . The option is meaningful with certain kernel configuration only. .It Dv RES_USE_EDNS0 Enables support for OPT pseudo-RR for EDNS0 extension. With the option, resolver code will attach OPT pseudo-RR into DNS queries, to inform of our receive buffer size. The option will allow DNS servers to take advantage of non-default receive buffer size, and to send larger replies. DNS query packets with EDNS0 extension is not compatible with non-EDNS0 DNS servers. .El .Pp The .Fn res_init routine reads the configuration file (if any; see .Xr resolver 5 ) to get the default domain name, search list and the Internet address of the local name server(s). If no server is configured, the host running the resolver is tried. The current domain name is defined by the hostname if not specified in the configuration file; it can be overridden by the environment variable .Ev LOCALDOMAIN . This environment variable may contain several blank-separated tokens if you wish to override the .Em "search list" on a per-process basis. This is similar to the .Ic search command in the configuration file. Another environment variable .Dq Ev RES_OPTIONS can be set to override certain internal resolver options which are otherwise set by changing fields in the .Va _res structure or are inherited from the configuration file's .Ic options command. The syntax of the .Dq Ev RES_OPTIONS environment variable is explained in .Xr resolver 5 . Initialization normally occurs on the first call to one of the following routines. .Pp The .Fn res_query function provides an interface to the server query mechanism. It constructs a query, sends it to the local server, awaits a response, and makes preliminary checks on the reply. The query requests information of the specified .Fa type and .Fa class for the specified fully-qualified domain name .Fa dname . The reply message is left in the .Fa answer buffer with length .Fa anslen supplied by the caller. .Pp The .Fn res_search routine makes a query and awaits a response like .Fn res_query , but in addition, it implements the default and search rules controlled by the .Dv RES_DEFNAMES and .Dv RES_DNSRCH options. It returns the first successful reply. .Pp The remaining routines are lower-level routines used by .Fn res_query . The .Fn res_mkquery function constructs a standard query message and places it in .Fa buf . It returns the size of the query, or \-1 if the query is larger than .Fa buflen . The query type .Fa op is usually .Dv QUERY , but can be any of the query types defined in .In arpa/nameser.h . The domain name for the query is given by .Fa dname . The .Fa newrr_in argument is currently unused but is intended for making update messages. .Pp The .Fn res_send routine sends a pre-formatted query and returns an answer. It will call .Fn res_init if .Dv RES_INIT is not set, send the query to the local name server, and handle timeouts and retries. The length of the reply message is returned, or \-1 if there were errors. .Pp The .Fn dn_comp function compresses the domain name .Fa exp_dn and stores it in .Fa comp_dn . The size of the compressed name is returned or \-1 if there were errors. The size of the array pointed to by .Fa comp_dn is given by .Fa length . The compression uses an array of pointers .Fa dnptrs to previously-compressed names in the current message. The first pointer points to the beginning of the message and the list ends with .Dv NULL . The limit to the array is specified by .Fa lastdnptr . A side effect of .Fn dn_comp is to update the list of pointers for labels inserted into the message as the name is compressed. If .Fa dnptr is .Dv NULL , names are not compressed. If .Fa lastdnptr is .Dv NULL , the list of labels is not updated. .Pp The .Fn dn_expand entry expands the compressed domain name .Fa comp_dn to a full domain name The compressed name is contained in a query or reply message; .Fa msg is a pointer to the beginning of the message. The uncompressed name is placed in the buffer indicated by .Fa exp_dn which is of size .Fa length . The size of compressed name is returned or \-1 if there was an error. .Pp The .Fn dn_skipname function skips over a compressed domain name, which starts at a location pointed to by .Fa comp_dn . The compressed name is contained in a query or reply message; .Fa eom is a pointer to the end of the message. The size of compressed name is returned or \-1 if there was an error. .Pp The .Fn ns_get16 function gets a 16-bit quantity from a buffer pointed to by .Fa src . .Pp The .Fn ns_get32 function gets a 32-bit quantity from a buffer pointed to by .Fa src . .Pp The .Fn ns_put16 function puts a 16-bit quantity .Fa src to a buffer pointed to by .Fa dst . .Pp The .Fn ns_put32 function puts a 32-bit quantity .Fa src to a buffer pointed to by .Fa dst . .Sh IMPLEMENTATION NOTES This implementation of the resolver is thread-safe, but it will not function properly if the programmer attempts to declare his or her own .Va _res structure in an attempt to replace the per-thread version referred to by that macro. .Pp The following compile-time option can be specified to change the default behavior of resolver routines when necessary. .Bl -tag -width RES_ENFORCE_RFC1034 .It Dv RES_ENFORCE_RFC1034 If this symbol is defined during compile-time, .Fn res_search will enforce RFC 1034 check, namely, disallow using of underscore character within host names. This is used by the standard host lookup routines like .Xr gethostbyname 3 . For compatibility reasons this option is not enabled by default. .El .Sh RETURN VALUES The .Fn res_init function will return 0 on success, or \-1 in a threaded program if per-thread storage could not be allocated. .Pp The .Fn res_mkquery , .Fn res_search , and .Fn res_query functions return the size of the response on success, or \-1 if an error occurs. The integer .Vt h_errno may be checked to determine the reason for error. See .Xr gethostbyname 3 for more information. .Sh FILES .Bl -tag -width /etc/resolv.conf .It Pa /etc/resolv.conf The configuration file, see .Xr resolver 5 . .El .Sh SEE ALSO .Xr gethostbyname 3 , .Xr resolver 5 , .Xr hostname 7 , .Xr named 8 .Pp .%T RFC1032 , .%T RFC1033 , .%T RFC1034 , .%T RFC1035 , .%T RFC974 -.Rs -.%T "Name Server Operations Guide for BIND" -.Re .Sh HISTORY The .Nm function appeared in .Bx 4.3 . diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 index ca7586f039b7..6bf643f6c5ce 100644 --- a/share/man/man5/hosts.5 +++ b/share/man/man5/hosts.5 @@ -1,97 +1,94 @@ .\" Copyright (c) 1983, 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. .\" .\" @(#)hosts.5 8.2 (Berkeley) 12/11/93 .\" $FreeBSD$ .\" -.Dd May 25, 2021 +.Dd September 15, 2022 .Dt HOSTS 5 .Os .Sh NAME .Nm hosts .Nd host name data base .Sh DESCRIPTION The .Nm file contains information regarding the known hosts on the network. It can be used in conjunction with DNS, and the NIS maps `hosts.byaddr' and `hosts.byname', as controlled by .Xr nsswitch.conf 5 . For each host a single line should be present with the following information: .Bd -unfilled -offset indent Internet address official host name aliases .Ed .Pp Items are separated by any number of blanks and/or tab characters. A ``#'' indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Pp This file provides a backup used when the name server is not running. For the name server, it is suggested that only a few addresses be included in this file. These include addresses for the local interfaces that .Xr ifconfig 8 needs at boot time and a few machines on the local network. .Pp Network addresses are specified in either the conventional ``.'' (dot) notation for IPv4 or colon hexadecimal notation for IPv6, as understood by the .Xr inet_pton 3 routine from the Internet address manipulation library, .Xr inet 3 . Host names may contain any printable character other than a field delimiter, newline, or comment character. .Sh FILES .Bl -tag -width /etc/hosts -compact .It Pa /etc/hosts The .Nm file resides in .Pa /etc . .El .Sh SEE ALSO .Xr gethostbyname 3 , .Xr inet 3 , .Xr nsswitch.conf 5 , .Xr ifconfig 8 -.Rs -.%T "Name Server Operations Guide for BIND" -.Re .Sh HISTORY The .Nm file format appeared in .Bx 4.1c . diff --git a/share/man/man5/resolver.5 b/share/man/man5/resolver.5 index 468c635839c6..9b45d668f4c9 100644 --- a/share/man/man5/resolver.5 +++ b/share/man/man5/resolver.5 @@ -1,235 +1,232 @@ .\" 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 November 9, 2021 +.Dd September 15, 2022 .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 IPv4 or IPv6 address 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. 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 network pairs are separated by slashes. Up to 10 pairs may be specified. E.g., .Pp .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 .