Skip to content

[JENKINS-76263] Add documentation for CSP in core, adapt existing docs#8529

Merged
MarkEWaite merged 13 commits intojenkins-infra:masterfrom
daniel-beck:JENKINS-76263
Nov 25, 2025
Merged

[JENKINS-76263] Add documentation for CSP in core, adapt existing docs#8529
MarkEWaite merged 13 commits intojenkins-infra:masterfrom
daniel-beck:JENKINS-76263

Conversation

@daniel-beck
Copy link
Contributor

@daniel-beck daniel-beck commented Nov 5, 2025

Corresponds to jenkinsci/jenkins#11269.

Do not merge before that PR is merged (and the 2.TODO version number placeholders in this PR are updated).

Merge checklist:

  • Replace 2.TODO version numbers with weekly version once upstream PR is merged

@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Nov 5, 2025
- Adapt to renamed system property
- Document CSP UI as new section in /doc/book/security/
- Add redirect for Resource Root URL, use it
- Add note in DBS CSP that there's also UI CSP
- Rephrase a few 'configure this' reminders
- Mention resources from elsewhere in CSP developer docs
- Update developer docs to mention new core behavior
@daniel-beck daniel-beck changed the title [JENKINS-76263] Document the new option [JENKINS-76263] Add documentation for CSP in core, adapt existing docs Nov 10, 2025
Copy link
Contributor

@Kevin-CB Kevin-CB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've read all the documentation changes, it looks fine.

FTR: I've not rendered the changed


NOTE: In certain environments, this configuration will not be available.
This includes controllers whose CSP enforcement is controlled by the Java system property link:/doc/book/managing/system-properties/#jenkins-security-csp-cspheader-headername[`jenkins.security.csp.CspHeader.headerName`], as well as during Jenkins core and plugin development.
See below for more information how CSP enforcement is controlled in those environments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See below for more information how CSP enforcement is controlled in those environments.
See below for more information on how CSP enforcement is controlled in those environments.

=== In Jenkins 2.TODO and newer

Jenkins 2.TODO and newer supports Content Security Policy out of the box.
See the link:/doc/book/security/csp/[documentation] for information how to set it up.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See the link:/doc/book/security/csp/[documentation] for information how to set it up.
See the link:/doc/book/security/csp/[documentation] for information on how to set it up.

- link to new spreadsheet
- add section of plugins kinda inherently affected
- add dashboard-view, gitlab-plugin to incompatible list
@daniel-beck
Copy link
Contributor Author

IMO this PR is ready now. I inserted the prospective upcoming core version number as well.

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MarkEWaite MarkEWaite merged commit 73e0cc8 into jenkins-infra:master Nov 25, 2025
6 checks passed
@daniel-beck daniel-beck deleted the JENKINS-76263 branch November 25, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Jenkins documentation, including user and developer docs, solution pages, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants