Merge pull request #29 from yggdrasil-network/v0.3.1

Version 0.3.1

admin.md

@@ -296,10 +296,20 @@ Expects:
 - `coords=` `string`, location of the remote node in the network, in the same format as e.g. a `getDHT` response
 - `target=` `string`, hex-encoded 512-bit NodeID to ask about, affects what the response from the remote node will be, optional
 
-Asks a remote node to respond with information from the DHT
+Asks a remote node to respond with information from the DHT.
 
 Returns a `nodes` section with information about each node included in the DHT lookup response, indexed by IPv6.
 
 For each IPv6 address, this includes:
 - `box_pub_key` (`string`) contains the `EncryptionPublicKey` of the remote node
 - `coords` (`string`) contains the coordinates of the node on the spanning tree
+
+#### `getNodeInfo`
+
+Expects:
+- `box_pub_key=` `string`, hex-encoded public key of the remote node to ping, in the same format as e.g. verbose output from a `getDHT` response
+- `coords=` `string`, location of the remote node in the network, in the same format as e.g. a `getDHT` response
+
+Asks a remote node to respond with their nodeinfo.
+
+Returns a `nodeinfo` section with the nodeinfo. This can be in any format, containing any keys.

changelog.md

@@ -25,6 +25,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - in case of vulnerabilities.
 -->
 
+## [0.3.1] - 2018-12-17
+### Added
+- Build name and version is now imprinted onto the binaries if available/specified during build
+- Ability to disable admin socket with `AdminListen: none`
+- `AF_UNIX` domain sockets for the admin socket
+- Cache size restriction for crypto-key routes
+- `NodeInfo` support for specifying node information, e.g. node name or contact, which can be used in network crawls or surveys
+- `getNodeInfo` request added to admin socket
+- Adds flags `-c`, `-l` and `-t` to `build` script for specifying `GCFLAGS`, `LDFLAGS` or whether to keep symbol/DWARF tables
+
+### Changed
+- Default `AdminListen` in newly generated config is now `unix:///var/run/yggdrasil.sock`
+- Formatting of `getRoutes` in the admin socket has been improved
+- Debian package now adds `yggdrasil` group to assist with `AF_UNIX` admin socket permissions
+- Crypto, address and other utility code refactored into separate Go packages
+
+### Fixed
+- Switch peer convergence is now much faster again (previously it was taking up to a minute once the peering was established)
+- `yggdrasilctl` is now less prone to crashing when parameters are specified incorrectly
+- Panic fixed when `Peers` or `InterfacePeers` was commented out
+
 ## [0.3.0] - 2018-12-12
 ### Added
 - Crypto-key routing support for tunnelling both IPv4 and IPv6 over Yggdrasil

configuration.md

@@ -173,6 +173,11 @@ A new configuration file has the following format. Please note that some of the
     # Maximum size of all switch queues combined (in bytes).
     MaxTotalQueueSize: 4194304
   }
+
+  # Optional node info. This must be a { "key": "value", ... } map
+  # or set as null. This is entirely optional but, if set, is visible
+  # to the whole network on request.
+  NodeInfo: {}
 }
 ```
 
@@ -279,6 +284,18 @@ Note that any field not specified in the configuration will use its default valu
     - Contains the following configuration options:
         - `MaxTotalQueueSize`
             - The maximum allowed size, in bytes, of all local switch queues combined. Default is `4194304` (or 4MB).
+- `NodeInfo`
+    - Public information about your node. This information can be requested by any node and may be particularly useful for crawlers and network surveys.
+    - There are no set options - you can freely enter any valid HJSON or JSON (whichever your configuration file is using).
+    - An example of some ways in which you may populate nodeinfo:
+    ```
+NodeInfo:
+{
+    name: hostname.y.domain.com
+    contact: email@domain.com
+    location: Place, Country
+}
+    ```
 
 # Use Cases