net-snmp 3.10.0 → 3.10.2

package/README.md

@@ -2486,7 +2486,7 @@ call.
 Takes an OID in one of the three supported formats (the library automatically detects the given OID's format):
 - **OidFormat.oid** - canonical (numerical) OID format e.g. 1.3.6.1.2.1.1.1
 - **OidFormat.path** - named OID path format e.g. iso.org.dod.internet.mgmt.mib-2.system.sysDescr
-- **OidFormat.module** - module-qualified format e.g. RFC1158-MIB::sysDescr
+- **OidFormat.module** - module-qualified format e.g. SNMPv2-MIB::sysDescr
 
 Returns the given OID translated to the provided destination format - also one of the above three formats.
 
@@ -3343,6 +3343,14 @@ Example programs are included under the module's `example` directory.
 
  * Add numeric/named OID translate function
 
+## Version 3.10.1 - 30/01/2024
+
+ * Fix table column type in provider definition with column type constraints
+
+## Version 3.10.2 - 05/02/2024
+
+ * Add MIB parsing support for OID values with intermediate entries in list
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/snmp-agent.js

@@ -190,8 +190,13 @@ var tableProvider = {
             number: 2,
             name: "ifDescr",
             type: snmp.ObjectType.OctetString,
-			maxAccess: snmp.MaxAccess['read-write'],
-			defVal: "Hello world!"
+            maxAccess: snmp.MaxAccess['read-write'],
+            constraints: {
+                sizes: [
+                    { min: 1, max: 255 },
+                ]
+            },
+            defVal: "Hello world!"
         },
         {
             number: 3,

package/example/test.js

@@ -1,47 +1,62 @@
-const snmp = require("../");
-
-const store = snmp.createModuleStore();
-
-//store.loadFromFile("/var/tmp/mibs/CISCO-SMI.mib");
-//store.loadFromFile("/var/tmp/mibs/CISCO-TC.mib");
-//store.loadFromFile("/home/mark/snmp/test/CISCO-CONFIG-MAN-MIB.MIB");
-store.loadFromFile("/home/mark/snmp/test/smiv1.mib");
-// store.loadFromFile("/home/mark/snmp/test/smiv2.mib");
-
-const mod1 = store.getModule("SMIv1-TEST-MIB");
-// const mod2 = store.getModule("SMIv2-TEST-MIB");
-
-// Object.keys(mod1)
-//   .forEach(key => console.log(key));
-
-console.log(JSON.stringify(mod1, null, 2));
-// console.log(JSON.stringify(mod2, null, 2));
-
-//const mod = store.getModule("CISCO-CONFIG-MAN-MIB");
-//console.log(mod);
-//console.log(JSON.stringify(mod.ccmHistoryEventTerminalUser, null, 2));
-//console.log(JSON.stringify(mod.ciscoConfigManCTIDNotifyGroup, null, 2));
-//console.log(JSON.stringify(mod.ciscoConfigManCTIDObjectGroup, null, 2));
-//console.log(JSON.stringify(mod.HistoryEventMedium, null, 2));
-//console.log(JSON.stringify(mod.ccmHistoryRunningLastChanged, null, 2));
-//console.log(JSON.stringify(mod.ccmHistoryRunningLastSaved, null, 2));
-
-// console.log(JSON.stringify(store.translations.moduleToOid, null, 2));
-// console.log(JSON.stringify(store.translations.moduleToPath, null, 2));
-// console.log(JSON.stringify(store.translations.oidToPath, null, 2));
-// console.log(JSON.stringify(store.translations.oidToModule, null, 2));
-// console.log(JSON.stringify(store.translations.pathToOid, null, 2));
-// console.log(JSON.stringify(store.translations.pathToModule, null, 2));
-
-console.log('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart => ' + store.translate('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart', 'oid'));
-console.log('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart => ' + store.translate('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart', 'module'));
-console.log('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart => ' + store.translate('iso.org.dod.internet.snmpV2.snmpModules.snmpMIB.snmpMIBObjects.snmpTraps.warmStart', 'path'));
-console.log('1.3.6.1.2.1.1.1 => ' + store.translate('1.3.6.1.2.1.1.1', 'oid'));
-console.log('1.3.6.1.2.1.1.1 => ' + store.translate('1.3.6.1.2.1.1.1', 'module'));
-console.log('1.3.6.1.2.1.1.1 => ' + store.translate('1.3.6.1.2.1.1.1', 'path'));
-console.log('RFC1158-MIB::sysDescr => ' + store.translate('RFC1158-MIB::sysDescr', snmp.OidFormat.oid));
-console.log('SNMPv2-MIB::sysDescr => ' + store.translate('SNMPv2-MIB::sysDescr', snmp.OidFormat.oid));
-console.log('RFC1158-MIB::sysDescr => ' + store.translate('SNMPv2-MIB::sysDescr', snmp.OidFormat.path));
-console.log('RFC1158-MIB::sysDescr => ' + store.translate('SNMPv2-MIB::sysDescr', snmp.OidFormat.module));
-
-// console.log('RFC1158-MIB::ipAdEntReasmMaxSize => ' + store.translate('RFC1158-MIB::ipAdEntReasmMaxSizesz', snmp.OidFormat.oid));
+/* eslint-disable no-unused-vars */
+
+var snmp = require ("../");
+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 + "IANAifType-MIB.mib");
+store.loadFromFile (mibDir + "IF-MIB.mib");
+store.loadFromFile (mibDir + "HOST-RESOURCES-MIB.MIB");
+store.loadFromFile (mibDir + "IANA-PRINTER-MIB.mib");
+store.loadFromFile (mibDir + "IANA-CHARSET-MIB.mib");
+store.loadFromFile (mibDir + "PRINTER-MIBv1.mib");
+store.loadFromFile (mibDir + "JOB-MONITORING-MIB.mib");
+
+// const mibModuleOid = store.translate('1.3.6.1.4.1', snmp.OidFormat.module);
+// console.log('mibModuleOid: ', mibModuleOid);
+// const mibOid = store.translate('Job-Monitoring-MIB::jmJobTable', snmp.OidFormat.oid);
+// console.log('mibOid: ', mibOid);
+console.log(store.translate('Job-Monitoring-MIB::jmJobTable', snmp.OidFormat.oid));
+
+// ifNumber
+// Scalar type - setScalarValue() and getScalarValue() are the entire API for these
+
+// console.log("All modules: ", JSON.stringify(modules, '', 2));
+const jobModule = store.getModule('Job-Monitoring-MIB');
+console.log('jobModule: ', JSON.stringify(jobModule, null, 2));
+
+// print IF-MIB
+// const ifModule = store.getModule('IF-MIB');
+// console.log('ifModule: ', JSON.stringify(ifModule, null, 2));

package/index.js

@@ -3350,10 +3350,14 @@ ModuleStore.prototype.getProvidersForModule = function (moduleName) {
 							}
 						} else if ( parentOid == currentTableProvider.name ) {
 							// table column
+							let columnType = syntaxTypes[syntax];
+							if (typeof columnType === 'object') {
+								columnType = syntaxTypes[Object.keys(columnType)[0]];
+							}
 							var columnDefinition = {
 								number: parseInt (mibEntry["OBJECT IDENTIFIER"].split (" ")[1]),
 								name: mibEntry.ObjectName,
-								type: syntaxTypes[syntax],
+								type: columnType,
 								maxAccess: MaxAccess[maxAccess]
 							};
 							if ( constraints ) {
@@ -3388,8 +3392,9 @@ ModuleStore.prototype.getProvidersForModule = function (moduleName) {
 			} else if ( mibEntry.MACRO == "OBJECT-TYPE" ) {
 				// OBJECT-TYPE entries not in a table are scalars
 				let scalarType = syntaxTypes[syntax];
-				if (typeof scalarType === 'object')
+				if (typeof scalarType === 'object') {
 					scalarType = syntaxTypes[Object.keys(scalarType)[0]];
+				}
 				var scalarDefinition = {
 					name: mibEntry.ObjectName,
 					type: MibProviderType.Scalar,

package/lib/mib.js

@@ -733,7 +733,7 @@ var MIB = function (dir) {
             callback(summary);
         },
         OID: function (OBJECT_IDENTIFIER, ID, ObjectName, OD, callback) {
-            let members = OBJECT_IDENTIFIER.split(" ");
+            let members = OBJECT_IDENTIFIER.split(/\s+/);
             let parent = members.shift();
             let oid = members.pop();
             if (parent == 'iso') {
@@ -755,8 +755,29 @@ var MIB = function (dir) {
                 callback(midID.join('.'), midOD.join('.'));
                 return;
             }
-            ID = ID == '' ? oid : [oid, ID].join('.');
-            OD = OD == '' ? parent : [parent, OD].join('.');
+            if (members.length > 0) {
+                // We have middle entries e.g. { enterprises pwg(2699) mibs(1) 1 }
+                let midID = [];
+                let midOD = [parent];
+                for (let entry of members) {
+                    let match = entry.match(/(.*)\((.+)\)$/);
+                    midID.push(match[2]);
+                    midOD.push(match[1]);
+                }
+                midID.push(oid);
+                if ( ID != '' ) {
+                    midID.push(ID);
+                }
+                if ( OD != '' ) {
+                    midOD.push(OD);
+                }
+                ID = midID.join('.');
+                OD = midOD.join('.');
+            } else {
+                // We have no middle entries e.g. { enterprises 2021 }
+                ID = ID == '' ? oid : [oid, ID].join('.');
+                OD = OD == '' ? parent : [parent, OD].join('.');
+            }
             for (var ModuleName in this.Modules) {
                 if (this.Modules.hasOwnProperty(ModuleName)) {
                     if (this.Modules[ModuleName][parent]) {

package/package.json

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