Skip to content

kangaroos-are-cool/directoryscanner

Repository files navigation

directoryscanner

Go Report Card Go CodeQL Go Reference GitHub license

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
  • Performance Improvements
  • Function to export findings to file

About

A go module for scanning directories for sensitive information (or anything you'd like really)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages