net-snmp 3.9.8 → 3.10.0

package/README.md

@@ -83,6 +83,7 @@ for each shown in this table:
  * SNMPv3 context support
  * Notification receiver for traps and informs
  * MIB parsing and MIB module store
+ * Translation between numeric and named OIDs
  * SNMP agent with MIB management for both scalar and tabular data
  * Agent table index support for non-integer keys, foreign keys, composite keys and table augmentation
  * Agent support for "RowStatus" protocol-based creation and deletion of table rows
@@ -323,6 +324,11 @@ Actions
 - `12 -  EResponseNotHandled`
 - `13 -  EUnexpectedResponse`
 
+## snmp.OidFormat
+- `oid - oid`
+- `path - path`
+- `module - module`
+
 # OID Strings & Varbinds
 
 Some parts of this module accept simple OID strings, e.g.:
@@ -2475,6 +2481,26 @@ objects contained in the named MIB module.  The list of provider definitions are
 ready to be registered to an agent's MIB by using the `agent.getMib().registerProviders()`
 call.
 
+## store.translate (oid, destinationFormat)
+
+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
+
+Returns the given OID translated to the provided destination format - also one of the above three formats.
+
+For example:
+
+```js
+var numericOid = store.translate ('SNMPv2-MIB::sysDescr', snmp.OidFormat.oid);
+    => '1.3.6.1.2.1.1.1'
+var moduleQualifiedName = store.translate ('1.3.6.1.2.1.1.1', snmp.OidFormat.module);
+    => 'SNMPv2-MIB::sysDescr'
+var namedOid = store.translate ('1.3.6.1.2.1.1.1', snmp.OidFormat.path);
+    => 'iso.org.dod.internet.mgmt.mib-2.system.sysDescr'
+```
+
 # Forwarder Module
 
 An `Agent` instance, when created, in turn creates an instance of the `Forwarder` class.
@@ -3309,6 +3335,14 @@ Example programs are included under the module's `example` directory.
 
  * Fix subtree callback termination
 
+## Version 3.9.9 - 17/01/2024
+
+ * Add SMIv1 integer enumeration support
+
+## Version 3.10.0 - 17/01/2024
+
+ * Add numeric/named OID translate function
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/test.js

@@ -1,54 +1,47 @@
-/* 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 + "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));
+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));

package/index.js

@@ -264,6 +264,12 @@ var ResponseInvalidCode = {
 
 _expandConstantObject (ResponseInvalidCode);
 
+var OidFormat = {
+	"oid": "oid",
+	"path": "path",
+	"module": "module"
+};
+
 /*****************************************************************************
  ** Exception class definitions
  **/
