For the complete documentation index, see llms.txt. This page is also available as Markdown.

Device Protection in Jenkins

Jenkins builds run on Linux agents, so Device Protection installs the same way it does on any Linux machine. What is specific to Jenkins is where the install goes: once on a permanent agent, or inside each build on a Docker agent.

Read Install Device Protection for Linux first for the token and the install flavors. The job-level snippets below use the container flavor, which Device Protection in Containers explains.

Permanent agents

Install the agent on each Linux agent host with --headless, then reboot. See Install Device Protection for Linux. No pipeline changes needed.

Docker agents

Add your Device Protection token as a Secret text credential with the ID aikido-token, then start the agent before any stage that installs packages:

Jenkinsfile
pipeline {
  agent {
    docker {
      image 'node:20-bookworm'
      args '-u root'
    }
  }
  environment {
    AIKIDO_TOKEN = credentials('aikido-token')
  }
  stages {
    stage('Start Device Protection') {
      steps {
        sh '''
          curl -fsSL https://github.com/AikidoSec/safe-chain/raw/refs/heads/main/install-scripts/install-endpoint-linux.sh | sh -s -- --container
          aikido-endpoint-protection-start --wait-for-healthy
        '''
      }
    }
    stage('Install dependencies') {
      steps {
        sh '''
          for f in /etc/profile.d/aikido-*.sh; do . "$f"; done
          npm ci
        '''
      }
    }
  }
}
  • args '-u root' is required. Jenkins runs the container as the agent's user, and the install needs root.

  • Source /etc/profile.d/aikido-*.sh in every sh step that installs packages. Each sh step is a new shell, and without those settings downloads skip the agent.

  • Use ''', not """. Groovy expands $ inside double quotes and breaks the loop.

Verify it works

403 means the agent blocked the malware test package. 200 means the download skipped the agent.

Troubleshooting

Problem
Fix

Root privileges required

Add args '-u root' to the docker agent

Token is required

Check the credential ID, and that the credential is Secret text

Test package returns 200, or SELF_SIGNED_CERT_IN_CHAIN

The sh step did not source /etc/profile.d/aikido-*.sh

Last updated

Was this helpful?