Skip to main content

Check out Port for yourself 

ArmorCode

Port's ArmorCode integration allows you to model ArmorCode resources in your software catalog and ingest data into them.

Overview​

This integration allows you to:

  • Track security vulnerabilities and findings from ArmorCode in Port.
  • Map products, sub-products, and their security findings.
  • Monitor security posture across your software catalog.

Supported Resources​

The resources that can be ingested from ArmorCode into Port are listed below. It is possible to reference any field that appears in the API responses linked below in the mapping configuration.

  • Products - ArmorCode products representing applications or services.
  • Sub-Products - Repositories or components within products.
  • Findings - Security vulnerabilities and issues detected by ArmorCode.

Setup​

Choose one of the following installation methods:

Using this installation option means that the integration will be hosted by Port, with a customizable resync interval to ingest data into Port.

Live event support

Currently, live events are not supported for this integration.
Resyncs will be performed periodically (with a configurable interval), or manually triggered by you via Port's UI.

Therefore, real-time events (including GitOps) will not be ingested into Port immediately.
Live events support for this integration is WIP and will be supported in the near future.

Self-hosted installation

Alternatively, you can install the integration using the Self-hosted method to update Port in real time using webhooks.

Installation

To install, follow these steps:

  1. Go to the Data sources page of your portal.

  2. Click on the + Data source button in the top-right corner.

  3. Click on the relevant integration in the list.

  4. Under Select your installation method, choose Hosted by Port.

  5. Configure the integration settings and application settings as you wish (see below for details).

Application settings

Every integration hosted by Port has the following customizable application settings, which are configurable after installation:

  • Resync interval: The frequency at which Port will ingest data from the integration. There are various options available, ranging from every 1 hour to once a day. If a sync is still in progress when the next one is due, the new sync will be skipped (up to 24 hours delay).
    This ensures that all kinds are fully synchronized and that cleanup of stale entities always takes place at the end of each sync.

  • Send raw data examples: A boolean toggle (enabled by default). If enabled, raw data examples will be sent from the integration to Port. These examples are used when testing your mapping configuration, they allow you to run your jq expressions against real data and see the results.

Integration settings

Every integration has its own tool-specific settings, under the Integration settings section.
Each of these settings has an ⓘ icon next to it, which you can hover over to see a description of the setting.

Port secrets

Some integration settings require sensitive pieces of data, such as tokens.
For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.

When filling in such a setting, its value will be obscured (shown as ••••••••).
For each such setting, Port will automatically create a secret in your organization.

To see all secrets in your organization, follow these steps.

Limitations

  • The maximum time for a full sync to run is based on the configured resync interval. For very large amounts of data where a resync operation is expected to take longer, please use a longer interval.

Port source IP addresses

When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses.
You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:

54.73.167.226  
63.33.143.237  
54.76.185.219

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration for this integration:

Default mapping configuration (click to expand)
deleteDependentEntities: true
createMissingRelatedEntities: true
enableMergeEntity: true
resources:
  - kind: product
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeProduct"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            description: .description
            businessOwner: .business_owner
            securityOwner: .security_owner
  - kind: sub-product
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeSubProduct"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            repoLink: .repo_link
            programmingLanguage: .programming_language
            technologies: .technologies
          relations:
            product: .product_id
  - kind: finding
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeFinding"'
          identifier: .id | tostring
          title: .title
          properties:
            source: .source
            description: .description
            mitigation: .mitigation
            severity: .severity
            findingCategory: .finding_category
            status: .status
            productStatus: .product_status
            subProductStatuses: .sub_product_statuses
            title: .title
            toolSeverity: .tool_severity
            createdAt: .created_at
            lastUpdated: .last_updated
            cwe: .cwe
            cve: .cve
            link: .link
            riskScore: .risk_score
            findingScore: .finding_score
          relations:
            product: .product_id
            subProduct: .sub_product_id

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Examples​

Examples of blueprints and the relevant integration configurations:

Product​

