]>
Commit | Line | Data |
---|---|---|
ffd10e5a ZJS |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
eea10b26 | 4 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
ffd10e5a ZJS |
5 | <!ENTITY % entities SYSTEM "custom-entities.ent" > |
6 | %entities; | |
7 | ]> | |
db9ecf05 | 8 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
ffd10e5a ZJS |
9 | |
10 | <refentry id="org.freedesktop.resolve1" conditional='ENABLE_RESOLVE' | |
11 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
12 | <refentryinfo> | |
13 | <title>org.freedesktop.resolve1</title> | |
14 | <productname>systemd</productname> | |
15 | </refentryinfo> | |
16 | ||
17 | <refmeta> | |
18 | <refentrytitle>org.freedesktop.resolve1</refentrytitle> | |
19 | <manvolnum>5</manvolnum> | |
20 | </refmeta> | |
21 | ||
22 | <refnamediv> | |
23 | <refname>org.freedesktop.resolve1</refname> | |
24 | <refpurpose>The D-Bus interface of systemd-resolved</refpurpose> | |
25 | </refnamediv> | |
26 | ||
27 | <refsect1> | |
28 | <title>Introduction</title> | |
29 | ||
30 | <para> | |
31 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
ca264f7d | 32 | is a system service that provides hostname resolution and caching using DNS, LLMNR, and mDNS. It also |
ffd10e5a ZJS |
33 | does DNSSEC validation. This page describes the resolve semantics and the D-Bus interface.</para> |
34 | ||
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"> | |
ca264f7d | 38 | Writing Network Configuration Managers</ulink> and |
ffd10e5a ZJS |
39 | <ulink url="https://wiki.freedesktop.org/www/Software/systemd/writing-resolver-clients">Writing Resolver |
40 | Clients</ulink>. | |
41 | </para> | |
42 | </refsect1> | |
43 | ||
44 | <refsect1> | |
45 | <title>The Manager Object</title> | |
46 | ||
47 | <para>The service exposes the following interfaces on the Manager object on the bus:</para> | |
48 | ||
48f99d7c | 49 | <programlisting executable="systemd-resolved" node="/org/freedesktop/resolve1" interface="org.freedesktop.resolve1.Manager"> |
ffd10e5a ZJS |
50 | node /org/freedesktop/resolve1 { |
51 | interface org.freedesktop.resolve1.Manager { | |
52 | methods: | |
53 | ResolveHostname(in i ifindex, | |
54 | in s name, | |
55 | in i family, | |
56 | in t flags, | |
57 | out a(iiay) addresses, | |
58 | out s canonical, | |
59 | out t flags); | |
60 | ResolveAddress(in i ifindex, | |
61 | in i family, | |
62 | in ay address, | |
63 | in t flags, | |
64 | out a(is) names, | |
65 | out t flags); | |
66 | ResolveRecord(in i ifindex, | |
67 | in s name, | |
68 | in q class, | |
69 | in q type, | |
70 | in t flags, | |
71 | out a(iqqay) records, | |
72 | out t flags); | |
73 | ResolveService(in i ifindex, | |
74 | in s name, | |
75 | in s type, | |
76 | in s domain, | |
77 | in i family, | |
78 | in t flags, | |
79 | out a(qqqsa(iiay)s) srv_data, | |
80 | out aay txt_data, | |
81 | out s canonical_name, | |
82 | out s canonical_type, | |
83 | out s canonical_domain, | |
84 | out t flags); | |
ffd10e5a ZJS |
85 | GetLink(in i ifindex, |
86 | out o path); | |
87 | SetLinkDNS(in i ifindex, | |
88 | in a(iay) addresses); | |
9653108f ZJS |
89 | SetLinkDNSEx(in i ifindex, |
90 | in a(iayqs) addresses); | |
ffd10e5a ZJS |
91 | SetLinkDomains(in i ifindex, |
92 | in a(sb) domains); | |
4fb222c4 ZJS |
93 | SetLinkDefaultRoute(in i ifindex, |
94 | in b enable); | |
ffd10e5a ZJS |
95 | SetLinkLLMNR(in i ifindex, |
96 | in s mode); | |
97 | SetLinkMulticastDNS(in i ifindex, | |
98 | in s mode); | |
4fb222c4 ZJS |
99 | SetLinkDNSOverTLS(in i ifindex, |
100 | in s mode); | |
ffd10e5a ZJS |
101 | SetLinkDNSSEC(in i ifindex, |
102 | in s mode); | |
103 | SetLinkDNSSECNegativeTrustAnchors(in i ifindex, | |
104 | in as names); | |
105 | RevertLink(in i ifindex); | |
4fb222c4 ZJS |
106 | RegisterService(in s name, |
107 | in s name_template, | |
108 | in s type, | |
109 | in q service_port, | |
110 | in q service_priority, | |
0894f08b | 111 | in q service_weight, |
4fb222c4 ZJS |
112 | in aa{say} txt_datas, |
113 | out o service_path); | |
114 | UnregisterService(in o service_path); | |
115 | ResetStatistics(); | |
116 | FlushCaches(); | |
117 | ResetServerFeatures(); | |
ffd10e5a | 118 | properties: |
4fb222c4 ZJS |
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 = [...]; | |
9653108f | 127 | readonly a(iiayqs) DNSEx = [...]; |
4fb222c4 ZJS |
128 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") |
129 | readonly a(iiay) FallbackDNS = [...]; | |
9653108f ZJS |
130 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") |
131 | readonly a(iiayqs) FallbackDNSEx = [...]; | |
4fb222c4 | 132 | readonly (iiay) CurrentDNSServer = ...; |
9653108f | 133 | readonly (iiayqs) CurrentDNSServerEx = ...; |
4fb222c4 ZJS |
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 = '...'; | |
4261ab65 LP |
150 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") |
151 | readonly s ResolvConfMode = '...'; | |
ffd10e5a | 152 | }; |
4fb222c4 ZJS |
153 | interface org.freedesktop.DBus.Peer { ... }; |
154 | interface org.freedesktop.DBus.Introspectable { ... }; | |
155 | interface org.freedesktop.DBus.Properties { ... }; | |
ffd10e5a ZJS |
156 | }; |
157 | </programlisting> | |
158 | ||
4fb222c4 ZJS |
159 | <!--method RegisterService is not documented!--> |
160 | ||
161 | <!--method UnregisterService is not documented!--> | |
162 | ||
163 | <!--method FlushCaches is not documented!--> | |
164 | ||
165 | <!--method ResetServerFeatures is not documented!--> | |
166 | ||
4fb222c4 ZJS |
167 | <!--property DNSSECNegativeTrustAnchors is not documented!--> |
168 | ||
00bb75d7 ZJS |
169 | <!--Autogenerated cross-references for systemd.directives, do not edit--> |
170 | ||
171 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Manager"/> | |
172 | ||
173 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Manager"/> | |
174 | ||
175 | <variablelist class="dbus-method" generated="True" extra-ref="ResolveHostname()"/> | |
176 | ||
177 | <variablelist class="dbus-method" generated="True" extra-ref="ResolveAddress()"/> | |
178 | ||
179 | <variablelist class="dbus-method" generated="True" extra-ref="ResolveRecord()"/> | |
180 | ||
181 | <variablelist class="dbus-method" generated="True" extra-ref="ResolveService()"/> | |
182 | ||
183 | <variablelist class="dbus-method" generated="True" extra-ref="GetLink()"/> | |
184 | ||
185 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNS()"/> | |
186 | ||
9653108f ZJS |
187 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSEx()"/> |
188 | ||
00bb75d7 ZJS |
189 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDomains()"/> |
190 | ||
191 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDefaultRoute()"/> | |
192 | ||
193 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkLLMNR()"/> | |
194 | ||
195 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkMulticastDNS()"/> | |
196 | ||
197 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSOverTLS()"/> | |
198 | ||
199 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSEC()"/> | |
200 | ||
201 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSECNegativeTrustAnchors()"/> | |
202 | ||
203 | <variablelist class="dbus-method" generated="True" extra-ref="RevertLink()"/> | |
204 | ||
205 | <variablelist class="dbus-method" generated="True" extra-ref="RegisterService()"/> | |
206 | ||
207 | <variablelist class="dbus-method" generated="True" extra-ref="UnregisterService()"/> | |
208 | ||
209 | <variablelist class="dbus-method" generated="True" extra-ref="ResetStatistics()"/> | |
210 | ||
211 | <variablelist class="dbus-method" generated="True" extra-ref="FlushCaches()"/> | |
212 | ||
213 | <variablelist class="dbus-method" generated="True" extra-ref="ResetServerFeatures()"/> | |
214 | ||
215 | <variablelist class="dbus-property" generated="True" extra-ref="LLMNRHostname"/> | |
216 | ||
217 | <variablelist class="dbus-property" generated="True" extra-ref="LLMNR"/> | |
218 | ||
219 | <variablelist class="dbus-property" generated="True" extra-ref="MulticastDNS"/> | |
220 | ||
221 | <variablelist class="dbus-property" generated="True" extra-ref="DNSOverTLS"/> | |
222 | ||
223 | <variablelist class="dbus-property" generated="True" extra-ref="DNS"/> | |
224 | ||
9653108f ZJS |
225 | <variablelist class="dbus-property" generated="True" extra-ref="DNSEx"/> |
226 | ||
00bb75d7 ZJS |
227 | <variablelist class="dbus-property" generated="True" extra-ref="FallbackDNS"/> |
228 | ||
9653108f ZJS |
229 | <variablelist class="dbus-property" generated="True" extra-ref="FallbackDNSEx"/> |
230 | ||
00bb75d7 ZJS |
231 | <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServer"/> |
232 | ||
9653108f ZJS |
233 | <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServerEx"/> |
234 | ||
00bb75d7 ZJS |
235 | <variablelist class="dbus-property" generated="True" extra-ref="Domains"/> |
236 | ||
237 | <variablelist class="dbus-property" generated="True" extra-ref="TransactionStatistics"/> | |
238 | ||
239 | <variablelist class="dbus-property" generated="True" extra-ref="CacheStatistics"/> | |
240 | ||
241 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSEC"/> | |
242 | ||
243 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSECStatistics"/> | |
244 | ||
245 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSECSupported"/> | |
246 | ||
247 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSECNegativeTrustAnchors"/> | |
248 | ||
249 | <variablelist class="dbus-property" generated="True" extra-ref="DNSStubListener"/> | |
250 | ||
4261ab65 LP |
251 | <variablelist class="dbus-property" generated="True" extra-ref="ResolvConfMode"/> |
252 | ||
00bb75d7 ZJS |
253 | <!--End of Autogenerated section--> |
254 | ||
ffd10e5a ZJS |
255 | <refsect2> |
256 | <title>Methods</title> | |
257 | ||
2ce49367 ZJS |
258 | <para><function>ResolveHostname()</function> takes a hostname and resolves it to one or more IP |
259 | addresses. As parameters it takes the Linux network interface index to execute the query on, or 0 if | |
260 | it may be done on any suitable interface. The <varname>name</varname> parameter specifies the hostname | |
261 | to resolve. Note that if required, IDNA conversion is applied to this name unless it is resolved via | |
262 | LLMNR or MulticastDNS. The <varname>family</varname> parameter limits the results to a specific address | |
263 | family. It may be <constant>AF_INET</constant>, <constant>AF_INET6</constant> or | |
264 | <constant>AF_UNSPEC</constant>. If <constant>AF_UNSPEC</constant> is specified (recommended), both | |
265 | kinds are retrieved, subject to local network configuration (i.e. if no local, routable IPv6 address is | |
266 | found, no IPv6 address is retrieved; and similarly for IPv4). A 64-bit <varname>flags</varname> field | |
267 | may be used to alter the behaviour of the resolver operation (see below). The method returns an array | |
268 | of address records. Each address record consists of the interface index the address belongs to, an | |
269 | address family as well as a byte array with the actual IP address data (which either has 4 or 16 | |
270 | elements, depending on the address family). The returned address family will be one of | |
271 | <constant>AF_INET</constant> or <constant>AF_INET6</constant>. For IPv6, the returned address interface | |
272 | index should be used to initialize the .sin6_scope_id field of a | |
273 | <structname>struct sockaddr_in6</structname> instance to permit support for resolution to link-local IP | |
274 | addresses. The address array is followed by the canonical name of the host, which may or may not be | |
275 | identical to the resolved hostname. Finally, a 64-bit <varname>flags</varname> field is returned that | |
276 | is defined similarly to the <varname>flags</varname> field that was passed in, but contains information | |
277 | about the resolved data (see below). If the hostname passed in is an IPv4 or IPv6 address formatted as | |
278 | string, it is parsed, and the result is returned. In this case, no network communication is | |
279 | done.</para> | |
ffd10e5a ZJS |
280 | |
281 | <para><function>ResolveAddress()</function> executes the reverse operation: it takes an IP address and | |
282 | acquires one or more hostnames for it. As parameters it takes the interface index to execute the query | |
283 | on, or <constant>0</constant> if all suitable interfaces are OK. The <varname>family</varname> | |
ca264f7d | 284 | parameter indicates the address family of the IP address to resolve. It may be either |
ffd10e5a | 285 | <constant>AF_INET</constant> or <constant>AF_INET6</constant>. The <varname>address</varname> parameter |
ca264f7d DDM |
286 | takes the raw IP address data (as either a 4 or 16 byte array). The <varname>flags</varname> input |
287 | parameter may be used to alter the resolver operation (see below). The method returns an array of name | |
288 | records, each consisting of an interface index and a hostname. The <varname>flags</varname> output | |
ffd10e5a ZJS |
289 | field contains additional information about the resolver operation (see below).</para> |
290 | ||
291 | <para><function>ResolveRecord()</function> takes a DNS resource record (RR) type, class and name, and | |
292 | retrieves the full resource record set (RRset), including the RDATA, for it. As parameter it takes the | |
293 | Linux network interface index to execute the query on, or <constant>0</constant> if it may be done on | |
294 | any suitable interface. The <varname>name</varname> parameter specifies the RR domain name to look up | |
295 | (no IDNA conversion is applied), followed by the 16-bit class and type fields (which may be | |
296 | ANY). Finally, a <varname>flags</varname> field may be passed in to alter behaviour of the look-up (see | |
ca264f7d | 297 | below). On completion, an array of RR items is returned. Each array entry consists of the network interface |
ffd10e5a | 298 | index the RR was discovered on, the type and class field of the RR found, and a byte array of the raw |
4fb222c4 | 299 | RR discovered. The raw RR data starts with the RR's domain name, in the original casing, followed |
ffd10e5a ZJS |
300 | by the RR type, class, TTL and RDATA, in the binary format documented in |
301 | <ulink url="https://www.ietf.org/rfc/rfc1035.txt">RFC 1035</ulink>. For RRs that support name | |
302 | compression in the payload (such as MX or PTR), the compression is expanded in the returned | |
303 | data.</para> | |
304 | ||
ca264f7d | 305 | <para>Note that currently, the class field has to be specified as IN or ANY. Specifying a different |
ffd10e5a | 306 | class will return an error indicating that look-ups of this kind are unsupported. Similarly, some |
ca264f7d DDM |
307 | special types are not supported either (AXFR, OPT, …). While <filename>systemd-resolved</filename> parses and validates resource |
308 | records of many types, it is crucial that clients using this API understand that the RR data originates | |
ffd10e5a ZJS |
309 | from the network and should be thoroughly validated before use.</para> |
310 | ||
9a024bf1 ZJS |
311 | <para><function>ResolveService()</function> may be used to resolve a DNS |
312 | <constant class="dns">SRV</constant> service record, as well as the hostnames referenced in it, and | |
313 | possibly an accompanying DNS-SD <constant class="dns">TXT</constant> record containing additional | |
314 | service metadata. The primary benefit of using this method over <function>ResolveRecord()</function> | |
315 | specifying the <constant class="dns">SRV</constant> type is that it will resolve the | |
316 | <constant class="dns">SRV</constant> and <constant class="dns">TXT</constant> RRs as well as the | |
317 | hostnames referenced in the SRV in a single operation. As parameters it takes a Linux network interface | |
318 | index, a service name, a service type and a service domain. This method may be invoked in three | |
319 | different modes:</para> | |
ffd10e5a ZJS |
320 | |
321 | <orderedlist> | |
4fb222c4 | 322 | <listitem><para>To resolve a DNS-SD service, specify the service name (e.g. <literal>Lennart's |
ffd10e5a | 323 | Files</literal>), the service type (e.g. <literal>_webdav._tcp</literal>) and the domain to search in |
ca264f7d | 324 | (e.g. <literal>local</literal>) as the three service parameters. The service name must be in UTF-8 |
ffd10e5a | 325 | format, and no IDNA conversion is applied to it in this mode (as mandated by the DNS-SD |
ca264f7d | 326 | specifications). However, if necessary, IDNA conversion is applied to the domain parameter.</para> |
ffd10e5a ZJS |
327 | </listitem> |
328 | ||
9a024bf1 ZJS |
329 | <listitem><para>To resolve a plain <constant class="dns">SRV</constant> record, set the service name |
330 | parameter to the empty string and set the service type and domain properly. (IDNA conversion is | |
331 | applied to the domain, if necessary.)</para></listitem> | |
ffd10e5a | 332 | |
9a024bf1 ZJS |
333 | <listitem><para>Alternatively, leave both the service name and type empty and specify the full domain |
334 | name of the <constant class="dns">SRV</constant> record (i.e. prefixed with the service type) in the | |
335 | domain parameter. (No IDNA conversion is applied in this mode.)</para></listitem> | |
ffd10e5a ZJS |
336 | </orderedlist> |
337 | ||
ca264f7d | 338 | <para>The <varname>family</varname> parameter of the <function>ResolveService()</function> method encodes |
ffd10e5a | 339 | the desired family of the addresses to resolve (use <constant>AF_INET</constant>, |
ca264f7d | 340 | <constant>AF_INET6</constant>, or <constant>AF_UNSPEC</constant>). If this is enabled (Use the |
ffd10e5a ZJS |
341 | <constant>NO_ADDRESS</constant> flag to turn address resolution off, see below). The |
342 | <varname>flags</varname> parameter takes a couple of flags that may be used to alter the resolver | |
343 | operation.</para> | |
344 | ||
9a024bf1 ZJS |
345 | <para>On completion, <function>ResolveService()</function> returns an array of |
346 | <constant class="dns">SRV</constant> record structures. Each items consisting of the priority, weight and port | |
347 | fields as well as the hostname to contact, as encoded in the <constant class="dns">SRV</constant> | |
ca264f7d | 348 | record. Immediately following is an array of the addresses of this hostname, with each item consisting |
ffd10e5a | 349 | of the interface index, the address family and the address data in a byte array. This address array is |
9a024bf1 ZJS |
350 | followed by the canonicalized hostname. After this array of <constant class="dns">SRV</constant> record |
351 | structures an array of byte arrays follows that encodes the TXT RR strings, in case DNS-SD look-ups are | |
352 | enabled. The next parameters are the canonical service name, type and domain. This may or may not be | |
353 | identical to the parameters passed in. Finally, a <varname>flags</varname> field is returned that | |
354 | contains information about the resolver operation performed.</para> | |
ffd10e5a | 355 | |
ca264f7d DDM |
356 | <para>The <function>ResetStatistics()</function> method resets the various statistics counters that |
357 | <filename>systemd-resolved</filename> maintains to zero. (For details, see the statistics properties below.)</para> | |
ffd10e5a ZJS |
358 | |
359 | <para>The <function>GetLink()</function> method takes a network interface index and returns the object | |
360 | path to the <interfacename>org.freedesktop.resolve1.Link</interfacename> object corresponding to it. | |
361 | </para> | |
362 | ||
363 | <para>The <function>SetLinkDNS()</function> method sets the DNS servers to use on a specific | |
ca264f7d | 364 | interface. This method (and the following ones) may be used by network management software to configure |
ffd10e5a ZJS |
365 | per-interface DNS settings. It takes a network interface index as well as an array of DNS server IP |
366 | address records. Each array item consists of an address family (either <constant>AF_INET</constant> or | |
367 | <constant>AF_INET6</constant>), followed by a 4-byte or 16-byte array with the raw address data. This | |
ca264f7d DDM |
368 | method is a one-step shortcut for retrieving the Link object for a network interface using |
369 | <function>GetLink()</function> (see above) and then invoking the <function>SetDNS()</function> method | |
2ce49367 ZJS |
370 | (see below) on it.</para> |
371 | ||
372 | <para><function>SetLinkDNSEx()</function> is similar to <function>SetLinkDNS()</function>, but allows | |
373 | an IP port (instead of the default 53) and DNS name to be specified for each DNS server. The server | |
374 | name is used for Server Name Indication (SNI), which is useful when DNS-over-TLS is | |
375 | used. C.f. <varname>DNS=</varname> in | |
376 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
ffd10e5a ZJS |
377 | </para> |
378 | ||
2ce49367 ZJS |
379 | <para><function>SetLinkDefaultRoute()</function> specifies whether the link shall be used as the |
380 | default route for name queries. See the description of name routing in | |
381 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
382 | for details.</para> | |
ffd10e5a ZJS |
383 | |
384 | <para>The <function>SetLinkDomains()</function> method sets the search and routing domains to use on a | |
ca264f7d DDM |
385 | specific network interface for DNS look-ups. It takes a network interface index and an array of domains, |
386 | each with a boolean parameter indicating whether the specified domain shall be used as a search domain | |
387 | (false), or just as a routing domain (true). Search domains are used for qualifying single-label names into | |
ffd10e5a | 388 | FQDN when looking up hostnames, as well as for making routing decisions on which interface to send |
ca264f7d DDM |
389 | queries ending in the domain to. Routing domains are only used for routing decisions and not used for single-label |
390 | name qualification. Pass the search domains in the order they should be used.</para> | |
ffd10e5a ZJS |
391 | |
392 | <para>The <function>SetLinkLLMNR()</function> method enables or disables LLMNR support on a specific | |
ca264f7d | 393 | network interface. It takes a network interface index as well as a string that may either be empty or one of |
ffd10e5a | 394 | <literal>yes</literal>, <literal>no</literal> or <literal>resolve</literal>. If empty, the systemd-wide |
ca264f7d DDM |
395 | default LLMNR setting is used. If <literal>yes</literal>, LLMNR is used for resolution of single-label |
396 | names and the local hostname is registered on all local LANs for LLMNR resolution by peers. If | |
397 | <literal>no</literal>, LLMNR is turned off fully on this interface. If <literal>resolve</literal>, LLMNR | |
38b38500 | 398 | is only enabled for resolving names, but the local hostname is not registered for other peers to |
ffd10e5a ZJS |
399 | use.</para> |
400 | ||
401 | <para>Similarly, the <function>SetLinkMulticastDNS()</function> method enables or disables MulticastDNS | |
402 | support on a specific interface. It takes the same parameters as <function>SetLinkLLMNR()</function> | |
403 | described above.</para> | |
404 | ||
405 | <para>The <function>SetLinkDNSSEC()</function> method enables or disables DNSSEC validation on a | |
ca264f7d DDM |
406 | specific network interface. It takes a network interface index as well as a string that may either be |
407 | empty or one of <literal>yes</literal>, <literal>no</literal>, or <literal>allow-downgrade</literal>. When | |
408 | empty, the system-wide default DNSSEC setting is used. If <literal>yes</literal>, full DNSSEC validation | |
409 | is done for all look-ups. If the selected DNS server does not support DNSSEC, look-ups will fail if this | |
410 | mode is used. If <literal>no</literal>, DNSSEC validation is fully disabled. If | |
411 | <literal>allow-downgrade</literal>, DNSSEC validation is enabled, but is turned off automatically if the | |
ffd10e5a ZJS |
412 | selected server does not support it (thus opening up behaviour to downgrade attacks). Note that DNSSEC |
413 | only applies to traditional DNS, not to LLMNR or MulticastDNS.</para> | |
414 | ||
415 | <para>The <function>SetLinkDNSSECNegativeTrustAnchors()</function> method may be used to configure DNSSEC | |
416 | Negative Trust Anchors (NTAs) for a specific network interface. It takes a network interface index and a | |
ca264f7d | 417 | list of domains as arguments.</para> |
ffd10e5a | 418 | |
2ce49367 ZJS |
419 | <para>The <function>SetLinkDNSOverTLS()</function> method enables or disables DNS-over-TLS. |
420 | C.f. <varname>DNSOverTLS=</varname> in | |
421 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
422 | for details.</para> | |
423 | ||
424 | <para>Network management software integrating with <filename>systemd-resolved</filename> should call | |
425 | <function>SetLinkDNS()</function> or <function>SetLinkDNSEx()</function>, | |
426 | <function>SetLinkDefaultRoute()</function>, <function>SetLinkDomains()</function> and others after the | |
427 | interface appeared in the kernel (and thus after a network interface index has been assigned), but | |
428 | before the network interfaces is activated (<constant>IFF_UP</constant> set) so that all settings take | |
429 | effect during the full time the network interface is up. It is safe to alter settings while the | |
430 | interface is up, however. Use <function>RevertLink()</function> (described below) to reset all | |
431 | per-interface settings.</para> | |
432 | ||
433 | <para>The <function>RevertLink()</function> method may be used to revert all per-link settings | |
434 | described above to the defaults.</para> | |
ffd10e5a ZJS |
435 | |
436 | <refsect3> | |
437 | <title>The Flags Parameter</title> | |
438 | ||
ca264f7d | 439 | <para>The four methods above accept and return a 64-bit flags value. In most cases passing 0 is sufficient |
ffd10e5a ZJS |
440 | and recommended. However, the following flags are defined to alter the look-up:</para> |
441 | ||
50ff4753 | 442 | <programlisting>/* Input+Output: Protocol/scope */ |
d0eae64c LP |
443 | #define SD_RESOLVED_DNS (UINT64_C(1) << 0) |
444 | #define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1) | |
445 | #define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2) | |
446 | #define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3) | |
447 | #define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4) | |
50ff4753 LP |
448 | |
449 | /* Input: Restrictions */ | |
d0eae64c LP |
450 | #define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5) |
451 | #define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6) | |
452 | #define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7) | |
453 | #define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8) | |
454 | #define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10) | |
455 | #define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11) | |
456 | #define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12) | |
457 | #define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13) | |
458 | #define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14) | |
459 | #define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15) | |
460 | #define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24) | |
461 | #define SD_RESOLVED_RELAX_SINGLE_LABEL (UINT64_C(1) << 25) | |
50ff4753 LP |
462 | |
463 | /* Output: Security */ | |
d0eae64c LP |
464 | #define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9) |
465 | #define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18) | |
50ff4753 LP |
466 | |
467 | /* Output: Origin */ | |
d0eae64c LP |
468 | #define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19) |
469 | #define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20) | |
470 | #define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21) | |
471 | #define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22) | |
472 | #define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23) | |
50ff4753 | 473 | </programlisting> |
ffd10e5a ZJS |
474 | |
475 | <para>On input, the first five flags control the protocols to use for the look-up. They refer to | |
476 | classic unicast DNS, LLMNR via IPv4/UDP and IPv6/UDP respectively, as well as MulticastDNS via | |
477 | IPv4/UDP and IPv6/UDP. If all of these five bits are off on input (which is strongly recommended) the | |
478 | look-up will be done via all suitable protocols for the specific look-up. Note that these flags | |
2ce49367 ZJS |
479 | operate as filter only, but cannot force a look-up to be done via a protocol. Specifically, |
480 | <filename>systemd-resolved</filename> will only route look-ups within the .local TLD to MulticastDNS | |
481 | (plus some reverse look-up address domains), and single-label names to LLMNR (plus some reverse | |
482 | address lookup domains). It will route neither of these to Unicast DNS servers. Also, it will do | |
483 | LLMNR and Multicast DNS only on interfaces suitable for multicast.</para> | |
ffd10e5a | 484 | |
50ff4753 LP |
485 | <para>On output, these five flags indicate which protocol was used to execute the operation, and |
486 | hence where the data was found.</para> | |
ffd10e5a | 487 | |
ca264f7d | 488 | <para>The primary use cases for these five flags are follow-up look-ups based on DNS data retrieved |
ffd10e5a | 489 | earlier. In this case it is often a good idea to limit the follow-up look-up to the protocol that was |
ca264f7d | 490 | used to discover the first DNS result.</para> |
ffd10e5a ZJS |
491 | |
492 | <para>The NO_CNAME flag controls whether CNAME/DNAME resource records shall be followed during the | |
493 | look-up. This flag is only available at input, none of the functions will return it on output. If a | |
ca264f7d | 494 | CNAME/DNAME RR is discovered while resolving a hostname, an error is returned instead. By default, |
ffd10e5a ZJS |
495 | when the flag is off, CNAME/DNAME RRs are followed.</para> |
496 | ||
ca264f7d | 497 | <para>The NO_TXT and NO_ADDRESS flags only influence operation of the |
c6f20515 ZJS |
498 | <function>ResolveService()</function> method. They are only defined for input, not output. If NO_TXT |
499 | is set, the DNS-SD TXT RR look-up is not done in the same operation. If NO_ADDRESS is set, the | |
500 | discovered hostnames are not implicitly translated to their addresses.</para> | |
ffd10e5a ZJS |
501 | |
502 | <para>The NO_SEARCH flag turns off the search domain logic. It is only defined for input in | |
503 | <function>ResolveHostname()</function>. When specified, single-label hostnames are not qualified | |
504 | using defined search domains, if any are configured. Note that <function>ResolveRecord()</function> | |
50ff4753 LP |
505 | will never qualify single-label domain names using search domains. Also note that multi-label |
506 | hostnames are never subject to search list expansion.</para> | |
507 | ||
508 | <para>NO_VALIDATE can be set to disable validation via DNSSEC even if it would normally be | |
509 | used.</para> | |
510 | ||
5ed91481 | 511 | <para>The next six flags allow disabling certain sources during resolution. NO_SYNTHESIZE disables |
50ff4753 LP |
512 | synthetic records, e.g. the local host name, see section SYNTHETIC RECORDS in |
513 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
514 | for more information. NO_CACHE disables the use of the cache of previously resolved records. NO_ZONE | |
515 | disables answers using locally registered public LLMNR/mDNS resource records. NO_TRUST_ANCHOR | |
516 | disables answers using locally configured trust anchors. NO_NETWORK requires all answers to be | |
5ed91481 KV |
517 | provided without using the network, i.e. either from local sources or the cache. NO_STALE flag |
518 | can be set to disable answering request with stale records.</para> | |
ffd10e5a ZJS |
519 | |
520 | <para>The AUTHENTICATED bit is defined only in the output flags of the four functions. If set, the | |
c6f20515 ZJS |
521 | returned data has been fully authenticated. Specifically, this bit is set for all DNSSEC-protected |
522 | data for which a full trust chain may be established to a trusted domain anchor. It is also set for | |
523 | locally synthesized data, such as <literal>localhost</literal> or data from | |
524 | <filename>/etc/hosts</filename>. Moreover, it is set for all LLMNR or mDNS RRs which originate from | |
525 | the local host. Applications that require authenticated RR data for operation should check this flag | |
526 | before trusting the data. Note that <filename>systemd-resolved</filename> will never return | |
6eed65d4 | 527 | invalidated data, hence this flag simply allows one to discern the cases where data is known to be |
c6f20515 ZJS |
528 | trusted, or where there is proof that the data is "rightfully" unauthenticated (which includes cases |
529 | where the underlying protocol or server does not support authenticating data).</para> | |
530 | ||
50ff4753 LP |
531 | <para>CONFIDENTIAL means the query was resolved via encrypted channels or never left this |
532 | system.</para> | |
c6f20515 | 533 | |
50ff4753 LP |
534 | <para>The next five bits flags are used in output and provide information about the origin of the |
535 | answer. FROM_SYNTHETIC means the query was (at least partially) synthesized locally. FROM_CACHE means | |
536 | the query was answered (at least partially) using the cache. FROM_ZONE means the query was answered | |
537 | (at least partially) based on public, locally registered records. FROM_TRUST_ANCHOR means the query | |
538 | was answered (at least partially) using local trust anchors. FROM_NETWORK means the query was | |
539 | answered (at least partially) using the network.</para> | |
ffd10e5a | 540 | </refsect3> |
2ce49367 | 541 | </refsect2> |
ffd10e5a ZJS |
542 | |
543 | <refsect2> | |
544 | <title>Properties</title> | |
545 | ||
2ce49367 ZJS |
546 | <para>The <varname>LLMNR</varname> and <varname>MulticastDNS</varname> properties report whether LLMNR |
547 | and MulticastDNS are (globally) enabled. Each may be one of <literal>yes</literal>, | |
548 | <literal>no</literal>, and <literal>resolve</literal>. See <function>SetLinkLLMNR()</function> | |
549 | and <function>SetLinkMulticastDNS()</function> above.</para> | |
550 | ||
7f255076 ZJS |
551 | <para><varname>LLMNRHostname</varname> contains the hostname currently exposed on the network via |
552 | LLMNR. It usually follows the system hostname as may be queried via | |
4fb222c4 | 553 | <citerefentry project="man-pages"><refentrytitle>gethostname</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
7f255076 | 554 | but may differ if a conflict is detected on the network.</para> |
ffd10e5a | 555 | |
2ce49367 ZJS |
556 | <para><varname>DNS</varname> and <varname>DNSEx</varname> contain arrays of all DNS servers currently |
557 | used by <filename>systemd-resolved</filename>. <varname>DNS</varname> contains information similar to | |
558 | the DNS server data in <filename>/run/systemd/resolve/resolv.conf</filename>. Each structure in the | |
559 | array consists of a numeric network interface index, an address family, and a byte array containing the | |
560 | DNS server address (either 4 bytes in length for IPv4 or 16 bytes in lengths for IPv6). | |
561 | <varname>DNSEx</varname> is similar, but additionally contains the IP port and server name (used for | |
562 | Server Name Indication, SNI). Both arrays contain DNS servers configured system-wide, including those | |
563 | possibly read from a foreign <filename>/etc/resolv.conf</filename> or the <varname>DNS=</varname> | |
564 | setting in <filename>/etc/systemd/resolved.conf</filename>, as well as per-interface DNS server | |
565 | information either retrieved from | |
ffd10e5a | 566 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
2ce49367 ZJS |
567 | or configured by external software via <function>SetLinkDNS()</function> or |
568 | <function>SetLinkDNSEx()</function> (see above). The network interface index will be 0 for the | |
569 | system-wide configured services and non-zero for the per-link servers.</para> | |
570 | ||
571 | <para><varname>FallbackDNS</varname> and <varname>FallbackDNSEx</varname> contain arrays of all DNS | |
572 | servers configured as fallback servers, if any, using the same format as <varname>DNS</varname> and | |
573 | <varname>DNSEx</varname> described above. See the description of <varname>FallbackDNS=</varname> in | |
574 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for | |
575 | the description of when those servers are used.</para> | |
ffd10e5a | 576 | |
2ce49367 ZJS |
577 | <para><varname>CurrentDNSServer</varname> and <varname>CurrentDNSServerEx</varname> specify the server |
578 | that is currently used for query resolution, in the same format as a single entry in the | |
579 | <varname>DNS</varname> and <varname>DNSEx</varname> arrays described above.</para> | |
580 | ||
581 | <para>Similarly, the <varname>Domains</varname> property contains an array of all search and routing | |
582 | domains currently used by <filename>systemd-resolved</filename>. Each entry consists of a network | |
583 | interface index (again, 0 encodes system-wide entries), the actual domain name, and whether the entry | |
584 | is used only for routing (true) or for both routing and searching (false).</para> | |
ffd10e5a ZJS |
585 | |
586 | <para>The <varname>TransactionStatistics</varname> property contains information about the number of | |
ca264f7d | 587 | transactions <filename>systemd-resolved</filename> has processed. It contains a pair of unsigned 64-bit counters, the first |
ffd10e5a | 588 | containing the number of currently ongoing transactions, the second the number of total transactions |
ca264f7d DDM |
589 | <filename>systemd-resolved</filename> is processing or has processed. The latter value may be reset using the |
590 | <function>ResetStatistics()</function> method described above. Note that the number of transactions does | |
591 | not directly map to the number of issued resolver bus method calls. While simple look-ups usually require a | |
ffd10e5a ZJS |
592 | single transaction only, more complex look-ups might result in more, for example when CNAMEs or DNSSEC |
593 | are in use.</para> | |
594 | ||
595 | <para>The <varname>CacheStatistics</varname> property contains information about the executed cache | |
596 | operations so far. It exposes three 64-bit counters: the first being the total number of current cache | |
ca264f7d | 597 | entries (both positive and negative), the second the number of cache hits, and the third the number of |
ffd10e5a | 598 | cache misses. The latter counters may be reset using <function>ResetStatistics()</function> (see |
2ce49367 ZJS |
599 | above).</para> |
600 | ||
601 | <para>The <varname>DNSSEC</varname> property specifies current status of DNSSEC validation. It is one | |
602 | of <literal>yes</literal> (validation is enforced), <literal>no</literal> (no validation is done), | |
603 | <literal>allow-downgrade</literal> (validation is done if the current DNS server supports it). See the | |
604 | description of <varname>DNSSEC=</varname> in | |
605 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
606 | </para> | |
ffd10e5a ZJS |
607 | |
608 | <para>The <varname>DNSSECStatistics</varname> property contains information about the DNSSEC | |
609 | validations executed so far. It contains four 64-bit counters: the number of secure, insecure, bogus, | |
610 | and indeterminate DNSSEC validations so far. The counters are increased for each validated RRset, and | |
6b5e8240 | 611 | each non-existence proof. The secure counter is increased for each operation that successfully verified |
ffd10e5a ZJS |
612 | a signed reply, the insecure counter is increased for each operation that successfully verified that an |
613 | unsigned reply is rightfully unsigned. The bogus counter is increased for each operation where the | |
ca264f7d | 614 | validation did not check out and the data is likely to have been tempered with. Finally the |
ffd10e5a ZJS |
615 | indeterminate counter is increased for each operation which did not complete because the necessary keys |
616 | could not be acquired or the cryptographic algorithms were unknown.</para> | |
617 | ||
618 | <para>The <varname>DNSSECSupported</varname> boolean property reports whether DNSSEC is enabled and | |
619 | the selected DNS servers support it. It combines information about system-wide and per-link DNS | |
620 | settings (see below), and only reports true if DNSSEC is enabled and supported on every interface for | |
ca264f7d DDM |
621 | which DNS is configured and for the system-wide settings if there are any. Note that <filename>systemd-resolved</filename> assumes |
622 | DNSSEC is supported by DNS servers until it verifies that this is not the case. Thus, the reported | |
ffd10e5a | 623 | value may initially be true, until the first transactions are executed.</para> |
df957849 | 624 | |
2ce49367 ZJS |
625 | <para>The <varname>DNSOverTLS</varname> boolean property reports whether DNS-over-TLS is enabled. |
626 | </para> | |
627 | ||
4261ab65 LP |
628 | <para>The <varname>ResolvConfMode</varname> property exposes how <filename>/etc/resolv.conf</filename> |
629 | is managed on the host. Currently, the values <literal>uplink</literal>, <literal>stub</literal>, | |
630 | <literal>static</literal> (these three correspond to the three different files | |
631 | <filename>systemd-resolved.service</filename> provides), <literal>foreign</literal> (the file is | |
632 | managed by admin or another service, <filename>systemd-resolved.service</filename> just consumes it), | |
633 | <literal>missing</literal> (<filename>/etc/resolv.conf</filename> is missing).</para> | |
2ce49367 ZJS |
634 | |
635 | <para>The <varname>DNSStubListener</varname> property reports whether the stub listener on port 53 is | |
636 | enabled. Possible values are <literal>yes</literal> (enabled), <literal>no</literal> (disabled), | |
637 | <literal>udp</literal> (only the UDP listener is enabled), and <literal>tcp</literal> (only the TCP | |
638 | listener is enabled).</para> | |
ffd10e5a ZJS |
639 | </refsect2> |
640 | </refsect1> | |
641 | ||
642 | <refsect1> | |
643 | <title>Link Object</title> | |
644 | ||
48f99d7c ZJS |
645 | <programlisting executable="systemd-resolved" node="/org/freedesktop/resolve1/link/_1" interface="org.freedesktop.resolve1.Link"> |
646 | node /org/freedesktop/resolve1/link/_1 { | |
ffd10e5a ZJS |
647 | interface org.freedesktop.resolve1.Link { |
648 | methods: | |
4fb222c4 | 649 | SetDNS(in a(iay) addresses); |
9653108f | 650 | SetDNSEx(in a(iayqs) addresses); |
4fb222c4 ZJS |
651 | SetDomains(in a(sb) domains); |
652 | SetDefaultRoute(in b enable); | |
653 | SetLLMNR(in s mode); | |
654 | SetMulticastDNS(in s mode); | |
655 | SetDNSOverTLS(in s mode); | |
656 | SetDNSSEC(in s mode); | |
657 | SetDNSSECNegativeTrustAnchors(in as names); | |
ffd10e5a | 658 | Revert(); |
ffd10e5a | 659 | properties: |
4fb222c4 ZJS |
660 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") |
661 | readonly t ScopesMask = ...; | |
662 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
663 | readonly a(iay) DNS = [...]; | |
664 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
9653108f ZJS |
665 | readonly a(iayqs) DNSEx = [...]; |
666 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
4fb222c4 ZJS |
667 | readonly (iay) CurrentDNSServer = ...; |
668 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
9653108f ZJS |
669 | readonly (iayqs) CurrentDNSServerEx = ...; |
670 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
4fb222c4 ZJS |
671 | readonly a(sb) Domains = [...]; |
672 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
673 | readonly b DefaultRoute = ...; | |
674 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
675 | readonly s LLMNR = '...'; | |
676 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
677 | readonly s MulticastDNS = '...'; | |
678 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
679 | readonly s DNSOverTLS = '...'; | |
680 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
681 | readonly s DNSSEC = '...'; | |
682 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
683 | readonly as DNSSECNegativeTrustAnchors = ['...', ...]; | |
684 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
685 | readonly b DNSSECSupported = ...; | |
ffd10e5a | 686 | }; |
4fb222c4 ZJS |
687 | interface org.freedesktop.DBus.Peer { ... }; |
688 | interface org.freedesktop.DBus.Introspectable { ... }; | |
689 | interface org.freedesktop.DBus.Properties { ... }; | |
ffd10e5a ZJS |
690 | }; |
691 | </programlisting> | |
692 | ||
4fb222c4 ZJS |
693 | <!--property DNSSECNegativeTrustAnchors is not documented!--> |
694 | ||
00bb75d7 ZJS |
695 | <!--Autogenerated cross-references for systemd.directives, do not edit--> |
696 | ||
697 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Link"/> | |
698 | ||
699 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Link"/> | |
700 | ||
701 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNS()"/> | |
702 | ||
9653108f ZJS |
703 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSEx()"/> |
704 | ||
00bb75d7 ZJS |
705 | <variablelist class="dbus-method" generated="True" extra-ref="SetDomains()"/> |
706 | ||
707 | <variablelist class="dbus-method" generated="True" extra-ref="SetDefaultRoute()"/> | |
708 | ||
709 | <variablelist class="dbus-method" generated="True" extra-ref="SetLLMNR()"/> | |
710 | ||
711 | <variablelist class="dbus-method" generated="True" extra-ref="SetMulticastDNS()"/> | |
712 | ||
713 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSOverTLS()"/> | |
714 | ||
715 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSEC()"/> | |
716 | ||
717 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSECNegativeTrustAnchors()"/> | |
718 | ||
719 | <variablelist class="dbus-method" generated="True" extra-ref="Revert()"/> | |
720 | ||
721 | <variablelist class="dbus-property" generated="True" extra-ref="ScopesMask"/> | |
722 | ||
723 | <variablelist class="dbus-property" generated="True" extra-ref="DNS"/> | |
724 | ||
9653108f ZJS |
725 | <variablelist class="dbus-property" generated="True" extra-ref="DNSEx"/> |
726 | ||
00bb75d7 ZJS |
727 | <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServer"/> |
728 | ||
9653108f ZJS |
729 | <variablelist class="dbus-property" generated="True" extra-ref="CurrentDNSServerEx"/> |
730 | ||
00bb75d7 ZJS |
731 | <variablelist class="dbus-property" generated="True" extra-ref="Domains"/> |
732 | ||
733 | <variablelist class="dbus-property" generated="True" extra-ref="DefaultRoute"/> | |
734 | ||
735 | <variablelist class="dbus-property" generated="True" extra-ref="LLMNR"/> | |
736 | ||
737 | <variablelist class="dbus-property" generated="True" extra-ref="MulticastDNS"/> | |
738 | ||
739 | <variablelist class="dbus-property" generated="True" extra-ref="DNSOverTLS"/> | |
740 | ||
741 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSEC"/> | |
742 | ||
743 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSECNegativeTrustAnchors"/> | |
744 | ||
745 | <variablelist class="dbus-property" generated="True" extra-ref="DNSSECSupported"/> | |
746 | ||
747 | <!--End of Autogenerated section--> | |
748 | ||
ca264f7d | 749 | <para>For each Linux network interface a "Link" object is created which exposes per-link DNS |
ffd10e5a ZJS |
750 | configuration and state. Use <function>GetLink()</function> on the Manager interface to retrieve the |
751 | object path for a link object given the network interface index (see above).</para> | |
752 | ||
753 | <refsect2> | |
754 | <title>Methods</title> | |
755 | ||
756 | <para>The various methods exposed by the Link interface are equivalent to their similarly named | |
757 | counterparts on the Manager interface. e.g. <function>SetDNS()</function> on the Link object maps to | |
758 | <function>SetLinkDNS()</function> on the Manager object, the main difference being that the later | |
ca264f7d | 759 | expects an interface index to be specified. Invoking the methods on the Manager interface has the |
ffd10e5a | 760 | benefit of reducing roundtrips, as it is not necessary to first request the Link object path via |
2ce49367 ZJS |
761 | <function>GetLink()</function> before invoking the methods. The same relationship holds for |
762 | <function>SetDNSEx()</function>, <function>SetDomains()</function>, | |
763 | <function>SetDefaultRoute()</function>, <function>SetLLMNR()</function>, | |
764 | <function>SetMulticastDNS()</function>, <function>SetDNSOverTLS()</function>, | |
765 | <function>SetDNSSEC()</function>, <function>SetDNSSECNegativeTrustAnchors()</function>, and | |
766 | <function>Revert()</function>. For further details on these methods see the | |
767 | <interfacename>Manager</interfacename> documentation above.</para> | |
ffd10e5a ZJS |
768 | </refsect2> |
769 | ||
770 | <refsect2> | |
771 | <title>Properties</title> | |
772 | ||
773 | <para><varname>ScopesMask</varname> defines which resolver scopes are currently active on this | |
ca264f7d | 774 | interface. This 64-bit unsigned integer field is a bit mask consisting of a subset of the bits of the |
ffd10e5a ZJS |
775 | flags parameter describe above. Specifically, it may have the DNS, LLMNR and MDNS bits (the latter in |
776 | IPv4 and IPv6 flavours) set. Each individual bit is set when the protocol applies to a specific | |
777 | interface and is enabled for it. It is unset otherwise. Specifically, a multicast-capable interface in | |
ca264f7d | 778 | the "UP" state with an IP address is suitable for LLMNR or MulticastDNS, and any interface that is UP and |
ffd10e5a ZJS |
779 | has an IP address is suitable for DNS. Note the relationship of the bits exposed here with the LLMNR |
780 | and MulticastDNS properties also exposed on the Link interface. The latter expose what is *configured* | |
781 | to be used on the interface, the former expose what is actually used on the interface, taking into | |
782 | account the abilities of the interface.</para> | |
783 | ||
784 | <para><varname>DNSSECSupported</varname> exposes a boolean field that indicates whether DNSSEC is | |
ca264f7d | 785 | currently configured and in use on the interface. Note that if DNSSEC is enabled on an interface, it is |
ffd10e5a ZJS |
786 | assumed available until it is detected that the configured server does not actually support it. Thus, |
787 | this property may initially report that DNSSEC is supported on an interface.</para> | |
788 | ||
2ce49367 ZJS |
789 | <para><varname>DefaultRoute</varname> exposes a boolean field that indicates whether the interface will |
790 | be used as default route for name queries. See <function>SetLinkDefaultRoute()</function> above.</para> | |
791 | ||
ca264f7d | 792 | <para>The other properties reflect the state of the various configuration settings for the link which |
2ce49367 ZJS |
793 | may be set with the various methods calls such as <function>SetDNS()</function> or |
794 | <function>SetLLMNR()</function>.</para> | |
ffd10e5a ZJS |
795 | </refsect2> |
796 | </refsect1> | |
797 | ||
798 | <refsect1> | |
799 | <title>Common Errors</title> | |
800 | ||
ca264f7d DDM |
801 | <para>Many bus methods <filename>systemd-resolved</filename> exposes (in particular the resolver methods such |
802 | as <function>ResolveHostname()</function> on the <interfacename>Manager</interfacename> interface) may return | |
ffd10e5a ZJS |
803 | some of the following errors:</para> |
804 | ||
805 | <variablelist> | |
806 | <varlistentry><term><constant>org.freedesktop.resolve1.NoNameServers</constant></term> | |
ec07c3c8 AK |
807 | <listitem><para>No suitable DNS servers were found to resolve a request.</para> |
808 | ||
809 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
810 | </varlistentry> |
811 | ||
812 | <varlistentry><term><constant>org.freedesktop.resolve1.InvalidReply</constant></term> | |
ec07c3c8 AK |
813 | <listitem><para>A response from the selected DNS server was not understood.</para> |
814 | ||
815 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
816 | </varlistentry> |
817 | ||
818 | <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchRR</constant></term> | |
819 | <listitem><para>The requested name exists, but there is no resource record of the requested type for | |
ec07c3c8 AK |
820 | it. (This is the DNS NODATA case).</para> |
821 | ||
822 | <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry> | |
ffd10e5a ZJS |
823 | |
824 | <varlistentry><term><constant>org.freedesktop.resolve1.CNameLoop</constant></term> | |
ec07c3c8 AK |
825 | <listitem><para>The look-up failed because a CNAME or DNAME loop was detected.</para> |
826 | ||
827 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
828 | </varlistentry> |
829 | ||
830 | <varlistentry><term><constant>org.freedesktop.resolve1.Aborted</constant></term> | |
ca264f7d | 831 | <listitem><para>The look-up was aborted because the selected protocol became unavailable while the |
ec07c3c8 AK |
832 | operation was ongoing.</para> |
833 | ||
834 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
835 | </varlistentry> |
836 | ||
837 | <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchService</constant></term> | |
9a024bf1 | 838 | <listitem><para>A service look-up was successful, but the <constant class="dns">SRV</constant> record |
ec07c3c8 AK |
839 | reported that the service is not available.</para> |
840 | ||
841 | <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry> | |
ffd10e5a ZJS |
842 | |
843 | <varlistentry><term><constant>org.freedesktop.resolve1.DnssecFailed</constant></term> | |
ec07c3c8 AK |
844 | <listitem><para>The acquired response did not pass DNSSEC validation.</para> |
845 | ||
846 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
847 | </varlistentry> |
848 | ||
849 | <varlistentry><term><constant>org.freedesktop.resolve1.NoTrustAnchor</constant></term> | |
ca264f7d | 850 | <listitem><para>No chain of trust could be established for the response to a configured DNSSEC trust |
ec07c3c8 AK |
851 | anchor.</para> |
852 | ||
853 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
854 | </varlistentry> |
855 | ||
856 | <varlistentry><term><constant>org.freedesktop.resolve1.ResourceRecordTypeUnsupported</constant></term> | |
857 | <listitem><para>The requested resource record type is not supported on the selected DNS servers. This | |
858 | error is generated for example when an RRSIG record is requested from a DNS server that does not | |
ec07c3c8 AK |
859 | support DNSSEC.</para> |
860 | ||
861 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
862 | |
863 | </varlistentry> | |
864 | ||
865 | <varlistentry><term><constant>org.freedesktop.resolve1.NoSuchLink</constant></term> | |
866 | <listitem><para>No network interface with the specified network interface index exists. | |
ec07c3c8 AK |
867 | </para> |
868 | ||
869 | <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry> | |
ffd10e5a ZJS |
870 | |
871 | <varlistentry><term><constant>org.freedesktop.resolve1.LinkBusy</constant></term> | |
ca264f7d | 872 | <listitem><para>The requested configuration change could not be made because |
ffd10e5a | 873 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
ec07c3c8 AK |
874 | already took possession of the interface and supplied configuration data for it.</para> |
875 | ||
876 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
877 | </varlistentry> |
878 | ||
879 | <varlistentry><term><constant>org.freedesktop.resolve1.NetworkDown</constant></term> | |
880 | <listitem><para>The requested look-up failed because the system is currently not connected to any | |
ec07c3c8 AK |
881 | suitable network.</para> |
882 | ||
883 | <xi:include href="version-info.xml" xpointer="v246"/></listitem></varlistentry> | |
ffd10e5a ZJS |
884 | |
885 | <varlistentry><term><constant>org.freedesktop.resolve1.DnsError.NXDOMAIN</constant></term> | |
886 | <term><constant>org.freedesktop.resolve1.DnsError.REFUSED</constant></term> | |
887 | <term>...</term> | |
888 | <listitem><para>The look-up failed with a DNS return code reporting a failure. The error names used as | |
889 | suffixes here are defined in by IANA in | |
890 | <ulink url="https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6">DNS RCODEs</ulink>. | |
ec07c3c8 AK |
891 | </para> |
892 | ||
893 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
ffd10e5a ZJS |
894 | </varlistentry> |
895 | </variablelist> | |
896 | </refsect1> | |
897 | ||
48f99d7c ZJS |
898 | <refsect1> |
899 | <title>Examples</title> | |
900 | ||
901 | <example> | |
902 | <title>Introspect <interfacename>org.freedesktop.resolve1.Manager</interfacename> on the bus</title> | |
903 | ||
904 | <programlisting> | |
905 | $ gdbus introspect --system \ | |
906 | --dest org.freedesktop.resolve1 \ | |
907 | --object-path /org/freedesktop/resolve1 | |
908 | </programlisting> | |
909 | </example> | |
910 | ||
911 | <example> | |
912 | <title>Introspect <interfacename>org.freedesktop.resolve1.Link</interfacename> on the bus</title> | |
913 | ||
914 | <programlisting> | |
915 | $ gdbus introspect --system \ | |
916 | --dest org.freedesktop.resolve1 \ | |
917 | --object-path /org/freedesktop/resolve1/link/_11 | |
918 | </programlisting> | |
919 | </example> | |
920 | </refsect1> | |
921 | ||
e4239a34 | 922 | <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> |
ffd10e5a | 923 | </refentry> |