3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
5 <!ENTITY % entities SYSTEM "custom-entities.ent" >
8 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
10 <refentry id="org.freedesktop.resolve1" conditional='ENABLE_RESOLVE'
11 xmlns:xi="http://www.w3.org/2001/XInclude">
13 <title>org.freedesktop.resolve1</title>
14 <productname>systemd</productname>
18 <refentrytitle>org.freedesktop.resolve1</refentrytitle>
19 <manvolnum>5</manvolnum>
23 <refname>org.freedesktop.resolve1</refname>
24 <refpurpose>The D-Bus interface of systemd-resolved</refpurpose>
28 <title>Introduction</title>
31 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
32 is a system service that provides hostname resolution and caching using DNS, LLMNR, and mDNS. It also
33 does DNSSEC validation. This page describes the resolve semantics and the D-Bus interface.</para>
35 <para>This page contains an API reference only. If you are looking for a longer explanation how to use
36 this API, please consult
37 <ulink url="https://wiki.freedesktop.org/www/Software/systemd/writing-network-configuration-managers">
38 Writing Network Configuration Managers</ulink> and
39 <ulink url="https://wiki.freedesktop.org/www/Software/systemd/writing-resolver-clients">Writing Resolver
45 <title>The Manager Object</title>
47 <para>The service exposes the following interfaces on the Manager object on the bus:</para>
49 <programlisting executable="systemd-resolved" node="/org/freedesktop/resolve1" interface="org.freedesktop.resolve1.Manager">
50 node /org/freedesktop/resolve1 {
51 interface org.freedesktop.resolve1.Manager {
53 ResolveHostname(in i ifindex,
57 out a(iiay) addresses,
60 ResolveAddress(in i ifindex,
66 ResolveRecord(in i ifindex,
73 ResolveService(in i ifindex,
79 out a(qqqsa(iiay)s) srv_data,
83 out s canonical_domain,
87 SetLinkDNS(in i ifindex,
89 SetLinkDNSEx(in i ifindex,
90 in a(iayqs) addresses);
91 SetLinkDomains(in i ifindex,
93 SetLinkDefaultRoute(in i ifindex,
95 SetLinkLLMNR(in i ifindex,
97 SetLinkMulticastDNS(in i ifindex,
99 SetLinkDNSOverTLS(in i ifindex,
101 SetLinkDNSSEC(in i ifindex,
103 SetLinkDNSSECNegativeTrustAnchors(in i ifindex,
105 RevertLink(in i ifindex);
106 RegisterService(in s name,
110 in q service_priority,
112 in aa{say} txt_datas,
114 UnregisterService(in o service_path);
117 ResetServerFeatures();
119 readonly s LLMNRHostname = '...';
120 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
121 readonly s LLMNR = '...';
122 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
123 readonly s MulticastDNS = '...';
124 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
125 readonly s DNSOverTLS = '...';
126 readonly a(iiay) DNS = [...];
127 readonly a(iiayqs) DNSEx = [...];
128 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
129 readonly a(iiay) FallbackDNS = [...];
130 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
131 readonly a(iiayqs) FallbackDNSEx = [...];
132 readonly (iiay) CurrentDNSServer = ...;
133 readonly (iiayqs) CurrentDNSServerEx = ...;
134 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
135 readonly a(isb) Domains = [...];
136 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
137 readonly (tt) TransactionStatistics = ...;
138 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
139 readonly (ttt) CacheStatistics = ...;
140 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
141 readonly s DNSSEC = '...';
142 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
143 readonly (tttt) DNSSECStatistics = ...;
144 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
145 readonly b DNSSECSupported = ...;
146 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
147 readonly as DNSSECNegativeTrustAnchors = ['...', ...];
148 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
149 readonly s DNSStubListener = '...';
150 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
151 readonly s ResolvConfMode = '...';
153 interface org.freedesktop.DBus.Peer { ... };
154 interface org.freedesktop.DBus.Introspectable { ... };
155 interface org.freedesktop.DBus.Properties { ... };
159 <!--Autogenerated cross-references for systemd.directives, do not edit-->
161 <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Manager"/>
163 <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Manager"/>
165 <variablelist class="dbus-method" generated="True" extra-ref="ResolveHostname()"/>
167 <variablelist class="dbus-method" generated="True" extra-ref="ResolveAddress()"/>
169 <variablelist class="dbus-method" generated="True" extra-ref="ResolveRecord()"/>
171 <variablelist class="dbus-method" generated="True" extra-ref="ResolveService()"/>
173 <variablelist class="dbus-method" generated="True" extra-ref="GetLink()"/>
175 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNS()"/>
177 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSEx()"/>
179 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDomains()"/>
181 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDefaultRoute()"/>
183 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkLLMNR()"/>
185 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkMulticastDNS()"/>
187 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSOverTLS()"/>
189 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSEC()"/>
191 <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSECNegativeTrustAnchors()"/>
193 <variablelist class="dbus-method" generated="True" extra-ref="RevertLink()"/>
195 <variablelist class="dbus-method" generated="True" extra-ref="RegisterService()"/>
197 <variablelist class="dbus-method" generated="True" extra-ref="UnregisterService()"/>
199 <variablelist class="dbus-method" generated="True" extra-ref="ResetStatistics()"/>
201 <variablelist class="dbus-method" generated="True" extra-ref="FlushCaches()"/>
203 <variablelist class="dbus-method" generated="True" extra-ref="ResetServerFeatures()"/>
205 <variablelist class="dbus-property" generated="True" extra-ref="LLMNRHostname"/>
207 <variablelist class="dbus-property" generated="True" extra-ref="LLMNR"/>
209 <variablelist class="dbus-property" generated="True" extra-ref="MulticastDNS"/>
211 <variablelist class="dbus-property" generated="True" extra-ref="DNSOverTLS"/>
213 <variablelist class="dbus-property" generated="True" extra-ref="DNS"/>
215 <variablelist class="dbus-property" generated="True" extra-ref="DNSEx"/>
217 <variablelist class="dbus-property" generated="True" extra-ref="FallbackDNS"/>
219 <variablelist class="dbus-property" generated="True" extra-ref="FallbackDNSEx"/>
221 <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServer"/>
223 <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServerEx"/>
225 <variablelist class="dbus-property" generated="True" extra-ref="Domains"/>
227 <variablelist class="dbus-property" generated="True" extra-ref="TransactionStatistics"/>
229 <variablelist class="dbus-property" generated="True" extra-ref="CacheStatistics"/>
231 <variablelist class="dbus-property" generated="True" extra-ref="DNSSEC"/>
233 <variablelist class="dbus-property" generated="True" extra-ref="DNSSECStatistics"/>
235 <variablelist class="dbus-property" generated="True" extra-ref="DNSSECSupported"/>
237 <variablelist class="dbus-property" generated="True" extra-ref="DNSSECNegativeTrustAnchors"/>
239 <variablelist class="dbus-property" generated="True" extra-ref="DNSStubListener"/>
241 <variablelist class="dbus-property" generated="True" extra-ref="ResolvConfMode"/>
243 <!--End of Autogenerated section-->
246 <title>Methods</title>
248 <para><function>ResolveHostname()</function> takes a hostname and resolves it to one or more IP
249 addresses. As parameters it takes the Linux network interface index to execute the query on, or 0 if
250 it may be done on any suitable interface. The <varname>name</varname> parameter specifies the hostname
251 to resolve. Note that if required, IDNA conversion is applied to this name unless it is resolved via
252 LLMNR or MulticastDNS. The <varname>family</varname> parameter limits the results to a specific address
253 family. It may be <constant>AF_INET</constant>, <constant>AF_INET6</constant> or
254 <constant>AF_UNSPEC</constant>. If <constant>AF_UNSPEC</constant> is specified (recommended), both
255 kinds are retrieved, subject to local network configuration (i.e. if no local, routable IPv6 address is
256 found, no IPv6 address is retrieved; and similarly for IPv4). A 64-bit <varname>flags</varname> field
257 may be used to alter the behaviour of the resolver operation (see below). The method returns an array
258 of address records. Each address record consists of the interface index the address belongs to, an
259 address family as well as a byte array with the actual IP address data (which either has 4 or 16
260 elements, depending on the address family). The returned address family will be one of
261 <constant>AF_INET</constant> or <constant>AF_INET6</constant>. For IPv6, the returned address interface
262 index should be used to initialize the .sin6_scope_id field of a
263 <structname>struct sockaddr_in6</structname> instance to permit support for resolution to link-local IP
264 addresses. The address array is followed by the canonical name of the host, which may or may not be
265 identical to the resolved hostname. Finally, a 64-bit <varname>flags</varname> field is returned that
266 is defined similarly to the <varname>flags</varname> field that was passed in, but contains information
267 about the resolved data (see below). If the hostname passed in is an IPv4 or IPv6 address formatted as
268 string, it is parsed, and the result is returned. In this case, no network communication is
271 <para><function>ResolveAddress()</function> executes the reverse operation: it takes an IP address and
272 acquires one or more hostnames for it. As parameters it takes the interface index to execute the query
273 on, or <constant>0</constant> if all suitable interfaces are OK. The <varname>family</varname>
274 parameter indicates the address family of the IP address to resolve. It may be either
275 <constant>AF_INET</constant> or <constant>AF_INET6</constant>. The <varname>address</varname> parameter
276 takes the raw IP address data (as either a 4 or 16 byte array). The <varname>flags</varname> input
277 parameter may be used to alter the resolver operation (see below). The method returns an array of name
278 records, each consisting of an interface index and a hostname. The <varname>flags</varname> output
279 field contains additional information about the resolver operation (see below).</para>
281 <para><function>ResolveRecord()</function> takes a DNS resource record (RR) type, class and name, and
282 retrieves the full resource record set (RRset), including the RDATA, for it. As parameter it takes the
283 Linux network interface index to execute the query on, or <constant>0</constant> if it may be done on
284 any suitable interface. The <varname>name</varname> parameter specifies the RR domain name to look up
285 (no IDNA conversion is applied), followed by the 16-bit class and type fields (which may be
286 ANY). Finally, a <varname>flags</varname> field may be passed in to alter behaviour of the look-up (see
287 below). On completion, an array of RR items is returned. Each array entry consists of the network interface
288 index the RR was discovered on, the type and class field of the RR found, and a byte array of the raw
289 RR discovered. The raw RR data starts with the RR's domain name, in the original casing, followed
290 by the RR type, class, TTL and RDATA, in the binary format documented in
291 <ulink url="https://www.ietf.org/rfc/rfc1035.txt">RFC 1035</ulink>. For RRs that support name
292 compression in the payload (such as MX or PTR), the compression is expanded in the returned
295 <para>Note that currently, the class field has to be specified as IN or ANY. Specifying a different
296 class will return an error indicating that look-ups of this kind are unsupported. Similarly, some
297 special types are not supported either (AXFR, OPT, …). While <filename>systemd-resolved</filename> parses and validates resource
298 records of many types, it is crucial that clients using this API understand that the RR data originates
299 from the network and should be thoroughly validated before use.</para>
301 <para><function>ResolveService()</function> may be used to resolve a DNS
302 <constant class="dns">SRV</constant> service record, as well as the hostnames referenced in it, and
303 possibly an accompanying DNS-SD <constant class="dns">TXT</constant> record containing additional
304 service metadata. The primary benefit of using this method over <function>ResolveRecord()</function>
305 specifying the <constant class="dns">SRV</constant> type is that it will resolve the
306 <constant class="dns">SRV</constant> and <constant class="dns">TXT</constant> RRs as well as the
307 hostnames referenced in the SRV in a single operation. As parameters it takes a Linux network interface
308 index, a service name, a service type and a service domain. This method may be invoked in three
309 different modes:</para>
312 <listitem><para>To resolve a DNS-SD service, specify the service name (e.g. <literal>Lennart's
313 Files</literal>), the service type (e.g. <literal>_webdav._tcp</literal>) and the domain to search in
314 (e.g. <literal>local</literal>) as the three service parameters. The service name must be in UTF-8
315 format, and no IDNA conversion is applied to it in this mode (as mandated by the DNS-SD
316 specifications). However, if necessary, IDNA conversion is applied to the domain parameter.</para>
319 <listitem><para>To resolve a plain <constant class="dns">SRV</constant> record, set the service name
320 parameter to the empty string and set the service type and domain properly. (IDNA conversion is
321 applied to the domain, if necessary.)</para></listitem>
323 <listitem><para>Alternatively, leave both the service name and type empty and specify the full domain
324 name of the <constant class="dns">SRV</constant> record (i.e. prefixed with the service type) in the
325 domain parameter. (No IDNA conversion is applied in this mode.)</para></listitem>
328 <para>The <varname>family</varname> parameter of the <function>ResolveService()</function> method encodes
329 the desired family of the addresses to resolve (use <constant>AF_INET</constant>,
330 <constant>AF_INET6</constant>, or <constant>AF_UNSPEC</constant>). If this is enabled (Use the
331 <constant>NO_ADDRESS</constant> flag to turn address resolution off, see below). The
332 <varname>flags</varname> parameter takes a couple of flags that may be used to alter the resolver
335 <para>On completion, <function>ResolveService()</function> returns an array of
336 <constant class="dns">SRV</constant> record structures. Each items consisting of the priority, weight and port
337 fields as well as the hostname to contact, as encoded in the <constant class="dns">SRV</constant>
338 record. Immediately following is an array of the addresses of this hostname, with each item consisting
339 of the interface index, the address family and the address data in a byte array. This address array is
340 followed by the canonicalized hostname. After this array of <constant class="dns">SRV</constant> record
341 structures an array of byte arrays follows that encodes the TXT RR strings, in case DNS-SD look-ups are
342 enabled. The next parameters are the canonical service name, type and domain. This may or may not be
343 identical to the parameters passed in. Finally, a <varname>flags</varname> field is returned that
344 contains information about the resolver operation performed.</para>
346 <para>The <function>ResetStatistics()</function> method resets the various statistics counters that
347 <filename>systemd-resolved</filename> maintains to zero. (For details, see the statistics properties below.)</para>
349 <para>The <function>GetLink()</function> method takes a network interface index and returns the object
350 path to the <interfacename>org.freedesktop.resolve1.Link</interfacename> object corresponding to it.
353 <para>The <function>SetLinkDNS()</function> method sets the DNS servers to use on a specific
354 interface. This method (and the following ones) may be used by network management software to configure
355 per-interface DNS settings. It takes a network interface index as well as an array of DNS server IP
356 address records. Each array item consists of an address family (either <constant>AF_INET</constant> or
357 <constant>AF_INET6</constant>), followed by a 4-byte or 16-byte array with the raw address data. This
358 method is a one-step shortcut for retrieving the Link object for a network interface using
359 <function>GetLink()</function> (see above) and then invoking the <function>SetDNS()</function> method
360 (see below) on it.</para>
362 <para><function>SetLinkDNSEx()</function> is similar to <function>SetLinkDNS()</function>, but allows
363 an IP port (instead of the default 53) and DNS name to be specified for each DNS server. The server
364 name is used for Server Name Indication (SNI), which is useful when DNS-over-TLS is
365 used. C.f. <varname>DNS=</varname> in
366 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
369 <para><function>SetLinkDefaultRoute()</function> specifies whether the link shall be used as the
370 default route for name queries. See the description of name routing in
371 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
374 <para>The <function>SetLinkDomains()</function> method sets the search and routing domains to use on a
375 specific network interface for DNS look-ups. It takes a network interface index and an array of domains,
376 each with a boolean parameter indicating whether the specified domain shall be used as a search domain
377 (false), or just as a routing domain (true). Search domains are used for qualifying single-label names into
378 FQDN when looking up hostnames, as well as for making routing decisions on which interface to send
379 queries ending in the domain to. Routing domains are only used for routing decisions and not used for single-label
380 name qualification. Pass the search domains in the order they should be used.</para>
382 <para>The <function>SetLinkLLMNR()</function> method enables or disables LLMNR support on a specific
383 network interface. It takes a network interface index as well as a string that may either be empty or one of
384 <literal>yes</literal>, <literal>no</literal> or <literal>resolve</literal>. If empty, the systemd-wide
385 default LLMNR setting is used. If <literal>yes</literal>, LLMNR is used for resolution of single-label
386 names and the local hostname is registered on all local LANs for LLMNR resolution by peers. If
387 <literal>no</literal>, LLMNR is turned off fully on this interface. If <literal>resolve</literal>, LLMNR
388 is only enabled for resolving names, but the local hostname is not registered for other peers to
391 <para>Similarly, the <function>SetLinkMulticastDNS()</function> method enables or disables MulticastDNS
392 support on a specific interface. It takes the same parameters as <function>SetLinkLLMNR()</function>
393 described above.</para>
395 <para>The <function>SetLinkDNSSEC()</function> method enables or disables DNSSEC validation on a
396 specific network interface. It takes a network interface index as well as a string that may either be
397 empty or one of <literal>yes</literal>, <literal>no</literal>, or <literal>allow-downgrade</literal>. When
398 empty, the system-wide default DNSSEC setting is used. If <literal>yes</literal>, full DNSSEC validation
399 is done for all look-ups. If the selected DNS server does not support DNSSEC, look-ups will fail if this
400 mode is used. If <literal>no</literal>, DNSSEC validation is fully disabled. If
401 <literal>allow-downgrade</literal>, DNSSEC validation is enabled, but is turned off automatically if the
402 selected server does not support it (thus opening up behaviour to downgrade attacks). Note that DNSSEC
403 only applies to traditional DNS, not to LLMNR or MulticastDNS.</para>
405 <para>The <function>SetLinkDNSSECNegativeTrustAnchors()</function> method may be used to configure DNSSEC
406 Negative Trust Anchors (NTAs) for a specific network interface. It takes a network interface index and a
407 list of domains as arguments.</para>
409 <para>The <function>SetLinkDNSOverTLS()</function> method enables or disables DNS-over-TLS.
410 C.f. <varname>DNSOverTLS=</varname> in
411 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
414 <para>Network management software integrating with <filename>systemd-resolved</filename> should call
415 <function>SetLinkDNS()</function> or <function>SetLinkDNSEx()</function>,
416 <function>SetLinkDefaultRoute()</function>, <function>SetLinkDomains()</function> and others after the
417 interface appeared in the kernel (and thus after a network interface index has been assigned), but
418 before the network interfaces is activated (<constant>IFF_UP</constant> set) so that all settings take
419 effect during the full time the network interface is up. It is safe to alter settings while the
420 interface is up, however. Use <function>RevertLink()</function> (described below) to reset all
421 per-interface settings.</para>
423 <para>The <function>RevertLink()</function> method may be used to revert all per-link settings
424 described above to the defaults.</para>
426 <para>The <function>FlushCaches()</function> flushes all resource record caches maintained by the
427 resolver, and ensures that any subsequent lookups re-request their responses from their sources.</para>
429 <para>The <function>ResetServerFeatures()</function> flushes any feature information learned about
430 remote DNS servers. This ensures that subsequent lookups will be initially attempted at the highest DNS
431 protocol feature level again, possibly requiring a (potentially slow) downgrade cycle to recognize the
432 supported feature level again.</para>
434 <para>The <function>RegisterService()</function> method may be used to register a DNS-SD service on the
435 host. This functionality is closely related to the functionality provided by
436 <citerefentry><refentrytitle>systemd.dnssd</refentrytitle><manvolnum>5</manvolnum></citerefentry>
437 files. It takes a server identifier string as first parameter (this is jus a local identifier, and
438 should be chosen so that it neither collides with the basename of <filename>*.dnssd</filename> files
439 nor with names chosen by other IPC clients). It also takes a name template string for the DNS-SD
440 service name visible on the network. This string is subject to specifier expansation, as documented for
441 the <varname>Name=</varname> setting in <filename>*.dnssd</filename> files. It also takes a service
442 type string containing the DNS-SD service type, as well as an IP port, a priority/weight pair for the
443 DNS-SD SRV record. Finally, it takes an array of TXT record data. It returns an object path which may be
444 used as handle to the registered service.</para>
446 <para>The <function>UnregisterService()</function> method undoes the effect of
447 <function>RegisterService()</function> and deletes a DNS-SD service previously created via IPC
451 <title>The Flags Parameter</title>
453 <para>The four methods above accept and return a 64-bit flags value. In most cases passing 0 is sufficient
454 and recommended. However, the following flags are defined to alter the look-up:</para>
456 <programlisting>/* Input+Output: Protocol/scope */
457 #define SD_RESOLVED_DNS (UINT64_C(1) << 0)
458 #define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1)
459 #define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2)
460 #define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3)
461 #define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4)
463 /* Input: Restrictions */
464 #define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5)
465 #define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6)
466 #define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7)
467 #define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8)
468 #define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10)
469 #define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11)
470 #define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12)
471 #define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13)
472 #define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14)
473 #define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15)
474 #define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24)
476 /* Output: Security */
477 #define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9)
478 #define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18)
481 #define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19)
482 #define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20)
483 #define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21)
484 #define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22)
485 #define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23)
488 <para>On input, the first five flags control the protocols to use for the look-up. They refer to
489 classic unicast DNS, LLMNR via IPv4/UDP and IPv6/UDP respectively, as well as MulticastDNS via
490 IPv4/UDP and IPv6/UDP. If all of these five bits are off on input (which is strongly recommended) the
491 look-up will be done via all suitable protocols for the specific look-up. Note that these flags
492 operate as filter only, but cannot force a look-up to be done via a protocol. Specifically,
493 <filename>systemd-resolved</filename> will only route look-ups within the .local TLD to MulticastDNS
494 (plus some reverse look-up address domains), and single-label names to LLMNR (plus some reverse
495 address lookup domains). It will route neither of these to Unicast DNS servers. Also, it will do
496 LLMNR and Multicast DNS only on interfaces suitable for multicast.</para>
498 <para>On output, these five flags indicate which protocol was used to execute the operation, and
499 hence where the data was found.</para>
501 <para>The primary use cases for these five flags are follow-up look-ups based on DNS data retrieved
502 earlier. In this case it is often a good idea to limit the follow-up look-up to the protocol that was
503 used to discover the first DNS result.</para>
505 <para>The NO_CNAME flag controls whether CNAME/DNAME resource records shall be followed during the
506 look-up. This flag is only available at input, none of the functions will return it on output. If a
507 CNAME/DNAME RR is discovered while resolving a hostname, an error is returned instead. By default,
508 when the flag is off, CNAME/DNAME RRs are followed.</para>
510 <para>The NO_TXT and NO_ADDRESS flags only influence operation of the
511 <function>ResolveService()</function> method. They are only defined for input, not output. If NO_TXT
512 is set, the DNS-SD TXT RR look-up is not done in the same operation. If NO_ADDRESS is set, the
513 discovered hostnames are not implicitly translated to their addresses.</para>
515 <para>The NO_SEARCH flag turns off the search domain logic. It is only defined for input in
516 <function>ResolveHostname()</function>. When specified, single-label hostnames are not qualified
517 using defined search domains, if any are configured. Note that <function>ResolveRecord()</function>
518 will never qualify single-label domain names using search domains. Also note that multi-label
519 hostnames are never subject to search list expansion.</para>
521 <para>NO_VALIDATE can be set to disable validation via DNSSEC even if it would normally be
524 <para>The next six flags allow disabling certain sources during resolution. NO_SYNTHESIZE disables
525 synthetic records, e.g. the local host name, see section SYNTHETIC RECORDS in
526 <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
527 for more information. NO_CACHE disables the use of the cache of previously resolved records. NO_ZONE
528 disables answers using locally registered public LLMNR/mDNS resource records. NO_TRUST_ANCHOR
529 disables answers using locally configured trust anchors. NO_NETWORK requires all answers to be
530 provided without using the network, i.e. either from local sources or the cache. NO_STALE flag
531 can be set to disable answering request with stale records.</para>
533 <para>The AUTHENTICATED bit is defined only in the output flags of the four functions. If set, the
534 returned data has been fully authenticated. Specifically, this bit is set for all DNSSEC-protected
535 data for which a full trust chain may be established to a trusted domain anchor. It is also set for
536 locally synthesized data, such as <literal>localhost</literal> or data from
537 <filename>/etc/hosts</filename>. Moreover, it is set for all LLMNR or mDNS RRs which originate from
538 the local host. Applications that require authenticated RR data for operation should check this flag
539 before trusting the data. Note that <filename>systemd-resolved</filename> will never return
540 invalidated data, hence this flag simply allows one to discern the cases where data is known to be
541 trusted, or where there is proof that the data is "rightfully" unauthenticated (which includes cases
542 where the underlying protocol or server does not support authenticating data).</para>
544 <para>CONFIDENTIAL means the query was resolved via encrypted channels or never left this
547 <para>The next five bits flags are used in output and provide information about the origin of the
548 answer. FROM_SYNTHETIC means the query was (at least partially) synthesized locally. FROM_CACHE means
549 the query was answered (at least partially) using the cache. FROM_ZONE means the query was answered
550 (at least partially) based on public, locally registered records. FROM_TRUST_ANCHOR means the query
551 was answered (at least partially) using local trust anchors. FROM_NETWORK means the query was
552 answered (at least partially) using the network.</para>
557 <title>Properties</title>
559 <para>The <varname>LLMNR</varname> and <varname>MulticastDNS</varname> properties report whether LLMNR
560 and MulticastDNS are (globally) enabled. Each may be one of <literal>yes</literal>,
561 <literal>no</literal>, and <literal>resolve</literal>. See <function>SetLinkLLMNR()</function>
562 and <function>SetLinkMulticastDNS()</function> above.</para>
564 <para><varname>LLMNRHostname</varname> contains the hostname currently exposed on the network via
565 LLMNR. It usually follows the system hostname as may be queried via
566 <citerefentry project="man-pages"><refentrytitle>gethostname</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
567 but may differ if a conflict is detected on the network.</para>
569 <para><varname>DNS</varname> and <varname>DNSEx</varname> contain arrays of all DNS servers currently
570 used by <filename>systemd-resolved</filename>. <varname>DNS</varname> contains information similar to
571 the DNS server data in <filename>/run/systemd/resolve/resolv.conf</filename>. Each structure in the
572 array consists of a numeric network interface index, an address family, and a byte array containing the
573 DNS server address (either 4 bytes in length for IPv4 or 16 bytes in lengths for IPv6).
574 <varname>DNSEx</varname> is similar, but additionally contains the IP port and server name (used for
575 Server Name Indication, SNI). Both arrays contain DNS servers configured system-wide, including those
576 possibly read from a foreign <filename>/etc/resolv.conf</filename> or the <varname>DNS=</varname>
577 setting in <filename>/etc/systemd/resolved.conf</filename>, as well as per-interface DNS server
578 information either retrieved from
579 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
580 or configured by external software via <function>SetLinkDNS()</function> or
581 <function>SetLinkDNSEx()</function> (see above). The network interface index will be 0 for the
582 system-wide configured services and non-zero for the per-link servers.</para>
584 <para><varname>FallbackDNS</varname> and <varname>FallbackDNSEx</varname> contain arrays of all DNS
585 servers configured as fallback servers, if any, using the same format as <varname>DNS</varname> and
586 <varname>DNSEx</varname> described above. See the description of <varname>FallbackDNS=</varname> in
587 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
588 the description of when those servers are used.</para>
590 <para><varname>CurrentDNSServer</varname> and <varname>CurrentDNSServerEx</varname> specify the server
591 that is currently used for query resolution, in the same format as a single entry in the
592 <varname>DNS</varname> and <varname>DNSEx</varname> arrays described above.</para>
594 <para>Similarly, the <varname>Domains</varname> property contains an array of all search and routing
595 domains currently used by <filename>systemd-resolved</filename>. Each entry consists of a network
596 interface index (again, 0 encodes system-wide entries), the actual domain name, and whether the entry
597 is used only for routing (true) or for both routing and searching (false).</para>
599 <para>The <varname>TransactionStatistics</varname> property contains information about the number of
600 transactions <filename>systemd-resolved</filename> has processed. It contains a pair of unsigned 64-bit counters, the first
601 containing the number of currently ongoing transactions, the second the number of total transactions
602 <filename>systemd-resolved</filename> is processing or has processed. The latter value may be reset using the
603 <function>ResetStatistics()</function> method described above. Note that the number of transactions does
604 not directly map to the number of issued resolver bus method calls. While simple look-ups usually require a
605 single transaction only, more complex look-ups might result in more, for example when CNAMEs or DNSSEC
608 <para>The <varname>CacheStatistics</varname> property contains information about the executed cache
609 operations so far. It exposes three 64-bit counters: the first being the total number of current cache
610 entries (both positive and negative), the second the number of cache hits, and the third the number of
611 cache misses. The latter counters may be reset using <function>ResetStatistics()</function> (see
614 <para>The <varname>DNSSEC</varname> property specifies current status of DNSSEC validation. It is one
615 of <literal>yes</literal> (validation is enforced), <literal>no</literal> (no validation is done),
616 <literal>allow-downgrade</literal> (validation is done if the current DNS server supports it). See the
617 description of <varname>DNSSEC=</varname> in
618 <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
621 <para>The <varname>DNSSECStatistics</varname> property contains information about the DNSSEC
622 validations executed so far. It contains four 64-bit counters: the number of secure, insecure, bogus,
623 and indeterminate DNSSEC validations so far. The counters are increased for each validated RRset, and
624 each non-existence proof. The secure counter is increased for each operation that successfully verified
625 a signed reply, the insecure counter is increased for each operation that successfully verified that an
626 unsigned reply is rightfully unsigned. The bogus counter is increased for each operation where the
627 validation did not check out and the data is likely to have been tempered with. Finally the
628 indeterminate counter is increased for each operation which did not complete because the necessary keys
629 could not be acquired or the cryptographic algorithms were unknown.</para>
631 <para>The <varname>DNSSECSupported</varname> boolean property reports whether DNSSEC is enabled and
632 the selected DNS servers support it. It combines information about system-wide and per-link DNS
633 settings (see below), and only reports true if DNSSEC is enabled and supported on every interface for
634 which DNS is configured and for the system-wide settings if there are any. Note that <filename>systemd-resolved</filename> assumes
635 DNSSEC is supported by DNS servers until it verifies that this is not the case. Thus, the reported
636 value may initially be true, until the first transactions are executed.</para>
638 <para>The <varname>DNSOverTLS</varname> boolean property reports whether DNS-over-TLS is enabled.
641 <para>The <varname>ResolvConfMode</varname> property exposes how <filename>/etc/resolv.conf</filename>
642 is managed on the host. Currently, the values <literal>uplink</literal>, <literal>stub</literal>,
643 <literal>static</literal> (these three correspond to the three different files
644 <filename>systemd-resolved.service</filename> provides), <literal>foreign</literal> (the file is
645 managed by admin or another service, <filename>systemd-resolved.service</filename> just consumes it),
646 <literal>missing</literal> (<filename>/etc/resolv.conf</filename> is missing).</para>
648 <para>The <varname>DNSStubListener</varname> property reports whether the stub listener on port 53 is
649 enabled. Possible values are <literal>yes</literal> (enabled), <literal>no</literal> (disabled),
650 <literal>udp</literal> (only the UDP listener is enabled), and <literal>tcp</literal> (only the TCP
651 listener is enabled).</para>
653 <para>The <varname>DNSSECNegativeTrustAnchors</varname> property contains a list of recognized DNSSEC
654 negative trust anchors and contains a list of domains.</para>
659 <title>Link Object</title>
661 <programlisting executable="systemd-resolved" node="/org/freedesktop/resolve1/link/_1" interface="org.freedesktop.resolve1.Link">
662 node /org/freedesktop/resolve1/link/_1 {
663 interface org.freedesktop.resolve1.Link {
665 SetDNS(in a(iay) addresses);
666 SetDNSEx(in a(iayqs) addresses);
667 SetDomains(in a(sb) domains);
668 SetDefaultRoute(in b enable);
670 SetMulticastDNS(in s mode);
671 SetDNSOverTLS(in s mode);
672 SetDNSSEC(in s mode);
673 SetDNSSECNegativeTrustAnchors(in as names);
676 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
677 readonly t ScopesMask = ...;
678 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
679 readonly a(iay) DNS = [...];
680 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
681 readonly a(iayqs) DNSEx = [...];
682 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
683 readonly (iay) CurrentDNSServer = ...;
684 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
685 readonly (iayqs) CurrentDNSServerEx = ...;
686 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
687 readonly a(sb) Domains = [...];
688 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
689 readonly b DefaultRoute = ...;
690 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
691 readonly s LLMNR = '...';
692 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
693 readonly s MulticastDNS = '...';
694 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
695 readonly s DNSOverTLS = '...';
696 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
697 readonly s DNSSEC = '...';
698 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
699 readonly as DNSSECNegativeTrustAnchors = ['...', ...];
700 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
701 readonly b DNSSECSupported = ...;
703 interface org.freedesktop.DBus.Peer { ... };
704 interface org.freedesktop.DBus.Introspectable { ... };
705 interface org.freedesktop.DBus.Properties { ... };
709 <!--Autogenerated cross-references for systemd.directives, do not edit-->
711 <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Link"/>
713 <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Link"/>
715 <variablelist class="dbus-method" generated="True" extra-ref="SetDNS()"/>
717 <variablelist class="dbus-method" generated="True" extra-ref="SetDNSEx()"/>
719 <variablelist class="dbus-method" generated="True" extra-ref="SetDomains()"/>
721 <variablelist class="dbus-method" generated="True" extra-ref="SetDefaultRoute()"/>
723 <variablelist class="dbus-method" generated="True" extra-ref="SetLLMNR()"/>
725 <variablelist class="dbus-method" generated="True" extra-ref="SetMulticastDNS()"/>
727 <variablelist class="dbus-method" generated="True" extra-ref="SetDNSOverTLS()"/>
729 <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSEC()"/>
731 <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSECNegativeTrustAnchors()"/>
733 <variablelist class="dbus-method" generated="True" extra-ref="Revert()"/>
735 <variablelist class="dbus-property" generated="True" extra-ref="ScopesMask"/>
737 <variablelist class="dbus-property" generated="True" extra-ref="DNS"/>
739 <variablelist class="dbus-property" generated="True" extra-ref="DNSEx"/>
741 <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServer"/>
743 <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServerEx"/>
745 <variablelist class="dbus-property" generated="True" extra-ref="Domains"/>
747 <variablelist class="dbus-property" generated="True" extra-ref="DefaultRoute"/>
749 <variablelist class="dbus-property" generated="True" extra-ref="LLMNR"/>
751 <variablelist class="dbus-property" generated="True" extra-ref="MulticastDNS"/>
753 <variablelist class="dbus-property" generated="True" extra-ref="DNSOverTLS"/>
755 <variablelist class="dbus-property" generated="True" extra-ref="DNSSEC"/>
757 <variablelist class="dbus-property" generated="True" extra-ref="DNSSECNegativeTrustAnchors"/>
759 <variablelist class="dbus-property" generated="True" extra-ref="DNSSECSupported"/>
761 <!--End of Autogenerated section-->
763 <para>For each Linux network interface a "Link" object is created which exposes per-link DNS
764 configuration and state. Use <function>GetLink()</function> on the Manager interface to retrieve the
765 object path for a link object given the network interface index (see above).</para>
768 <title>Methods</title>
770 <para>The various methods exposed by the Link interface are equivalent to their similarly named
771 counterparts on the Manager interface. e.g. <function>SetDNS()</function> on the Link object maps to
772 <function>SetLinkDNS()</function> on the Manager object, the main difference being that the later
773 expects an interface index to be specified. Invoking the methods on the Manager interface has the
774 benefit of reducing roundtrips, as it is not necessary to first request the Link object path via
775 <function>GetLink()</function> before invoking the methods. The same relationship holds for
776 <function>SetDNSEx()</function>, <function>SetDomains()</function>,
777 <function>SetDefaultRoute()</function>, <function>SetLLMNR()</function>,
778 <function>SetMulticastDNS()</function>, <function>SetDNSOverTLS()</function>,
779 <function>SetDNSSEC()</function>, <function>SetDNSSECNegativeTrustAnchors()</function>, and
780 <function>Revert()</function>. For further details on these methods see the
781 <interfacename>Manager</interfacename> documentation above.</para>
785 <title>Properties</title>
787 <para><varname>ScopesMask</varname> defines which resolver scopes are currently active on this
788 interface. This 64-bit unsigned integer field is a bit mask consisting of a subset of the bits of the
789 flags parameter describe above. Specifically, it may have the DNS, LLMNR and MDNS bits (the latter in
790 IPv4 and IPv6 flavours) set. Each individual bit is set when the protocol applies to a specific
791 interface and is enabled for it. It is unset otherwise. Specifically, a multicast-capable interface in
792 the "UP" state with an IP address is suitable for LLMNR or MulticastDNS, and any interface that is UP and
793 has an IP address is suitable for DNS. Note the relationship of the bits exposed here with the LLMNR
794 and MulticastDNS properties also exposed on the Link interface. The latter expose what is *configured*
795 to be used on the interface, the former expose what is actually used on the interface, taking into
796 account the abilities of the interface.</para>
798 <para><varname>DNSSECSupported</varname> exposes a boolean field that indicates whether DNSSEC is
799 currently configured and in use on the interface. Note that if DNSSEC is enabled on an interface, it is
800 assumed available until it is detected that the configured server does not actually support it. Thus,
801 this property may initially report that DNSSEC is supported on an interface.</para>
803 <para><varname>DefaultRoute</varname> exposes a boolean field that indicates whether the interface will
804 be used as default route for name queries. See <function>SetLinkDefaultRoute()</function> above.</para>
806 <para>The other properties reflect the state of the various configuration settings for the link which
807 may be set with the various methods calls such as <function>SetDNS()</function> or
808 <function>SetLLMNR()</function>.</para>
813 <title>Common Errors</title>
815 <para>Many bus methods <filename>systemd-resolved</filename> exposes (in particular the resolver methods such
816 as <function>ResolveHostname()</function> on the <interfacename>Manager</interfacename> interface) may return
817 some of the following errors:</para>
820 <varlistentry><term><constant>org.freedesktop.resolve1.NoNameServers</constant></term>
821 <listitem><para>No suitable DNS servers were found to resolve a request.</para>
823 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
826 <varlistentry><term><constant>org.freedesktop.resolve1.InvalidReply</constant></term>
827 <listitem><para>A response from the selected DNS server was not understood.</para>
829 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
832 <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchRR</constant></term>
833 <listitem><para>The requested name exists, but there is no resource record of the requested type for
834 it. (This is the DNS NODATA case).</para>
836 <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry>
838 <varlistentry><term><constant>org.freedesktop.resolve1.CNameLoop</constant></term>
839 <listitem><para>The look-up failed because a CNAME or DNAME loop was detected.</para>
841 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
844 <varlistentry><term><constant>org.freedesktop.resolve1.Aborted</constant></term>
845 <listitem><para>The look-up was aborted because the selected protocol became unavailable while the
846 operation was ongoing.</para>
848 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
851 <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchService</constant></term>
852 <listitem><para>A service look-up was successful, but the <constant class="dns">SRV</constant> record
853 reported that the service is not available.</para>
855 <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry>
857 <varlistentry><term><constant>org.freedesktop.resolve1.DnssecFailed</constant></term>
858 <listitem><para>The acquired response did not pass DNSSEC validation.</para>
860 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
863 <varlistentry><term><constant>org.freedesktop.resolve1.NoTrustAnchor</constant></term>
864 <listitem><para>No chain of trust could be established for the response to a configured DNSSEC trust
867 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
870 <varlistentry><term><constant>org.freedesktop.resolve1.ResourceRecordTypeUnsupported</constant></term>
871 <listitem><para>The requested resource record type is not supported on the selected DNS servers. This
872 error is generated for example when an RRSIG record is requested from a DNS server that does not
873 support DNSSEC.</para>
875 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
879 <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchLink</constant></term>
880 <listitem><para>No network interface with the specified network interface index exists.
883 <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry>
885 <varlistentry><term><constant>org.freedesktop.resolve1.LinkBusy</constant></term>
886 <listitem><para>The requested configuration change could not be made because
887 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
888 already took possession of the interface and supplied configuration data for it.</para>
890 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
893 <varlistentry><term><constant>org.freedesktop.resolve1.NetworkDown</constant></term>
894 <listitem><para>The requested look-up failed because the system is currently not connected to any
895 suitable network.</para>
897 <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry>
899 <varlistentry><term><constant>org.freedesktop.resolve1.DnsError.NXDOMAIN</constant></term>
900 <term><constant>org.freedesktop.resolve1.DnsError.REFUSED</constant></term>
902 <listitem><para>The look-up failed with a DNS return code reporting a failure. The error names used as
903 suffixes here are defined in by IANA in
904 <ulink url="https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6">DNS RCODEs</ulink>.
907 <xi:include href="version-info.xml" xpointer="v246"/></listitem>
913 <title>Examples</title>
916 <title>Introspect <interfacename>org.freedesktop.resolve1.Manager</interfacename> on the bus</title>
919 $ gdbus introspect --system \
920 --dest org.freedesktop.resolve1 \
921 --object-path /org/freedesktop/resolve1
926 <title>Introspect <interfacename>org.freedesktop.resolve1.Link</interfacename> on the bus</title>
929 $ gdbus introspect --system \
930 --dest org.freedesktop.resolve1 \
931 --object-path /org/freedesktop/resolve1/link/_11
936 <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>