CSRF protection in Jenkins - Step-by-Step Execution

Process Flow - CSRF protection

User sends request

↓

Check CSRF token in request?

No→Reject request

Yes↓

Validate token matches server token?

No→Reject request

Yes↓

Process request

↓

Send response

The server checks if the request has a CSRF token and if it matches the expected token before processing the request.

Execution Sample

Jenkins

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

This command sends a POST request to trigger a Jenkins job with a CSRF token in the header.

Process Table

Step	Action	CSRF Token Present?	Token Valid?	Result
1	Receive POST request	Yes	Check token value	Proceed to validation
2	Validate token	Yes	Matches server token	Request accepted
3	Process job build	Yes	Matches server token	Job triggered
4	Send response	Yes	Matches server token	Success response sent
5	Receive POST request without token	No	N/A	Request rejected
6	Receive POST request with wrong token	Yes	Does not match	Request rejected

💡 Requests without a valid CSRF token are rejected to protect Jenkins from CSRF attacks.

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
CSRF Token in Request	None	abc123	abc123	abc123	abc123
Server Expected Token	abc123	abc123	abc123	abc123	abc123
Request Status	Pending	Pending	Validated	Processed	Completed

Key Moments - 3 Insights

Why does Jenkins reject a POST request without a CSRF token?

Because the execution_table row 5 shows that when the token is missing, Jenkins rejects the request to prevent unauthorized actions.

What happens if the CSRF token does not match the server's token?

As shown in execution_table row 6, Jenkins rejects the request to protect against forged requests.

Why is the CSRF token included in the request header?

Including the token in the header allows Jenkins to verify the request is legitimate before processing, as seen in steps 1 and 2 of the execution_table.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the CSRF token first checked?

A Step 5

B Step 3

C Step 1

D Step 6

💡 Hint

Check the 'CSRF Token Present?' column in the execution_table rows.

According to variable_tracker, what is the value of 'Request Status' after step 2?

A Validated

B Pending

C Processed

D Completed

💡 Hint

Look at the 'Request Status' row under 'After Step 2' in variable_tracker.

If the CSRF token in the request was 'wrongtoken', what would happen according to the execution_table?

A Request accepted

B Request rejected

C Request processed anyway

D Request ignored silently

💡 Hint

See row 6 in the execution_table where token does not match.

Concept Snapshot

CSRF protection in Jenkins:
- Jenkins requires a CSRF token (crumb) in POST requests.
- Token is sent in header 'Jenkins-Crumb'.
- Server validates token matches expected value.
- Requests without valid token are rejected.
- This prevents unauthorized commands from external sites.

Full Transcript

CSRF protection in Jenkins works by requiring a special token called a crumb in POST requests. When Jenkins receives a request, it first checks if the CSRF token is present. If missing, Jenkins rejects the request immediately. If present, Jenkins compares the token with the expected server token. If they match, the request is accepted and processed, such as triggering a job build. If the token does not match, Jenkins rejects the request to prevent unauthorized actions. This mechanism protects Jenkins from cross-site request forgery attacks by ensuring only legitimate requests with valid tokens are processed.

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)