Difference between revisions of "Autopsy Developer's Guide"

From SleuthKitWiki
Jump to: navigation, search
(Added Autopsy 3 links)
(Autopsy 3 Topics)
 
(14 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]].  
  
This page is a work in progress and more information will be posted.  Here are some starting points.
+
There are two types of development that can occur with Autopsy:
* The [[Developer Guidelines]] define how code and patches can be submitted and incorporated into the distribution.
+
* Development of Plug-in modules that you distribute
* The [[sleuthkit-developers]] list exists to discuss the development of the tools.  Subscribe to ask and answer questions.
+
* Development of core infrastructure and the Autopsy framework
* 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.
 
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.
  
= Technical Details =
+
= Module Development =  
The source code is stored in a [http://svnbook.red-bean.com/ Subversion] repository. You can get the latest source tree by doing a checkout from [http://svn.sleuthkit.org/repos/autopsy/ http://svn.sleuthkit.org/repos/autopsy/]. The latest code is in the <tt>trunk</tt> directory.  The <tt>branches</tt> directory contains branches for minor release versions so that bugs can be fixed there for bug releases. The <tt>tags</tt> directory contains tags for each release. Note that this repository was created right before the 2.20 release and does not contain the previous CVS history.
+
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.
 +
* If you want to contribute documentation, then refer to the [http://www.sleuthkit.org/support.php Support] page.  
 +
 
 +
 
 +
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.  
  
More details in this section will be defined...
+
== Autopsy 3 Topics ==
  
= Autopsy 3.0 Design =
+
* [[Autopsy 3 Logging and Error Checking]] is a reference for how errors and log messages are made.
Version 3 of Autopsy is a complete rewrite. Find the design docs in this section.
+
* [[Autopsy 3 Module Versions]] is a reference on the versioning scheme of the internal modules.
* [[Autopsy 3 Nodes]]
+
* Adding extensions to the [[Autopsy File Extension Mismatch Module]]
* [[Autopsy 3 Data Flow]]
+
* Debugging the [[Autopsy Keyword Search Module]]
* Creating interfaces
+
* [[Adding Artifacts and Attributes]] to the official code base
** [[Creating a Data Explorer]]
+
** [[Creating a Data Result Viewer]]
+
** [[Creating a Data Content Viewer]]
+

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