directoryscanner

README

directoryscanner

A simple go module for scanning directories for sensitive information (or really anything you want)

How to Use

import(
    ds "github.com/audrey-morrisette/directoryscanner"
    ...
)
...
results, err := ds.Scan(".")
for _, result := range results{
    fmt.Println(result)
}

Scan(path string)
returns a slice of strings containing all findings from the given directory

Find(path string, dataTypes ...string)
returns a slice of strings containing all the findings specified by the variadic parameter 'dataTypes'

FindString(path string, strings ...string)
returns a slice of strings containing all findings as specified by the variadic parameter 'strings' which can contain any string you like

TODO:

• Add simpler way to add new items to scan for
• Improve Documentation
• Add ability to scan .zip
• Add ability to scan .rar files
• Performance Improvements
• Function to export findings to file

Documentation

Overview

Package directoryscanner provides simple directory scanning functionality for sensitive data, or for any other string/regex you want

Index

• func Find(path string, dataTypes ...string) ([]string, error)
• func FindString(path string, strings ...string) ([]string, error)
• func Scan(path string) ([]string, error)

Functions

func Find

func Find(path string, dataTypes ...string) ([]string, error)

Find ... begins at the specified path (path) and recursively searches all directories acceptable arguments for variatic function: "Credit Card", "SSN", "Word Password", "Word Username", "Email"

func FindString

func FindString(path string, strings ...string) ([]string, error)

FindString ... Finds in the directory "path" all files and locations within those files containing any of the strings contained within the variadic parameter "strings"

func Scan

func Scan(path string) ([]string, error)

Scan ... begins at the specified path (path) and recursively searches all directories for PII