net-snmp 3.6.1 → 3.6.2

package/README.md

@@ -1452,6 +1452,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 +1484,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 +3177,10 @@ 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
+
 # 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

@@ -3126,6 +3126,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 +3163,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.2",
   "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}
-