Skip to main content

API Intro

Currently the artemis API is very basic. It mainly exposes Rust functions that are callable from JavaScript. The artemis-api contains TypeScript bindings to make it easier for users to script and call these functions. There also a handful of API functions for artifact parsers that are written in pure TypeScript.

The API can be broken down into two broad groups of categories:

  1. Highlevel helper functions. For example, functions to read files, parse XML, base64 encode and decode, etc
CategoryDescription
FilesystemFunctions to interact with the filesystem
EncodingFunctions to assist with encoding and decoding data
EnvironmentFunctions to get environment variable details
TimeFunctions to convert timestamps
SystemFunctions to get system related data
NomFunctions to parse data using nom
  1. Functions to directly parse OS artifacts
CategoryDescription
WindowsFunctions to parse Windows artifacts
macOSFunctions to parse macOS artifacts
LinuxFunctions to parse Linux artifacts
UnixFunctions to parse Unix artifacts
ApplicationsFunctions to parse Application artifacts