prepare for the first release (#264)
First, write a changelog file. We will use GitHub releases, but the
content in those is not stored in git nor is it portable or machine
readable. The canonical place for the changelog is here.
Second, disable 'garble test', as it is entirely broken. Issue #241
tracks fixing and re-enabling it, which will most likely happen for the
next release.
Third, disable the undocumented 'garble list'. This was added as part of
'garble reverse', but it never got used. I can't think of any reason why
any end user would prefer it over 'go list', either.
'garble reverse' remains enabled, but undocumented as it isn't fully
functional yet. Until it supports position information, it's not
particularly useful to end users. But it's not broken either, so it can
remain where it is.
Fourth, update the '-tiny' size reduction numbers in the README. Since
we removed the in-place modification of object files, we are no longer
able to do such an aggressive stripping of info. Garble itself drops in
size by 2%, so replace the old 6-10% estimate by 2-5%. We probably will
gain some of this back in the near future.
Finally, fix the indentation formatting of the README to consistently
use tabs.
3 years ago
|
|
|
# Changelog
|
|
|
|
|
|
|
|
|
|
## [0.5.1] - 2022-01-18
|
|
|
|
|
|
|
|
|
|
This bugfix release features:
|
|
|
|
|
|
|
|
|
|
* Obfuscate exported names in `main` packages
|
|
|
|
|
* Fix build errors when using `-literals` with `GOGARBLE=*`
|
|
|
|
|
* Avoid breaking `-ldflags=-X` when `-literals` is used
|
|
|
|
|
* Avoid link errors when using `-debugdir`
|
|
|
|
|
* Speed up obfuscating the `runtime` package
|
|
|
|
|
|
|
|
|
|
## [0.5.0] - 2022-01-06
|
|
|
|
|
|
|
|
|
|
This release of Garble adds initial support for the upcoming Go 1.18,
|
|
|
|
|
continues support for Go 1.17.x, and drops support for Go 1.16.x.
|
|
|
|
|
Note that building generic code isn't supported just yet.
|
|
|
|
|
|
|
|
|
|
Two breaking changes are introduced:
|
|
|
|
|
|
|
|
|
|
* Deprecate the use of `GOPRIVATE` in favor of `GOGARBLE` (see https://github.com/burrowers/garble/issues/276)
|
|
|
|
|
* `garble reverse` now requires a main package argument
|
|
|
|
|
|
|
|
|
|
Noteworthy changes include:
|
|
|
|
|
|
|
|
|
|
* Improve detection of `reflect` usage even further
|
|
|
|
|
* Support obfuscating some more standard library packages
|
|
|
|
|
* Improve literal obfuscation by using constant folding
|
|
|
|
|
* Add the `-debug` flag to log details of the obfuscated build
|
|
|
|
|
* Ensure the `runtime` package is built in a reproducible way
|
|
|
|
|
* Obfuscate local variable names to prevent shadowing bugs
|
|
|
|
|
* Fix and test support for using garble on 32-bit hosts
|
|
|
|
|
|
|
|
|
|
## [0.4.0] - 2021-08-26
|
|
|
|
|
|
|
|
|
|
This release of Garble adds support for Go 1.17.x while maintaining support for
|
|
|
|
|
Go 1.16.x. A few other noteworthy changes are included:
|
|
|
|
|
|
|
|
|
|
* Support obfuscating literals in more edge cases with `-literals`
|
|
|
|
|
* Improve detection of `reflect` usage with standard library APIs
|
|
|
|
|
* Names exported for cgo are no longer obfuscated
|
|
|
|
|
* Avoid breaking consts using `iota` with `-literals`
|
|
|
|
|
|
|
|
|
|
Known bugs:
|
|
|
|
|
|
|
|
|
|
* obfuscating the entire standard library with `GOPRIVATE=*` is not well supported yet
|
|
|
|
|
|
|
|
|
|
## [0.3.0] - 2021-05-31
|
prepare for the first release (#264)
First, write a changelog file. We will use GitHub releases, but the
content in those is not stored in git nor is it portable or machine
readable. The canonical place for the changelog is here.
Second, disable 'garble test', as it is entirely broken. Issue #241
tracks fixing and re-enabling it, which will most likely happen for the
next release.
Third, disable the undocumented 'garble list'. This was added as part of
'garble reverse', but it never got used. I can't think of any reason why
any end user would prefer it over 'go list', either.
'garble reverse' remains enabled, but undocumented as it isn't fully
functional yet. Until it supports position information, it's not
particularly useful to end users. But it's not broken either, so it can
remain where it is.
Fourth, update the '-tiny' size reduction numbers in the README. Since
we removed the in-place modification of object files, we are no longer
able to do such an aggressive stripping of info. Garble itself drops in
size by 2%, so replace the old 6-10% estimate by 2-5%. We probably will
gain some of this back in the near future.
Finally, fix the indentation formatting of the README to consistently
use tabs.
3 years ago
|
|
|
|
|
|
|
|
This release of Garble fixes a number of bugs and improves existing features,
|
|
|
|
|
while maintaining support for Go 1.16.x. Notably:
|
|
|
|
|
|
|
|
|
|
* Make builds reproducible even when cleaning `GOCACHE`
|
|
|
|
|
* Detecting types used with reflection is more reliable
|
|
|
|
|
* Cross builds with `GOPRIVATE=*` are now supported
|
|
|
|
|
* Support conversion between struct types from different packages
|
|
|
|
|
* Improve support for type aliases
|
|
|
|
|
* Function names used with `go:linkname` are now obfuscated
|
|
|
|
|
* `garble reverse` can now reverse field names and lone filenames
|
|
|
|
|
|
|
|
|
|
Known bugs:
|
|
|
|
|
|
|
|
|
|
* obfuscating the entire standard library with `GOPRIVATE=*` is not well supported yet
|
|
|
|
|
|
|
|
|
|
## [0.2.0] - 2021-04-08
|
|
|
|
|
|
|
|
|
|
This release of Garble drops support for Go 1.15.x, which is necessary for some
|
|
|
|
|
of the enhancements below:
|
|
|
|
|
|
|
|
|
|
* New: `garble test` allows running Go tests built with obfuscation
|
|
|
|
|
* New: `garble reverse` allows de-obfuscating output like stack traces
|
|
|
|
|
* Names of functions implemented in assembly are now obfuscated
|
|
|
|
|
* `GOPRIVATE=*` now works with packages like `crypto/tls` and `embed`
|
|
|
|
|
* `garble build` can now be used with many main packages at once
|
|
|
|
|
* `-literals` is more robust and now works on all of `std`
|
|
|
|
|
|
|
|
|
|
The README is also overhauled to be more helpful to first-time users.
|
|
|
|
|
|
|
|
|
|
Known bugs:
|
|
|
|
|
|
|
|
|
|
* obfuscating the entire standard library with `GOPRIVATE=*` is not well supported yet
|
|
|
|
|
|
|
|
|
|
## [0.1.0] - 2021-03-05
|
|
|
|
|
|
prepare for the first release (#264)
First, write a changelog file. We will use GitHub releases, but the
content in those is not stored in git nor is it portable or machine
readable. The canonical place for the changelog is here.
Second, disable 'garble test', as it is entirely broken. Issue #241
tracks fixing and re-enabling it, which will most likely happen for the
next release.
Third, disable the undocumented 'garble list'. This was added as part of
'garble reverse', but it never got used. I can't think of any reason why
any end user would prefer it over 'go list', either.
'garble reverse' remains enabled, but undocumented as it isn't fully
functional yet. Until it supports position information, it's not
particularly useful to end users. But it's not broken either, so it can
remain where it is.
Fourth, update the '-tiny' size reduction numbers in the README. Since
we removed the in-place modification of object files, we are no longer
able to do such an aggressive stripping of info. Garble itself drops in
size by 2%, so replace the old 6-10% estimate by 2-5%. We probably will
gain some of this back in the near future.
Finally, fix the indentation formatting of the README to consistently
use tabs.
3 years ago
|
|
|
This is the first release of Garble. It supports Go 1.15.x and 1.16.x.
|
|
|
|
|
|
|
|
|
|
It ships all the major features that have worked for the past year, including:
|
|
|
|
|
|
|
|
|
|
* Obfuscation of all names, except methods and reflect targets
|
|
|
|
|
* Obfuscation of package import paths and position information
|
|
|
|
|
* Stripping of build and module information
|
|
|
|
|
* Support for Go modules
|
|
|
|
|
* Reproducible and cacheable builds
|
|
|
|
|
* Stripping of extra information via `-tiny`
|
|
|
|
|
* Literal obfuscation via `-literals`
|
|
|
|
|
|
|
|
|
|
Known bugs:
|
|
|
|
|
|
|
|
|
|
* obfuscating the standard library with `GOPRIVATE=*` is not well supported yet
|
|
|
|
|
* `garble test` is temporarily disabled, as it is currently broken
|
|
|
|
|
|
|
|
|
|
[0.5.1]: https://github.com/burrowers/garble/releases/tag/v0.5.1
|
|
|
|
|
[0.5.0]: https://github.com/burrowers/garble/releases/tag/v0.5.0
|
|
|
|
|
[0.4.0]: https://github.com/burrowers/garble/releases/tag/v0.4.0
|
|
|
|
|
[0.3.0]: https://github.com/burrowers/garble/releases/tag/v0.3.0
|
|
|
|
|
[0.2.0]: https://github.com/burrowers/garble/releases/tag/v0.2.0
|
|
|
|
|
[0.1.0]: https://github.com/burrowers/garble/releases/tag/v0.1.0
|