Commit Graph

2641 Commits

Author SHA1 Message Date
Marek Wolan
d4287d6690 3110 Fix formatting and code examples in docs 2025-03-13 14:18:26 +00:00
Marek Wolan
dc65681f2c 3110 Add generated notebooks folder to makefile clean command 2025-03-13 14:18:03 +00:00
Marek Wolan
ba3d855b4c 3110 - change notebook title to deduplicate 2025-03-13 11:54:16 +00:00
Marek Wolan
00364c3a9f 3110 - Fix naming schema for rewards in docs 2025-03-13 11:53:44 +00:00
Marek Wolan
9ffd5b90d9 3110 - Remove empty customising scenarios doc page 2025-03-13 11:53:44 +00:00
Nick Todd
e8e8ad7681 Merge branch 'feature/#3110-userguide-fixes' of ssh.dev.azure.com:v3/ma-dev-uk/PrimAITE/PrimAITE into feature/#3110-userguide-fixes 2025-03-13 11:36:36 +00:00
Nick Todd
dc3dc5d9c1 #3110: Correct config YAML snippets. 2025-03-13 11:36:24 +00:00
Marek Wolan
3cb9e51084 3110 - docs formatting fixes and updating text 2025-03-13 11:29:03 +00:00
Marek Wolan
8b91c280cb 3110 - remove outdated todos 2025-03-12 17:13:03 +00:00
Nick Todd
ea7898ce33 #3110: More example config file and domain name changes 2025-03-12 15:47:26 +00:00
Nick Todd
c54007daec Merge branch 'feature/#3110-userguide-fixes' of ssh.dev.azure.com:v3/ma-dev-uk/PrimAITE/PrimAITE into feature/#3110-userguide-fixes 2025-03-12 15:23:33 +00:00
Nick Todd
af025d45ff #3110: config file example changes. 2025-03-12 15:23:17 +00:00
Marek Wolan
19d7989c4a Add extra detail and examples to YAML migration guide 2025-03-12 15:21:35 +00:00
Nick Todd
907294992c #3110: Update example schema in terminal.rst 2025-03-12 14:53:34 +00:00
Nick Todd
58de350941 #3110: Remove HTTPS reference. 2025-03-12 14:04:46 +00:00
Nick Todd
283273babe #3110: Fixed code snippet and added text. 2025-03-12 13:50:46 +00:00
Nick Todd
96014962f0 #3110: Update code snippet in state_system. 2025-03-12 13:22:43 +00:00
Nick Todd
5d21bed557 Merge branch 'feature/#3110-userguide-fixes' of ssh.dev.azure.com:v3/ma-dev-uk/PrimAITE/PrimAITE into feature/#3110-userguide-fixes 2025-03-12 12:54:21 +00:00
Nick Todd
9d800b6c45 #3110: update code snippets and text in request_system. 2025-03-12 12:54:08 +00:00
Archer Bowen
68db549217 #3110 Notebook update changes:
- All agent training demo notebooks now reference UC2.
- Terminal-Processing Notebook now includes a few extra markdown cells for extra context. Additionally yaml snippets have been updated to reflect 4.0.0 schema
- Request-and-Response notebook now includes a few more markdown cells for extra context as well as updated software names
- General notebook cell clean up and tidying.
2025-03-12 12:42:38 +00:00
Marek Wolan
62812749d5 3110 - change docs custom class template to remove things inherited from basemodel 2025-03-12 12:01:25 +00:00
Nick Todd
747fe72065 Merge branch 'feature/#3110-userguide-fixes' of ssh.dev.azure.com:v3/ma-dev-uk/PrimAITE/PrimAITE into feature/#3110-userguide-fixes 2025-03-12 10:22:26 +00:00
Nick Todd
f19422e1f0 #3110: Replace "identifier" with "discriminator". 2025-03-12 10:22:14 +00:00
Archer Bowen
213ed045ee #3110 Notebook Changes:
**How-To-Use-Primaite-Dev-Mode**
- Neatened up titles and general formatting

**Privilege-Escalation-and-Data-Loss-Example**
- Added new text which gives more context to the scenario (smaller UC7 with a focus on simulation demonstration rather than agent training)
- Fixed Broken terminal commands
- general misc tidying (bolding etc)
2025-03-11 17:51:57 +00:00
Nick Todd
3f74031dc7 #3110: Fix references to list of ports and protocols. 2025-03-11 17:40:43 +00:00
Nick Todd
99d4e228c9 Merge branch 'feature/#3110-userguide-fixes' of ssh.dev.azure.com:v3/ma-dev-uk/PrimAITE/PrimAITE into feature/#3110-userguide-fixes 2025-03-11 16:42:46 +00:00
Nick Todd
d2b5097dce #3110: update port and protocol descriptions 2025-03-11 16:41:32 +00:00
Archer Bowen
678a500c5e #3111 yaml migration guide comments. 2025-03-11 16:07:34 +00:00
Nick Todd
dab261da0b #3110: Update URLs 2025-03-11 15:29:57 +00:00
Nick Todd
b13d6ebd03 #3110: Fix mangled license. 2025-03-11 14:58:19 +00:00
Archer Bowen
cb91e13fe7 #3110 Getting-information-out-of-PrimAITE changes:
- New text that explains that this notebook uses UC2
- New text which informs users that sys_logs slow down training a lot
- New code snippet for the .describe_method()
2025-03-11 13:05:44 +00:00
Archer Bowen
a71ded8ecf #3110 UC2 Notebook changes:
- YAML obs nest dict updated
- `friendly_output_red_action` updated
- `NMNE` section moved into the same timestep that the attack takes place.
- General OBS print is neater and less bloated
- ACL's code snippets assumed that ACL's indexed at 1 (as they did previously). However, this is no longer the case. (Updated config to reflect this)
- Remove un-necessary env.reset(). (We already reset at the start of the notebook - users can just run-run the notebook)
2025-03-11 12:58:59 +00:00
Nick Todd
42f7925748 #3110: fix links in how-to guides 2025-03-11 12:27:45 +00:00
Archer Bowen
b4df227af3 #3111 & initial notebook fixes. 2025-03-10 16:19:54 +00:00
Nick Todd
b467292edd Merged PR 624: CHANGELOG updates
## Summary
Updates to CHANGELOG.md for 4.0.0.

