Dns over quic support: bis

.travis.yml

@@ -12,6 +12,7 @@ matrix:
             - libssl-dev
             - libgnutls28-dev
             - libnghttp2-dev
+            - openssl
 #    - os: osx
 #      addons:
 #        homebrew:
@@ -26,8 +27,16 @@ matrix:
 before_script:
   - if [ "${TRAVIS_OS_NAME}" = linux ]; then sh ci/install-libuv.sh; fi
   - if [ "${TRAVIS_OS_NAME}" = linux ]; then sh ci/install-ldns.sh; fi
+  - sh ci/install-quicly.sh
 
 script:
+  - ln -s /tmp/quicly 3rd/
   - mkdir build && cd build && cmake ..
   - make all tests
   - ./tests
+  - cd ..
+  - mkdir quic-build && cd quic-build
+  - if [ "${TRAVIS_OS_NAME}" = linux ]; then cmake -DQUIC_ENABLE=ON ..; fi
+  - if [ "${TRAVIS_OS_NAME}" = osx ]; then PKG_CONFIG_PATH=/usr/local/opt/openssl@1.1/lib/pkgconfig cmake -DQUIC_ENABLE=ON ..; fi
+  - make all tests
+  - ./tests

CMakeLists.txt

@@ -51,6 +51,15 @@ pkg_search_module(LIBLDNS REQUIRED libldns ldns)
 pkg_check_modules(LIBUV REQUIRED libuv>=1.23)
 pkg_check_modules(LIBGNUTLS REQUIRED gnutls>=3.3)
 
+option(DOQ_ENABLE "Enable QUIC support" OFF)
+if (DOQ_ENABLE)
+    pkg_check_modules(OPENSSL REQUIRED libcrypto>=1.0.2)
+    message(STATUS "QUIC support is enabled")
+    add_definitions(-DDOQ_ENABLE)
+else()
+    message(STATUS "QUIC support is disabled")
+endif()
+
 option(DOH_ENABLE "Enable DNS over HTTPS (DoH) support" OFF)
 option(USE_HTTP_PARSER "Use http_parse library instead of url_parse" OFF)
 if (DOH_ENABLE)
@@ -178,6 +187,31 @@ if (DOH_ENABLE)
         )
 endif()
 
+if (DOQ_ENABLE)
+    set(flamecore_src 
+        ${flamecore_src}
+        flame/quicsession.cpp
+        flame/quicsession.h
+        3rd/quicly/deps/picotls/lib/openssl.c
+        3rd/quicly/deps/picotls/lib/pembase64.c
+        3rd/quicly/deps/picotls/lib/picotls.c
+        )
+
+    set(flamecore_dirs
+        ${flamecore_dirs}
+        PUBLIC ${OPENSSL_INCLUDE_DIRS}
+        PUBLIC "${CMAKE_SOURCE_DIR}/3rd/quicly/include"
+        PUBLIC "${CMAKE_SOURCE_DIR}/3rd/quicly/deps/picotls/include"
+        )
+
+    set(flamecore_libs
+        ${flamecore_libs}
+        PRIVATE ${OPENSSL_LIBRARIES}
+        PRIVATE "-L ${CMAKE_SOURCE_DIR}/3rd/quicly/build/ -lquicly"
+        PUBLIC ${OPENSSL_LDFLAGS}
+        )
+endif()
+
 add_library(flamecore ${flamecore_src})
 
 target_include_directories(flamecore ${flamecore_dirs})

README.md

@@ -9,7 +9,9 @@ A DNS performance and functional testing utility.
 Overview
 --------
 
