https://github.com/kangaroos-are-cool/directoryscanner

A go module for scanning directories for sensitive information (or anything you'd like really)
https://github.com/kangaroos-are-cool/directoryscanner

gathering go golang information infosec pii regex scanning sensitive

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kangaroos-are-cool/directoryscanner
• Owner: kangaroos-are-cool
• License: mit
• Created: 2020-12-26T20:16:15.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-03T21:21:57.000Z (about 4 years ago)
• Last Synced: 2024-08-03T23:28:42.859Z (6 months ago)
• Topics: gathering, go, golang, information, infosec, pii, regex, scanning, sensitive
• Language: Go
• Homepage:
• Size: 50.8 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - directoryscanner

README

        
# directoryscanner

[![Go Report Card](https://goreportcard.com/badge/github.com/audrey-morrisette/directoryscanner)](https://goreportcard.com/report/github.com/audrey-morrisette/directoryscanner) ![Go](https://github.com/audrey-morrisette/directoryscanner/workflows/Go/badge.svg) ![CodeQL](https://github.com/audrey-morrisette/directoryscanner/workflows/CodeQL/badge.svg?branch=main) [![Go Reference](https://pkg.go.dev/badge/github.com/audrey-morrisette/directoryscanner.svg)](https://pkg.go.dev/github.com/audrey-morrisette/directoryscanner) [![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/Naereen/StrapDown.js/blob/master/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:

- [x] Add simpler way to add new items to scan for

- [x] Improve Documentation

- [x] Add ability to scan .zip

- [ ] Performance Improvements

- [ ] Function to export findings to file