From b7ea7dabd2a7a008f3621977bc1e3672260fe8d3 Mon Sep 17 00:00:00 2001 From: Mr RK <75608361+raviknox@users.noreply.github.com> Date: Fri, 14 Jun 2024 23:33:30 +0530 Subject: [PATCH] Update README.md Revised Command and Parameters --- nessus-job/README.md | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/nessus-job/README.md b/nessus-job/README.md index 3b29425..8e76d1a 100644 --- a/nessus-job/README.md +++ b/nessus-job/README.md @@ -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 | @@ -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.