Пакет pe

import "debug/pe"
Обзор
Индекс

Обзор

Пакет pe реализует доступ к файлам PE (Microsoft Windows Portable Executable).

Безопасность

Этот пакет не предназначен для защиты от вредоносных входных данных и находится вне сферы применения https://go.dev/security/policy. В частности, при разборе объектных файлов выполняется только базовая проверка. Поэтому следует проявлять осторожность при разборе недоверенных входных данных, так как разбор повреждённых файлов может потребовать значительных ресурсов или привести к панике.

Индекс

Константы
Тип COFFSymbol
Функция (sym *COFFSymbol) FullName(st StringTable) (string, error)
Тип COFFSymbolAuxFormat5
Тип DataDirectory
Тип File
Функция NewFile(r io.ReaderAt) (*File, error)
Функция Open(name string) (*File, error)
Функция (f *File) COFFSymbolReadSectionDefAux(idx int) (*COFFSymbolAuxFormat5, error)
Функция (f *File) Close() error
Функция (f *File) DWARF() (*dwarf.Data, error)
Функция (f *File) ImportedLibraries() ([]string, error)
Функция (f *File) ImportedSymbols() ([]string, error)
Функция (f *File) Section(name string) *Section
Тип FileHeader
Тип FormatError
Функция (e *FormatError) Error() string
Тип ImportDirectory
Тип OptionalHeader32
Тип OptionalHeader64
Тип Reloc
Тип Section
Функция (s *Section) Data() ([]byte, error)
Функция (s *Section) Open() io.ReadSeeker
Тип SectionHeader
Тип SectionHeader32
Тип StringTable
Функция (st StringTable) String(start uint32) (string, error)
Тип Symbol

Файлы пакета

file.go pe.go section.go string.go symbol.go

Константы

const (
    IMAGE_FILE_MACHINE_UNKNOWN     = 0x0
    IMAGE_FILE_MACHINE_AM33        = 0x1d3
    IMAGE_FILE_MACHINE_AMD64       = 0x8664
    IMAGE_FILE_MACHINE_ARM         = 0x1c0
    IMAGE_FILE_MACHINE_ARMNT       = 0x1c4
    IMAGE_FILE_MACHINE_ARM64       = 0xaa64
    IMAGE_FILE_MACHINE_EBC         = 0xebc
    IMAGE_FILE_MACHINE_I386        = 0x14c
    IMAGE_FILE_MACHINE_IA64        = 0x200
    IMAGE_FILE_MACHINE_LOONGARCH32 = 0x6232
    IMAGE_FILE_MACHINE_LOONGARCH64 = 0x6264
    IMAGE_FILE_MACHINE_M32R        = 0x9041
    IMAGE_FILE_MACHINE_MIPS16      = 0x266
    IMAGE_FILE_MACHINE_MIPSFPU     = 0x366
    IMAGE_FILE_MACHINE_MIPSFPU16   = 0x466
    IMAGE_FILE_MACHINE_POWERPC     = 0x1f0
    IMAGE_FILE_MACHINE_POWERPCFP   = 0x1f1
    IMAGE_FILE_MACHINE_R4000       = 0x166
    IMAGE_FILE_MACHINE_SH3         = 0x1a2
    IMAGE_FILE_MACHINE_SH3DSP      = 0x1a3
    IMAGE_FILE_MACHINE_SH4         = 0x1a6
    IMAGE_FILE_MACHINE_SH5         = 0x1a8
    IMAGE_FILE_MACHINE_THUMB       = 0x1c2
    IMAGE_FILE_MACHINE_WCEMIPSV2   = 0x169
    IMAGE_FILE_MACHINE_RISCV32     = 0x5032
    IMAGE_FILE_MACHINE_RISCV64     = 0x5064
    IMAGE_FILE_MACHINE_RISCV128    = 0x5128
)

Константы IMAGE_DIRECTORY_ENTRY

const (
    IMAGE_DIRECTORY_ENTRY_EXPORT         = 0
    IMAGE_DIRECTORY_ENTRY_IMPORT         = 1
    IMAGE_DIRECTORY_ENTRY_RESOURCE       = 2
    IMAGE_DIRECTORY_ENTRY_EXCEPTION      = 3
    IMAGE_DIRECTORY_ENTRY_SECURITY       = 4
    IMAGE_DIRECTORY_ENTRY_BASERELOC      = 5
    IMAGE_DIRECTORY_ENTRY_DEBUG          = 6
    IMAGE_DIRECTORY_ENTRY_ARCHITECTURE   = 7
    IMAGE_DIRECTORY_ENTRY_GLOBALPTR      = 8
    IMAGE_DIRECTORY_ENTRY_TLS            = 9
    IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG    = 10
    IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT   = 11
    IMAGE_DIRECTORY_ENTRY_IAT            = 12
    IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT   = 13
    IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR = 14
)

