From 1fce55fab10260ae942cc46c6fee15d71a1403c2 Mon Sep 17 00:00:00 2001
From: Adam Ierymenko <adam.ierymenko@gmail.com>
Date: Wed, 17 Jul 2013 17:35:19 -0400
Subject: Add an echoed 32-bit token field to command packets.

---
 node/NodeConfig.hpp | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'node/NodeConfig.hpp')

diff --git a/node/NodeConfig.hpp b/node/NodeConfig.hpp
index bb24d815..66c99448 100644
--- a/node/NodeConfig.hpp
+++ b/node/NodeConfig.hpp
@@ -33,6 +33,7 @@
 #include <string>
 #include <vector>
 #include <stdexcept>
+
 #include <stdint.h>
 #include "SharedPtr.hpp"
 #include "Network.hpp"
@@ -45,7 +46,20 @@ namespace ZeroTier {
 class RuntimeEnvironment;
 
 /**
- * Node configuration holder and fetcher
+ * Node configuration endpoint
+ *
+ * Packet format for local UDP configuration packets:
+ *  [8] random initialization vector
+ *  [16] first 16 bytes of HMAC-SHA-256 of payload
+ *  [4] arbitrary tag, echoed in response
+ *  [...] payload
+ *
+ * For requests, the payload consists of a single ASCII command. For
+ * responses, the payload consists of one or more response lines delimited
+ * by NULL (0) characters. The tag field is replicated in the result
+ * packet.
+ *
+ * TODO: further document use of keys, encryption...
  */
 class NodeConfig
 {
-- 
cgit v1.2.3