feat(jans-auth): update SG script to conform API

[yurem]

closes #9540

• I confirm that there is no impact on the docs due to the code changes in this PR.

[dryrunsecurity]

DryRun Security Summary

The pull request primarily involves refactoring and renaming methods in Java classes related to the Jans Config API's "Lock" plugin to improve code readability and consistency, without introducing any significant security vulnerabilities, while emphasizing the importance of maintaining a vigilant approach to application security and reviewing the OpenAPI specification for the Lock plugin to ensure proper implementation and security of the API's authentication, authorization, input validation, and error handling mechanisms.

Expand for full summary

Summary:

The code changes in this pull request primarily involve refactoring and renaming methods in various Java classes related to the Jans Config API's "Lock" plugin. These changes are focused on improving code readability and consistency by aligning the method names with standard Java naming conventions.

From an application security perspective, the changes do not appear to introduce any significant security vulnerabilities. The affected classes, such as HealthEntry, LogEntry, and TelemetryEntry, are data model classes that handle various types of monitoring and telemetry data. The changes are mostly cosmetic, involving the renaming of getter and setter methods.

However, it's important to maintain a vigilant approach to application security and regularly review the codebase for potential vulnerabilities, especially in areas related to logging, auditing, and data handling. Additionally, the changes to the OpenAPI specification for the Lock plugin should be reviewed to ensure that the API's authentication, authorization, input validation, and error handling mechanisms are properly implemented and secured.

Files Changed:

1. jans-config-api/plugins/lock-plugin/src/main/java/io/jans/configapi/plugin/lock/model/stat/HealthEntry.java: The changes in this file involve renaming the getnodeName() and setnodeName() methods to getNodeName() and setNodeName(), respectively, to follow Java naming conventions.

2. jans-config-api/plugins/lock-plugin/src/main/java/io/jans/configapi/plugin/lock/model/stat/LogEntry.java: The changes in this file also involve renaming the getnodeName() and setnodeName() methods to getNodeName() and setNodeName(). The class is used for handling logging-related data and is annotated with ORM annotations, indicating it is used for data persistence.

3. jans-config-api/plugins/lock-plugin/src/main/java/io/jans/configapi/plugin/lock/model/stat/TelemetryEntry.java: Similar to the previous files, the changes in this file involve renaming the getnodeName() and setnodeName() methods to getNodeName() and setNodeName(). The TelemetryEntry class is used for storing and retrieving telemetry-related data.

4. docs/script-catalog/person_authentication/super-gluu-external-authenticator/SuperGluuExternalAuthenticator.py: This file contains the code for the Super-Gluu external authenticator, which is responsible for handling the authentication flow for the Super-Gluu application. The code includes various security-related features, such as secure communication channels, multi-step authentication, U2F device validation, and push notification handling.

5. jans-config-api/plugins/docs/lock-plugin-swagger.yaml: This file contains the OpenAPI specification for the Lock plugin, which defines the API endpoints and data models for managing configuration, audit, and telemetry data. The changes in this file should be reviewed to ensure that the API's authentication, authorization, input validation, and error handling mechanisms are properly implemented and secured.

Code Analysis

We ran 9 analyzers against 5 files and 1 analyzer had findings. 8 analyzers had no findings.

Analyzer	Findings
Authn/Authz Analyzer	1 finding

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

[sonarcloud]

Quality Gate passed for 'jans-config-api-parent'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
100.0% Duplication on New Code

See analysis details on SonarCloud