go_ms_cfb

README

go-ms-cfb

A Microsoft CFB (Compound File Binary) parsing library in go

Status

This collection of libraries can be used to allow your go application to interact with and output data from Legacy Microsoft Docs that employ the MS CFB file architectures.

Experimental / Concept

Use at your own peril!

☠️

Installing

$ go get github.com/JoNilsson/go_ms_cfb

Documentation

Index

• Variables
• type DirectoryEntry
  • func (d *DirectoryEntry) Name() string
  • func (d *DirectoryEntry) Path() string
  • func (d *DirectoryEntry) Size() uint64
  • func (d *DirectoryEntry) StartingSector() uint32
  • func (d *DirectoryEntry) Type() ObjectType
• type File
  • func New(r io.ReaderAt) (*File, error)
  • func (f *File) Get(path string) (Object, error)
  • func (f *File) Header() *FileHeader
  • func (f *File) Objects() ([]Object, error)
• type FileHeader
  • func (h *FileHeader) MiniSectorSize() uint32
  • func (h *FileHeader) SectorSize() uint32
• type Object
• type ObjectType
  • func (i ObjectType) String() string
• type SectorReader
  • func (sr *SectorReader) Read(b []byte) (int, error)
  • func (sr *SectorReader) ReadAt(b []byte, offset int64) (int, error)
  • func (sr *SectorReader) Seek(offset int64, whence int) (int64, error)
• type Storage
  • func (s *Storage) Name() string
  • func (s *Storage) Path() string
  • func (s *Storage) Read(b []byte) (int, error)
  • func (s *Storage) ReadAt(b []byte, offset int64) (int, error)
  • func (s *Storage) Seek(offset int64, whence int) (int64, error)
  • func (s *Storage) Size() uint64
  • func (s *Storage) String() string
  • func (s *Storage) Type() ObjectType
• type Stream
  • func (s *Stream) Name() string
  • func (s *Stream) Path() string
  • func (s *Stream) Read(b []byte) (int, error)
  • func (s *Stream) ReadAt(b []byte, offset int64) (int, error)
  • func (s *Stream) Seek(offset int64, whence int) (int64, error)
  • func (s *Stream) Size() uint64
  • func (s *Stream) String() string
  • func (s *Stream) Type() ObjectType

Variables

var (
	ErrInsufficientData   = errors.New("insufficient data")
	ErrWrongSector        = errors.New("wrong sector")
	ErrInvalidSectorChain = errors.New("invalid sector chain")
	ErrInvalidSeek        = errors.New("invalid seek operation")
	ErrInvalidOffset      = errors.New("invalid offset")
	ErrWrongObjectType    = errors.New("wrong object type")
	ErrInvalidObject      = errors.New("invalid object")
	ErrObjectNotFound     = errors.New("object not found")
	ErrValidation         = errors.New("validation error")
)

Types

type DirectoryEntry

type DirectoryEntry struct {
	// contains filtered or unexported fields
}

func (*DirectoryEntry) Name

func (d *DirectoryEntry) Name() string

func (*DirectoryEntry) Path

func (d *DirectoryEntry) Path() string

func (*DirectoryEntry) Size

func (d *DirectoryEntry) Size() uint64

func (*DirectoryEntry) StartingSector

func (d *DirectoryEntry) StartingSector() uint32

func (*DirectoryEntry) Type

func (d *DirectoryEntry) Type() ObjectType

type File

type File struct {
	// contains filtered or unexported fields
}

func New

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

func (*File) Get

func (f *File) Get(path string) (Object, error)

func (*File) Header

func (f *File) Header() *FileHeader

func (*File) Objects

func (f *File) Objects() ([]Object, error)

type FileHeader

type FileHeader struct {
	// contains filtered or unexported fields
}

func (*FileHeader) MiniSectorSize

func (h *FileHeader) MiniSectorSize() uint32

func (*FileHeader) SectorSize

func (h *FileHeader) SectorSize() uint32

type Object

type Object interface {
	Name() string
	Path() string
	Type() ObjectType
	Size() uint64
	ReadAt([]byte, int64) (int, error)
	Seek(int64, int) (int64, error)
	Read([]byte) (int, error)
}

type ObjectType

type ObjectType uint8

const (
	UnknownObject     ObjectType = 0x00
	StorageObject     ObjectType = 0x01
	StreamObject      ObjectType = 0x02
	RootStorageObject ObjectType = 0x05
)

func (ObjectType) String

func (i ObjectType) String() string

type SectorReader

type SectorReader struct {
	// contains filtered or unexported fields
}

func (*SectorReader) Read

func (sr *SectorReader) Read(b []byte) (int, error)

func (*SectorReader) ReadAt

func (sr *SectorReader) ReadAt(b []byte, offset int64) (int, error)

func (*SectorReader) Seek

func (sr *SectorReader) Seek(offset int64, whence int) (int64, error)

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

func (*Storage) Name

func (s *Storage) Name() string

func (*Storage) Path

func (s *Storage) Path() string

func (*Storage) Read

func (s *Storage) Read(b []byte) (int, error)

func (*Storage) ReadAt

func (s *Storage) ReadAt(b []byte, offset int64) (int, error)

func (*Storage) Seek

func (s *Storage) Seek(offset int64, whence int) (int64, error)

func (*Storage) Size

func (s *Storage) Size() uint64

func (*Storage) String

func (s *Storage) String() string

func (*Storage) Type

func (s *Storage) Type() ObjectType

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

func (*Stream) Name

func (s *Stream) Name() string

func (*Stream) Path

func (s *Stream) Path() string

func (*Stream) Read

func (s *Stream) Read(b []byte) (int, error)

func (*Stream) ReadAt

func (s *Stream) ReadAt(b []byte, offset int64) (int, error)

func (*Stream) Seek

func (s *Stream) Seek(offset int64, whence int) (int64, error)

func (*Stream) Size

func (s *Stream) Size() uint64

func (*Stream) String

func (s *Stream) String() string

func (*Stream) Type

func (s *Stream) Type() ObjectType