Request repository hosting for slsa-plugin

[netomi]

Repository URL

https://github.com/netomi/slsa-jenkins-plugin

New Repository Name

slsa-plugin

Description

The Eclipse Security Team has been developing a jenkins plugin to create SLSA provenance attestations (https://slsa.dev/attestation-model) during a build hosted in the repository above.

Its still early work, but already functional, and we would like to start the process of migrating it to the jenkinsci organization.

GitHub users to have commit permission

@netomi @mbarbero @fredg02

Jenkins project users to have release permission

netomi

Issue tracker

GitHub issues

[jenkins-cert-app]

Security audit, information and commands

The security team is auditing all the hosting requests, to ensure a better security by default.

This message informs you that a security scan was triggered on your repository. It takes ~10 minutes to complete.

Commands

The bot will parse all comments, and it will check if any line start with a command. Security team only:

• /audit-ok => the audit is complete, the hosting can continue :tada:.
• /audit-skip => the audit is not necessary, the hosting can continue :tada:.
• /audit-required => the superficial audit was not sufficient, a deeper look is necessary :mag:.
• /audit-findings => the audit reveals some issues that require corrections :pencil2:.

Anyone:

• /request-security-scan => the findings from the security scan were corrected, this command will re-scan your repository :mag:.
• /audit-review => the findings from the audits were corrected, this command will ping the security team to review the findings :eyes:. It's only applicable when the previous audit required changes.

Only one command can be requested per comment.

(automatically generated message, version: 1.15.8)

[jenkins-cert-app]

:x: CodeQL Scan failed. The Security team was notified about this.

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :warning: Warning: No pom.xml detected.

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin.git' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :warning: Warning: No pom.xml detected.

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[NotMyFault]

The repository must be hosted on GitHub, don't add .git at the end of the URL @netomi

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin.git' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :warning: Warning: No pom.xml detected.

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[netomi]

ok ty, I already guessed something like that. We will move the repo first to github and then start the migration.

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: Repository URL 'https://gitlab.eclipse.org/eclipsefdn/security/slsa-jenkins-plugin' is not a valid GitHub repository (check that you do not have .git at the end, GitHub API doesn't support this).
• :warning: Warning: No pom.xml detected.

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: You must specify an <scm> block in your pom.xml. See https://maven.apache.org/pom.html#SCM for more information.
• :no_entry: Required: You must add a 'groupId' in your pom.xml with the value io.jenkins.plugins.
• :no_entry: Required: The pom.xml file in the root of the origin repository is not valid
• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)
• :no_entry: Required: The 'artifactId' from the pom.xml (slsa-provenance) is incorrect, it should be slsa ('New Repository Name' field with "-plugin" removed)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[netomi]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[netomi]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• :no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: netomi (reports are re-synced hourly, wait to re-check for a bit after logging in)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[NotMyFault]

/request-security-scan

[jenkins-cert-app]

The CodeQL Scan discovered 2 finding(s) :mag:. For each of them, either apply the recommended correction, suppress the warning or provide a justification.

Once you're done, either re-run the scan with /request-security-scan or request the Security team to review your justifications with /audit-review.

---

Stapler: Missing permission check

You can find detailed information about this finding here.

ProvenanceRecorder.java#151

``` Potential missing permission check in DescriptorImpl#doCheckTargetDirectory ```

ProvenanceRecorder.java#144

``` Potential missing permission check in DescriptorImpl#doCheckArtifactFilter ```

[NotMyFault]

Hey @netomi,

thanks for moving on to GitHub. I took a brief look over the hosting request and have some feedback for you:

• https://github.com/netomi/slsa-jenkins-plugin/blob/main/README.md Please fill out the readme with useful information for the user, rather than shipping the unedited default. This includes fixing the broken links, like LICENSE.md at the bottom
• https://github.com/netomi/slsa-jenkins-plugin/blob/main/pom.xml you can safely remove all unused dependencies within the <dependencies> block. They don't need to be included if they are unused.
• https://github.com/netomi/slsa-jenkins-plugin/blob/c688d2ea29527c405cbcbd7f0e5f9bf096b29286/pom.xml#L99-L121 is obsolete and can be removed. The parent pom already provides this step.
• Create a .github directory within the repository root with the following files and subdirectories: https://github.com/jenkinsci/archetypes/tree/master/common-files/.github
• Create a .mvn folder within the repository root with the following files: https://github.com/jenkinsci/archetypes/tree/master/common-files/.mvn
• https://github.com/netomi/slsa-jenkins-plugin/blob/c688d2ea29527c405cbcbd7f0e5f9bf096b29286/src/main/resources/io/jenkins/plugins/slsa/ProvenanceAction/index.jelly#L28 appears to be obsolete. Jenkins does already ship a default style of arranged page items, putting in a random space may derail page content compared to other pages.
• https://github.com/netomi/slsa-jenkins-plugin/blob/c688d2ea29527c405cbcbd7f0e5f9bf096b29286/src/main/resources/io/jenkins/plugins/slsa/ProvenanceAction/index.jelly#L33-L39 instead of applying a table style manually, I recommend taking a look at the jenkins-table attribute: https://weekly.ci.jenkins.io/design-library/Table/ That aligns with the overall table design in core.

Additionally, depending on if available:

• https://github.com/netomi/slsa-jenkins-plugin/blob/main/src/main/webapp/icons/slsa-logo.png Jenkins supports SVGs too, if you want to put a more reactive icon in place.

[netomi]

thanks for the quick and thorough feedback, I will work on these items. I understand its still in an early stage and missing tests, but this will come step after step :D

[netomi]

/request-security-scan

[jenkins-cert-app]

The CodeQL Scan discovered 2 finding(s) :mag:. For each of them, either apply the recommended correction, suppress the warning or provide a justification.

Once you're done, either re-run the scan with /request-security-scan or request the Security team to review your justifications with /audit-review.

---

Stapler: Missing POST/RequirePOST annotation

You can find detailed information about this finding here.

ProvenanceRecorder.java#158

``` Potential CSRF vulnerability: If DescriptorImpl#doCheckTargetDirectory connects to user-specified URLs, modifies state, or is expensive to run, it should be annotated with @POST or @RequirePOST ```

ProvenanceRecorder.java#145

``` Potential CSRF vulnerability: If DescriptorImpl#doCheckArtifactFilter connects to user-specified URLs, modifies state, or is expensive to run, it should be annotated with @POST or @RequirePOST ```

[NotMyFault]

thanks for the quick and thorough feedback, I will work on these items

Sounds great!

• https://github.com/netomi/slsa-jenkins-plugin/blob/5b066e6deb96aac3defb80bea86b6e89e18ecc6a/.github/workflows/release-drafter.yml#L8 should point to the actual default branch, in this case, main.

[NotMyFault]

/request-security-scan

[jenkins-cert-app]

:x: CodeQL Scan failed. The Security team was notified about this.

[Wadeck]

[ASSIST]

[ERROR] Failed to execute goal org.jenkins-ci.tools:maven-hpi-plugin:3.41:validate (default-validate) on project slsa: The plugin org.jenkins-ci.tools:maven-hpi-plugin:3.41 requires Maven version 3.8.1 -> [Help 1]

I will dig the problem :)

