justan0th3rstud3nt
/
garble
mirror of https://github.com/burrowers/garble
1
0
Fork 0
Code Issues 1 Projects Releases Wiki Activity
Forked from: github.com/burrowers/garble
154 Commits
3 Branches
23 Tags
10 MiB
Go 98.8%
Shell 1.1%
AMPL 0.1%
 
 
 
Go to file
Pagran 13a5b2fe8e First version
.github First version
internal set up an AUTHORS file to attribute copyright
scripts First version
testdata Rewrite renaming logic for private names and reduce length of public names ()
.gitattributes start testing on GitHub Actions
.gitignore skip literals used in constant expressions
AUTHORS set up an AUTHORS file to attribute copyright
CONTRIBUTING.md set up an AUTHORS file to attribute copyright
LICENSE set up an AUTHORS file to attribute copyright
README.md remove unnecessary data from runtime if -tiny is passed
bench_test.go set up an AUTHORS file to attribute copyright
go.mod Garble imports and package paths in GOPRIVATE ()
go.sum Garble imports and package paths in GOPRIVATE ()
import_obfuscation.go Rewrite renaming logic for private names and reduce length of public names ()
line_obfuscator.go Strip all filename and position info when -tiny is passed ()
main.go Add go version validation ()
main_test.go set up an AUTHORS file to attribute copyright
runtime_strip.go remove unnecessary data from runtime if -tiny is passed

README.md

garble

GO111MODULE=on go get mvdan.cc/garble

Obfuscate Go code by wrapping the Go toolchain. Requires Go 1.15 or later, since Go 1.14 uses an entirely different object format.

garble build [build flags] [packages]

See garble -h for up to date usage information.

Purpose

Produce a binary that works as well as a regular build, but that has as little information about the original source code as possible.

The tool is designed to be:

  • Coupled with cmd/go, to support both GOPATH and modules with ease
  • Deterministic and reproducible, given the same initial source code
  • Reversible given the original source, to un-garble panic stack traces

Mechanism

The tool wraps calls to the Go compiler and linker to transform the Go build, in order to:

  • Replace as many useful identifiers as possible with short base64 hashes
  • Replace package paths with short base64 hashes
  • Remove all build and module information
  • Strip filenames and shuffle position information
  • Strip debugging information and symbol tables
  • Obfuscate literals, if the -literals flag is given
  • Removes extra information if the -tiny flag is given

Options

By default, the tool garbles the packages under the current module. If not running in module mode, then only the main package is garbled. To specify what packages to garble, set GOPRIVATE, documented at go help module-private.

Caveats

Most of these can improve with time and effort. The purpose of this section is to document the current shortcomings of this tool.

  • Build caching is not supported, so large projects will likely be slow to build. See golang/go#41145.

  • Exported methods and fields are never garbled at the moment, since they could be required by interfaces and reflection. This area is a work in progress.

  • Functions implemented outside Go, such as assembly, aren't garbled since we currently only transform the input Go source.

  • Go plugins are not currently supported; see #87.

Tiny Mode

When the -tiny flag is passed, extra information is stripped from the resulting Go binary. This includes line numbers, filenames, and code in the runtime the prints panics, fatal errors, and trace/debug info. All in all this can make binaries 6-10% smaller in our testing.

Note: if -tiny is passed, no panics, fatal errors will ever be printed, but they can still be handled internally with recover as normal. In addition, the GODEBUG environmental variable will be ignored.