net-snmp 3.9.9 → 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.
@@ -3313,6 +3339,10 @@ Example programs are included under the module's `example` directory.
 
  * 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

@@ -25,3 +25,23 @@ console.log(JSON.stringify(mod1, 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/package.json

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