---

Note for myself: Recent maven tooling require 3.8.1 which is not available by default in Debian Bullseye which is the base image used to run Jenkins security scan.

---

Image updated to install maven directly instead of relying on Debian packages. Worked locally, let's try :)

[Wadeck]

/request-security-scan

[jenkins-cert-app]

:x: CodeQL Scan failed. The Security team was notified about this.

[Wadeck]

/request-security-scan

[netomi]

The security-scan workflow of the repo itself seems to work properly: https://github.com/netomi/slsa-jenkins-plugin/actions/runs/4713231330

[Wadeck]

[ASSIST] @netomi they are different workflows, using the same scanner internally :)

[netomi]

After merging the 2 PR from dependabot:

https://github.com/netomi/slsa-jenkins-plugin/commit/bf782166039778720e70fdff01ef1ffa2ab3822b https://github.com/netomi/slsa-jenkins-plugin/commit/d9c6536da3fe87ea7b644889f9be88902a7a5564

it started to fail.

[Wadeck]

Yeah, there was a new requirement for Maven :) normally I updated the scanner image to include an up-to-date version of Maven. Current run seems running better

[jenkins-cert-app]

The CodeQL Scan did not find anything dangerous with your plugin, congratulations! :tada:

[NotMyFault]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A human volunteer will check over things that I am not able to check for (code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[NotMyFault]

Looks alright to me. The produced .hpi file sizes ~12M. I'd recommend removing unused dependencies from the pom.xml and applying <exclusion>s to strip parts of dependencies this plugin doesn't need, to reduce the size a bit, if applicable.

[netomi]

Thanks for following up on this, I will check the dependencies to further reduce the size.

[netomi]

The reason why the plugin accumulates to 12 MB is the inclusion of the bouncycastle provider jar. Will refactor the plugin to not require that or use the available shared library.

[NotMyFault]

Will refactor the plugin to not require that or use the available shared library.

Thanks! If you rely on bouncycastle, you may depend on the corresponding Jenkins plugin: https://plugins.jenkins.io/bouncycastle-api/dependencies/ and don't need to bundle it yourself.

[netomi]

The dependency org.eclipsefdn.security.slsa:attestation has been updated to remove the bouncy castle dependency for now as the plugin currently can not generate signed attestations. This will be added in a future version.

The size of the plugin is now

.rw-rw-r-- 2,2M tn 24 Apr 22:45 slsa.hpi

[NotMyFault]

Thanks a lot!

Would you mind dropping the unused plugin dependencies from your pom.xml? https://github.com/netomi/slsa-jenkins-plugin/blob/409d2351163f28f73f806140c216084909636e22/pom.xml#L138-L168 No need to install plugins you don't depend on.

[netomi]

I cleaned the dependencies to other plugins.

Some additional changes that I made:

• added an optional dependency on the git plugin: the plugin needs to collect information about the checked out SCM revision / branch to be included in the generated attestation, in a pipeline project that information is not stored in the environment variables, thus I need to collect if from some action, maybe there is a better way to do it, I am open to suggestions. I tried also the GitSCM class, but it does not retain the checked out revision, so I used the BuildData action from the git plugin.
• added a snippet to the README to show how the plugin can be used in a pipeline project

currently, only git is supported as SCM provider, will work on adding support also for others. There does not seem to be a generic way to get the SCM url from an SCM object at least I could not find a way yet. So each SCM provider needs to get custom handling.

[NotMyFault]

/hosting re-check

[github-actions[bot]]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A human volunteer will check over things that I am not able to check for (code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[NotMyFault]

/request-security-scan

[jenkins-cert-app]

The Jenkins Security Scan did not find anything dangerous with your plugin, congratulations! :tada:

---

:bulb: The Security team recommends that you are setting up the scan in your repository by following our guide.

[NotMyFault]

/hosting host

[jenkins-infra-bot]

Hosting request complete, the code has been forked into the jenkinsci project on GitHub as https://github.com/jenkinsci/slsa-plugin

GitHub issues has been selected for issue tracking and was enabled for the forked repo.

A pull request has been created against the repository permissions updater to setup release permissions. Additional users can be added by modifying the created file.

Please delete your original repository (if there are no other forks), under 'Danger Zone', so that the jenkinsci organization repository is the definitive source for the code. If there are other forks, please contact GitHub support to make the jenkinsci repo the root of the fork network (mention that Jenkins approval was given in support request 569994). Also, please make sure you properly follow the documentation on documenting your plugin so that your plugin is correctly documented.

You will also need to do the following in order to push changes and release your plugin:

• Accept the invitation to the Jenkins CI Org on Github
• Add additional users for upload permissions, if needed
• Releasing your plugin

In order for your plugin to be built by the Jenkins CI Infrastructure and check pull requests, please add a Jenkinsfile to the root of your repository with the following content: https://github.com/jenkinsci/archetypes/blob/master/common-files/Jenkinsfile

Welcome aboard!