Download Latest Version TDD_Kyusho.zip (72.4 kB)
Email in envelope

Get an email when there's a new version of Kyusho-Sensitive Data Search Tool

Home
Name Modified Size InfoDownloads / Week
Kyusho_v_2.0 2014-02-15
modified-code-not-original-author 2013-09-05
Old-version 2013-08-19
Kyusho_v_1.0 2013-08-19
___README___.txt 2014-02-15 3.0 kB
Totals: 5 Items   3.0 kB 2
Welcome to Kyusho!

Authors: Jamie Gambetta, John Franolich 

Note: See the Readme in Kyusho_v_2.0 folder for the latest updates.

Contents
--------

1. Overview

	Kyusho is a framework for finding sensitive information or weaknesses on your own systems.  With it, you can write a program to process a select group of files in a select group of folders and specify exactly how you would like to process each kind of file.
	For example, you can use it to specify:

	- Process only .txt files larger than 512KB and .exe file between 1MB and 10MB
	- For each .txt file, run the following FileProcessors: ...
	- For each .exe file, run the following FileProcessors: ...

	All of the information for a run can be specified programmatically before a run.
	You can write your own FileProcessors and add or remove them programmatically as well.

	We are currently working on a generic UI that would allow for automated discovery and usage of custom FileProcessors.

	1.1 Basic Components

		1.1.1 Directory Processor
		1.1.2 Target Profile
		1.1.3 File Processor

2. Usage

	**Prerequisites:
		- Kyusho is written in Python 2.7, so that needs to be installed if being run as a python script. 
		  Or you need to run it through 2to3. 
		  If using the compiled exe version, these should not be necessary.

	**Right now, you must use Kyusho as an API, though we are currently working on a UI to include auto-discovery of custom FileProcessors.  There are some examples in this document, but if you want more examples that are known to be working, please feel free to look through the project's unit tests.

	2.1 Examples

		2.1.1 Search all .txt files in C:\ for a set of regular expressions

		#==================================================
		# **** This script assumes it is in the same directory
		# **** as DirectoryProcessor (main Kyusho folder) for 
		# **** import locations

		from DirectoryProcessor import DirectoryProcessor
		from TargetProfile import TargetProfile
		from FileProcessors.RegexTextFileProcessor import RegexTextFileProcessor
		dp = DirectoryProcessor()
		
		tp = TargetProfile()
		tp.addFileExtension(".txt")

		fp = RegexTextFileProcessor()
		dp.addFileProcessor(fp)

		#------ set up, process directories------------
		dp.addDirectory("C:\\")
		dp.processAllDirectories()
		#------------------ OR --------------------------
		#dp.processDirectory("C:\\")
		#==================================================



		2.1.2 Search all .bin files in C:\ for social security numbers
		2.1.3 Search:
				- .txt files greater than 2MB and less than 10MB for common regular expressions
				- .bin files less than 10 MB for social security numbers
		    

		      


	
3. Developer Documentation

	

4. Contact Us
	

5. License - Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License http://creativecommons.org/licenses/by/4.0/deed.en_US" 
Source: ___README___.txt, updated 2014-02-15