]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
DNSSEC doco fixes.
authorBob Halley <halley@dnspython.org>
Fri, 23 Dec 2022 17:19:47 +0000 (09:19 -0800)
committerBob Halley <halley@dnspython.org>
Fri, 23 Dec 2022 17:19:47 +0000 (09:19 -0800)
dns/dnssec.py
doc/dnssec.rst

index 3589b1f14cf4a09cf14c3fac398dbdbd1002a2bd..d380ea17dbd1112c423553666482ff257e98ec12 100644 (file)
@@ -111,7 +111,7 @@ def to_timestamp(value: Union[datetime, str, float, int]) -> int:
         raise TypeError("Unsupported timestamp type")
 
 
-def key_id(key: Union[DNSKEY,CDNSKEY]) -> int:
+def key_id(key: Union[DNSKEY, CDNSKEY]) -> int:
     """Return the key id (a 16-bit number) for the specified key.
 
     *key*, a ``dns.rdtypes.ANY.DNSKEY.DNSKEY``
@@ -201,7 +201,7 @@ def make_ds(
     The currently supported hashes are "SHA1", "SHA256", and "SHA384". Case
     does not matter for these strings.
 
-    *origin*, a ``dns.name.Name`` or ``None``.  If `key` is a relative name,
+    *origin*, a ``dns.name.Name`` or ``None``.  If *key* is a relative name,
     then it will be made absolute using the specified origin.
 
     *policy*, a ``dns.dnssec.Policy`` or ``None``.  If ``None``, the default policy,
@@ -274,7 +274,7 @@ def make_cds(
     The currently supported hashes are "SHA1", "SHA256", and "SHA384". Case
     does not matter for these strings.
 
-    *origin*, a ``dns.name.Name`` or ``None``.  If `key` is a relative name,
+    *origin*, a ``dns.name.Name`` or ``None``.  If *key* is a relative name,
     then it will be made absolute using the specified origin.
 
     Raises ``UnsupportedAlgorithm`` if the algorithm is unknown.
@@ -888,7 +888,7 @@ def _make_dnskey(
 
     *algorithm*, a ``str`` or ``int`` specifying the DNSKEY algorithm.
 
-    *flags: DNSKEY flags field as an integer.
+    *flags*: DNSKEY flags field as an integer.
 
     *protocol*: DNSKEY protocol field as an integer.
 
@@ -982,7 +982,7 @@ def _make_cdnskey(
 
     *algorithm*, a ``str`` or ``int`` specifying the DNSKEY algorithm.
 
-    *flags: DNSKEY flags field as an integer.
+    *flags*: DNSKEY flags field as an integer.
 
     *protocol*: DNSKEY protocol field as an integer.
 
index 71b4b608bcfb4858b44ac9901b9a53b90195bbca..b14be628cc0e7f9010d009a8688ac2af958b82c7 100644 (file)
@@ -14,11 +14,17 @@ DNSSEC Functions
 .. autofunction:: dns.dnssec.algorithm_to_text
 .. autofunction:: dns.dnssec.key_id
 .. autofunction:: dns.dnssec.make_ds
+.. autofunction:: dns.dnssec.make_cds
 .. autofunction:: dns.dnssec.make_dnskey
+.. autofunction:: dns.dnssec.make_cdnskey()
 .. autofunction:: dns.dnssec.sign
 .. autofunction:: dns.dnssec.validate
 .. autofunction:: dns.dnssec.validate_rrsig
 .. autofunction:: dns.dnssec.nsec3_hash
+.. autofunction:: dns.dnssec.make_ds_rdataset()
+.. autofunction:: dns.dnssec.cds_rdataset_to_ds_rdataset()
+.. autofunction:: dns.dnssec.dnskey_rdataset_to_cds_rdataset()
+.. autofunction:: dns.dnssec.dnskey_rdataset_to_cdnskey_rdataset()
 
 DNSSEC Algorithms
 -----------------