README
¶
Scnnr
Scans files (by extension) in a given directory for a keyword. Can be any file, or can be just .js or .js,.html,.jsx.
Prints out a \n delimited string of each file (filepath in artifact) containing one of the keywords.
Max file descriptors is set to 1024 (linux default) in scnnr scn mode.
Examples
scn mode is the default
Help
Call scnnr with the -h flag:
$ scnnr -h
-d string
OPTIONAL Scnnr MODE
directory where scnnr will scan
default is current directory and all child directories (default ".")
-e string
OPTIONAL Scnnr MODE
a comma delimited list of file extensions to scan
if none are given all files will be searched
-f string
REQUIRED NameFinder MODE
fuzzy find the filename(s) contain(s) - can be comma delimited: Example 'wow' or 'wow,omg,lol'
-k string
OPTIONAL Scnnr MODE
a comma delimited list of characters to look for in a file
if no keywords are given - all file paths of given file extensions will be returned
if keywords are given - only filepaths of matches will be returned
-m string
OPTIONAL
mode that scnnr will run in
options are:
(scn) for scnnr
(fnf) for File/NameFinder
(fsf) for File/SizeFinder
ex: scnnr -d / -k password,token,authorization
ex: scnnr -m fsf -s 100MB -d E:/LotsOfStuff
ex: scnnr -m fnf -f DEFCON -p /tmp,/usr,/etc,$HOME/Documents
(default "scn")
-p string
REQUIRED NameFinder MODE
any absolute path - can be comma delimited: Example: $HOME or '/tmp,/usr'
-r OPTIONAL Scnnr MODE
if you want to use the regex engine or not
defaults to false and will not use the regex engine for scans unless set to a truthy value
truthy values are: 1, t, T, true, True, TRUE
falsy values are: 0, f, F, false, False, FALSE
-s string
REQUIRED SizeFinder MODE
size: 1MB,10MB,100MB,1GB,10GB,100GB,1TB
No Keywords
If you just want to scan for file paths
$ scnnr -e .md -d .
README.md
You can also use equal signs for the flags:
$ scnnr -e=.md -d=.
README.md
Do not provide any keywords and scnnr will return all given filepaths matching given extensions.
If no extensions are given, all filepaths will be returned in the scanned directory.
Single Keyword
Scan this repo for markdown files with the keyword cache= in them.
With quotes
$ scnnr -e ".md" -d "." -k "cache="
README.md
Without quotes (if no need to escape anything)
scnnr -e .md -d . -k cache=
Multiple Keywords and Multiple File Extensions
$ scnnr -d . -e .md,.go -k fileData,cache
README.md
cmd/scanner.go
File Name Finder (NameFinder) (fnf)
-p string
REQUIRED NameFinder MODE
any absolute path - can be comma delimited: Example: $HOME or '/tmp,/usr'
-f string
REQUIRED NameFinder MODE
fuzzy find the filename(s) contain(s) - can be comma delimited: Example 'wow' or 'wow,omg,lol'
Example use to search /tmp, /etc, /usr, and $HOME/Documents for filenames that contain:
- DEFCON
- Tax
- Return
- Finance
scnnr -m fnf -f DEFCON,Finance,Tax,Return -p /tmp,/usr,/etc,$HOME/Documents
File Size Finder (SizeFinder) (fsf)
-s string
REQUIRED SizeFinder MODE
size: 1MB,10MB,100MB,1GB,10GB,100GB,1TB
Example use to find any file over 100MB in E:/LotsOfStuff
scnnr -m fsf -s 100MB -d E:/LotsOfStuff
Back to Scnnr
Using the package github.com/selfup/scnnr/pkg
import (
scnnr "github.com/selfup/scnnr/pkg"
)
directory := "./artifact"
keywords := []string{"something","something else", "another thing"}
patterns := []string{".js",".go",".md"}
scanner := scnnr.Scanner{
Directory: directory,
FileExtensions: patterns,
Keywords: keywords,
}
err := scanner.Scan()
if err != nil {
log.Fatal(err)
}
Regex
Using Regex Patterns
scnnr -e ".js" -d "artifact" -k "cons?" -r T > .results
According to the godoc for flag.BoolVar you can use a few things for boolean flag values:
t, T, 1, true, True, TRUE
scnnr $ time scnnr -r 1 -d artifact -e .js,.ts,.md -k 'cons*,let?,var?, impor*, expor*' > .results
real 0m0.748s
user 0m2.398s
sys 0m0.311s
Using the package github.com/selfup/scnnr/pkg
import (
scnnr "github.com/selfup/scnnr/pkg"
)
rgx := true
directory := "./artifact"
keywords := []string{"const PASSW*","password?", "export PASS?"}
extensions := []string{".js",".ts"}
scanner := scnnr.Scanner{
Regex: rgx,
Directory: directory,
FileExtensions: extensions,
Keywords: keywords,
}
err := scanner.Scan()
if err != nil {
log.Fatal(err)
}
Install
If you have Go
go install github.com/selfup/scnnr@latest
If you do not have Go
Release Binaries
I have a GitLab Release Repo that builds the needed artifacts using GitLabCI
Direct Download Link
https://gitlab.com/selfup/scnnr/-/jobs/artifacts/master/download?job=release
cURL
curl -L https://gitlab.com/selfup/scnnr/-/jobs/artifacts/master/download?job=release > artifacts.zip
wget
wget https://gitlab.com/selfup/scnnr/-/jobs/artifacts/master/download?job=release -O artifacts.zip
the sha256 sum is provided in the artifact zip of the scnnr_bins.zip
you can also verify the provided sum matches the output in CI (output for verification)
- Unzip
artifacts.zip - Unzip
scnnr_bins.zip
From here pick your arch (mac/windows/linux) and appropriate binary and move to needed path!
scnnr_bins/linux:
scnnr
scnnr_bins/mac:
scnnr
scnnr_bins/windows:
scnnr.exe
Docker
-
Clone repo:
git clone https://github.com/selfup/scnnr -
cdinto repo- Shell:
./scripts/dind.build.sh - Powershell:
./scripts/dind.build.ps1
- Shell:
-
Unzip
scnnr_bins.zip
From here pick your arch (mac/windows/linux) and appropriate binary and move to needed path!
scnnr_bins/linux:
scnnr
scnnr_bins/mac:
scnnr
scnnr_bins/windows:
scnnr.exe
Performance (scn)
I will add perf numbers for fnf and fsf modes soon!
Use of goroutines, buffers, streams, mutexes, and simple checks.
Memory in the following example never went above 5.5MB for the entire program.
No matches on 33k files after npm i for a JavaScript project as the artifact:
$ time scnnr -d artifact -e .kt -k cache
real 0m0.121s
user 0m0.053s
sys 0m0.076s
33k files, two file types, one keyword, and 567 matches:
$ time scnnr -d artifact -e .md,.js -k cache > .results
real 0m0.232s
user 0m0.574s
sys 0m0.210s
$ ls -lahg .results
-rw-r--r-- 1 selfup 33K Jul 21 00:55 .results
33k files, two file types, 5 keywords, and 360 matches:
$ time scnnr -d artifact -e .js,.md -k stuff,things,wow,lol,omg > .results
real 0m0.266s
user 0m0.813s
sys 0m0.174s
$ ls -lahg .results
-rw-r--r-- 1 selfup 22K Jul 21 00:53 .results
33k files, 4 file types, 5 common keywords, and 18866 matches:
Results are piped into a file to reduce noise.
The amount of file paths results in 1.2MB of text data..
$ time scnnr -d artifact -e .js,.ts,.md,.css -k const,let,var,import,export > .results
real 0m0.344s
user 0m0.755s
sys 0m0.351s
$ ls -lahg .results
-rw-r--r-- 1 selfup 1.2M Jul 21 00:57 .results
Documentation
¶
There is no documentation for this package.
Source Files
Directories