tfmask 项目使用教程

1. 项目的目录结构及介绍

tfmask/
├── LICENSE
├── Makefile
├── README.md
├── README.yaml
├── go.mod
├── main.go
├── main_test.go
└── editorconfig

• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• Makefile: 包含项目的构建和测试命令。
• README.md: 项目的主要介绍文档。
• README.yaml: 项目的 YAML 格式介绍文档。
• go.mod: Go 语言的模块定义文件。
• main.go: 项目的主入口文件。
• main_test.go: 项目的测试文件。
• editorconfig: 编辑器配置文件，用于统一代码风格。

2. 项目的启动文件介绍

main.go 是 tfmask 项目的主入口文件。它包含了主要的逻辑，用于处理 Terraform 输出的敏感信息屏蔽。以下是 main.go 文件的简要介绍：

package main

import (
    "fmt"
    "os"
    "regexp"
    "io/ioutil"
    "strings"
)

func main() {
    // 主函数逻辑
}

• package main: 定义了包名为 main。
• import: 导入了必要的 Go 标准库和其他库。
• main 函数: 程序的入口点，包含了处理 Terraform 输出屏蔽的逻辑。

3. 项目的配置文件介绍

tfmask 项目的配置主要通过环境变量进行设置。以下是一些重要的环境变量及其默认值：

• TFMASK_CHAR: 用于屏蔽输出的字符，默认值为 *。
• TFMASK_VALUES_REGEX: 用于匹配需要屏蔽的值的正则表达式。
• TFMASK_RESOURCES_REGEX: 用于匹配需要屏蔽的资源的正则表达式。

示例 envrc 文件：

# Export terraform environment
export TFMASK_CHAR="#"
export TFMASK_VALUES_REGEX="( i)^ *[^a-zA-Z](oauth|secret|token|password|key|result|id) *$"

通过设置这些环境变量，可以自定义 tfmask 的行为，以适应不同的需求。