]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd-resolved.service.xml
journal: Serialize __MONOTONIC_TIMESTAMP metadata field as well
[thirdparty/systemd.git] / man / systemd-resolved.service.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
eea10b26 3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
db9ecf05 4<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
091a364c 5
4623eecb
AK
6<refentry id="systemd-resolved.service" conditional='ENABLE_RESOLVE'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
091a364c 8
798d3a52
ZJS
9 <refentryinfo>
10 <title>systemd-resolved.service</title>
11 <productname>systemd</productname>
798d3a52
ZJS
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>systemd-resolved.service</refentrytitle>
16 <manvolnum>8</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>systemd-resolved.service</refname>
21 <refname>systemd-resolved</refname>
22 <refpurpose>Network Name Resolution manager</refpurpose>
23 </refnamediv>
24
25 <refsynopsisdiv>
26 <para><filename>systemd-resolved.service</filename></para>
12b42c76 27 <para><filename>/usr/lib/systemd/systemd-resolved</filename></para>
798d3a52
ZJS
28 </refsynopsisdiv>
29
30 <refsect1>
31 <title>Description</title>
32
b0fb800c
ZJS
33 <para><command>systemd-resolved</command> is a system service that provides network name resolution to
34 local applications. It implements a caching and validating DNS/DNSSEC stub resolver, as well as an LLMNR
35 and MulticastDNS resolver and responder. Local applications may submit network name resolution requests
36 via three interfaces:</para>
b541146b
LP
37
38 <itemizedlist>
af8a03cc 39 <listitem><para>The native, fully-featured API <command>systemd-resolved</command> exposes via D-Bus,
ffd10e5a
ZJS
40 see
41 <citerefentry><refentrytitle>org.freedesktop.resolve1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1a0e562a
ZJS
42 and
43 <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
ffd10e5a
ZJS
44 for details. Usage of this API is generally recommended to clients as it is asynchronous and fully
45 featured (for example, properly returns DNSSEC validation status and interface scope for addresses as
46 necessary for supporting link-local networking).</para></listitem>
b541146b 47
af8a03cc
LP
48 <listitem><para>The native API <command>systemd-resolved</command> exposes via Varlink on the
49 <filename>/run/systemd/resolve/io.systemd.Resolve</filename> AF_UNIX socket. This provides similar
50 functionality as the D-Bus interface, but is available during the entire runtime, without requiring a
51 running D-Bus system bus broker service.</para></listitem>
52
b541146b 53 <listitem><para>The glibc
b0fb800c
ZJS
54 <citerefentry project='man-pages'><refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum></citerefentry>
55 API as defined by <ulink url="https://tools.ietf.org/html/rfc3493">RFC3493</ulink> and its related
56 resolver functions, including
57 <citerefentry project='man-pages'><refentrytitle>gethostbyname</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
58 This API is widely supported, including beyond the Linux platform. In its current form it does not
59 expose DNSSEC validation status information however, and is synchronous only. This API is backed by the
60 glibc Name Service Switch
61 (<citerefentry project='man-pages'><refentrytitle>nss</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
62 Usage of the glibc NSS module
63 <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry> is
38b38500 64 required in order to allow glibc's NSS resolver functions to resolve hostnames via
b541146b
LP
65 <command>systemd-resolved</command>.</para></listitem>
66
b0fb800c 67 <listitem><para>Additionally, <command>systemd-resolved</command> provides a local DNS stub listener on
a8d09063
LP
68 the IP addresses 127.0.0.53 and 127.0.0.54 on the local loopback interface. Programs issuing DNS
69 requests directly, bypassing any local API may be directed to this stub, in order to connect them to
b0fb800c
ZJS
70 <command>systemd-resolved</command>. Note however that it is strongly recommended that local programs
71 use the glibc NSS or bus APIs instead (as described above), as various network resolution concepts
72 (such as link-local addressing, or LLMNR Unicode domains) cannot be mapped to the unicast DNS
a8d09063
LP
73 protocol.</para>
74
75 <para id="proxy-stub">The DNS stub resolver on 127.0.0.53 provides the full feature set of the local
76 resolver, which includes offering LLMNR/MulticastDNS resolution. The DNS stub resolver on 127.0.0.54
77 provides a more limited resolver, that operates in "proxy" mode only, i.e. it will pass most DNS
78 messages relatively unmodified to the current upstream DNS servers and back, but not try to process the
79 messages locally, and hence does not validate DNSSEC, or offer up LLMNR/MulticastDNS. (It will
80 translate to DNS-over-TLS communication if needed however.)</para></listitem>
b541146b 81 </itemizedlist>
798d3a52 82
b541146b
LP
83 <para>The DNS servers contacted are determined from the global settings in
84 <filename>/etc/systemd/resolved.conf</filename>, the per-link static settings in
6cdf635d 85 <filename>/etc/systemd/network/*.network</filename> files (in case
b0fb800c 86 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
9d569d5f 87 is used), the per-link dynamic settings received over DHCP, information provided via
b0fb800c
ZJS
88 <citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, and any
89 DNS server information made available by other system services. See
b541146b 90 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
b0fb800c
ZJS
91 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
92 details about systemd's own configuration files for DNS servers. To improve compatibility,
93 <filename>/etc/resolv.conf</filename> is read in order to discover configured system DNS servers, but
94 only if it is not a symlink to <filename>/run/systemd/resolve/stub-resolv.conf</filename>,
95 <filename>/usr/lib/systemd/resolv.conf</filename> or
96 <filename>/run/systemd/resolve/resolv.conf</filename> (see below).</para>
396c716c
LP
97
98 </refsect1>
99
100 <refsect1>
101 <title>Synthetic Records</title>
b541146b 102
78bc7025 103 <para><command>systemd-resolved</command> synthesizes DNS resource records (RRs) for the following
b0fb800c 104 cases:</para>
2dc6b11d
LP
105
106 <itemizedlist>
b0fb800c
ZJS
107 <listitem><para>The local, configured hostname is resolved to all locally configured IP addresses
108 ordered by their scope, or — if none are configured — the IPv4 address 127.0.0.2 (which is on the local
9e1804b2 109 loopback interface) and the IPv6 address ::1 (which is the local host).</para></listitem>
b0fb800c
ZJS
110
111 <listitem><para>The hostnames <literal>localhost</literal> and <literal>localhost.localdomain</literal>
9e1804b2
ZJS
112 as well as any hostname ending in <literal>.localhost</literal> or
113 <literal>.localhost.localdomain</literal> are resolved to the IP addresses 127.0.0.1 and ::1.
b0fb800c
ZJS
114 </para></listitem>
115
116 <listitem><para>The hostname <literal>_gateway</literal> is resolved to all current default routing
117 gateway addresses, ordered by their metric. This assigns a stable hostname to the current gateway,
118 useful for referencing it independently of the current network configuration state.</para></listitem>
2f166bb7
LP
119
120 <listitem><para>The hostname <literal>_outbound</literal> is resolved to the local IPv4 and IPv6
121 addresses that are most likely used for communication with other hosts. This is determined by
122 requesting a routing decision to the configured default gateways from the kernel and then using the
123 local IP addresses selected by this decision. This hostname is only available if there is at least one
124 local default gateway configured. This assigns a stable hostname to the local outbound IP addresses,
125 useful for referencing them independently of the current network configuration state.</para></listitem>
b0fb800c 126
17f244e8
LP
127 <listitem><para>The hostname <literal>_localdnsstub</literal> is resolved to the IP address 127.0.0.53,
128 i.e. the address the local DNS stub (see above) is listening on.</para></listitem>
129
130 <listitem><para>The hostname <literal>_localdnsproxy</literal> is resolved to the IP address 127.0.0.54,
131 i.e. the address the local DNS proxy (see above) is listening on.</para></listitem>
132
b0fb800c
ZJS
133 <listitem><para>The mappings defined in <filename>/etc/hosts</filename> are resolved to their
134 configured addresses and back, but they will not affect lookups for non-address types (like MX).
9d569d5f
ZJS
135 Support for <filename>/etc/hosts</filename> may be disabled with <varname>ReadEtcHosts=no</varname>,
136 see <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
b0fb800c 137 </para></listitem>
2dc6b11d 138 </itemizedlist>
396c716c
LP
139 </refsect1>
140
141 <refsect1>
142 <title>Protocols and Routing</title>
2dc6b11d 143
32f82ccc
ZJS
144 <para>The lookup requests that <filename>systemd-resolved.service</filename> receives are routed to the
145 available DNS servers, LLMNR, and MulticastDNS interfaces according to the following rules:</para>
2dc6b11d
LP
146
147 <itemizedlist>
9e1804b2
ZJS
148 <listitem><para>Names for which synthetic records are generated (the local hostname,
149 <literal>localhost</literal> and <literal>localdomain</literal>, local gateway, as listed in the
150 previous section) and addresses configured in <filename>/etc/hosts</filename> are never routed to the
151 network and a reply is sent immediately.</para></listitem>
152
153 <listitem><para>Single-label names are resolved using LLMNR on all local interfaces where LLMNR is
154 enabled. Lookups for IPv4 addresses are only sent via LLMNR on IPv4, and lookups for IPv6 addresses are
78bc7025 155 only sent via LLMNR on IPv6. Note that lookups for single-label synthesized names are not routed to
9e1804b2
ZJS
156 LLMNR, MulticastDNS or unicast DNS.</para></listitem>
157
78bc7025 158 <listitem><para>Queries for the address records (A and AAAA) of single-label non-synthesized names are
9e1804b2 159 resolved via unicast DNS using search domains. For any interface which defines search domains, such
dbb3b26f
ZJS
160 look-ups are routed to the servers defined for that interface, suffixed with each of those search
161 domains. When global search domains are defined, such look-ups are routed to the global servers. For
162 each search domain, queries are performed by suffixing the name with each of the search domains in
163 turn. Additionally, lookup of single-label names via unicast DNS may be enabled with the
164 <varname>ResolveUnicastSingleLabel=yes</varname> setting. The details of which servers are queried and
165 how the final reply is chosen are described below. Note that this means that address queries for
b838bc11 166 single-label names are never sent out to remote DNS servers by default, and resolution is only
dbb3b26f 167 possible if search domains are defined.</para></listitem>
9e1804b2
ZJS
168
169 <listitem><para>Multi-label names with the domain suffix <literal>.local</literal> are resolved using
170 MulticastDNS on all local interfaces where MulticastDNS is enabled. As with LLMNR, IPv4 address lookups
171 are sent via IPv4 and IPv6 address lookups are sent via IPv6.</para></listitem>
172
173 <listitem><para>Queries for multi-label names are routed via unicast DNS on local interfaces that have
174 a DNS server configured, plus the globally configured DNS servers if there are any. Which interfaces
175 are used is determined by the routing logic based on search and route-only domains, described below.
176 Note that by default, lookups for domains with the <literal>.local</literal> suffix are not routed to
177 DNS servers, unless the domain is specified explicitly as routing or search domain for the DNS server
178 and interface. This means that on networks where the <literal>.local</literal> domain is defined in a
179 site-specific DNS server, explicit search or routing domains need to be configured to make lookups work
180 within this DNS domain. Note that these days, it's generally recommended to avoid defining
181 <literal>.local</literal> in a DNS server, as <ulink
182 url="https://tools.ietf.org/html/rfc6762">RFC6762</ulink> reserves this domain for exclusive
6cdf635d 183 MulticastDNS use.</para></listitem>
9d569d5f 184
9e1804b2
ZJS
185 <listitem><para>Address lookups (reverse lookups) are routed similarly to multi-label names, with the
186 exception that addresses from the link-local address range are never routed to unicast DNS and are only
187 resolved using LLMNR and MulticastDNS (when enabled).</para></listitem>
2dc6b11d
LP
188 </itemizedlist>
189
b0fb800c
ZJS
190 <para>If lookups are routed to multiple interfaces, the first successful response is returned (thus
191 effectively merging the lookup zones on all matching interfaces). If the lookup failed on all interfaces,
192 the last failing response is returned.</para>
2dc6b11d 193
9e1804b2
ZJS
194 <para>Routing of lookups is determined by the per-interface routing domains (search and route-only) and
195 global search domains. See
2e88625f 196 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
9e1804b2
ZJS
197 <citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for a
198 description how those settings are set dynamically and the discussion of <varname>Domains=</varname> in
199 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
200 description of globally configured DNS settings.</para>
201
32f82ccc
ZJS
202 <para>The following query routing logic applies for unicast DNS lookups initiated by
203 <filename>systemd-resolved.service</filename>:</para>
2e88625f
LP
204
205 <itemizedlist>
b0fb800c 206 <listitem><para>If a name to look up matches (that is: is equal to or has as suffix) any of the
9e1804b2
ZJS
207 configured routing domains (search or route-only) of any link, or the globally configured DNS settings,
208 "best matching" routing domain is determined: the matching one with the most labels. The query is then
209 sent to all DNS servers of any links or the globally configured DNS servers associated with this "best
210 matching" routing domain. (Note that more than one link might have this same "best matching" routing
211 domain configured, in which case the query is sent to all of them in parallel).</para>
9d569d5f
ZJS
212
213 <para>In case of single-label names, when search domains are defined, the same logic applies, except
bace6883 214 that the name is first suffixed by each of the search domains in turn. Note that this search logic
377a9545 215 doesn't apply to any names with at least one dot. Also see the discussion about compatibility with
bace6883 216 the traditional glibc resolver below.</para></listitem>
b0fb800c 217
9e1804b2
ZJS
218 <listitem><para>If a query does not match any configured routing domain (either per-link or global), it
219 is sent to all DNS servers that are configured on links with the <varname>DefaultRoute=</varname>
220 option set, as well as the globally configured DNS server.</para></listitem>
b0fb800c 221
9e1804b2
ZJS
222 <listitem><para>If there is no link configured as <varname>DefaultRoute=</varname> and no global DNS
223 server configured, one of the compiled-in fallback DNS servers is used.</para></listitem>
b0fb800c 224
9e1804b2 225 <listitem><para>Otherwise the unicast DNS query fails, as no suitable DNS servers can be determined.
b0fb800c 226 </para></listitem>
2e88625f
LP
227 </itemizedlist>
228
9e1804b2
ZJS
229 <para>The <varname>DefaultRoute=</varname> option is a boolean setting configurable with
230 <command>resolvectl</command> or in <filename>.network</filename> files. If not set, it is implicitly
231 determined based on the configured DNS domains for a link: if there's a route-only domain other than
232 <literal>~.</literal>, it defaults to false, otherwise to true.</para>
2e88625f 233
78bc7025 234 <para>Effectively this means: in order to support single-label non-synthesized names, define appropriate
9e1804b2
ZJS
235 search domains. In order to preferably route all DNS queries not explicitly matched by routing domain
236 configuration to a specific link, configure a <literal>~.</literal> route-only domain on it. This will
237 ensure that other links will not be considered for these queries (unless they too carry such a routing
238 domain). In order to route all such DNS queries to a specific link only if no other link is preferred,
239 set the <varname>DefaultRoute=</varname> option for the link to true and do not configure a
9d569d5f 240 <literal>~.</literal> route-only domain on it. Finally, in order to ensure that a specific link never
9e1804b2
ZJS
241 receives any DNS traffic not matching any of its configured routing domains, set the
242 <varname>DefaultRoute=</varname> option for it to false.</para>
b0fb800c 243
21006e0e
ZJS
244 <para>See
245 <citerefentry><refentrytitle>org.freedesktop.resolve1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
246 for information about the D-Bus APIs <filename>systemd-resolved</filename> provides.</para>
798d3a52
ZJS
247 </refsect1>
248
bace6883
ZJS
249 <refsect1>
250 <title>Compatibility with the traditional glibc stub resolver</title>
251
612a91c1 252 <para>This section provides a short summary of differences in the resolver implemented by
bace6883 253 <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry> together
75909cc7 254 with <command>systemd-resolved</command> and the traditional stub resolver implemented in
d8096172 255 <filename>nss-dns</filename>.</para>
bace6883
ZJS
256
257 <itemizedlist>
258 <listitem><para>Some names are always resolved internally (see Synthetic Records above). Traditionally
32f82ccc
ZJS
259 they would be resolved by <filename>nss-files</filename> if provided in
260 <filename>/etc/hosts</filename>. But note that the details of how a query is constructed are under the
261 control of the client library. <filename>nss-dns</filename> will first try to resolve names using
262 search domains and even if those queries are routed to <filename>systemd-resolved</filename>, it will
263 send them out over the network using the usual rules for multi-label name routing <footnote><para>For
e83580bf 264 example, if <filename>/etc/resolv.conf</filename> has <programlisting>nameserver 127.0.0.53
32f82ccc
ZJS
265search foobar.com barbar.com
266 </programlisting>and we look up <literal>localhost</literal>, <filename>nss-dns</filename> will send
267 the following queries to <filename>systemd-resolved</filename> listening on 127.0.0.53:53: first
268 <literal>localhost.foobar.com</literal>, then <literal>localhost.barbar.com</literal>, and finally
269 <literal>localhost</literal>. If (hopefully) the first two queries fail,
270 <filename>systemd-resolved</filename> will synthesize an answer for the third query.</para>
271
272 <para>When using <filename>nss-dns</filename> with any search domains, it is thus crucial to always
273 configure <filename>nss-files</filename> with higher priority and provide mappings for names that
274 should not be resolved using search domains.</para></footnote>.</para></listitem>
bace6883
ZJS
275
276 <listitem><para>Single-label names are not resolved for A and AAAA records using unicast DNS (unless
377a9545 277 overridden with <varname>ResolveUnicastSingleLabel=</varname>, see
bace6883
ZJS
278 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
279 This is similar to the <option>no-tld-query</option> option being set in
d8096172 280 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
bace6883
ZJS
281 </para></listitem>
282
283 <listitem><para>Search domains are not used for <emphasis>suffixing</emphasis> of multi-label names.
284 (Search domains are nevertheless used for lookup <emphasis>routing</emphasis>, for names that were
285 originally specified as single-label or multi-label.) Any name with at least one dot is always
286 interpreted as a FQDN. <filename>nss-dns</filename> would resolve names both as relative (using search
287 domains) and absolute FQDN names. Some names would be resolved as relative first, and after that query
288 has failed, as absolute, while other names would be resolved in opposite order. The
289 <varname>ndots</varname> option in <filename>/etc/resolv.conf</filename> was used to control how many
290 dots the name needs to have to be resolved as relative first. This stub resolver does not implement
9273d8e6
ZJS
291 this at all: multi-label names are only resolved as FQDNs.<footnote><para>There are currently more than
292 1500 top-level domain names defined, and new ones are added regularly, often using "attractive" names
293 that are also likely to be used locally. Not looking up multi-label names in this fashion avoids
294 fragility in both directions: a valid global name could be obscured by a local name, and resolution of
295 a relative local name could suddenly break when a new top-level domain is created, or when a new
296 subdomain of a top-level domain in registered. Resolving any given name as either relative or absolute
be0d27ee 297 avoids this ambiguity.</para></footnote></para></listitem>
bace6883
ZJS
298
299 <listitem><para>This resolver has a notion of the special <literal>.local</literal> domain used for
300 MulticastDNS, and will not route queries with that suffix to unicast DNS servers unless explicitly
301 configured, see above. Also, reverse lookups for link-local addresses are not sent to unicast DNS
302 servers.</para></listitem>
303
304 <listitem><para>This resolver reads and caches <filename>/etc/hosts</filename> internally. (In other
305 words, <filename>nss-resolve</filename> replaces <filename>nss-files</filename> in addition to
306 <filename>nss-dns</filename>). Entries in <filename>/etc/hosts</filename> have highest priority.</para>
307 </listitem>
308
309 <listitem><para>This resolver also implements LLMNR and MulticastDNS in addition to the classic unicast
310 DNS protocol, and will resolve single-label names using LLMNR (when enabled) and names ending in
311 <literal>.local</literal> using MulticastDNS (when enabled).</para></listitem>
312
313 <listitem><para>Environment variables <varname>$LOCALDOMAIN</varname> and
314 <varname>$RES_OPTIONS</varname> described in
d8096172
ZJS
315 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
316 are not supported currently.</para></listitem>
612a91c1
LP
317
318 <listitem><para>The <filename>nss-dns</filename> resolver maintains little state between subsequent DNS
319 queries, and for each query always talks to the first listed DNS server from
320 <filename>/etc/resolv.conf</filename> first, and on failure continues with the next until reaching the
321 end of the list which is when the query fails. The resolver in
322 <filename>systemd-resolved.service</filename> however maintains state, and will continuously talk to
323 the same server for all queries on a particular lookup scope until some form of error is seen at which
324 point it switches to the next, and then continuously stays with it for all queries on the scope until
325 the next failure, and so on, eventually returning to the first configured server. This is done to
326 optimize lookup times, in particular given that the resolver typically must first probe server feature
327 sets when talking to a server, which is time consuming. This different behaviour implies that listed
328 DNS servers per lookup scope must be equivalent in the zones they serve, so that sending a query to one
329 of them will yield the same results as sending it to another configured DNS server.</para></listitem>
bace6883
ZJS
330 </itemizedlist>
331 </refsect1>
332
b541146b
LP
333 <refsect1>
334 <title><filename>/etc/resolv.conf</filename></title>
335
e6b2d948 336 <para>Four modes of handling <filename>/etc/resolv.conf</filename> (see
0a07667d 337 <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>) are
b541146b
LP
338 supported:</para>
339
340 <itemizedlist>
e6b2d948 341 <listitem><para><command>systemd-resolved</command> maintains the
b0fb800c 342 <filename>/run/systemd/resolve/stub-resolv.conf</filename> file for compatibility with traditional
5e81e84c 343 Linux programs. This file lists the 127.0.0.53 DNS stub (see above) as the only DNS server. It also
344 contains a list of search domains that are in use by systemd-resolved. The list of search domains is
345 always kept up-to-date. Note that <filename>/run/systemd/resolve/stub-resolv.conf</filename> should not
346 be used directly by applications, but only through a symlink from
347 <filename>/etc/resolv.conf</filename>. This file may be symlinked from
b0fb800c
ZJS
348 <filename>/etc/resolv.conf</filename> in order to connect all local clients that bypass local DNS APIs
349 to <command>systemd-resolved</command> with correct search domains settings. This mode of operation is
e6b2d948
DJL
350 recommended.</para></listitem>
351
b541146b
LP
352 <listitem><para>A static file <filename>/usr/lib/systemd/resolv.conf</filename> is provided that lists
353 the 127.0.0.53 DNS stub (see above) as only DNS server. This file may be symlinked from
b0fb800c
ZJS
354 <filename>/etc/resolv.conf</filename> in order to connect all local clients that bypass local DNS APIs
355 to <command>systemd-resolved</command>. This file does not contain any search domains.
356 </para></listitem>
b541146b
LP
357
358 <listitem><para><command>systemd-resolved</command> maintains the
359 <filename>/run/systemd/resolve/resolv.conf</filename> file for compatibility with traditional Linux
b0fb800c
ZJS
360 programs. This file may be symlinked from <filename>/etc/resolv.conf</filename> and is always kept
361 up-to-date, containing information about all known DNS servers. Note the file format's limitations: it
362 does not know a concept of per-interface DNS servers and hence only contains system-wide DNS server
363 definitions. Note that <filename>/run/systemd/resolve/resolv.conf</filename> should not be used
364 directly by applications, but only through a symlink from <filename>/etc/resolv.conf</filename>. If
365 this mode of operation is used local clients that bypass any local DNS API will also bypass
366 <command>systemd-resolved</command> and will talk directly to the known DNS servers.</para></listitem>
367
368 <listitem><para>Alternatively, <filename>/etc/resolv.conf</filename> may be managed by other packages,
369 in which case <command>systemd-resolved</command> will read it for DNS configuration data. In this mode
370 of operation <command>systemd-resolved</command> is consumer rather than provider of this configuration
b541146b
LP
371 file. </para></listitem>
372 </itemizedlist>
373
b0fb800c
ZJS
374 <para>Note that the selected mode of operation for this file is detected fully automatically, depending
375 on whether <filename>/etc/resolv.conf</filename> is a symlink to
376 <filename>/run/systemd/resolve/resolv.conf</filename> or lists 127.0.0.53 as DNS server.</para>
b541146b
LP
377 </refsect1>
378
2c7284a9
LP
379 <refsect1>
380 <title>Signals</title>
381
382 <variablelist>
383 <varlistentry>
384 <term><constant>SIGUSR1</constant></term>
385
d55b0463 386 <listitem><para>Upon reception of the <constant>SIGUSR1</constant> process signal
b0fb800c
ZJS
387 <command>systemd-resolved</command> will dump the contents of all DNS resource record caches it
388 maintains, as well as all feature level information it learnt about configured DNS servers into the
ec07c3c8
AK
389 system logs.</para>
390
391 <xi:include href="version-info.xml" xpointer="v231"/></listitem>
2c7284a9
LP
392 </varlistentry>
393
394 <varlistentry>
395 <term><constant>SIGUSR2</constant></term>
396
d55b0463 397 <listitem><para>Upon reception of the <constant>SIGUSR2</constant> process signal
b0fb800c
ZJS
398 <command>systemd-resolved</command> will flush all caches it maintains. Note that it should normally
399 not be necessary to request this explicitly – except for debugging purposes – as
400 <command>systemd-resolved</command> flushes the caches automatically anyway any time the host's
401 network configuration changes. Sending this signal to <command>systemd-resolved</command> is
402 equivalent to the <command>resolvectl flush-caches</command> command, however the latter is
ec07c3c8
AK
403 recommended since it operates in a synchronous way.</para>
404
405 <xi:include href="version-info.xml" xpointer="v231"/></listitem>
d55b0463
LP
406 </varlistentry>
407
408 <varlistentry>
409 <term><constant>SIGRTMIN+1</constant></term>
410
411 <listitem><para>Upon reception of the <constant>SIGRTMIN+1</constant> process signal
412 <command>systemd-resolved</command> will forget everything it learnt about the configured DNS
b0fb800c
ZJS
413 servers. Specifically any information about server feature support is flushed out, and the server
414 feature probing logic is restarted on the next request, starting with the most fully featured
415 level. Note that it should normally not be necessary to request this explicitly – except for
416 debugging purposes – as <command>systemd-resolved</command> automatically forgets learnt information
417 any time the DNS server configuration changes. Sending this signal to
418 <command>systemd-resolved</command> is equivalent to the <command>resolvectl
419 reset-server-features</command> command, however the latter is recommended since it operates in a
ec07c3c8
AK
420 synchronous way.</para>
421
422 <xi:include href="version-info.xml" xpointer="v235"/></listitem>
2c7284a9 423 </varlistentry>
14a52176
LB
424
425 <varlistentry>
426 <term><constant>SIGHUP</constant></term>
427
428 <listitem><para>Upon reception of the <constant>SIGHUP</constant> process signal
429 <command>systemd-resolved</command> will flush all caches it maintains, drop all open TCP
430 connections (if any), and reload its configuration files.</para>
431
432 <xi:include href="version-info.xml" xpointer="v256"/></listitem>
433 </varlistentry>
2c7284a9
LP
434 </variablelist>
435 </refsect1>
436
116687f2
LP
437 <refsect1>
438 <title>Credentials</title>
439
440 <para><command>systemd-resolved</command> supports the service credentials logic as implemented by
bbfb25f4 441 <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname>
658dc909 442 (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
116687f2
LP
443 details). The following credentials are used when passed in:</para>
444
8914f7e8 445 <variablelist class='system-credentials'>
116687f2
LP
446 <varlistentry>
447 <term><varname>network.dns</varname></term>
448 <term><varname>network.search_domains</varname></term>
449
450 <listitem><para>May contain a space separated list of DNS server IP addresses and DNS search
451 domains. This information is only used when no explicit configuration via
452 <filename>/etc/systemd/resolved.conf</filename>, <filename>/etc/resolv.conf</filename> or the kernel
ec07c3c8
AK
453 command line has been provided.</para>
454
455 <xi:include href="version-info.xml" xpointer="v253"/></listitem>
116687f2
LP
456 </varlistentry>
457 </variablelist>
458 </refsect1>
459
460 <refsect1>
461 <title>Kernel Command Line</title>
462
463 <para><command>systemd-resolved</command> also honours two kernel command line options:</para>
464
465 <variablelist class='kernel-commandline-options'>
466 <varlistentry>
467 <term><varname>nameserver=</varname></term>
468 <term><varname>domain=</varname></term>
469
470 <listitem><para>Takes the IP address of a DNS server (in case of <varname>nameserver=</varname>), and
471 a DNS search domain (in case of <varname>domain=</varname>). May be used multiple times, to define
472 multiple DNS servers/search domains. If either of these options are specified
473 <filename>/etc/resolv.conf</filename> will not be read and the <varname>DNS=</varname> and
474 <varname>Domains=</varname> settings of
475 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
476 will be ignored. These two kernel command line options hence override system
ec07c3c8
AK
477 configuration.</para>
478
479 <xi:include href="version-info.xml" xpointer="v253"/></listitem>
116687f2
LP
480 </varlistentry>
481 </variablelist>
482 </refsect1>
483
bef84b81
LP
484 <refsect1>
485 <title>IP Ports</title>
486
487 <para>The <command>systemd-resolved</command> service listens on the following IP ports:</para>
488
489 <itemizedlist>
490 <listitem><para>Port 53 on IPv4 addresses 127.0.0.53 and 127.0.0.54 (both are on the local loopback
491 interface <literal>lo</literal>). This is the local DNS stub, as discussed above. Both UDP and TCP are
492 covered.</para></listitem>
493
494 <listitem><para>Port 5353 on all local addresses, both IPv4 and IPv6 (0.0.0.0 and ::0), for
495 MulticastDNS on UDP. Note that even though the socket is bound to all local interfaces via the selected
496 "wildcard" IP addresses, the incoming datagrams are filtered by the network interface they are coming
497 in on, and separate MulticastDNS link-local scopes are maintained for each, taking into consideration
498 whether MulticastDNS is enabled for the interface or not.</para></listitem>
499
500 <listitem><para>Port 5355 on all local addresses, both IPv4 and IP6 (0.0.0.0 and ::0), for LLMNR, on
501 both TCP and UDP. As with MulticastDNS filtering by incoming network interface is applied.</para></listitem>
502 </itemizedlist>
503 </refsect1>
504
798d3a52
ZJS
505 <refsect1>
506 <title>See Also</title>
13a69c12
DT
507 <para><simplelist type="inline">
508 <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
509 <member><citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
510 <member><citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
511 <member><citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
512 <member><citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
513 <member><citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
514 <member><citerefentry project='man-pages'><refentrytitle>hosts</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
515 <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
516 <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
517 </simplelist></para>
798d3a52 518 </refsect1>
091a364c
TG
519
520</refentry>