@@ -3149,6 +3155,14 @@ Receiver.create = function (options, callback) {
 
 var ModuleStore = function () {
 	this.parser = mibparser ();
+	this.translations = {
+		oidToPath: {},
+		oidToModule: {},
+		pathToOid: {},
+		pathToModule: {},
+		moduleToOid: {},
+		moduleToPath: {}
+	};
 };
 
 ModuleStore.prototype.getSyntaxTypes = function () {
@@ -3174,8 +3188,44 @@ ModuleStore.prototype.getSyntaxTypes = function () {
 };
 
 ModuleStore.prototype.loadFromFile = function (fileName) {
+	var modulesBeforeLoad = this.getModuleNames();
 	this.parser.Import (fileName);
 	this.parser.Serialize ();
+	var modulesAfterLoad = this.getModuleNames();
+	var newModulesForTranslation = modulesAfterLoad.filter (moduleName => modulesBeforeLoad.indexOf (moduleName) === -1);
+	newModulesForTranslation.forEach ( moduleName => this.addTranslationsForModule (moduleName) );
+};
+
+ModuleStore.prototype.addTranslationsForModule = function (moduleName) {
+	var mibModule = this.parser.Modules[moduleName];
+
+	if ( ! mibModule ) {
+		throw new ReferenceError ("MIB module " + moduleName + " not loaded");
+	}
+	var entryArray = Object.values (mibModule);
+	for ( var i = 0; i < entryArray.length ; i++ ) {
+		var mibEntry = entryArray[i];
+		var oid = mibEntry.OID;
+		var namedPath = mibEntry.NameSpace;
+		var moduleQualifiedName;
+		if ( mibEntry.ObjectName ) {
+			moduleQualifiedName = moduleName + "::" + mibEntry.ObjectName;
+		} else {
+			moduleQualifiedName = undefined;
+		}
+		if ( oid && namedPath ) {
+			this.translations.oidToPath[oid] = namedPath;
+			this.translations.pathToOid[namedPath] = oid;
+		}
+		if ( oid && moduleQualifiedName ) {
+			this.translations.oidToModule[oid] = moduleQualifiedName;
+			this.translations.moduleToOid[moduleQualifiedName] = oid;
+		}
+		if ( namedPath && moduleQualifiedName ) {
+			this.translations.pathToModule[namedPath] = moduleQualifiedName;
+			this.translations.moduleToPath[moduleQualifiedName] = namedPath;
+		}
+	}
 };
 
 ModuleStore.prototype.getModule = function (moduleName) {
@@ -3368,6 +3418,7 @@ ModuleStore.prototype.loadBaseModules = function () {
 		this.parser.Import (__dirname + "/lib/mibs/" + mibModule + ".mib");
 	}
 	this.parser.Serialize ();
+	this.getModuleNames (true).forEach( moduleName => this.addTranslationsForModule (moduleName) );
 };
 
 ModuleStore.getConstraintsFromSyntax = function (syntax, syntaxTypes) {
@@ -3403,6 +3454,50 @@ ModuleStore.getConstraintsFromSyntax = function (syntax, syntaxTypes) {
 	};
 };
 
+ModuleStore.prototype.translate = function (name, destinationFormat) {
+	var sourceFormat;
+	if ( name.includes ("::") ) {
+		sourceFormat = OidFormat.module;
+	} else if ( name.startsWith ("1.") ) {
+		sourceFormat = OidFormat.oid;
+	} else {
+		sourceFormat = OidFormat.path;
+	}
+	var lowercaseDestinationFormat = destinationFormat.toLowerCase();
+	if ( sourceFormat === lowercaseDestinationFormat ) {
+		var testMap;
+		switch ( sourceFormat ) {
+			case OidFormat.oid: {
+				testMap = "oidToPath";
+				break;
+			}
+			case OidFormat.path: {
+				testMap = "pathToOid";
+				break;
+			}
+			case OidFormat.module: {
+				testMap = "moduleToOid";
+				break;
+			}
+		}
+		var entryExists = this.translations[testMap][name];
+		if ( entryExists === undefined ) {
+			throw new Error ("No translation found for " + name);
+		} else {
+			return name;
+		}
+	} else {
+		var capitalizedDestinationFormat = destinationFormat.charAt(0).toUpperCase() + destinationFormat.slice(1).toLowerCase();
+		var translationMap = sourceFormat + "To" + capitalizedDestinationFormat;
+		var translation = this.translations[translationMap][name];
+		if ( ! translation ) {
+			throw new Error ("No '" + destinationFormat + "' translation found for " + name);
+		} else {
+			return translation;
+		}
+	}
+};
+
 ModuleStore.create = function () {
 	var store = new ModuleStore ();
 	store.loadBaseModules ();
@@ -6233,6 +6328,7 @@ exports.AccessControlModelType = AccessControlModelType;
 exports.AccessLevel = AccessLevel;
 exports.MaxAccess = MaxAccess;
 exports.RowStatus = RowStatus;
+exports.OidFormat = OidFormat;
 
 exports.ResponseInvalidCode = ResponseInvalidCode;
 exports.ResponseInvalidError = ResponseInvalidError;

package/lib/mib.js

@@ -679,22 +679,10 @@ var MIB = function (dir) {
             var SYNTAX = Symbols[c1];
             var val = Symbols[c1 + 1];
 
+            // Normal MACROs
             if (this.MACROS.indexOf(macro) > -1 && m < 10) {
                 if (val[0] === "{") {
-                    c1++;
-                    while (Symbols[c1].indexOf("}") == -1) {
-                        c1++;
-                        val += Symbols[c1].trim();
-                    }
-                    val = val.replace("{", "").replace("}", "").split(",");
-
-                    Object[ObjectName]['SYNTAX'] = {};
-                    Object[ObjectName]['SYNTAX'][SYNTAX] = {};
-
-                    for (var TC = 0; TC < val.length; TC++) {
-                        let openParenSplit = val[TC].split(/\s*\(\s*/);
-                        Object[ObjectName]['SYNTAX'][SYNTAX][openParenSplit[1].replace(/\s*\)\s*$/, '')] = openParenSplit[0].trimStart();
-                    }
+                    this.BuildObjectEnumeration(Object, ObjectName, c1, SYNTAX, val, Symbols);
                 } else if (val[0] === '(') {
                     const key = val.startsWith('(SIZE')? 'sizes' : 'ranges';
                     Object[ObjectName]['SYNTAX'] = {};
@@ -702,6 +690,28 @@ var MIB = function (dir) {
                 } else {
                     Object[ObjectName]['SYNTAX'] = SYNTAX;
                 }
+            // SMIv1 INTEGER enumerations
+            } else if ( Symbols[i + 1] == 'INTEGER' ) {
+                c1 = i + 1;
+                SYNTAX = 'INTEGER';
+                val = Symbols[c1 + 1];
+                if ( val[0] === '{' ) {
+                    this.BuildObjectEnumeration(Object, ObjectName, c1, SYNTAX, val, Symbols);
+                }
+            }
+        },
+        BuildObjectEnumeration: function (Object, ObjectName, c1, SYNTAX, val, Symbols) {
+            c1++;
+            while (Symbols[c1].indexOf("}") == -1) {
+                c1++;
+                val += Symbols[c1].trim();
+            }
+            val = val.replace("{", "").replace("}", "").split(",");
+            Object[ObjectName]['SYNTAX'] = {};
+            Object[ObjectName]['SYNTAX'][SYNTAX] = {};
+            for (var TC = 0; TC < val.length; TC++) {
+                let openParenSplit = val[TC].split(/\s*\(\s*/);
+                Object[ObjectName]['SYNTAX'][SYNTAX][openParenSplit[1].replace(/\s*\)\s*$/, '')] = openParenSplit[0].trimStart();
             }
         },
         GetSummary: function (callback) {

package/package.json

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