garble

go install mvdan.cc/garble@latest

通过包装Go工具链来混淆Go代码。需要Go 1.20或更高版本。

garble build [构建标志] [包]

该工具还支持garble test来运行混淆代码的测试，garble run来混淆并执行简单程序，以及garble reverse来反混淆堆栈跟踪等文本。运行garble -h查看所有可用的命令和标志。

您也可以使用go install mvdan.cc/garble@master安装最新的开发版本。

生成一个与常规构建一样工作良好，但包含尽可能少的原始源代码信息的二进制文件。

该工具设计为：

该工具包装对Go编译器和链接器的调用，以转换Go构建，目的是：

默认情况下，该工具会混淆所有正在构建的包。您可以通过GOGARBLE手动指定要混淆的包，它是一个以逗号分隔的glob模式列表，匹配包路径前缀。这种格式借鉴自GOPRIVATE；参见go help private。

请注意，像garble build这样的命令将使用在您的$PATH中找到的go版本。要使用不同版本的Go，您可以安装它们并使用它们设置$PATH。例如，对于Go 1.17.1：

$ go install golang.org/dl/go1.17.1@latest
$ go1.17.1 download
$ PATH=$(go1.17.1 env GOROOT)/bin:${PATH} garble build

一个常见的问题是为什么编译语言Go需要代码混淆器。Go二进制文件包含大量关于原始源代码的信息；即使剥离了调试信息和符号表，许多名称和位置仍然保留，以便进行跟踪、反射和调试。

某些Go用例需要与最终用户共享Go二进制文件。如果二进制文件的源代码是私有的或需要购买，混淆可以帮助阻止逆向工程。

类似的用例是源代码私有或需要购买的Go库。由于Go库不能以二进制形式导入，而Go插件有其缺点，共享混淆的源代码成为一种选择。参见#369。

混淆还可以帮助处理与许可完全无关的方面。例如，-tiny标志可以使二进制文件缩小15%，类似于Android中常见的做法以减小应用程序大小。混淆还帮助一些开源开发者解决了反病毒扫描错误地将Go二进制文件视为恶意软件的问题。

使用-literals标志会导致字符串等字面表达式被替换为更复杂的表达式，在运行时解析为相同的值。通过-ldflags=-X注入的字符串字面量也会被此标志替换。这个功能是选择性的，因为它可能会根据输入代码导致性能下降。

在常量表达式中使用的字面量不能被混淆，因为它们在编译时解析。这包括任何作为const声明一部分的表达式。

使用-tiny标志，可以从Go二进制文件中剥离更多信息。位置信息被完全移除，而不是被混淆。打印恐慌、致命错误和跟踪/调试信息的运行时代码被移除。许多符号名也在链接时从二进制节中省略。总的来说，这可以使二进制文件缩小约15%。

使用此标志时，永远不会打印任何恐慌或致命运行时错误，但它们仍然可以像往常一样通过recover在内部处理。此外，GODEBUG环境变量将被忽略。

请注意，这个标志可能会使调试崩溃变得更加困难，因为恐慌将简单地退出整个程序而不打印堆栈跟踪，并且源代码位置和许多名称都被移除。同样，在这种模式下garble reverse通常不太有用。

garble build应该比go build大约多花两倍的时间，因为它需要完成两次构建。原始构建用于加载和类型检查输入代码，然后是混淆构建。

Garble一次混淆一个包，模仿Go一次编译一个包的方式。这允许Garble完全支持Go的构建缓存；增量的garble build调用应该只重新构建和重新混淆修改过的代码。

请注意，第一次调用garble build可能相对较慢，因为它必须首次混淆每个包。这类似于使用go clean -cache清除GOCACHE并从头开始运行go build。

Garble还使用自己的缓存来重用工作，类似于Go的GOCACHE。它默认存放在用户的缓存目录下，如~/.cache/garble，可以通过设置GARBLE_CACHE将其放在其他地方。

就像Go一样，garble构建本质上是确定性和可重复的。这有显著的好处，比如缓存构建和能够使用garble reverse来反混淆堆栈跟踪。

默认情况下，garble会以独特的方式混淆每个包，如果其构建输入发生变化，混淆方式也会改变：garble版本、Go版本、包的源代码，或任何构建参数如GOOS或-tags。这是一个合理的默认设置，因为猜测这些输入非常困难。

您可以使用-seed标志提供自己的混淆随机种子。重用相同的种子可以帮助产生相同的代码混淆，这在调试或重现问题时很有帮助。定期轮换种子也可以长期帮助防止逆向工程，否则人们可以通过观察Go标准库的混淆方式变化来猜测一系列构建中Go或garble版本何时发生了变化。

要为每次构建使用不同的种子，请使用-seed=random。请注意，使用自定义种子时应格外小心：如果构建中使用的-seed值丢失，garble reverse将无法工作。

这些大多数可以随着时间和努力而改进。本节的目的是记录这个工具当前的缺点。

目前，导出的方法永远不会被混淆，因为它们可能被接口所需要。这个领域正在进行中；参见#3。
Garble自动检测哪些Go类型与反射一起使用，以避免混淆它们，因为这可能会破坏您的程序。请注意，Garble一次混淆一个包，所以如果您的反射代码检查导入包中的类型，您可能需要在导入的包中添加一个"提示"来排除混淆它：

type Message struct {
    Command string
    Args    string
}

// 永远不要混淆Message类型。
var _ = reflect.TypeOf(Message{})

除了使用GOGARBLE选择要混淆的包模式，以及上面使用reflect.TypeOf的提示来排除混淆特定类型之外，目前没有支持的方法来排除混淆特定文件或包的选择。更多情况下，用户想这样做是为了解决一个bug；请直接报告这个bug。
Go程序按包初始化，其中导入的包总是在其导入者之前初始化，否则它们按照其导入路径的词法顺序初始化。由于garble混淆了导入路径，这种词法顺序可能会任意改变。
目前不支持Go插件；参见#87。
Garble需要git来修补链接器。一旦go-gitdiff支持非严格补丁，就可以避免这一点。

我们欢迎新的贡献者。如果您想贡献，请参阅CONTRIBUTING.md作为起点。