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.

Sign up for GitHub

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

Jump to bottom

fix(docs): autogenerate docs #8891

Merged
merged 2 commits into from
Jul 8, 2024
Merged

fix(docs): autogenerate docs #8891

merged 2 commits into from
Jul 8, 2024

Conversation

mo-auto
Copy link
Member

@mo-auto mo-auto commented Jul 8, 2024 •
edited
Loading

Auto generated docs
Closes #8892,

@dryrunsecurity DryRunSecurity
Copy link

dryrunsecurity bot commented Jul 8, 2024 •
edited
Loading

Hi there 👋, @DryRunSecurity here, below is a summary of our analysis and findings.

DryRun Security Status Findings
Configured Codepaths Analyzer ✅ 0 findings
Server-Side Request Forgery Analyzer ✅ 0 findings
Secrets Analyzer ✅ 0 findings
Authn/Authz Analyzer ✅ 0 findings
SQL Injection Analyzer ✅ 0 findings
Sensitive Files Analyzer ✅ 0 findings
IDOR Analyzer ✅ 0 findings

Note

🟢 Risk threshold not exceeded.

Change Summary (click to expand)

The following is a summary of changes in this pull request made by me, your security buddy 🤖. Note that this summary is auto-generated and not meant to be a definitive list of security issues but rather a helpful summary from a security perspective.

Summary:

The changes in this pull request are primarily focused on updating the Helm chart documentation for the Janssen Project, a suite of open-source identity and access management (IAM) tools. The key changes include:

  1. Updating the version of the helm-docs tool used to generate the Helm chart documentation across various charts, including janssen-all-in-one, auth-server-key-rotation, auth-server, casa, cn-istio-ingress, config-api, kc-scheduler, config, link, fido2, persistence, nginx-ingress, opendj, saml, and scim.

  2. Introducing a new environment variable CN_SSL_CERT_FROM_DOMAIN for the Janssen Configurator container, which helps to validate the SSL certificate used by the Configurator and mitigate potential man-in-the-middle attacks.

  3. Updating the Docker-based installation documentation to include additional script files (up.sh, down.sh, clean.sh) to simplify the process of starting, stopping, and cleaning up the Janssen deployment.

  4. Modifying the Helm chart configuration, such as increasing the memory limit for the config-api service, adding the kc-scheduler service, and updating the lock-config endpoint in the Nginx ingress definitions.

  5. Updating the Jans Config API Swagger documentation, including changes to the adminCanAccess and userCanAccess properties, as well as the introduction of a new fapi flag.

Overall, these changes do not appear to introduce any immediate security concerns, but it's important to review the updates to the Helm charts, Docker-based installation, and API documentation to ensure that they align with the intended security model and do not introduce any unintended vulnerabilities.

Files Changed:

  1. charts/janssen-all-in-one/README.md: Updated the Helm chart metadata version.
  2. charts/janssen/charts/auth-server-key-rotation/README.md: Updated the Helm chart metadata version.
  3. charts/janssen/charts/auth-server/README.md: Updated the Helm chart metadata version.
  4. charts/janssen/charts/casa/README.md: Updated the Helm chart metadata version.
  5. charts/janssen/README.md: Updated the Helm chart metadata version.
  6. charts/janssen/charts/cn-istio-ingress/README.md: Updated the Helm chart metadata version.
  7. charts/janssen/charts/config-api/README.md: Updated the Helm chart metadata version.
  8. charts/janssen/charts/kc-scheduler/README.md: Updated the Helm chart metadata version.
  9. charts/janssen/charts/config/README.md: Updated the Helm chart metadata version.
  10. charts/janssen/charts/link/README.md: Updated the Helm chart metadata version.
  11. charts/janssen/charts/fido2/README.md: Updated the Helm chart metadata version.
  12. charts/janssen/charts/persistence/README.md: Updated the Helm chart metadata version.
  13. charts/janssen/charts/nginx-ingress/README.md: Updated the Helm chart metadata version.
  14. charts/janssen/charts/opendj/README.md: Updated the Helm chart metadata version.
  15. charts/janssen/charts/saml/README.md: Updated the Helm chart metadata version.
  16. charts/janssen/charts/scim/README.md: Updated the Helm chart metadata version.
  17. docs/admin/reference/kubernetes/docker-jans-configurator.md: Added a new environment variable CN_SSL_CERT_FROM_DOMAIN to validate the SSL certificate used by the Janssen Configurator.
  18. docs/admin/install/docker-install/compose.md: Updated the Docker-based installation documentation to include additional script files.
  19. docs/admin/reference/kubernetes/helm-chart.md: Updated the Janssen Helm chart to version 1.1.3, including changes to the config-api service, addition of the kc-scheduler service, and updates to the Nginx ingress definitions.
  20. `jans-config-api/docs/j

Powered by DryRun Security

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-charts-jans comp-jans-config-api Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality labels Jul 8, 2024
@mo-auto
Copy link
Member Author

mo-auto commented Jul 8, 2024

Error: Hi @mo-auto, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

@mo-auto mo-auto mentioned this pull request Jul 8, 2024
Closed
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Jul 8, 2024

Quality Gate Passed 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

@moabu moabu merged commit 56a0dd0 into main Jul 8, 2024
10 checks passed
@moabu moabu deleted the cn-jans-update-auto-generated-docs branch July 8, 2024 13:03
yuriyz pushed a commit that referenced this pull request Nov 7, 2024
@mo-auto
fix(docs): autogenerate docs (#8891)
ad327fa 
* docs: auto-generated property docs

* docs: auto-generated Swagger SPEC docs

Former-commit-id: 56a0dd0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@moabu moabu moabu approved these changes

@pujavs pujavs Awaiting requested review from pujavs pujavs is a code owner

@yuriyz yuriyz Awaiting requested review from yuriyz yuriyz is a code owner

@yurem yurem Awaiting requested review from yurem yurem is a code owner

@iromli iromli Awaiting requested review from iromli iromli is a code owner

Assignees
No one assigned
Labels
area-documentation Documentation needs to change as part of issue or PR comp-charts-jans comp-jans-config-api Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

fix: fix(docs): autogenerate docs -autocreated
2 participants
@mo-auto @moabu