diff --git a/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/new-icon.png b/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/new-icon.png deleted file mode 100644 index 14206340e1..0000000000 Binary files a/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/new-icon.png and /dev/null differ diff --git a/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/open-icon.png b/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/open-icon.png deleted file mode 100644 index d16e51b682..0000000000 Binary files a/Core/javahelp/org/sleuthkit/autopsy/casemodule/docs/open-icon.png and /dev/null differ diff --git a/Ingest/src/org/sleuthkit/autopsy/ingest/docs/ingest-about.html b/Ingest/src/org/sleuthkit/autopsy/ingest/docs/ingest-about.html index 7852fb8723..b34f5e4544 100755 --- a/Ingest/src/org/sleuthkit/autopsy/ingest/docs/ingest-about.html +++ b/Ingest/src/org/sleuthkit/autopsy/ingest/docs/ingest-about.html @@ -21,16 +21,16 @@
  • Lookup MD5 hash in database
  • Detect file type of each file
  • Keyword search each file
    • -
  • Extract web artifacts (downloads, history, etc.
    • +
  • Extract web artifacts (downloads, history, etc.)

    • Ingest modules can be created by third-party-developers and can be added independently of Autopsy.

    Configuring Ingest Modules

    - There are two places to configure ingest modules. When the Ingest Manager is launched so that you can choose which ingest modules to run, there maybe a small set of configuration changes that the module allows you to set from that interface. Additional configuration is typically available from a separate dialog box that can be opened from either the "Tools" menu or with the "Advanced" button in the Ingest Manager. + There are two places to configure ingest modules. When the Ingest Manager is launched, there may be a small set of options the module allows you to edit directly in the Ingest Manager. Additionally, the Ingest Manager may display an "Advanced" button, which will open up a larger configuration menu with more available settings. This advanced configuration menu can often be found in the "Tools" > "Options" menu, along with the advanced settings for numerous other ingest modules.

    Adding Ingest Modules

    - Not yet supported. + Ingest modules can be added through Autopsy's plugin manager. This is accessible through the "Tools" > "Plugins" menu. Currently, the best way to add an ingest module is by navigating to the module's NBM file after choosing "Add Plugin..." in the "Downloaded" tab of the plugin manager. Autopsy will require a restart after any modules are installed in order to properly load and display them. \ No newline at end of file diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchSettings.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchSettings.java index 9d9821048a..8ecbec9a5d 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchSettings.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchSettings.java @@ -166,27 +166,27 @@ public class KeywordSearchSettings { logger.log(Level.INFO, "Detecting default settings."); //setting default NSRL if(!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_NSRL, "SkipKnown")){ - logger.log(Level.INFO, "No configuration for NSRL not found, generating default..."); + logger.log(Level.INFO, "No configuration for NSRL found, generating default..."); KeywordSearchSettings.setSkipKnown(true); } //setting default Update Frequency if(!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, "UpdateFrequency")){ - logger.log(Level.INFO, "No configuration for Update Frequency not found, generating default..."); + logger.log(Level.INFO, "No configuration for Update Frequency found, generating default..."); KeywordSearchSettings.setUpdateFrequency(UpdateFrequency.AVG); } //setting default Extract UTF8 if(!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, AbstractFileExtract.ExtractOptions.EXTRACT_UTF8.toString())){ - logger.log(Level.INFO, "No configuration for UTF8 not found, generating default..."); + logger.log(Level.INFO, "No configuration for UTF8 found, generating default..."); KeywordSearchSettings.setStringExtractOption(AbstractFileExtract.ExtractOptions.EXTRACT_UTF8.toString(), Boolean.TRUE.toString()); } //setting default Extract UTF16 if(!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, AbstractFileExtract.ExtractOptions.EXTRACT_UTF16.toString())){ - logger.log(Level.INFO, "No configuration for UTF16 not found, generating defaults..."); + logger.log(Level.INFO, "No configuration for UTF16 found, generating defaults..."); KeywordSearchSettings.setStringExtractOption(AbstractFileExtract.ExtractOptions.EXTRACT_UTF16.toString(), Boolean.TRUE.toString()); } //setting default Latin-1 Script if(!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name())){ - logger.log(Level.INFO, "No configuration for Scripts not found, generating defaults..."); + logger.log(Level.INFO, "No configuration for Scripts found, generating defaults..."); ModuleSettings.setConfigSetting(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name(), Boolean.toString(true)); } } diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-about.html b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-about.html index 2702a205c6..29500b874c 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-about.html +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-about.html @@ -32,7 +32,7 @@ limitations under the License.

    To see keyword search results in real-time while ingest is running, add keyword lists using the Keyword Search Configuration Dialog - and select the "Use during triage / ingest" check box. See (Ingest) + and select the "Use during ingest" check box. See (Ingest) for more information on refresh speeds and ingest in general.

    diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.html b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.html index 3859a7ac07..33d836e5f5 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.html +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.html @@ -25,10 +25,15 @@ limitations under the License.

    Keyword Search Configuration Dialog

    - The keyword search configuration dialog is used to add, remove, and modify keyword search lists. + The keyword search configuration dialog has three tabs, each with it's own purpose:
    +

    - To begin, select the 'New List' button and choose a name for the new Keyword List. + To create a list, select the 'New List' button and choose a name for the new Keyword List. Once the list has been created, keywords can be added to it. Regular expressions are supported using Java Regex Syntax. Lists can be added to the keyword search ingest process; searches will happen at regular intervals as content is added to the index. @@ -44,6 +49,11 @@ limitations under the License. The hash database ingest service can be configured to use the NIST NSRL hash database of known files. The keyword search configuration dialog contains an option to skip keyword indexing and search on files found in the NSRL.

    - Keyword Search Configuration Dialog + Lists tab:
    + Keyword Search Configuration Dialog

    + String Extraction tab:
    + Keyword Search Configuration Dialog String Extraction

    + General tab:
    + Keyword Search Configuration Dialog General

    diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.png b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.png index 52cc04fbbb..d7fb57b36d 100644 Binary files a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.png and b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/docs/keywordsearch-configuration.png differ diff --git a/docs/doxygen/modDev.dox b/docs/doxygen/modDev.dox index 2470e16fdc..474df2b54d 100644 --- a/docs/doxygen/modDev.dox +++ b/docs/doxygen/modDev.dox @@ -4,13 +4,22 @@ \section mod_dev_setup Basic Setup +\subsection mod_dev_setup_java The Java Enviroment + +Currently, to develop modules for Autopsy, you must be using Java 1.6. + +If you have the Autopsy source code open in NetBeans, you can verify the Autopsy project is running with Java 1.6 by right clicking the project, choosing Properties, and checking that under Libraries the Java Platform is JDK 1.6 and under Sources the Source Level is 1.6. + + +\subsection mod_dev_setup_autopsy Autopsy as a Development Enviroment + To setup a module development environment for Autopsy, you must have either: \li Autopsy installed on your machine \li The Autopsy source code, downloaded from GitHub If you have Autopsy installed on your machine and would like to use that as your development environment, proceed to \ref mod_dev_module. Note that older versions of Autopsy may not have the latest features available for module development. -To use the latest Autopsy source code as your development environment, first follow BUILDING.TXT to properly build and setup Autopsy in NetBeans. +To use the latest Autopsy source code as your development environment, first follow BUILDING.TXT to properly build and setup Autopsy in NetBeans. Make sure you are using Java 1.6. Once Autopsy has been successfully built, right click on the Autopsy project in NetBeans and select Package as > ZIP Distribution. Then extract the ZIP file to any directory of your choosing. @@ -30,6 +39,8 @@ Autopsy has now been added as a "NetBeans Platform", meaning the development env Click Next, and fill out the rest of the module-creation wizard. Press Finish when complete, and the module will be added as a standalone project in NetBeans. +After the module is created, it is important to verify the new project is using Java 1.6. Any other version of Java may have unforeseen consequences. To check the version of Java, right click on the module in the Projects window and go to Properties. Make sure that under the Libraries category the Java Platform is JDK 1.6, and under Sources the Source Level is 1.6. + See \ref mod_ingest_page for instructions on programming ingest modules for Autopsy. Or read this guide from NetBeans.org for general module development tips.