> For the complete documentation index, see [llms.txt](https://docs.opsmx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opsmx.com/remediation-agents/code-agent/bir-binary-image-remediation.md).

# BIR - Binary Image Remediation

Binary Image remediation feature covers the vulnerability detection and remediation within the AIG platform. The system integrates a UI layer, AIG backend services, SSD scanning APIs, and CI/CD pipelines to deliver a deterministic, traceable, and automated remediation workflow.&#x20;

The process is initiated when the user provides the following inputs through the UI:

* GitHub Repository (mandatory) — source code location
* Branch (mandatory) — target branch for remediation
* Dockerfile Path (mandatory) — used for analysis and patching
* Docker Image — used as input for SSD artifact scanning

After receiving the inputs, the AIG backend creates a project in SSD via the Project APIs. Repository metadata (repo URL, branch, Dockerfile path) is registered, establishing a link between AIG and the SSD system.

The system then triggers two independent scans in SSD:

* **Source Scan API** — performs SAST (Static Application Security Testing) for code issues and SCA (Software Composition Analysis) for dependency vulnerabilities.
* **Artifact Scan API** (Binary Scan) — scans the Docker image for OS-level, runtime, and binary vulnerabilities.

The instructions below provide steps to add the inputs, initiate the scans, view the scan results and remediate.&#x20;

{% hint style="info" %}

* Before starting a scan, integrate Docker and add your account. Refer to [Docker Integration](https://docs.opsmx.com/integrations/integrating-ci-and-cd-tools/docker#usage-of-docker-in-delivery-shield).&#x20;
* Make the necessary configuration changes before proceeding. Refer [Configuration Changes](https://docs.opsmx.com/getting-started/release-notes/configuration-changes/config-changes-for-v2026.06.00/config-changes-to-enable-bir-in-ssd) for details.&#x20;
  {% endhint %}

### To Add Project

* To add or update a new project with Artifact Scan configurations, for scanning, click **Add Project**.

<figure><img src="https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FzglzBKadiTYi2cserDgS%2Fartifact%20scan%20.png?alt=media&amp;token=724e6aca-ff35-4148-b595-be36aec03c6e" alt=""><figcaption></figcaption></figure>

* The Create Project details page is displayed as shown below. Enter the details for the following fields:

<figure><img src="https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FMHiY3r6O3zpBBEoqTQbv%2Fdocker%20upload.png?alt=media&amp;token=e011e5bd-9667-4413-983a-d690c7787718" alt=""><figcaption></figcaption></figure>

* **Name** : Enter a name for the project.
* **Team** : Select the team for which you want to create the project.
* **Scan Type** : The default type is Artifact Scan.
* **Platform** : Select the platform type as Docker. (The platform where the code resides). Other platforms options are: Docker, Gitlab Container Registry, ACR, GAR, GCR, GCS, ECR, Quay, Jfrog Artifactory, Nexus Artifact Registry.
* **Account** : Choose the added docker account from the dropdown.
* **Organization / Workspace** : Choose the organization or workspace that the selected account has access to.
* **Scan Level** : Select the scan level; either organization level or repository level that needs to be scanned.
* **Configuration** : Set the configuration details:
  * **Artifact Name/ Repo /File / Packages** : Select the repo or project name for which the scan needs to be executed.
  * **Artifact Tag** :  Select the **Artifact Tag** from the dropdown:&#x20;
    * **Latest** - If this option is selected, you can upload the docker file from your local.&#x20;
    * **Tags Pattern** : If this option is selected, you can enter the associated tag or tags pattern. &#x20;
  * **Scan Upto** : Select the branch limit for which the scan needs to be executed. (number of branches to be scanned)
  * **Schedule Auto Scan** :  Select the time range during which the scan needs to be rerun automatically.
* Click **Save**.

The project gets added for scanning.

### Viewing Binary Reports

The Binary scan reports are available in the Artifact Scan page.&#x20;

* Navigate to **Artifact Scan**.
* The added account is listed along with its scan status.
* Expand the account entry to view scan details.

![](https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FVjRwYKJSJKxNPJGSZZej%2Funknown.png?alt=media\&token=647fc0b5-f4dc-490f-b2d5-2cee0adc281c)

* Click **View Reports** in the **Action** column. The report page is displayed.&#x20;
* In the report page, click **Remediation** and select **Binary**.

<figure><img src="https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FZYl3QCX9Q4Wu6kSpRxC7%2FBIR%20new.png?alt=media&amp;token=e49e4872-809c-49b2-ba89-fe59c8d24d05" alt=""><figcaption></figcaption></figure>

* The components and their vulnerability analysis are displayed.

### Remediation Findings

* Expand a component to view its findings.
* Click the **Remediation** tab next to the component that you wish to remedaite.&#x20;

<figure><img src="https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FnpzBP5fjMKZyWo8c8Z22%2FBIR%20new%201.png?alt=media&amp;token=b51bdb26-90c3-48ec-b092-9042305371b3" alt=""><figcaption></figcaption></figure>

* A detailed analysis is provided, covering:
  * Overview — summary of the vulnerability and affected component.
  * Fix Plan — recommended remediation approach.
  * Remediation — the actionable fix, ready to apply.

![](https://591284771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxDmLTMQiowMHZ4CQPCvT%2Fuploads%2FiKQdnJiHadkMcDNSWM7C%2Funknown.png?alt=media\&token=46be5f93-c6f0-4b3b-84e6-8f94cb051be9)

<br>
