Merge pull request #23 from zevv/binaryBroker

Implement a MQTT broker binary

Author: ThomasTJdev

.gitignore

@@ -1,4 +1,5 @@
-test/connection
-test/subscribe
-test/publish
-test/tester
+test/tester
+nmqtt
+nmqtt_password
+nmqtt_pub
+nmqtt_sub

README.md

@@ -1,12 +1,14 @@
 # Native Nim MQTT client library
 
 This is a hybrid package including a native Nim MQTT library and
-binaries for publishing and subscribing to a MQTT-broker.
+binaries for a MQTT broker, publisher and subscriber.
 
 * [Install](#Install)
 * [Binaries](#Binaries)
-  * [Publish](#Publish)
-  * [Subscribe](#Subscribe)
+  * [nmqtt](#nmqtt)
+  * [nmqtt_password](#nmqtt_password)
+  * [nmqtt_pub](#nmqtt_pub)
+  * [nmqtt_sub](#nmqtt_sub)
 * [Library](#Library)
   * [Examples](#Examples)
   * [Procs](#Procs)
@@ -27,11 +29,72 @@ $ nimble install
 
 # Binaries
 
-The package provides 2 binaries for publishing messages to a MQTT-broker and
-for subscribing to a MQTT-broker.
+The package provides 4 MQTT binaries:
+1) `nmqtt` -> Broker
+2) `nmqtt_password` -> Password utility for the broker
+3) `nmqtt_pub` -> MQTT publisher
+4) `nmqtt_sub` -> MQTT subscriber
 
-## Publish
-```bash
+
+## nmqtt
+```
+$ nmqtt --help
+nmqtt is a MQTT v3.1.1 broker
+
+USAGE
+  nmqtt [options]
+  nmqtt [-c /path/to/config.conf]
+  nmqtt [-h hostIP -p port]
+
+CONFIG
+  Use the configuration file for detailed settings,
+  such as SSL, adjusting keep alive timer, etc. or
+  specify options at the command line.
+
+  To add and delete users from the password file
+  please use nmqtt_password:
+    - nmqtt_password -a|-b|-d [options]
+
+OPTIONS
+  -?, --help          print this cligen-erated help
+  -c=, --config=      absolute path to the config file. Overrides all other options.
+  -h=, --host=        IP-address to serve the broker on.
+  -p=, --port=        network port to accept connecting from.
+  -v=, --verbosity=   verbosity from 0-3.
+  --max-conn=         max simultaneous connections. Defaults to no limit.
+  --clientid-maxlen=  max lenght of clientid. Defaults to 65535.
+  --clientid-spaces   allow spaces in clientid. Defaults to false.
+  --clientid-empty    allow empty clientid and assign random id. Defaults to false.
+  --client-kickold    kick old client, if new client has same clientid. Defaults to false.
+  --clientid-pass     pass clientid in payload {clientid:payload}. Defaults to false.
+  --password-file=    absolute path to the password file
+```
+_SSL is not supported_
+
+
+## nmqtt_password
+```
+$ nmqtt_password --help
+Add users and passwords to nmqtt's password file.
+
+USAGE
+  nmqtt_password -a {password_file.conf} {username}
+  nmqtt_password -b {password_file.conf} {username} {password}
+  nmqtt_password -d {password_file.conf} {username}
+
+CONFIG
+  Add or delete users from nmqtt password file.
+
+OPTIONS
+  -?, --help     print this cligen-erated help
+  -a, --adduser  add a new user to the password file.
+  -b, --batch    run in batch mode to allow passing passwords on the command line.
+  -d, --deluser  delete a user form the password file.
+```
+
+
+## nmqtt_pub
+```
 $ ./nmqtt_pub --help
 Publish MQTT messages to a MQTT-broker.
 
@@ -65,8 +128,8 @@ OPTIONS
 _`-verbose` not implemented yet_
 
 
-## Subscribe
-```bash
+## nmqtt_sub
+```
 $ ./nmqtt_sub --help
 Subscribe to a topic on a MQTT-broker.
 

config/nmqtt.conf

@@ -0,0 +1,64 @@
+# Config file for nmqtt
+#
+# Source code is available at https://github.com/zevv/nmqtt
+#
+# Default values are shown.
+#
+# Use the # character to indicate a comment, but only if it is the very first
+# character on the line. Do NOT insert a comment in front of the options.
+
+# The host is the IP-address which the broker is binding to. As default your
+# localhost, `127.0.0.1`, is used.
+host = 127.0.0.1
+
+# The port which the broker is bind to. It is normal practice to use `1883` for
+# NON-SSL connections while `8883` is used for SSL-connections.
+port = 1883
+
+# The verbosity level handles the stderr-output.
+# Level `1`
+#  - This will print when a client connects and disconnect.
+# Level `2`
+#  - This will print level 1 information and packet data.
+# Level `3`
+#  - This will print level 1 and 2 information and detailed data on each client
+#    and the broker. This will reveal clients password, so it should NOT be
+#    used in production.
+verbosity = 1
+
+# The max lenght of the clients id. Max length is `65535`.
+clientid_maxlen = 60
+
+# If spaces in the client id should be allowed.
+clientid_spaces = false
+
+# If empty client id's is allowed. If it is set to `true`, the client will be
+# assigned a random integer as the client id.
+clientid_empty = false
+
+# If set to true the publishers client id will be inserted in front of the
+# messages. This will reveal the clients id to all other connected clients.
+#
+# `false`
+#  - message
+# `true`
+#  - clientid:message
+clientid_pass = false
+
+# Disconnect an existing client if new client has the same client id.
+client_kickold = false
+
+# The max simultaneous connections to the broker. Disabled when set
+# to `0`.
+max_conn = 0
+
+# Allow anonymous connection - no need for username and password. If set to
+# true, then an absolute path to `password_file` is required.
+allow_anonymous = true
+
+# The absolute path to the password file containing usernames and hashed
+# passwords.
+#
+# To generate the password files and insert entities use `nmqtt_password`:
+# $ nmqtt_password -a /path/to/nmqtt_pwd.conf NewUser
+password_file =

nmqtt.nimble

@@ -5,9 +5,52 @@ description   = "Native MQTT client library and binaries"
 license       = "MIT"
 srcDir        = "src"
 installFiles  = @["nmqtt.nim"]
-bin           = @["nmqtt_pub", "nmqtt_sub"]
+bin           = @["nmqtt", "nmqtt_password", "nmqtt_pub", "nmqtt_sub"]
 
 
 # Dependencies
 requires "nim >= 1.0.6"
-requires "cligen >= 0.9.43"
+requires "bcrypt >= 0.2.1"
+requires "https://github.com/c-blake/cligen#36d5218"
+
+from strutils import format
+
+after install:
+  var path: string
+
+  echo "\nGenerate default nmqtt.conf? (y/N)"
+  let genConf = readLineFromStdin()
+  if genConf == "y" or genConf == "Y":
+    let confPath = "/home/" & getEnv("USER") & "/.config/nmqtt"
+    echo "\nAbsolute path to nmqtt config folder. Default: " & confPath
+
+    path = readLineFromStdin()
+    if path == "":
+      path = confPath
+
+    if not dirExists(path):
+      mkDir(path)
+
+    cpFile("config/nmqtt.conf", path & "/nmqtt.conf")
+    echo "The brokers configuration has been saved at: " & path & "/nmqtt.conf"
+
+  echo """
+
+nmqtt v$1 has been installed.
+
+
+LIBRARY:
+Access the nim-libary with an import statement in your code:
+
+  `import nmqtt`
+
+
+BINARIES:
+Access the binaries directly with. For help append `--help`.
+
+  nmqtt
+  nmqtt_password
+  nmqtt_pub
+  nmqtt_sub
+
+""".format(version)