bindiff

README

go-bindiff

Go package to interface with bindiff

Getting Started

go get github.com/blacktop/go-bindiff

bindiff demo tool

Install

go install github.com/blacktop/go-bindiff/cmd/bindiff@latest

Usage

❯ bindiff path/to/BinExport1 path/to/BinExport2

   • Running bindiff...
   • Reading bindiff results...
   • bindiff complete
   • memset_s                  confidence=0.99 similarity=1.00
   • timingsafe_bcmp           confidence=0.99 similarity=1.00
   • cc_clear                  confidence=0.99 similarity=1.00
   • cc_disable_dit            confidence=0.97 similarity=1.00
   • ccdigest_init             confidence=0.99 similarity=1.00
   • ccdigest_update           confidence=0.99 similarity=1.00
   • cchmac                    confidence=0.99 similarity=1.00
   • cchmac_init               confidence=0.99 similarity=1.00
   • cchmac_update             confidence=0.99 similarity=1.00
   • cchmac_final              confidence=0.99 similarity=1.00
   • ccdigest_final_64be       confidence=0.99 similarity=1.00
   <SNIP>

License

MIT Copyright (c) 2025 blacktop

Documentation

Overview

Package bindiff provides functionality to run bindiff and parse the diffs.

Index

• type BasicBlockAlgorithm
• type BasicBlockMatch
  • func (bbm BasicBlockMatch) String() string
• type BinDiff
  • func NewBinDiff(prev, next, output string) (*BinDiff, error)
  • func (b *BinDiff) BasicBlockMatches() []BasicBlockMatch
  • func (b *BinDiff) Close() error
  • func (b *BinDiff) Files() []File
  • func (b *BinDiff) FunctionMatches() []FunctionMatch
  • func (b *BinDiff) Instructions() []Instruction
  • func (b *BinDiff) Metadata() Metadata
  • func (b *BinDiff) Read() (err error)
  • func (b *BinDiff) Run() error
• type File
• type FunctionAlgorithm
• type FunctionMatch
  • func (fm FunctionMatch) String() string
• type Instruction
  • func (i Instruction) String() string
• type Metadata

Types

type BasicBlockAlgorithm

type BasicBlockAlgorithm int

const (
	BBAlgorithmNone                         BasicBlockAlgorithm = iota
	BBAlgorithmEdgesPrimeProduct            BasicBlockAlgorithm = 1
	BBAlgorithmHashMatchingFourInstMin      BasicBlockAlgorithm = 2
	BBAlgorithmPrimeMatchingFourInstMin     BasicBlockAlgorithm = 3
	BBAlgorithmCallReferenceMatching        BasicBlockAlgorithm = 4
	BBAlgorithmStringReferencesMatching     BasicBlockAlgorithm = 5
	BBAlgorithmEdgesMdIndexTopDown          BasicBlockAlgorithm = 6
	BBAlgorithmMdIndexMatchingTopDown       BasicBlockAlgorithm = 7
	BBAlgorithmEdgesMdIndexBottomUp         BasicBlockAlgorithm = 8
	BBAlgorithmMdIndexMatchingBottomUp      BasicBlockAlgorithm = 9
	BBAlgorithmRelaxedMdIndexMatching       BasicBlockAlgorithm = 10
	BBAlgorithmPrimeMatchingNoInstMin       BasicBlockAlgorithm = 11
	BBAlgorithmEdgesLengauerTarjanDominated BasicBlockAlgorithm = 12
	BBAlgorithmLoopEntryMatching            BasicBlockAlgorithm = 13
	BBAlgorithmSelfLoopMatching             BasicBlockAlgorithm = 14
	BBAlgorithmEntryPointMatching           BasicBlockAlgorithm = 15
	BBAlgorithmExitPointMatching            BasicBlockAlgorithm = 16
	BBAlgorithmInstructionCountMatching     BasicBlockAlgorithm = 17
	BBAlgorithmJumpSequenceMatching         BasicBlockAlgorithm = 18
	BBAlgorithmPropagationSizeOne           BasicBlockAlgorithm = 19
	BBAlgorithmManual                       BasicBlockAlgorithm = 20
)

type BasicBlockMatch

type BasicBlockMatch struct {
	ID         int `gorm:"primaryKey"`
	FunctionID int
	Address1   decimal.Decimal `gorm:"type:BIGINT"`
	Address2   decimal.Decimal `gorm:"type:BIGINT"`
	Algorithm  BasicBlockAlgorithm
	Evalute    bool
}

