{"id":152,"date":"2024-11-15T12:24:49","date_gmt":"2024-11-15T11:24:49","guid":{"rendered":"https:\/\/aralez.co\/index.php\/docs\/documentation\/4-configuration-and-customization\/configuration-structure\/"},"modified":"2025-01-25T01:48:09","modified_gmt":"2025-01-25T00:48:09","password":"","slug":"configuration-structure","status":"publish","type":"docs","link":"https:\/\/aralez.co\/index.php\/docs\/configuration-structure\/","title":{"rendered":"Configuration Structure"},"content":{"rendered":"\n

The configuration file for Aralez<\/strong> is a YAML document that defines the tasks and operations that the tool will execute during triage collection or system analysis. It allows for high flexibility and customization by specifying which artifacts to collect, directories to target, file patterns to match, and commands to execute.<\/p>\n\n\n\n

Each task is grouped logically and can include options like priority, exclusions, maximum file sizes, and encryption labels. The configuration also supports embedding custom settings directly into the executable, making deployment and usage seamless across different environments.<\/p>\n\n\n\n

This section provides a comprehensive breakdown of all fields in the configuration file, including their purpose, type, default values, and whether they are optional or required. By understanding these fields, users can tailor Aralez to meet their specific forensic and incident response needs effectively.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Find item <\/h4>\n\n\n\n

Each search configuration defines what and where to search. The key fields include:<\/p>\n\n\n\n

    \n
  • root_path<\/code><\/strong>: Specifies the directory to search within.<\/li>\n\n\n\n
  • objects<\/code><\/strong>: Lists the objects (e.g., files or directories) to include in the search.<\/li>\n\n\n\n
  • max_size<\/code><\/strong> (optional): Sets a maximum file size for retrieval. Files exceeding this size will be skipped.<\/li>\n\n\n\n
  • encrypt<\/code><\/strong> (optional): Provides a password for AES-GCM encryption. If specified, files will be encrypted and saved with an .enc<\/code> extension. If not specified, files will remain unencrypted.<\/li>\n<\/ul>\n\n\n\n
    <\/div>\n\n\n\n

    Glob Patterns<\/strong><\/h4>\n\n\n\n

    Aralez exclusively uses glob patterns to match files and directories. Glob patterns are simple expressions used to define search criteria:<\/p>\n\n\n\n

      \n
    • *<\/code><\/strong>: Matches any sequence of characters except the directory separator (\\\\).
      Examples: \n
        \n
      • *.txt<\/code><\/code> matches all .txt<\/code> files in the specified directory.<\/li>\n\n\n\n
      • \\\\*\\\\<\/code> match all one level folders.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
      • **<\/code><\/strong>: Matches directories and their contents recursively.
        Example: \"**\"<\/code> matches all files in a directory and its sub-directories.<\/li>\n\n\n\n
      • **\\\\<\/code><\/strong>: Matches directories recursively.
        Example: \"**\\\\\"<\/code> matches all directories and sub directories within the specified path.<\/li>\n<\/ul>\n\n\n\n
        <\/div>\n\n\n\n

        Dynamic Paths with Environment Variables<\/strong><\/h4>\n\n\n\n

        Aralez supports Windows environment variables within the root_path<\/code> field. Variables must be wrapped in %...%<\/code>, and they will automatically expand to their corresponding system values during execution.<\/p>\n\n\n\n

        Example:<\/p>\n\n\n\n

        <\/path><\/path><\/svg><\/span>
        entries<\/span>:<\/span><\/span>\n  <\/span>files<\/span>:<\/span><\/span>\n    <\/span>-<\/span> <\/span>root_path<\/span>:<\/span> <\/span>"<\/span>%USERPROFILE%<\/span>\\\\<\/span>Documents<\/span>"<\/span><\/span>\n      <\/span>objects<\/span>:<\/span> <\/span>[<\/span>"<\/span>*.docx<\/span>"<\/span>,<\/span> <\/span>"<\/span>*.pdf<\/span>"<\/span>]<\/span><\/span>\n      <\/span>max_size<\/span>:<\/span> <\/span>1048576<\/span><\/span>\n      <\/span>encrypt<\/span>:<\/span> <\/span>"<\/span>infected<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        In this example, %USERPROFILE%<\/code> expands to the current user\u2019s profile directory.<\/p>\n\n\n\n
        <\/div>\n\n\n\n
        Field Descriptions<\/strong><\/h4>\n\n\n\n
        <\/div>\n\n\n\n
        Field<\/th>Type<\/th>Description<\/th>Required<\/th>Default<\/th><\/tr><\/thead>
        tasks<\/td>Object<\/td>Defines the collection and execution tasks Aralez will perform. Each task contains specific entries for data collection or execution.<\/td>Yes<\/td>–<\/td><\/tr>
        [task_name]<\/td>String<\/td>A named task, such as artifacts<\/code> or tools<\/code>, representing a logical grouping of operations. The name of the task doesn’t have any impact.<\/td>Yes<\/td>–<\/td><\/tr>
        type<\/td>String<\/td>Specifies the type of the task. Options are:
        – \"collect\"<\/code>: For data collection tasks.
        – \"execute\"<\/code>: For command or tool execution tasks.<\/td>        		Yes<\/td>–<\/td><\/tr>
        entries<\/td>Object<\/td>Contains the specific operations or file paths and objects for the task.<\/td>Yes<\/td>–<\/td><\/tr>
        [entry_name]<\/td>Object<\/td>A named entry defining a specific operation within the task.<\/td>Yes<\/td>–<\/td><\/tr>
        priority<\/td>Integer<\/td>Defines the execution order of the tasks. <\/td>Yes<\/td>–<\/td><\/tr>
        disabled<\/td>Boolean<\/td>Indicates whether the task is disabled. If set to true<\/code>, the task will be skipped during execution.<\/td>No<\/td>false<\/td><\/tr>
        drive<\/td>Char<\/td>Specifies the target drive for collection tasks. Common values include \"C\"<\/code> or \"*\"<\/code>. \u00ab\u00a0*\u00a0\u00bb represent all drives of the machine.<\/td>No<\/td>C<\/td><\/tr>
        exclude_drives<\/td>List of Chars<\/td>Lists drives to exclude when using \"*\"<\/code> in the drive<\/code> field.<\/td>No<\/td>–<\/td><\/tr>
        root_path<\/td>String<\/td>Defines the directory to search within. Supports environment variables wrapped in %...%<\/span><\/code> and glob patterns. The root_path<\/span> should start with \\\\, except for environment variables.<\/td>Yes for collect<\/span> type
        No for execute<\/span> type<\/td>        		–<\/td><\/tr>
        objects<\/td>List of Strings<\/td>Specifies the files or patterns to collect from the directory path. Wildcards like *.evtx<\/code> can be used to match file types.<\/td>Yes for collect<\/span> type
        No for execute<\/span> type<\/td>        		–<\/td><\/tr>
        max_size<\/td>Integer<\/td>The maximum size (in bytes) of files to be collected. Files exceeding this size will be skipped.<\/td>No<\/td>No limit<\/td><\/tr>
        encrypt<\/td>String<\/td>Specifies an encryption label for collected files (e.g., \"infected\"<\/code>).<\/td>No<\/td>–<\/td><\/tr>
        args<\/td>List of Strings<\/td>Command-line arguments passed to external or system executables.<\/td>Yes for execute<\/span> type
        No for collect<\/span> type<\/td>        		–<\/td><\/tr>
        output_file<\/td>String<\/td>The name of the output file generated by the executable or internal tool.<\/td>Yes for execute<\/span> type
        No for collect<\/span> type<\/td>        		–<\/td><\/tr>
        exec_type<\/td>String<\/td>Defines the type of execution. Options are:
        – \"external\"<\/code>: Executes external binaries.
        – \"system\"<\/code>: Executes system commands.
        – \"internal\"<\/code>: Executes built-in Aralez functions.<\/td>        		Yes for execute<\/span> type
        No for collect<\/span> type<\/td>        		–<\/td><\/tr>
        output_filename<\/td>String<\/td>The naming convention for the final output file. Template variables like {{hostname}}<\/code> and {{datetime}}<\/code> can be used.<\/td>Yes<\/td>–<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        <\/div>\n\n\n\n
        Example Configurations<\/strong><\/h4>\n\n\n\n
        <\/div>\n\n\n\n
        Collect Files<\/strong><\/h5>\n\n\n\n
        This example collects .docx<\/code> and .pdf<\/code> files from all users’ Documents<\/code> directories, with a file size limit of 1 MB and encryption enabled.<\/p>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        tasks<\/span>:<\/span> <\/span><\/span>\n  <\/span>artifacts<\/span>:<\/span><\/span>\n    <\/span>type<\/span>:<\/span> <\/span>"<\/span>collect<\/span>"<\/span><\/span>\n    <\/span>priority<\/span>:<\/span> <\/span>1<\/span><\/span>\n    <\/span>entries<\/span>:<\/span><\/span>\n      <\/span>files<\/span>:<\/span><\/span>\n        <\/span>-<\/span> <\/span>root_path<\/span>:<\/span> <\/span>"<\/span>\\\\<\/span>Users<\/span>\\\\<\/span>*<\/span>\\\\<\/span>Documents<\/span>"<\/span><\/span>\n          <\/span>objects<\/span>:<\/span> <\/span>[<\/span>"<\/span>*.docx<\/span>"<\/span>,<\/span> <\/span>"<\/span>*.pdf<\/span>"<\/span>]<\/span><\/span>\n          <\/span>max_size<\/span>:<\/span> <\/span>1048576<\/span><\/span>\n          <\/span>encrypt<\/span>:<\/span> <\/span>"<\/span>infected<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        <\/div>\n\n\n\n
        Execute a PowerShell Command<\/h5>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        tasks<\/span>:<\/span><\/span>\n  <\/span>tools<\/span>:<\/span><\/span>\n    <\/span>priority<\/span>:<\/span> <\/span>3<\/span><\/span>\n    <\/span>type<\/span>:<\/span> <\/span>"<\/span>execute<\/span>"<\/span><\/span>\n      <\/span>entries<\/span>:<\/span><\/span>\n        <\/span>win_tools<\/span>:<\/span><\/span>\n          <\/span>-<\/span> <\/span>name<\/span>:<\/span> <\/span>"<\/span>powershell<\/span>"<\/span><\/span>\n            <\/span>args<\/span>:<\/span> <\/span>[<\/span>"<\/span>-command<\/span>"<\/span>,<\/span> <\/span>"<\/span>Get-ComputerInfo<\/span>"<\/span>]<\/span><\/span>\n            <\/span>output_file<\/span>:<\/span> <\/span>"<\/span>ComputerInfo.txt<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        <\/div>\n\n\n\n
        Match All Files Recursively<\/h5>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        tasks<\/span>:<\/span> <\/span><\/span>\n  <\/span>artifacts<\/span>:<\/span><\/span>\n    <\/span>type<\/span>:<\/span> <\/span>"<\/span>collect<\/span>"<\/span><\/span>\n    <\/span>priority<\/span>:<\/span> <\/span>1<\/span><\/span>\n    <\/span>entries<\/span>:<\/span><\/span>\n      <\/span>logs<\/span>:<\/span><\/span>\n        <\/span>-<\/span> <\/span>root_path<\/span>:<\/span> <\/span>"<\/span>\\\\<\/span>Logs<\/span>"<\/span><\/span>\n          <\/span>objects<\/span>:<\/span> <\/span>[<\/span>"<\/span>**<\/span>"<\/span>]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        <\/div>\n\n\n\n
        Dynamic Output Filename<\/h5>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        output_filename<\/span>:<\/span> <\/span>"<\/span>Aralez_{{hostname}}_{{datetime}}<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        For instance, if executed on a machine named MyPC<\/code> on September 23, 2024, the output file will be named:<\/p>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        Aralez_MyPC_2024-09-23_10-30-10.zip<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        <\/div>\n\n\n\n
        Change the configuration<\/h5>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        aralez.exe<\/span> <\/span>--change_config<\/span> <\/span>custom_config.yml<\/span> <\/span>custom_aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        <\/p>\n","protected":false},"excerpt":{"rendered":"
        The configuration file for Aralez is a YAML document that defines the tasks and operations that the tool will execute during triage collection or system analysis. It allows for high flexibility and customization by specifying which artifacts to collect, directories to target, file patterns to match, and commands to execute. Each task is grouped logically […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_themeisle_gutenberg_block_has_review":false,"footnotes":""},"doc_category":[9],"doc_tag":[],"class_list":["post-152","docs","type-docs","status-publish","hentry","doc_category-4-configuration-and-customization"],"blocksy_meta":[],"aioseo_notices":[],"year_month":"2026-04","word_count":834,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"ab","author_nicename":"admin5116","author_url":"https:\/\/aralez.co\/index.php\/author\/admin5116\/"},"doc_category_info":[{"term_name":"4. Configuration and Customization","term_url":"https:\/\/aralez.co\/index.php\/docs-category\/4-configuration-and-customization\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/152","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/comments?post=152"}],"version-history":[{"count":44,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/152\/revisions"}],"predecessor-version":[{"id":553,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/152\/revisions\/553"}],"wp:attachment":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/media?parent=152"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/doc_category?post=152"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/doc_tag?post=152"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}