JanssenProject / jans

An open source enterprise digital identity platform for CIAM or workforce... Janssen is a distribution of standards-based, developer friendly, components that are engineered to work together in any cloud. #OAuth #OpenID #FIDO
https://docs.jans.io
Apache License 2.0
478 stars 75 forks source link

ci: fix nightly package paths and docs #10256

Closed moabu closed 14 hours ago

moabu commented 14 hours ago

Prepare


Description

Target issue

closes #10243

Implementation Details


Test and Document the changes

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.

Closes #10257,

dryrunsecurity[bot] commented 14 hours ago

DryRun Security Summary

The provided code changes focus on ensuring the integrity and trustworthiness of the distributed software artifacts for the "Jans" application through the use of secure practices, such as generating SHA-256 checksums and handling nightly builds separately from official releases, while also addressing potential security concerns in the GitHub Actions workflow responsible for building and deploying the project's documentation.

Expand for full summary
**Summary:** The provided code changes cover three different files related to the packaging and deployment process of the "Jans" application. The changes demonstrate a focus on ensuring the integrity and trustworthiness of the distributed software artifacts through the use of secure practices, such as generating SHA-256 checksums and handling nightly builds separately from official releases. The first two changes involve shell scripts that generate checksums for RPM packages, with the scripts being tailored for different Linux distributions (SUSE 15 and EL8). These scripts exhibit good security practices, including the use of a consistent naming convention for the checksum files, robust version handling, and secure checksum generation using the `sha256sum` command. The third change involves a GitHub Actions workflow that is responsible for building and deploying the documentation for the Janssen Project. While the changes are primarily focused on updating version numbers and managing the deployment process, there are a few potential security concerns that should be addressed, such as ensuring proper sanitization of user input to prevent command injection vulnerabilities. Overall, the code changes demonstrate a strong emphasis on security and integrity in the packaging and deployment processes, which is a crucial aspect of maintaining a secure and trustworthy application. **Files Changed:** 1. `automation/packaging/rpm/suse15/checksum.sh`: - This shell script generates SHA-256 checksums for RPM packages, handling both standard version numbers and "nightly" builds. - The script uses a consistent file naming convention and follows good security practices for checksum generation. 2. `automation/packaging/rpm/el8/checksum.sh`: - This shell script is similar to the SUSE 15 version, generating SHA-256 checksums for RPM packages on the EL8 platform. - The script also handles nightly builds and follows a consistent naming convention for the checksum files. 3. `.github/workflows/build-docs.yml`: - This is a GitHub Actions workflow that is responsible for building and deploying the documentation for the Janssen Project. - The changes focus on updating version numbers in the documentation files and managing the deployment of the documentation to the GitHub Pages site. - While the changes are primarily focused on the deployment process, there are a few potential security concerns related to the use of user input in commands like `egrep`, `sed`, `gh`, and `git`.

Code Analysis

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

Riskiness

:green_circle: Risk threshold not exceeded.

View PR in the DryRun Dashboard.

mo-auto commented 14 hours ago

Error: Hi @moabu, 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.