WithCredentials block usage in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the withCredentials block in Jenkins pipelines?

The withCredentials block securely provides credentials to a Jenkins pipeline step, allowing the pipeline to use secrets like passwords or tokens without exposing them in logs or code.

beginner

How do you use a username and password credential inside a withCredentials block?

You specify the credential ID and bind it to environment variables like USERNAME and PASSWORD. For example:

withCredentials([usernamePassword(credentialsId: 'my-creds', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) {
  // use env.USERNAME and env.PASSWORD here
}

beginner

What happens if you try to access credentials outside the withCredentials block?

Credentials are only available inside the withCredentials block. Outside this block, the environment variables for credentials are not set, so you cannot access the secrets.

beginner

Name two types of credentials you can use with withCredentials in Jenkins.

You can use types like usernamePassword for username and password pairs, and string for secret text tokens or API keys.

beginner

Why is it important to use withCredentials instead of hardcoding secrets in Jenkins pipelines?

Using withCredentials keeps secrets safe by not exposing them in pipeline code or logs. It helps prevent accidental leaks and follows best security practices.

What does the withCredentials block do in a Jenkins pipeline?

A Runs the pipeline on a secure node

B Encrypts the entire pipeline script

C Provides secure access to stored credentials within the block

D Saves pipeline logs to a secure location

The withCredentials block securely injects credentials as environment variables only inside its scope.

Which environment variables are set when using usernamePassword in withCredentials?

A USER and PASS

B LOGIN and SECRET

C CRED_USER and CRED_PASS

D USERNAME and PASSWORD

You define the variable names, commonly USERNAME and PASSWORD, when using usernamePassword.

Can you access credentials outside the withCredentials block?

A No, credentials are only available inside the block

B Yes, credentials are global

C Only if you export them

D Only in the next pipeline stage

Credentials are scoped to the withCredentials block to keep them secure.

Which of these is NOT a valid credential type for withCredentials?

A databaseConnection

B string

C usernamePassword

D file

databaseConnection is not a supported credential type in Jenkins withCredentials.

Why should you avoid hardcoding secrets in Jenkins pipelines?

A It makes the pipeline run slower

B It risks exposing secrets in logs and code

C It causes Jenkins to crash

D It prevents pipeline parallelism

Hardcoding secrets can expose them accidentally, risking security breaches.

Explain how to use the withCredentials block to securely access a username and password in a Jenkins pipeline.

Think about how environment variables are set only inside the block.

Describe why using withCredentials is important for security in Jenkins pipelines.

Consider what could happen if secrets were visible in pipeline scripts.

Practice

1. What is the main purpose of the withCredentials block in a Jenkins pipeline?

easy

A. To display credentials in the console output for debugging

B. To permanently store credentials in the pipeline script

C. To securely inject credentials only inside the block without exposing them elsewhere

D. To create new credentials in Jenkins

Solution

1. Step 1: Understand the purpose of withCredentials

   The block is designed to provide credentials securely only within its scope.

2. Step 2: Analyze other options

   Options A, B, and D describe incorrect or unsafe behaviors not related to withCredentials.

3. Final Answer:

   To securely inject credentials only inside the block without exposing them elsewhere -> Option C

4. Quick Check:

   Secure injection inside block = C [OK]

Hint: Remember: credentials only live inside the block [OK]

Common Mistakes:

• Thinking credentials persist outside the block
• Assuming credentials are printed in logs
• Confusing with credential creation

2. Which of the following is the correct syntax to use a username and password credential with withCredentials in a Jenkins pipeline?

easy

A. withCredentials([usernamePassword(credentialsId: 'cred-id', usernameVariable: 'USER', passwordVariable: 'PASS')]) { ... }

B. withCredentials(usernamePassword('cred-id', 'USER', 'PASS')) { ... }

C. withCredentials { usernamePassword('cred-id', 'USER', 'PASS') ... }

D. withCredentials([usernamePassword('cred-id', 'USER', 'PASS')]) { ... }

Solution

1. Step 1: Recall correct withCredentials syntax

   The correct syntax uses a list with usernamePassword specifying named parameters.

2. Step 2: Check each option

   Only withCredentials([usernamePassword(credentialsId: 'cred-id', usernameVariable: 'USER', passwordVariable: 'PASS')]) { ... } uses named parameters and list syntax correctly; others miss brackets or parameter names.

3. Final Answer:

   withCredentials([usernamePassword(credentialsId: 'cred-id', usernameVariable: 'USER', passwordVariable: 'PASS')]) { ... } -> Option A

4. Quick Check:

   Named params + list = A [OK]

Hint: Use named parameters inside a list for credentials [OK]

Common Mistakes:

• Omitting square brackets around credentials
• Not using named parameters
• Wrong block structure

3. Given this Jenkins pipeline snippet:

withCredentials([string(credentialsId: 'token-id', variable: 'TOKEN')]) {
  sh 'echo $TOKEN'
}

What will happen when this pipeline runs?

medium

A. The token will be printed as plain text in the Jenkins UI

B. The secret token value will be printed in the console output

C. The pipeline will fail because $TOKEN is not accessible

D. The shell command will print the token value but it will be masked in logs

Solution

1. Step 1: Understand withCredentials behavior

   The secret is injected as an environment variable inside the block and Jenkins masks it in logs.

2. Step 2: Analyze the shell command output

   The echo $TOKEN prints the token, but Jenkins hides it in console output to protect secrets.

3. Final Answer:

   The shell command will print the token value but it will be masked in logs -> Option D

4. Quick Check:

   Secrets masked in logs = A [OK]

Hint: Secrets print masked, not visible in logs [OK]

Common Mistakes:

• Assuming secrets print as plain text
• Thinking environment variables are unavailable
• Confusing console output with UI display

4. Identify the error in this Jenkins pipeline snippet:

withCredentials([usernamePassword(credentialsId: 'cred-id', usernameVariable: 'USER')]) {
  sh 'echo $USER $PASS'
}

medium

A. Missing passwordVariable parameter causes $PASS to be undefined

B. Credentials ID is incorrect format

C. The sh step cannot access environment variables

D. The withCredentials block must not use a list

Solution

1. Step 1: Check withCredentials parameters

   The snippet provides only usernameVariable but misses passwordVariable.

2. Step 2: Understand impact on shell command

   Since passwordVariable is missing, $PASS is undefined and will cause an empty or error output.

3. Final Answer:

   Missing passwordVariable parameter causes $PASS to be undefined -> Option A

4. Quick Check:

   Both username and password variables needed = D [OK]

Hint: Always specify both usernameVariable and passwordVariable [OK]

Common Mistakes:

• Forgetting passwordVariable
• Assuming shell can't access env vars
• Wrong credentialsId format

5. You want to use multiple credentials (a username/password and a secret text) inside a Jenkins pipeline securely. Which is the correct way to use withCredentials to access both?

hard

A. withCredentials(usernamePassword(credentialsId: 'cred1', usernameVariable: 'USER', passwordVariable: 'PASS')) {
withCredentials(string(credentialsId: 'cred2', variable: 'TOKEN')) { ... }
}

B. withCredentials([usernamePassword(credentialsId: 'cred1', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'cred2', variable: 'TOKEN')]) { ... }

C. withCredentials([usernamePassword('cred1', 'USER', 'PASS'), string('cred2', 'TOKEN')]) { ... }

D. withCredentials([usernamePassword(credentialsId: 'cred1', usernameVariable: 'USER', passwordVariable: 'PASS')]) { withCredentials([string(credentialsId: 'cred2', variable: 'TOKEN')]) { ... } }

Solution

1. Step 1: Understand multiple credentials usage

   You can pass multiple credentials as a list inside a single withCredentials block.

2. Step 2: Compare options

   withCredentials([usernamePassword(credentialsId: 'cred1', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'cred2', variable: 'TOKEN')]) { ... } correctly uses a list with both credential types together. Options A and D nest blocks unnecessarily. withCredentials([usernamePassword('cred1', 'USER', 'PASS'), string('cred2', 'TOKEN')]) { ... } uses wrong syntax.

3. Final Answer:

   withCredentials([usernamePassword(credentialsId: 'cred1', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'cred2', variable: 'TOKEN')]) { ... } -> Option B

4. Quick Check:

   Multiple creds in one list = B [OK]

Hint: Use one list with all credentials inside withCredentials [OK]

Common Mistakes:

• Nesting multiple withCredentials blocks unnecessarily
• Using incorrect parameter syntax
• Passing credentials without a list