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

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

# security

Security scanning for B2C Commerce cartridge code.

Rules are written as ESLint v9 rules over Script API JavaScript. The SDK
runs them without ESLint (parsing with espree and eslint-scope), and the
same rule objects can run in ESLint or oxlint.

## Example

```typescript
import {scanSecurity, toSarif} from '@salesforce/b2c-tooling-sdk/security';

const result = scanSecurity({root: '.', minSeverity: 'low'});
const open = result.findings.filter((f) => !f.suppression && !f.baselined);
const sarif = toSarif(result.findings, result.rules);
```

## Interfaces

- [AstNode](interfaces/AstNode.md)
- [AstReference](interfaces/AstReference.md)
- [AstScope](interfaces/AstScope.md)
- [AstVariable](interfaces/AstVariable.md)
- [InlineSuppression](interfaces/InlineSuppression.md)
- [MetadataReport](interfaces/MetadataReport.md)
- [MetadataRule](interfaces/MetadataRule.md)
- [ScanSecurityTextOptions](interfaces/ScanSecurityTextOptions.md)
- [ScriptComment](interfaces/ScriptComment.md)
- [ScriptReportDescriptor](interfaces/ScriptReportDescriptor.md)
- [ScriptRule](interfaces/ScriptRule.md)
- [ScriptRuleContext](interfaces/ScriptRuleContext.md)
- [ScriptRuleReport](interfaces/ScriptRuleReport.md)
- [ScriptRunResult](interfaces/ScriptRunResult.md)
- [ScriptSourceCode](interfaces/ScriptSourceCode.md)
- [SecurityBaseline](interfaces/SecurityBaseline.md)
- [SecurityConfig](interfaces/SecurityConfig.md)
- [SecurityFinding](interfaces/SecurityFinding.md)
- [SecurityLocation](interfaces/SecurityLocation.md)
- [SecurityRuleInfo](interfaces/SecurityRuleInfo.md)
- [SecurityRuleSettings](interfaces/SecurityRuleSettings.md)
- [SecurityScanError](interfaces/SecurityScanError.md)
- [SecurityScanOptions](interfaces/SecurityScanOptions.md)
- [SecurityScanResult](interfaces/SecurityScanResult.md)
- [ToSarifOptions](interfaces/ToSarifOptions.md)

## Type Aliases

- [MetadataDocument](type-aliases/MetadataDocument.md)
- [MetadataFileKind](type-aliases/MetadataFileKind.md)
- [MetadataRuleDefinition](type-aliases/MetadataRuleDefinition.md)
- [ScriptParseErrorReason](type-aliases/ScriptParseErrorReason.md)
- [ScriptRuleDefinition](type-aliases/ScriptRuleDefinition.md)
- [ScriptRuleListener](type-aliases/ScriptRuleListener.md)
- [SecurityAnalyzer](type-aliases/SecurityAnalyzer.md)
- [SecurityCategory](type-aliases/SecurityCategory.md)
- [SecurityConfidence](type-aliases/SecurityConfidence.md)
- [SecurityRule](type-aliases/SecurityRule.md)
- [SecurityRuleSetting](type-aliases/SecurityRuleSetting.md)
- [SecuritySeverity](type-aliases/SecuritySeverity.md)

## Variables

- [DEMO\_CLIENT\_ID](variables/DEMO_CLIENT_ID.md)
- [METADATA\_RULES](variables/METADATA_RULES.md)
- [REFERENCE\_CARTRIDGES](variables/REFERENCE_CARTRIDGES.md)
- [SCRIPT\_RULES](variables/SCRIPT_RULES.md)
- [SECURITY\_CONFIG\_FILE](variables/SECURITY_CONFIG_FILE.md)
- [SECURITY\_RULES](variables/SECURITY_RULES.md)
- [SECURITY\_RULES\_DOCS\_URL](variables/SECURITY_RULES_DOCS_URL.md)
- [SECURITY\_SETTINGS\_KEY](variables/SECURITY_SETTINGS_KEY.md)
- [SECURITY\_SEVERITIES](variables/SECURITY_SEVERITIES.md)

## Functions

- [applyBaseline](functions/applyBaseline.md)
- [applyRuleSettings](functions/applyRuleSettings.md)
- [classifyParseError](functions/classifyParseError.md)
- [collectMetadataFiles](functions/collectMetadataFiles.md)
- [collectSecurityScanFiles](functions/collectSecurityScanFiles.md)
- [createBaseline](functions/createBaseline.md)
- [defineMetadataRule](functions/defineMetadataRule.md)
- [defineScriptRule](functions/defineScriptRule.md)
- [detectMetadataKind](functions/detectMetadataKind.md)
- [disabledRules](functions/disabledRules.md)
- [findSuppression](functions/findSuppression.md)
- [fingerprintFinding](functions/fingerprintFinding.md)
- [ignoredPathTest](functions/ignoredPathTest.md)
- [isAtLeastSeverity](functions/isAtLeastSeverity.md)
- [listSecurityRules](functions/listSecurityRules.md)
- [loadSecurityConfig](functions/loadSecurityConfig.md)
- [parseBaseline](functions/parseBaseline.md)
- [parseSecurityConfig](functions/parseSecurityConfig.md)
- [parseSuppressions](functions/parseSuppressions.md)
- [runScriptRules](functions/runScriptRules.md)
- [scanMetadataText](functions/scanMetadataText.md)
- [scanSecurity](functions/scanSecurity.md)
- [scanSecurityText](functions/scanSecurityText.md)
- [selectSecurityRules](functions/selectSecurityRules.md)
- [toSarif](functions/toSarif.md)
- [validateSecurityConfig](functions/validateSecurityConfig.md)
