]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
rename experimental dot module to experimental_dot_auth
authorPetr Špaček <petr.spacek@nic.cz>
Wed, 5 Dec 2018 14:49:49 +0000 (15:49 +0100)
committerPetr Špaček <petr.spacek@nic.cz>
Wed, 5 Dec 2018 15:21:46 +0000 (15:21 +0000)
doc/modules.rst
modules/dot/dot.mk [deleted file]
modules/experimental_dot_auth/README.rst [moved from modules/dot/README.rst with 85% similarity]
modules/experimental_dot_auth/basexx.lua [moved from modules/dot/basexx.lua with 100% similarity]
modules/experimental_dot_auth/experimental_dot_auth.lua [moved from modules/dot/dot.lua with 100% similarity]
modules/experimental_dot_auth/experimental_dot_auth.mk [new file with mode: 0644]
modules/modules.mk

index 6a9aa349b5759119855c6b0e220dc86e3d6488d9..ce659408d9e810cd6c51af6e65831d8e13e2cf1f 100644 (file)
@@ -34,3 +34,4 @@ Knot Resolver modules
 .. include:: ../modules/prefill/README.rst
 .. include:: ../modules/serve_stale/README.rst
 .. include:: ../modules/edns_keepalive/README.rst
+.. include:: ../modules/experimental_dot_auth/README.rst
diff --git a/modules/dot/dot.mk b/modules/dot/dot.mk
deleted file mode 100644 (file)
index bc95128..0000000
+++ /dev/null
@@ -1,2 +0,0 @@
-dot_SOURCES := dot.lua
-$(call make_lua_module,dot)
similarity index 85%
rename from modules/dot/README.rst
rename to modules/experimental_dot_auth/README.rst
index 11cee686e1ebf327025a70c5970e0da9d3848dfc..ddfd51d38b7a12ed20a1b4a31d21ec7935ffd3c2 100644 (file)
@@ -1,18 +1,12 @@
-.. _mod-dot:
+.. _mod-experimental_dot_auth:
 
-DNS-over-TLS (DoT) Auto-discovery
----------------------------------
+Experimental DNS-over-TLS (DoT) Auto-discovery
+----------------------------------------------
 
 DoT module enables automatic discovery of authoritative servers' SPKI
 fingerprint via the use of magic NS names. It is very similar to `dnscurve`_ mechanism.
 
-.. warning:: This module is experimental.
-
-Requirements
-^^^^^^^^^^^^
-
-At the time of this writting, this module is to be built on top of the
-`cloudflare`_ branch of knot-resolver.
+.. warning:: This module is experimental and can be changed or removed at any time. Use at own risk, security properties were not tested!
 
 How it works
 ^^^^^^^^^^^^
@@ -73,15 +67,14 @@ To enable the module, add this stanza to your config:
 .. code-block:: lua
 
        -- Load the module
-       modules.load('dot')
+       modules.load('experimental_dot_auth')
 
 Caveats
 ^^^^^^^
 
 The module relies on seeing the reply of the NS query and as such will not work
-if knot-resolver use its cache. You may need to delete the cache before starting ``kresd`` to work around this.
+if Knot Resolver use its cache. You may need to delete the cache before starting ``kresd`` to work around this.
 
 The module also assumes that the NS query answer will return both the NS targets in the Authority section as well as the glue records in the Additional section.
 
 .. _dnscurve: https://dnscurve.org/
-.. _cloudflare: https://gitlab.labs.nic.cz/knot/knot-resolver/tree/cloudflare
diff --git a/modules/experimental_dot_auth/experimental_dot_auth.mk b/modules/experimental_dot_auth/experimental_dot_auth.mk
new file mode 100644 (file)
index 0000000..dba4d9e
--- /dev/null
@@ -0,0 +1,2 @@
+experimental_dot_auth_SOURCES := experimental_dot_auth.lua
+$(call make_lua_module,experimental_dot_auth)
index 1189db83059a5772724f07f426b789ff1a98455a..71c79b12ee280952a0ccc14974ed4829f5ad4dd0 100644 (file)
@@ -17,7 +17,7 @@ modules_TARGETS += bogus_log \
                   nsid \
                   etcd \
                    ta_sentinel \
-                   dot \
+                   experimental_dot_auth \
                    graphite \
                    policy \
                    view \