Commit Graph

2666 Commits

Author SHA1 Message Date
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
56f8c53be2 #3113: Fix incorrect hostname. 2025-03-10 11:35:33 +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
Archer Bowen
f532b5e0da #2925 Fixed TAP003 error and failing tests. 2025-03-07 13:41:12 +00:00
Marek Wolan
908dbe4722 fix show history 2025-03-07 13:41:12 +00:00
Archer Bowen
4e03d436ac Merge remote-tracking branch 'origin/dev' into UC7-migration 2025-03-07 13:41:12 +00:00
Archer Bowen
36aecdea37 #2925 Updating more tests based on PR comments. (Mainly clean-up and improving comment clarity) 2025-03-07 13:41:12 +00:00
Archer Bowen
6a0d28bf5f #2825 Updated all tests to use a constants rather than a magic num. 2025-03-07 13:41:12 +00:00
Archer Bowen
72a06ea001 #2925 Further clean up to tap kill chain repeat test. 2025-03-07 13:41:12 +00:00
Archer Bowen
5cc885f6e9 #2925 PR TAP Test comments. 2025-03-07 13:41:12 +00:00
Archer Bowen
0b7cdd451b Merge branch 'dev' into UC7-migration 2025-03-07 13:41:12 +00:00
Archer Bowen
2662540965 Reviewing PR comments - #2925 !612 2025-03-07 13:41:12 +00:00
Archer Bowen
e45c2742cc #2925 Responding to a few more pr comments (general notebook clean up and improvement). 2025-03-07 13:41:12 +00:00
Archer Bowen
eec73deae7 #2925 Responding to PR comments. 2025-03-07 13:41:12 +00:00
Archer Bowen
43d58a7ca6 #2925 General Config fixes and node-os-scan bug fix implemented in the UC7-E2E-Demo notebook. 2025-03-07 13:41:12 +00:00
Marek Wolan
da60833abd Fix os scan action 2025-03-07 13:41:12 +00:00
Archer Bowen
d8b52012f5 #2925 Addressing PR comments. General config clean up and typos. 2025-03-07 13:41:12 +00:00
Archer Bowen
f6a6c3dde5 #2483 Addressed inconsistent naming schema. Now all some tech networks will be referenced using a underscore. E.g "ST-PROJ-A-PRV-PC-1" has now been changed to "ST_PROJ-A-PRV-PC-1". 2025-03-07 13:41:12 +00:00
Archer Bowen
80be1d5418 #2483- Slight updates to UC7 config and e2e notebook 2025-03-07 13:41:12 +00:00
Archer Bowen
6769bc917f Merge branch '4.0.0a1-dev' into UC7-migration 2025-03-07 13:41:12 +00:00
Marek Wolan
d8c8aa40a4 3086 UC7 Migration - All YAMLS, tests and notebooks. A few lingering issues such as the OS-SCAN not working and agent logs not appearing. 2025-03-07 13:40:50 +00:00
Marek Wolan
92af387e56 Remove buggy autoreload from notebook 2025-02-28 15:35:06 +00:00
Marek Wolan
75eb1050c9 Merged PR 621: Change acl observations to be less confusing
Related work items: #2869, #2887, #3029, #3060, #3062, #3075, #3089
2025-02-28 11:28:14 +00:00
Marek Wolan
5609dc8d07 Appease precommit 2025-02-28 11:13:23 +00:00
Archer Bowen
b7bc39ce1a Merged PR 610: #3087 - TAP001/003 Core Migration (No Tests & Notebook)
## Summary

This PR migrates the TAP003 and TAP001 agents into the core PrimAITE codebase. This choice was made in order to allow for the UC7 network to utilise the TAP agents.

### **This PR does NOT include the TAP tests and notebooks**

The TAP notebooks and tests are included in the #2925 feature.

### **This PR has a sister PR on the milpac repo which removes the TAP agents from milpac**

PR will also needs to be merged and all relevant branches must be updated.

## Test process

The changes made in this PR were preemptively merged into the UC7 migration branch to create the TAP tests & notebooks.

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

#3087 - TAP001/003 Added - **No tests or notebooks migrated**

Related work items: #3087
2025-02-28 09:09:14 +00:00
Charlie Crane
110fc9243f Merge in updates from dev 2025-02-27 18:21:43 +00:00
Charlie Crane
1f6f007941 Updates to documentation and inclusion of how-to guides 2025-02-27 18:16:45 +00:00
Archer Bowen
3b4fb2d27f #3087 Addressing docustring TODO's and a few minor spelling mistakes. 2025-02-27 14:03:18 +00:00