---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [security](../index.md) / SecurityScanOptions

# Interface: SecurityScanOptions

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:61](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L61)

Options for [scanSecurity](../functions/scanSecurity.md).

## Properties

### baseline?

> `optional` **baseline**: [`SecurityBaseline`](SecurityBaseline.md)

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:76](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L76)

Mark findings that match this baseline.

***

### cartridgePath?

> `optional` **cartridgePath**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:78](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L78)

Cartridge path order (names) used to compose routes across cartridges.

***

### cartridgePathSource?

> `optional` **cartridgePathSource**: [`CartridgeOrder`](../../project-index/interfaces/CartridgeOrder.md)

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:82](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L82)

Where `cartridgePath` came from (see `BuildProjectIndexOptions.cartridgePathSource`).

***

### config?

> `optional` **config**: `false` \| [`SecurityConfig`](SecurityConfig.md)

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L94)

Project security settings (rules turned off, severities, ignored paths),
for example the `security` key of dw.json. Defaults to
`.b2c-security.json` in `root` when present; pass `false` to use none.

***

### excludeReferenceCartridges?

> `optional` **excludeReferenceCartridges**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:86](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L86)

Leave out findings inside SFRA and SiteGenesis reference cartridges ([REFERENCE\_CARTRIDGES](../variables/REFERENCE_CARTRIDGES.md)).

***

### excludeRules?

> `optional` **excludeRules**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:72](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L72)

Skip these rule IDs.

***

### ignore?

> `optional` **ignore**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:96](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L96)

More paths to leave out (globs relative to `root`), in addition to the config's `ignore`.

***

### includeAllCartridges?

> `optional` **includeAllCartridges**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:80](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L80)

Index every project cartridge, not just those on the path (see `BuildProjectIndexOptions.includeAllCartridges`).

***

### minSeverity?

> `optional` **minSeverity**: [`SecuritySeverity`](../type-aliases/SecuritySeverity.md)

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:74](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L74)

Drop findings below this severity.

***

### paths?

> `optional` **paths**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:68](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L68)

Files or directories to scan. Directories are searched for cartridges
(folders with a `.project` file) and their server-side scripts. Defaults to `root`.

***

### projectIndex?

> `optional` **projectIndex**: [`ProjectIndex`](../../project-index/interfaces/ProjectIndex.md)

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:88](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L88)

A project index to use instead of building one from `root` and `paths`.

***

### root?

> `optional` **root**: `string`

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:63](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L63)

Directory that finding paths are relative to. Defaults to the current directory.

***

### rules?

> `optional` **rules**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:70](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L70)

Run only these rule IDs.

***

### siteId?

> `optional` **siteId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/security/engine.ts:84](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/security/engine.ts#L84)

Without `cartridgePath`: the site whose cartridge path to read from the project's site.xml files.
