History

Dan Puttick 3f49612a23 Add new logger, move logging to filecheck * Wrote a new text-based logger that displays all file information in the tree instead of using two separate logs * Stopped using twiggy since it wasn't giving us anything useful * Moved a lot of the logging code to filecheck, since it didn't really seem appropriate as an API. Left a Logging stub in kittengroomer to hold methods that might be useful for implementing other loggers. * For the new logger, had to change the way that we traverse the items in the source file tree.		2017-04-10 13:22:20 +02:00
..
README.md	Move non-filecheck.py binaries into examples directory	2017-01-19 15:25:08 -05:00
__init__.py	Do not use subprocess.	2015-10-27 10:24:45 +01:00
filecheck.py	Add new logger, move logging to filecheck	2017-04-10 13:22:20 +02:00

README.md

filecheck.py

This is the script used by the CIRCLean USB key sanitizer. It is designed to handle a range of file types, and will mark them as dangerous if they meet certain criteria.

Before installing the filecheck.py depenencies, make sure to install the PyCIRCLean dependencies:

    pip install .

Dependencies by type of document:

Microsoft office: oletools, olefile
OOXML: officedissector
PDF: pdfid
Archives: p7zip-full, p7zip-rar
Metadata: exifread
Images: pillow

Note: pdfid is a not installable with pip. It must be downloaded and installed manually in the directory where filecheck will be run.

    sudo apt-get install p7zip-full p7zip-rar libxml2-dev libxslt1-dev
    pip install lxml oletools olefile pillow exifread
    pip install git+https://github.com/Rafiot/officedissector.git
    # installing pdfid manually
    wget https://didierstevens.com/files/software/pdfid_v0_2_1.zip
    unzip pdfid_v0_2_1.zip