Product blueprint (click to expand)
{
  "identifier": "armorcodeProduct",
  "title": "Armorcode Product",
  "icon": "Package",
  "schema": {
    "properties": {
      "name": {
        "type": "string",
        "title": "Name"
      },
      "description": {
        "type": "string",
        "title": "Description"
      },
      "businessOwner": {
        "type": "string",
        "title": "Business Owner"
      },
      "securityOwner": {
        "type": "string",
        "title": "Security Owner"
      }
    },
    "required": [
      "name"
    ]
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}
Integration configuration (click to expand)
createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: products
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeProduct"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            description: .description
            businessOwner: .business_owner
            securityOwner: .security_owner

Sub-Product​

Sub-Product blueprint (click to expand)
{
  "identifier": "armorcodeSubProduct",
  "title": "Armorcode Sub-Product",
  "icon": "Git",
  "schema": {
    "properties": {
      "name": {
        "type": "string",
        "title": "Name"
      },
      "repoLink": {
        "type": "string",
        "title": "Repository Link",
        "format": "url"
      },
      "programmingLanguage": {
        "type": "string",
        "title": "Language"
      },
      "technologies": {
        "type": "array",
        "title": "Technologies",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "name"
    ]
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {
    "product": {
      "title": "Product",
      "target": "armorcodeProduct",
      "required": false,
      "many": false
    }
  }
}
Integration configuration (click to expand)
createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: sub_products
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeSubProduct"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            repoLink: .repo_link
            programmingLanguage: .programming_language
            technologies: .technologies
          relations:
            product: .product_id

Finding​

Finding blueprint (click to expand)
{
  "identifier": "armorcodeFinding",
  "title": "ArmorCode Finding",
  "icon": "Bug",
  "schema": {
    "properties": {
      "source": {
        "title": "Source",
        "type": "string",
        "description": "The security tool that generated this finding"
      },
      "description": {
        "title": "Description",
        "type": "string",
        "description": "Detailed description of the security finding"
      },
      "mitigation": {
        "title": "Mitigation",
        "type": "string",
        "description": "Recommended mitigation steps for this finding"
      },
      "severity": {
        "type": "string",
        "title": "Severity",
        "enum": [
          "CRITICAL",
          "HIGH",
          "MEDIUM",
          "LOW",
          "INFORMATIONAL",
          "UNKNOWN"
        ],
        "enumColors": {
          "CRITICAL": "red",
          "HIGH": "orange",
          "MEDIUM": "yellow",
          "LOW": "darkGray",
          "INFORMATIONAL": "silver",
          "UNKNOWN": "lightGray"
        }
      },
      "findingCategory": {
        "title": "Finding Category",
        "type": "string",
        "description": "Category classification of the finding"
      },
      "status": {
        "type": "string",
        "title": "Status",
        "enum": [
          "OPEN",
          "CLOSED",
          "ACTIVE",
          "IN_PROGRESS",
          "RESOLVED",
          "TRIAGE",
          "CONTROLLED",
          "SUPPRESS",
          "MITIGATED"
        ],
        "enumColors": {
          "OPEN": "paleBlue",
          "ACTIVE": "olive",
          "CLOSED": "lightGray",
          "RESOLVED": "green",
          "IN_PROGRESS": "orange",
          "TRIAGE": "yellow",
          "CONTROLLED": "purple",
          "SUPPRESS": "darkGray",
          "MITIGATED": "lime"
        }
      },
      "productStatus": {
        "title": "Product Status",
        "type": "string",
        "description": "Status of the product containing this finding"
      },
      "subProductStatuses": {
        "title": "Sub-Product Status",
        "type": "string",
        "description": "Status of the sub-product containing this finding"
      },
      "title": {
        "title": "Title",
        "type": "string",
        "description": "Brief title describing the finding"
      },
      "toolSeverity": {
        "title": "Tool Severity",
        "type": "string",
        "description": "Original severity as reported by the security tool"
      },
      "createdAt": {
        "title": "Created At",
        "type": "string",
        "description": "When the finding was first created"
      },
      "lastUpdated": {
        "title": "Last Updated",
        "type": "string",
        "format": "date-time",
        "description": "When the finding was last updated"
      },
      "cwe": {
        "title": "CWE",
        "type": "array",
        "description": "Common Weakness Enumeration identifiers",
        "items": {
          "type": "string"
        }
      },
      "cve": {
        "title": "CVE",
        "type": "array",
        "description": "Common Vulnerabilities and Exposures identifiers",
        "items": {
          "type": "string"
        }
      },
      "link": {
        "title": "Link to Finding",
        "type": "string",
        "format": "url",
        "description": "Direct link to the finding in ArmorCode"
      },
      "riskScore": {
        "title": "Risk Score",
        "type": "number",
        "description": "Calculated risk score for the finding"
      },
      "findingScore": {
        "title": "Finding Score",
        "type": "number",
        "description": "ArmorCode finding score"
      }
    },
    "required": [
      "title",
      "status",
      "severity",
      "source",
      "findingCategory"
    ]
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {
    "product": {
      "title": "Product",
      "target": "armorcodeProduct",
      "required": true,
      "many": false
    },
    "subProduct": {
      "title": "Sub-Product",
      "target": "armorcodeSubProduct",
      "required": true,
      "many": false
    }
  }
}
Integration configuration (click to expand)
createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: findings
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"armorcodeFinding"'
          identifier: .id | tostring
          title: .title
          properties:
            source: .source
            description: .description
            mitigation: .mitigation
            severity: .severity
            findingCategory: .finding_category
            status: .status
            productStatus: .product_status
            subProductStatuses: .sub_product_statuses
            title: .title
            toolSeverity: .tool_severity
            createdAt: .created_at
            lastUpdated: .last_updated
            cwe: .cwe
            cve: .cve
            link: .link
            riskScore: .risk_score
            findingScore: .finding_score
          relations:
            product: .product_id
            subProduct: .sub_product_id

Let's Test It​

This section includes a sample response data from ArmorCode. In addition, it includes the entity created from the resync event based on the Ocean configuration provided in the previous section.

Payload​

Here is an example of the payload structure from ArmorCode:

Product response data (click to expand)
{
  "id": 1,
  "name": "E-commerce Platform",
  "description": "Main e-commerce application for online retail",
  "business_owner": "John Smith",
  "security_owner": "Sarah Johnson",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}
Sub-Product response data (click to expand)
{
  "id": 101,
  "name": "payment-service",
  "repo_link": "https://github.com/company/payment-service",
  "programming_language": "Java",
  "technologies": ["Spring Boot", "PostgreSQL", "Redis"],
  "product_id": 1,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}
Finding response data (click to expand)
{
  "id": 1001,
  "title": "SQL Injection Vulnerability",
  "source": "SAST",
  "description": "Potential SQL injection vulnerability detected in user input validation",
  "mitigation": "Use parameterized queries and input validation",
  "severity": "HIGH",
  "finding_category": "Code Security",
  "status": "OPEN",
  "product_status": "ACTIVE",
  "sub_product_statuses": "ACTIVE",
  "tool_severity": "HIGH",
  "created_at": "2024-01-15T10:30:00Z",
  "last_updated": "2024-01-20T14:45:00Z",
  "cwe": ["CWE-89"],
  "cve": ["CVE-2023-1234"],
  "link": "https://app.armorcode.com/findings/1001",
  "risk_score": 8.5,
  "finding_score": 7.2,
  "product_id": 1,
  "sub_product_id": 101
}