Stop executing fork-controlled Maven in the privileged fork Sonar workflow (#232) - #285
Merged
AndreasIgel merged 16 commits intoSep 12, 2026
Merged
Conversation
The class-level Javadoc and docs/CONFIGURATION.md implied that @SimpleBuilder is inherited by subclasses, but the annotation was not meta-annotated with @inherited. As a result BuilderProcessor, which collects types via RoundEnvironment.getElementsAnnotatedWith(...), only produced builders for the exact type carrying @SimpleBuilder and not for unannotated subclasses. Add @inherited to @SimpleBuilder so subclasses are treated as if they also carried the annotation, mirroring the existing behaviour of @SimpleBuilder.Template (which is already @inherited). Update the Javadoc to document the inheritance explicitly and clarify the CONFIGURATION.md wording. @Ignore4BuilderGeneration still suppresses generation for the exact type it is placed on, so opt-outs continue to work as before. Add SimpleBuilderInheritanceTest covering direct inheritance, the opt-out interaction, and multi-level (grandchild) inheritance. Closes java-helpers#244 Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…ance Rename SimpleBuilderInheritanceTest to BuilderAnnotationInheritanceTest so the name reflects that it covers both builder-triggering annotations. Add unannotatedSubclassGetsBuilderFromInheritedTemplate, which verifies that a custom @inherited template annotation (meta-annotated with @SimpleBuilder.Template) propagates to unannotated subclasses, matching the existing behaviour of @SimpleBuilder itself. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
The Template Javadoc and CONFIGURATION.md "Template Annotations" section did not explain that @SimpleBuilder.Template is @inherited, nor that a custom template annotation must additionally declare @inherited to propagate to unannotated subclasses. Add explicit documentation and an example showing the @inherited custom annotation pattern. Also move assertNoBuilderGenerated to ProcessorAsserts so it is shared by BuilderAnnotationInheritanceTest and Ignore4BuilderGenerationTest instead of being duplicated as a private helper in each test class. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
While @SimpleBuilder and @inherited template annotations now correctly trigger builder generation for unannotated subclasses, the configuration options declared on the parent's @SimpleBuilder(options = ...) or template are not yet applied to inherited subclass builders — they use default options instead. This is tracked separately in issue java-helpers#245. Add caveats to the SimpleBuilder Javadoc, the CONFIGURATION.md Template Annotations section, and the Template Annotations Not Working troubleshooting section so users are not surprised by this limitation. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Add explicit guidance that @SimpleBuilder.Template is a meta-annotation for custom annotation declarations (@interface) only and cannot be placed directly on a class or record. @SimpleBuilder is for direct one-off annotation of classes/records. - SimpleBuilder.java: add 'When to use' section to class-level Javadoc - SimpleBuilder.Template Javadoc: state it can only be placed on annotation types (ANNOTATION_TYPE), not on classes/records - CONFIGURATION.md 'Template Annotations': add comparison table and introductory paragraph - CONFIGURATION.md troubleshooting: add item about @SimpleBuilder.Template not being a class annotation Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…Javadoc Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…arget The compiler and IDE already enforce @target(ANNOTATION_TYPE) and show a clear error when @SimpleBuilder.Template is placed on a class/record, so this troubleshooting item adds no value. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…kflow (java-helpers#232) Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
Contributor
Dependency ReviewThe following issues were found:
Snapshot WarningsEnsure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice. License Issues.github/workflows/fork-sonar.yml
OpenSSF Scorecard
Scanned Files
|
This was referenced Sep 12, 2026
AndreasIgel
added a commit
that referenced
this pull request
Sep 12, 2026
Stop executing fork-controlled Maven in the privileged fork Sonar workflow (#232) (#285) The fork Sonar job ran `mvn sonar:sonar` on the checked-out fork tree with SONAR_TOKEN set — arbitrary code execution via fork-controlled pom.xml/.mvn/wrapper in a privileged context. Now nothing fork-controlled is executed: Maven only runs on the trusted base checkout (dependency classpath), the fork head is fetched as git objects and verified against the CI-built SHA, and analysis uses the standalone sonarqube-scan-action with workflow-written config passed via project.settings — so fork pom/properties files are inert. The fork-ci environment gate remains as defense-in-depth.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the SonarCloud S7631 finding on
.github/workflows/fork-sonar.yml(new-code Security rating C) by removing every execution of fork-controlled content from the privilegedworkflow_runjob, while keeping thefork-cirequired-reviewer gate and the artifact-based design unchanged.Analysis (issue #232, step 1)
The finding is real, not a false positive: the old workflow checked out
refs/pull/N/headand ranmvn ... sonar-maven-plugin:sonar --file pom.xmlwithSONAR_TOKENin the environment. Even with-DskipTests, Maven on a fork tree executes code the fork controls:.mvn/extensions.xml/<build><extensions>— arbitrary jars loaded into the Maven process.mvn/maven.config/.mvn/jvm.config— arbitrary flags, e.g.-javaagent:pom.xmlplugin bindings — any plugin/execution bound to phases run by the Sonar goal (it forks a build), or<pluginRepositories>pointing at attacker-hosted pluginsmvnwwrapper scripts (not used today, but trivially added by a PR)The required-reviewer gate reduces likelihood but not impact: a maintainer approving a plausible-looking PR cannot review
.mvn/config or plugin coordinates for exfiltration intent. The rule flags the pattern for exactly that reason.Options considered (step 2)
.gitit warnsSCM provider autodetection failedand reports 0 new lines, so PR decoration and the new-code gate become meaningless. Also duplicates data already present inrefs/pull/N/head. Rejected.Key insight: the problem was never checking out the fork tree (that only writes files), it was running a build tool on it. The fix therefore separates the two.
Implementation (step 3)
fork-sonar.ymlnow:Why each piece matters:
pom.xml: it runs before the fork tree exists in the workspace. The classpath it produces is what gives the Java analyzer full type resolution; a dependency added by the fork PR is simply unresolved (analysis degrades, nothing is downloaded on the fork's behalf).pr_head_shais now validated (^[0-9a-f]{40}$) and asserted againstrefs/pull/N/head, so the analysed sources match the artifact's bytecode even if the PR was force-pushed between the CI run and the approval.project.settingsoutside the workspace — with it set, the scanner ignores anysonar-project.propertiesin the fork tree. This matters because that file can setsonar.scanner.javaExePath(i.e. "run this binary"), which would otherwise be a new fork-controlled execution vector.maven.ymladditionally shipscore/processor target/test-classesso the standalone scanner getssonar.java.test.binaries(previously provided implicitly by the Maven plugin).Sonar properties duplicated from the root
pom.xmlare called out in a comment and indocs/CONTRIBUTING.md; the docs section now records the security model and this decision.Validation
actionlintclean on both workflows.main(30 jars, nosimple-builders-*self-references).main(workflow_run uses the base-branch workflow file) plus a maintainer approval in thefork-cienvironment. Please check the SonarCloud PR decoration shows changed lines and coverage on the first such run.Closes #232.