oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#1796: documentation

Browse Source
This commit is contained in:
Czar.Echavez
2023-09-28 14:09:32 +01:00
parent 6202d320a6
commit bca3e6344e
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@@ -27,6 +27,9 @@ SessionManager.
- File System - ability to emulate a node's file system during a simulation - File System - ability to emulate a node's file system during a simulation
- Example notebooks - There is currently 1 jupyter notebook which walks through using PrimAITE - Example notebooks - There is currently 1 jupyter notebook which walks through using PrimAITE
1. Creating a simulation - this notebook explains how to build up a simulation using the Python package. (WIP) 1. Creating a simulation - this notebook explains how to build up a simulation using the Python package. (WIP)
- Database:
- `DatabaseClient` and `DatabaseService` created to allow emulation of database actions
- Ability to `backup_database` and `restore_backup` for a `DatabaseService`
- Red Agent Services: - Red Agent Services:
- Data Manipulator Bot - A red agent service which sends a payload to a target machine. (By default this payload is a SQL query that breaks a database) - Data Manipulator Bot - A red agent service which sends a payload to a target machine. (By default this payload is a SQL query that breaks a database)
- DNS Services: `DNSClient` and `DNSServer` - DNS Services: `DNSClient` and `DNSServer`

6
docs/source/simulation_components/system/database_client_server.rst
View File

@@ -60,6 +60,12 @@ Usage
- Retrieve results in a dictionary. - Retrieve results in a dictionary.
- Disconnect when finished. - Disconnect when finished.
To create database backups:
- Configure the backup server the ``DatabaseService`` by providing the Backup server ``IPv4Address`` with ``configure_backup``
- Create a backup using ``backup_database``. This fails if the backup server is not configured.
- Restore a backup using ``restore_backup``. By default, this uses the database created via ``backup_database``.
Implementation Implementation
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^