-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft for review: Security notes for Pipeline authors #4667
Open
StackScribe
wants to merge
6
commits into
jenkins-infra:master
Choose a base branch
from
StackScribe:1026-pipeline-author
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+37
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,6 @@ sections: | |
|
||
# Further references | ||
- services | ||
|
||
# New files | ||
- pipeline-authors |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Security Practices for Pipeline Authors | ||
layout: section | ||
--- | ||
ifdef::backend-html5[] | ||
:toc: | ||
ifdef::env-github[:imagesdir: ../resources] | ||
ifndef::env-github[:imagesdir: ../../resources] | ||
:hide-uri-scheme: | ||
endif::[] | ||
|
||
The job of securing the Jenkins instance falls mostly on administrators, but Pipeline authors must also adhere to good security practices. | ||
We summarize these here. | ||
|
||
== Use Credentials to Access Resources | ||
|
||
If your Pipeline needs to access external resources such as a database, artifact repository, or cloud, be sure to use credentials for authorization rather than hard coding the username/password, secret text, or other identifiers in your Pipeline. | ||
See link:/doc/book/using/using-credentials/[Using Credentials] for more information. | ||
|
||
== Handle String Interpolation Properly | ||
|
||
Understand Groovy | ||
link:/doc/book/pipeline/jenkinsfile/#string-interpolation[string interpolation] | ||
and be very careful when passing sensitive data such as environment variables. | ||
Never enclose sensitive environment variables in double quotes! | ||
Data inside double quotes is subject to Groovy string interpolation, which means that Groovy evaluates the string and passes the actual value through where it may be visible as an argument to the `sh` or `bat` step or some other facility. | ||
Data that is enclosed in single quotes is passed to the interpreter (`sh`, `bat`, `powershell`, or `pwsh` for evaluation and so is secure. | ||
|
||
See | ||
link:/doc/book/pipeline/jenkinsfile/#interpolation-of-sensitive-environment-variables[Interpolation of sensitive environment variables] | ||
and | ||
link:/doc/book/pipeline/jenkinsfile/#injection-via-interpolation[Injection via interpolation] | ||
for more details. | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if you want to mention if that extends to the multi-line strings?
'''
and"""
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but could you give me a little more information? Maybe a code snippet as an example? I find one mention of multiline strings in "Storing Secrets" in /doc/developer but no discussion of them and I'm not familiar with them.