Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Revised Command and Parameters
  • Loading branch information
raviknox authored Jun 14, 2024
1 parent 3d71de7 commit b7ea7da
Showing 1 changed file with 11 additions and 19 deletions.
30 changes: 11 additions & 19 deletions nessus-job/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Nessus Data Exporter
Instruction to export Nessus Data to AccuKnox SaaS
Instruction to export Tenable Nessus Scan Data to AccuKnox SaaS.

### Prerequisites:
- Docker
- Parameters as env variable to get details from Nessus
- Parameters env variable to send details to AccuKnox SaaS

- [Docker](https://docs.docker.com/engine/install/)
- Parameters as docker environment variables to get scan file from [Tenable Nessus](https://www.tenable.com/products/nessus)
- Parameters as docker environment variables to send Nessus scan data to [AccuKnox](https://accuknox.com) SaaS

### Parameters:
| Variable | Sample Value | Description |
Expand All @@ -14,40 +13,33 @@ Instruction to export Nessus Data to AccuKnox SaaS
| folder_id | 4 | Nessus Folder ID |
| nessus_access_key | $access_key | Nessus Access Key |
| nessus_secret_key | $secret_key | Nessus Secret Key |
| k8s_job | false | This is required when ran outside SaaS |
| IS_ONPREM_DEPLOYMENT | true | This is required when run outside SaaS |
| CSPM_BASE_URL | https://cspm.demo.accuknox.com | AccuKnox CSPM API Endpoint |
| label | NESSUS | AccuKnox Label |
| label | $label | AccuKnox Label |
| internal_tenant_id | $tenant_id | AccuKnox Tenant ID |
| ARTIFACT_TOKEN | $token | AccuKnox Token |

> All variables are mandatory
## Steps to send details to SaaS:
1. Creating and Switching to `/tmp/nessus-output/` folder to store nessus file on local.
1. Creating and switching to `/tmp/nessus-output/` folder to store Nessus scan file locally.
```sh
mkdir -p /tmp/nessus-output/ && cd /tmp/nessus-output/
```

2. Getting Nessus data & Sending data to AccuKnox SaaS
2. Getting Nessus scan file & Sending data to AccuKnox SaaS
```bash
docker run --rm -it \
-e nessus_url=https://cloud.tenable.com \
-e folder_id=4 \
-e nessus_access_key=$access_key \
-e nessus_secret_key=$secret_key \
-e k8s_job=false \
-e IS_ONPREM_DEPLOYMENT=true \
-e CSPM_BASE_URL=https://cspm.demo.accuknox.com \
-e label=NESSUS \
-e label=$label \
-e internal_tenant_id=$tenant_id \
-e ARTIFACT_TOKEN=$token \
-v $PWD:/tmp/ \
accuknox/nessus:v1
```

> Note: If we don't want to store data inside `/tmp/nessus-output/` then step #1 can be skipped and from step #2 last 2nd like i.e., `-v $PWD:/tmp/ \` can be removed.
> Note: If we don't want to store data inside `/tmp/nessus-output/` then step #1 can be skipped and from step #2 last 2nd line i.e., `-v $PWD:/tmp/ \` can be removed.
### QnA:
- You might see a warning related to the Certificate, but this should not cause any issue
- If env variables are not correct, then this might not work correctly
### Note:
- All Docker environment variables are mandatory & case-sensitive.

0 comments on commit b7ea7da

Please sign in to comment.