justan0th3rstud3nt
/
garble
mirror of https://github.com/burrowers/garble
1
0
Fork 0
Code Issues 1 Projects Releases Wiki Activity

README: slightly tweak the wording around flags

Browse Source 
Make the literals section easier to follow by using the word
"expression" more consistently.

The tiny section was misleading as well, as the README made it seem like
position information was stripped both with and without the flag.
Clarify what happens with that information in each case.
pull/569/head
Daniel Martí 3 years ago committed by Andrew LeFevre
parent 8d36e1d80e
commit 8bc971e0a2
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File

16
README.md
Unescape Escape View File

@ -28,8 +28,8 @@ order to:
* Replace as many useful identifiers as possible with short base64 hashes * Replace as many useful identifiers as possible with short base64 hashes
* Replace package paths with short base64 hashes * Replace package paths with short base64 hashes
* Replace filenames and position information with short base64 hashes
* Remove all [build](https://go.dev/pkg/runtime/#Version) and [module](https://go.dev/pkg/runtime/debug/#ReadBuildInfo) information * Remove all [build](https://go.dev/pkg/runtime/#Version) and [module](https://go.dev/pkg/runtime/debug/#ReadBuildInfo) information
* Strip filenames and shuffle position information
* Strip debugging information and symbol tables via `-ldflags="-w -s"` * Strip debugging information and symbol tables via `-ldflags="-w -s"`
* [Obfuscate literals](#literal-obfuscation), if the `-literals` flag is given * [Obfuscate literals](#literal-obfuscation), if the `-literals` flag is given
* Remove [extra information](#tiny-mode), if the `-tiny` flag is given * Remove [extra information](#tiny-mode), if the `-tiny` flag is given
@ -54,19 +54,19 @@ $ PATH=$(go1.17.1 env GOROOT)/bin:${PATH} garble build
### Literal obfuscation ### Literal obfuscation
Using the `-literals` flag causes literal expressions such as strings to be Using the `-literals` flag causes literal expressions such as strings to be
replaced with more complex variants, resolving to the same value at run-time. replaced with more complex expressions, resolving to the same value at run-time.
This feature is opt-in, as it can cause slow-downs depending on the input code. This feature is opt-in, as it can cause slow-downs depending on the input code.
Literal expressions used as constants cannot be obfuscated, since they are Literals used in constant expressions cannot be obfuscated, since they are
resolved at compile time. This includes any expressions part of a `const` resolved at compile time. This includes any expressions part of a `const`
declaration. declaration, for example.
### Tiny mode ### Tiny mode
When the `-tiny` flag is passed, extra information is stripped from the resulting With the `-tiny` flag, even more information is stripped from the Go binary.
Go binary. This includes line numbers, filenames, and code in the runtime that Position information is removed entirely, rather than being obfuscated.
prints panics, fatal errors, and trace/debug info. All in all this can make binaries Runtime code which prints panics, fatal errors, and trace/debug info is removed.
2-5% smaller in our testing, as well as prevent extracting some more information. All in all, this can make binaries 2-5% smaller.
With this flag, no panics or fatal runtime errors will ever be printed, but they With this flag, no panics or fatal runtime errors will ever be printed, but they
can still be handled internally with `recover` as normal. In addition, the can still be handled internally with `recover` as normal. In addition, the

Write Preview
Loading…
Cancel
Save