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

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

# Interface: SecurityRuleInfo

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

Descriptive metadata every security rule carries.

## Properties

### analyzer

> **analyzer**: [`SecurityAnalyzer`](../type-aliases/SecurityAnalyzer.md)

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

***

### category

> **category**: [`SecurityCategory`](../type-aliases/SecurityCategory.md)

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

***

### confidence

> **confidence**: [`SecurityConfidence`](../type-aliases/SecurityConfidence.md)

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

***

### cwe

> **cwe**: readonly `string`[]

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

CWE identifiers, for example `CWE-601`.

***

### description

> **description**: `string`

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

One-sentence summary of what the rule finds.

***

### docsUrl

> **docsUrl**: `string`

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

Link to the rule's documentation.

***

### id

> **id**: `string`

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

Stable rule ID, kebab-case (for example `open-redirect`). Public contract once released.

***

### remediation

> **remediation**: `string`

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

Short guidance on how to fix a finding.

***

### severity

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

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