Credentials binding in pipelines in Jenkins - Mini Project: Build & Apply

Credentials binding in pipelines

📖 Scenario: You are setting up a Jenkins pipeline to securely use credentials stored in Jenkins. This is common when you need to access private servers or services without exposing passwords in your code.

🎯 Goal: Build a Jenkins pipeline script that binds a username and password credential to environment variables and uses them in a shell command.

📋 What You'll Learn

Create a Jenkins pipeline script with a pipeline block

Use environment block to bind credentials with credentials()

Access the bound credentials as environment variables in a shell step

Print the username and password environment variables in the shell step

💡 Why This Matters

🌍 Real World

In real projects, Jenkins pipelines often need to access private servers, APIs, or databases. Using credentials binding keeps secrets safe and avoids hardcoding passwords.

💼 Career

Understanding credentials binding is essential for DevOps engineers and anyone managing CI/CD pipelines to ensure secure automation.

1

Create the basic Jenkins pipeline structure

Write a Jenkins pipeline script starting with pipeline {} and inside it add an empty agent any block.

Jenkins

pipeline {
    agent any
    // Your code here
}

Hint

Start with the pipeline block and specify agent any to run on any available agent.

2

Add environment block with credentials binding

Inside the pipeline block, add an environment block that binds the Jenkins credential with ID my-credentials to environment variables USERNAME and PASSWORD using credentials('my-credentials').

Jenkins

pipeline {
    agent any
    environment {
        // Your code here
    }
}

Hint

Note: Jenkins declarative pipeline does not support accessing username and password separately using credentials(). Instead, use the usernamePassword credentials binding in a withCredentials block inside steps. The environment block can only bind a single string credential using credentials('id').

