feat(jans-cli-tui): config-api configuration

[devrimyatar]

closes #8598

@ossdhaval This PR needs TUI documentation update. After this PR merged please update TUI docs and add Config API screen:

• Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

[dryrunsecurity]

DryRun Security Summary

The pull request covers various updates to the Jans CLI-TUI application, including improvements to the handling of list-type values, Admin UI functionality, documentation for the Jans Config-API configuration, and enhancements to utility functions and user interface components, with a focus on ensuring the overall security of the application.

Expand for full summary

Summary:

The code changes in this pull request cover various aspects of the Jans CLI-TUI application, including updates to the handling of list-type values in the getTitledText function, improvements to the Admin UI functionality, documentation updates for the Jans Config-API configuration, and enhancements to the utility functions and user interface components.

From an application security perspective, the changes do not appear to introduce any obvious security vulnerabilities. However, it is important to review the entire codebase and the application's architecture to ensure that it follows best practices for secure application development. Key areas to focus on include input validation, authentication and authorization, logging and auditing, secure communication, and the handling of sensitive data.

The documentation updates for the Jans Config-API configuration are particularly noteworthy, as they highlight several security-related settings and controls, such as API protection, CORS configuration, audit logging, and user attribute validation. These settings are critical for ensuring the overall security of the application.

Files Changed:

1. jans-cli-tui/cli_tui/jans_cli_tui.py: The changes ensure that list-type values are properly displayed in the TextArea widget, which does not introduce any obvious security concerns.

2. docs/admin/config-guide/config-api-config/janssen-config-api-configuration.md: The documentation updates provide a comprehensive overview of the different configuration tools available for the Jans Config-API, with a strong emphasis on security-related settings and controls.

3. jans-cli-tui/cli_tui/plugins/040_admin_ui/main.py: The changes focus on the Admin UI functionality, including the management of admin roles and permissions. While the code appears to handle these operations securely, it is important to ensure that the underlying API endpoints and data validation are also secure.

4. docs/admin/config-guide/config-tools/config-api/config.md: This documentation update provides detailed information on managing the Jans Config-API configuration, highlighting the security-critical settings such as OAuth authorization, API protection, and user attribute management.

5. jans-cli-tui/cli_tui/utils/utils.py: The changes introduce a new attribute to the common_data object, which does not appear to have any direct security implications. However, it is recommended to review the get_item_data method and the check_email function to ensure that they handle input validation properly.

6. jans-cli-tui/cli_tui/plugins/140_config_api/main.py: The changes in this file are focused on the Jans Config API plugin, which allows users to configure various settings related to the Jans Config API. The code appears to handle these operations securely, but it is important to ensure that input validation, authentication, authorization, logging, and secure communication are properly implemented.

7. jans-cli-tui/cli_tui/utils/background_tasks.py: The changes in this file are focused on improving the efficiency and reliability of the attribute retrieval process, which is an important aspect of the application's functionality. The code demonstrates good practices, such as error handling, pagination, and separation of concerns, which help to mitigate potential security risks.

8. jans-cli-tui/cli_tui/wui_components/jans_label_container.py: The changes in this file are focused on improving the functionality and appearance of the label container, without introducing any obvious security concerns. However, it is recommended to review the input validation and secure callback implementation.

9. jans-cli-tui/cli_tui/wui_components/jans_label_widget.py: The changes in this file are focused on improving the functionality of the label widget, including the addition of a filtering mechanism. While the changes do not appear to introduce any security vulnerabilities, it is important to ensure that user input is properly validated and that the application's behavior aligns with the expected permissions and access levels.

Code Analysis

We ran 9 analyzers against 15 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

[ossdhaval]

Hi @devrimyatar Thanks for high-lighting the need for update to the documentation for this PR.

There are two things that I can suggest. And these are what we are striving to achieve too with respect to how we tackle the documentation.

1. Let's make the documentation changes part of the same development PR where the code is being changed. Meaning the code and docs should flow together.
2. Developers have to contribute/update/create the related documentation. I'll review the doc changes to ensure that they are consistent with the other existing documentation, the documentation guidelines and bit of proofreading too.

Both of the above points will help us keep up the documentation with the constantly evolving code and the Janssen Server's feature set.

For this PR, mention me in the PR comments once you add the documentation that is ready for review.

[sonarqubecloud]

Quality Gate passed for 'agama parent'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'jans-core'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'Jans-Keycloak-Link'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'jans-pycloudlib'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

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
0.0% Duplication on New Code

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'Fido2 API'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'orm'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'keycloak-integration-parent'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'SCIM API'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[ossdhaval]

There is this document that has a good amount of overlap with your document. I'll need to merge contents.

[sonarqubecloud]

Quality Gate failed for 'jans-cli'

Failed conditions
14 New Code Smells (required ≤ 8)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[sonarqubecloud]

Quality Gate passed for 'jans-linux-setup'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud