net-snmp 3.21.0 → 3.21.2

package/README.md

@@ -3521,6 +3521,14 @@ Example programs are included under the module's `example` directory.
 
  * 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
+
+# Version 3.21.2 - 27/04/2025
+
+ * Add custom base module list
+
 # 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);
 	}
 }
 
@@ -2031,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
@@ -3348,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
@@ -3451,7 +3455,8 @@ Receiver.create = function (options, callback) {
 	return receiver;
 };
 
-var ModuleStore = function () {
+var ModuleStore = function (baseModules) {
+	this.baseModules = baseModules ?? ModuleStore.BASE_MODULES;
 	this.parser = mibparser ();
 	this.translations = {
 		oidToPath: {},
@@ -3541,7 +3546,7 @@ ModuleStore.prototype.getModule = function (moduleName) {
 ModuleStore.prototype.getModules = function (includeBase) {
 	var modules = {};
 	for ( var moduleName of Object.keys(this.parser.Modules) ) {
-		if ( includeBase || ModuleStore.BASE_MODULES.indexOf (moduleName) == -1 ) {
+		if ( includeBase || this.baseModules.indexOf (moduleName) == -1 ) {
 			modules[moduleName] = this.parser.Modules[moduleName];
 		}
 	}
@@ -3551,7 +3556,7 @@ ModuleStore.prototype.getModules = function (includeBase) {
 ModuleStore.prototype.getModuleNames = function (includeBase) {
 	var modules = [];
 	for ( var moduleName of Object.keys(this.parser.Modules) ) {
-		if ( includeBase || ModuleStore.BASE_MODULES.indexOf (moduleName) == -1 ) {
+		if ( includeBase || this.baseModules.indexOf (moduleName) == -1 ) {
 			modules.push (moduleName);
 		}
 	}
@@ -3725,7 +3730,7 @@ ModuleStore.prototype.getProvidersForModule = function (moduleName) {
 };
 
 ModuleStore.prototype.loadBaseModules = function () {
-	for ( var mibModule of ModuleStore.BASE_MODULES ) {
+	for ( var mibModule of this.baseModules ) {
 		this.parser.Import (__dirname + "/lib/mibs/" + mibModule + ".mib");
 	}
 	this.parser.Serialize ();
@@ -3809,8 +3814,8 @@ ModuleStore.prototype.translate = function (name, destinationFormat) {
 	}
 };
 
-ModuleStore.create = function () {
-	var store = new ModuleStore ();
+ModuleStore.create = function (options) {
+	const store = new ModuleStore (options?.baseModules ?? ModuleStore.BASE_MODULES);
 	store.loadBaseModules ();
 	return store;
 };
@@ -4272,7 +4277,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);
 		}
@@ -4865,7 +4871,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
@@ -4986,7 +4992,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 ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "net-snmp",
-  "version": "3.21.0",
+  "version": "3.21.2",
   "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);
         });
     });