Skip to content

Include Extra Data in the Scan

Overview

When creating a new scan profile, you can include extra assets to be used while scanning the profile's target asset.

Supported extra assets

This feature, as of now, only supports schemas. It is intended in our roadmap to support other types of extra assets in a near future.

This feature is in beta

This feature is in beta and is subject to change. In order to use this feature, you need to have a specific feature flag enabled on your organization. Please contact your Escape representative to enable this feature.

Linkage model

Under the hood, Escape will keep track of how assets are bound to each other in your ASM, and it will separately keep track of what assets are additionally used in each profile.

Assets definitions

In the ASM, it is possible to attach assets as a definition of another asset. This is done by linking the two assets together at the ASM level.

Profile extra Assets

A profile is dedicated to scanning a single target asset. This target asset can be defined by multiple different assets, including schemas, related services, code projects, etc.

The profile leverages a subset of the target asset's definition assets, in order to provide additional data to the scan. The extra assets of the profile are cherry picked among the target asset's definition assets.

Bypass

Alternatively, you can choose to use all of them, in this case, every future scan of this profile will use all the target asset's definition assets.

Usage in the UI

During Profile creation

When creating a new scan profile, you can include extra assets to be used while scanning the profile's target asset. You can do so by selecting the assets you want to include in the "Extra Assets" section.

extra-assets

You can also choose to use all the target asset's definition assets by checking the "Use all available extra assets" checkbox.

extra-assets

You can also create assets on the fly from this utility and have them immediately linked to the target asset, and used in the profile.

extra-assets

When creating the profile, you are offered to pick extra assets among all of the target asset's definition assets. To add a displayed asset to the extra assets of the created profile, a switch can be enabled or disabled.

Default behavior

Assets created through this UI are automatically linked to the target asset, and used in the profile.

Existing Profile edition

On the Profile settings section, it is possible to manage the extra assets of the profile under the "Schemas" section.

extra-assets

All features available during profile creation are also available here. It is also possible to unlink the extra assets from the target asset. This operation will require a confirmation and it will remove the asset from the extra assets of all the profiles scanning the target asset.

extra-assets

Troubleshooting

Missing assets in the list

If you don't see an asset in the list, it is likely because it is not a definition asset of the target asset. To fix this, you can either create the asset on the fly, or link it to the target asset from the ASM.

It is possible to browse all the assets in the list by clicking on their "See in ASM" button.

Asset creation failure

If it is not possible to create an asset from the provided file or asset definition, a card will notify of the error.

extra-assets

The error can be troubleshoot by clicking on the "See details" button.

extra-assets