Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(README): Threat / Mitigation Packs - Fix instructions #140

Merged
merged 1 commit into from
Sep 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ Threat packs allow you to quickly find and add bulk or selected threat statement
1. Update the value of `id` to be a short human readable indentier for the pack (e.g. `AuthThreats`)
1. Update the value of `description` to describe the contents of the pack (e.g. `This pack contains common authentication threats`)
1. Update the value of `path` to point to the _relative_ path of the source `.tc.json` file (e.g. `./AuthenticationThreats.tc.json`)
1. Generate the threat pack file by running `yarn run build:pack` from the root of the local repository
1. Generate the threat pack file by running `yarn run build:packs` from the root of the local repository
1. Update `packages/threat-composer/src/data/threatPacks/threatPacks.ts` file to import the generated file. e.g. `import authenticationThreatPack './generated/AuthThreats.json';` and add it to the `threatPacks` array - for example:
```
const threatPacks = [
Expand Down Expand Up @@ -451,13 +451,13 @@ Mitigation packs allow you to quickly find and add bulk or selected mitigation c
1. Update the value of `id` to be a short human readable indentier for the pack (e.g. `BaselineControls`)
1. Update the value of `description` to describe the contents of the pack (e.g. `This pack contains our organizations baseline controls`)
1. Update the value of `path` to point to the _relative_ path of the source `.tc.json` file (e.g. `./BaselineControls.tc.json`)
1. Generate the threat pack file by running `yarn run build:pack` from the root of the local repository
1. Generate the threat pack file by running `yarn run build:packs` from the root of the local repository
1. Update `packages/threat-composer/src/data/mitigationPacks/mitigationPacks.ts` file to import the generated file. e.g. `import ourBaselineControlsMitigationPack './generated/BaselineControls.json';` and add it to the `mitigationPacks` array - for example:
```
const mitigationPacks = [
ourBaselineControlsMitigationPack,
GenAIChatbot,
] as ThreatPack[];
] as MitigationPack[];
```
1. Build the project.

Expand Down
Loading