pe-library 0.4.1: NtExecutable

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.NtExecutable 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.NtExecutable
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:2acbf9b8d82328af4ecec96bbfb050c6ab6cf749f7baef4918beecd98fbdb160","constraints":{"executionContext":"node"},"contract":["NtExecutable.createEmpty creates 64-bit and 32-bit PE executables with valid DOS and NT headers and alignment defaults","NtExecutable manages extra trailing data payload attached to executable","NtExecutable.generate serializes executable image into binary ArrayBuffer","NtExecutable.from parses binary ArrayBuffer restoring executable architecture, alignments, and extra payload data"],"goal":"verify pe-library.NtExecutable in pkg:npm/pe-library@0.4.1","kind":"HOW","packages":["pkg:npm/pe-library@0.4.1"],"schemaVersion":1,"symbols":["pe-library.NtExecutable"]},"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.NtExecutable"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-pe-library-ntexecutable",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-pe-library-ntexecutable",
      "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-ntexecutable",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "pe-library": "0.4.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pe-library.NtExecutable in pkg:npm/pe-library@0.4.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/pe-library@0.4.1"
  ],
  "symbols": [
    "pe-library.NtExecutable"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

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

// 1. NtExecutable.createEmpty creates 64-bit and 32-bit PE executables with headers and default alignments
const exe64 = NtExecutable.createEmpty(false, true);
assert.equal(exe64.is32bit(), false, 'createEmpty(false, true) should create 64-bit binary');
assert.ok(exe64.dosHeader, 'dosHeader should exist');
assert.ok(exe64.newHeader, 'newHeader should exist');
assert.equal(typeof exe64.getImageBase(), 'number', 'getImageBase should return number');
assert.equal(exe64.getFileAlignment(), 512, 'default file alignment should be 512');
assert.equal(exe64.getSectionAlignment(), 4096, 'default section alignment should be 4096');
assert.ok(exe64.getTotalHeaderSize() > 0, 'totalHeaderSize should be greater than zero');
assert.ok(Array.isArray(exe64.getAllSections()), 'getAllSections should return an array');

const exe32 = NtExecutable.createEmpty(true, false);
assert.equal(exe32.is32bit(), true, 'createEmpty(true, false) should create 32-bit binary');

// 2. NtExecutable manages extra trailing data payload attached to the binary
const extraPayload = Buffer.from('CSX-VERIFIED-PAYLOAD-DATA');
exe64.setExtraData(extraPayload);
const retrievedExtra = exe64.getExtraData();
assert.ok(retrievedExtra, 'extra data should be attached');
assert.equal(Buffer.from(retrievedExtra).toString('utf-8'), 'CSX-VERIFIED-PAYLOAD-DATA');

// 3. NtExecutable.generate serializes executable image into binary ArrayBuffer
const bin = exe64.generate();
assert.ok(bin instanceof ArrayBuffer, 'generate should return an ArrayBuffer');
assert.ok(bin.byteLength > 0, 'generated binary should have positive byteLength');
const checksum = calculateCheckSumForPE(bin);
assert.equal(typeof checksum, 'number', 'calculateCheckSumForPE should return a checksum number');

// 4. NtExecutable.from parses binary ArrayBuffer restoring executable architecture, alignments, and extra payload
const parsedExe = NtExecutable.from(bin);
assert.equal(parsedExe.is32bit(), false, 'parsed executable architecture should match 64-bit');
assert.equal(parsedExe.getFileAlignment(), exe64.getFileAlignment(), 'file alignment should match');
assert.equal(parsedExe.getSectionAlignment(), exe64.getSectionAlignment(), 'section alignment should match');
assert.equal(parsedExe.getImageBase(), exe64.getImageBase(), 'image base should match');
const parsedExtra = parsedExe.getExtraData();
assert.ok(parsedExtra, 'parsed executable should preserve extra data');
assert.equal(Buffer.from(parsedExtra).toString('utf-8'), 'CSX-VERIFIED-PAYLOAD-DATA');

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