Difference between revisions of "Autopsy Developer's Guide"

From SleuthKitWiki
Jump to: navigation, search
(Autopsy 3 Topics)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This page contains technical information on developing code for [[Autopsy]].  
 
This page contains technical information on developing code for [[Autopsy]].  
  
= General sleuthkit.org Information =
+
There are two types of development that can occur with Autopsy:
This page is a work in progress and more information will be posted. Here are some starting points.  
+
* Development of Plug-in modules that you distribute
* The [[Developer Guidelines]] define how code and patches can be submitted and incorporated into the sleuthkit.org projects.  
+
* Development of core infrastructure and the Autopsy framework
 +
 
 +
If you are looking for ideas on how you can contribute, then you may want to refer to the feature request and bug [[trackers]]. They contain ideas that people have for the tools or bugs that need to be fixed.
 +
 
 +
= Module Development =  
 +
Autopsy was developed to be a platform for plug-in modules.  The [http://www.sleuthkit.org/autopsy/docs/api-docs/ Developer's Guide] contains the API docs and information on how to write modules. When you create a module, add it to the list of [[Autopsy 3rd Party Modules]].  
 +
 
 +
= Platform Development =
 +
 
 +
* The [[Developer Guidelines]] defines how code and patches can be submitted and incorporated into the sleuthkit.org projects.  
 
* The [[sleuthkit-developers]] list exists to discuss the development of the sleuthkit.org tools.  Subscribe to ask and answer questions.  
 
* The [[sleuthkit-developers]] list exists to discuss the development of the sleuthkit.org tools.  Subscribe to ask and answer questions.  
 
* If you want to contribute documentation, then refer to the [http://www.sleuthkit.org/support.php Support] page.  
 
* If you want to contribute documentation, then refer to the [http://www.sleuthkit.org/support.php Support] page.  
  
= What To Do? =
 
If you are looking for ideas on how you can contribute, then you may want to refer to the feature request and bug [[trackers]].  They contain ideas that people have for the tools or bugs that need to be fixed.
 
  
= Source Code =
+
The source code is stored in a [http://www.github.com/ github] repository. You can get the latest source tree from http://github.com/sleuthkit/autopsy.  
The source code is stored in a [http://www.github.org/ github] repository. You can get the latest source tree from http://github.com/sleuthkit/autopsy. The latest code is in the master branch. There is a branch for minor releases and tags for each release. The github repository contains the history from the previous subversion repository. Note that the previous subversion repository was created right before the 2.20 release and does not contain the previous CVS history.
+
 
 +
== Autopsy 3 Topics ==
  
= Autopsy 3.0 =
 
[[Autopsy 3]] is a complete rewrite from Autopsy 2. This section will cover the topics that developers need to get started.  This section will be better organized as we add content, but here are some starting points:
 
* To compile the program from source, refer to [http://github.com/sleuthkit/autopsy/blob/master/BUILDING.txt BUILDING.txt].
 
* [http://www.sleuthkit.org/autopsy/docs/api-docs/ Developer's Guide] contains the API docs and information on how to write modules.
 
 
* [[Autopsy 3 Logging and Error Checking]] is a reference for how errors and log messages are made.
 
* [[Autopsy 3 Logging and Error Checking]] is a reference for how errors and log messages are made.
 
* [[Autopsy 3 Module Versions]] is a reference on the versioning scheme of the internal modules.
 
* [[Autopsy 3 Module Versions]] is a reference on the versioning scheme of the internal modules.
 +
* Adding extensions to the [[Autopsy File Extension Mismatch Module]]
 +
* Debugging the [[Autopsy Keyword Search Module]]
 +
* [[Adding Artifacts and Attributes]] to the official code base

Latest revision as of 11:44, 27 January 2015

This page contains technical information on developing code for Autopsy.

There are two types of development that can occur with Autopsy:

  • Development of Plug-in modules that you distribute
  • Development of core infrastructure and the Autopsy framework

If you are looking for ideas on how you can contribute, then you may want to refer to the feature request and bug trackers. They contain ideas that people have for the tools or bugs that need to be fixed.

Module Development

Autopsy was developed to be a platform for plug-in modules. The Developer's Guide contains the API docs and information on how to write modules. When you create a module, add it to the list of Autopsy 3rd Party Modules.

Platform Development

  • The Developer Guidelines defines how code and patches can be submitted and incorporated into the sleuthkit.org projects.
  • The sleuthkit-developers list exists to discuss the development of the sleuthkit.org tools. Subscribe to ask and answer questions.
  • If you want to contribute documentation, then refer to the Support page.


The source code is stored in a github repository. You can get the latest source tree from http://github.com/sleuthkit/autopsy.

Autopsy 3 Topics