Skip to content
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.

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

Binary package: Base module for binary analysis #1856

Merged
merged 3 commits into from
Jan 21, 2021

Conversation

puerco
Copy link
Member

@puerco puerco commented Jan 19, 2021

What type of PR is this?

/kind feature

What this PR does / why we need it:

This commit initializes the new binary package which will house our new code for performing
verification and analysis of binary executables.

This first iteration adds the base implementations to open and extract data from the executable
headers of ELF (Linux), Mach-O (MacOS) and PE (Win) binaries.

The binary.Binary object has two methods:

  • Arch() returns the GOARCH label obtained from analyzing a binary
  • OS() returns the GOOS label that indicates the operating system of the binary

The object has a Header object which can be queried to get some platform-specific info. Currently
has one method: WordLength() which returns an integer (32/64) which will determine if the file is a
32 or 64 bit binary.i

Signed-off-by: Adolfo García Veytia (Puerco) adolfo.garcia@uservers.net

Which issue(s) this PR fixes:

Part of #1837
Part of the fix for #1521

Special notes for your reviewer:

Base scaffolding for the module. It currently has simple functionality which will get new features as the BOM work progresses

Example usage:

bin, err := binary.New("path/to/file.exe")
if err != nil {
	logrus.Fatal(err)
}
// Print the file arch and OS:
fmt.Printf("File is an executable for %s/%s\n", bin.OS(), bin.Arch())

Tests are included

Does this PR introduce a user-facing change?

New `binary` module for analysis of executables. Initial functionality includes parsing of ELF, Mach-O and PE (win) executables to determine platform, OS, and wordlength (64/32 bit)

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 19, 2021
@k8s-ci-robot k8s-ci-robot added area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 19, 2021
@puerco puerco mentioned this pull request Jan 19, 2021
19 tasks
pkg/binary/binary.go Outdated Show resolved Hide resolved
pkg/binary/binary.go Outdated Show resolved Hide resolved
pkg/binary/binary.go Outdated Show resolved Hide resolved
pkg/binary/binary.go Outdated Show resolved Hide resolved
pkg/binary/binary.go Outdated Show resolved Hide resolved
pkg/binary/elf.go Show resolved Hide resolved
pkg/binary/mach-o.go Show resolved Hide resolved
pkg/binary/windows.go Show resolved Hide resolved
This commit initializes the new binary package which will
house our code for performing verification and analysis of
binary executables.

This first iteration adds the base implementations to open
and extract data from the executable headers of ELF (Linux),
Mach-O (MacOS) and PE (Win) binaries.

The binary object has two methods:

* `Arch()` returns the GOARCH label obtained from analyzing a binary
* `OS()` returns the GOOS label that indicates the operating system of the binary

The `binary` object has a Header object which can be queried to
get some platform sepcifics info. Has currently one method: `WordLength()`
which returns an integer (32/64) which will determine if the file is a
32 or 64 bit binary.i

Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 21, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: puerco, saschagrunert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 8a27364 into kubernetes:master Jan 21, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Jan 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/release Categorizes an issue or PR as relevant to SIG Release. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants