package pe

Import Path
	debug/pe (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	  d file.go
		Package pe implements access to PE (Microsoft Windows Portable Executable) files.
		
		# Security
		
		This package is not designed to be hardened against adversarial inputs, and is
		outside the scope of https://go.dev/security/policy. In particular, only basic
		validation is done when parsing object files. As such, care should be taken when
		parsing untrusted inputs, as parsing malformed files may consume significant
		resources, or cause panics.

	    pe.go
	    section.go
	    string.go
	    symbol.go
Package-Level Type Names (total 15)

	/* sort by: alphabet | popularity */
	 type COFFSymbol (struct)
		COFFSymbol represents single COFF symbol table record.

		Fields (total 6)
			Name [8]uint8
			NumberOfAuxSymbols uint8
			SectionNumber int16
			StorageClass uint8
			Type uint16
			Value uint32
		Methods (only one)
			(*COFFSymbol) FullName(st StringTable) (string, error)
				FullName finds real name of symbol sym. Normally name is stored
				in sym.Name, but if it is longer then 8 characters, it is stored
				in COFF string table st instead.


	 type COFFSymbolAuxFormat5 (struct)
		COFFSymbolAuxFormat5 describes the expected form of an aux symbol
		attached to a section definition symbol. The PE format defines a
		number of different aux symbol formats: format 1 for function
		definitions, format 2 for .be and .ef symbols, and so on. Format 5
		holds extra info associated with a section definition, including
		number of relocations + line numbers, as well as COMDAT info. See
		https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-format-5-section-definitions
		for more on what's going on here.

		Fields (total 6)
			Checksum uint32
			NumLineNumbers uint16
			NumRelocs uint16
			SecNum uint16
			Selection uint8
			Size uint32
		As Outputs Of (at least one exported)
			func (*File).COFFSymbolReadSectionDefAux(idx int) (*COFFSymbolAuxFormat5, error)

	 type DataDirectory (struct)

		Fields (total 2)
			Size uint32
			VirtualAddress uint32

	 type File (struct)
		A File represents an open PE file.

		Fields (total 13)
			COFFSymbols []COFFSymbol
				// all COFF symbols (including auxiliary symbol records)

			FileHeader FileHeader
			FileHeader.Characteristics uint16
			FileHeader.Machine uint16
			FileHeader.NumberOfSections uint16
			FileHeader.NumberOfSymbols uint32
			FileHeader.PointerToSymbolTable uint32
			FileHeader.SizeOfOptionalHeader uint16
			FileHeader.TimeDateStamp uint32
			OptionalHeader any
				// of type *OptionalHeader32 or *OptionalHeader64

			Sections []*Section
			StringTable StringTable
			Symbols []*Symbol
				// COFF symbols with auxiliary symbol records removed

		Methods (total 6)
			(*File) COFFSymbolReadSectionDefAux(idx int) (*COFFSymbolAuxFormat5, error)
				COFFSymbolReadSectionDefAux returns a blob of auxiliary information
				(including COMDAT info) for a section definition symbol. Here 'idx'
				is the index of a section symbol in the main [COFFSymbol] array for
				the File. Return value is a pointer to the appropriate aux symbol
				struct. For more info, see:
				
				auxiliary symbols: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-symbol-records
				COMDAT sections: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#comdat-sections-object-only
				auxiliary info for section definitions: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#auxiliary-format-5-section-definitions

			(*File) Close() error
				Close closes the [File].
				If the [File] was created using [NewFile] directly instead of [Open],
				Close has no effect.

			(*File) DWARF() (*dwarf.Data, error)
			(*File) ImportedLibraries() ([]string, error)
				ImportedLibraries returns the names of all libraries
				referred to by the binary f that are expected to be
				linked with the binary at dynamic link time.

			(*File) ImportedSymbols() ([]string, error)
				ImportedSymbols returns the names of all symbols
				referred to by the binary f that are expected to be
				satisfied by other libraries at dynamic load time.
				It does not return weak symbols.

			(*File) Section(name string) *Section
				Section returns the first section with the given name, or nil if no such
				section exists.

		Implements (at least one exported)
			*File : io.Closer
		As Outputs Of (at least 2)
			func NewFile(r io.ReaderAt) (*File, error)
			func Open(name string) (*File, error)

	 type FileHeader (struct)

		Fields (total 7)
			Characteristics uint16
			Machine uint16
			NumberOfSections uint16
			NumberOfSymbols uint32
			PointerToSymbolTable uint32
			SizeOfOptionalHeader uint16
			TimeDateStamp uint32

	 type FormatError (struct)
		FormatError is unused.
		The type is retained for compatibility.

		Methods (only one)
			(*FormatError) Error() string
		Implements (at least one exported)
			*FormatError : error

	 type ImportDirectory (struct)

		Fields (total 5)
			FirstThunk uint32
			ForwarderChain uint32
			Name uint32
			OriginalFirstThunk uint32
			TimeDateStamp uint32

	 type OptionalHeader32 (struct)

		Fields (total 31)
			AddressOfEntryPoint uint32
			BaseOfCode uint32
			BaseOfData uint32
			CheckSum uint32
			DataDirectory [16]DataDirectory
			DllCharacteristics uint16
			FileAlignment uint32
			ImageBase uint32
			LoaderFlags uint32
			Magic uint16
			MajorImageVersion uint16
			MajorLinkerVersion uint8
			MajorOperatingSystemVersion uint16
			MajorSubsystemVersion uint16
			MinorImageVersion uint16
			MinorLinkerVersion uint8
			MinorOperatingSystemVersion uint16
			MinorSubsystemVersion uint16
			NumberOfRvaAndSizes uint32
			SectionAlignment uint32
			SizeOfCode uint32
			SizeOfHeaders uint32
			SizeOfHeapCommit uint32
			SizeOfHeapReserve uint32
			SizeOfImage uint32
			SizeOfInitializedData uint32
			SizeOfStackCommit uint32
			SizeOfStackReserve uint32
			SizeOfUninitializedData uint32
			Subsystem uint16
			Win32VersionValue uint32

	 type OptionalHeader64 (struct)

		Fields (total 30)
			AddressOfEntryPoint uint32
			BaseOfCode uint32
			CheckSum uint32
			DataDirectory [16]DataDirectory
			DllCharacteristics uint16
			FileAlignment uint32
			ImageBase uint64
			LoaderFlags uint32
			Magic uint16
			MajorImageVersion uint16
			MajorLinkerVersion uint8
			MajorOperatingSystemVersion uint16
			MajorSubsystemVersion uint16
			MinorImageVersion uint16
			MinorLinkerVersion uint8
			MinorOperatingSystemVersion uint16
			MinorSubsystemVersion uint16
			NumberOfRvaAndSizes uint32
			SectionAlignment uint32
			SizeOfCode uint32
			SizeOfHeaders uint32
			SizeOfHeapCommit uint64
			SizeOfHeapReserve uint64
			SizeOfImage uint32
			SizeOfInitializedData uint32
			SizeOfStackCommit uint64
			SizeOfStackReserve uint64
			SizeOfUninitializedData uint32
			Subsystem uint16
			Win32VersionValue uint32

	 type Reloc (struct)
		Reloc represents a PE COFF relocation.
		Each section contains its own relocation list.

		Fields (total 3)
			SymbolTableIndex uint32
			Type uint16
			VirtualAddress uint32

	 type Section (struct)
		Section provides access to PE COFF section.

		Fields (total 13)
			ReaderAt io.ReaderAt
				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.

			Relocs []Reloc
			SectionHeader SectionHeader
			SectionHeader.Characteristics uint32
			SectionHeader.Name string
			SectionHeader.NumberOfLineNumbers uint16
			SectionHeader.NumberOfRelocations uint16
			SectionHeader.Offset uint32
			SectionHeader.PointerToLineNumbers uint32
			SectionHeader.PointerToRelocations uint32
			SectionHeader.Size uint32
			SectionHeader.VirtualAddress uint32
			SectionHeader.VirtualSize uint32
		Methods (total 3)
			(*Section) Data() ([]byte, error)
				Data reads and returns the contents of the PE section s.
				
				If s.Offset is 0, the section has no contents,
				and Data will always return a non-nil error.

			(*Section) Open() io.ReadSeeker
				Open returns a new ReadSeeker reading the PE section s.
				
				If s.Offset is 0, the section has no contents, and all calls
				to the returned reader will return a non-nil error.

			( Section) ReadAt(p []byte, off int64) (n int, err error)
		Implements (at least one exported)
			 Section : io.ReaderAt
		As Outputs Of (at least one exported)
			func (*File).Section(name string) *Section

	 type SectionHeader (struct)
		SectionHeader is similar to [SectionHeader32] with Name
		field replaced by Go string.

		Fields (total 10)
			Characteristics uint32
			Name string
			NumberOfLineNumbers uint16
			NumberOfRelocations uint16
			Offset uint32
			PointerToLineNumbers uint32
			PointerToRelocations uint32
			Size uint32
			VirtualAddress uint32
			VirtualSize uint32

	 type SectionHeader32 (struct)
		SectionHeader32 represents real PE COFF section header.

		Fields (total 10)
			Characteristics uint32
			Name [8]uint8
			NumberOfLineNumbers uint16
			NumberOfRelocations uint16
			PointerToLineNumbers uint32
			PointerToRawData uint32
			PointerToRelocations uint32
			SizeOfRawData uint32
			VirtualAddress uint32
			VirtualSize uint32

	 type StringTable ([])
		StringTable is a COFF string table.

		Methods (only one)
			( StringTable) String(start uint32) (string, error)
				String extracts string from COFF string table st at offset start.

		As Inputs Of (at least one exported)
			func (*COFFSymbol).FullName(st StringTable) (string, error)

	 type Symbol (struct)
		Symbol is similar to [COFFSymbol] with Name field replaced
		by Go string. Symbol also does not have NumberOfAuxSymbols.

		Fields (total 5)
			Name string
			SectionNumber int16
			StorageClass uint8
			Type uint16
			Value uint32


Package-Level Functions (total 2)

	 func NewFile(r io.ReaderAt) (*File, error)
		NewFile creates a new [File] for accessing a PE binary in an underlying reader.

	 func Open(name string) (*File, error)
		Open opens the named file using [os.Open] and prepares it for use as a PE binary.


Package-Level Constants (total 97)

	const COFFSymbolSize = 18
	const IMAGE_COMDAT_SELECT_ANY = 2
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_COMDAT_SELECT_ASSOCIATIVE = 5
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_COMDAT_SELECT_EXACT_MATCH = 4
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_COMDAT_SELECT_LARGEST = 6
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_COMDAT_SELECT_NODUPLICATES = 1
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_COMDAT_SELECT_SAME_SIZE = 3
		These constants make up the possible values for the 'Selection'
		field in an AuxFormat5.

	const IMAGE_DIRECTORY_ENTRY_ARCHITECTURE = 7
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_BASERELOC = 5
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT = 11
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR = 14
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_DEBUG = 6
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT = 13
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_EXCEPTION = 3
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_EXPORT = 0
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_GLOBALPTR = 8
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_IAT = 12
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_IMPORT = 1
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG = 10
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_RESOURCE = 2
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_SECURITY = 4
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DIRECTORY_ENTRY_TLS = 9
		IMAGE_DIRECTORY_ENTRY constants

	const IMAGE_DLLCHARACTERISTICS_APPCONTAINER = 4096
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE = 64
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY = 128
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_GUARD_CF = 16384
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA = 32
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_NO_BIND = 2048
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_NO_ISOLATION = 512
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_NO_SEH = 1024
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_NX_COMPAT = 256
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE = 32768
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_DLLCHARACTERISTICS_WDM_DRIVER = 8192
		OptionalHeader64.DllCharacteristics and OptionalHeader32.DllCharacteristics
		values. These can be combined together.

	const IMAGE_FILE_32BIT_MACHINE = 256
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_AGGRESIVE_WS_TRIM = 16
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_BYTES_REVERSED_HI = 32768
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_BYTES_REVERSED_LO = 128
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_DEBUG_STRIPPED = 512
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_DLL = 8192
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_EXECUTABLE_IMAGE = 2
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_LARGE_ADDRESS_AWARE = 32
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_LINE_NUMS_STRIPPED = 4
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_LOCAL_SYMS_STRIPPED = 8
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_MACHINE_AM33 = 467
	const IMAGE_FILE_MACHINE_AMD64 = 34404
	const IMAGE_FILE_MACHINE_ARM = 448
	const IMAGE_FILE_MACHINE_ARM64 = 43620
	const IMAGE_FILE_MACHINE_ARMNT = 452
	const IMAGE_FILE_MACHINE_EBC = 3772
	const IMAGE_FILE_MACHINE_I386 = 332
	const IMAGE_FILE_MACHINE_IA64 = 512
	const IMAGE_FILE_MACHINE_LOONGARCH32 = 25138
	const IMAGE_FILE_MACHINE_LOONGARCH64 = 25188
	const IMAGE_FILE_MACHINE_M32R = 36929
	const IMAGE_FILE_MACHINE_MIPS16 = 614
	const IMAGE_FILE_MACHINE_MIPSFPU = 870
	const IMAGE_FILE_MACHINE_MIPSFPU16 = 1126
	const IMAGE_FILE_MACHINE_POWERPC = 496
	const IMAGE_FILE_MACHINE_POWERPCFP = 497
	const IMAGE_FILE_MACHINE_R4000 = 358
	const IMAGE_FILE_MACHINE_RISCV128 = 20776
	const IMAGE_FILE_MACHINE_RISCV32 = 20530
	const IMAGE_FILE_MACHINE_RISCV64 = 20580
	const IMAGE_FILE_MACHINE_SH3 = 418
	const IMAGE_FILE_MACHINE_SH3DSP = 419
	const IMAGE_FILE_MACHINE_SH4 = 422
	const IMAGE_FILE_MACHINE_SH5 = 424
	const IMAGE_FILE_MACHINE_THUMB = 450
	const IMAGE_FILE_MACHINE_UNKNOWN = 0
	const IMAGE_FILE_MACHINE_WCEMIPSV2 = 361
	const IMAGE_FILE_NET_RUN_FROM_SWAP = 2048
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_RELOCS_STRIPPED = 1
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 1024
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_SYSTEM = 4096
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_FILE_UP_SYSTEM_ONLY = 16384
		Values of IMAGE_FILE_HEADER.Characteristics. These can be combined together.

	const IMAGE_SCN_CNT_CODE = 32
		Section characteristics flags.

	const IMAGE_SCN_CNT_INITIALIZED_DATA = 64
		Section characteristics flags.

	const IMAGE_SCN_CNT_UNINITIALIZED_DATA = 128
		Section characteristics flags.

	const IMAGE_SCN_LNK_COMDAT = 4096
		Section characteristics flags.

	const IMAGE_SCN_MEM_DISCARDABLE = 33554432
		Section characteristics flags.

	const IMAGE_SCN_MEM_EXECUTE = 536870912
		Section characteristics flags.

	const IMAGE_SCN_MEM_READ = 1073741824
		Section characteristics flags.

	const IMAGE_SCN_MEM_WRITE = 2147483648
		Section characteristics flags.

	const IMAGE_SUBSYSTEM_EFI_APPLICATION = 10
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_EFI_ROM = 13
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_NATIVE = 1
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_OS2_CUI = 5
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_POSIX_CUI = 7
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_UNKNOWN = 0
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_WINDOWS_CUI = 3
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_WINDOWS_GUI = 2
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

	const IMAGE_SUBSYSTEM_XBOX = 14
		OptionalHeader64.Subsystem and OptionalHeader32.Subsystem values.

The pages are generated with Golds v0.6.9-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.