Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: config guide restructuring #8932

Merged
merged 13 commits into from
Jul 10, 2024
Merged

Conversation

ossdhaval
Copy link
Contributor

Prepare


Description

Target issue

closes #8894

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

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

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval added the area-documentation Documentation needs to change as part of issue or PR label Jul 10, 2024
@ossdhaval ossdhaval self-assigned this Jul 10, 2024
Copy link

dryrunsecurity bot commented Jul 10, 2024

DryRun Security Summary

The pull request focuses on updating and improving the documentation for the Janssen Project, an identity and access management (IAM) platform, covering a wide range of configuration and management topics, including authentication, authorization, FIDO2, SCIM, logging, and more, to ensure the overall security of the Janssen platform.

Expand for full summary

Summary:

The changes in this pull request focus on updating and improving the documentation for the Janssen Project, an identity and access management (IAM) platform. The changes cover a wide range of configuration and management topics, including authentication, authorization, FIDO2, SCIM, logging, and more.

From an application security perspective, the key points are:

  1. The documentation provides detailed guidance on managing sensitive configuration settings, such as LDAP credentials, OAuth client secrets, and FIDO2 metadata. Ensuring these settings are properly secured and accessed only by authorized personnel is crucial for maintaining the overall security of the Janssen platform.

  2. The documentation emphasizes the use of command-line tools, text-based UIs, and REST APIs for managing the Janssen server configuration. This approach can be more secure than web-based interfaces, as it typically requires authentication and authorization, and provides more granular control over the operations being performed.

  3. The documentation covers various security-related features, such as password validation rules, FIDO2 attestation validation, and OAuth scope management. Ensuring these features are properly configured and aligned with the organization's security policies is essential for maintaining a secure IAM solution.

  4. The reorganization and restructuring of the configuration guide section make the documentation more organized and easier to navigate, which can improve the overall security of the Janssen platform by helping administrators and developers better understand the various configuration options and their security implications.

Files Changed:

The changes in this pull request span multiple files in the "docs/admin/config-guide" and related directories, covering a wide range of configuration and management topics for the Janssen Project. The key files changed include:

  • docs/admin/auth-server/config.md: Updates the link to the Config API Guide documentation.
  • docs/admin/config-guide/auth-server-config/agama-project-configuration.md: Provides documentation for managing Agama projects in the Janssen Server.
  • docs/admin/config-guide/auth-server-config/cache-configuration.md: Covers the configuration of the cache in the Janssen Server.
  • docs/admin/auth-server/openid-features/acrs.md: Documents the Authentication Context Class Reference (ACR) configuration in the Janssen Server.
  • docs/admin/config-guide/auth-server-config/couchbase-configuration.md: Provides guidance on configuring the Couchbase database integration.
  • docs/admin/config-guide/auth-server-config/default-authentication-method-config.md: Covers the configuration of the default authentication method.
  • docs/admin/config-guide/auth-server-config/json-web-key-config.md: Documents the management of JSON Web Keys (JWKs) in the Janssen Server.
  • docs/admin/config-guide/auth-server-config/ldap-configuration.md: Provides guidance on configuring the LDAP integration.
  • docs/admin/config-guide/auth-server-config/jans-authorization-server-config.md: Documents the configuration of the Janssen Authorization Server.
  • docs/admin/config-guide/auth-server-config/logging-configuration.md: Covers the configuration of logging in the Janssen Authorization Server.
  • docs/admin/config-guide/auth-server-config/messaging-config.md: Adds a placeholder for future documentation on messaging configuration.
  • docs/admin/config-guide/auth-server-config/ssa-config.md: Adds a new documentation page for "SSA Configuration".
  • docs/admin/config-guide/auth-server-config/oauth-umaresources-config.md: Documents the configuration of OAuth UMA resources.
  • docs/admin/config-guide/auth-server-config/oauth-scopes-config.md: Covers the configuration of OAuth scopes.
  • docs/admin/config-guide/auth-server-config/openid-connect-client-configuration.md: Documents the configuration of OpenID Connect clients.
  • docs/admin/config-guide/config-tools/jans-cli/README.md: Updates the README for the Janssen CLI tool.
  • docs/admin/config-guide/link-configuration.md: Adds a new documentation page for "Jans Link Configuration".
  • docs/admin/config-guide/scim-config/scim-group-config.md: Documents the configuration of SCIM group resources.

Code Analysis

We ran 7 analyzers against 28 files and 0 analyzers had findings. 7 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@mo-auto mo-auto added the comp-agama Touching folder /agama label Jul 10, 2024
@ossdhaval ossdhaval changed the title Docs config guide restructure docs: config guide restructuring Jul 10, 2024
@ossdhaval ossdhaval merged commit 9e25c05 into main Jul 10, 2024
9 checks passed
@ossdhaval ossdhaval deleted the docs-config-guide-restructure branch July 10, 2024 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-agama Touching folder /agama
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: docs: restructure navigation of configuration section -autocreated
4 participants