@salesforce/b2c-tooling-sdk / security / SecurityScanOptions
Interface: SecurityScanOptions
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:61
Options for scanSecurity.
Properties
baseline?
optionalbaseline:SecurityBaseline
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:76
Mark findings that match this baseline.
cartridgePath?
optionalcartridgePath:string[]
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:78
Cartridge path order (names) used to compose routes across cartridges.
cartridgePathSource?
optionalcartridgePathSource:CartridgeOrder
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:82
Where cartridgePath came from (see BuildProjectIndexOptions.cartridgePathSource).
config?
optionalconfig:false|SecurityConfig
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:94
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?
optionalexcludeReferenceCartridges:boolean
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:86
Leave out findings inside SFRA and SiteGenesis reference cartridges (REFERENCE_CARTRIDGES).
excludeRules?
optionalexcludeRules:string[]
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:72
Skip these rule IDs.
ignore?
optionalignore:string[]
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:96
More paths to leave out (globs relative to root), in addition to the config's ignore.
includeAllCartridges?
optionalincludeAllCartridges:boolean
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:80
Index every project cartridge, not just those on the path (see BuildProjectIndexOptions.includeAllCartridges).
minSeverity?
optionalminSeverity:SecuritySeverity
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:74
Drop findings below this severity.
paths?
optionalpaths:string[]
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:68
Files or directories to scan. Directories are searched for cartridges (folders with a .project file) and their server-side scripts. Defaults to root.
projectIndex?
optionalprojectIndex:ProjectIndex
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:88
A project index to use instead of building one from root and paths.
root?
optionalroot:string
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:63
Directory that finding paths are relative to. Defaults to the current directory.
rules?
optionalrules:string[]
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:70
Run only these rule IDs.
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/security/engine.ts:84
Without cartridgePath: the site whose cartridge path to read from the project's site.xml files.