@isopodlabs/binary_libs 1.2.0 → 1.3.0

package/dist/pe.d.ts

@@ -1,136 +1,191 @@
-import * as binary from '@isopodlabs/binary';
-declare const DOS_HEADER: {
-    magic: binary.TypeT<number>;
-    cblp: binary.TypeT<number>;
-    cp: binary.TypeT<number>;
-    crlc: binary.TypeT<number>;
-    cparhdr: binary.TypeT<number>;
-    minalloc: binary.TypeT<number>;
-    maxalloc: binary.TypeT<binary.hex<number | bigint>>;
-    ss: binary.TypeT<number>;
-    sp: binary.TypeT<number>;
-    csum: binary.TypeT<number>;
-    ip: binary.TypeT<number>;
-    cs: binary.TypeT<number>;
-    lfarlc: binary.TypeT<number>;
-    ovno: binary.TypeT<number>;
-};
-declare const EXE_HEADER: {
-    res: binary.TypeT<number[]>;
-    oemid: binary.TypeT<number>;
-    oeminfo: binary.TypeT<number>;
-    res2: binary.TypeT<number[]>;
-    lfanew: binary.TypeT<number>;
-};
-export declare class pe_stream extends binary.stream {
-    pe: PE;
-    constructor(pe: PE, data: Uint8Array);
-    get_rva(): Uint8Array | undefined;
-}
+import * as bin from '@isopodlabs/binary';
+import { ReadCLR } from './clr';
 declare const FILE_HEADER: {
-    Machine: binary.TypeT<string>;
-    NumberOfSections: binary.TypeT<number>;
-    TimeDateStamp: binary.TypeT<number>;
-    PointerToSymbolTable: binary.TypeT<number>;
-    NumberOfSymbols: binary.TypeT<number>;
-    SizeOfOptionalHeader: binary.TypeT<number>;
-    Characteristics: binary.TypeT<number>;
+    Machine: bin.TypeT<string>;
+    NumberOfSections: bin.TypeT<number>;
+    TimeDateStamp: bin.TypeT<number>;
+    PointerToSymbolTable: bin.TypeT<number>;
+    NumberOfSymbols: bin.TypeT<number>;
+    SizeOfOptionalHeader: bin.TypeT<number>;
+    Characteristics: bin.TypeT<number>;
 };
