pe-library 0.4.1: NtExecutableResource

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pe-library.NtExecutableResource in pkg:npm/pe-library@0.4.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/pe-library@0.4.1
Demonstrate these symbols/APIs:
  - pe-library.NtExecutableResource

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:10ccb5957ac2ad4d3f8b5aa9d14314acb5b72cfb2451db344595f849c37db7e0","contract":["NtExecutableResource.from creates a resource manager from an NtExecutable instance","NtExecutableResource.replaceResourceEntryFromString adds and retrieves UTF-8 string resources by type and ID","NtExecutableResource.replaceResourceEntry adds raw binary resource entries to the resource table","NtExecutableResource.outputResource writes resource section into NtExecutable preserving data across binary serialization and deserialization","NtExecutableResource.removeResourceEntry removes specified resource entries from the executable resource table"],"goal":"verify pe-library.NtExecutableResource in pkg:npm/pe-library@0.4.1","kind":"HOW","packages":["pkg:npm/pe-library@0.4.1"],"schemaVersion":1,"symbols":["pe-library.NtExecutableResource"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/pe-library@0.4.1"],"schemaVersion":1,"subject":"pkg:npm/pe-library@0.4.1","symbols":["pe-library.NtExecutableResource"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-pe-library-ntexecutableresource",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-pe-library-ntexecutableresource",
      "version": "1.0.0",
      "dependencies": {
        "pe-library": "0.4.1"
      }
    },
    "node_modules/pe-library": {
      "version": "0.4.1",
      "resolved": "https://registry.npmjs.org/pe-library/-/pe-library-0.4.1.tgz",
      "integrity": "sha512-eRWB5LBz7PpDu4PUlwT0PhnQfTQJlDDdPa35urV4Osrm0t0AqQFGn+UIkU3klZvwJ8KPO3VbBFsXquA6p6kqZw==",
      "license": "MIT",
      "engines": {
        "node": ">=12",
        "npm": ">=6"
      },
      "funding": {
        "type": "github",
        "url": "https://github.com/sponsors/jet2jet"
      }
    }
  }
}

{
  "name": "sample-pe-library-ntexecutableresource",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "pe-library": "0.4.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pe-library.NtExecutableResource in pkg:npm/pe-library@0.4.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/pe-library@0.4.1"
  ],
  "symbols": [
    "pe-library.NtExecutableResource"
  ]
}

import assert from 'node:assert/strict';
import { NtExecutable, NtExecutableResource } from 'pe-library';

// 1. NtExecutableResource.from creates a resource manager from an NtExecutable instance
const exe = NtExecutable.createEmpty(false, true); // 64-bit PE
const res = NtExecutableResource.from(exe);
assert.ok(res instanceof NtExecutableResource, 'res should be an instance of NtExecutableResource');
assert.equal(res.entries.length, 0, 'new empty executable should have 0 resource entries');

// 2. NtExecutableResource.replaceResourceEntryFromString adds and retrieves UTF-8 string resources by type and ID
res.replaceResourceEntryFromString('CUSTOM', 'DATA1', 1033, 'Hello CodeSampleX');
assert.equal(res.entries.length, 1, 'entries length should be 1 after adding string resource');
assert.equal(res.entries[0].type, 'CUSTOM', 'entry type should match');
assert.equal(res.entries[0].id, 'DATA1', 'entry id should match');
assert.equal(res.entries[0].lang, 1033, 'entry lang should match');

const strEntries = res.getResourceEntriesAsString('CUSTOM', 'DATA1');
assert.equal(strEntries.length, 1, 'should find 1 matching resource entry');
assert.equal(strEntries[0][0], 1033, 'tuple lang should match 1033');
assert.equal(strEntries[0][1], 'Hello CodeSampleX', 'tuple value should match original string');

// 3. NtExecutableResource.replaceResourceEntry adds raw binary resource entries to the resource table
const rawBytes = Buffer.from('RAW_RESOURCE_PAYLOAD');
const arrayBuf = rawBytes.buffer.slice(rawBytes.byteOffset, rawBytes.byteOffset + rawBytes.byteLength);
res.replaceResourceEntry({
  type: 10, // RT_RCDATA
  id: 100,
  lang: 0,
  codepage: 1200,
  bin: arrayBuf
});
assert.equal(res.entries.length, 2, 'entries length should be 2 after adding raw resource');

// 4. NtExecutableResource.outputResource writes resource section into NtExecutable preserving data across binary serialization and deserialization
res.outputResource(exe);
const binary = exe.generate();
assert.ok(binary instanceof ArrayBuffer, 'generate should return an ArrayBuffer');
assert.ok(binary.byteLength > 0, 'generated binary should not be empty');

const loadedExe = NtExecutable.from(binary);
const loadedRes = NtExecutableResource.from(loadedExe);
assert.equal(loadedRes.entries.length, 2, 'deserialized executable should retain 2 resource entries');

const loadedStrings = loadedRes.getResourceEntriesAsString('CUSTOM', 'DATA1');
assert.equal(loadedStrings.length, 1, 'deserialized string resource should be present');
assert.equal(loadedStrings[0][1], 'Hello CodeSampleX', 'deserialized string resource value should match');

// 5. NtExecutableResource.removeResourceEntry removes specified resource entries from the executable resource table
loadedRes.removeResourceEntry('CUSTOM', 'DATA1', 1033);
assert.equal(loadedRes.entries.length, 1, 'entries length should be 1 after removing entry');
assert.equal(loadedRes.getResourceEntriesAsString('CUSTOM', 'DATA1').length, 0, 'removed entry should no longer be found');

console.log('pe-library.NtExecutableResource contract passed');