]>
Commit | Line | Data |
---|---|---|
1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> | |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2014 Tom Gundersen | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | --> | |
23 | ||
24 | <refentry id="systemd-resolved.service" conditional='ENABLE_RESOLVE'> | |
25 | ||
26 | <refentryinfo> | |
27 | <title>systemd-resolved.service</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Tom</firstname> | |
34 | <surname>Gundersen</surname> | |
35 | <email>teg@jklm.no</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>systemd-resolved.service</refentrytitle> | |
42 | <manvolnum>8</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd-resolved.service</refname> | |
47 | <refname>systemd-resolved</refname> | |
48 | <refpurpose>Network Name Resolution manager</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsynopsisdiv> | |
52 | <para><filename>systemd-resolved.service</filename></para> | |
53 | <para><filename>/usr/lib/systemd/systemd-resolved</filename></para> | |
54 | </refsynopsisdiv> | |
55 | ||
56 | <refsect1> | |
57 | <title>Description</title> | |
58 | ||
59 | <para><command>systemd-resolved</command> is a system service that provides network name resolution to local | |
60 | applications. It implements a caching and validating DNS/DNSSEC stub resolver, as well as an LLMNR resolver and | |
61 | responder. Local applications may submit network name resolution requests via three interfaces:</para> | |
62 | ||
63 | <itemizedlist> | |
64 | <listitem><para>The native, fully-featured API <command>systemd-resolved</command> exposes on the bus. See the | |
65 | <ulink url="https://www.freedesktop.org/wiki/Software/systemd/resolved">API Documentation</ulink> for | |
66 | details. Usage of this API is generally recommended to clients as it is asynchronous and fully featured (for | |
67 | example, properly returns DNSSEC validation status and interface scope for addresses as necessary for supporting | |
68 | link-local networking).</para></listitem> | |
69 | ||
70 | <listitem><para>The glibc | |
71 | <citerefentry project='man-pages'><refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum></citerefentry> API as defined | |
72 | by <ulink url="https://tools.ietf.org/html/rfc3493">RFC3493</ulink> and its related resolver functions, | |
73 | including <citerefentry project='man-pages'><refentrytitle>gethostbyname</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This | |
74 | API is widely supported, including beyond the Linux platform. In its current form it does not expose DNSSEC | |
75 | validation status information however, and is synchronous only. This API is backed by the glibc Name Service | |
76 | Switch (<citerefentry project='man-pages'><refentrytitle>nss</refentrytitle><manvolnum>5</manvolnum></citerefentry>). Usage of the | |
77 | glibc NSS module <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
78 | is required in order to allow glibc's NSS resolver functions to resolve host names via | |
79 | <command>systemd-resolved</command>.</para></listitem> | |
80 | ||
81 | <listitem><para>Additionally, <command>systemd-resolved</command> provides a local DNS stub listener on IP | |
82 | address 127.0.0.53 on the local loopback interface. Programs issuing DNS requests directly, bypassing any local | |
83 | API may be directed to this stub, in order to connect them to <command>systemd-resolved</command>. Note however | |
84 | that it is strongly recommended that local programs use the glibc NSS or bus APIs instead (as described above), | |
85 | as various network resolution concepts (such as link-local addressing, or LLMNR Unicode domains) cannot be mapped | |
86 | to the unicast DNS protocol.</para></listitem> | |
87 | </itemizedlist> | |
88 | ||
89 | <para>The DNS servers contacted are determined from the global settings in | |
90 | <filename>/etc/systemd/resolved.conf</filename>, the per-link static settings in | |
91 | <filename>/etc/systemd/network/*.network</filename> files, the per-link dynamic settings received over DHCP and any | |
92 | DNS server information made available by other system services. See | |
93 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> and | |
94 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details | |
95 | about systemd's own configuration files for DNS servers. To improve compatibility, | |
96 | <filename>/etc/resolv.conf</filename> is read in order to discover configured system DNS servers, but only if it is | |
97 | not a symlink to <filename>/run/systemd/resolve/stub-resolv.conf</filename> or | |
98 | <filename>/run/systemd/resolve/resolv.conf</filename> (see below).</para> | |
99 | ||
100 | <para><command>systemd-resolved</command> synthesizes DNS resource records (RRs) for the following cases:</para> | |
101 | ||
102 | <itemizedlist> | |
103 | <listitem><para>The local, configured hostname is resolved to | |
104 | all locally configured IP addresses ordered by their scope, or | |
105 | — if none are configured — the IPv4 address 127.0.0.2 (which | |
106 | is on the local loopback) and the IPv6 address ::1 (which is the | |
107 | local host).</para></listitem> | |
108 | ||
109 | <listitem><para>The hostnames <literal>localhost</literal> and | |
110 | <literal>localhost.localdomain</literal> (as well as any hostname | |
111 | ending in <literal>.localhost</literal> or <literal>.localhost.localdomain</literal>) | |
112 | are resolved to the IP addresses 127.0.0.1 and ::1.</para></listitem> | |
113 | ||
114 | <listitem><para>The hostname <literal>gateway</literal> is | |
115 | resolved to all current default routing gateway addresses, | |
116 | ordered by their metric. This assigns a stable hostname to the | |
117 | current gateway, useful for referencing it independently of the | |
118 | current network configuration state.</para></listitem> | |
119 | ||
120 | <listitem><para>The mappings defined in <filename>/etc/hosts</filename> are resolved | |
121 | to their configured addresses and back, but they will not affect lookups for | |
122 | non-address types (like MX).</para></listitem> | |
123 | </itemizedlist> | |
124 | ||
125 | <para>Lookup requests are routed to the available DNS servers | |
126 | and LLMNR interfaces according to the following rules:</para> | |
127 | ||
128 | <itemizedlist> | |
129 | <listitem><para>Lookups for the special hostname | |
130 | <literal>localhost</literal> are never routed to the | |
131 | network. (A few other, special domains are handled the same way.)</para></listitem> | |
132 | ||
133 | <listitem><para>Single-label names are routed to all local | |
134 | interfaces capable of IP multicasting, using the LLMNR | |
135 | protocol. Lookups for IPv4 addresses are only sent via LLMNR on | |
136 | IPv4, and lookups for IPv6 addresses are only sent via LLMNR on | |
137 | IPv6. Lookups for the locally configured host name and the | |
138 | <literal>gateway</literal> host name are never routed to | |
139 | LLMNR.</para></listitem> | |
140 | ||
141 | <listitem><para>Multi-label names are routed to all local | |
142 | interfaces that have a DNS server configured, plus the globally | |
143 | configured DNS server if there is one. Address lookups from the | |
144 | link-local address range are never routed to | |
145 | DNS.</para></listitem> | |
146 | </itemizedlist> | |
147 | ||
148 | <para>If lookups are routed to multiple interfaces, the first | |
149 | successful response is returned (thus effectively merging the | |
150 | lookup zones on all matching interfaces). If the lookup failed on | |
151 | all interfaces, the last failing response is returned.</para> | |
152 | ||
153 | <para>Routing of lookups may be influenced by configuring | |
154 | per-interface domain names. See | |
155 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
156 | for details. Lookups for a hostname ending in one of the | |
157 | per-interface domains are exclusively routed to the matching | |
158 | interfaces.</para> | |
159 | ||
160 | <para>See the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/resolved"> resolved D-Bus API | |
161 | Documentation</ulink> for information about the APIs <filename>systemd-resolved</filename> provides.</para> | |
162 | ||
163 | </refsect1> | |
164 | ||
165 | <refsect1> | |
166 | <title><filename>/etc/resolv.conf</filename></title> | |
167 | ||
168 | <para>Four modes of handling <filename>/etc/resolv.conf</filename> (see | |
169 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>) are | |
170 | supported:</para> | |
171 | ||
172 | <itemizedlist> | |
173 | <listitem><para><command>systemd-resolved</command> maintains the | |
174 | <filename>/run/systemd/resolve/stub-resolv.conf</filename> file for compatibility with traditional Linux | |
175 | programs. This file may be symlinked from <filename>/etc/resolv.conf</filename>. This file lists the 127.0.0.53 | |
176 | DNS stub (see above) as the only DNS server. It also contains a list of search domains that are in use by | |
177 | systemd-resolved. The list of search domains is always kept up-to-date. Note that | |
178 | <filename>/run/systemd/resolve/stub-resolv.conf</filename> should not be used directly by applications, but only | |
179 | through a symlink from <filename>/etc/resolv.conf</filename>. This file may be symlinked from | |
180 | <filename>/etc/resolv.conf</filename> in order to connect all local clients that bypass local DNS APIs to | |
181 | <command>systemd-resolved</command> with correct search domains settings. This mode of operation is | |
182 | recommended.</para></listitem> | |
183 | ||
184 | <listitem><para>A static file <filename>/usr/lib/systemd/resolv.conf</filename> is provided that lists | |
185 | the 127.0.0.53 DNS stub (see above) as only DNS server. This file may be symlinked from | |
186 | <filename>/etc/resolv.conf</filename> in order to connect all local clients that bypass local DNS APIs to | |
187 | <command>systemd-resolved</command>. This file does not contain any search domains.</para></listitem> | |
188 | ||
189 | <listitem><para><command>systemd-resolved</command> maintains the | |
190 | <filename>/run/systemd/resolve/resolv.conf</filename> file for compatibility with traditional Linux | |
191 | programs. This file may be symlinked from <filename>/etc/resolv.conf</filename> and is always kept up-to-date, | |
192 | containing information about all known DNS servers. Note the file format's limitations: it does not know a | |
193 | concept of per-interface DNS servers and hence only contains system-wide DNS server definitions. Note that | |
194 | <filename>/run/systemd/resolve/resolv.conf</filename> should not be used directly by applications, but only | |
195 | through a symlink from <filename>/etc/resolv.conf</filename>. If this mode of operation is used local clients | |
196 | that bypass any local DNS API will also bypass <command>systemd-resolved</command> and will talk directly to the | |
197 | known DNS servers.</para> </listitem> | |
198 | ||
199 | <listitem><para>Alternatively, <filename>/etc/resolv.conf</filename> may be managed by other packages, in which | |
200 | case <command>systemd-resolved</command> will read it for DNS configuration data. In this mode of operation | |
201 | <command>systemd-resolved</command> is consumer rather than provider of this configuration | |
202 | file. </para></listitem> | |
203 | </itemizedlist> | |
204 | ||
205 | <para>Note that the selected mode of operation for this file is detected fully automatically, depending on whether | |
206 | <filename>/etc/resolv.conf</filename> is a symlink to <filename>/run/systemd/resolve/resolv.conf</filename> or | |
207 | lists 127.0.0.53 as DNS server.</para> | |
208 | </refsect1> | |
209 | ||
210 | <refsect1> | |
211 | <title>Signals</title> | |
212 | ||
213 | <variablelist> | |
214 | <varlistentry> | |
215 | <term><constant>SIGUSR1</constant></term> | |
216 | ||
217 | <listitem><para>Upon reception of the <constant>SIGUSR1</constant> process signal | |
218 | <command>systemd-resolved</command> will dump the contents of all DNS resource record caches it maintains, as | |
219 | well as all feature level information it learnt about configured DNS servers into the system | |
220 | logs.</para></listitem> | |
221 | </varlistentry> | |
222 | ||
223 | <varlistentry> | |
224 | <term><constant>SIGUSR2</constant></term> | |
225 | ||
226 | <listitem><para>Upon reception of the <constant>SIGUSR2</constant> process signal | |
227 | <command>systemd-resolved</command> will flush all caches it maintains. Note that it should normally not be | |
228 | necessary to request this explicitly – except for debugging purposes – as <command>systemd-resolved</command> | |
229 | flushes the caches automatically anyway any time the host's network configuration changes. Sending this signal | |
230 | to <command>systemd-resolved</command> is equivalent to the <command>systemd-resolve --flush-caches</command> | |
231 | command, however the latter is recommended since it operates in a synchronous way.</para></listitem> | |
232 | </varlistentry> | |
233 | ||
234 | <varlistentry> | |
235 | <term><constant>SIGRTMIN+1</constant></term> | |
236 | ||
237 | <listitem><para>Upon reception of the <constant>SIGRTMIN+1</constant> process signal | |
238 | <command>systemd-resolved</command> will forget everything it learnt about the configured DNS | |
239 | servers. Specifically any information about server feature support is flushed out, and the server feature | |
240 | probing logic is restarted on the next request, starting with the most fully featured level. Note that it | |
241 | should normally not be necessary to request this explicitly – except for debugging purposes – as | |
242 | <command>systemd-resolved</command> automatically forgets learnt information any time the DNS server | |
243 | configuration changes. Sending this signal to <command>systemd-resolved</command> is equivalent to the | |
244 | <command>systemd-resolve --reset-server-features</command> command, however the latter is recommended since it | |
245 | operates in a synchronous way.</para></listitem> | |
246 | </varlistentry> | |
247 | </variablelist> | |
248 | ||
249 | </refsect1> | |
250 | ||
251 | <refsect1> | |
252 | <title>See Also</title> | |
253 | <para> | |
254 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
255 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
256 | <citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
257 | <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
258 | <citerefentry><refentrytitle>systemd-resolve</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
259 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
260 | <citerefentry project='man-pages'><refentrytitle>hosts</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
261 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
262 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
263 | </para> | |
264 | </refsect1> | |
265 | ||
266 | </refentry> |