CSRF protection in Jenkins - Commands & Configuration

Introduction

CSRF protection stops bad websites from tricking Jenkins into doing things without permission. It keeps your Jenkins safe by making sure requests come from trusted users only.

When you want to prevent attackers from making unauthorized changes to Jenkins jobs or settings.

When you expose Jenkins to the internet and want to protect it from cross-site attacks.

When you use Jenkins APIs or scripts that require secure access.

When multiple users share the same Jenkins server and you want to ensure actions are intentional.

When you want to comply with security best practices for web applications.

Commands

Starts Jenkins server with default settings including CSRF protection enabled by default.

Terminal

java -jar jenkins.war

Expected Output

Running from: /home/user/jenkins.war

INFO: Jenkins is fully up and running

Requests a CSRF crumb token from Jenkins to use in POST requests for protection.

Terminal

curl -X GET http://localhost:8080/crumbIssuer/api/xml -u admin:admin123

Expected Output

<defaultCrumbIssuer><crumb>abc123def456</crumb><crumbRequestField>.crumb</crumbRequestField></defaultCrumbIssuer>

→

-X GET - Use GET method to request the crumb token

→

-u admin:admin123 - Authenticate with Jenkins using username and password

Triggers a Jenkins job build using the CSRF crumb token in the header to pass protection.

Terminal

curl -X POST http://localhost:8080/job/example-job/build -u admin:admin123 -H ".crumb: abc123def456"

Expected Output

Started build #1

→

-H ".crumb: abc123def456" - Include CSRF crumb token in request header

Uses Jenkins CLI to check current user identity, confirming authentication and CSRF protection in place.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080/ -auth admin:admin123 who-am-i

Expected Output

Authenticated as: admin

→

-auth admin:admin123 - Authenticate CLI commands

Key Concept

If you remember nothing else from this pattern, remember: Jenkins uses a crumb token to verify requests and prevent CSRF attacks.

Common Mistakes

Trying to send POST requests to Jenkins API without including the CSRF crumb token.

Jenkins rejects these requests to protect against CSRF, causing failures.

Always request a crumb token first and include it in your POST request headers.

Disabling CSRF protection in Jenkins configuration to avoid errors.

This exposes Jenkins to security risks and attacks.

Keep CSRF protection enabled and use crumb tokens properly.

Using incorrect crumb header name or value in API requests.

Jenkins will not recognize the token and reject the request.

Use the exact crumbRequestField name Jenkins provides and the correct crumb value.

Summary

Start Jenkins which has CSRF protection enabled by default.

Request a crumb token before making POST API calls to Jenkins.

Include the crumb token in the header of your POST requests to pass CSRF checks.

Use Jenkins CLI with authentication to interact securely with Jenkins.

Practice

1. What is the main purpose of CSRF protection in Jenkins?

easy

A. To backup Jenkins configuration automatically

B. To speed up Jenkins build times

C. To encrypt Jenkins user passwords

D. To prevent unauthorized web requests from other sites

Solution

1. Step 1: Understand CSRF meaning

   CSRF stands for Cross Site Request Forgery, which means unauthorized commands sent from a user that the web app trusts.

2. Step 2: Identify Jenkins CSRF protection role

   Jenkins uses CSRF protection to stop these unauthorized web requests from other sites.

3. Final Answer:

   To prevent unauthorized web requests from other sites -> Option D

4. Quick Check:

   CSRF protection = prevent unauthorized requests [OK]

Hint: CSRF stops fake requests from other websites [OK]

Common Mistakes:

• Confusing CSRF with password encryption
• Thinking CSRF speeds up builds
• Assuming CSRF backs up Jenkins data

2. Which Jenkins setting enables CSRF protection?

easy

A. Enable 'Prevent Cross Site Request Forgery exploits'

B. Disable 'Prevent Cross Site Request Forgery exploits'

C. Enable 'Allow anonymous read access'

D. Disable 'Enable security'

Solution

1. Step 1: Locate CSRF protection setting

   In Jenkins global security settings, there is an option named 'Prevent Cross Site Request Forgery exploits'.

2. Step 2: Choose correct action to enable protection

   To enable CSRF protection, you must turn ON (enable) this setting.

3. Final Answer:

   Enable 'Prevent Cross Site Request Forgery exploits' -> Option A

4. Quick Check:

   Enable CSRF protection = turn on prevent exploits [OK]

Hint: Turn ON 'Prevent Cross Site Request Forgery exploits' [OK]

Common Mistakes:

• Disabling the CSRF protection setting
• Confusing with anonymous access settings
• Disabling overall security disables CSRF too

3. Given this Jenkins API call snippet:

curl -X POST http://jenkins.example.com/job/test/build \
  --header "Jenkins-Crumb: abc123" \
  --user user:token

What is the purpose of the Jenkins-Crumb header?

medium

A. It passes the CSRF protection token

B. It specifies the build job name

C. It authenticates the user credentials

D. It sets the API version

Solution

1. Step 1: Understand Jenkins-Crumb header role

   The Jenkins-Crumb header carries a token called a crumb, which Jenkins uses to verify requests are safe from CSRF attacks.

2. Step 2: Identify purpose in API call

   In API calls, this crumb token must be included to pass CSRF protection checks.

3. Final Answer:

   It passes the CSRF protection token -> Option A

4. Quick Check:

   Jenkins-Crumb = CSRF token header [OK]

Hint: Jenkins-Crumb header sends CSRF token in API calls [OK]

Common Mistakes:

• Thinking Jenkins-Crumb is user authentication
• Confusing it with job name or API version
• Omitting crumb causes CSRF errors

4. You get a 403 Forbidden error when triggering a Jenkins job via API. You suspect CSRF protection is causing it. What is the most likely fix?

medium

A. Disable CSRF protection in Jenkins settings

B. Add the Jenkins-Crumb token header to your API request

C. Use HTTP GET instead of POST for the API call

D. Increase Jenkins build timeout

Solution

1. Step 1: Identify cause of 403 error

   403 Forbidden often means Jenkins rejected the request due to missing or invalid CSRF token.

2. Step 2: Apply correct fix for CSRF error

   Adding the Jenkins-Crumb token header to the API request satisfies CSRF protection and avoids 403 errors.

3. Final Answer:

   Add the Jenkins-Crumb token header to your API request -> Option B

4. Quick Check:

   403 + CSRF = add crumb header [OK]

Hint: Add crumb header to fix 403 CSRF errors [OK]

Common Mistakes:

• Disabling CSRF protection (unsafe)
• Using GET instead of POST incorrectly
• Changing unrelated settings like timeout

5. You want to automate Jenkins job triggers from a script safely with CSRF protection enabled. Which approach is best?

hard

A. Disable CSRF protection temporarily during automation

B. Send requests without authentication but with crumb header

C. Use Jenkins API token and include the Jenkins-Crumb header in requests

D. Use HTTP GET requests to avoid CSRF checks

Solution

1. Step 1: Understand safe automation with CSRF

   Disabling CSRF protection is unsafe. Automation must authenticate and pass CSRF tokens.

2. Step 2: Combine authentication and CSRF token

   Using Jenkins API token for authentication plus including the Jenkins-Crumb header ensures safe, authorized requests.

3. Final Answer:

   Use Jenkins API token and include the Jenkins-Crumb header in requests -> Option C

4. Quick Check:

   Safe automation = auth + crumb header [OK]

Hint: Authenticate and send crumb header for safe automation [OK]

Common Mistakes:

• Disabling CSRF protection (security risk)
• Sending crumb without authentication
• Using GET to bypass CSRF (not reliable)