Skip to content

puffyCid/artemis

Repository files navigation

Artemis - A cross platform DFIR application

License: MIT codecov GitHub Workflow Status (with event) GitHub Workflow Status (with event)

Artemis is a powerful command line digital forensic and incident response (DFIR) tool that collects forensic data from Windows, macOS, Linux, and FreeBSD endpoints. Its primary focus is: speed, ease of use, and low resource usage.
Notable features so far:

  • Setup collections using basic TOML files
  • Parsing support for large amount of forensic artifacts (40+)
  • Output to JSON, JSONL, or CSV file(s)
  • Can output results to local system or upload to cloud services.
  • An embedded JavaScript runtime via Boa that allows you to script and create your own parsers and artifacts.
  • Timeline support that is compatible with Timesketch

Checkout the online guide at https://puffycid.github.io/artemis-api for in-depth walkthrough on using artemis

Quick Guide

  1. Download the latest stable release binary from GitHub. Nightly versions also available
  2. Run artemis!
artemis -h
Usage: artemis [OPTIONS] [COMMAND]

Commands:
  acquire  Acquire forensic artifacts
  help     Print this message or the help of the given subcommand(s)

Options:
  -t, --toml <TOML>              Full path to TOML collector
  -d, --decode <DECODE>          Base64 encoded TOML file
  -j, --javascript <JAVASCRIPT>  Full path to JavaScript file
  -h, --help                     Print help
  -V, --version                  Print version

An example to example collect a process listing.

> artemis acquire -h
Acquire forensic artifacts

Usage: artemis acquire [OPTIONS] [COMMAND]

Commands:
  processes          Collect processes
  connections        Collect network connections
  filelisting        Pull filelisting
  systeminfo         Get systeminfo
  prefetch           windows: Parse Prefetch
  eventlogs          windows: Parse EventLogs
  rawfilelisting     windows: Parse NTFS to get filelisting
  shimdb             windows: Parse ShimDatabase
  registry           windows: Parse Registry
  userassist         windows: Parse Userassist
  shimcache          windows: Parse Shimcache
  shellbags          windows: Parse Shellbags
  amcache            windows: Parse Amcache
  shortcuts          windows: Parse Shortcuts
  usnjrnl            windows: Parse UsnJrnl
  bits               windows: Parse BITS
  srum               windows: Parse SRUM
  users-windows      windows: Parse Users
  search             windows: Parse Windows Search
  tasks              windows: Parse Windows Tasks
  services           windows: Parse Windows Services
  jumplists          windows: Parse Jumplists
  recyclebin         windows: Parse RecycleBin
  wmipersist         windows: Parse WMI Repository
  outlook            windows: Parse Outlook messages
  mft                windows: Parse MFT file
  execpolicy         macos: Parse ExecPolicy
  users-macos        macos: Collect local users
  fsevents           macos: Parse FsEvents entries
  emond              macos: Parse Emond persistence. Removed in Ventura
  loginitems         macos: Parse LoginItems
  launchd            macos: Parse Launch Daemons and Agents
  groups-macos       macos: Collect local groups
  safari-history     macos: Collect Safari History
  safari-downloads   macos: Collect Safari Downloads
  unifiedlogs        macos: Parse the Unified Logs
  sudologs-macos     macos: Parse Sudo log entries from Unified Logs
  spotlight          macos: Parse the Spotlight database
  sudologs-linux     linux: Grab Sudo logs
  journals           linux: Parse systemd Journal files
  logons             linux: Parse Logon files
  help               Print this message or the help of the given subcommand(s)

Options:
      --format <FORMAT>          Output format. JSON or JSONL or CSV [default: JSON]
      --output-dir <OUTPUT_DIR>  Optional output directory for storing results [default: ./tmp]
      --compress                 GZIP Compress results
      --timeline                 Timeline parsed data. Output is always JSONL
  -h, --help                     Print help



> artemis acquire processes
[artemis] Starting artemis collection!
[artemis] Writing output to: ./tmp
[artemis] Finished artemis collection!

./tmp/local_collector/
8706ce06-ff87-4ea9-8685-c96b64fb2cbe.log  ef308829-a667-496b-b983-d82e7fd7a631.json  status.log

About

A cross platform forensic parser written in Rust!

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •