diff --git a/_modules/index.html b/_modules/index.html index 98d3047..2825093 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -8,7 +8,7 @@ -
usage: parsedmarc [-h] [--strip-attachment-payloads] [-o OUTPUT]
- [-n NAMESERVERS [NAMESERVERS ...]] [-t TIMEOUT] [-H HOST]
- [-u USER] [-p PASSWORD] [--imap-port IMAP_PORT]
- [--imap-skip-certificate-verification] [--imap-no-ssl]
- [-r REPORTS_FOLDER] [-a ARCHIVE_FOLDER] [-d]
- [-E [ELASTICSEARCH_HOST [ELASTICSEARCH_HOST ...]]]
- [--elasticsearch-index-suffix ELASTICSEARCH_INDEX_SUFFIX]
- [--hec HEC] [--hec-token HEC_TOKEN] [--hec-index HEC_INDEX]
- [--hec-skip-certificate-verification]
- [-K [KAFKA_HOSTS [KAFKA_HOSTS ...]]]
- [--kafka-username KAFKA_USERNAME]
- [--kafka-password KAFKA_PASSWORD] [--kafka-use-ssl]
- [--kafka-aggregate-topic KAFKA_AGGREGATE_TOPIC]
- [--kafka-forensic_topic KAFKA_FORENSIC_TOPIC]
- [--save-aggregate] [--save-forensic] [-O OUTGOING_HOST]
- [-U OUTGOING_USER] [-P OUTGOING_PASSWORD]
- [--outgoing-port OUTGOING_PORT]
- [--outgoing-ssl OUTGOING_SSL] [-F OUTGOING_FROM]
- [-T OUTGOING_TO [OUTGOING_TO ...]] [-S OUTGOING_SUBJECT]
- [-A OUTGOING_ATTACHMENT] [-M OUTGOING_MESSAGE] [-w] [--test]
- [-s] [--debug] [-v]
- [file_path [file_path ...]]
+ [-n NAMESERVERS [NAMESERVERS ...]] [-t TIMEOUT] [-H HOST]
+ [-u USER] [-p PASSWORD] [--imap-port IMAP_PORT]
+ [--imap-skip-certificate-verification] [--imap-no-ssl]
+ [-r REPORTS_FOLDER] [-a ARCHIVE_FOLDER] [-d]
+ [-E [ELASTICSEARCH_HOST [ELASTICSEARCH_HOST ...]]]
+ [--elasticsearch-index-suffix ELASTICSEARCH_INDEX_SUFFIX]
+ [--elasticsearch-use-ssl]
+ [--elasticsearch-ssl-cert-path ELASTICSEARCH_SSL_CERT_PATH]
+ [--elasticsearch-monthly-indexes] [--hec HEC]
+ [--hec-token HEC_TOKEN] [--hec-index HEC_INDEX]
+ [--hec-skip-certificate-verification]
+ [-K [KAFKA_HOSTS [KAFKA_HOSTS ...]]]
+ [--kafka-username KAFKA_USERNAME]
+ [--kafka-password KAFKA_PASSWORD] [--kafka-use-ssl]
+ [--kafka-aggregate-topic KAFKA_AGGREGATE_TOPIC]
+ [--kafka-forensic_topic KAFKA_FORENSIC_TOPIC]
+ [--save-aggregate] [--save-forensic] [-O OUTGOING_HOST]
+ [-U OUTGOING_USER] [-P OUTGOING_PASSWORD]
+ [--outgoing-port OUTGOING_PORT]
+ [--outgoing-ssl OUTGOING_SSL] [-F OUTGOING_FROM]
+ [-T OUTGOING_TO [OUTGOING_TO ...]] [-S OUTGOING_SUBJECT]
+ [-A OUTGOING_ATTACHMENT] [-M OUTGOING_MESSAGE] [-w] [--test]
+ [-s] [--debug] [--log-file LOG_FILE] [-v]
+ [file_path [file_path ...]]
Parses DMARC reports
@@ -307,6 +310,13 @@ lookalike domain monitoring, check out --elasticsearch-index-suffix ELASTICSEARCH_INDEX_SUFFIX
append this suffix to the dmarc_aggregate and
dmarc_forensic Elasticsearch index names, joined by _
+ --elasticsearch-use-ssl
+ Use SSL when connecting to Elasticsearch
+ --elasticsearch-ssl-cert-path ELASTICSEARCH_SSL_CERT_PATH
+ Path to the Elasticsearch SSL certificate
+ --elasticsearch-monthly-indexes
+ Use monthly Elasticsearch indexes instead of daily
+ indexes
--hec HEC the URL to a Splunk HTTP Event Collector (HEC)
--hec-token HEC_TOKEN
the authorization token for a Splunk HTTP Event
@@ -317,7 +327,7 @@ lookalike domain monitoring, check out --hec-skip-certificate-verification
skip certificate verification for Splunk HEC
-K [KAFKA_HOSTS [KAFKA_HOSTS ...]], --kafka-hosts [KAFKA_HOSTS [KAFKA_HOSTS ...]]
- s list of one or more Kafka hostnames
+ a list of one or more Kafka hostnames
--kafka-username KAFKA_USERNAME
an optional Kafka username
--kafka-password KAFKA_PASSWORD
@@ -358,6 +368,7 @@ lookalike domain monitoring, check out --test do not move or delete IMAP messages
-s, --silent only print errors and warnings
--debug print debugging information
+ --log-file LOG_FILE output logging to a file
-v, --version show program's version number and exit
For the best possible processing speed, consider using parsedmarc inside a pypy3
-virtualenv. First, download the latest version of pypy3. Extract it to
+virtualenv. First, download the latest portable Linux version of pypy3. Extract it to
/opt/pypy3 (sudo mkdir /opt if /opt does not exist), then create a
symlink:
sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
+wget https://bitbucket.org/squeaky/portable-pypy/downloads/pypy3.5-6.0.0-linux_x86_64-portable.tar.bz2
+tar -jxf pypy3.5-6.0.0-linux_x86_64-portable.tar.bz2
+rm pypy3.5-6.0.0-linux_x86_64-portable.tar.bz2
+sudo chown -R root:root pypy3.5-6.0.0-linux_x86_64-portable
+sudo mv pypy3.5-6.0.0-linux_x86_64-portable /opt/pypy3
+sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
Install virtualenv on your system:
@@ -1673,7 +1689,7 @@ to a callback function
parsedmarc.elastic.save_aggregate_report_to_elasticsearch(aggregate_report, index_suffix=None)[source]¶parsedmarc.elastic.save_aggregate_report_to_elasticsearch(aggregate_report, index_suffix=None, monthly_indexes=False)[source]¶
Saves a parsed DMARC aggregate report to ElasticSearch
| Parameters: |
|
|---|
| Parameters: |
|
|---|
| Parameters: | hosts – A single hostname or URL, or list of hostnames or URLs | +
|---|---|
| Parameters: |
|