Значения IMAGE_FILE_HEADER.Characteristics. Их можно объединять.

const (
    IMAGE_FILE_RELOCS_STRIPPED         = 0x0001
    IMAGE_FILE_EXECUTABLE_IMAGE        = 0x0002
    IMAGE_FILE_LINE_NUMS_STRIPPED      = 0x0004
    IMAGE_FILE_LOCAL_SYMS_STRIPPED     = 0x0008
    IMAGE_FILE_AGGRESIVE_WS_TRIM       = 0x0010
    IMAGE_FILE_LARGE_ADDRESS_AWARE     = 0x0020
    IMAGE_FILE_BYTES_REVERSED_LO       = 0x0080
    IMAGE_FILE_32BIT_MACHINE           = 0x0100
    IMAGE_FILE_DEBUG_STRIPPED          = 0x0200
    IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400
    IMAGE_FILE_NET_RUN_FROM_SWAP       = 0x0800
    IMAGE_FILE_SYSTEM                  = 0x1000
    IMAGE_FILE_DLL                     = 0x2000
    IMAGE_FILE_UP_SYSTEM_ONLY          = 0x4000
    IMAGE_FILE_BYTES_REVERSED_HI       = 0x8000
)

Значения OptionalHeader64.Subsystem и OptionalHeader32.Subsystem.

const (
    IMAGE_SUBSYSTEM_UNKNOWN                  = 0
    IMAGE_SUBSYSTEM_NATIVE                   = 1
    IMAGE_SUBSYSTEM_WINDOWS_GUI              = 2
    IMAGE_SUBSYSTEM_WINDOWS_CUI              = 3
    IMAGE_SUBSYSTEM_OS2_CUI                  = 5
    IMAGE_SUBSYSTEM_POSIX_CUI                = 7
    IMAGE_SUBSYSTEM_NATIVE_WINDOWS           = 8
    IMAGE_SUBSYSTEM_WINDOWS_CE_GUI           = 9
    IMAGE_SUBSYSTEM_EFI_APPLICATION          = 10
    IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER  = 11
    IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER       = 12
    IMAGE_SUBSYSTEM_EFI_ROM                  = 13
    IMAGE_SUBSYSTEM_XBOX                     = 14
    IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16
)

Значения OptionalHeader64.DllCharacteristics и OptionalHeader32.DllCharacteristics. Их можно объединять.

const (
    IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA       = 0x0020
    IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE          = 0x0040
    IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY       = 0x0080
    IMAGE_DLLCHARACTERISTICS_NX_COMPAT             = 0x0100
    IMAGE_DLLCHARACTERISTICS_NO_ISOLATION          = 0x0200
    IMAGE_DLLCHARACTERISTICS_NO_SEH                = 0x0400
    IMAGE_DLLCHARACTERISTICS_NO_BIND               = 0x0800
    IMAGE_DLLCHARACTERISTICS_APPCONTAINER          = 0x1000
    IMAGE_DLLCHARACTERISTICS_WDM_DRIVER            = 0x2000
    IMAGE_DLLCHARACTERISTICS_GUARD_CF              = 0x4000
    IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
)

Флаги характеристик секции.

const (
    IMAGE_SCN_CNT_CODE               = 0x00000020
    IMAGE_SCN_CNT_INITIALIZED_DATA   = 0x00000040
    IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080
    IMAGE_SCN_LNK_COMDAT             = 0x00001000
    IMAGE_SCN_MEM_DISCARDABLE        = 0x02000000
    IMAGE_SCN_MEM_EXECUTE            = 0x20000000
    IMAGE_SCN_MEM_READ               = 0x40000000
    IMAGE_SCN_MEM_WRITE              = 0x80000000
)

Эти константы представляют возможные значения поля "Selection" в AuxFormat5.

const (
    IMAGE_COMDAT_SELECT_NODUPLICATES = 1
    IMAGE_COMDAT_SELECT_ANY          = 2
    IMAGE_COMDAT_SELECT_SAME_SIZE    = 3
    IMAGE_COMDAT_SELECT_EXACT_MATCH  = 4
    IMAGE_COMDAT_SELECT_ASSOCIATIVE  = 5
    IMAGE_COMDAT_SELECT_LARGEST      = 6
)

const COFFSymbolSize = 18

Тип COFFSymbol 1.1

COFFSymbol представляет собой запись в таблице символов COFF.

type COFFSymbol struct {
    Name               [8]uint8
    Value              uint32
    SectionNumber      int16
    Type               uint16
    StorageClass       uint8
    NumberOfAuxSymbols uint8
}

