@salesforce/b2c-tooling-sdk / 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
- AstReference
- AstScope
- AstVariable
- InlineSuppression
- MetadataReport
- MetadataRule
- ScanSecurityTextOptions
- ScriptComment
- ScriptReportDescriptor
- ScriptRule
- ScriptRuleContext
- ScriptRuleReport
- ScriptRunResult
- ScriptSourceCode
- SecurityBaseline
- SecurityConfig
- SecurityFinding
- SecurityLocation
- SecurityRuleInfo
- SecurityRuleSettings
- SecurityScanError
- SecurityScanOptions
- SecurityScanResult
- ToSarifOptions
Type Aliases
- MetadataDocument
- MetadataFileKind
- MetadataRuleDefinition
- ScriptParseErrorReason
- ScriptRuleDefinition
- ScriptRuleListener
- SecurityAnalyzer
- SecurityCategory
- SecurityConfidence
- SecurityRule
- SecurityRuleSetting
- SecuritySeverity
Variables
- DEMO_CLIENT_ID
- METADATA_RULES
- REFERENCE_CARTRIDGES
- SCRIPT_RULES
- SECURITY_CONFIG_FILE
- SECURITY_RULES
- SECURITY_RULES_DOCS_URL
- SECURITY_SETTINGS_KEY
- SECURITY_SEVERITIES
Functions
- applyBaseline
- applyRuleSettings
- classifyParseError
- collectMetadataFiles
- collectSecurityScanFiles
- createBaseline
- defineMetadataRule
- defineScriptRule
- detectMetadataKind
- disabledRules
- findSuppression
- fingerprintFinding
- ignoredPathTest
- isAtLeastSeverity
- listSecurityRules
- loadSecurityConfig
- parseBaseline
- parseSecurityConfig
- parseSuppressions
- runScriptRules
- scanMetadataText
- scanSecurity
- scanSecurityText
- selectSecurityRules
- toSarif
- validateSecurityConfig