net-snmp 3.4.2 → 3.5.2

package/.vscode/launch.json

@@ -127,14 +127,14 @@
             ],
             "program": "${workspaceFolder}/example/snmp-trap.js",
             "args": [
-                "-e", "0102030407",
+                "-e", "0x010203040a",
                 "-v", "3",
-                "-u", "both",
+                "-u", "barney",
                 "-l", "authPriv",
-                "-a", "md5",
-                "-A", "testing123",
-                "-x", "des",
-                "-X", "testing123",
+                "-a", "sha",
+                "-A", "illhavesomeauth",
+                "-x", "aes",
+                "-X", "andsomepriv",
                 "127.0.0.1",
                 "1.3.6.1.6.3.1.1.5.1"
             ]
@@ -259,16 +259,7 @@
             ],
             "program": "${workspaceFolder}/example/test.js",
             "args": [
-                "-d",
-                "-v", "3",
-                "-l", "authPriv",
-                "-u", "test256",
-                "-a", "sha",
-                "-A", "maybeitsok",
-                "-x", "aes256b",
-                "-X", "maybeitsok",
-                "127.0.0.1",
-                "1.3.6.1.2.1.1.1.0"
+                "-p", "1161"
             ]
         },
         {

package/README.md

@@ -292,7 +292,7 @@ The Agent Extensibility (AgentX) Protocol specifies these PDUs in RFC 2741:
 - `3 - read-write`
 - `4 - read-create`
 
-# snmp.RowStatus
+## snmp.RowStatus
 Status values
 - `1 - active`
 - `2 - notInService`
@@ -303,6 +303,21 @@ Actions
 - `5 - createAndWait`
 - `6 - destroy`
 
+## snmp.ResponseInvalidCode
+- `1 -  EIp4AddressSize`
+- `2 -  EUnknownObjectType`
+- `3 -  EUnknownPduType`
+- `4 -  ECouldNotDecrypt`
+- `5 -  EAuthFailure`
+- `6 -  EReqResOidNoMatch`
+- `7 -  ENonRepeaterCountMismatch`
+- `8 -  EOutOfOrder`
+- `9 -  EVersionNoMatch`
+- `10 -  ECommunityNoMatch`
+- `11 -  EUnexpectedReport`
+- `12 -  EResponseNotHandled`
+- `13 -  EUnexpectedResponse`
+
 # OID Strings & Varbinds
 
 Some parts of this module accept simple OID strings, e.g.:
@@ -376,7 +391,7 @@ function responseCb (error, varbinds) {
 }
 ```
 
-When defined, the error parameter is always an instance of the `Error` class,
+When defined, the `error` parameter is always an instance of the `Error` class,
 or a sub-class described in one of the sub-sections contained in this section.
 
 The semantics of error handling is slightly different between SNMP version
@@ -485,8 +500,17 @@ exposed `message` attribute will contain the value `Request timed out`.
 
 ## snmp.ResponseInvalidError
 
-This error indicates a failure to parse a response message.  The exposed
-`message` attribute will contain a detailed error message.
+This error indicates a failure to parse a response message. The
+exposed `message` attribute will contain a detailed error message, and
+as a sub-class of Error, its `toString()` method will yield that
+`message` attribute.
+
+An error of this class will always additionally include a `code`
+attribute (one of the values in `ResponseInvalidCode`); and in some
+cases, also have an `info` attribute which provides `code`-specific
+supplemental information. An authentication error, for example -- code
+`ResponseInvalidCode.EAuthFailure` -- will contain a map in `info`
+with the attempted authentication data which failed to authenticate.
 
 # Using This Module: Command & Notification Generator
 
@@ -567,6 +591,7 @@ var options = {
     transport: "udp4",
     trapPort: 162,
     version: snmp.Version3,
+    engineID: "8000B98380XXXXXXXXXXXXXXXXXXXXXXXX", // where the X's are random hex digits
     idBitsSize: 32,
     context: ""
 };
@@ -1428,7 +1453,7 @@ var options = {
     port: 162,
     disableAuthorization: false,
     accessControlModelType: snmp.AccessControlModelType.None,
-    engineID: "8000B98380XXXXXXXXXXXX", // where the X's are random hex digits
+    engineID: "8000B98380XXXXXXXXXXXXXXXXXXXXXXXX", // where the X's are random hex digits
     address: null,
     transport: "udp4"
 };
@@ -1538,7 +1563,7 @@ var options = {
     port: 161,
     disableAuthorization: false,
     accessControlModelType: snmp.AccessControlModelType.None,
-    engineID: "8000B98380XXXXXXXXXXXX", // where the X's are random hex digits
+    engineID: "8000B98380XXXXXXXXXXXXXXXXXXXXXXXX", // where the X's are random hex digits
     address: null,
     transport: "udp4"
 };
@@ -3101,6 +3126,22 @@ Example programs are included under the module's `example` directory.
 
  * Add error codes to ResponseInvalidError
 
+## Version 3.4.3 - 06/02/2021
+
+ * Add documentation for ResponseInvalidError error codes
+
+## Version 3.5.0 - 28/02/2021
+
+ * Add engineID option to v3 session
+
+## Version 3.5.1 - 28/02/2021
+
+ * Fix MIB parsing of sized integers without whitespace
+
+## Version 3.5.2 - 02/03/2021
+
+ * Fix MIB table index handling of Buffer type
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/option-parser.js

@@ -1,7 +1,9 @@
 var snmp = require ("../");
 var getopts = require ("getopts");
 
-var options = getopts(process.argv.slice(2));
+var options = getopts(process.argv.slice(2), {
+    string: ["e"]
+});
 var community;
 var user;
 var session;
@@ -20,14 +22,12 @@ snmpOptions.version = snmp.Version[options.v];
 snmpOptions.debug = options.d;
 snmpOptions.transport = options.t;
 if ( snmpOptions.version == snmp.Version3 ) {
-    var engineID;
     if ( options.e ) {
-        engineID = Buffer.from((options.e.toString().length % 2 == 1 ? '0' : '') + options.e.toString(), 'hex');
+        snmpOptions.engineID = options.e.toString();
     }
 	user = {
 		name: options.u,
-		level: snmp.SecurityLevel[options.l],
-        engineID: engineID
+		level: snmp.SecurityLevel[options.l]
     };
     if ( options.a ) {
         user.authProtocol = snmp.AuthProtocols[options.a.toLowerCase()];

package/example/snmp-receiver.js

@@ -6,6 +6,7 @@ var verbose = options.v;
 var snmpOptions = {
     disableAuthorization: options.n,
     port: options.p,
+	transport: options.t,
     engineID: options.e
 };
 
@@ -22,8 +23,10 @@ var cb = function(error, trap) {
         } else {
             if (trap.pdu.type == snmp.PduType.Trap ) {
                 console.log (now + ": " + trapType + ": " + trap.rinfo.address + " : " + trap.pdu.enterprise);
-            } else {
-                console.log (now + ": " + trapType + ": " + trap.rinfo.address + " : " + trap.pdu.varbinds[1].value);
+			} else {
+				for (var i = 0; i < trap.pdu.varbinds.length; i++) {
+                    console.log (now + ": " + trapType + ": " + trap.rinfo.address + " : " + trap.pdu.varbinds[i].oid + " -> " + trap.pdu.varbinds[i].value);
+				}
             }
         }
     }

package/example/test.js

@@ -1,21 +1,54 @@
-
-// Copyright 2013 Stephen Vickers
+/* eslint-disable no-unused-vars */
 
 var snmp = require ("../");
-var options = require("./option-parser");
-
-var session = options.session;
-var oids = options.oids;
-
-session.get (oids, function (error, varbinds) {
-	if (error) {
-		console.error (error.toString ());
-	} else {
-		for (var i = 0; i < varbinds.length; i++) {
-			if (snmp.isVarbindError (varbinds[i]))
-				console.error (snmp.varbindError (varbinds[i]));
-			else
-				console.log (varbinds[i].oid + "|" + varbinds[i].value);
-		}
-	}
-});
+var getopts = require ("getopts");
+
+var options = getopts(process.argv.slice(2));
+var providers;
+var mibDir = '/var/tmp/mibs/';
+
+var counter64 = function (num) {
+    var buf = Buffer.alloc (4);
+    buf.writeUInt32BE (num);
+    return buf;
+};
+
+var snmpOptions = {
+    disableAuthorization: options.n,
+    port: options.p,
+    engineID: options.e,
+    debug: options.d
+};
+
+var callback = function (error, data) {
+    if ( error ) {
+        console.error (error);
+    } else {
+        console.log (data.pdu.varbinds[0].oid);
+    }
+};
+
+var store = snmp.createModuleStore ();
+var agent = snmp.createAgent (snmpOptions, callback);
+var mib = agent.getMib ();
+
+var authorizer = agent.getAuthorizer ();
+authorizer.addCommunity ("public");
+
+// IF-MIB load and providers registration
+store.loadFromFile (mibDir + "IPv6-TC.mib");
+store.loadFromFile (mibDir + "IPv6-MIB.mib");
+providers = store.getProvidersForModule ("IPV6-MIB");
+mib.registerProviders (providers);
+
+// agent.getMib ().dumpProviders ();
+
+// mib.dump ();
+
+var modules = store.getModules (true);
+var one = store.getModule ("IPV6-MIB");
+var names = store.getModuleNames (true);
+
+// console.log("All modules: ", JSON.stringify(modules, '', 2));
+console.log("Modules: ", names);
+console.log("Single module definition: ", JSON.stringify(one, '', 2));

package/index.js

@@ -1812,7 +1812,7 @@ var Session = function (target, authenticator, options) {
 
 	DEBUG = options.debug;
 
-	this.engine = new Engine ();
+	this.engine = new Engine (options.engineID);
 	this.reqs = {};
 	this.reqCount = 0;
 
@@ -2586,7 +2586,7 @@ Session.prototype.trap = function () {
 
 	if ( this.version == Version3 ) {
 		var msgSecurityParameters = {
-			msgAuthoritativeEngineID: this.user.engineID,
+			msgAuthoritativeEngineID: this.engine.engineID,
 			msgAuthoritativeEngineBoots: 0,
 			msgAuthoritativeEngineTime: 0
 		};
@@ -2777,7 +2777,12 @@ Session.createV3 = function (target, user, options) {
 
 var Engine = function (engineID, engineBoots, engineTime) {
 	if ( engineID ) {
-		this.engineID = Buffer.from (engineID, 'hex');
+		if ( ! (engineID instanceof Buffer) ) {
+			engineID = engineID.replace('0x', '');
+			this.engineID = Buffer.from((engineID.toString().length % 2 == 1 ? '0' : '') + engineID.toString(), 'hex');
+		} else {
+			this.engineID = engineID;
+		}
 	} else {
 		this.generateEngineID ();
 	}
@@ -2787,7 +2792,7 @@ var Engine = function (engineID, engineBoots, engineTime) {
 
 Engine.prototype.generateEngineID = function() {
 	// generate a 17-byte engine ID in the following format:
-	// 0x80 + 0x00B983 (enterprise OID) | 0x80 (enterprise-specific format) | 12 bytes of random
+	// 0x80 | 0x00B983 (enterprise OID) | 0x80 (enterprise-specific format) | 12 bytes of random
 	this.engineID = Buffer.alloc (17);
 	this.engineID.fill ('8000B98380', 'hex', 0, 5);
 	this.engineID.fill (crypto.randomBytes (12), 5, 17, 'hex');
@@ -4076,7 +4081,13 @@ Mib.prototype.getOidAddressFromValue = function (value, indexPart) {
 			oidComponents = value.split (".");
 			break;
 		case ObjectType.OctetString:
-			oidComponents = [...value].map (c => c.charCodeAt());
+			if ( value instanceof Buffer ) {
+				// Buffer
+				oidComponents = Array.prototype.slice.call (value);
+			} else {
+				// string
+				oidComponents = [...value].map (c => c.charCodeAt());
+			}
 			break;
 		case ObjectType.IpAddress:
 			return value.split (".");

package/lib/mib.js

@@ -168,7 +168,10 @@ var MIB = function (dir) {
                             this.CharBuffer.inGroup++;
                         }
                     }
-                    if (this.CharBuffer.isComment || ((this.CharBuffer.isOID || this.CharBuffer.nested > 0) && (!this.CharBuffer.isList || this.CharBuffer.inGroup > 0))) {
+                    if (this.CharBuffer.builder == 'INTEGER') {
+                        this.CharBuffer.Fill(FileName, row, column);
+                        this.CharBuffer.Append(char);
+                    } else if (this.CharBuffer.isComment || ((this.CharBuffer.isOID || this.CharBuffer.nested > 0) && (!this.CharBuffer.isList || this.CharBuffer.inGroup > 0))) {
                         this.CharBuffer.Append(char);
                     } else {
                         this.CharBuffer.Fill(FileName, row, column);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "net-snmp",
-  "version": "3.4.2",
+  "version": "3.5.2",
   "description": "JavaScript implementation of the Simple Network Management Protocol (SNMP)",
   "main": "index.js",
   "directories": {

package/test/snmp-test.sh

@@ -8,7 +8,7 @@ HOME_DIR=.
 HOST=localhost
 LEVEL=authpriv
 PRINT_ONLY=0
-TRAP_ENGINEID="0102030409"
+TRAP_ENGINEID="010203040a"
 IPV6=0
 CMDS=/var/tmp/snmp-test.$$
 
@@ -20,7 +20,7 @@ USER_AUTH=betty
 USER_PRIV=barney
 USER_TRAP_NONE=fred
 USER_TRAP_AUTH=betty
-USER_TRAP_PRIV=barney
+USER_TRAP_PRIV=wilma
 USER_SET_NONE=trapnone
 USER_SET_AUTH=trapshaonly
 USER_SET_PRIV=trapshades
@@ -99,7 +99,7 @@ node ${HOME_DIR}/example/snmp-subtree.js ${PARAMS} ${HOST} 1.3.6.1.6.3.16.1.5.2.
 node ${HOME_DIR}/example/snmp-table.js ${PARAMS} ${HOST} 1.3.6.1.2.1.1.9
 node ${HOME_DIR}/example/snmp-table-columns.js ${PARAMS} ${HOST} 1.3.6.1.2.1.2.2 2
 node ${HOME_DIR}/example/snmp-set.js ${SET_PARAMS} ${HOST} 1.3.6.1.2.1.1.6.0 OctetString Auckland
-node ${HOME_DIR}/example/snmp-trap.js -e ${TRAP_ENGINE_ID} ${TRAP_PARAMS} ${HOST} 1.3.6.1.6.3.1.1.5.2
+node ${HOME_DIR}/example/snmp-trap.js -e ${TRAP_ENGINEID} ${TRAP_PARAMS} ${HOST} 1.3.6.1.6.3.1.1.5.2
 node ${HOME_DIR}/example/snmp-inform.js ${PARAMS} ${HOST} 1.3.6.1.6.3.1.1.5.2
 ENDOFCMDS