How to do Artifact Scan
The Artifact Scan scans the artifacts produced by your build pipeline, such as container images, that are stored in your artifact registry. The scanning process includes vulnerability detection, component analysis (SBOM generation), license verification, and secret detection.
By integrating OpsMx Delivery Shield with your artifact registry, you gain continuous, automated scanning of every artifact built in your pipeline, which helps ensure that only verified and secure artifacts are promoted toward deployment. Automatic scans on every build, detailed reporting, and policy checks through CI/CD integration ensure that your software is secure at the artifact stage, before it reaches production.
This page explains the process of Artifact Scan for artifacts stored in your registry.
Before starting with the scan, you need to integrate your artifact registry with the OpsMx platform. Follow the steps provided in Integrating Registry in Delivery Shield (for example, ACR or Nexus) to complete the process.
Once the registry integration is connected to OpsMx, you can start with the artifact scan.
To Access Artifact Scan
Navigate to Scan Now > Artifact Scan.

Now you can Add Project, Upload Project or Sync Project to proceed with the scan.
To Add a Project
To add or update a new project with source scan configurations, for scanning, click Add Project. The Create Project details page is displayed as shown below.

Enter the details for the following fields:
Name (mandatory) : Enter a name for the project.
Team: Select the team for which you want to create the project.
Scan Type (mandatory) : The default type is Source Scan.
Platform (mandatory): Select the platform type, the platform where the code resides (Docker, Gitlab,Container Registry, ACR, GAR, GCR, GCS, ECR, Quay, Jfrog Artifactory, Nexus Artifact Registry) for the project.
Account : Choose the needed account that has been integrated for the selected platform. If no account is available for the selected platform then click Add Account. The integration page is displayed. You can add a new account.
Organization / Workspace (mandatory): Choose the organization or workspace that the selected account has access to.
Scan Level (mandatory) : Select the scan level; either organization level or repository level that needs to be scanned.
Artifact Configuration : Set the configuration details, and schedule the auto scan time.
Artifact Name/ Repo / File / Packages (mandatory) : Select the repo or package for which the scan needs to be executed.
Artifact Tag : You can select Latest or Tags Pattern.
If Latest is selected:

Upload the Docker File for which the scan needs to be done.
Scan Upto (mandatory): 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.
If Tags Pattern is selected:

Tags / Tag Pattern : Enter the tag pattern.
Scan Upto (mandatory): 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.
To Upload a Project
To upload a project from your local, for scanning, click Upload Project.

Click Upload File and select the json file that you want to add for scanning.
Click Save.
The file gets added for scanning.
Saving Configuration
After adding the configuration details you can click the Save Configuration option to save the adding details and trigger the scan at a later period.
Click Add Project and in the Create Project page, add the required details.

Click Save. A notification is displayed as shown below:

To trigger the scan at a later time, click Save Configuration.
The added project displays in the list with a Paused scan status.

When you want to scan the saved project you can click the Trigger Scan option to initiate the scan.
Ths scan gets initiated and the results are displayed.
To Integrate JIRA at Project Level
JIRA can be integrated at project level to create tickets whenever an alert is identified.
To integrate JIRA, click the Integrations icon on expanding the project.

The JIRA integration page is displayed. Click Add Account and enter the details.
Enter the values for the following fields:
Account Name - Enter the JIRA account name.
Jira Project Key - Enter the name of your Jira project.
Jira URL - Enter your Jira host Url
Jira Email Id - Enter the username to access Jira.
Token - Enter the password / token for the Jira account.
Enable Automatically create Jira tickets during the scan to create JIRA ticket to the team owner when the alerts are identified.
Trigger Type - Indicates at which level Jira tickets should be created.
Create Jira ticket at the Component Alert level - Jira tickets will be created for each individual impacted component.
Create Jira ticket at the Deduplication Alert level - A single Jira ticket will be created for all the impacted components.
Creation Scope - If Vulnerabilities is selected, Jira is created only for Critical and High alerts. If All Policies is selected Jira is created for all alerts.
Enable Assign the Jira ticket to the Team owner if you want to assign the ticket to the team owner.
Fields - Enter the labels that need to be added in the created Jira ticket.
Values - Enter the values that need to be given in the Jira ticket. The given variables are replaced with actual values when the tickets are created.
Status Keyword Mapping - You can set the keywords for the status.
Click Test to check if the entered values are valid.
Once validated, click Save. The tool is connected.
To View and Interpret Scan Results
Once the scan is complete, OpsMx generates the overall results and they are displayed as shown below:
Repos Registered
Total Branches
Total Scans
Total Projects
Auto Scan Enabled Repos

The panel at the bottom displays the project details. On expanding each project you can view the complete details of it.
Click View Reports to view the various reports related to the scan.
The page displays the findings for each scan. Click on the appropriate tab to view the results.

On clicking the Download button, the scan results are downloaded in .json or .csv format.
On clicking Go to Artifact Page, you are redirected to the Source Scan artifact page.
Quick Actions
Each project displays 5 quick action buttons as shown:

Trigger Scan – Initiates a new scan for the project or runs a scan using a previously saved configuration.
Integrations – Opens the project's Integrations page, where all available integrations for the project are listed.
Policies – Displays the list of policies that have been configured for the project.
Edit Project – Opens the project configuration settings, allowing you to modify the project's details and scan settings.
Delete – Removes the project from the system.
Best Practices
To get the most out of OpsMx Delivery Shield Source Scan, consider following these best practices:
Frequent Scanning: Run the scans regularly (e.g., after each commit or weekly) to detect the vulnerabilities early.
CI/CD Pipeline Integration: Incorporate source scanning into your continuous integration/continuous deployment pipeline to identify the issues before they go live.
Alerts and Notifications: Set up alerts to notify your team when critical vulnerabilities are detected, to address them promptly.
Fixing Issues in Advance: Address vulnerabilities as soon as they are found to prevent issues from piling up.
Troubleshooting
If you encounter any issues during or after the scan, check the following:
Connection Issues with the selected platform:
Ensure that the correct authentication methods (OAuth, API tokens, SSH) are set up properly.
Verify that the OpsMx account has the necessary permissions to access the repository.
Check for url whitelisting in supplychain api configmap
Last updated