Source file
src/debug/pe/file.go
1
2
3
4
5
16 package pe
17
18 import (
19 "bytes"
20 "compress/zlib"
21 "debug/dwarf"
22 "encoding/binary"
23 "errors"
24 "fmt"
25 "io"
26 "os"
27 "strings"
28 )
29
30
31 type File struct {
32 FileHeader
33 OptionalHeader any
34 Sections []*Section
35 Symbols []*Symbol
36 COFFSymbols []COFFSymbol
37 StringTable StringTable
38
39 closer io.Closer
40 }
41
42
43 func Open(name string) (*File, error) {
44 f, err := os.Open(name)
45 if err != nil {
46 return nil, err
47 }
48 ff, err := NewFile(f)
49 if err != nil {
50 f.Close()
51 return nil, err
52 }
53 ff.closer = f
54 return ff, nil
55 }
56
57
58
59
60 func (f *File) Close() error {
61 var err error
62 if f.closer != nil {
63 err = f.closer.Close()
64 f.closer = nil
65 }
66 return err
67 }
68
69
70
71
72 func NewFile(r io.ReaderAt) (*File, error) {
73 f := new(File)
74 sr := io.NewSectionReader(r, 0, 1<<63-1)
75
76 var dosheader [96]byte
77 if _, err := r.ReadAt(dosheader[0:], 0); err != nil {
78 return nil, err
79 }
80 var base int64
81 if dosheader[0] == 'M' && dosheader[1] == 'Z' {
82 signoff := int64(binary.LittleEndian.Uint32(dosheader[0x3c:]))
83 var sign [4]byte
84 r.ReadAt(sign[:], signoff)
85 if !(sign[0] == 'P' && sign[1] == 'E' && sign[2] == 0 && sign[3] == 0) {
86 return nil, fmt.Errorf("invalid PE file signature: % x", sign)
87 }
88 base = signoff + 4
89 } else {
90 base = int64(0)
91 }
92 sr.Seek(base, io.SeekStart)
93 if err := binary.Read(sr, binary.LittleEndian, &f.FileHeader); err != nil {
94 return nil, err
95 }
96 switch f.FileHeader.Machine {
97 case IMAGE_FILE_MACHINE_AMD64,
98 IMAGE_FILE_MACHINE_ARM64,
99 IMAGE_FILE_MACHINE_ARMNT,
100 IMAGE_FILE_MACHINE_I386,
101 IMAGE_FILE_MACHINE_RISCV32,
102 IMAGE_FILE_MACHINE_RISCV64,
103 IMAGE_FILE_MACHINE_RISCV128,
104 IMAGE_FILE_MACHINE_UNKNOWN:
105
106 default:
107 return nil, fmt.Errorf("unrecognized PE machine: %#x", f.FileHeader.Machine)
108 }
109
110 var err error
111
112
113 f.StringTable, err = readStringTable(&f.FileHeader, sr)
114 if err != nil {
115 return nil, err
116 }
117
118
119 f.COFFSymbols, err = readCOFFSymbols(&f.FileHeader, sr)
120 if err != nil {
121 return nil, err
122 }
123 f.Symbols, err = removeAuxSymbols(f.COFFSymbols, f.StringTable)
124 if err != nil {
125 return nil, err
126 }
127
128
129 _, err = sr.Seek(base+int64(binary.Size(f.FileHeader)), io.SeekStart)
130 if err != nil {
131 return nil, err
132 }
133
134
135 f.OptionalHeader, err = readOptionalHeader(sr, f.FileHeader.SizeOfOptionalHeader)
136 if err != nil {
137 return nil, err
138 }
139
140
141 f.Sections = make([]*Section, f.FileHeader.NumberOfSections)
142 for i := 0; i < int(f.FileHeader.NumberOfSections); i++ {
143 sh := new(SectionHeader32)
144 if err := binary.Read(sr, binary.LittleEndian, sh); err != nil {
145 return nil, err
146 }
147 name, err := sh.fullName(f.StringTable)
148 if err != nil {
149 return nil, err
150 }
151 s := new(Section)
152 s.SectionHeader = SectionHeader{
153 Name: name,
154 VirtualSize: sh.VirtualSize,
155 VirtualAddress: sh.VirtualAddress,
156 Size: sh.SizeOfRawData,
157 Offset: sh.PointerToRawData,
158 PointerToRelocations: sh.PointerToRelocations,
159 PointerToLineNumbers: sh.PointerToLineNumbers,
160 NumberOfRelocations: sh.NumberOfRelocations,
161 NumberOfLineNumbers: sh.NumberOfLineNumbers,
162 Characteristics: sh.Characteristics,
163 }
164 r2 := r
165 if sh.PointerToRawData == 0 {
166 r2 = &nobitsSectionReader{}
167 }
168 s.sr = io.NewSectionReader(r2, int64(s.SectionHeader.Offset), int64(s.SectionHeader.Size))
169 s.ReaderAt = s.sr
170 f.Sections[i] = s
171 }
172 for i := range f.Sections {
173 var err error
174 f.Sections[i].Relocs, err = readRelocs(&f.Sections[i].SectionHeader, sr)
175 if err != nil {
176 return nil, err
177 }
178 }
179
180 return f, nil
181 }
182
183 type nobitsSectionReader struct{}
184
185 func (*nobitsSectionReader) ReadAt(p []byte, off int64) (n int, err error) {
186 return 0, errors.New("unexpected read from section with uninitialized data")
187 }
188
189
190 func getString(section []byte, start int) (string, bool) {
191 if start < 0 || start >= len(section) {
192 return "", false
193 }
194
195 for end := start; end < len(section); end++ {
196 if section[end] == 0 {
197 return string(section[start:end]), true
198 }
199 }
200 return "", false
201 }
202
203
204
205 func (f *File) Section(name string) *Section {
206 for _, s := range f.Sections {
207 if s.Name == name {
208 return s
209 }
210 }
211 return nil
212 }
213
214 func (f *File) DWARF() (*dwarf.Data, error) {
215 dwarfSuffix := func(s *Section) string {
216 switch {
217 case strings.HasPrefix(s.Name, ".debug_"):
218 return s.Name[7:]
219 case strings.HasPrefix(s.Name, ".zdebug_"):
220 return s.Name[8:]
221 default:
222 return ""
223 }
224
225 }
226
227
228 sectionData := func(s *Section) ([]byte, error) {
229 b, err := s.Data()
230 if err != nil && uint32(len(b)) < s.Size {
231 return nil, err
232 }
233
234 if 0 < s.VirtualSize && s.VirtualSize < s.Size {
235 b = b[:s.VirtualSize]
236 }
237
238 if len(b) >= 12 && string(b[:4]) == "ZLIB" {
239 dlen := binary.BigEndian.Uint64(b[4:12])
240 dbuf := make([]byte, dlen)
241 r, err := zlib.NewReader(bytes.NewBuffer(b[12:]))
242 if err != nil {
243 return nil, err
244 }
245 if _, err := io.ReadFull(r, dbuf); err != nil {
246 return nil, err
247 }
248 if err := r.Close(); err != nil {
249 return nil, err
250 }
251 b = dbuf
252 }
253 return b, nil
254 }
255
256
257
258
259 var dat = map[string][]byte{"abbrev": nil, "info": nil, "str": nil, "line": nil, "ranges": nil}
260 for _, s := range f.Sections {
261 suffix := dwarfSuffix(s)
262 if suffix == "" {
263 continue
264 }
265 if _, ok := dat[suffix]; !ok {
266 continue
267 }
268
269 b, err := sectionData(s)
270 if err != nil {
271 return nil, err
272 }
273 dat[suffix] = b
274 }
275
276 d, err := dwarf.New(dat["abbrev"], nil, nil, dat["info"], dat["line"], nil, dat["ranges"], dat["str"])
277 if err != nil {
278 return nil, err
279 }
280
281
282 for i, s := range f.Sections {
283 suffix := dwarfSuffix(s)
284 if suffix == "" {
285 continue
286 }
287 if _, ok := dat[suffix]; ok {
288
289 continue
290 }
291
292 b, err := sectionData(s)
293 if err != nil {
294 return nil, err
295 }
296
297 if suffix == "types" {
298 err = d.AddTypes(fmt.Sprintf("types-%d", i), b)
299 } else {
300 err = d.AddSection(".debug_"+suffix, b)
301 }
302 if err != nil {
303 return nil, err
304 }
305 }
306
307 return d, nil
308 }
309
310
311
312 type ImportDirectory struct {
313 OriginalFirstThunk uint32
314 TimeDateStamp uint32
315 ForwarderChain uint32
316 Name uint32
317 FirstThunk uint32
318
319 dll string
320 }
321
322
323
324
325
326 func (f *File) ImportedSymbols() ([]string, error) {
327 if f.OptionalHeader == nil {
328 return nil, nil
329 }
330
331 _, pe64 := f.OptionalHeader.(*OptionalHeader64)
332
333
334 var dd_length uint32
335 if pe64 {
336 dd_length = f.OptionalHeader.(*OptionalHeader64).NumberOfRvaAndSizes
337 } else {
338 dd_length = f.OptionalHeader.(*OptionalHeader32).NumberOfRvaAndSizes
339 }
340
341
342
343 if dd_length < IMAGE_DIRECTORY_ENTRY_IMPORT+1 {
344 return nil, nil
345 }
346
347
348 var idd DataDirectory
349 if pe64 {
350 idd = f.OptionalHeader.(*OptionalHeader64).DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT]
351 } else {
352 idd = f.OptionalHeader.(*OptionalHeader32).DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT]
353 }
354
355
356 var ds *Section
357 ds = nil
358 for _, s := range f.Sections {
359 if s.Offset == 0 {
360 continue
361 }
362
363
364
365 if s.VirtualAddress <= idd.VirtualAddress && idd.VirtualAddress-s.VirtualAddress < s.VirtualSize {
366 ds = s
367 break
368 }
369 }
370
371
372 if ds == nil {
373 return nil, nil
374 }
375
376 d, err := ds.Data()
377 if err != nil {
378 return nil, err
379 }
380
381
382 seek := idd.VirtualAddress - ds.VirtualAddress
383 if seek >= uint32(len(d)) {
384 return nil, errors.New("optional header data directory virtual size doesn't fit within data seek")
385 }
386 d = d[seek:]
387
388
389 var ida []ImportDirectory
390 for len(d) >= 20 {
391 var dt ImportDirectory
392 dt.OriginalFirstThunk = binary.LittleEndian.Uint32(d[0:4])
393 dt.TimeDateStamp = binary.LittleEndian.Uint32(d[4:8])
394 dt.ForwarderChain = binary.LittleEndian.Uint32(d[8:12])
395 dt.Name = binary.LittleEndian.Uint32(d[12:16])
396 dt.FirstThunk = binary.LittleEndian.Uint32(d[16:20])
397 d = d[20:]
398 if dt.OriginalFirstThunk == 0 {
399 break
400 }
401 ida = append(ida, dt)
402 }
403
404
405
406
407
408
409 names, _ := ds.Data()
410 var all []string
411 for _, dt := range ida {
412 dt.dll, _ = getString(names, int(dt.Name-ds.VirtualAddress))
413 d, _ = ds.Data()
414
415 seek := dt.OriginalFirstThunk - ds.VirtualAddress
416 if seek >= uint32(len(d)) {
417 return nil, errors.New("import directory original first thunk doesn't fit within data seek")
418 }
419 d = d[seek:]
420 for len(d) > 0 {
421 if pe64 {
422 if len(d) < 8 {
423 return nil, errors.New("thunk parsing needs at least 8-bytes")
424 }
425 va := binary.LittleEndian.Uint64(d[0:8])
426 d = d[8:]
427 if va == 0 {
428 break
429 }
430 if va&0x8000000000000000 > 0 {
431
432 } else {
433 fn, _ := getString(names, int(uint32(va)-ds.VirtualAddress+2))
434 all = append(all, fn+":"+dt.dll)
435 }
436 } else {
437 if len(d) <= 4 {
438 return nil, errors.New("thunk parsing needs at least 5-bytes")
439 }
440 va := binary.LittleEndian.Uint32(d[0:4])
441 d = d[4:]
442 if va == 0 {
443 break
444 }
445 if va&0x80000000 > 0 {
446
447
448 } else {
449 fn, _ := getString(names, int(va-ds.VirtualAddress+2))
450 all = append(all, fn+":"+dt.dll)
451 }
452 }
453 }
454 }
455
456 return all, nil
457 }
458
459
460
461
462 func (f *File) ImportedLibraries() ([]string, error) {
463
464
465 return nil, nil
466 }
467
468
469
470 type FormatError struct {
471 }
472
473 func (e *FormatError) Error() string {
474 return "unknown error"
475 }
476
477
478
479
480
481 func readOptionalHeader(r io.ReadSeeker, sz uint16) (any, error) {
482
483 if sz == 0 {
484 return nil, nil
485 }
486
487 var (
488
489
490
491 ohMagic uint16
492 ohMagicSz = binary.Size(ohMagic)
493 )
494
495
496 if sz < uint16(ohMagicSz) {
497 return nil, fmt.Errorf("optional header size is less than optional header magic size")
498 }
499
500
501 var err error
502 read := func(data any) bool {
503 err = binary.Read(r, binary.LittleEndian, data)
504 return err == nil
505 }
506
507 if !read(&ohMagic) {
508 return nil, fmt.Errorf("failure to read optional header magic: %v", err)
509
510 }
511
512 switch ohMagic {
513 case 0x10b:
514 var (
515 oh32 OptionalHeader32
516
517
518 oh32MinSz = binary.Size(oh32) - binary.Size(oh32.DataDirectory)
519 )
520
521 if sz < uint16(oh32MinSz) {
522 return nil, fmt.Errorf("optional header size(%d) is less minimum size (%d) of PE32 optional header", sz, oh32MinSz)
523 }
524
525
526 oh32.Magic = ohMagic
527 if !read(&oh32.MajorLinkerVersion) ||
528 !read(&oh32.MinorLinkerVersion) ||
529 !read(&oh32.SizeOfCode) ||
530 !read(&oh32.SizeOfInitializedData) ||
531 !read(&oh32.SizeOfUninitializedData) ||
532 !read(&oh32.AddressOfEntryPoint) ||
533 !read(&oh32.BaseOfCode) ||
534 !read(&oh32.BaseOfData) ||
535 !read(&oh32.ImageBase) ||
536 !read(&oh32.SectionAlignment) ||
537 !read(&oh32.FileAlignment) ||
538 !read(&oh32.MajorOperatingSystemVersion) ||
539 !read(&oh32.MinorOperatingSystemVersion) ||
540 !read(&oh32.MajorImageVersion) ||
541 !read(&oh32.MinorImageVersion) ||
542 !read(&oh32.MajorSubsystemVersion) ||
543 !read(&oh32.MinorSubsystemVersion) ||
544 !read(&oh32.Win32VersionValue) ||
545 !read(&oh32.SizeOfImage) ||
546 !read(&oh32.SizeOfHeaders) ||
547 !read(&oh32.CheckSum) ||
548 !read(&oh32.Subsystem) ||
549 !read(&oh32.DllCharacteristics) ||
550 !read(&oh32.SizeOfStackReserve) ||
551 !read(&oh32.SizeOfStackCommit) ||
552 !read(&oh32.SizeOfHeapReserve) ||
553 !read(&oh32.SizeOfHeapCommit) ||
554 !read(&oh32.LoaderFlags) ||
555 !read(&oh32.NumberOfRvaAndSizes) {
556 return nil, fmt.Errorf("failure to read PE32 optional header: %v", err)
557 }
558
559 dd, err := readDataDirectories(r, sz-uint16(oh32MinSz), oh32.NumberOfRvaAndSizes)
560 if err != nil {
561 return nil, err
562 }
563
564 copy(oh32.DataDirectory[:], dd)
565
566 return &oh32, nil
567 case 0x20b:
568 var (
569 oh64 OptionalHeader64
570
571
572 oh64MinSz = binary.Size(oh64) - binary.Size(oh64.DataDirectory)
573 )
574
575 if sz < uint16(oh64MinSz) {
576 return nil, fmt.Errorf("optional header size(%d) is less minimum size (%d) for PE32+ optional header", sz, oh64MinSz)
577 }
578
579
580 oh64.Magic = ohMagic
581 if !read(&oh64.MajorLinkerVersion) ||
582 !read(&oh64.MinorLinkerVersion) ||
583 !read(&oh64.SizeOfCode) ||
584 !read(&oh64.SizeOfInitializedData) ||
585 !read(&oh64.SizeOfUninitializedData) ||
586 !read(&oh64.AddressOfEntryPoint) ||
587 !read(&oh64.BaseOfCode) ||
588 !read(&oh64.ImageBase) ||
589 !read(&oh64.SectionAlignment) ||
590 !read(&oh64.FileAlignment) ||
591 !read(&oh64.MajorOperatingSystemVersion) ||
592 !read(&oh64.MinorOperatingSystemVersion) ||
593 !read(&oh64.MajorImageVersion) ||
594 !read(&oh64.MinorImageVersion) ||
595 !read(&oh64.MajorSubsystemVersion) ||
596 !read(&oh64.MinorSubsystemVersion) ||
597 !read(&oh64.Win32VersionValue) ||
598 !read(&oh64.SizeOfImage) ||
599 !read(&oh64.SizeOfHeaders) ||
600 !read(&oh64.CheckSum) ||
601 !read(&oh64.Subsystem) ||
602 !read(&oh64.DllCharacteristics) ||
603 !read(&oh64.SizeOfStackReserve) ||
604 !read(&oh64.SizeOfStackCommit) ||
605 !read(&oh64.SizeOfHeapReserve) ||
606 !read(&oh64.SizeOfHeapCommit) ||
607 !read(&oh64.LoaderFlags) ||
608 !read(&oh64.NumberOfRvaAndSizes) {
609 return nil, fmt.Errorf("failure to read PE32+ optional header: %v", err)
610 }
611
612 dd, err := readDataDirectories(r, sz-uint16(oh64MinSz), oh64.NumberOfRvaAndSizes)
613 if err != nil {
614 return nil, err
615 }
616
617 copy(oh64.DataDirectory[:], dd)
618
619 return &oh64, nil
620 default:
621 return nil, fmt.Errorf("optional header has unexpected Magic of 0x%x", ohMagic)
622 }
623 }
624
625
626
627
628 func readDataDirectories(r io.ReadSeeker, sz uint16, n uint32) ([]DataDirectory, error) {
629 ddSz := uint64(binary.Size(DataDirectory{}))
630 if uint64(sz) != uint64(n)*ddSz {
631 return nil, fmt.Errorf("size of data directories(%d) is inconsistent with number of data directories(%d)", sz, n)
632 }
633
634 dd := make([]DataDirectory, n)
635 if err := binary.Read(r, binary.LittleEndian, dd); err != nil {
636 return nil, fmt.Errorf("failure to read data directories: %v", err)
637 }
638
639 return dd, nil
640 }
641
View as plain text