Support SNMPv3 HMAC-SHA-2 authentication protocols: SHA224, SHA256, SHA384 and SHA512

[NassimBtk]

Specification

We have added support for HMAC-SHA-2 authentication protocols in SNMP v3, including SHA224, SHA256, SHA384, and SHA512.

Updates and Modifications

1. Dependency Upgrade

   • Upgrade the SNMP dependency version to org.sentrysoftware:snmp:2.0.00.

2. Enhancements in SNMPv3 Authentication

   • Update the SNMPV3Configuration class to recognize and detect SHA224, SHA256, SHA384, and SHA512 authentication methods.

3. CLI Updates for SNMP v3

   • Revise the SnmpV3Cli tool:
     • Update the footer examples to reflect the new authentication options.
     • Modify @Option annotation for the --auth option to include SHA224, SHA256, SHA384, and SHA512.
     • Introduce a new usage example to demonstrate authentication via SHA256.

4. Global CLI Service Modifications

   • Enhance the SnmpV3ConfigCli service to display the newly supported authentication protocols in the --snmpv3-auth CLI @Option.

5. snmpv3cli Documentation Updates

   • Update the SNMPv3 CLI Documentation:
     • Modify syntax examples to display the new SNMPv3 authentication methods.
     • Revise the --auth option.

6. Update monitoring configuration doc:

   • https://metricshub.com/docs/latest/configuration/configure-monitoring.html#!#snmp-version-3

---

Acceptance Criteria

To validate the new authentication methods, the following acceptance tests should be conducted:

1. Dependency Validation

   • Confirm that the org.sentrysoftware:snmp:2.0.00 dependency is correctly integrated and loaded.

2. Protocol Support Verification

   • Verify that SHA224, SHA256, SHA384, and SHA512 authentication methods are successfully recognized and applied in SNMPv3 authentication.

3. CLI Functional Tests

   • Run SnmpV3Cli and confirm that:
     • The footer correctly displays the updated authentication protocols.
     • The --auth option description accurately reflects the newly added protocols.
     • The SHA256 example executes as expected without errors.

4. Global CLI Validation

   • Execute a job the metricshub CLI
     • The --snmpv3-auth option lists all the supported authentication methods.
     • Configuration updates are correctly applied and reflected in the CLI output.
     • The resource is correctly monitored through SNMPv3 SHA256

5. Configuration File Verification

   • Check that authType values in metricshub.yaml accept SHA224, SHA256, SHA384, and SHA512 without errors and the resource configured in metricshub.yaml is correctly monitored through SNMPv3 SHA256, SHA224, SHA256, SHA384, or SHA512.

6. End-to-End SNMPv3 Authentication Tests

   • Attempt authentication using each of the newly supported HMAC-SHA-2 algorithms (SHA224, SHA256, SHA384, SHA512) with an SNMPv3-enabled device and verify successful authentication.

7. Backward Compatibility Check

   • Ensure that previous authentication methods (MD5, SHA) remain functional and do not break existing configurations.

[NassimBtk]

@MedMaalej org.sentrysoftware:snmp:2.0.00 is now available.