-Flamethrower is a small, fast, configurable tool for functional testing, benchmarking, and stress testing DNS servers and networks. It supports IPv4, IPv6, UDP, TCP, DoT, and DoH and has a modular system for generating queries used in the tests.
+Flamethrower is a small, fast, configurable tool for functional testing, benchmarking, and stress testing DNS servers and networks. It supports IPv4, IPv6, UDP, TCP, DoT, DoH, and DoQ and has a modular system for generating queries used in the tests.
+
+The support of DNS-over-QUIC is experimental, following the draft RFC https://datatracker.ietf.org/doc/draft-huitema-quic-dnsoquic/
 
 Originally built as an alternative to [dnsperf](https://github.com/DNS-OARC/dnsperf), many of the command line options are compatible.
 
@@ -120,6 +122,10 @@ Optional dependencies:
 * nlohmann-json >= 3.7.3
 * cpp-httplib
 
+Optional experimental DoQ support requires:
+ * quicly https://github.com/h2o/quicly
+ * openssl >= 1.0.2
+
 Building
 --------
 
@@ -139,6 +145,25 @@ cmake -DDOH_ENABLE=ON ..
 make
 ```
 
+To build with DoQ support, first checkout and build quicly:
+```
+git clone https://github.com/h2o/quicly.git
+cd quicly
+git submodule update --init --recursive
+mkdir build; cd build
+cmake ..
+make
+```
+the name of the "build" directory used to build quicly is significant, as it's referenced in the flamethrower paths.
+You then need to manually symlink quicly into the flamethrower 3rd party directory before enabling support in flamethrower and building:
+```
+cd flamethrower
+ln -s <PATH-TO-QUICLY> 3rd/
+mkdir build; cd build
+cmake -DQUIC_ENABLE=ON ..
+make
+```
+
 Building the docker image:
 ```
 org="myorg"
@@ -155,4 +180,3 @@ Pull Requests and issues are welcome. See the [NS1 Contribution Guidelines](http
 License
 -------
 This code is released under Apache License 2.0. You can find terms and conditions in the LICENSE file.
-

ci/install-quicly.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+GITREPO="https://github.com/h2o/quicly"
+
+set -ex
+
+cd /tmp
+git clone "$GITREPO"
+cd quicly
+
+git submodule update --init --recursive
+if [ "$TRAVIS_OS_NAME" = "osx" ];
+then
+    export PKG_CONFIG_PATH=/usr/local/opt/openssl@1.1/lib/pkgconfig
+fi
+mkdir build && cd build
+cmake ..
+make
+

flame/flame.h.in

@@ -0,0 +1,3 @@
+#cmakedefine QUIC_ENABLE
+#cmakedefine FLAME_VERSION_NUM "@PROJECT_VERSION@"
+#cmakedefine FLAME_VERSION "@FLAME_VERSION@"

flame/main.cpp

@@ -1,4 +1,4 @@
-// Copyright 2017 NSONE, Inc
+// Copyright 2017-2019 NSONE, Inc
 
 #include <iostream>
 #include <iterator>
@@ -62,9 +62,9 @@ static const char USAGE[] =
       -r RECORD        The base record to use as the DNS query for generators [default: test.com]
       -T QTYPE         The query type to use for generators [default: A]
       -f FILE          Read records from FILE, one per row, QNAME TYPE
-      -p PORT          Which port to flame [defaults: 53, 443 for DoH, 853 for DoT]
+      -p PORT          Which port to flame [defaults: 53, 443 for DoH, 853 for DoT, 853 for DoQ]
       -F FAMILY        Internet family (inet/inet6) [default: inet]
-      -P PROTOCOL      Protocol to use (udp/tcp/dot/doh) [default: udp]
+      -P PROTOCOL      Protocol to use (udp/tcp/dot/doh/doq) [default: udp]
       -M HTTPMETHOD    HTTP method to use (POST/GET) when DoH is used [default: GET]
       -g GENERATOR     Generate queries with the given generator [default: static]
       -o FILE          Metrics output file, JSON format
@@ -244,8 +244,17 @@ int main(int argc, char *argv[])
             c_count = 30;
     } else if (args["-P"].asString() == "udp") {
         proto = Protocol::UDP;
-    } else {
-        std::cerr << "protocol must be 'udp', 'tcp', dot' or 'doh'" << std::endl;
+    }
+    else if (args["-P"].asString() == "doq") {
+#ifdef DOQ_ENABLE
+        proto = Protocol::DOQ;
+#else
+			std::cerr << "DNS over QUIC support is not enabled" << std::endl;
+			return 1;
+#endif
+    }
+    else {
+        std::cerr << "protocol must be 'udp', 'tcp', 'dot', 'doh', 'doq'" << std::endl;
         return 1;
     }
 
@@ -256,7 +265,11 @@ int main(int argc, char *argv[])
         else if (proto == Protocol::DOH)
             args["-p"] = std::string("443");
 #endif
-        else
+#ifdef DOQ_ENABLE
+        else if (proto == Protocol::DOQ)
+            args["-p"] = std::string("853");
+#endif
+        else 
             args["-p"] = std::string("53");
     }
 

