]> granicus.if.org Git - pdns/commitdiff
Small documentation fixes
authorPieter Lexis <pieter.lexis@powerdns.com>
Wed, 21 Mar 2018 16:17:29 +0000 (17:17 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Wed, 21 Mar 2018 16:17:29 +0000 (17:17 +0100)
pdns/dnsdistdist/docs/reference/dnscrypt.rst

index 9e67e999a29408de0e75b654370e1f5bc36a1f1f..c597dbecbfb5585109f5666627df51d2c270d28e 100644 (file)
@@ -26,7 +26,8 @@ DNSCrypt objects and functions
   :param string publicKey: path to write the public key to
   :param string privateKey: path to write the private key to
 
-.. function:: generateDNSCryptCertificate(privatekey, certificate, keyfile, serial, validFrom, validUntil, version)
+.. function:: generateDNSCryptCertificate(privatekey, certificate, keyfile, serial, validFrom, validUntil[, version])
+
   .. versionchanged:: 1.3.0
     ``version`` optional parameter added.
 
@@ -144,6 +145,27 @@ Context
     :param int end: Unix timestamp from until the certificate is valid
     :param DNSCryptExchangeVersion version: The exchange version to use. Possible values are ``DNSCryptExchangeVersion::VERSION1`` (default, X25519-XSalsa20Poly1305) and ``DNSCryptExchangeVersion::VERSION2`` (X25519-XChacha20Poly1305)
 
+  .. method:: DNSCryptContext:getCurrentCertificate() -> DNSCryptCert
+
+    .. deprecated:: 1.3.0
+      Removed as it relied on one certificate. See :meth:`DNSCryptContext:getCertificate`.
+
+   Return the current certificate.
+
+  .. method:: DNSCryptContext:getOldCertificate() -> DNSCryptCert
+
+    .. deprecated:: 1.3.0
+      Removed as it relied on one certificate.
+
+   Return the previous certificate.
+
+  .. method:: DNSCryptContext:hasOldCertificate() -> bool
+
+    .. deprecated:: 1.3.0
+      Removed as it relied on one certificate.
+
+    Whether or not the context has a previous certificate, from a certificate rotation.
+
   .. method:: DNSCryptContext:getCertificate(index) -> DNSCryptCert
 
     .. versionadded:: 1.3.0