Add support for SNMPv3 context engine ID and context name to snmptrap (#76)

This commits adds support for ContextEngineId and ContextName to the `snmptrap` input. 

Co-authored-by: Edmo Vamerlatti Costa <[email protected]>

Author: robbavey

.ci/docker-compose-integration.override.yml

@@ -1,5 +1,3 @@
-version: '2.4'
-
 services:
   logstash:
     container_name: snmp_ls

.ci/docker-compose.yml

@@ -1,6 +1,3 @@
-# docker ipv6 only support in version 2.x
-version: '2.4'
-
 # run tests:  cd ci/unit; docker-compose up --build --force-recreate
 # manual:  cd ci/unit; docker-compose run logstash bash
 services:

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.1.0
+  - Add support for SNMPv3 `context engine ID` and `context name` to the `snmptrap` input [#76](https://github.com/logstash-plugins/logstash-integration-snmp/pull/76)
+
 ## 4.0.7
   - FIX: The `snmptrap` input now correctly enforces the user security level set by `security_level` config, and drops received events that do not match the configured value [#75](https://github.com/logstash-plugins/logstash-integration-snmp/pull/75)
 

VERSION

@@ -1 +1 @@
-4.0.7
+4.1.0

docs/input-snmptrap.asciidoc

@@ -60,6 +60,8 @@ The value is stored in the `@metadata` where it can be used by other plugins in
 |ECS disabled, v1, v8 |Availability|Description
 |[@metadata][input][snmptrap][pdu][agent_addr]|`SNMPv1`|Network address of the object generating the trap
 |[@metadata][input][snmptrap][pdu][community]|`SNMPv1` `SNMPv2c`|SNMP community
+|[@metadata][input][snmptrap][pdu][context_engine_id]|`SNMPv3`|SNMP context engine ID
+|[@metadata][input][snmptrap][pdu][context_name]|`SNMPv3`|SNMP context name
 |[@metadata][input][snmptrap][pdu][enterprise]|`SNMPv1`|Type of object generating the trap
 |[@metadata][input][snmptrap][pdu][error_index]|`SNMPv2c` `SNMPv3`|Provides additional information by identifying
 which variable binding in the list caused the error

src/main/java/org/logstash/snmp/SnmpClient.java

@@ -246,7 +246,6 @@ public <A extends Address> void processPdu(final CommandResponderEvent<A> event)
                 if (!validateTrapMessage(version, securityName, event.getSecurityLevel(), allowedCommunities)) {
                     return;
                 }
-
                 final Map<String, Object> trapEvent = createTrapEvent(version, securityName, event.getPDU());
                 final Map<String, Object> formattedVarBindings = new HashMap<>(event.getPDU().getVariableBindings().size());
                 for (VariableBinding binding : event.getPDU().getVariableBindings()) {
@@ -306,6 +305,11 @@ private Map<String, Object> createTrapEvent(int version, final String securityNa
             trapEvent.put("error_status", pdu.getErrorStatus());
             trapEvent.put("error_status_text", pdu.getErrorStatusText());
             trapEvent.put("error_index", pdu.getErrorIndex());
+            if (pdu instanceof ScopedPDU) {
+                final ScopedPDU scopedPDU = (ScopedPDU) pdu;
+                trapEvent.put("context_engine_id", String.valueOf(scopedPDU.getContextEngineID()));
+                trapEvent.put("context_name", String.valueOf(scopedPDU.getContextName()));
+            }
         } else if (pdu instanceof PDUv1) {
             final PDUv1 pdUv1 = (PDUv1) pdu;
             trapEvent.put("enterprise", String.valueOf(pdUv1.getEnterprise()));

src/test/java/org/logstash/snmp/SnmpClientTest.java

@@ -1083,10 +1083,14 @@ void trapShouldProperlyCreateV2cTrapMessage() throws IOException {
 
     @Test
     void trapShouldProperlyCreateV3TrapMessage() throws IOException {
-        final PDU scopedPDU = new PDU(PDU.TRAP, List.of(
+        final ScopedPDU scopedPDU = new ScopedPDU();
+        scopedPDU.setVariableBindings(List.of(
                 new VariableBinding(new OID("1.1"), new OctetString("foo")),
                 new VariableBinding(new OID("1.2"), new OctetString("bar"))
         ));
+        scopedPDU.setContextEngineID(OctetString.fromString("666f6f", 16));
+        scopedPDU.setContextName(OctetString.fromString("626172", 16));
+        scopedPDU.setType(ScopedPDU.TRAP);
         scopedPDU.setRequestID(new Integer32(123));
 
         when(mibManager.map(any(OID.class)))
@@ -1105,6 +1109,8 @@ void trapShouldProperlyCreateV3TrapMessage() throws IOException {
         assertEquals(scopedPDU.getErrorStatus(), trapEvent.remove("error_status"));
         assertEquals(scopedPDU.getErrorStatusText(), trapEvent.remove("error_status_text"));
         assertEquals(scopedPDU.getErrorIndex(), trapEvent.remove("error_index"));
+        assertEquals(scopedPDU.getContextEngineID().toString(), trapEvent.remove("context_engine_id"));
+        assertEquals(scopedPDU.getContextName().toString(), trapEvent.remove("context_name"));
 
         @SuppressWarnings("unchecked") final Map<String, Object> variableBindings = (Map<String, Object>) trapEvent.remove("variable_bindings");
         scopedPDU.getVariableBindings().forEach(binding -> assertEquals(