Skip to content

Commit

Permalink
Merge pull request #106 from cisagov/sync-with-internal-repo
Browse files Browse the repository at this point in the history
Sync with internal repo
  • Loading branch information
karendm authored Dec 5, 2023
2 parents 98ef817 + 80fb04c commit b96ce1d
Show file tree
Hide file tree
Showing 61 changed files with 19,594 additions and 13,215 deletions.
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,12 @@ This is a development version, so includes source code with docker images. In fu
- [Restore Offline](#restore-offline)
- [Other Functions](#other-functions)
- [Create a Superuser](#create-superuser)
- [Change Password](#change-password)
- [Reset Login Attempts](#reset-attempts)
- [View Logs](#view-logs)
- [Connect to Shell](#connect-shell)
- [Pause](#pause)
- [Resume](#resume)
- [Tear Down](#tear-down)
- [Development Guide](#development-guide)
- [Setup (Development)](#development-setup)
Expand Down Expand Up @@ -96,7 +100,7 @@ Once `python` is successfully installed, run the following command to verify tha
## Getting Started

```bash
> git clone https://github.com/cisagov/assessment-reporting-engine.git
> git clone https://github.com/asmtlab/assessment-reporting-engine.git
> cd assessment-reporting-engine
```

Expand All @@ -106,7 +110,7 @@ Once `python` is successfully installed, run the following command to verify tha

A python3 script ptp.py is included to automate various functions, including the set up, backup, restore, and tear down processes. In order to use the ptp.py script and set up RE, the following dependencies must be met (in addition to the prerequisites outlined in the previous section). Note that RE has only been tested with the following dependency versions and may not function correctly with other versions.

#### Node v18.13.x and NPM v9.2.x
#### Node v18.x.x and NPM v9.x.x

Any alternate versions of Node and NPM that may be running on the system where RE is being installed could conflict with RE set up. For that reason, it is recommended to purge any existing versions of Node and NPM if they are not needed. The following command will install Node and NPM:

Expand Down Expand Up @@ -239,7 +243,7 @@ Once the above requirements are met, the following commands can be run from the
> docker load < web.tar
> docker load < nginx.tar
> docker load < db.tar
> python3 ptp.py restore -r [FAST/RPT/RVA] -b [/path/to/backup.zip]
> python3 ptp.py restore -r [FAST/RPT/RVA] -b [/path/to/backup.zip] -c offline
```

<a name='other-functions'></a>
Expand All @@ -256,6 +260,26 @@ During set up, you will automatically be prompted to create a superuser. Once th
> python3 ptp.py su
```

<a name='change-password'></a>

### Change Password

The password for an existing account can be changed by running the following command (user will be prompted to set a new password for the user):

```bash
> python3 ptp.py password -u [username]
```

<a name='reset-attempts'></a>

### Reset Login Attempts

An account will be locked out after three failed attempts to prevent brute-force password attacks. The attempt count for all accounts can be reset by running the following command:

```bash
> python3 ptp.py reset
```

<a name='view-logs'></a>

### View Logs
Expand All @@ -276,6 +300,26 @@ To connect to a shell for a particular container, use the following command (be
> python3 ptp.py shell -c [db/nginx/web]
```

<a name='pause'></a>

### Pause

To pause an instance of Reporting Engine, run the following command (be sure to back up the instance first):

```bash
> python3 ptp.py pause
```

<a name='resume'></a>

### Resume

To resume a paused instance of Reporting Engine, run the following command:

```bash
> python3 ptp.py resume
```

<a name='tear-down'></a>

### Tear Down
Expand Down Expand Up @@ -332,4 +376,4 @@ In the current version, collaborating on the same screen as another user is not

## Troubleshooting

It is recommended to refer to Docker and Django documentation for troubleshooting guidance. This section will be updated at a later time to reflect common issues.
It is recommended to refer to Docker and Django documentation for troubleshooting guidance. This section will be updated at a later time to reflect common issues.
Binary file modified assets/Penetration Testing Findings Repository 1.0.xlsx
Binary file not shown.
22,701 changes: 12,584 additions & 10,117 deletions assets/known_exploited_vulnerabilities.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/narrative-tools.csv
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ PyWhisker,https://github.com/ShutdownRepo/pywhisker
RainbowCrack,https://www.kali.org/tools/rainbowcrack/
Reaver,https://www.kali.org/tools/reaver/
Recon-ng,https://www.kali.org/tools/recon-ng/
Responder,https://github.com/SpiderLabs/Responder
Responder,https://github.com/lgandx/Responder
Rubeus,https://github.com/GhostPack/Rubeus
SET,https://www.kali.org/tools/set/
SIET,https://github.com/frostbits-security/SIET
Expand Down
3 changes: 2 additions & 1 deletion assets/security-solutions.csv
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Cybereason
Cylance Endpoint Security
Cynet Next-Gen Antivirus (NGAV)
CYREN AntiVirus
Elastic Security
ESET-NOD32
F-Secure
FireEye Endpoint Security
Fortinet
HP Wolf Security
Expand All @@ -38,4 +38,5 @@ Symantec Endpoint Security
Trellix
Trend Micro
Webroot
WithSecure
Vipre
2 changes: 1 addition & 1 deletion docker/dev/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ gunicorn==19.9.0
inflect==4.1.0
openpyxl==3.0.7
pandas==2.0.0
Pillow==9.3.0
Pillow==10.0.1
psycopg2-binary==2.9.4
python-docx==0.8.10
python-pptx==0.6.18
Expand Down
2 changes: 1 addition & 1 deletion docker/prod/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ gunicorn==19.9.0
inflect==4.1.0
openpyxl==3.0.7
pandas==2.0.0
Pillow==9.3.0
Pillow==10.0.1
psycopg2-binary==2.9.4
python-docx==0.8.10
python-pptx==0.6.18
Expand Down
7 changes: 7 additions & 0 deletions help_templates/payloads.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Description,Protocol,Host,Border
Linked x64 EXE (Cobalt Strike),HTTPS,N,B
Linked EXE Embedded HTA (Cobalt Strike),HTTPS,B,N
Linked VBA Embedded HTA (Cobalt Strike),HTTPS,N,B
Linked PowerShell HTA (Cobalt Strike),HTTPS,B,N
Linked PowerShell HTA (Obfuscated via MorphHTA),HTTPS,N,N
Linked C# HTA Embedded in HTML (SharpShooter),HTTPS,B,B
8 changes: 4 additions & 4 deletions pentestportal/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

# Application definition

VERSION_NUMBER = "2.0.4 alpha"
VERSION_NUMBER = "2.0.5"

INSTALLED_APPS = [
"django.contrib.admin",
Expand Down Expand Up @@ -77,7 +77,7 @@
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
"ptportal.middleware.LoginRequiredMiddleware",
"axes.middleware.AxesMiddleware"
"axes.middleware.AxesMiddleware",
# 'debug_toolbar.middleware.DebugToolbarMiddleware',
]
AXES_FAILURE_LIMIT = 5
Expand Down Expand Up @@ -156,7 +156,7 @@

LANGUAGE_CODE = "en-us"

TIME_ZONE = "US/Eastern"
TIME_ZONE = "UTC"

USE_I18N = True

Expand Down Expand Up @@ -193,4 +193,4 @@

INTERNAL_IPS = ["*"]

DBBACKUP_STORAGE = "django.core.files.storage.FileSystemStorage"
DBBACKUP_STORAGE = "django.core.files.storage.FileSystemStorage"
Loading

0 comments on commit b96ce1d

Please sign in to comment.