Update configs and readme

Author: Daniel Jimenez

README.md

@@ -78,12 +78,18 @@ Those are the variables you have to use:
 |PG_PORT|Database port|5432|
 |PG_SSLMODE|One of these (disable,allow,prefer,require,verify-ca,verify-full)|disable|
 |PG_CA_B64|A base64 encoded CA certificate||
-|SQS_QUEUE_ARN|Checks queueu ARN|arn:aws:sqs:xxx:123456789012:yyy|
-|SNS_TOPIC_ARN|ARN of topic to publish new vulnerabilities|arn:aws:sns:xxx:123456789012:yyy|
 |RESULTS_URL|External vulcan-results URL|https://results.vulcan.com|
 |RESULTS_INTERNAL_URL|Internal vulcan-results URL|http://vulcan-results|
+|SQS_QUEUE_ARN|Checks queueu ARN|arn:aws:sqs:xxx:123456789012:yyy|
 |AWS_SQS_ENDPOINT|Endpoint for SQS creation queue (optional)|http://custom-aws-endpoint|
+|SNS_ENABLED|Enables/Disables notifications sent to SNS|false|
+|SNS_TOPIC_ARN|ARN of topic to publish new vulnerabilities|arn:aws:sns:xxx:123456789012:yyy|
 |AWS_SNS_ENDPOINT|Endpoint for SNS topic (optional)|http://custom-aws-endpoint|
+|KAFKA_ENABLED|Enables/Disables notifications sent to Kafka|false|
+|KAFKA_USER|Kafka user||
+|KAFKA_PASSWORD|Kafka password||
+|KAFKA_BROKER_URL|Kafka Broker URL|localhost:9092|
+|KAFKA_TOPIC|Kafka topic|findings|
 
 ```bash
 docker build . -t vdb

_resources/config/local.toml.example

@@ -18,12 +18,11 @@ timeout = 30
 queue_arn = "arn:aws:sqs:xxx:123456789012:yyy"
 
 [sns]
-enabled = "false"
+enabled = false
 topic_arn = "arn:aws:sns:xxx:123456789012:yyy"
-enabled = true
 
 [kafka]
-enabled = "false"
+enabled = false
 user = "user"
 password = "password"
 broker_url = "localhost:9092"

config.toml

@@ -22,10 +22,17 @@ queue_arn = "$SQS_QUEUE_ARN"
 endpoint = "$AWS_SQS_ENDPOINT"
 
 [sns]
+enabled = $SNS_ENABLED
 topic_arn = "$SNS_TOPIC_ARN"
-enabled = true
 endpoint = "$AWS_SNS_ENDPOINT"
 
+[kafka]
+enabled = $KAFKA_ENABLED
+user = "$KAFKA_USER"
+password = "$KAFKA_PASSWORD"
+broker_url = "$KAFKA_BROKER_URL"
+topic = "$KAFKA_TOPIC"
+
 [report]
 url_replace = "$RESULTS_URL|$RESULTS_INTERNAL_URL"
 

local.env.example

@@ -10,9 +10,17 @@ PG_SSLMODE=disable
 PG_NAME=vulndb
 
 SQS_QUEUE_ARN=arn:aws:sqs:xxx:123456789012:yyy
-SNS_TOPIC_ARN=arn:aws:sns:xxx:123456789012:yyy
 AWS_SQS_ENDPOINT=
+
+SNS_ENABLED=false
+SNS_TOPIC_ARN=arn:aws:sns:xxx:123456789012:yyy
 AWS_SNS_ENDPOINT=
 
+KAFKA_ENABLED=false
+KAFKA_USER=
+KAFKA_PASSWORD=
+KAFKA_BROKER_URL=localhost:29092
+KAFKA_TOPIC=findings
+
 RESULTS_URL=http://vulcan-results
 RESULTS_INTERNAL_URL=http://vulcan-results