Skip to content

fix(jans-lock): fix broken link in lock docs #10110

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

Merged
merged 2 commits into from
Nov 11, 2024
Merged

fix(jans-lock): fix broken link in lock docs #10110

merged 2 commits into from
Nov 11, 2024

Conversation

yurem
Copy link
Contributor

@yurem yurem commented Nov 11, 2024

closes #9572

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

Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>
@yurem yurem enabled auto-merge (squash) November 11, 2024 11:35
Copy link

dryrunsecurity bot commented Nov 11, 2024

DryRun Security Summary

The pull request updates the documentation for the Jans Lock Server, a Java Weld application that connects ephemeral Cedarlings to the enterprise, including details on its purpose, installation, configuration, logging, and command-line and text-based user interface capabilities, as well as highlighting its security features such as the use of OAuth and the requirement for Cedarlings to present a Secure Software Attestation during client registration.

Expand for full summary

Summary:

The code change in this pull request appears to be a documentation update for the Jans Lock Server, which is a Java Weld application that connects ephemeral Cedarlings to the enterprise. The key changes include updating the link to the Swagger UI for the Lock Server endpoints and providing a comprehensive overview of the Lock Server, including its purpose, installation, configuration, logging, and command-line interface (CLI) and text-based user interface (TUI) capabilities.

From an application security perspective, the documentation highlights several positive security measures implemented in the Lock Server, such as the use of OAuth and the requirement for Cedarlings to present a Secure Software Attestation (SSA) during client registration to obtain access tokens with scopes for the OAuth-protected Lock Server endpoints. Additionally, the availability of logging features, including an audit log for RDBMS options and a JWT (JSON Web Token) status log, can be valuable for security monitoring and incident investigation. The ability to manage the Lock Server's runtime configuration and view activity through the CLI and TUI is also a useful feature for administrators to maintain and monitor the application's security posture.

Files Changed:

  • docs/janssen-server/lock/lock-server.md: This file contains the documentation update for the Jans Lock Server. The changes include updating the link to the Swagger UI for the Lock Server endpoints and providing a detailed overview of the Lock Server's purpose, installation, configuration, logging, and CLI/TUI capabilities. The documentation also highlights the security-related features, such as the use of OAuth and the requirement for Cedarlings to present an SSA during client registration.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-lock kind-bug Issue or PR is a bug in existing functionality labels Nov 11, 2024
@yurem yurem changed the title fix(jans-lock): fix broken linjk in lock docs fix(jans-lock): fix broken link in lock docs Nov 11, 2024
@yurem yurem merged commit 40af176 into main Nov 11, 2024
16 of 17 checks passed
@yurem yurem deleted the lock_docs_update branch November 11, 2024 18:10
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-docs Touching folder /docs comp-jans-lock kind-bug Issue or PR is a bug in existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(jans-lock): rename Lock Master to Lock Server
3 participants