Add SNMPv3 to node-red-node-snmp

io/snmp/README.md

@@ -1,8 +1,13 @@
 node-red-node-snmp
 ==================
 
-A pair of <a href="http://nodered.org" target="_new">Node-RED</a> nodes that
-fetch either individual oids, or a table oid from a SNMP enabled host.
+A set of <a href="http://nodered.org" target="_new">Node-RED</a> nodes that
+fetch values from SNMP enabled hosts. Supports v1, v2c and v3.
+* SNMP get - Simple SNMP oid or oid list fetcher
+* SNMP set - Simple snmp Set node.
+* SNMP subtree - Simple sub tree fetcher
+* SNMP table - Simple SNMP oid table fetcher
+* SNMP walker - Simple SNMP oid walker fetcher
 
 Install
 -------
@@ -18,16 +23,28 @@ Usage
 
 SNMP oids fetcher. Can fetch a single or comma separated list of oids. Triggered by any input.
 
-`msg.host` may contain the host.
+`msg.host` may contain the host including the port.
 
-`msg.community` may contain the community.
+`msg.community` may contain the community. (v1 and v2c only)
+
+`msg.username` may contain the username. (v3 only)
+
+`msg.authkey` may contain the digest security key. (v3 only)
+
+`msg.privkey` may contain the encryption security key. (v3 only)
 
 `msg.oid` may contain a comma separated list of oids to search for. (no spaces)
 
 The host configured in the edit config will override `msg.host`. Leave blank if you want to use `msg.host` to provide input.
 
 The community configured in the edit config will override `msg.community`. Leave blank if you want to use `msg.community` to provide input.
 
+The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
+
+The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
+
+The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
+
 The oids configured in the edit config will override `msg.oid`. Leave blank if you
 want to use `msg.oid` to provide input.
 
@@ -38,9 +55,15 @@ Values depends on the oids being requested.
 
 SNMP sets the value of one or more OIDs.
 
-`msg.host` may contain the host.
+`msg.host` may contain the host including the port.
+
+`msg.community` may contain the community. (v1 and v2c only)
+
+`msg.username` may contain the username. (v3 only)
 
-`msg.community` may contain the community.
+`msg.authkey` may contain the digest security key. (v3 only)
+
+`msg.privkey` may contain the encryption security key. (v3 only)
 
 `msg.varbinds` may contain an array of varbind JSON objects e.g.:
 ```
@@ -81,6 +104,12 @@ The host configured in the edit config will override `msg.host`. Leave blank if
 
 The community configured in the edit config will override `msg.community`. Leave blank if you want to use `msg.community` to provide input.
 
+The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
+
+The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
+
+The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
+
 The varbinds configured in the edit config will override `msg.varbinds`. Leave blank if you want to use `msg.varbinds` to provide input.
 
 
@@ -89,16 +118,28 @@ The varbinds configured in the edit config will override `msg.varbinds`. Leave b
 
 Simple SNMP table oid fetcher. Triggered by any input.
 
-`msg.host` may contain the host.
+`msg.host` may contain the host including the port.
 
-`msg.community` may contain the community.
+`msg.community` may contain the community. (v1 and v2c only)
 
-`msg.oid` may contain the oid of a single table to search for.
+`msg.username` may contain the username. (v3 only)
+
+`msg.authkey` may contain the digest security key. (v3 only)
+
+`msg.privkey` may contain the encryption security key. (v3 only)
+
+`msg.oid` may contain a comma separated list of oids to search for. (no spaces)
 
 The host configured in the edit config will override `msg.host`. Leave blank if you want to use `msg.host` to provide input.
 
 The community configured in the edit config will override `msg.community`. Leave blank if you want to use `msg.community` to provide input.
 
+The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
+
+The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
+
+The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
+
 The oid configured in the edit config will override `msg.oid`. Leave blank if you
 want to use `msg.oid` to provide input.
 
@@ -109,16 +150,28 @@ Values depends on the oids being requested.
 
 Simple SNMP oid subtree fetcher. Triggered by any input. Reads from OID specified and any below it.
 
-`msg.host` may contain the host.
+`msg.host` may contain the host including the port.
 
-`msg.community` may contain the community.
+`msg.community` may contain the community. (v1 and v2c only)
+
+`msg.username` may contain the username. (v3 only)
+
+`msg.authkey` may contain the digest security key. (v3 only)
+
+`msg.privkey` may contain the encryption security key. (v3 only)
 
 `msg.oid` may contain the oid of a single table to search for.
 
 The host configured in the edit config will override `msg.host`. Leave blank if you want to use `msg.host` to provide input.
 
 The community configured in the edit config will override `msg.community`. Leave blank if you want to use `msg.community` to provide input.
 
+The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
+
+The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
+
+The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
+
 The oid configured in the edit config will override `msg.oid`. Leave blank if you
 want to use `msg.oid` to provide input.
 
@@ -129,16 +182,28 @@ Values depends on the oids being requested.
 
 Simple SNMP oid walker fetcher. Triggered by any input. Reads from OID specified to the end of the table.
 
-`msg.host` may contain the host.
+`msg.host` may contain the host including the port.
+
+`msg.community` may contain the community. (v1 and v2c only)
+
+`msg.username` may contain the username. (v3 only)
 
-`msg.community` may contain the community.
+`msg.authkey` may contain the digest security key. (v3 only)
+
+`msg.privkey` may contain the encryption security key. (v3 only)
 
 `msg.oid` may contain the oid of a single table to search for.
 
 The host configured in the edit config will override `msg.host`. Leave blank if you want to use `msg.host` to provide input.
 
 The community configured in the edit config will override `msg.community`. Leave blank if you want to use `msg.community` to provide input.
 
+The username configured in the edit config will override `msg.username`. Leave blank if you want to use `msg.username` to provide input.
+
+The digest security key configured in the edit config will override `msg.authkey`. Leave blank if you want to use `msg.authkey` to provide input.
+
+The encryption security key configured in the edit config will override `msg.privkey`. Leave blank if you want to use `msg.privkey` to provide input.
+
 The oid configured in the edit config will override `msg.oid`. Leave blank if you
 want to use `msg.oid` to provide input.
 

io/snmp/package.json

@@ -1,16 +1,16 @@
 {
     "name"          : "node-red-node-snmp",
-    "version"       : "0.0.25",
-    "description"   : "A Node-RED node that looks for SNMP oids.",
+    "version"       : "1.0.0",
+    "description"   : "A Node-RED node that gets and sets SNMP oid values. Supports v1, v2c and v3",
     "dependencies"  : {
-        "net-snmp"  : "1.2.4"
+        "net-snmp"  : "^3.6.3"
     },
     "repository" : {
         "type":"git",
         "url":"https://github.com/node-red/node-red-nodes/tree/master/io/snmp"
     },
     "license": "Apache-2.0",
-    "keywords": [ "node-red", "snmp", "oid" ],
+    "keywords": [ "node-red", "snmp", "oid", "snmpv3" ],
     "node-red"      : {
         "nodes"     : {
             "snmp": "snmp.js"
@@ -23,6 +23,8 @@
     },
     "contributors": [
         { "name": "Mika Karaila" },
-        { "name": "Bryan Malyn" }
+        { "name": "Bryan Malyn" },
+        { "name": "Steve-Mcl" },
+		{ "name": "Andres" }
     ]
 }