Функция (*COFFSymbol) FullName 1.8

func (sym *COFFSymbol) FullName(st StringTable) (string, error)

FullName находит реальное имя символа sym. Обычно имя хранится в sym.Name, но если оно длиннее 8 символов, оно хранится в таблице строк COFF st.

Тип COFFSymbolAuxFormat5 1.19

COFFSymbolAuxFormat5 описывает ожидаемый вид вспомогательного символа, прикреплённого к символу определения секции. Формат PE определяет ряд различных форматов вспомогательных символов: формат 1 для определений функций, формат 2 для символов .be и .ef и так далее. Формат 5 содержит дополнительную информацию, связанную с определением секции, включая количество перемещений + номера строк, а также информацию о COMDAT. См. https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-format-5-section-definitions для получения дополнительной информации.

type COFFSymbolAuxFormat5 struct {
    Size           uint32
    NumRelocs      uint16
    NumLineNumbers uint16
    Checksum       uint32
    SecNum         uint16
    Selection      uint8
    // contains filtered or unexported fields
}

Тип DataDirectory 1.3

type DataDirectory struct {
    VirtualAddress uint32
    Size           uint32
}

Тип File

File представляет собой открытый файл PE.

type File struct {
    FileHeader
    OptionalHeader any // of type *OptionalHeader32 or *OptionalHeader64; added in Go 1.3
    Sections       []*Section
    Symbols        []*Symbol    // COFF symbols with auxiliary symbol records removed; added in Go 1.1
    COFFSymbols    []COFFSymbol // all COFF symbols (including auxiliary symbol records); added in Go 1.8
    StringTable    StringTable // Go 1.8
    // contains filtered or unexported fields
}

Функция NewFile

func NewFile(r io.ReaderAt) (*File, error)

NewFile создаёт новый File для доступа к PE-бинарнику в базовом читателе.

Функция Open

func Open(name string) (*File, error)

Open открывает указанный файл с помощью os.Open и подготавливает его для использования в качестве PE-бинарника.

Функция (*File) COFFSymbolReadSectionDefAux 1.19

func (f *File) COFFSymbolReadSectionDefAux(idx int) (*COFFSymbolAuxFormat5, error)

COFFSymbolReadSectionDefAux возвращает фрагмент вспомогательной информации (включая информацию COMDAT) для символа определения секции. Здесь "idx" — индекс символа секции в основном массиве COFFSymbol для File. Значение возвращаемого результата — указатель на соответствующую структуру вспомогательного символа. Для получения дополнительной информации см.:

вспомогательные символы: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-symbol-records секции COMDAT: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#comdat-sections-object-only вспомогательная информация для определений секций: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-format-5-section-definitions

Функция (*File) Close

func (f *File) Close() error

Close закрывает File. Если File был создан с помощью NewFile напрямую, а не Open, Close не оказывает никакого влияния.

Функция (*File) DWARF

func (f *File) DWARF() (*dwarf.Data, error)

Функция (*File) ImportedLibraries

func (f *File) ImportedLibraries() ([]string, error)

ImportedLibraries возвращает имена всех библиотек, на которые ссылается бинарник f и которые должны быть связаны с бинарником во время динамической связи.

Функция (*File) ImportedSymbols

func (f *File) ImportedSymbols() ([]string, error)

ImportedSymbols возвращает имена всех символов, на которые ссылается бинарник f, и которые должны быть удовлетворены другими библиотеками во время динамической загрузки. Он не возвращает слабые символы.

Функция (*File) Section

func (f *File) Section(name string) *Section

Section возвращает первую секцию с данным именем или nil, если такая секция не существует.

Тип FileHeader

type FileHeader struct {
    Machine              uint16
    NumberOfSections     uint16
    TimeDateStamp        uint32
    PointerToSymbolTable uint32
    NumberOfSymbols      uint32
    SizeOfOptionalHeader uint16
    Characteristics      uint16
}

Тип FormatError

FormatError не используется. Тип сохранён для совместимости.

type FormatError struct {
}

Функция (*FormatError) Error

func (e *FormatError) Error() string

Тип ImportDirectory

type ImportDirectory struct {
    OriginalFirstThunk uint32
    TimeDateStamp      uint32
    ForwarderChain     uint32
    Name               uint32
    FirstThunk         uint32
    // contains filtered or unexported fields
}

Тип OptionalHeader32 1.3

