Installation

npm i uncoverit

Usage

Important

Please ensure these functions are always ran on the server-side to prevent API key abuse.

import { fetchBalance, exists, upload, staticReport } from "uncoverit";

// exported types
import { BalanceResponseType, UploadResponseType, StaticAnalysisDataType }

Fetching balance:

await fetchBalance(apiKey);

Example Response:

{
  "requests_left": 1000,
  "expiration_date": "2024-08-26T10:00:00Z"
}

Checking if file exists (Upload function already does this:

await exists(apiKey, file); // file can be a File, Blob or a SHA-256 hash string

Example Response:

true

Uploading a file:

await upload(apiKey, file); // file can be a File or a Blob

Example Response:

{ "blake3Hash": "8347c2669ff2a7d5a1c2e73171bec5c36e3ac5654699c20a622ebf24860255c8" }

Fetching a static analysis report:

Important

This response is automatically cached and memoized.

await staticReport(apiKey, hash); // hash can be SHA-256, SHA-512 or BLAKE3

Example Response:

{
  "date": "2024-08-26T10:00:00Z",
  "blake3Hash": "8347c2669ff2a7d5a1c2e73171bec5c36e3ac5654699c20a622ebf24860255c8",
  "sha512Hash": "8b16496acb3c6671439588287940817892c8920249c4bc967072c537a826afb398d381ff654a196726c0763e129e24c4660dfa39cfc5e42ffa14eacf558af61a",
  "sha256Hash": "2c2751b069c34f810f152dd13b6c527d20d1ac6552f2ea702da1c1fb7b0c505b",
  "sha1Hash": "22dff75a842daeff1919b5fae8bcb2785193873e",
  "mD5Hash": "3e0b4724c6cb604ffef0c10dcff400de",
  "ssDeep": "3072:Xc1GZ7XaS7pNifbi+nIhROuvgGUVrYdVCQ2zrUIx0Exaa2kAHRKdey6rOaxrmKSQ:Xc1G1XJp+bzASHzwIx0tEAHREeKam",
  "fileName": "AccountGrabber.exe",
  "sizeInBytes": 270336,
  "tags": [
    {
      "name": "RAT",
      "heat": 1,
    }, {
      "name": "XWORM",
      "heat": 10,
    }
  ],
  "configs": {
    "XWORM": {
      "C2s": "example.com",
      "Ports": "8080",
      "Traffic Encryption Key": "<123456789>",
      "Mutex": "A9lWJ0tQCdsEozbm",
      "Delimiter": "<Xwormmm>",
      "Version": "XWorm V5.2",
      "Bitcoin Address": "0xfaF7bFf63a4C43d6D05eA8733911df2111c3238e",
      "Telegram Bot Token": "8120265505:AAFwq8bHiPgQsIrf26384ddYSCnMRcKVrN0",
      "Telegram Chat Id": "-4916970420",
    },
  },
  "staticAnalysisDuration": "00:00:00.0427370",
}

npm

Installation

Usage

On this page