Skip to content

Freebsd subcommand #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
securechicken wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Freebsd subcommand #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7bd4ef
dwarf2json: add FreeBSD kernel support
ant1 Jun 25, 2024
db4ff26
Add freebsd subcommand/flagset, discard System.map
securechicken Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 55 additions & 12 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func (f *FilesToProcess) Add(newFile FileToProcess) {

// The symbol names are part of Linux's or Mac's read-only data
// Their contents will be saved, if the symbol is found
var constantLinuxDataSymbols = []string{"linux_banner"}
var constantLinuxDataSymbols = []string{"linux_banner", "version"}
var constantMacosDataSymbols = []string{"version"}

// The compiler can add a leading underscore to symbol names in the symbol
Expand Down Expand Up @@ -615,7 +615,7 @@ func readELFSymbol(file *elf.File, symbol elf.Symbol) ([]byte, error) {
var err error

for _, section := range file.Sections {
if section.Name == ".rodata" &&
if (section.Name == ".data" || section.Name == ".rodata") &&
(section.Flags&elf.SHF_ALLOC) == elf.SHF_ALLOC &&
section.Addr <= symbol.Value &&
(section.Addr+section.Size) >= (symbol.Value+symbol.Size) {
Expand Down Expand Up @@ -669,8 +669,9 @@ func main() {
A tool for generating intermediate symbol file (ISF)

Commands:
linux generate ISF for Linux analysis
mac generate ISF for macOS analysis
linux generate ISF for Linux analysis
freebsd generate ISF for FreeBSD analysis
mac generate ISF for macOS analysis

`,
os.Args[0])
Expand All @@ -690,15 +691,25 @@ Commands:

// linux subcommand setup
linuxArgs := pflag.NewFlagSet("linux", pflag.ExitOnError)
elfPaths := linuxArgs.StringArray("elf", nil, "ELF file `PATH` to extract symbol and type information")
systemMapPaths := linuxArgs.StringArray("system-map", nil, "System.Map file `PATH` to extract symbol information")
elfTypePaths := linuxArgs.StringArray("elf-types", nil, "ELF file `PATH` to extract only type information")
elfSymbolPaths := linuxArgs.StringArray("elf-symbols", nil, "ELF file `PATH` to extract only symbol information")
lelfPaths := linuxArgs.StringArray("elf", nil, "ELF file `PATH` to extract symbol and type information")
lsystemMapPaths := linuxArgs.StringArray("system-map", nil, "System.Map file `PATH` to extract symbol information")
lelfTypePaths := linuxArgs.StringArray("elf-types", nil, "ELF file `PATH` to extract only type information")
lelfSymbolPaths := linuxArgs.StringArray("elf-symbols", nil, "ELF file `PATH` to extract only symbol information")
linuxArgs.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s linux [OPTIONS]\n\n", TOOL_NAME)
linuxArgs.PrintDefaults()
}

// freebsd subcommand setup
freebsdArgs := pflag.NewFlagSet("freebsd", pflag.ExitOnError)
felfPaths := freebsdArgs.StringArray("elf", nil, "ELF file `PATH` to extract symbol and type information")
felfTypePaths := freebsdArgs.StringArray("elf-types", nil, "ELF file `PATH` to extract only type information")
felfSymbolPaths := freebsdArgs.StringArray("elf-symbols", nil, "ELF file `PATH` to extract only symbol information")
freebsdArgs.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s freebsd [OPTIONS]\n\n", TOOL_NAME)
freebsdArgs.PrintDefaults()
}

if len(os.Args) < 2 {
pflag.Usage()
os.Exit(0)
Expand Down Expand Up @@ -747,23 +758,23 @@ Commands:

var filesToProcess FilesToProcess
// Type only
for _, filePath := range *elfTypePaths {
for _, filePath := range *lelfTypePaths {
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: DwarfTypes})
}

// Type and Symbols
for _, filePath := range *elfPaths {
for _, filePath := range *lelfPaths {
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: SymTabSymbols | DwarfSymbols | DwarfTypes | ConstantData})
}

//Symbol only
for _, filePath := range *elfSymbolPaths {
for _, filePath := range *lelfSymbolPaths {
// filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: DwarfSymbols | SymTabSymbols | ConstantData})
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: SymTabSymbols | ConstantData})
}

// System.Map processing
for _, filePath := range *systemMapPaths {
for _, filePath := range *lsystemMapPaths {
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: SystemMap})
}

Expand All @@ -779,6 +790,38 @@ Commands:
os.Exit(1)
}

case "freebsd":
freebsdArgs.Parse(os.Args[2:])

var filesToProcess FilesToProcess
// Type only
for _, filePath := range *felfTypePaths {
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: DwarfTypes})
}

// Type and Symbols
for _, filePath := range *felfPaths {
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: SymTabSymbols | DwarfSymbols | DwarfTypes | ConstantData})
}

//Symbol only
for _, filePath := range *felfSymbolPaths {
// filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: DwarfSymbols | SymTabSymbols | ConstantData})
filesToProcess.Add(FileToProcess{FilePath: filePath, Extract: SymTabSymbols | ConstantData})
}

if len(filesToProcess) == 0 {
fmt.Fprintf(os.Stderr, "No files specified\n")
freebsdArgs.Usage()
os.Exit(1)
}

doc, err = generateLinux(filesToProcess)
if err != nil {
fmt.Fprintf(os.Stderr, "Failed freebsd processing: %v\n", err)
os.Exit(1)
}

case "-h", "--help":
pflag.Usage()
os.Exit(0)
Expand Down