net-snmp 3.20.1 → 3.21.1

package/README.md

@@ -1663,7 +1663,7 @@ an object, possibly empty, and can contain the following fields:
  * `sockets` - an array of objects containing triples of `transport`, `address` and `port` that
  can be used to specify multiple socket listeners.  This option overrides any individual
  `transport`, `address` and `port` options.
- * `mibOptions` - an MIB options object that is passed to the `Mib` instance - see the MIB section
+ * `mibOptions` - a MIB options object that is passed to the `Mib` instance - see the MIB section
  for further details on this - defaults to the empty object.
 
 The `mib` parameter is optional, and sets the agent's singleton `Mib` instance.
@@ -2689,7 +2689,9 @@ var options = {
     master: "localhost",
     masterPort: 705,
     timeout: 0,
-    description: "Node net-snmp AgentX sub-agent"
+    description: "Node net-snmp AgentX sub-agent",
+    mibOptions: {},
+    mib: undefined
 };
 
 subagent = snmp.createSubagent (options);
@@ -2704,6 +2706,12 @@ The `options` parameter is a mandatory object, possibly empty, and can contain t
  * `timeout` - set the session-wide timeout on the master agent - defaults to 0, which
  means no session-wide timeout is set.
  * `description` - a textual description of the subagent.
+ * `mibOptions` - n MIB options object that is passed to the `Mib` instance - see the MIB section
+ for further details on this - defaults to the empty object.
+ * `mib` - sets the agent's singleton `Mib` instance.  If not supplied, the agent creates itself
+ a new empty `Mib` singleton.  If supplied, the `Mib` instance needs to be created and populated as
+ per the [Mib Module](#mib-module) section.
+
 
 ## subagent.getMib ()
 
@@ -3509,6 +3517,14 @@ Example programs are included under the module's `example` directory.
 
  * Update documentation with compatibility note on DES and recent Node.js versions
 
+# Version 3.21.0 - 26/04/2025
+
+ * Add AgentX subagent mib and mibOptions on initialization
+
+# Version 3.21.1 - 26/04/2025
+
+ * Add better defval type handling, improved debug handling and simple agent example
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/snmp-agent-snmpv2mib.js

@@ -0,0 +1,44 @@
+const snmp = require ("..");
+
+// Create a module store, which contains SNMPv2-MIB and other modules
+const store = snmp.createModuleStore ();
+
+// Fetch MIB providers for SNMPv2-MIB, create an agent, and register the providers with the agent's MIB
+const providers = store.getProvidersForModule ("SNMPv2-MIB");
+const agentOptions = {
+    port: 1161
+};
+const agentCallback = function (error, data) {
+    if ( error ) {
+        console.error (error);
+    } else {
+        console.log (JSON.stringify(data, null, 2));
+    }
+};
+const agent = snmp.createAgent ( agentOptions, agentCallback );
+const mib = agent.getMib ();
+mib.registerProviders (providers);
+
+// Add community and user to agent's authorizer
+const authorizer = agent.getAuthorizer ();
+authorizer.addCommunity ("private");
+authorizer.addUser ({
+    name: "wilma",
+    level: snmp.SecurityLevel.authPriv,
+    authProtocol: snmp.AuthProtocols.sha,
+    authKey: "illhavesomeauth",
+    privProtocol: snmp.PrivProtocols.aes,
+    privKey: "andsomepriv"
+});
+
+// Start adding data to the MIB through the registered providers using the `Mib` API calls
+mib.setScalarValue ("sysDescr", "The most powerful system you can think of");
+mib.setScalarValue ("sysObjectID", "1.3.6.1.4.1.8072.3.2.10");
+mib.setScalarValue ("sysContact", "You");
+mib.setScalarValue ("sysName", "megamind");
+mib.setScalarValue ("sysLocation", "Yours");
+mib.setScalarValue ("sysORLastChange", 710);
+mib.addTableRow ("sysOREntry", [1, "1.3.6.1.4.1.47491.42.43.44.45", "I've dreamed up this MIB", 20]);
+
+// Dump the resulting MIB to the console
+mib.dump ();

package/example/snmp-agent.js

@@ -264,7 +264,7 @@ mib.dump ({
 // var data = mib.getTableColumnCells ("ifTable", 2);
 // var data = mib.getTableRowCells ("ifTable", [1]);
 // mib.setTableSingleCell ("ifTable", 2, [2], "changed!");
-mib.setTableSingleCell ("ifTable", 3, [2], 99);
+mib.setTableSingleCell ("ifTable", 3, [2], 24);
 var data = mib.getTableSingleCell ("ifTable", 3, [2]);
 // var data = mib.getScalarValue ("sysDescr");
 

package/index.js

@@ -21,9 +21,13 @@ const MAX_UNSIGNED_INT64 = 18446744073709551615;
 
 const DES_IMPLEMENTATION = 'library';
 
-function debug (line) {
+// Use test harness trace or debug functions falling back to console.debug in normal mode.
+// eslint-disable-next-line no-undef
+var debugfn = typeof(global.debug) === 'function'? global.trace ?? global.debug : console.debug;
+
+function debug () {
 	if ( DEBUG ) {
-		console.debug (line);
+		debugfn.apply (this, arguments);
 	}
 }
 
@@ -1400,6 +1404,7 @@ Encryption.encryptPduDes = function (scopedPdu, privProtocol, privPassword, auth
 		iv[i] = preIv[i] ^ salt[i];
 	}
 
+
 	if (scopedPdu.length % des.BLOCK_LENGTH == 0) {
 		paddedScopedPdu = scopedPdu;
 	} else {
@@ -2030,7 +2035,7 @@ var Session = function (target, authenticator, options) {
             ? options.reportOidMismatchErrors
             : false;
 
-	DEBUG = options.debug;
+	DEBUG |= options.debug;
 
 	this.engine = new Engine ({
 		engineId: options.engineID
@@ -2040,7 +2045,7 @@ var Session = function (target, authenticator, options) {
 
 	this.dgram = dgram.createSocket (this.transport);
 	this.dgram.unref();
-	
+
 	var me = this;
 	this.dgram.on ("message", me.onMsg.bind (me));
 	this.dgram.on ("close", me.onClose.bind (me));
@@ -2268,7 +2273,7 @@ Session.prototype.inform = function () {
 
 	/**
 	 ** Support the following signatures:
-	 ** 
+	 **
 	 **    typeOrOid, varbinds, options, callback
 	 **    typeOrOid, varbinds, callback
 	 **    typeOrOid, options, callback
@@ -2346,7 +2351,7 @@ Session.prototype.inform = function () {
 		};
 		pduVarbinds.push (varbind);
 	}
-	
+
 	options.port = this.trapPort;
 
 	this.simpleGet (InformRequestPdu, feedCb, pduVarbinds, responseCb, options);
@@ -2466,7 +2471,7 @@ Session.prototype.registerRequest = function (req) {
 Session.prototype.send = function (req, noWait) {
 	try {
 		var me = this;
-		
+
 		var buffer = req.message.toBuffer ();
 
 		this.dgram.send (buffer, 0, buffer.length, req.port, this.target,
@@ -2484,7 +2489,7 @@ Session.prototype.send = function (req, noWait) {
 	} catch (error) {
 		req.responseCb (error);
 	}
-	
+
 	return this;
 };
 
@@ -2736,7 +2741,7 @@ Session.prototype.trap = function () {
 
 	/**
 	 ** Support the following signatures:
-		** 
+		**
 		**    typeOrOid, varbinds, options, callback
 		**    typeOrOid, varbinds, agentAddr, callback
 		**    typeOrOid, varbinds, callback
@@ -2779,7 +2784,7 @@ Session.prototype.trap = function () {
 		};
 		pduVarbinds.push (varbind);
 	}
-	
+
 	var id = _generateId (this.idBitsSize);
 
 	if (this.version == Version2c || this.version == Version3 ) {
@@ -3070,7 +3075,7 @@ Listener.prototype.startListening = function () {
 
 Listener.prototype.send = function (message, rinfo, socket) {
 	// var me = this;
-	
+
 	var buffer = message.toBuffer ();
 
 	socket.send (buffer, 0, buffer.length, rinfo.port, rinfo.address, function (error, bytes) {
@@ -3347,7 +3352,7 @@ SimpleAccessControlModel.prototype.isAccessAllowed = function (securityModel, se
  **/
 
 var Receiver = function (options, callback) {
-	DEBUG = options.debug;
+	DEBUG |= options.debug;
 	this.authorizer = new Authorizer (options);
 	this.engine = new Engine ({
 		engineId: options.engineID
@@ -3678,7 +3683,7 @@ ModuleStore.prototype.getProvidersForModule = function (moduleName) {
 							// (See lib/mibs/SNMPv2-TC.mib#L186.)
 							if ( syntax == "RowStatus" &&
 									"IMPORTS" in mibModule &&
-									Array.isArray(mibModule.IMPORTS["SNMPv2-TC"]) && 
+									Array.isArray(mibModule.IMPORTS["SNMPv2-TC"]) &&
 									mibModule.IMPORTS["SNMPv2-TC"].includes("RowStatus") ) {
 
 								// Mark this column as being rowStatus
@@ -4027,7 +4032,7 @@ MibNode.prototype.getNextInstanceNode = function () {
 		childrenAddresses = Object.keys (node.children).sort ( (a, b) => a - b);
 		node = node.children[childrenAddresses[0]];
 		if ( ! node ) {
-			// unexpected 
+			// unexpected
 			return null;
 		}
 	}
@@ -4271,7 +4276,8 @@ Mib.prototype.registerProvider = function (provider) {
 			if ( provider.constraints?.enumeration ) {
 				scalarValue = ObjectTypeUtil.getEnumerationNumberFromName (provider.constraints.enumeration, provider.defVal);
 			} else {
-				scalarValue = provider.defVal;
+				// Remove quotes from strings and resolve numeric strings to integers
+				scalarValue = JSON.parse(provider.defVal);
 			}
 			this.setScalarValue (provider.name, scalarValue);
 		}
@@ -4690,7 +4696,7 @@ Mib.prototype.getTableCells = function (table, byRows, includeInstances) {
 	} else {
 		return data;
 	}
-	
+
 };
 
 Mib.prototype.getTableSingleCell = function (table, columnNumber, rowIndex) {
@@ -4864,7 +4870,7 @@ MibRequest.prototype.isTabular = function () {
 };
 
 var Agent = function (options, callback, mib) {
-	DEBUG = options.debug;
+	DEBUG |= options.debug;
 	this.listener = new Listener (options, this);
 	this.engine = new Engine ({
 		engineId: options.engineID
@@ -4985,7 +4991,7 @@ Agent.prototype.onMsg = function (socket, buffer, rinfo) {
 	}
 
 	// Request processing
-	// debug (JSON.stringify (message.pdu, null, 2));
+	debug (message.pdu);
 	if ( message.pdu.contextName && message.pdu.contextName != "" ) {
 		this.onProxyRequest (socket, message, rinfo);
 	} else if ( message.pdu.type == PduType.GetRequest ) {
@@ -5088,7 +5094,7 @@ Agent.prototype.tryCreateInstance = function (varbind, requestType) {
 					typeof rowStatusColumn == "number" &&
 					column === rowStatusColumn ) {
 
-				if ( (varbind.value === RowStatus["createAndGo"] || varbind.value === RowStatus["createAndWait"]) && 
+				if ( (varbind.value === RowStatus["createAndGo"] || varbind.value === RowStatus["createAndWait"]) &&
 						provider.createHandler !== null ) {
 
 					// The create handler will return an array
@@ -5572,7 +5578,7 @@ Agent.prototype.getBulkRequest = function (socket, requestMessage, rinfo) {
 	}
 
 	if ( requestPdu.nonRepeaters < requestVarbinds.length ) {
-	
+
 		for (var v = requestPdu.nonRepeaters ; v < requestVarbinds.length ; v++ ) {
 			startOid.push (requestVarbinds[v].oid);
 		}
@@ -5784,7 +5790,7 @@ AgentXPdu.prototype.readHeader = function (buffer) {
 	this.version = buffer.readUInt8 ();
 	this.pduType = buffer.readUInt8 ();
 	this.flags = buffer.readUInt8 ();
-	buffer.readUInt8 ();   // reserved byte 
+	buffer.readUInt8 ();   // reserved byte
 	this.sessionID = buffer.readUInt32BE ();
 	this.transactionID = buffer.readUInt32BE ();
 	this.packetID = buffer.readUInt32BE ();
@@ -5854,7 +5860,7 @@ AgentXPdu.createFromVariables = function (vars) {
 					+ "' in created PDU");
 
 	}
-	
+
 	return pdu;
 };
 
@@ -6089,7 +6095,7 @@ AgentXPdu.packetID = 1;
 
 var Subagent = function (options) {
 	DEBUG = options.debug;
-	this.mib = new Mib ();
+	this.mib = options?.mib ?? new Mib (options?.mibOptions);
 	this.master = options.master || 'localhost';
 	this.masterPort = options.masterPort || 705;
 	this.timeout = options.timeout || 0;

package/lib/mib.js

@@ -655,7 +655,7 @@ const MIB = function (dir) {
                     if (unresolvedObjects.length > 0) {
                         for (const unresolved of unresolvedObjects) {
                             const obj = this.Modules[ModuleName][unresolved];
-                            
+
                             const { oidString, nameString, unresolvedObject } = this.getOidAndNamePaths(obj['OBJECT IDENTIFIER'], unresolved, ModuleName);
                             this.Modules[ModuleName][unresolved].NameSpace = nameString;
                             this.Modules[ModuleName][unresolved].OID = oidString;

package/package.json

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

package/test/mib.test.js

@@ -122,7 +122,7 @@ describe('MIB', function () {
             };
             mib = snmp.createMib(options);
             mib.registerProviders(mibProviders);
-            assert.equal(mib.getScalarValue('testScalarIntegerDefval'), 49);
+            assert.strictEqual(mib.getScalarValue('testScalarIntegerDefval'), 49);
         });
     });