## Test process
Checked that document rendered correctly.

## Checklist
- [X] PR is linked to a **work item**
- [ ] **acceptance criteria** of linked ticket are met
- [X] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [X] updated the **change log**
- [X] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

Related work items: #3105
2025-03-07 13:41:13 +00:00
Archer Bowen
282f76caa0 Merged PR 623: TAP003 Local Host index error causing index error.
## Summary

Adds an additional if statement to catch the edge case.

This bug came out of another bug-fix made in !612 in which the manipulation stage logic was altered (the last host was being skipped over).

## Test process
Ran the pre-existing tests (in milpac as well)

## Checklist
- [x] PR is linked to a **work item**
- [x] **acceptance criteria** of linked ticket are met
- [x] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [x] ran **pre-commit** checks for code style
- [x] attended to any **TO-DOs** left in the code

Fixing an issue where if tap-003 were to attempt to change the password of it's starting node an index error would cause a crash. (only if the starting host was the last host in the `account_changes` config option)

Related work items: #3107
2025-03-07 13:41:13 +00:00
Nick Todd
65dee930b1 #3105: Further PR comments. 2025-03-07 13:41:13 +00:00
Nick Todd
7775403067 #3105: Code review changes. 2025-03-07 13:41:13 +00:00
Nick Todd
d9191abd0f #3105: Pre-commit changes. 2025-03-07 13:41:13 +00:00
Charlie Crane
1b0183f689 Merged PR 622: Addition of How-To Guides
## Summary
Port of How-To guides from an old PR to PrimAITE v4.0, alongside updates for the extensible pages created to be visible in navigation pane.

## Test process
Locally generated Documentation has working links

## Checklist
- [ ] PR is linked to a **work item**
- [ ] **acceptance criteria** of linked ticket are met
- [ ] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [ ] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

Related work items: #2893
2025-03-07 13:41:12 +00:00
Archer Bowen
4fbcd511b3 #3107 Reduce dense commenting 2025-03-07 13:41:12 +00:00
Nick Todd
995bcd7170 #3105: Updated and corrected entries. 2025-03-07 13:41:12 +00:00
Archer Bowen
dd5571359a Merged PR 612: #2925 Use Case 7 Scenario Modelling
## Summary
This PR contains the entirety of the #2925 UC7 implementation and updated to work with 4.0.0.

Specifically, this PR contains the following:

- New UC7 Scenario config (#2483)
- New UC7 TAP001 Config #2909
- New UC7 TAP003 Config #2910
- New UC7 default blue agent #3070
- New UC7 green agent POL #3067
- Multiple UC7 detailed diagrams #3068
- Multiple new UC7 notebooks #3069

## Test process

Pre-existing tests have been re-modelled to use UC7 as well as a few more new UC7 specific tests that ensure all of the expected default behaviour is working.

Additionally, multiple notebooks exist which utilise a large amount of the UC7 scenario and thus also act as tests.

## Checklist
- [X] PR is linked to a **work item**
- [X] **acceptance criteria** of linked ticket are met
- [ ] performed **self-review** of the code
- [X] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [ ] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

Related work items: #2483, #2909, #2910, #3067, #3068, #3069, #3070, #3071, #3086
2025-03-07 13:41:12 +00:00
Marek Wolan
fd2ad45059 Merge remote-tracking branch 'origin/dev' into feature/Updated-How-To-Guides 2025-03-07 13:41:12 +00:00
Archer Bowen
3690b61be5 Fixing an issue where if tap-003 were to attempt to change the password of it's starting node an index error would cause a crash. (only if the starting host was the last host in the account_changes config option) 2025-03-07 13:41:12 +00:00
Archer Bowen
83c9a90c0a #20925 fixing failing notebook pipeline. 2025-03-07 13:41:12 +00:00
Archer Bowen
7b928696f6 #2725 Remove borked reload 2025-03-07 13:41:12 +00:00
Archer Bowen
be51d039c2 Moved red_scan_countdown into node class attributes. ( 2025-03-07 13:41:12 +00:00
Marek Wolan
f3cc4e8409 Fix red scan not happening 2025-03-07 13:41:12 +00:00
Archer Bowen
7f3d166de0 #2925 Replace try catch logic with a more elegant solution. 2025-03-07 13:41:12 +00:00