Improve FilePath API and Javadoc around validation #6033
Merged
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.
One of the causes of https://www.jenkins.io/security/advisory/2021-03-18/#SECURITY-2041 seems to have been the multiple different methods of
FilePath
to validate certain file masks. One group is suitable for form validation around workspace contents, as it performs a permission check and limits the number of operations, while the other is more suitable for running during a build, and does neither. This PR attempts to clarify this difference.Additionally, this adds an overload of
FilePath#validateAntFileMask
that doesn't take an explicit parameter for the file mask bound (which is usually simply the static field with the default value).Proposed changelog entries
FilePath#validateAntFileMask(String, boolean)
overload for convenience.Proposed upgrade guidelines
N/A
Submitter checklist
Proposed changelog entries
section only if there are breaking changes or other changes which may require extra steps from users during the upgradeDesired reviewers
@mention
Maintainer checklist
Before the changes are marked as
ready-for-merge
:Proposed changelog entries
are correctupgrade-guide-needed
label is set and there is aProposed upgrade guidelines
section in the PR title. (example)lts-candidate
to be considered (see query).