-declare const Section_base: (new (s: binary._stream) => {
+declare const Section_base: (new (s: bin._stream) => {
     Name: string;
     VirtualSize: number;
-    VirtualAddress: binary.hex<number | bigint>;
+    VirtualAddress: bin.hex<number | bigint>;
     SizeOfRawData: number;
-    PointerToRawData: binary.hex<number | bigint>;
-    PointerToRelocations: binary.hex<number | bigint>;
-    PointerToLinenumbers: binary.hex<number | bigint>;
+    PointerToRawData: bin.hex<number | bigint>;
+    PointerToRelocations: bin.hex<number | bigint>;
+    PointerToLinenumbers: bin.hex<number | bigint>;
     NumberOfRelocations: number;
     NumberOfLinenumbers: number;
     Characteristics: Record<string, bigint | boolean> | Record<string, number | boolean>;
 }) & {
-    get: <X extends abstract new (...args: any) => any>(this: X, s: binary._stream) => InstanceType<X>;
+    get: <X extends abstract new (...args: any) => any>(this: X, s: bin._stream) => InstanceType<X>;
 };
 export declare class Section extends Section_base {
-    data?: binary.MappedMemory;
-    constructor(r: binary.stream);
+    data?: bin.MappedMemory;
+    constructor(r: bin.stream);
     get flags(): number;
 }
+export declare class COFF {
+    static check(data: Uint8Array): boolean;
+    header: bin.ReadType<typeof FILE_HEADER>;
+    opt?: bin.ReadType<typeof OPTIONAL_HEADER> & (bin.ReadType<typeof OPTIONAL_HEADER32> | bin.ReadType<typeof OPTIONAL_HEADER64>);
+    sections: Section[];
+    constructor(data: Uint8Array);
+}
+declare const COFFSymbol_base: (new (s: bin._stream) => {
+    a: number;
+    b: number;
+    c: number;
+    Architecture: string;
+    Id: number;
+    Length: number;
+    Value: number;
+    Type: number;
+    Symbol: string;
+    Module: string;
+}) & {
+    get: <X extends abstract new (...args: any) => any>(this: X, s: bin._stream) => InstanceType<X>;
+};
+export declare class COFFSymbol extends COFFSymbol_base {
+    static check(data: Uint8Array): boolean;
+    constructor(data: Uint8Array);
+}
+export declare class pe_stream extends bin.stream {
+    pe: PE;
+    constructor(pe: PE, data: Uint8Array);
+    translate_rva(addr: number): bin.MappedMemory | undefined;
+    get_rva(): Uint8Array | undefined;
+}
+declare const DOS_HEADER: {
+    magic: bin.TypeT<number>;
+    cblp: bin.TypeT<number>;
+    cp: bin.TypeT<number>;
+    crlc: bin.TypeT<number>;
+    cparhdr: bin.TypeT<number>;
+    minalloc: bin.TypeT<number>;
+    maxalloc: bin.TypeT<bin.hex<number | bigint>>;
+    ss: bin.TypeT<number>;
+    sp: bin.TypeT<number>;
+    csum: bin.TypeT<number>;
+    ip: bin.TypeT<number>;
+    cs: bin.TypeT<number>;
+    lfarlc: bin.TypeT<number>;
+    ovno: bin.TypeT<number>;
+};
+declare const EXE_HEADER: {
+    res: bin.TypeT<number[]>;
+    oemid: bin.TypeT<number>;
+    oeminfo: bin.TypeT<number>;
+    res2: bin.TypeT<number[]>;
+    lfanew: bin.TypeT<number>;
+};
 interface DirectoryInfo {
-    read?: (pe: PE, data: binary.MappedMemory) => any;
+    read: (pe: PE, data: bin.MappedMemory) => unknown;
 }
-export declare const DIRECTORIES: Record<string, DirectoryInfo>;
+export declare const DIRECTORIES: {
+    readonly EXPORT: {
+        readonly read: (pe: PE, data: bin.MappedMemory) => (string | number | bin.MappedMemory | undefined)[][];
+    };
+    readonly IMPORT: {
+        readonly read: (pe: PE, data: bin.MappedMemory) => [string, any][];
+    };
+    readonly RESOURCE: {
+        readonly read: (pe: PE, data: bin.MappedMemory) => Record<string, any>;
+    };
+    readonly EXCEPTION: DirectoryInfo;
+    readonly SECURITY: DirectoryInfo;
+    readonly BASERELOC: DirectoryInfo;
+    readonly DEBUG_DIR: DirectoryInfo;
+    readonly ARCHITECTURE: DirectoryInfo;
+    readonly GLOBALPTR: DirectoryInfo;
+    readonly TLS: DirectoryInfo;
+    readonly LOAD_CONFIG: DirectoryInfo;
+    readonly BOUND_IMPORT: DirectoryInfo;
+    readonly IAT: DirectoryInfo;
+    readonly DELAY_IMPORT: DirectoryInfo;
+    readonly CLR_DESCRIPTOR: {
+        readonly read: typeof ReadCLR;
+    };
+};
+type DirectoryName = keyof typeof DIRECTORIES;
+type DirectoryReadResult<T extends DirectoryName> = typeof DIRECTORIES[T] extends {
+    read: (pe: PE, data: bin.MappedMemory) => infer R;
+} ? R : bin.MappedMemory | undefined;
 export declare const DATA_DIRECTORY: {
-    VirtualAddress: binary.TypeT<number>;
-    Size: binary.TypeT<number>;
+    VirtualAddress: bin.TypeT<number>;
+    Size: bin.TypeT<number>;
 };
-type Directory = binary.ReadType<typeof DATA_DIRECTORY>;
+type Directory = bin.ReadType<typeof DATA_DIRECTORY>;
 declare const OPTIONAL_HEADER: {
-    Magic: binary.TypeT<string>;
-    MajorLinkerVersion: binary.TypeT<number>;
-    MinorLinkerVersion: binary.TypeT<number>;
-    SizeOfCode: binary.TypeT<number>;
-    SizeOfInitializedData: binary.TypeT<number>;
-    SizeOfUninitializedData: binary.TypeT<number>;
-    AddressOfEntryPoint: binary.TypeT<binary.hex<number | bigint>>;
-    BaseOfCode: binary.TypeT<binary.hex<number | bigint>>;
+    Magic: bin.TypeT<string>;
+    MajorLinkerVersion: bin.TypeT<number>;
+    MinorLinkerVersion: bin.TypeT<number>;
+    SizeOfCode: bin.TypeT<number>;
+    SizeOfInitializedData: bin.TypeT<number>;
+    SizeOfUninitializedData: bin.TypeT<number>;
+    AddressOfEntryPoint: bin.TypeT<bin.hex<number | bigint>>;
+    BaseOfCode: bin.TypeT<bin.hex<number | bigint>>;
 };
 declare const OPTIONAL_HEADER32: {
-    BaseOfData: binary.TypeT<binary.hex<number | bigint>>;
-    ImageBase: binary.TypeT<binary.hex<number | bigint>>;
-    SectionAlignment: binary.TypeT<number>;
-    FileAlignment: binary.TypeT<number>;
-    MajorOperatingSystemVersion: binary.TypeT<number>;
-    MinorOperatingSystemVersion: binary.TypeT<number>;
-    MajorImageVersion: binary.TypeT<number>;
-    MinorImageVersion: binary.TypeT<number>;
-    MajorSubsystemVersion: binary.TypeT<number>;
-    MinorSubsystemVersion: binary.TypeT<number>;
-    Win32VersionValue: binary.TypeT<number>;
-    SizeOfImage: binary.TypeT<number>;
-    SizeOfHeaders: binary.TypeT<number>;
-    CheckSum: binary.TypeT<number>;
-    Subsystem: binary.TypeT<number>;
-    DllCharacteristics: binary.TypeT<Record<string, bigint | boolean> | Record<string, number | boolean>>;
-    SizeOfStackReserve: binary.TypeT<number>;
-    SizeOfStackCommit: binary.TypeT<number>;
-    SizeOfHeapReserve: binary.TypeT<number>;
-    SizeOfHeapCommit: binary.TypeT<number>;
-    LoaderFlags: binary.TypeT<number>;
-    DataDirectory: binary.TypeT<Record<string, {
+    BaseOfData: bin.TypeT<bin.hex<number | bigint>>;
+    ImageBase: bin.TypeT<bin.hex<number | bigint>>;
+    SectionAlignment: bin.TypeT<number>;
+    FileAlignment: bin.TypeT<number>;
+    MajorOperatingSystemVersion: bin.TypeT<number>;
+    MinorOperatingSystemVersion: bin.TypeT<number>;
+    MajorImageVersion: bin.TypeT<number>;
+    MinorImageVersion: bin.TypeT<number>;
+    MajorSubsystemVersion: bin.TypeT<number>;
+    MinorSubsystemVersion: bin.TypeT<number>;
+    Win32VersionValue: bin.TypeT<number>;
+    SizeOfImage: bin.TypeT<number>;
+    SizeOfHeaders: bin.TypeT<number>;
+    CheckSum: bin.TypeT<number>;
+    Subsystem: bin.TypeT<number>;
+    DllCharacteristics: bin.TypeT<Record<string, bigint | boolean> | Record<string, number | boolean>>;
+    SizeOfStackReserve: bin.TypeT<number>;
+    SizeOfStackCommit: bin.TypeT<number>;
+    SizeOfHeapReserve: bin.TypeT<number>;
+    SizeOfHeapCommit: bin.TypeT<number>;
+    LoaderFlags: bin.TypeT<number>;
+    DataDirectory: bin.TypeT<Record<string, {
         VirtualAddress: number;
         Size: number;
     }>>;
 };
 declare const OPTIONAL_HEADER64: {
-    ImageBase: binary.TypeT<binary.hex<number | bigint>>;
-    SectionAlignment: binary.TypeT<number>;
-    FileAlignment: binary.TypeT<number>;
-    MajorOperatingSystemVersion: binary.TypeT<number>;
-    MinorOperatingSystemVersion: binary.TypeT<number>;
-    MajorImageVersion: binary.TypeT<number>;
-    MinorImageVersion: binary.TypeT<number>;
-    MajorSubsystemVersion: binary.TypeT<number>;
-    MinorSubsystemVersion: binary.TypeT<number>;
-    Win32VersionValue: binary.TypeT<number>;
-    SizeOfImage: binary.TypeT<number>;
-    SizeOfHeaders: binary.TypeT<number>;
-    CheckSum: binary.TypeT<number>;
-    Subsystem: binary.TypeT<number>;
-    DllCharacteristics: binary.TypeT<Record<string, bigint | boolean> | Record<string, number | boolean>>;
-    SizeOfStackReserve: binary.TypeT<bigint>;
-    SizeOfStackCommit: binary.TypeT<bigint>;
-    SizeOfHeapReserve: binary.TypeT<bigint>;
-    SizeOfHeapCommit: binary.TypeT<bigint>;
-    LoaderFlags: binary.TypeT<number>;
-    DataDirectory: binary.TypeT<Record<string, {
+    ImageBase: bin.TypeT<bin.hex<number | bigint>>;
+    SectionAlignment: bin.TypeT<number>;
+    FileAlignment: bin.TypeT<number>;
+    MajorOperatingSystemVersion: bin.TypeT<number>;
+    MinorOperatingSystemVersion: bin.TypeT<number>;
+    MajorImageVersion: bin.TypeT<number>;
+    MinorImageVersion: bin.TypeT<number>;
+    MajorSubsystemVersion: bin.TypeT<number>;
+    MinorSubsystemVersion: bin.TypeT<number>;
+    Win32VersionValue: bin.TypeT<number>;
+    SizeOfImage: bin.TypeT<number>;
+    SizeOfHeaders: bin.TypeT<number>;
+    CheckSum: bin.TypeT<number>;
+    Subsystem: bin.TypeT<number>;
+    DllCharacteristics: bin.TypeT<Record<string, bigint | boolean> | Record<string, number | boolean>>;
+    SizeOfStackReserve: bin.TypeT<bigint>;
+    SizeOfStackCommit: bin.TypeT<bigint>;
+    SizeOfHeapReserve: bin.TypeT<bigint>;
+    SizeOfHeapCommit: bin.TypeT<bigint>;
+    LoaderFlags: bin.TypeT<number>;
+    DataDirectory: bin.TypeT<Record<string, {
         VirtualAddress: number;
         Size: number;
     }>>;
 };
 export declare class PE {
     static check(data: Uint8Array): boolean;
-    header: binary.ReadType<typeof DOS_HEADER> & binary.ReadType<typeof EXE_HEADER>;
-    opt?: binary.ReadType<typeof OPTIONAL_HEADER> & (binary.ReadType<typeof OPTIONAL_HEADER32> | binary.ReadType<typeof OPTIONAL_HEADER64>);
+    header: bin.ReadType<typeof DOS_HEADER> & bin.ReadType<typeof EXE_HEADER>;
+    opt?: bin.ReadType<typeof OPTIONAL_HEADER> & (bin.ReadType<typeof OPTIONAL_HEADER32> | bin.ReadType<typeof OPTIONAL_HEADER64>);
     sections: Section[];
     constructor(data: Uint8Array);
     get directories(): Record<string, {
@@ -139,39 +194,14 @@ export declare class PE {
     }> | undefined;
     FindSectionRVA(rva: number): Section | undefined;
     FindSectionRaw(addr: number): Section | undefined;
-    GetDataRVA(rva: number, size?: number): binary.MappedMemory | undefined;
+    GetDataRVA(rva: number, size?: number): bin.MappedMemory | undefined;
     GetDataRaw(addr: number, size: number): Uint8Array | undefined;
-    GetDataDir(dir: Directory): binary.MappedMemory | undefined;
-    ReadDirectory(name: string): any;
-}
-export declare class COFF {
-    static check(data: Uint8Array): boolean;
-    header: binary.ReadType<typeof FILE_HEADER>;
-    opt?: binary.ReadType<typeof OPTIONAL_HEADER> & (binary.ReadType<typeof OPTIONAL_HEADER32> | binary.ReadType<typeof OPTIONAL_HEADER64>);
-    sections: Section[];
-    constructor(data: Uint8Array);
-}
-declare const COFFSymbol_base: (new (s: binary._stream) => {
-    a: number;
-    b: number;
-    c: number;
-    Architecture: string;
-    Id: number;
-    Length: number;
-    Value: number;
-    Type: number;
-    Symbol: string;
-    Module: string;
-}) & {
-    get: <X extends abstract new (...args: any) => any>(this: X, s: binary._stream) => InstanceType<X>;
-};
-export declare class COFFSymbol extends COFFSymbol_base {
-    static check(data: Uint8Array): boolean;
-    constructor(data: Uint8Array);
+    GetDataDir(dir: Directory): bin.MappedMemory | undefined;
+    ReadDirectory<T extends DirectoryName>(name: T): DirectoryReadResult<T>;
 }
-export declare function ReadExports(file: pe_stream): (string | number | binary.MappedMemory | undefined)[][];
+export declare function ReadExports(file: pe_stream): (string | number | bin.MappedMemory | undefined)[][];
 export declare class DLLImports extends Array {
 }
 export declare function ReadImports(file: pe_stream): [string, any][];
-export declare function ReadResourceDirectory(file: binary.stream, data: binary.MappedMemory, type?: number): Record<string, any>;
+export declare function ReadResourceDirectory(file: pe_stream, type?: number): Record<string, any>;
 export {};