Skip to main content
This guide demonstrates how to integrate the Binarly Transparency Platform into your CI/CD pipeline.

Prerequisites

Before integrating, ensure you have:
  • API Client credentials (BINARLY_CLIENT_ID and BINARLY_CLIENT_SECRET). See Setup API Client
    • SaaS customers: Contact support@binarly.io to request credentials
    • On-Prem customers: Create credentials via Keycloak Admin Console
    • API clients have full administrative access to your organization. Store the secret in your CI/CD platform’s secret store. See Access control for M2M tokens
  • Product ID (BINARLY_PRODUCT_ID) for your firmware project
  • Binary file to scan

Workflow Overview

All CI/CD integrations follow the same four-step workflow:
  1. Authenticate: Obtain an access token using Client Credentials
  2. Upload: Submit the binary image for analysis
  3. Poll: Check the scan status until completion
  4. Verify: Pass/fail the build based on findings. See Details

Choose Your Platform

Bash Script

Universal script using curl and jq

GitHub Actions

Native GitHub workflow integration

Jenkins

Jenkinsfile pipeline example

GitLab CI

.gitlab-ci.yml configuration

Verify Results

Pass/fail builds with comparison statistics

Next Steps