flame/metrics.cpp

@@ -103,7 +103,11 @@ void MetricsMgr::flush_to_disk()
     j["runtime_s"] = _runtime_s;
     j["run_id"] = _run_id;
     for (auto i : _response_codes) {
-        j["total_responses"][ldns_lookup_by_id(ldns_rcodes, i.first)->name] = i.second;
+        ldns_lookup_table* msg = ldns_lookup_by_id(ldns_rcodes, i.first);
+        if (msg)
+            j["total_responses"][msg->name] = i.second;
+        else
+            j["total_responses"]["Unknown rcode (" + std::to_string(i.second) + ")"] = i.second;
     }
     _metric_file << j << std::endl;
 }
@@ -131,7 +135,11 @@ void MetricsMgr::display_final_text()
     if (_response_codes.size()) {
         std::cout << "responses   :" << std::endl;
         for (auto i : _response_codes) {
-            std::cout << "  " << ldns_lookup_by_id(ldns_rcodes, i.first)->name << ": " << i.second << std::endl;
+            ldns_lookup_table* msg = ldns_lookup_by_id(ldns_rcodes, i.first);
+            if (msg)
+                std::cout << "  " << msg->name << ": " << i.second << std::endl;
+            else
+                std::cout << "  Unknown rcode (" << std::to_string(i.first) << "): " << i.second << std::endl;
         }
     }
 }

flame/query.cpp

@@ -186,6 +186,24 @@ QueryGenerator::QueryTpt QueryGenerator::next_tcp(const std::vector<uint16_t> &i
     return std::make_tuple(std::move(buf), total_len);
 }
 
+QueryGenerator::QueryTpt QueryGenerator::next_tcp(uint16_t id)
+{
+
+    WireTpt w = _wire_buffers[_reqs++ % _wire_buffers.size()];
+    size_t len{2 + w.second};
+
+    auto buf = std::make_unique<char[]>(len);
+    // write pkt len
+    uint16_t plen = htons(w.second);
+    memcpy(buf.get(), &plen, sizeof(plen));
+    // write wire
+    memcpy(buf.get() + 2, w.first, w.second);
+    // write id requested
+    uint16_t _id = ntohs(id);
+    memcpy(buf.get() + 2, &_id, sizeof(_id));
+    return std::make_tuple(std::move(buf), len);
+}
+
 QueryGenerator::QueryTpt QueryGenerator::next_udp(uint16_t id)
 {
 
@@ -634,6 +652,11 @@ QueryGenerator::QueryTpt NumberNameQueryGenerator::next_tcp(const std::vector<ui
     throw std::runtime_error("tcp unsupported");
 }
 
+QueryGenerator::QueryTpt NumberNameQueryGenerator::next_tcp(uint16_t id)
+{
+    throw std::runtime_error("tcp unsupported");
+}
+
 QueryGenerator::QueryTpt NumberNameQueryGenerator::next_udp(uint16_t id)
 {
 

flame/query.h

@@ -73,6 +73,7 @@ class QueryGenerator
 #endif
     virtual QueryTpt next_udp(uint16_t);
     virtual QueryTpt next_tcp(const std::vector<uint16_t> &);
+    virtual QueryTpt next_tcp(uint16_t);
     bool finished();
 
     virtual const char *name() = 0;
@@ -254,6 +255,7 @@ class NumberNameQueryGenerator : public QueryGenerator
     //QueryTpt next_base64url(uint16_t);
     QueryTpt next_udp(uint16_t);
     QueryTpt next_tcp(const std::vector<uint16_t> &);
+    QueryTpt next_tcp(uint16_t);
 
     const char *name()
     {