README
¶
pii
Description
pii is a small library and command line utility that aims to make detecting PII a little easier for security analysts by doing the following:
- Attempts to standardize well-known PII regular expressions to avoid discrepencies
- Allows the creation of combinatorial logic around multiple regular expressions for more granularity
- Proccesses files in parallel, giving performance enhancements over Python / Ruby / etc.
- Is written as a library allowing for easy integration into existing Go tools
The tool is very much evolving as people contribute. This is one of those tools that should get better over time as improvements are made and the patterns are tuned even further.
Installation
go get github.com/gen0cide/pii/cmd/pii
Usage
pii search foo.txt
Options
pii -j/--jsonwill output the data in JSON format.pii search --find-matcheswill attempt to extract the findings from the files (expirimental)
Contact
Twitter: @alexlevinson
Slack: LOTR Slack (gandalf, #pii)
Documentation
¶
Index ¶
- type Matcher
- func Address() Matcher
- func All(funcs ...Matcher) Matcher
- func And(a, b Matcher) Matcher
- func Any(funcs ...Matcher) Matcher
- func AtLeastN(n int, funcs ...Matcher) Matcher
- func BankInfo() Matcher
- func CreditCard() Matcher
- func Email() Matcher
- func HaltLangDetect() Matcher
- func IP() Matcher
- func Link() Matcher
- func Not(f Matcher) Matcher
- func Or(a, b Matcher) Matcher
- func Phone() Matcher
- func SSN() Matcher
- func UUID() Matcher
- func VIN() Matcher
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Matcher ¶
Matcher is an evaluation type
func Address ¶
func Address() Matcher
Address returns a matcher for identifying street address, po boxes, and zip codes
func BankInfo ¶
func BankInfo() Matcher
BankInfo returns a matcher for identifying either IBANs or US Routing #s
func CreditCard ¶
func CreditCard() Matcher
CreditCard returns a matcher for identifying major credit card numbers
func HaltLangDetect ¶
func HaltLangDetect() Matcher
HaltLangDetect is a special matcher for preventing language detection from running
func Link ¶
func Link() Matcher
Link returns a matcher for identifying URLs and links that are not emails
Source Files