Permalink
Browse files

Addition of first set of submodules

  • Loading branch information...
1 parent 550946a commit 0d666c364c4e95df192981990b1264fb7e887cf0 @rcordovano rcordovano committed May 18, 2012
View
@@ -4,3 +4,21 @@
[submodule "framework/TskModules/c_ZIPExtractionModule"]
path = framework/TskModules/c_ZIPExtractionModule
url = git://github.com/sleuthkit/c_ZIPExtractionModule.git
+[submodule "framework/TskModules/c_EntropyModule"]
+ path = framework/TskModules/c_EntropyModule
+ url = git://github.com/sleuthkit/c_EntropyModule.git
+[submodule "framework/TskModules/c_SaveInterestingFilesModule"]
+ path = framework/TskModules/c_SaveInterestingFilesModule
+ url = git://github.com/sleuthkit/c_SaveInterestingFilesModule.git
+[submodule "framework/TskModules/c_RegRipperModule"]
+ path = framework/TskModules/c_RegRipperModule
+ url = git://github.com/sleuthkit/c_RegRipperModule.git
+[submodule "framework/TskModules/c_InterestingFilesModule"]
+ path = framework/TskModules/c_InterestingFilesModule
+ url = git://github.com/sleuthkit/c_InterestingFilesModule.git
+[submodule "framework/TskModules/c_TskHashLookupModule"]
+ path = framework/TskModules/c_TskHashLookupModule
+ url = git://github.com/sleuthkit/c_TskHashLookupModule.git
+[submodule "framework/TskModules/c_SummaryReportModule"]
+ path = framework/TskModules/c_SummaryReportModule
+ url = git://github.com/sleuthkit/c_SummaryReportModule.git
@@ -24,21 +24,29 @@ static const uint32_t FILE_BUFFER_SIZE = 8193;
extern "C"
{
/**
- * Module initialization function. Takes a string as input that allows
- * arguments to be passed into the module.
- * @param arguments This module takes no arguments
+ * Module initialization function. Receives a string of initialization arguments,
+ * typically read by the caller from a pipeline configuration file.
+ * Returns TskModule::OK or TskModule::FAIL. Returning TskModule::FAIL indicates
+ * the module is not in an operational state.
+ *
+ * @param args This module takes no arguments.
+ * @return TskModule::OK if initialization succeeded, otherwise TskModule::FAIL.
*/
TskModule::Status TSK_MODULE_EXPORT initialize(std::string& arguments)
{
return TskModule::OK;
}
/**
- * The run() method is where the modules work is performed.
- * The module will be passed a pointer to a file from which both
- * content and metadata can be retrieved.
+ * Module execution function. Receives a pointer to a file the module is to
+ * process. The file is represented by a TskFile interface from which both
+ * file content and file metadata can be retrieved. Returns TskModule::OK,
+ * TskModule::FAIL, or TskModule::STOP. Returning TskModule::FAIL indicates
+ * the module experienced an error processing the file. Returning TskModule::STOP
+ * is a request to terminate processing of the file.
+ *
* @param pFile A pointer to a file to be processed.
- * @returns TskModule::OK on success and TskModule::FAIL on error.
+ * @returns TskModule::OK on success, TskModule::FAIL on error, or TskModule::STOP.
*/
TskModule::Status TSK_MODULE_EXPORT run(TskFile * pFile)
{
@@ -85,6 +93,12 @@ extern "C"
return TskModule::OK;
}
+ /**
+ * Module cleanup function. This is where the module should free any resources
+ * allocated during initialization or execution.
+ *
+ * @returns TskModule::OK on success and TskModule::FAIL on error.
+ */
TskModule::Status TSK_MODULE_EXPORT finalize()
{
return TskModule::OK;
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 10.00
# Visual C++ Express 2008
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "framework", "framework.vcproj", "{F791B16A-1489-4526-9FFF-CB481CEC5414}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libtskframework", "framework.vcproj", "{F791B16A-1489-4526-9FFF-CB481CEC5414}"
EndProject
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "CalcFileSizeModule", "..\CalcFileSize\CalcFileSize.vcproj", "{FA3FF845-E341-4BE3-A17F-8042C99A374F}"
ProjectSection(ProjectDependencies) = postProject
@@ -13,6 +13,20 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ValidatePipeline", "..\Vali
{F791B16A-1489-4526-9FFF-CB481CEC5414} = {F791B16A-1489-4526-9FFF-CB481CEC5414}
EndProjectSection
EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "EntropyModule", "..\..\TskModules\c_EntropyModule\win32\EntropyModule.vcproj", "{00E3B0EE-B612-433A-A43E-1CE0B3DE1015}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "HashCalcModule", "..\..\TskModules\c_HashCalcModule\win32\HashCalcModule.vcproj", "{46CD18AC-3A1C-405D-B39F-F86BA0FD1820}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "InterestingFilesModule", "..\..\TskModules\c_InterestingFilesModule\win32\InterestingFilesModule.vcproj", "{8F956113-11D2-4288-985D-53CBF84648E0}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "RegRipperModule", "..\..\TskModules\c_RegRipperModule\win32\RegRipperModule.vcproj", "{4DD49717-8C15-4E07-8C18-D47A093184AA}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "InterestingFilesModule", "..\..\TskModules\c_SaveInterestingFilesModule\win32\SaveInterestingFilesModule.vcproj", "{39CDF492-FCD0-42E8-B2E2-42D2E0F6D2CC}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "TskHashLookupModule", "..\..\TskModules\c_TskHashLookupModule\win32\TskHashLookupModule.vcproj", "{430B8E55-C5F4-4936-A0C7-DABD8B34788A}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ZipExtractionModule", "..\..\TskModules\c_ZIPExtractionModule\win32\ZipExtractionModule.vcproj", "{506823BC-AE48-4827-B72A-BA4C9E1E4670}"
+EndProject
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "tsk_analyzeimg", "..\tsk_analyzeimg\tsk_analyzeimg.vcproj", "{13BD0806-028E-42F1-A91D-5128565A9717}"
ProjectSection(ProjectDependencies) = postProject
{F791B16A-1489-4526-9FFF-CB481CEC5414} = {F791B16A-1489-4526-9FFF-CB481CEC5414}
@@ -40,6 +54,34 @@ Global
{13BD0806-028E-42F1-A91D-5128565A9717}.Debug|Win32.Build.0 = Debug|Win32
{13BD0806-028E-42F1-A91D-5128565A9717}.Release|Win32.ActiveCfg = Release|Win32
{13BD0806-028E-42F1-A91D-5128565A9717}.Release|Win32.Build.0 = Release|Win32
+ {00E3B0EE-B612-433A-A43E-1CE0B3DE1015}.Debug|Win32.ActiveCfg = Debug|Win32
+ {00E3B0EE-B612-433A-A43E-1CE0B3DE1015}.Debug|Win32.Build.0 = Debug|Win32
+ {00E3B0EE-B612-433A-A43E-1CE0B3DE1015}.Release|Win32.ActiveCfg = Release|Win32
+ {00E3B0EE-B612-433A-A43E-1CE0B3DE1015}.Release|Win32.Build.0 = Release|Win32
+ {46CD18AC-3A1C-405D-B39F-F86BA0FD1820}.Debug|Win32.ActiveCfg = Debug|Win32
+ {46CD18AC-3A1C-405D-B39F-F86BA0FD1820}.Debug|Win32.Build.0 = Debug|Win32
+ {46CD18AC-3A1C-405D-B39F-F86BA0FD1820}.Release|Win32.ActiveCfg = Release|Win32
+ {46CD18AC-3A1C-405D-B39F-F86BA0FD1820}.Release|Win32.Build.0 = Release|Win32
+ {8F956113-11D2-4288-985D-53CBF84648E0}.Debug|Win32.ActiveCfg = Debug|Win32
+ {8F956113-11D2-4288-985D-53CBF84648E0}.Debug|Win32.Build.0 = Debug|Win32
+ {8F956113-11D2-4288-985D-53CBF84648E0}.Release|Win32.ActiveCfg = Release|Win32
+ {8F956113-11D2-4288-985D-53CBF84648E0}.Release|Win32.Build.0 = Release|Win32
+ {4DD49717-8C15-4E07-8C18-D47A093184AA}.Debug|Win32.ActiveCfg = Debug|Win32
+ {4DD49717-8C15-4E07-8C18-D47A093184AA}.Debug|Win32.Build.0 = Debug|Win32
+ {4DD49717-8C15-4E07-8C18-D47A093184AA}.Release|Win32.ActiveCfg = Release|Win32
+ {4DD49717-8C15-4E07-8C18-D47A093184AA}.Release|Win32.Build.0 = Release|Win32
+ {39CDF492-FCD0-42E8-B2E2-42D2E0F6D2CC}.Debug|Win32.ActiveCfg = Debug|Win32
+ {39CDF492-FCD0-42E8-B2E2-42D2E0F6D2CC}.Debug|Win32.Build.0 = Debug|Win32
+ {39CDF492-FCD0-42E8-B2E2-42D2E0F6D2CC}.Release|Win32.ActiveCfg = Release|Win32
+ {39CDF492-FCD0-42E8-B2E2-42D2E0F6D2CC}.Release|Win32.Build.0 = Release|Win32
+ {430B8E55-C5F4-4936-A0C7-DABD8B34788A}.Debug|Win32.ActiveCfg = Debug|Win32
+ {430B8E55-C5F4-4936-A0C7-DABD8B34788A}.Debug|Win32.Build.0 = Debug|Win32
+ {430B8E55-C5F4-4936-A0C7-DABD8B34788A}.Release|Win32.ActiveCfg = Release|Win32
+ {430B8E55-C5F4-4936-A0C7-DABD8B34788A}.Release|Win32.Build.0 = Release|Win32
+ {506823BC-AE48-4827-B72A-BA4C9E1E4670}.Debug|Win32.ActiveCfg = Debug|Win32
+ {506823BC-AE48-4827-B72A-BA4C9E1E4670}.Debug|Win32.Build.0 = Debug|Win32
+ {506823BC-AE48-4827-B72A-BA4C9E1E4670}.Release|Win32.ActiveCfg = Release|Win32
+ {506823BC-AE48-4827-B72A-BA4C9E1E4670}.Release|Win32.Build.0 = Release|Win32
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE

0 comments on commit 0d666c3

Please sign in to comment.