Git Product home page Git Product logo

pdscan's Introduction

pdscan

Scan your data stores for unencrypted personal data (PII)

  • Last names
  • Email addresses
  • IP addresses
  • Street addresses (US)
  • Phone numbers (US)
  • Credit card numbers
  • Social security numbers
  • Dates of birth
  • Location data
  • OAuth tokens

Uses data sampling and naming, and works with compressed files

💥 Zero runtime dependencies and minimal database load

Build Status

Installation

Download the latest version.

Unzip and follow the instructions below for your data store.

On Mac, you can also use:

brew install ankane/brew/pdscan

Data Stores

Files

pdscan file://path/to/file.txt

You can also specify a directory.

pdscan file://path/to/directory

For absolute paths, use file:///.

MySQL & MariaDB

pdscan mysql://user:pass@host:3306/dbname

Postgres

pdscan postgres://user:pass@host:5432/dbname

If your connection doesn’t use SSL, append to the URI:

?sslmode=disable

For best sampling, enable the tsm_system_rows extension (ships with Postgres 9.5+).

CREATE EXTENSION tsm_system_rows;

SQLite

pdscan sqlite:/path/to/dbname.sqlite3

S3

pdscan s3://bucket/path/to/file.txt

Requires s3:GetObject permission

You can also specify a prefix by ending with a /.

pdscan s3://bucket/path/to/directory/

Requires s3:ListBucket and s3:GetObject permissions

Others

Feel free to submit a PR

Options

Show data found

pdscan --show-data

Show low confidence matches

pdscan --show-all

Change sample size

pdscan --sample-size 50000

Specify number of processes to use (defaults to 1)

pdscan --processes 4

Roadmap

  • Add more data stores (SQL Server, MongoDB, Elasticsearch, Memcached, Redis)
  • Improve rules
  • Highlight matches
  • Add more output formats, like JSON and CSV

History

View the changelog

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

To get started with development:

git clone https://github.com/ankane/pdscan.git
cd pdscan
make test

pdscan's People

Contributors

ankane avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.