func (BasicBlockMatch) String

func (bbm BasicBlockMatch) String() string

type BinDiff

type BinDiff struct {
	ExportPrev string
	ExportNext string
	DiffFile   string
	Output     string
	// contains filtered or unexported fields
}

func NewBinDiff

func NewBinDiff(prev, next, output string) (*BinDiff, error)

func (*BinDiff) BasicBlockMatches

func (b *BinDiff) BasicBlockMatches() []BasicBlockMatch

func (*BinDiff) Close

func (b *BinDiff) Close() error

func (*BinDiff) Files

func (b *BinDiff) Files() []File

func (*BinDiff) FunctionMatches

func (b *BinDiff) FunctionMatches() []FunctionMatch

func (*BinDiff) Instructions

func (b *BinDiff) Instructions() []Instruction

func (*BinDiff) Metadata

func (b *BinDiff) Metadata() Metadata

func (*BinDiff) Read

func (b *BinDiff) Read() (err error)

func (*BinDiff) Run

func (b *BinDiff) Run() error

type File

type File struct {
	ID              int `gorm:"primaryKey"`
	Filename        string
	ExeFilename     string
	Hash            string
	Functions       int
	LibFunctions    int
	Calls           int
	BasicBlocks     int
	LibBasicBlocks  int
	Edges           int
	LibEdges        int
	Instructions    int
	LibInstructions int
}

type FunctionAlgorithm

type FunctionAlgorithm int

const (
	FAlgorithmNone                             FunctionAlgorithm = iota
	FAlgorithmNameHashMatching                 FunctionAlgorithm = 1
	FAlgorithmHashMatching                     FunctionAlgorithm = 2
	FAlgorithmEdgesFlowgraphMdIndex            FunctionAlgorithm = 3
	FAlgorithmEdgesCallgraphMdIndex            FunctionAlgorithm = 4
	FAlgorithmMdIndexMatchingFlowgraphTopDown  FunctionAlgorithm = 5
	FAlgorithmMdIndexMatchingFlowgraphBottomUp FunctionAlgorithm = 6
	FAlgorithmPrimeSignatureMatching           FunctionAlgorithm = 7
	FAlgorithmMdIndexMatchingCallGraphTopDown  FunctionAlgorithm = 8
	FAlgorithmMdIndexMatchingCallGraphBottomUp FunctionAlgorithm = 9
	FAlgorithmRelaxedMdIndexMatching           FunctionAlgorithm = 10
	FAlgorithmInstructionCount                 FunctionAlgorithm = 11
	FAlgorithmAddressSequence                  FunctionAlgorithm = 12
	FAlgorithmStringReferences                 FunctionAlgorithm = 13
	FAlgorithmLoopCountMatching                FunctionAlgorithm = 14
	FAlgorithmCallSequenceMatchingExact        FunctionAlgorithm = 15
	FAlgorithmCallSequenceMatchingTopology     FunctionAlgorithm = 16
	FAlgorithmCallSequenceMatchingSequence     FunctionAlgorithm = 17
	FAlgorithmCallReferenceMatching            FunctionAlgorithm = 18
	FAlgorithmManual                           FunctionAlgorithm = 19
)

type FunctionMatch

type FunctionMatch struct {
	ID             int             `gorm:"primaryKey"`
	Address1       decimal.Decimal `gorm:"type:BIGINT"`
	Name1          string
	Address2       decimal.Decimal `gorm:"type:BIGINT"`
	Name2          string
	Similarity     float64
	Confidence     float64
	Flags          int
	Algorithm      FunctionAlgorithm
	Evalute        bool
	Commentsported bool
	Basicblocks    int
	Edges          int
	Instructions   int
}

func (FunctionMatch) String

func (fm FunctionMatch) String() string

type Instruction

type Instruction struct {
	ID       int             `gorm:"primaryKey"`
	Address1 decimal.Decimal `gorm:"type:BIGINT"`
	Address2 decimal.Decimal `gorm:"type:BIGINT"`
}

func (Instruction) String

func (i Instruction) String() string

type Metadata

type Metadata struct {
	Version     string
	File1       int
	File2       int
	Description string
	Created     time.Time
	Modified    time.Time
	Similarity  float64
	Confidence  float64
}