Report

reporting:
  zip_archive:
    enabled: false
    encryption:
      enabled: false
      public_key: "example_public.pem"
      algorithm: CHACHA20-POLY1305
    compression:
      enabled: true
      size_limit: 100 MB
  metadata:
    mac_times: true
    checksums: true
    paths: true

Archive

PropertyDescriptionRequiredDefault
enabledSpecifies whether the zip archive creation is enabled.Notrue
encryptionConfiguration for encrypting the zip archive. Contains the fields: enabled, public_key, and algorithm.NoSee ReportingEncryption Defaults
compressionConfiguration for compressing the zip archive. Contains the fields: enabled and size_limit.NoSee ReportingCompression Defaults

Encryption

PropertyDescriptionRequiredDefault
enabledSpecifies whether encryption is enabled for the zip archive.Nofalse
public_keyThe path to the public key file used for encryption. Relative to the keys directoryYes (if enabled is true)-
algorithmThe encryption algorithm to be used. Available values: AES-128-GCM, CHACHA20-POLY1305, None.NoNone

Compression

PropertyDescriptionRequiredDefault
enabledSpecifies whether compression is enabled for the zip archive.Nofalse
size_limitThe maximum size limit for specific files to be compressed. If a file exceeds this limit, it will only be stored inside the archive without compression.No100 MB

Metadata

PropertyDescriptionRequiredDefault
mac_timesSpecifies whether the MAC times (Modified, Accessed, Created) should be recorded in the metadata.csv for stored files (using store or yara actions).Nofalse
checksumsSpecifies whether checksums should be calculated and included in the report.Nofalse
pathsSpecifies whether the original file paths should be recorded in the metadata.csv for stored files (using store or yara actions).Nofalse