net-snmp 3.10.4 → 3.11.1

package/README.md

@@ -3359,6 +3359,14 @@ Example programs are included under the module's `example` directory.
 
  * Add MIB parsing support for middle member of OID value list containing identifier only
 
+## Version 3.11.0 - 23/03/2024
+
+ * Fix parent object retrieval to respect MIB module imports
+
+## Version 3.11.1 - 30/03/2024
+
+ * Add error status and index handling to AgentX subagent
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/test.js

@@ -43,6 +43,7 @@ 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-RFC.mib");
+store.loadFromFile (mibDir + "NETSURE-MIB-001-B.mib");
 
 // const mibModuleOid = store.translate('1.3.6.1.4.1', snmp.OidFormat.module);
 // console.log('mibModuleOid: ', mibModuleOid);
@@ -63,5 +64,7 @@ console.log(store.translate('iso.org.dod.internet.private.enterprises.pwg.mibs.j
 // 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));
+// const ifModule = store.getModule('IF-MIB');
+// console.log('ifModule: ', JSON.stringify(ifModule, null, 2));
+const nsModule = store.getModule('NETSURE-MIB-001-B');
+console.log('nsModule: ', JSON.stringify(nsModule, null, 2));

package/index.js

@@ -5506,6 +5506,19 @@ AgentXPdu.prototype.readHeader = function (buffer) {
 	this.payloadLength = buffer.readUInt32BE ();
 };
 
+AgentXPdu.prototype.getResponsePduForRequest = function () {
+	const responsePdu = AgentXPdu.createFromVariables({
+		pduType: AgentXPduType.Response,
+		sessionID: this.sessionID,
+		transactionID: this.transactionID,
+		packetID: this.packetID,
+		sysUpTime: 0,
+		error: 0,
+		index: 0
+	});
+	return responsePdu;
+};
+
 AgentXPdu.createFromVariables = function (vars) {
 	var pdu = new AgentXPdu ();
 	pdu.flags = vars.flags ? vars.flags | 0x10 : 0x10;  // set NETWORK_BYTE_ORDER to big endian
@@ -6040,13 +6053,14 @@ Subagent.prototype.response = function (pdu) {
 };
 
 Subagent.prototype.request = function (pdu, requestVarbinds) {
-	var me = this;
-	var varbindsCompleted = 0;
-	var varbindsLength = requestVarbinds.length;
-	var responseVarbinds = [];
-
-	for ( var i = 0; i < requestVarbinds.length; i++ ) {
-		var requestVarbind = requestVarbinds[i];
+	const me = this;
+	const varbindsLength = requestVarbinds.length;
+	const responseVarbinds = [];
+	const responsePdu = pdu.getResponsePduForRequest ();
+	let varbindsCompleted = 0;
+
+	for ( let i = 0; i < varbindsLength; i++ ) {
+		const requestVarbind = requestVarbinds[i];
 		var instanceNode = this.mib.lookup (requestVarbind.oid);
 		var providerNode;
 		var mibRequest;
@@ -6097,14 +6111,21 @@ Subagent.prototype.request = function (pdu, requestVarbinds) {
 		}
 
 		(function (savedIndex) {
-			var responseVarbind;
 			mibRequest.done = function (error) {
+				let responseVarbind;
 				if ( error ) {
 					responseVarbind = {
 						oid: mibRequest.oid,
 						type: error.type || ObjectType.Null,
 						value: error.value || null
 					};
+					if ( (typeof responsePdu.errorStatus == "undefined" || responsePdu.errorStatus == ErrorStatus.NoError) && error.errorStatus != ErrorStatus.NoError ) {
+						responsePdu.error = error.errorStatus;
+						responsePdu.index = savedIndex + 1;
+					}
+					if ( error.errorStatus != ErrorStatus.NoError ) {
+						responseVarbind.errorStatus = error.errorStatus;
+					}
 				} else {
 					if ( pdu.pduType == AgentXPduType.TestSet ) {
 						// more tests?
@@ -6130,9 +6151,9 @@ Subagent.prototype.request = function (pdu, requestVarbinds) {
 				if ( ++varbindsCompleted == varbindsLength) {
 					if ( pdu.pduType == AgentXPduType.TestSet || pdu.pduType == AgentXPduType.CommitSet
 							|| pdu.pduType == AgentXPduType.UndoSet) {
-						me.sendSetResponse.call (me, pdu);
+						me.sendResponse.call (me, responsePdu);
 					} else {
-						me.sendGetResponse.call (me, pdu, responseVarbinds);
+						me.sendResponse.call (me, responsePdu, responseVarbinds);
 					}
 				}
 			};
@@ -6234,30 +6255,10 @@ Subagent.prototype.getBulkRequest = function (pdu) {
 	this.request (pdu, getBulkVarbinds);
 };
 
-Subagent.prototype.sendGetResponse = function (requestPdu, varbinds) {
-	var pdu = AgentXPdu.createFromVariables ({
-		pduType: AgentXPduType.Response,
-		sessionID: requestPdu.sessionID,
-		transactionID: requestPdu.transactionID,
-		packetID: requestPdu.packetID,
-		sysUpTime: 0,
-		error: 0,
-		index: 0,
-		varbinds: varbinds
-	});
-	this.sendPdu (pdu, null);
-};
-
-Subagent.prototype.sendSetResponse = function (setPdu) {
-	var responsePdu = AgentXPdu.createFromVariables ({
-		pduType: AgentXPduType.Response,
-		sessionID: setPdu.sessionID,
-		transactionID: setPdu.transactionID,
-		packetID: setPdu.packetID,
-		sysUpTime: 0,
-		error: 0,
-		index: 0,
-	});
+Subagent.prototype.sendResponse = function (responsePdu, varbinds) {
+	if ( varbinds ) {
+		responsePdu.varbinds = varbinds;
+	}
 	this.sendPdu (responsePdu, null);
 };
 

package/lib/mib.js

@@ -372,13 +372,11 @@ var MIB = function (dir) {
                                             Object[Symbols[i - 2]]['OID'] = '0.0';
                                             Object[Symbols[i - 2]]['NameSpace'] = 'null';
                                         } else {
-                                            this.OID(Object[Symbols[i - 2]]['OBJECT IDENTIFIER'], '', Symbols[i - 2], '', function (ID, OD) {
-
-                                                Object[Symbols[i - 2]]['OID'] = ID;
-                                                Object[Symbols[i - 2]]['NameSpace'] = OD;
-                                                //Object[Symbols[i - 2]]['ModuleName'] = ModuleName;
-                                                // Object[Symbols[i - 2]]['ObjectName'] = Symbols[i - 2];
-                                            });
+                                            const { oidString, nameString } = this.getOidAndNamePaths(Object[Symbols[i - 2]]['OBJECT IDENTIFIER'], Symbols[i - 2], ModuleName);
+                                            Object[Symbols[i - 2]]['OID'] = oidString;
+                                            Object[Symbols[i - 2]]['NameSpace'] = nameString;
+                                            // Object[Symbols[i - 2]]['ModuleName'] = ModuleName;
+                                            // Object[Symbols[i - 2]]['ObjectName'] = Symbols[i - 2];
                                         }
 
                                     } else {
@@ -533,13 +531,11 @@ var MIB = function (dir) {
                                             Object[Symbols[r - 1]]['OID'] = '0.0';
                                             Object[Symbols[r - 1]]['NameSpace'] = 'null';
                                         } else {
-                                            this.OID(Object[Symbols[r - 1]]['OBJECT IDENTIFIER'], '', Symbols[r - 1], '', function (ID, OD) {
-
-                                                Object[Symbols[r - 1]]['OID'] = ID;
-                                                Object[Symbols[r - 1]]['NameSpace'] = OD;
-                                                //Object[Symbols[r - 1]]['ModuleName'] = ModuleName;
-                                                //Object[Symbols[r - 1]]['ObjectName'] = Symbols[r - 1];
-                                            });
+                                            const { oidString, nameString } = this.getOidAndNamePaths(Object[Symbols[r - 1]]['OBJECT IDENTIFIER'], Symbols[r - 1], ModuleName);
+                                            Object[Symbols[r - 1]]['OID'] = oidString;
+                                            Object[Symbols[r - 1]]['NameSpace'] = nameString;
+                                            // Object[Symbols[r - 1]]['ModuleName'] = ModuleName;
+                                            // Object[Symbols[r - 1]]['ObjectName'] = Symbols[r - 1];
                                         }
                                         if ( Object[Symbols[r - 1]]['REVISIONS-DESCRIPTIONS'] &&
                                                 Object[Symbols[r - 1]]['REVISIONS-DESCRIPTIONS'].length == 1 &&
@@ -732,71 +728,71 @@ var MIB = function (dir) {
             }
             callback(summary);
         },
-        OID: function (OBJECT_IDENTIFIER, ID, ObjectName, OD, callback) {
-            let members = OBJECT_IDENTIFIER.split(/\s+/);
-            let parent = members.shift();
-            let oid = members.pop();
-            if ( oid.includes('(') ) {
-                let oidSplit = oid.match(/(.*)\((.+)\)$/);
-                oid = oidSplit[2];
-            }
-            if (parent == 'iso') {
-                let midID = ['1'];
-                let midOD = ['iso'];
-                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);
-                }
-                midOD.push(ObjectName);
-                callback(midID.join('.'), midOD.join('.'));
-                return;
-            }
-            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(/(.*)\((.+)\)$/);
-                    // cater for unannotated middle entries
+        getOidAndNamePaths: function (OBJECT_IDENTIFIER, ObjectName, ModuleName) {
+            const entries = OBJECT_IDENTIFIER.split(/\s+/);
+            const parent = entries.shift();
+            const finalEntries = entries.pop();
+            const nameEntries = [];
+            const oidEntries = [];
+            // process middle entries if any
+            // e.g. { enterprises pwg(2699) mibs(1) jobmonMIB(1) }
+            for (const entry of entries) {
+                const match = entry.match(/(.*)\((.+)\)$/);
+                if ( match ) {
+                    oidEntries.push(match[2]);
+                    nameEntries.push(match[1]);
+                } else {
+                    // cater for unannotated middle entries (use number entries for name entries)
                     // e.g. { enterprises 2699 1 1 }
-                    if ( ! match ) {
-                        midID.push(entry);
-                        midOD.push(entry);
-                    } else {
-                        midID.push(match[2]);
-                        midOD.push(match[1]);
-                    }
+                    oidEntries.push(entry);
+                    nameEntries.push(entry);
                 }
-                midID.push(oid);
-                if ( ID != '' ) {
-                    midID.push(ID);
-                }
-                if ( OD != '' ) {
-                    midOD.push(OD);
-                }
-                ID = midID.join('.');
-                OD = midOD.join('.');
+            }
+            // ignore name entry if it exists on final OID entry - use object name instead
+            // e.g. for { mibs jobmonMIB(1) } we would ignore the "jobmonMIB" name
+            let finalOid;
+            if ( finalEntries.includes('(') ) {
+                const oidSplit = finalEntries.match(/(.*)\((.+)\)$/);
+                finalOid = oidSplit[2];
             } else {
-                // We have no middle entries e.g. { enterprises 2021 }
-                ID = ID == '' ? oid : [oid, ID].join('.');
-                OD = OD == '' ? parent : [parent, OD].join('.');
+                finalOid = finalEntries;
             }
-            for (var ModuleName in this.Modules) {
-                if (this.Modules.hasOwnProperty(ModuleName)) {
-                    if (this.Modules[ModuleName][parent]) {
-                        this.OID(this.Modules[ModuleName][parent]["OBJECT IDENTIFIER"], ID, ObjectName, OD, callback);
-                        break;
+            oidEntries.push(finalOid);
+            nameEntries.push(ObjectName);
+            let parentOidPrefix;
+            let parentNamePrefix;
+            if ( parent == 'iso' ) {
+                parentOidPrefix = '1';
+                parentNamePrefix = 'iso';
+            } else {
+                // find parent object
+                // first look in the current module
+                let parentObject = this.Modules[ModuleName][parent];
+                // if not found, find the import entry for the object
+                if ( ! parentObject ) {
+                    const importModules = Object.keys(this.Modules[ModuleName]['IMPORTS']);
+                    for (let importModule of importModules) {
+                        if (this.Modules[importModule][parent]) {
+                            parentObject = this.Modules[importModule][parent];
+                            break;
+                        }
                     }
                 }
+                if ( ! parentObject ) {
+                    // occurs for out-of-order dependencies in a module
+                    // console.warn('Parent object not found for ' + parent);
+                    return {
+                        oidString: '',
+                        nameString: ''
+                    };
+                }
+                parentOidPrefix = parentObject['OID'];
+                parentNamePrefix = parentObject['NameSpace'];
             }
+            return {
+                oidString: parentOidPrefix + '.' + oidEntries.join('.'),
+                nameString: parentNamePrefix + '.' + nameEntries.join('.')
+            };
         }
     });
 

package/package.json

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