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.
Checkout the Getting started section for walkthrough on how to start scripting with artemis!
The API can be broken down into two broad groups of categories:
- High level helper functions. For example, functions to read files, parse XML, base64 encode and decode, etc
| Category | Description |
|---|---|
| Filesystem | Functions to interact with the filesystem |
| Encoding | Functions to assist with encoding and decoding data |
| Environment | Functions to get environment variable details |
| Time | Functions to convert timestamps |
| System | Functions to get system related data |
| Nom | Functions to parse data using nom |
- Functions to directly parse OS artifacts
| Category | Description |
|---|---|
| Windows | Functions to parse Windows artifacts |
| macOS | Functions to parse macOS artifacts |
| Linux | Functions to parse Linux artifacts |
| Unix | Functions to parse Unix artifacts |
| FreeBSD | Functions to parse FreeBSD artifacts |
| Applications | Functions to parse Application artifacts |