type OptionalHeader32 struct {
    Magic                       uint16
    MajorLinkerVersion          uint8
    MinorLinkerVersion          uint8
    SizeOfCode                  uint32
    SizeOfInitializedData       uint32
    SizeOfUninitializedData     uint32
    AddressOfEntryPoint         uint32
    BaseOfCode                  uint32
    BaseOfData                  uint32
    ImageBase                   uint32
    SectionAlignment            uint32
    FileAlignment               uint32
    MajorOperatingSystemVersion uint16
    MinorOperatingSystemVersion uint16
    MajorImageVersion           uint16
    MinorImageVersion           uint16
    MajorSubsystemVersion       uint16
    MinorSubsystemVersion       uint16
    Win32VersionValue           uint32
    SizeOfImage                 uint32
    SizeOfHeaders               uint32
    CheckSum                    uint32
    Subsystem                   uint16
    DllCharacteristics          uint16
    SizeOfStackReserve          uint32
    SizeOfStackCommit           uint32
    SizeOfHeapReserve           uint32
    SizeOfHeapCommit            uint32
    LoaderFlags                 uint32
    NumberOfRvaAndSizes         uint32
    DataDirectory               [16]DataDirectory
}

Тип OptionalHeader64 1.3

type OptionalHeader64 struct {
    Magic                       uint16
    MajorLinkerVersion          uint8
    MinorLinkerVersion          uint8
    SizeOfCode                  uint32
    SizeOfInitializedData       uint32
    SizeOfUninitializedData     uint32
    AddressOfEntryPoint         uint32
    BaseOfCode                  uint32
    ImageBase                   uint64
    SectionAlignment            uint32
    FileAlignment               uint32
    MajorOperatingSystemVersion uint16
    MinorOperatingSystemVersion uint16
    MajorImageVersion           uint16
    MinorImageVersion           uint16
    MajorSubsystemVersion       uint16
    MinorSubsystemVersion       uint16
    Win32VersionValue           uint32
    SizeOfImage                 uint32
    SizeOfHeaders               uint32
    CheckSum                    uint32
    Subsystem                   uint16
    DllCharacteristics          uint16
    SizeOfStackReserve          uint64
    SizeOfStackCommit           uint64
    SizeOfHeapReserve           uint64
    SizeOfHeapCommit            uint64
    LoaderFlags                 uint32
    NumberOfRvaAndSizes         uint32
    DataDirectory               [16]DataDirectory
}

Тип Reloc 1.8

Reloc представляет собой перемещение PE COFF. Каждая секция содержит свой собственный список перемещений.

type Reloc struct {
    VirtualAddress   uint32
    SymbolTableIndex uint32
    Type             uint16
}

Тип Section

Section предоставляет доступ к секции PE COFF.

type Section struct {
    SectionHeader
    Relocs []Reloc // Go 1.8

    // Embed ReaderAt for ReadAt method.
    // Do not embed SectionReader directly
    // to avoid having Read and Seek.
    // If a client wants Read and Seek it must use
    // Open() to avoid fighting over the seek offset
    // with other clients.
    io.ReaderAt
    // contains filtered or unexported fields
}

Функция (*Section) Data

func (s *Section) Data() ([]byte, error)

Data считывает и возвращает содержимое секции PE s.

Если s.Offset равен 0, секция не содержит данных, и Data всегда вернёт ошибку.

Функция (*Section) Open

func (s *Section) Open() io.ReadSeeker

Open возвращает новый ReadSeeker, считывающий секцию PE s.

Если s.Offset равен 0, секция не содержит данных, и все вызовы к возвращённому читателю вернут ошибку.

Тип SectionHeader

SectionHeader аналогичен SectionHeader32 с полем Name, заменённым на Go-строку.

type SectionHeader struct {
    Name                 string
    VirtualSize          uint32
    VirtualAddress       uint32
    Size                 uint32
    Offset               uint32
    PointerToRelocations uint32
    PointerToLineNumbers uint32
    NumberOfRelocations  uint16
    NumberOfLineNumbers  uint16
    Characteristics      uint32
}

Тип SectionHeader32

SectionHeader32 представляет собой реальный заголовок секции PE COFF.

type SectionHeader32 struct {
    Name                 [8]uint8
    VirtualSize          uint32
    VirtualAddress       uint32
    SizeOfRawData        uint32
    PointerToRawData     uint32
    PointerToRelocations uint32
    PointerToLineNumbers uint32
    NumberOfRelocations  uint16
    NumberOfLineNumbers  uint16
    Characteristics      uint32
}

Тип StringTable 1.8

StringTable — таблица строк COFF.

type StringTable []byte

Функция (StringTable) String 1.8

func (st StringTable) String(start uint32) (string, error)

String извлекает строку из таблицы строк COFF st по смещению start.

Тип Symbol 1.1

Symbol аналогичен COFFSymbol с полем Name, заменённым на Go-строку. Symbol также не имеет NumberOfAuxSymbols.

type Symbol struct {
    Name          string
    Value         uint32
    SectionNumber int16
    Type          uint16
    StorageClass  uint8
}