Skip to content
This repository has been archived by the owner. It is now read-only.
DEPRECATED. Replaced with Electron desktop application: https://github.com/bulk-reviewer/bulk-reviewer
Python Vue HTML JavaScript Dockerfile Shell CSS
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
docs
nginx
server
.gitignore
.travis.yml
LICENSE
README.md
docker-compose.test.yml
docker-compose.yml
init_default.sh
tox.ini

README.md

Bulk Reviewer logo

Identify, review, and remove sensitive files.

Build Status

Note: This project has been deprecated in favor of an Electron desktop application. For the actively developed and maintained project, see: Bulk Reviewer desktop application

Bulk Reviewer is a software program that aids in identification, review, and removal of sensitive files in directories and disk images. Bulk Reviewer scans directories and disk images for personally identifiable information (PII) and other sensitive information using bulk_extractor, a best-in-class digital forensics tool, and can optionally extract named entities (personal names as well as nationalities, religions, and political affiliations) using spaCy and Apache Tika. A browser application enables users to configure, start, and review scans, generate reports, and export files, separating problematic files (e.g., those requiring redaction or further review) from those that are free of sensitive information.

Bulk Reviewer consists of two separate applications that communicate via websockets and a REST API:

Currently, Bulk Reviewer can scan directories and disk images for:

  • Social Security Numbers (SSNs)
  • Credit card numbers
  • Email addresses
  • Phone numbers
  • URLs, web domains, RFC822 headers, and HTTP logs
  • GPS data
  • EXIF metadata
  • Personal names
  • Names of nationalities, religions, and political affiliations
  • User-supplied regular expressions

Scanners planned but not yet implemented include:

  • Canadian Social Insurance Number (SIN) and other national identifiers
  • Banking information
  • Personal health information
  • Facebook and Outlook data
  • Additional lexicons (like those developed by the ePADD project team)

Contributions are welcome!

Initial development of Bulk Reviewer occurred while the author, Tim Walsh, was a 2018 Summer Fellow at the Library Innovation Lab at Harvard University. The application is designed to aid archivists and librarians in processing and providing access to digital collections but may be useful in other domains as well. The application is currently under active development, and is still in the exploratory/prototype phase.

Interested in getting involved? Get in touch!

Development installation

Requires Docker CE, Docker-Compose, and Vue CLI 3.

Minimum resources required to be allocated to Docker for development (higher specs are recommended; bulk_extractor performance will increase linearly with additional CPUs, spaCy NLP performance will increase with additional RAM):

  • 2 CPUs
  • 8 GB RAM

Clone repository to local machine

git clone https://github.com/timothyryanwalsh/bulk-reviewer.git
cd bulk-reviewer

Set environment variables

bash init-default.sh

This script copies server/br_sample.env to br.env, which is used to set environment variables for Django and Postgres. To modify the values for the Postgres database name, username, and password, change the appropriate values in the resulting br.env file prior to starting the Docker containers.

Configure docker-compose volumes

The current configuration for sharing data between the host development machine and the server and worker Docker containers assumes a macOS development environment. Development in Linux or Windows may require changing the volume configuration to be appropriate for the local machine:

- /Users:/Users
- /Volumes:/Volumes

These two volumes are used only for giving the worker and server containers access to data to scan with bulk_extractor. For development on Linux or Windows, change these two volumes for the worker and server containers in docker-compose.yml to appropriate values such as - /home:/home (Linux) or - C:\Users:/Users (Windows) - this will determine which directories/files are accessible to Bulk Reviewer from the host machine.

Start containers

docker-compose up -d

The first time you do this, it will take a while (on my laptop, around 10 minutes). Much of this time is spent installing dependencies for and then building bulk_extractor.

Start frontend development server

cd client

Install node_modules (required first time only):

npm install

Start webpack dev server:

npm run serve

Open application in browser

Open 127.0.0.1:8080 in your browser (any recent version of Firefox or Chrome).

Tox

To run Tox/flake8 locally, create a /usr/share/bulk_extractor (Linux) or /usr/local/share/bulk_extractor (macOS) directory and move the helper scripts in the server/bulk_extractor directory into it. This will place required Python DFXML libraries into their expected paths; otherwise you may encounter module import errors.

License

Bulk Reviewer is distributed under the GNU Affero General Public License v3.0. See the LICENSE file for additional details.

Bulk Reviewer packages open source software developed by third parties. Licenses and attributions are retained here where applicable. Notable open source software included or packaged with Bulk Reviewer for convenience and to maintain stable download URLs for builds include:

  • bulk_extractor, as well as scripts and stoplists from the DFXML and bulk_extractor Github repositories. Public domain, developed by Simson Garfinkel as a United States government employee.
  • Apache Tika 1.20 jar. Copyright 2011 The Apache Software Foundation. The executable file is used here in accordance with the Apache License, Version 2.0 and the Apache Tika Github repository's notice.
  • spaCy. Copyright (C) 2016 ExplosionAI UG (haftungsbeschränkt), 2016 spaCy GmbH, 2015 Matthew Honnibal. Released under the MIT License.

Logo design

Bailey McGinn

You can’t perform that action at this time.