Skip Menu

Return to Skip Menu

Main Content

Find_SSNs Reference Manual

 

NAME

Find_SSNs - Search files for U.S. Social Security numbers and/or Credit Card numbers.

SYNOPSIS

1. python Find_SSNs.pyw | Find_SSNs.exe

2. python Find_SSNs.pyw -p /path/to/search -o /path/to/output/folder -t html|csv [-a | -c | -s] Find_SSNs.exe -p c:\path\to\search -o c:\path\to\output\folder -t html|csv [-a | -c | -s]

DESCRIPTION

In the first synopsis form, Find_SSNs would attempt to execute in GUI mode. In source form, GUI mode requires Python 2.4 through 2.6 and wxPython.

In the second synopsis form, Find_SSNs would attempt to execute in non-GUI mode. In source form, non-GUI mode requires Python 2.4 through 2.6.

The windows binary Find_SSNs.exe is standalone. It does not require Python or wxPython to execute.

The options are as follows. The options only apply to non-GUI mode:

-p The path to the directory to be searched. The path will be searched recursively.

-o The path to the directory that will contain Find_SSNs output files. See OUTPUT FILES section for more information.

-t Type of main report file you would like Find_SSNs to produce. Only html or csv are supported. Introduced in version 4.1. If you are using an earlier version, omit this option.

-a Search files for both U.S. Social Security numbers and Credit Card numbers.

-c Search files only for Credit Card numbers.

-s Search files only for U.S. Social Security numbers.

The options must be specified in the exact order as they appear.

CONFIG FILES

CONFIG FILES are optional. If used, they must be located in the same directory as Find_SSNs.

skip_files.txt This file can be used to skip certain file names. It does not skip file paths. It skips file names. For example, if the file name 'test.txt' is in this file, then any file named 'test.txt' encountered in the search path would be excluded from the search. Each time a file name is skipped, a log entry is sent to '.Find_SSNs_skip.txt'. Enter one file name per line into this file.

skip_folders.txt Same as 'skip_files.txt' except folder names are skipped.

skip_extensions.txt Same as 'skip_files.txt' except files extensions are skipped.

skip_numbers.txt Same as 'skip_files.txt' except certain numbers are skipped.

threshold.txt Enter a number into this file (e.g. 4) default is 1. Only files with at least X number of sensitive numbers (where X is the threshold) will be included in the main report file. The secondary report file ignores this setting.

maxsize.txt Enter a number into this file (e.g. 200000000) default is 100000000. Only files up to this size will be searched. The default is 100 MB.

wait_message.txt Enter your custom wait message into this file.

status_message.txt Enter your custom status message into this file. Only works in GUI mode.

end_message.txt Enter your custom end message into this file.

OUTPUT FILES

OUTPUT FILES are generated by Find_SSNs at run time.

Find_SSNs.html or Find_SSNs.csv Main report file. Contains the results from Find_SSNs. This file should be deleted as soon as it is no longer required. If it is to be stored or transmitted, then it should be encrypted.

Find_SSNs.txt Secondary report file. Contains the raw results from Find_SSNs. This file should be deleted as soon as it is no longer required. If it is to be stored or transmitted, then it should be encrypted. .Find_SSNs_skip.txt Skipped objects are logged to this file. This file is hidden. .Find_SSNs_exceptions.txt Run time exceptions are logged to this file. This file is hidden.

COPYRIGHT

(c) 2009 Virginia Polytechnic Institute and State University Find_SSNs 4.1 January 2009 1