For username/password pairs, use withCredentials([usernamePassword(credentialsId: 'my-credentials', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) { ... } inside steps.

3

Add a stage with a shell step to print the credentials

Inside the pipeline block, add a stages block with one stage named 'Print Credentials'. Inside the stage, add a steps block with a sh command that prints $USERNAME and $PASSWORD environment variables.

Jenkins

pipeline {
    agent any
    environment {
        USERNAME = ''
        PASSWORD = ''
    }
    stages {
        // Your code here
    }
}

Hint

Use withCredentials inside steps to bind username and password credentials to environment variables.

4

Print the final pipeline script output

Run the pipeline and observe the output. The shell steps should print the username and password stored in the Jenkins credential my-credentials. Write a sh command that prints Username: $USERNAME and Password: $PASSWORD.

Jenkins

pipeline {
    agent any
    stages {
        stage('Print Credentials') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

When you run the pipeline, Jenkins replaces $USERNAME and $PASSWORD with the actual credential values.

Practice

1. What is the main purpose of using credentials() or withCredentials in Jenkins pipelines?

easy

A. To securely inject secrets like passwords or tokens as environment variables

B. To speed up the pipeline execution by caching credentials

C. To automatically create new user accounts in Jenkins

D. To generate random passwords for pipeline steps

Solution

1. Step 1: Understand the role of credentials binding

   Credentials binding is used to safely provide secrets to pipeline steps without exposing them in code.

2. Step 2: Identify the function of credentials() and withCredentials

   These functions inject secrets as environment variables, keeping them hidden from logs.

3. Final Answer:

   To securely inject secrets like passwords or tokens as environment variables -> Option A

4. Quick Check:

   Credentials binding = secure secret injection [OK]

Hint: Remember: credentials() hides secrets as env variables [OK]

Common Mistakes:

• Thinking credentials speed up pipelines
• Confusing credentials binding with user creation
• Assuming credentials generate passwords automatically

2. Which of the following is the correct syntax to bind a username and password credential in a Jenkins declarative pipeline?

easy

A. withSecret([userPass('myCred', 'USER', 'PASS')]) { ... }

B. credentials('myCred', 'USER', 'PASS') { ... }

C. bindCredentials('myCred', 'USER', 'PASS') { ... }

D. withCredentials([usernamePassword(credentialsId: 'myCred', usernameVariable: 'USER', passwordVariable: 'PASS')]) { ... }

Solution

1. Step 1: Recall the correct Jenkins credentials binding syntax

   The correct syntax uses withCredentials with a list containing usernamePassword specifying credential ID and variable names.

2. Step 2: Match the syntax with options

   withCredentials([usernamePassword(credentialsId: 'myCred', usernameVariable: 'USER', passwordVariable: 'PASS')]) { ... } matches the exact syntax Jenkins expects for username/password binding.

3. Final Answer:

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

4. Quick Check:

   Correct syntax = withCredentials + usernamePassword [OK]

Hint: Look for withCredentials and usernamePassword keywords [OK]

Common Mistakes:

• Using non-existent functions like bindCredentials
• Mixing up credentials() with withCredentials syntax
• Incorrect parameter names or missing brackets

3. Given this Jenkins pipeline snippet:

withCredentials([string(credentialsId: 'token123', variable: 'API_TOKEN')]) {
  sh 'echo $API_TOKEN'
}

What will be the output in the Jenkins console log?

medium

A. The secret will be masked and replaced with '****' in the log

B. The string '$API_TOKEN' will be printed literally

C. The actual secret value stored in 'token123' will be printed

D. An error will occur because environment variables can't be used in sh

Solution

1. Step 1: Understand how withCredentials injects secrets

   It sets the secret as an environment variable for the shell command.

2. Step 2: Recognize Jenkins log masking behavior

   Jenkins automatically masks secrets in console output, replacing them with '****'.

3. Final Answer:

   The secret will be masked and replaced with '****' in the log -> Option A

4. Quick Check:

   Jenkins masks secrets in logs = masked output [OK]

Hint: Secrets never show in logs; Jenkins masks them [OK]

Common Mistakes:

• Expecting the secret to print plainly
• Thinking environment variables won't work in sh
• Confusing literal string output with variable expansion

4. You wrote this Jenkins pipeline snippet:

withCredentials([string(credentialsId: 'mySecret', variable: 'SECRET')]) {
  echo "$SECRET"
}

But the secret value is printed in the console log unmasked. What is the likely cause?

medium

A. The credentialsId 'mySecret' does not exist in Jenkins

B. Using echo instead of sh prevents masking

C. The variable name 'SECRET' is reserved and cannot be masked

D. The pipeline is missing the environment block

Solution

1. Step 1: Understand Jenkins masking scope

   Jenkins masks secrets only in shell or batch commands, not in pipeline echo steps.

2. Step 2: Identify why echo prints unmasked

   The echo step prints directly to console without masking, exposing the secret.

3. Final Answer:

   Using echo instead of sh prevents masking -> Option B

4. Quick Check:

   Masking works in sh, not pipeline echo [OK]

Hint: Use sh to mask secrets, not pipeline echo [OK]

Common Mistakes:

• Assuming all prints mask secrets
• Thinking missing credentials cause unmasked output
• Believing environment block controls masking

5. You want to securely use multiple credentials (a username/password and a secret text) in a Jenkins scripted pipeline. Which snippet correctly binds both credentials and uses them in shell commands?

hard

A. withCredentials([usernamePassword('userPassId', 'USER', 'PASS'), string('tokenId', 'TOKEN')]) {
sh 'echo $USER $PASS $TOKEN'
}

B. credentials(['userPassId', 'tokenId']) {
sh 'echo $USER'
sh 'echo $PASS'
sh 'echo $TOKEN'
}

C. withCredentials([usernamePassword(credentialsId: 'userPassId', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'tokenId', variable: 'TOKEN')]) {
sh 'echo $USER $PASS $TOKEN'
}

D. withCredentials([usernamePassword(credentialsId: 'userPassId', usernameVariable: 'USER', passwordVariable: 'PASS'), string('tokenId', 'TOKEN')]) {
sh 'echo $USER'
sh 'echo $PASS'
sh 'echo $TOKEN'
}

Solution

1. Step 1: Understand binding multiple credentials

   Use withCredentials with a list of credential bindings specifying IDs and variable names.

2. Step 2: Check correct syntax and usage in shell

   withCredentials([usernamePassword(credentialsId: 'userPassId', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'tokenId', variable: 'TOKEN')]) { sh 'echo $USER $PASS $TOKEN' } correctly binds both credentials and uses a single shell command to echo all variables.

3. Final Answer:

   withCredentials([usernamePassword(credentialsId: 'userPassId', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'tokenId', variable: 'TOKEN')]) { sh 'echo $USER $PASS $TOKEN' } -> Option C

4. Quick Check:

   Multiple credentials + correct syntax = withCredentials([usernamePassword(credentialsId: 'userPassId', usernameVariable: 'USER', passwordVariable: 'PASS'), string(credentialsId: 'tokenId', variable: 'TOKEN')]) { sh 'echo $USER $PASS $TOKEN' } [OK]

Hint: Use withCredentials with list and proper variable names [OK]

Common Mistakes:

• Using invalid credentials() function for multiple secrets
• Incorrect parameter order or missing keys
• Splitting shell commands unnecessarily