net-snmp 3.6.1 → 3.6.4

package/CONTRIBUTING.md

@@ -11,7 +11,9 @@ the developers managing and developing this open source project.
 
 The issue tracker is the preferred channel for [bug reports](#bugs),
 [features requests](#features) and [submitting pull
-requests](#pull-requests).
+requests](#pull-requests).  Please prefer the issue tracker over
+emailing individual project contributors as your first engagement
+with the project.
 
 ## What to always do
 

package/README.md

@@ -540,6 +540,7 @@ var options = {
     trapPort: 162,
     version: snmp.Version1,
     backwardsGetNexts: true,
+    reportOidMismatchErrors: false,
     idBitsSize: 32
 };
 
@@ -567,7 +568,9 @@ is an object, and can contain the following items:
  * `version` - Either `snmp.Version1` or `snmp.Version2c`, defaults to
    `snmp.Version1`
  * `backwardsGetNexts` - boolean to allow GetNext operations to retrieve lexicographically
-   preceeding OIDs
+   preceding OIDs, defaults to `true`
+ * `reportOidMismatchErrors` - boolean to allow error reporting of OID mismatches between
+   requests and responses, defaults to `false`
  * `idBitsSize` - Either `16` or `32`, defaults to `32`.  Used to reduce the size
     of the generated id for compatibility with some older devices.
 
@@ -592,6 +595,8 @@ var options = {
     trapPort: 162,
     version: snmp.Version3,
     engineID: "8000B98380XXXXXXXXXXXXXXXXXXXXXXXX", // where the X's are random hex digits
+    backwardsGetNexts: true,
+    reportOidMismatchErrors: false,
     idBitsSize: 32,
     context: ""
 };
@@ -1452,6 +1457,7 @@ class:
 var options = {
     port: 162,
     disableAuthorization: false,
+    includeAuthentication: false,
     accessControlModelType: snmp.AccessControlModelType.None,
     engineID: "8000B98380XXXXXXXXXXXXXXXXXXXXXXXX", // where the X's are random hex digits
     address: null,
@@ -1483,6 +1489,8 @@ an object, possibly empty, and can contain the following fields:
  * `transport` - the transport family to use - defaults to `udp4`
  * `address` - the IP address to bind to - default to `null`, which means bind to all IP
  addresses
+ * `includeAuthentication` - adds the community (v1/2c) or user name (v3) information
+ to the notification callback - defaults to `false`
 
 The `callback` parameter is a callback function of the form
 `function (error, notification)`.  On an error condition, the `notification`
@@ -3174,6 +3182,18 @@ Example programs are included under the module's `example` directory.
 
  * Add v3 context to non-initial PDUs
 
+## Version 3.6.2 - 07/04/2022
+
+ * Add option for receiver to receive client authentication identity
+
+## Version 3.6.3 - 26/04/2022
+
+ * Fix logic for v3 time synchronization requirement
+
+## Version 3.6.4 - 14/05/2022
+
+ * Ignore mismatched returned OIDs by default
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/snmp-receiver.js

@@ -7,7 +7,8 @@ var snmpOptions = {
     disableAuthorization: options.n,
     port: options.p,
 	transport: options.t,
-    engineID: options.e
+    engineID: options.e,
+    includeAuthentication: options.a
 };
 
 var cb = function(error, trap) {

package/index.js

@@ -1828,6 +1828,10 @@ var Session = function (target, authenticator, options) {
 			? options.backwardsGetNexts
 			: true;
 
+	this.reportOidMismatchErrors = (typeof options.reportOidMismatchErrors !== 'undefined')
+            ? options.reportOidMismatchErrors
+            : false;
+
 	DEBUG = options.debug;
 
 	this.engine = new Engine (options.engineID);
@@ -1870,6 +1874,8 @@ function _generateId (bitSize) {
 }
 
 Session.prototype.get = function (oids, responseCb) {
+	var reportOidMismatchErrors = this.reportOidMismatchErrors;
+
 	function feedCb (req, message) {
 		var pdu = message.pdu;
 		var varbinds = [];
@@ -1879,10 +1885,10 @@ Session.prototype.get = function (oids, responseCb) {
 					+ "match response OIDs", ResponseInvalidCode.EReqResOidNoMatch));
 		} else {
 			for (var i = 0; i < req.message.pdu.varbinds.length; i++) {
-				if (req.message.pdu.varbinds[i].oid != pdu.varbinds[i].oid) {
+				if ( reportOidMismatchErrors && req.message.pdu.varbinds[i].oid != pdu.varbinds[i].oid ) {
 					req.responseCb (new ResponseInvalidError ("OID '"
 							+ req.message.pdu.varbinds[i].oid
-							+ "' in request at positiion '" + i + "' does not "
+							+ "' in request at position '" + i + "' does not "
 							+ "match OID '" + pdu.varbinds[i].oid + "' in response "
 							+ "at position '" + i + "'", ResponseInvalidCode.EReqResOidNoMatch));
 					return;
@@ -1984,7 +1990,7 @@ Session.prototype.getBulk = function () {
 							pdu.varbinds[respIndex].oid)) {
 						req.responseCb (new ResponseInvalidError ("OID '"
 								+ req.message.pdu.varbinds[reqIndex].oid
-								+ "' in request at positiion '" + (reqIndex)
+								+ "' in request at position '" + (reqIndex)
 								+ "' does not precede OID '"
 								+ pdu.varbinds[respIndex].oid
 								+ "' in response at position '" + (respIndex) + "'",
@@ -2211,7 +2217,7 @@ Session.prototype.onMsg = function (buffer) {
 				return;
 			}
 			req.originalPdu.contextName = this.context;
-			var timeSyncNeeded = ! message.msgSecurityParameters.msgAuthoritativeEngineBoots || ! message.msgSecurityParameters.msgAuthoritativeEngineTime;
+			var timeSyncNeeded = ! message.msgSecurityParameters.msgAuthoritativeEngineBoots && ! message.msgSecurityParameters.msgAuthoritativeEngineTime;
 			this.sendV3Req (req.originalPdu, req.feedCb, req.responseCb, req.options, req.port, timeSyncNeeded);
 		}
 	} else if ( this.proxy ) {
@@ -2294,6 +2300,8 @@ Session.prototype.send = function (req, noWait) {
 };
 
 Session.prototype.set = function (varbinds, responseCb) {
+	var reportOidMismatchErrors = this.reportOidMismatchErrors;
+
 	function feedCb (req, message) {
 		var pdu = message.pdu;
 		var varbinds = [];
@@ -2303,10 +2311,10 @@ Session.prototype.set = function (varbinds, responseCb) {
 					+ "match response OIDs", ResponseInvalidCode.EReqResOidNoMatch));
 		} else {
 			for (var i = 0; i < req.message.pdu.varbinds.length; i++) {
-				if (req.message.pdu.varbinds[i].oid != pdu.varbinds[i].oid) {
+				if ( reportOidMismatchErrors && req.message.pdu.varbinds[i].oid != pdu.varbinds[i].oid ) {
 					req.responseCb (new ResponseInvalidError ("OID '"
 							+ req.message.pdu.varbinds[i].oid
-							+ "' in request at positiion '" + i + "' does not "
+							+ "' in request at position '" + i + "' does not "
 							+ "match OID '" + pdu.varbinds[i].oid + "' in response "
 							+ "at position '" + i + "'", ResponseInvalidCode.EReqResOidNoMatch));
 					return;
@@ -3126,6 +3134,7 @@ var Receiver = function (options, callback) {
 	this.port = options.port || 162;
 	options.port = this.port;
 	this.disableAuthorization = options.disableAuthorization || false;
+	this.includeAuthentication = options.includeAuthentication || false;
 	this.context = (options && options.context) ? options.context : "";
 	this.listener = new Listener (options, this);
 };
@@ -3162,29 +3171,38 @@ Receiver.prototype.onMsg = function (buffer, rinfo) {
 	// Inform/trap processing
 	// debug (JSON.stringify (message.pdu, null, 2));
 	if ( message.pdu.type == PduType.Trap || message.pdu.type == PduType.TrapV2 ) {
-		this.callback (null, this.formatCallbackData (message.pdu, rinfo) );
+		this.callback (null, this.formatCallbackData (message, rinfo) );
 	} else if ( message.pdu.type == PduType.InformRequest ) {
 		message.pdu.type = PduType.GetResponse;
 		message.buffer = null;
 		message.setReportable (false);
 		this.listener.send (message, rinfo);
 		message.pdu.type = PduType.InformRequest;
-		this.callback (null, this.formatCallbackData (message.pdu, rinfo) );
+		this.callback (null, this.formatCallbackData (message, rinfo) );
 	} else {
 		this.callback (new RequestInvalidError ("Unexpected PDU type " + message.pdu.type + " (" + PduType[message.pdu.type] + ")"));
 	}
 };
 
-Receiver.prototype.formatCallbackData = function (pdu, rinfo) {
-	if ( pdu.contextEngineID ) {
-		pdu.contextEngineID = pdu.contextEngineID.toString('hex');
+Receiver.prototype.formatCallbackData = function (message, rinfo) {
+	if ( message.pdu.contextEngineID ) {
+		message.pdu.contextEngineID = message.pdu.contextEngineID.toString('hex');
 	}
-	delete pdu.nonRepeaters;
-	delete pdu.maxRepetitions;
-	return {
-		pdu: pdu,
-		rinfo: rinfo 
+	delete message.pdu.nonRepeaters;
+	delete message.pdu.maxRepetitions;
+	const formattedData = {
+		pdu: message.pdu,
+		rinfo: rinfo
 	};
+	if (this.includeAuthentication) {
+		if (message.community) {
+			formattedData.pdu.community = message.community;
+		} else if (message.user) {
+			formattedData.pdu.user = message.user.name;
+		}
+	}
+
+	return formattedData;
 };
 
 Receiver.prototype.close  = function() {

package/package.json

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

package/test/receiver-test.sh

@@ -61,8 +61,8 @@ node ${HOME_DIR}/example/snmp-trap.js -v 3 -l authNoPriv -u ${USER_AUTH} -a ${AU
 node ${HOME_DIR}/example/snmp-trap.js -v 3 -l authPriv -u ${USER_PRIV} -a ${AUTH_PROTOCOL} -A ${AUTH_KEY} -x ${PRIV_PROTOCOL} -X ${PRIV_KEY} ${PARAMS} ${HOST} ${TRAP_OID}
 node ${HOME_DIR}/example/snmp-inform.js -v 2c -c ${COMMUNITY} ${PARAMS} ${HOST} ${TRAP_OID}
 node ${HOME_DIR}/example/snmp-inform.js -v 3 -l noAuthNoPriv -u ${USER_NONE} ${PARAMS} ${HOST} ${TRAP_OID}
-node ${HOME_DIR}/example/snmp-inform.js -v 3 -u ${USER_AUTH} -a ${AUTH_PROTOCOL} -A ${AUTH_KEY} ${PARAMS} ${HOST} ${TRAP_OID}
-node ${HOME_DIR}/example/snmp-inform.js -v 3 -u ${USER_PRIV} -a ${AUTH_PROTOCOL} -A ${AUTH_KEY} -x ${PRIV_PROTOCOL} -X ${PRIV_KEY} ${PARAMS} ${HOST} ${TRAP_OID}
+node ${HOME_DIR}/example/snmp-inform.js -v 3 -l authNoPriv -u ${USER_AUTH} -a ${AUTH_PROTOCOL} -A ${AUTH_KEY} ${PARAMS} ${HOST} ${TRAP_OID}
+node ${HOME_DIR}/example/snmp-inform.js -v 3 -l authPriv -u ${USER_PRIV} -a ${AUTH_PROTOCOL} -A ${AUTH_KEY} -x ${PRIV_PROTOCOL} -X ${PRIV_KEY} ${PARAMS} ${HOST} ${TRAP_OID}
 ENDOFCMDS
 
 COUNT=1
@@ -81,4 +81,3 @@ while read CMD ; do
 done <${CMDS}
 
 rm -f ${CMDS}
-