diff --git a/docs/doxygen-user/aleapp.dox b/docs/doxygen-user/aleapp.dox index d62a6edc6d..220b07de51 100644 --- a/docs/doxygen-user/aleapp.dox +++ b/docs/doxygen-user/aleapp.dox @@ -8,7 +8,7 @@ The Android Analyzer ingest module runs aLEAPP (https://github.com/abrignoni/aLE \section aleapp_config Using the Module -Select the checkbox in the Ingest Modules settings screen to enable the Android Analzyer (ALEAPP) module. The module will run on .tar/.zip files found in a \ref ds_log "logical files data source" or a \ref ds_img disk image. +Select the checkbox in the Ingest Modules settings screen to enable the Android Analzyer (ALEAPP) module. The module will run on .tar/.zip files found in a \ref ds_log "logical files data source" or a \ref ds_img "disk image". \section aleapp_results Seeing Results diff --git a/docs/doxygen-user/drone.dox b/docs/doxygen-user/drone.dox index 978e199917..baf2366a72 100755 --- a/docs/doxygen-user/drone.dox +++ b/docs/doxygen-user/drone.dox @@ -1,13 +1,13 @@ -/*! \page drone_page Drone Analyzer +/*! \page drone_page DJI Drone Analyzer [TOC] \section drone_overview Overview -The Drone Analyzer module allows you to analyze files from a drone. +The DJI Drone Analyzer module allows you to analyze files from a drone. -Currently, the Drone Analyzer module works on images obtained from the internal SD card found in the following DJI drone models: +Currently, the DJI Drone Analyzer module works on images obtained from the internal SD card found in the following DJI drone models: - Phantom 3 - Phantom 4 - Phantom 4 Pro @@ -20,7 +20,7 @@ The module will find DAT files and process them using DatCon (https://datfile.ne \section drone_config Running the Module -To enable the Drone Analyzer ingest module select the checkbox in the \ref ingest_configure "Ingest Modules configuration screen". +To enable the DJI Drone Analyzer ingest module select the checkbox in the \ref ingest_configure "Ingest Modules configuration screen". \section drone_results Viewing Results diff --git a/docs/doxygen-user/images/aleapp_main.jpg b/docs/doxygen-user/images/aleapp_main.jpg index 82d8d2c778..d318748a6d 100644 Binary files a/docs/doxygen-user/images/aleapp_main.jpg and b/docs/doxygen-user/images/aleapp_main.jpg differ diff --git a/docs/doxygen-user/images/yara_ingest_settings.png b/docs/doxygen-user/images/yara_ingest_settings.png new file mode 100644 index 0000000000..0917a73bd0 Binary files /dev/null and b/docs/doxygen-user/images/yara_ingest_settings.png differ diff --git a/docs/doxygen-user/images/yara_new_rule_set.png b/docs/doxygen-user/images/yara_new_rule_set.png new file mode 100644 index 0000000000..1470f8f45c Binary files /dev/null and b/docs/doxygen-user/images/yara_new_rule_set.png differ diff --git a/docs/doxygen-user/images/yara_options.png b/docs/doxygen-user/images/yara_options.png new file mode 100644 index 0000000000..e04a1e62f4 Binary files /dev/null and b/docs/doxygen-user/images/yara_options.png differ diff --git a/docs/doxygen-user/images/yara_results.png b/docs/doxygen-user/images/yara_results.png new file mode 100644 index 0000000000..5e1d447935 Binary files /dev/null and b/docs/doxygen-user/images/yara_results.png differ diff --git a/docs/doxygen-user/main.dox b/docs/doxygen-user/main.dox index c9649aeef6..b8778cd36b 100644 --- a/docs/doxygen-user/main.dox +++ b/docs/doxygen-user/main.dox @@ -51,6 +51,8 @@ The following topics are available here: - \subpage drone_page - \subpage gpx_page - \subpage ileapp_page + - \subpage aleapp_page + - \subpage yara_page - Reviewing the Results - \subpage uilayout_page diff --git a/docs/doxygen-user/yara.dox b/docs/doxygen-user/yara.dox new file mode 100644 index 0000000000..19bba86384 --- /dev/null +++ b/docs/doxygen-user/yara.dox @@ -0,0 +1,50 @@ +/*! \page yara_page YARA Analyzer + +[TOC] + + +\section yara_overview Overview + +The YARA Analyzer module uses a set of rules to search files for textual or binary patterns. YARA was designed for malware analysis but can be used to search for any type of files. For more information on YARA see https://virustotal.github.io/yara/. + +\section yara_config Configuration + +To create and edit your rule sets, go to "Tools", "Options" and then select the "YARA" tab. + +\image html yara_options.png + +YARA rule sets are stored in folders in the user's Autopsy folder. To create a new rule set, click the "New Set" button in the lower left and enter the name for your new set. + +\image html yara_new_rule_set.png + +With your new rule set selected, click the "Open Folder" button to go to the newly created rules folder. You can now copy existing YARA files into this folder to include them in the rule set. Information on writing YARA rules can be found here and many existing YARA rules can be found through a web search. As a very simple example, we will add this rule to the sample rule set to find files that contain the words "hello" and "world": + +\verbatim +rule HelloWorldRule +{ + strings: + $part1 = "hello" nocase + $part2 = "world" nocase + + condition: + $part1 and $part2 +} +\endverbatim + +Once you've added your rules to the folder, click the "Refresh File List" button to show them in the options panel. + +\section yara_running Running the Module + +To enable the YARA Analyzer ingest module select the checkbox in the \ref ingest_configure "Ingest Modules configuration screen". + +\image html yara_ingest_settings.png + +Make sure all rule sets you want to run are checked. You can also choose between running on all files or only running on executable files. + +\section yara_results Viewing Results + +Results are show in the Results tree under "Extracted Content". + +\image html yara_results.png + +*/