8000 Helpers · newdominic/faraday Wiki · GitHub
[go: up one dir, main page]
Skip to content

Helpers

Jump to bottom Edit New page
micabot edited this page Aug 18, 2016 · 19 revisions

In $FARADAY/helpers you can find several scripts developed to help you load and manage Faraday data. None of them are included as part of the Faraday core, and using them can usually mean deleting content from the database in a permanent way, so be careful when executing any of them and always make sure to have a fresh backup.

pushCwe.py

$ python helpers/pushCwe.py --help
usage: pushCwe [-h] [-c COUCHDB]

optional arguments:
  -h, --help            show this help message and exit
  -c COUCHDB, --couchdburi COUCHDB
                        Couchdb URL (default http://127.0.0.1:5984)

Example: ./pushCwe.py

This script allows you to upload your Vulnerability templates database to CouchDB. Read more about it here.

cfdbToCsv.py

This script allows you, create a CSV file with Vulnerability templates, based in Cfdb open source project. Read more about it here.

vulndbToCsv.py

This script allows you, create a CSV file with Vulnerability templates, based in Vulndb open source project. Read more about it here.

cleanXML.py

$ python helpers/cleanXML.py --help
usage: cleanXML [-h] -i INFILE [-o OUTFILE]

optional arguments:
  -h, --help            show this help message and exit
  -i INFILE, --input INFILE
                        XML File to read from
  -o OUTFILE, --output OUTFILE
                        Filename to write output

Example: ./cleanXML.py

Some tools are known for creating invalid XML output files which tend to be hard to fix by hand. If you want a quick way to patch an XML to feed it to Faraday for processing, this script is your best friend. Run it like this (make sure to have BeautifulSoup):

python $FARADAY/helpers/cleanXML.py broken_file.xml

removeBySeverity.py

$ python helpers/removeBySeverity.py --help
usage: removeBySeverity [-h] [-c COUCHDB] -d DB -s SEVERITY [-t] [-v]

optional arguments:
  -h, --help            show this help message and exit
  -c COUCHDB, --couchdburi COUCHDB
                        Couchdb URL as
                        http://user:password@couch_ip:couch_port (defaults to
                        http://127.0.0.1:5984)
  -d DB, --db DB        DB to process
  -s SEVERITY, --severity SEVERITY
                        Vulnerability severity
  -t, --test            Dry run, does everything except updating the DB
  -v, --verbose         Extended output

Example: ./removeBySeverity.py

Removes all vulnerabilities with selected severity. Faraday has 6 levels of severity defined from highest to lowest:

  • critical
  • high
  • med
  • low
  • info
  • unclassified
Add a custom footer

Clone this wiki locally
0