1 Per zone settings: Domain Metadata
2 ==================================
4 Each served zone can have "metadata". Such metadata determines how this
5 zone behaves in certain circumstances.
8 Domain metadata is only available for DNSSEC capable
9 backends! Make sure to enable the proper '-dnssec' setting to benefit.
11 For the BIND backend, this information is either stored in the
12 :ref:`setting-bind-dnssec-db` or the hybrid database,
13 depending on your settings.
15 For the implementation in non-sql backends, please review your backend's
18 Apart from raw SQL statements, setting domain metadata can be done with
19 ``pdnsutil set-meta`` and retrieving metadata is done with ``pdnsutil get-meta``.
21 .. _metadata-allow-axfr-from:
26 Per-zone AXFR ACLs can be stored in the domainmetadata table.
28 Each ACL specifies one subnet (v4 or v6), or the magical value 'AUTO-NS'
29 that tries to allow all potential slaves in.
35 pdnsutil set-meta powerdns.org ALLOW-AXFR-FROM AUTO-NS 2001:db8::/48
37 Each ACL has its own row in the database:
41 select id from domains where name='example.com';
43 insert into domainmetadata (domain_id, kind, content) values (7,'ALLOW-AXFR-FROM','AUTO-NS');
44 insert into domainmetadata (domain_id, kind, content) values (7,'ALLOW-AXFR-FROM','2001:db8::/48');
46 To disallow all IP's, except those explicitly allowed by domainmetadata
47 records, add ``allow-axfr-ips=`` to ``pdns.conf``.
49 .. _metadata-api-rectify:
53 .. versionadded:: 4.1.0
55 This metadata item controls whether or not a zone is fully rectified on changes
56 to the contents of a zone made through the :doc:`API <http-api/index>`.
58 When the ``API-RECTIFY`` value is "1", the zone will be rectified on changes.
59 Any other other value means that it will not be rectified. If this is not set
60 at all, rectifying of the zone depends on the config variable
61 :ref:`setting-default-api-rectify`.
63 .. _metadata-axfr-source:
68 The IP address to use as a source address for sending AXFR and IXFR
71 ALLOW-DNSUPDATE-FROM, TSIG-ALLOW-DNSUPDATE, FORWARD-DNSUPDATE, SOA-EDIT-DNSUPDATE, NOTIFY-DNSUPDATE
72 ---------------------------------------------------------------------------------------------------
74 See the documentation on :ref:`Dynamic DNS update <dnsupdate-metadata>`.
76 .. _metadata-also-notify:
81 When notifying this domain, also notify this nameserver (can occur
82 multiple times). The nameserver may have contain an optional port
87 pdnsutil set-meta powerdns.org ALSO-NOTIFY 192.0.2.1:5300
88 pdnsutil set-meta powerdns.org ALLOW-AXFR-FROM 2001:db8:53::1
94 insert into domainmetadata (domain_id, kind, content) values (7,'ALSO-NOTIFY','192.0.2.1:5300');
95 insert into domainmetadata (domain_id, kind, content) values (7,'ALLOW-AXFR-FROM','2001:db8:53::1');
100 Use this named TSIG key to retrieve this zone from its master, see :ref:`tsig-provision-signed-notify-axfr`.
102 GSS-ALLOW-AXFR-PRINCIPAL
103 ------------------------
105 Allow this GSS principal to perform AXFR retrieval. Most commonly it is
106 ``host/something@REALM``, ``DNS/something@REALM`` or ``user@REALM``.
107 (See :ref:`tsig-gss-tsig`).
109 GSS-ACCEPTOR-PRINCIPAL
110 ----------------------
112 Use this principal for accepting GSS context.
113 (See :ref:`tsig-gss-tsig`).
118 If set to 1, attempt IXFR when retrieving zone updates. Otherwise IXFR
124 Script to be used to edit incoming AXFRs, see :ref:`modes-of-operation-axfrfilter`.
125 This value will override the :ref:`setting-lua-axfr-script` setting. Use
126 'NONE' to remove a global script.
131 Set to "1" to tell PowerDNS this zone operates in NSEC3 'narrow' mode.
132 See ``set-nsec3`` for :doc:`pdnsutil <dnssec/pdnsutil>`.
137 NSEC3 parameters of a DNSSEC zone. Will be used to synthesize the
138 NSEC3PARAM record. If present, NSEC3 is used, if not present, zones
139 default to NSEC. See ``set-nsec3`` in :doc:`pdnsutil <dnssec/pdnsutil>`.
140 Example content: "1 0 1 ab".
142 .. _metadata-presigned:
147 This zone carries DNSSEC RRSIGs (signatures), and is presigned. PowerDNS
148 sets this flag automatically upon incoming zone transfers (AXFR) if it
149 detects DNSSEC records in the zone. However, if you import a presigned
150 zone using ``zone2sql`` or ``pdnsutil load-zone`` you must explicitly
151 set the zone to be ``PRESIGNED``. Note that PowerDNS will not be able to
152 correctly serve the zone if the imported data is bogus or incomplete.
153 Also see ``set-presigned`` in :doc:`pdnsutil <dnssec/pdnsutil>`.
155 If a zone is presigned, the content of the metadata must be "1" (without
156 the quotes). Any other value will not signal presignedness.
158 PUBLISH-CDNSKEY, PUBLISH-CDS
159 ----------------------------
161 Whether to publish CDNSKEY and/or CDS recording defined in :rfc:`7344`.
163 To publish CDNSKEY records of the KSKs for the zone, set
164 ``PUBLISH-CDNSKEY`` to ``1``.
166 To publish CDS records for the KSKs in the zone, set ``PUBLISH-CDS`` to
167 a comma- separated list of `signature algorithm
168 numbers <http://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml#ds-rr-types-1>`__.
170 This metadata can also be set using the
171 :doc:`pdnsutil <dnssec/pdnsutil>` commands ``set-publish-cdnskey``
172 and ``set-publish-cds``. For an example for an :rfc:`7344` key rollover,
173 see the :doc:`guides/kskrollcdnskey`.
175 .. _metadata-soa-edit:
180 When serving this zone, modify the SOA serial number in one of several
181 ways. Mostly useful to get slaves to re-transfer a zone regularly to get
182 fresh RRSIGs. See the :ref:`DNSSEC
183 documentation <soa-edit-ensure-signature-freshness-on-slaves>`
184 for more information.
186 .. _metadata-soa-edit-api:
191 On changes to the contents of a zone made through the :doc:`API <http-api/index>`,
192 the SOA record will be edited according to the SOA-EDIT-API rules. These rules
193 are the same as the :ref:`SOA-EDIT-DNSUPDATE <dnsupdate-soa-serial-updates>` rules.
194 If not set during zone creation, a SOA-EDIT-API metadata record is created and set to ``DEFAULT``.
195 If this record is removed from the backend, the default behaviour is to not do any SOA editing based on this setting.
196 This is different from setting ``DEFAULT``.
202 Allow these named TSIG keys to AXFR this zone, see :ref:`tsig-provision-signed-notify-axfr`.
207 This setting allows you to set the TSIG key required to do an :doc:`dnsupdate`.
208 If :ref:`GSS-TSIG <tsig-gss-tsig>` is enabled, you can put kerberos principals here as well.
213 Through the API and on the ``pdnsutil set-meta`` commandline, metadata
214 unused by PowerDNS can be added. It is mandatory to prefix this extra
215 metadata with "X-" and the name of the external application; the API
216 will only allow this metadata if it starts with "X-".