Repository: gojue/ecapture Branch: master Commit: 4d0d18e2d5f4 Files: 333 Total size: 9.6 MB Directory structure: gitextract_64e4skmz/ ├── .github/ │ ├── ISSUE_TEMPLATE/ │ │ └── bug_report.md │ ├── agents/ │ │ └── pr-agent.md │ └── workflows/ │ ├── android_e2e.yml │ ├── codeql-analysis.yml │ ├── e2e.yml │ ├── go-c-cpp.yml │ ├── pr_build_debug.yml │ ├── pr_build_debug_comment.yml │ └── release.yml ├── .gitignore ├── .gitmodules ├── .golangci.yml ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── README-zh_Hans.md ├── README.md ├── SECURITY.md ├── assets/ │ └── ebpf_probe_stub.go ├── builder/ │ ├── Dockerfile │ ├── Makefile.release │ ├── init_env.sh │ └── rpmBuild.spec ├── bytecode/ │ └── .gitkeep ├── cli/ │ ├── LICENSE │ ├── cmd/ │ │ ├── bash.go │ │ ├── ecaptureq.go │ │ ├── env_detection.go │ │ ├── gnutls.go │ │ ├── gotls.go │ │ ├── mysqld.go │ │ ├── nss.go │ │ ├── postgres.go │ │ ├── root.go │ │ ├── tls.go │ │ ├── upgrade.go │ │ └── zsh.go │ ├── cobrautl/ │ │ └── help.go │ ├── http/ │ │ ├── config_factory.go │ │ ├── config_factory_ecandroid.go │ │ ├── config_factory_linux.go │ │ ├── logger.go │ │ ├── resp.go │ │ ├── server.go │ │ └── status_string.go │ └── main.go ├── dist/ │ └── .gitkeep ├── docs/ │ ├── README.md │ ├── beta-release-guide.md │ ├── compilation-zh_Hans.md │ ├── compilation.md │ ├── e2e-tests.md │ ├── event-forward-api-zh_Hans.md │ ├── event-forward-api.md │ ├── event-forward.md │ ├── refactoring-guide.md │ ├── remote-config-update-api-zh_Hans.md │ └── remote-config-update-api.md ├── examples/ │ ├── ecaptureq_client/ │ │ ├── README.md │ │ ├── TESTING.md │ │ ├── go.mod │ │ ├── go.sum │ │ └── main.go │ └── https_client/ │ ├── golang_https.go │ ├── node_https.js │ └── python3_https.py ├── functions.mk ├── go.mod ├── go.sum ├── internal/ │ ├── README.md │ ├── builder/ │ │ ├── config_builder.go │ │ └── config_builder_test.go │ ├── config/ │ │ ├── base_config.go │ │ └── base_config_test.go │ ├── domain/ │ │ ├── configuration.go │ │ ├── event.go │ │ └── probe.go │ ├── errors/ │ │ ├── errors.go │ │ └── errors_test.go │ ├── events/ │ │ ├── dispatcher.go │ │ └── dispatcher_test.go │ ├── factory/ │ │ ├── probe_factory.go │ │ └── probe_factory_test.go │ ├── logger/ │ │ └── logger.go │ ├── output/ │ │ ├── encoders/ │ │ │ ├── encoder.go │ │ │ ├── json_encoder.go │ │ │ ├── plain_encoder.go │ │ │ └── protobuf_encoder.go │ │ └── writers/ │ │ ├── factory.go │ │ ├── file_writer.go │ │ ├── keylog_writer.go │ │ ├── logger_writer.go │ │ ├── pcap_writer.go │ │ ├── stdout_writer.go │ │ ├── tcp_writer.go │ │ ├── websocket_writer.go │ │ └── writer.go │ └── probe/ │ ├── base/ │ │ ├── base_probe.go │ │ ├── base_probe_test.go │ │ └── handlers/ │ │ ├── handlers.go │ │ ├── keylog_handler.go │ │ ├── keylog_handler_dedup_test.go │ │ ├── keylog_handler_test.go │ │ ├── pcap_handler.go │ │ ├── pcap_handler_test.go │ │ ├── text_handler.go │ │ └── text_handler_test.go │ ├── bash/ │ │ ├── bash_probe.go │ │ ├── bash_test.go │ │ ├── config.go │ │ ├── event.go │ │ └── register.go │ ├── gnutls/ │ │ ├── config.go │ │ ├── config_test.go │ │ ├── event.go │ │ ├── event_masterkey.go │ │ ├── gnutls_probe.go │ │ ├── gnutls_probe_test.go │ │ └── register.go │ ├── gotls/ │ │ ├── config.go │ │ ├── config_symbol.go │ │ ├── config_symbol_test.go │ │ ├── config_test.go │ │ ├── event.go │ │ ├── event_masterkey.go │ │ ├── event_packet.go │ │ ├── go_instructions_amd64.go │ │ ├── go_instructions_arm64.go │ │ ├── gotls_probe.go │ │ ├── gotls_probe_test.go │ │ └── register.go │ ├── mysql/ │ │ ├── config.go │ │ ├── event.go │ │ ├── mysql_probe.go │ │ ├── mysql_test.go │ │ └── register.go │ ├── nspr/ │ │ ├── config.go │ │ ├── config_test.go │ │ ├── event.go │ │ ├── event_masterkey.go │ │ ├── nspr_probe.go │ │ ├── nspr_probe_test.go │ │ └── register.go │ ├── openssl/ │ │ ├── config.go │ │ ├── config_ecandroid.go │ │ ├── config_linux.go │ │ ├── config_test.go │ │ ├── event.go │ │ ├── event_connect.go │ │ ├── event_connect_test.go │ │ ├── event_masterkey.go │ │ ├── event_packet.go │ │ ├── event_test.go │ │ ├── libs.go │ │ ├── openssl_probe.go │ │ ├── openssl_probe_test.go │ │ └── register.go │ ├── postgres/ │ │ ├── config.go │ │ ├── event.go │ │ ├── postgres_probe.go │ │ ├── postgres_test.go │ │ └── register.go │ └── zsh/ │ ├── config.go │ ├── event.go │ ├── register.go │ ├── zsh_probe.go │ └── zsh_test.go ├── kern/ │ ├── README.md │ ├── bash_kern.c │ ├── boringssl_a_13_kern.c │ ├── boringssl_a_14_kern.c │ ├── boringssl_a_15_kern.c │ ├── boringssl_a_16_kern.c │ ├── boringssl_const.h │ ├── boringssl_masterkey.h │ ├── boringssl_na_kern.c │ ├── bpf/ │ │ ├── arm64/ │ │ │ └── vmlinux_614.h │ │ ├── bpf_core_read.h │ │ ├── bpf_endian.h │ │ ├── bpf_helper_defs.h │ │ ├── bpf_helpers.h │ │ ├── bpf_tracing.h │ │ └── x86/ │ │ ├── .gitkeep │ │ └── vmlinux_614.h │ ├── common.h │ ├── core_fixes.bpf.h │ ├── ecapture.h │ ├── gnutls.h │ ├── gnutls_3_6_12_kern.c │ ├── gnutls_3_6_13_kern.c │ ├── gnutls_3_7_0_kern.c │ ├── gnutls_3_7_3_kern.c │ ├── gnutls_3_7_7_kern.c │ ├── gnutls_3_8_4_kern.c │ ├── gnutls_3_8_7_kern.c │ ├── gnutls_masterkey.h │ ├── go_argument.h │ ├── gotls_kern.c │ ├── mysqld_kern.c │ ├── nspr_kern.c │ ├── openssl.h │ ├── openssl_1_0_2a_kern.c │ ├── openssl_1_1_0a_kern.c │ ├── openssl_1_1_1a_kern.c │ ├── openssl_1_1_1b_kern.c │ ├── openssl_1_1_1d_kern.c │ ├── openssl_1_1_1j_kern.c │ ├── openssl_3_0_0_kern.c │ ├── openssl_3_0_12_kern.c │ ├── openssl_3_1_0_kern.c │ ├── openssl_3_2_0_kern.c │ ├── openssl_3_2_3_kern.c │ ├── openssl_3_2_4_kern.c │ ├── openssl_3_3_0_kern.c │ ├── openssl_3_3_2_kern.c │ ├── openssl_3_3_3_kern.c │ ├── openssl_3_4_0_kern.c │ ├── openssl_3_4_1_kern.c │ ├── openssl_3_5_0_kern.c │ ├── openssl_masterkey.h │ ├── openssl_masterkey_3.0.h │ ├── openssl_masterkey_3.2.h │ ├── postgres_kern.c │ ├── tc.h │ └── zsh_kern.c ├── main.go ├── pkg/ │ ├── ecaptureq/ │ │ ├── README.md │ │ ├── client.go │ │ ├── hub.go │ │ └── server.go │ ├── event_processor/ │ │ ├── base_event.go │ │ ├── event.go │ │ ├── http2_request.go │ │ ├── http2_request_test.go │ │ ├── http2_response.go │ │ ├── http2_response_test.go │ │ ├── http_request.go │ │ ├── http_response.go │ │ ├── http_response_test.go │ │ ├── iparser.go │ │ ├── iworker.go │ │ ├── processor.go │ │ ├── processor_test.go │ │ └── testdata/ │ │ └── all.json │ ├── proc/ │ │ ├── go_elf/ │ │ │ ├── eprint.go │ │ │ └── gccgo.go │ │ ├── proc.go │ │ └── proc_test.go │ ├── upgrade/ │ │ ├── github_response.go │ │ ├── upgrade.go │ │ └── upgrade_test.go │ └── util/ │ ├── ebpf/ │ │ ├── bpf.go │ │ ├── bpf_ecandroid.go │ │ ├── bpf_linux.go │ │ ├── bpf_test.go │ │ ├── elibpcap.go │ │ ├── elibpcap_stub.go │ │ └── parse.go │ ├── ethernet/ │ │ └── trailer.go │ ├── hkdf/ │ │ ├── hkdf.go │ │ └── hkdf_test.go │ ├── kernel/ │ │ ├── kernel_version.go │ │ ├── kernel_version_unsupport.go │ │ └── version.go │ ├── roratelog/ │ │ └── rorate.go │ └── ws/ │ ├── client.go │ ├── client_test.go │ ├── server.go │ └── server_test.go ├── protobuf/ │ ├── PROTOCOLS-zh_Hans.md │ ├── PROTOCOLS.md │ ├── README-zh_Hans.md │ ├── README.md │ ├── gen/ │ │ └── v1/ │ │ └── ecaptureq.pb.go │ └── proto/ │ └── v1/ │ └── ecaptureq.proto ├── test/ │ ├── e2e/ │ │ ├── IMPLEMENTATION_STATUS.md │ │ ├── QUICK_REFERENCE.md │ │ ├── README.md │ │ ├── android/ │ │ │ ├── android_bash_e2e_test.sh │ │ │ ├── android_gotls_e2e_test.sh │ │ │ ├── android_tls_e2e_test.sh │ │ │ ├── build_android_tests.sh │ │ │ ├── common_android.sh │ │ │ ├── run_android_e2e_tests.sh │ │ │ └── setup_android_env.sh │ │ ├── bash_advanced_test.sh │ │ ├── bash_e2e_test.sh │ │ ├── common.sh │ │ ├── edge_cases_test.sh │ │ ├── gnutls_e2e_test.sh │ │ ├── go_https_client.go │ │ ├── gotls_advanced_test.sh │ │ ├── gotls_e2e_test.sh │ │ ├── mysql_advanced_test.sh │ │ ├── mysql_e2e_test.sh │ │ ├── postgres_e2e_test.sh │ │ ├── run_e2e.sh │ │ ├── tls_e2e_test.sh │ │ ├── tls_keylog_advanced_test.sh │ │ ├── tls_pcap_advanced_test.sh │ │ ├── tls_text_advanced_test.sh │ │ └── zsh_e2e_test.sh │ └── issue_463/ │ ├── Makefile │ ├── main.c │ └── readme.md ├── tools/ │ └── check_dsb.go ├── utils/ │ ├── boringssl-offset.c │ ├── boringssl_android_offset.sh │ ├── boringssl_non_android_offset.sh │ ├── ecapture.lua │ ├── gnutls_offset.c │ ├── gnutls_offset.sh │ ├── openssl_1_0_2_offset.c │ ├── openssl_1_1_0_offset.c │ ├── openssl_1_1_1_offset.c │ ├── openssl_3_0_offset.c │ ├── openssl_3_2_0_offset.c │ ├── openssl_3_5_0_offset.c │ ├── openssl_offset_1.0.2.sh │ ├── openssl_offset_1.1.0.sh │ ├── openssl_offset_1.1.1.sh │ ├── openssl_offset_3.0.sh │ ├── openssl_offset_3.1.sh │ ├── openssl_offset_3.2.sh │ ├── openssl_offset_3.3.sh │ ├── openssl_offset_3.4.sh │ ├── openssl_offset_3.5.sh │ └── protobuf_visualizer/ │ ├── README.md │ ├── README_CN.md │ └── pb_debugger.go └── variables.mk ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Create a report to help us improve title: '' labels: '' assignees: '' --- > [!IMPORTANT] > You can mention the @dosu AI robot, which can quickly answer your questions. **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. 2. 3. **Screenshots** If applicable, add screenshots to help explain your problem. **Linux Server/Android (please complete the following information):** - Device: `Pixel 9` or `Linux Server` - Kernel Info: `uname -a` - eCapture Version: `ecapture -v` **Additional context** Add any other context about the problem here. ================================================ FILE: .github/agents/pr-agent.md ================================================ --- name: eCapture-PR-Agent display_name: eCapture PR Agent description: > 本 Agent 专门服务于 `gojue/ecapture` 仓库，用于自动创建 **小粒度、可审阅的代码改动 PR**。 --- # eCapture 自动 PR Agent Profile（草案） ## 名称 eCapture 自动 PR 机器人（Auto PR Agent） ## 作用描述 本 Agent 专门服务于 `gojue/ecapture` 仓库，用于自动创建小粒度、可审阅的代码改动 PR。主要目标： - 维护与扩展对 OpenSSL / BoringSSL / GnuTLS / NSS / GoTLS 等加密库版本的 HOOK 支持； - 改进或增加内核 eBPF 侧 C 代码和 Go 用户态逻辑中的健壮性、小 bug 修复； - 强制为变更添加相应测试（单元测试 + e2e 脚本）； - 保持现有构建系统（`Makefile` / `variables.mk` / `functions.mk`）的约定与约束，但不负责发布或打包。 重要约束（严格）： - **不向后兼容** - 不进行打包、发布、Tag 操作； - 不修改 `README*` / `CHANGELOG.md` 等文档（默认禁止改动，除非维护者明确要求）； - 不修改版本号或自动化发布流程。 --- ## 作用范围（Scope） Agent 允许并应该做的事情： 1. OpenSSL/其他加密库版本支持增强（核心任务） - 在 kern/ 源文件（`kern/openssl_*`、`kern/boringssl_*`、`kern/gnutls_*`、`kern/nspr` 等）与用户态版本检测逻辑中，增加对新版本加密库的支持；包括： - 在 `variables.mk` 的 `TARGETS` 中新增目标项； - 添加对应的 `kern/openssl__kern.c` 源文件或必要的偏移/结构体定义； - 在用户态（Go）中补充版本字符串映射、降级/回退逻辑与日志提示。 - 保证对旧版本不回归，并提供最小验证（编译通过或单测覆盖关键路径）。 2. 小范围代码修复与增强 - C 代码：修复明显 bug、加健壮性检查（空指针/边界/长度），改进日志； - Go 代码：改进错误处理、增加或修补单元测试、提升解析/事件处理健壮性； - 避免大规模重构或改动公共 CLI 语义。 3. 构建系统与工具链检查（不发布） - 可修改 `Makefile` / `variables.mk` / `functions.mk` 中与工具链检查、编译选项的小优化； - 不引入打包/发布动作，不修改 release 相关自动化。 4. 自动创建 PR - 基于默认开发分支创建新分支并打开 PR； - PR 描述必须包含：问题背景、修改点、测试方法、兼容性说明。 Agent 禁止的事项（严格）： - 不做发布（不生成 .deb/.rpm，不打 Tag 或更新 release）； - 不修改 README/CHANGELOG； - 不变更 CLI 外部行为（除非明确授权）； - 不直接修改生成的二进制 bytecode（如 user/bytecode/*.o）。 --- ## 仓库关键约束与变更要求 1. 工具链版本要求 - Clang 版本：**要求升级为 clang 12 或更高**。Agent 在必要的构建检查中应把 `.checkver_$(CMD_CLANG)` 的阈值改为 12。 - Go 版本：继续保持 Go 1.24 及以上（GO_VERSION_MAJ == 1 且 GO_VERSION_MIN >= 24）。 - bpftool 等工具保持检查逻辑，但不自动安装这些工具。 2. eBPF / 内核策略 - 保留 CO-RE 与 non-CO-RE 两条构建路径，不破坏 `AUTOGENCMD` 与 `kern/bpf/*/vmlinux.h` 的生成逻辑； - 最小内核：x86_64 ≥ 4.18，aarch64 ≥ 5.5（该约束不被 Agent 更改）。 3. OpenSSL 等库支持策略（Agent 的长期目标） - `variables.mk` 的 `TARGETS` 列表代表已支持版本，但 Agent 的目标是：持续添加对更新版本 OpenSSL/BoringSSL/GnuTLS/NSS 的 HOOK 支持。新增支持时，需： - 新增 target 与 kernel 源文件； - 添加用户态版本映射； - 提交 PR 并附带测试说明与验证方法。 --- ## 软件测试要求（新增） 为保证变更质量与可回溯性，Agent 在创建 PR 前必须满足以下测试要求： 1. 单元测试（必需） - 对于任何修改或新增的 Go 代码，必须新增或修改对应的 Go 单元测试，位于与被修改包相同的测试包（例如 `package foo_test` 或 `package foo`）； - 新增/修改的测试应覆盖主要逻辑分支、异常路径与边界条件； - PR 必须能通过命令：`make test-race`（若有特定包，可只跑对应包的测试）； - 若修改影响到公共函数签名或行为，测试需明确验证向后兼容性。 2. C/内核代码的测试与静态检查（必需/建议） - 对 C/eBPF 源文件，至少要保证能够通过静态语法检查与本地编译（`clang -fsyntax-only` 或 `make ebpf`）； - 若能做到，新增/修改的 C 代码应包含编译时断言或注释说明，以便在 CI 中尽早发现问题； - 在无法运行内核级测试（CI 限制）时，需在 PR 描述中注明“仅编译通过，未在目标内核上运行验证”的限制。 3. CLI E2E 脚本（必需，尽量） - 每个涉及 CLI 行为或集成点的变更，应补充或更新一条 e2e 测试脚本（放在 `test/e2e/` 目录），脚本需： - 能够在受控环境下做基本的“构建 -> 启动 -> smoke test”流程（例如 `ecapture --help`、`ecapture tls -h` 或 keylog/pcap 模式的最小运行检查）； - 需要用root权限运行ecapture，根据代码需求，补充启动时的必要参数（`参见 --help的结果`）； - 再开一个终端，使用`curl`或`wget`等脚本，触发https的请求，以验证eBPF hook的基本功能（如TLS keylog生成、流量捕获等）； - 在 PR 中给出如何运行 e2e 的说明（本地直接执行 / CI 集成的命令行）。 - 例：新增 `test/e2e/run_e2e.sh`，脚本执行： - `go test ./...` 并保存 coverage； - 构建二进制（`make build` 或 `go build` 作为回退）； - 运行 `bin/ecapture --help` 与一个最小子命令进行 smoke-test； - 提供可选的 Docker 模式（注释或开关）以便做更完整的运行时测试（需要 root/特权容器）。 4. CI 要求（必需） - 在 CI 流程中至少运行： - 运行 `make test-race`进行项目的单元测试与竞态检测； - 语法检查、`go vet`、`golangci-lint`； - 轻量 e2e 脚本以验证二进制基本可用性。 - 如涉及 eBPF 运行的严格验证，建议维护者决定是否启用带特权的 runner。 --- ## 风格与质量要求 （与之前描述一致，略述） - 使用 `make format` 格式化项目代码； - 小步提交、单一目的 PR、清晰的 PR 描述； - 所有 PR 中若有未解决的集成测试限制，必须在 PR 描述中注明并提供复现步骤或需要的维护者权限/环境。 --- ## PR 模板建议（尽量用英文） - 标题：`[type] 简短描述`，例如： - `feat: 支持 OpenSSL 3.6.x HOOK` - `fix: 修复 gotls 在某条件下的 panic` - 描述结构： 1. 背景/目的 2. 修改内容（文件/模块列表） 3. 测试说明（单元测试、e2e 脚本、手工验证步骤） 4. 兼容性影响与风险评估 5. CI 运行状态/限制说明（如有） --- ## 安全与保守原则 - 优先**少改**、保守变更； - 若无法确定兼容性或内核行为，不要直接合并，先开 PR 征询维护者； - 不随意修改 release/打包相关变量与文档，除非被明确授权。 ================================================ FILE: .github/workflows/android_e2e.yml ================================================ name: Android E2E Tests on: pull_request: branches: [ master, v2, v1 ] push: branches: [ master, v2, v1 ] workflow_dispatch: permissions: contents: read issues: write pull-requests: write concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: android-e2e-tests: runs-on: ubuntu-latest name: Android E2E Tests strategy: matrix: api-level: [35] # Android 15 target: [google_apis] arch: [x86_64] # Use x86_64 for emulator (host arch matches) steps: - name: Checkout code uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Set up Go uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Install Required Tools run: | sudo apt-get update sudo apt-get install --yes build-essential pkgconf libelf-dev llvm-14 clang-14 flex bison linux-tools-common linux-tools-generic gcc libssl-dev linux-source libpulse0 xvfb libxcb-cursor0 libxkbcommon-x11-0 for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig shell: bash - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Build ecapture for Android run: | # Build for x86_64 (for emulator testing) ANDROID=1 make clean ANDROID=1 make env echo "Building ecapture for Android (x86_64)..." CROSS_ARCH=amd64 ANDROID=1 make nocore -j$(nproc) # Verify binary if [ ! -f bin/ecapture ]; then echo "❌ Failed to build ecapture binary" exit 1 fi echo "=== Binary Info ===" ls -lh bin/ecapture file bin/ecapture # Verify x86_64 architecture if ! file bin/ecapture | grep -q "x86-64\|x86_64"; then echo "❌ Binary is not x86_64" exit 1 fi echo "✓ ecapture built successfully for Android x86_64" - name: Build Go test client for Android run: | cd test/e2e echo "Building Go HTTPS client for Android..." CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o android/go_https_client_android go_https_client.go if [ -f android/go_https_client_android ]; then echo "✓ Go client built successfully" ls -lh android/go_https_client_android file android/go_https_client_android else echo "⚠️ Go client build failed (tests will use curl)" fi - name: Start Xvfb for headless display run: | echo "Starting Xvfb virtual display..." sudo Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & echo "DISPLAY=:99" >> $GITHUB_ENV sleep 2 echo "✓ Xvfb started on display :99" - name: Enable KVM group permissions run: | echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules sudo udevadm control --reload-rules sudo udevadm trigger --name-match=kvm - name: AVD cache uses: actions/cache@v4 id: avd-cache with: path: | ~/.android/avd/* ~/.android/adb* key: avd-${{ matrix.api-level }}-${{ matrix.arch }} - name: Create AVD and generate snapshot for caching if: steps.avd-cache.outputs.cache-hit != 'true' uses: reactivecircus/android-emulator-runner@v2 with: api-level: ${{ matrix.api-level }} target: ${{ matrix.target }} arch: ${{ matrix.arch }} force-avd-creation: false ram-size: 4096M disk-size: 8192M emulator-options: -no-window -no-snapshot-save -noaudio -no-boot-anim -camera-back none disable-animations: true script: echo "Generated AVD snapshot for caching." - name: Run Android E2E Tests uses: reactivecircus/android-emulator-runner@v2 with: api-level: ${{ matrix.api-level }} target: ${{ matrix.target }} arch: ${{ matrix.arch }} force-avd-creation: false ram-size: 4096M disk-size: 8192M emulator-options: -no-snapshot-save -noaudio -no-boot-anim -camera-back none -writable-system disable-animations: true script: | echo "=== Android Emulator Info ===" adb devices adb shell getprop ro.build.version.release adb shell getprop ro.build.version.sdk adb shell uname -a echo "=== Getting root access ===" adb root sleep 5 adb wait-for-device echo "=== Checking root ===" adb shell id echo "=== Setting SELinux to permissive ===" adb shell setenforce 0 || true adb shell getenforce echo "=== Setup environment ===" bash test/e2e/android/setup_android_env.sh || true echo "=== Checking ecapture startup (diagnostic) ===" adb push bin/ecapture /data/local/tmp/ecapture adb shell chmod 755 /data/local/tmp/ecapture echo "--- Verifying eBPF / ecapture can start (3s sample) ---" adb shell "setsid nohup /data/local/tmp/ecapture tls -m text > /data/local/tmp/ecapture_startup.log 2>&1 < /dev/null &" sleep 3 adb shell "ps -A | grep ecapture || echo '(no ecapture process found)'" adb shell "cat /data/local/tmp/ecapture_startup.log 2>/dev/null || echo '(no startup log)'" adb shell "ps -A | grep ecapture | awk '{print \$2}' | while read p; do kill -9 \$p; done 2>/dev/null || true" echo "--- ecapture diagnostic complete ---" bash test/e2e/android/run_android_e2e_tests.sh - name: Upload test artifacts if: always() uses: actions/upload-artifact@v4 with: name: android-e2e-test-logs path: /tmp/ecapture_android_* retention-days: 7 ================================================ FILE: .github/workflows/codeql-analysis.yml ================================================ # For most projects, this workflow file will not need changing; you simply need # to commit it to your repository. # # You may wish to alter this file to override the set of languages analyzed, # or to provide custom queries or build logic. # # ******** NOTE ******** # We have attempted to detect the languages in your repository. Please check # the `language` matrix defined below to confirm you have the correct set of # supported CodeQL languages. # name: "CodeQL" on: push: branches: [ master, v2, v1 ] pull_request: # The branches below must be a subset of the branches above branches: [ master, v2, v1 ] schedule: - cron: '42 15 * * 3' jobs: analyze: name: Analyze runs-on: ubuntu-22.04 permissions: actions: read contents: read security-events: write strategy: fail-fast: false matrix: language: [ 'cpp', 'go' ] # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] # Learn more about CodeQL language support at https://git.io/codeql-language-support steps: - uses: actions/setup-go@v3 with: go-version: '1.24.6' - name: Checkout repository uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Install Compilers run: | sudo apt-get update sudo apt-get install --yes build-essential pkgconf libelf-dev llvm clang linux-tools-common linux-tools-generic flex bison gcc-aarch64-linux-gnu libssl-dev linux-source cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- prepare V=0 ls -al /usr/src/$source_dir shell: bash # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL uses: github/codeql-action/init@v2 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. # By default, queries listed here will override any specified in a config file. # Prefix the list here with "+" to use these queries and those in the config file. # queries: ./path/to/local/query, your-org/your-repo/queries@main # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild uses: github/codeql-action/autobuild@v2 # ℹ️ Command-line programs to run using the OS shell. # 📚 https://git.io/JvXDl # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines # and modify them (or add more) to build your code if your project # uses a compiled language - run: | make env make nocore -j4 - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v2 - name: Upload coverage reports to Codecov uses: codecov/codecov-action@v4 with: token: ${{ secrets.CODECOV_TOKEN }} ================================================ FILE: .github/workflows/e2e.yml ================================================ name: E2E Tests on: pull_request: branches: [ master, v2, v1 ] types: [ opened, synchronize, reopened ] push: branches: [ master, v2, v1 ] permissions: contents: read issues: write pull-requests: write concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: e2e-tests: runs-on: ubuntu-22.04 name: E2E Tests (TLS/GnuTLS/GoTLS) steps: - uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Install Required Tools run: | sudo apt-get update sudo apt-get install --yes \ build-essential \ pkgconf \ libelf-dev \ llvm-14 \ clang-14 \ linux-tools-common \ linux-tools-generic \ gcc \ curl \ wget \ netcat-openbsd \ openssl \ libssl-dev \ ca-certificates # Set up clang-14 as default for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done # Verify tools are installed echo "=== Installed Tool Versions ===" go version clang --version | head -1 curl --version | head -1 wget --version | head -1 openssl version - name: Prepare Linux Headers run: | cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") if [ -n "$source_file" ]; then source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig fi - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Build eCapture run: | make clean make env make -j$(nproc) # Verify binary was built if [ ! -f bin/ecapture ]; then echo "❌ Failed to build ecapture binary" exit 1 fi ls -lh bin/ecapture file bin/ecapture - name: Run E2E Tests run: | echo "=== Running E2E Tests ===" echo "Kernel: $(uname -r)" echo "Architecture: $(uname -m)" # Run comprehensive e2e tests with sudo # Tests will connect to https://github.com to verify TLS capture sudo make e2e || { echo "❌ E2E tests failed" exit 1 } - name: E2E Test Summary if: always() run: | echo "=== E2E Test Execution Complete ===" if [ $? -eq 0 ]; then echo "✅ All E2E tests passed successfully" else echo "❌ Some E2E tests failed - check logs above" fi e2e-tests-summary: runs-on: ubuntu-22.04 name: E2E Test Results Summary needs: e2e-tests if: always() steps: - name: Check E2E Test Results run: | if [ "${{ needs.e2e-tests.result }}" == "success" ]; then echo "✅ E2E Tests: PASSED" exit 0 else echo "❌ E2E Tests: FAILED" exit 1 fi - name: Comment PR with E2E Results if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository uses: actions/github-script@v7 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | const prNumber = context.payload.pull_request.number; const testResult = '${{ needs.e2e-tests.result }}'; const runId = context.runId; const statusEmoji = testResult === 'success' ? '✅' : '❌'; const statusText = testResult === 'success' ? 'PASSED' : 'FAILED'; const body = `## ${statusEmoji} E2E Test Results: ${statusText} **Test Run:** [#${runId}](https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${runId}) ### Tests Executed: - TLS/OpenSSL Module (curl → github.com) - GnuTLS Module (wget/curl → github.com) - GoTLS Module (Go client → github.com) ${testResult === 'success' ? '✅ All e2e tests passed successfully! The TLS capture functionality is working correctly.' : '❌ Some e2e tests failed. Please check the workflow logs for details.'} --- *Automated e2e test results for commit ${context.sha.substring(0, 7)}*`; try { await github.rest.issues.createComment({ issue_number: prNumber, owner: context.repo.owner, repo: context.repo.repo, body: body }); console.log('E2E test results comment posted successfully'); } catch (error) { console.log('Failed to post comment:', error.message); } ================================================ FILE: .github/workflows/go-c-cpp.yml ================================================ name: GO/C/C++ CI on: push: branches: [ master, v2, v1 ] pull_request: branches: [ master, v2, v1 ] jobs: build-on-ubuntu2204: runs-on: ubuntu-22.04 name: build on ubuntu-22.04 x86_64 steps: - uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Install Compilers run: | sudo apt-get update sudo apt-get install --yes build-essential pkgconf libelf-dev llvm-14 clang-14 flex bison linux-tools-common linux-tools-generic gcc gcc-aarch64-linux-gnu libssl-dev linux-source for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- prepare V=0 ls -al /usr/src/$source_dir shell: bash - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Build CO-RE run: | make clean make env DEBUG=1 make -j8 cd ./lib/libpcap/ && sudo make install cd $GITHUB_WORKSPACE - name: golangci-lint uses: golangci/golangci-lint-action@v8 with: version: v2.1 skip-cache: true problem-matchers: true - name: Build non-CO-RE run: | make clean make env make nocore - name: Build CO-RE (Cross-Compilation) run: | make clean CROSS_ARCH=arm64 make env CROSS_ARCH=arm64 make -j8 - name: Build non-CO-RE (Cross-Compilation/Android) run: | make clean CROSS_ARCH=arm64 make env ANDROID=1 CROSS_ARCH=arm64 make nocore -j8 - name: Test run: go test -v -race ./... build-on-ubuntu2204-arm64: runs-on: ubuntu-22.04-arm name: build on ubuntu-22.04 arm64 steps: - uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Install Compilers run: | sudo apt-get update sudo apt-get install --yes build-essential pkgconf libelf-dev llvm-14 clang-14 flex bison linux-tools-common linux-tools-generic gcc gcc-x86-64-linux-gnu libssl-dev linux-source for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig sudo make ARCH=x86 CROSS_COMPILE=x86_64-linux-gnu- prepare V=0 > /dev/null ls -al /usr/src/$source_dir shell: bash - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Build CO-RE run: | make clean make env DEBUG=1 make -j8 cd ./lib/libpcap/ && sudo make install cd $GITHUB_WORKSPACE - name: golangci-lint uses: golangci/golangci-lint-action@v8 with: version: v2.1 skip-cache: true problem-matchers: true - name: Build non-CO-RE run: | make clean make env make nocore - name: Build CO-RE (Cross-Compilation) run: | make clean CROSS_ARCH=amd64 make env CROSS_ARCH=amd64 make -j8 - name: Build non-CO-RE (Cross-Compilation/Android) run: | make clean CROSS_ARCH=amd64 make env ANDROID=1 CROSS_ARCH=amd64 make nocore -j8 - name: Test run: go test -v -race ./... ================================================ FILE: .github/workflows/pr_build_debug.yml ================================================ name: PR Build (Debug) on: pull_request: branches: [ master, v2, v1 ] types: [ opened, synchronize, reopened ] permissions: contents: read actions: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build-debug-artifacts: runs-on: ubuntu-22.04 name: Build Debug Artifacts strategy: matrix: os: [ android, linux ] arch: [ arm64, amd64 ] steps: - uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Install Compilers shell: bash run: | sudo apt-get update sudo apt-get install --yes \ build-essential \ pkgconf \ libelf-dev \ llvm-14 \ clang-14 \ linux-tools-common \ linux-tools-generic \ gcc \ gcc-aarch64-linux-gnu \ linux-source for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- prepare V=0 - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - name: Build Debug amd64 if: matrix.arch == 'amd64' run: | make clean make env DEBUG=1 make -f builder/Makefile.release release SNAPSHOT_VERSION=v0.0.0-pr-${{ github.event.number || 'dev' }}-debug cp bin/ecapture-*.tar.gz dist/ - name: Build Debug arm64 if: matrix.arch == 'arm64' run: | make clean make env DEBUG=1 CROSS_ARCH=arm64 make -f builder/Makefile.release release SNAPSHOT_VERSION=v0.0.0-pr-${{ github.event.number || 'dev' }}-debug cp bin/ecapture-*.tar.gz dist/ - name: Upload Debug Artifacts uses: actions/upload-artifact@v4 with: name: ecapture-v0.0.0-pr-${{ github.event.number || 'dev' }}-debug-${{ matrix.os }}-${{ matrix.arch }}.tar.gz path: dist/ecapture-v0.0.0-pr-${{ github.event.number || 'dev' }}-debug-${{ matrix.os }}-${{ matrix.arch }}.tar.gz retention-days: 7 - name: List Built Artifacts run: | echo "Built debug artifacts:" ls -la dist/ echo "Artifact sizes:" du -h dist/* ================================================ FILE: .github/workflows/pr_build_debug_comment.yml ================================================ name: PR Comment on Build on: workflow_run: workflows: ["PR Build (Debug)"] types: - completed permissions: contents: read pull-requests: write jobs: comment: runs-on: ubuntu-22.04 if: > github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' steps: - name: Comment PR with Download Links uses: actions/github-script@v7 with: script: | const runId = context.payload.workflow_run.id; // Get the PR number from the workflow run const pullRequests = context.payload.workflow_run.pull_requests; if (!pullRequests || pullRequests.length === 0) { console.log('No pull request associated with this workflow run'); return; } const prNumber = pullRequests[0].number; try { const commentBody = [ `🔧 **Debug Build Complete (PR #${prNumber})**`, '', '📦 Download Links:', `- [View Build Artifacts](https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${runId})`, '', '⏰ Files will be retained for 7 days, please download and test promptly.', '', '---', '*This build includes debug binaries for: android/linux (arm64/amd64)*' ].join('\n'); await github.rest.issues.createComment({ issue_number: prNumber, owner: context.repo.owner, repo: context.repo.repo, body: commentBody }); console.log('Comment created successfully'); } catch (error) { console.log('Failed to create comment:', error.message); throw error; } ================================================ FILE: .github/workflows/release.yml ================================================ name: Release on: push: tags: - "v*" concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build-on-ubuntu2204: runs-on: ubuntu-22.04 name: release Linux/Android Version (amd64/arm64) steps: - uses: actions/setup-go@v5 with: go-version: '1.24.6' - name: Check Release Type id: release_type run: | TAG_NAME=${{ github.ref_name }} if [[ "$TAG_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then echo "IS_PRERELEASE=false" >> $GITHUB_OUTPUT echo "RELEASE_TYPE=stable" >> $GITHUB_OUTPUT echo "📦 Stable release detected: $TAG_NAME" elif [[ "$TAG_NAME" =~ (alpha|beta|rc) ]]; then echo "IS_PRERELEASE=true" >> $GITHUB_OUTPUT echo "RELEASE_TYPE=prerelease" >> $GITHUB_OUTPUT echo "🚧 Pre-release detected: $TAG_NAME" else echo "IS_PRERELEASE=false" >> $GITHUB_OUTPUT echo "RELEASE_TYPE=stable" >> $GITHUB_OUTPUT echo "📦 Release: $TAG_NAME" fi shell: bash - name: Install Compilers run: | sudo apt-get update sudo apt-get install --yes \ build-essential \ pkgconf \ libelf-dev \ llvm-14 \ clang-14 \ linux-tools-common \ linux-tools-generic \ gcc \ gcc-aarch64-linux-gnu \ linux-source for tool in "clang" "llc" "llvm-strip" do sudo rm -f /usr/bin/$tool sudo ln -s /usr/bin/$tool-14 /usr/bin/$tool done cd /usr/src source_file=$(find . -maxdepth 1 -name "*linux-source*.tar.bz2") source_dir=$(echo "$source_file" | sed 's/\.tar\.bz2//g') sudo tar -xf $source_file cd $source_dir test -f .config || sudo make oldconfig sudo make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- prepare V=0 ls -al /usr/src/$source_dir shell: bash - uses: actions/checkout@v4 with: submodules: 'recursive' fetch-depth: 0 - uses: actions/cache@v4 with: path: | ~/.cache/go-build ~/go/pkg/mod key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} restore-keys: | ${{ runner.os }}-go- - name: authenticate run: | gh auth login --with-token <<<'${{ secrets.GITHUB_TOKEN }}' - name: Get Previous Tag id: previoustag run: | PREVIOUS=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "") echo "PREVIOUS_TAG=$PREVIOUS" >> $GITHUB_OUTPUT - name: Generate Release Notes id: release_notes run: | gh api \ --method POST \ -H "Accept: application/vnd.github+json" \ /repos/${{ github.repository }}/releases/generate-notes \ -f tag_name=${{ github.ref_name }} \ -f previous_tag_name=${{ steps.previoustag.outputs.PREVIOUS_TAG }} \ > release_notes.json echo "NOTES<> $GITHUB_OUTPUT jq -r .body release_notes.json >> $GITHUB_OUTPUT echo "EOF" >> $GITHUB_OUTPUT - name: Write File uses: DamianReeves/write-file-action@v1.2 with: path: ./bin/release_notes.txt contents: | ${{ steps.release_notes.outputs.NOTES }} write-mode: append - name: Release amd64 run: | make clean make env make -f builder/Makefile.release release SNAPSHOT_VERSION=${{ github.ref_name }} - name: Release arm64 (CROSS COMPILATION) run: | make clean make env CROSS_ARCH=arm64 make -f builder/Makefile.release release SNAPSHOT_VERSION=${{ github.ref_name }} - name: Publish env: IS_PRERELEASE: ${{ steps.release_type.outputs.IS_PRERELEASE }} run: | make -f builder/Makefile.release publish SNAPSHOT_VERSION=${{ github.ref_name }} build-docker-image: runs-on: ubuntu-22.04 steps: - name: Checkout uses: actions/checkout@v4 - name: Check Release Type id: release_type run: | TAG_NAME=${{ github.ref_name }} if [[ "$TAG_NAME" =~ (alpha|beta|rc) ]]; then echo "IS_PRERELEASE=true" >> $GITHUB_OUTPUT echo "🚧 Pre-release detected for Docker: $TAG_NAME" else echo "IS_PRERELEASE=false" >> $GITHUB_OUTPUT echo "📦 Stable release detected for Docker: $TAG_NAME" fi shell: bash - name: Set up QEMU uses: docker/setup-qemu-action@v3 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - name: Login to Docker Hub uses: docker/login-action@v3 with: username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Update submodule run: git submodule update --init - name: Prepare Docker Tags id: docker_tags run: | TAGS="${{ secrets.DOCKERHUB_USERNAME }}/ecapture:${{ github.ref_name }}" if [[ "${{ steps.release_type.outputs.IS_PRERELEASE }}" == "false" ]]; then TAGS="${TAGS} ${{ secrets.DOCKERHUB_USERNAME }}/ecapture:latest" echo "📦 Adding 'latest' tag for stable release" else echo "🚧 Skipping 'latest' tag for pre-release" fi echo "TAGS<> $GITHUB_OUTPUT echo "$TAGS" >> $GITHUB_OUTPUT echo "EOF" >> $GITHUB_OUTPUT - name: Build and push uses: docker/build-push-action@v5 with: context: . build-args: VERSION=${{ github.ref_name }} file: ./builder/Dockerfile platforms: linux/amd64,linux/arm64 push: true cache-from: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/ecapture:buildcache cache-to: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/ecapture:buildcache,mode=max tags: ${{ steps.docker_tags.outputs.TAGS }} ================================================ FILE: .gitignore ================================================ # Binaries for programs and plugins *.exe *.exe~ *.dll *.so *.dylib *.d *.o # Test binary, built with `go test -c` *.test # Output of the go coverage tool, specifically when used with LiteIDE *.out # Log files *.log # Dependency directories (remove the comment below to include it) # vendor/ /assets/ebpf_probe.go /assets/ebpf_probe_core.go /assets/ebpf_probe_noncore.go # VSCode .vscode/settings.json #idea .idea/* bin/* /.check* /deps/* /assets/probe.go docs/blog/* # Example binaries /examples/ecaptureq_client/ecaptureq_client pkg/proc/go_elf/go_elf ================================================ FILE: .gitmodules ================================================ [submodule "lib/libpcap"] path = lib/libpcap url = https://github.com/the-tcpdump-group/libpcap.git ================================================ FILE: .golangci.yml ================================================ # This configuration file is not a recommendation. # # We intentionally use a limited set of linters. # This configuration file is used with different version of golangci-lint to avoid regressions: # the linters can change between version, # their configuration may be not compatible or their reports can be different, # and this can break some of our tests. # Also, some linters are not relevant for the project (e.g. linters related to SQL). # # We have specific constraints, so we use a specific configuration. # # See the file `.golangci.reference.yml` to have a list of all available configuration options. version: "2" linters: default: none # This list of linters is not a recommendation (same thing for all this configuration file). # We intentionally use a limited set of linters. # See the comment on top of this file. enable: - errcheck - staticcheck - errorlint settings: errorlint: asserts: false staticcheck: checks: # Invalid regular expression. # https://staticcheck.dev/docs/checks/#SA1000 - all - "-ST1000" - "-ST1005" - "-ST1003" - "-ST1021" - "-ST1023" - "-QF1012" - "-QF1008" - "-S1005" - "-S1021" - "-S1025" - "-ST1020" - "-ST1016" - "-ST1022" - "-QF1011" - "-S1034" - "-S1023" - "-SA4031" - "-S1000" - "-SA4006" exclusions: paths: - test/ - tests/ - bin/ - utils/ formatters: enable: - gofmt - goimports settings: gofmt: rewrite-rules: - pattern: 'interface{}' replacement: 'any' goimports: local-prefixes: - github.com/gojue/ecapture exclusions: paths: - test/ - tests/ - bin/ - utils/ ================================================ FILE: CHANGELOG.md ================================================ # v2.0.0 (2026-03-14) ## What's Changed ### ⚠️ Breaking Changes * **Architecture refactoring**: Completely migrated from the legacy `user/` directory to the new `internal/probe` standardized architecture. The old `user/` directory has been deleted. (#911, #912, #913, #914) * **Build tag rename**: Build tag `androidgki` has been renamed to `ecap_android`. (#930) * **eBPF bytecode directory**: eBPF bytecode assets have been relocated to `ebpfassets/` directory structure. ### 🏗️ Architecture Refactoring (v2 Foundation) * Implement clean architecture foundation — Phase 3 complete + Phase 4 Plan B: All simple probes migrated (Bash, Zsh, MySQL, Postgres) by @Copilot in https://github.com/gojue/ecapture/pull/911 * feat: Phase 4 TLS probe refactoring — Complete all libraries (OpenSSL, GnuTLS, NSPR, GoTLS) with multi-mode support and factory registration by @Copilot in https://github.com/gojue/ecapture/pull/912 * Complete eCapture v2 Architecture Refactoring (Phases 5-7): E2E Tests, Deprecation, Migration Guide, Complete eBPF Code Migration, and CLI Integration Plan by @Copilot in https://github.com/gojue/ecapture/pull/913 * Complete migration to `internal/probe` architecture: CLI commands, eCaptureQ HTTP server, eBPF bytecode directory, and `user/` directory deletion (8/8 probes) by @Copilot in https://github.com/gojue/ecapture/pull/914 * Refactor `pkg/event_processor` to remove user/event dependency and fix CLI compilation by @Copilot in https://github.com/gojue/ecapture/pull/915 * Refactor gotls probe to follow standardized architecture pattern by @Copilot in https://github.com/gojue/ecapture/pull/916 * Refactor OpenSSL probe to follow standardized architecture pattern by @Copilot in https://github.com/gojue/ecapture/pull/917 * refactor(nspr): Complete probe refactoring to standardized architecture by @Copilot in https://github.com/gojue/ecapture/pull/918 * refactor: Refactor the event dispatcher setup and probe initialization process by @cfc4n in https://github.com/gojue/ecapture/pull/924 * refactor: migrate build tag from `androidgki` to `ecap_android` by @cfc4n in https://github.com/gojue/ecapture/pull/930 ### ✨ New Features * feat: add ELF path configuration and refactor eBPF filename handling in GoTLS probe by @cfc4n * feat: implement logger writer and enhance output handling in various components by @cfc4n in https://github.com/gojue/ecapture/pull/925 * feat: implement buffered pcapng packet writing with interface metadata and improved closure handling by @cfc4n in https://github.com/gojue/ecapture/pull/928 * feat: Optimize GoTLS event handling, enhance OpenSSL configuration (including Android support), and add configuration validation by @cfc4n in https://github.com/gojue/ecapture/pull/936 * feat: add connection event handling and enhance TLS event structure with additional fields by @cfc4n in https://github.com/gojue/ecapture/pull/938 ### 🐛 Bug Fixes & Improvements * refactor: rename documentation files and update capture mode handling in configuration by @cfc4n in https://github.com/gojue/ecapture/pull/923 * refactor: rename Chinese documentation files and update links in README by @cfc4n in https://github.com/gojue/ecapture/pull/927 * Fix E2E test failures: Android arch detection, missing curl fallback, keylog test tolerance by @Copilot in https://github.com/gojue/ecapture/pull/944 * Revert non-tag changes, keep ebpfassets/dynamic, minimally fix unit tests by @cfc4n in https://github.com/gojue/ecapture/pull/945 ### 🧪 Testing * Add comprehensive E2E test suite with 72+ scenarios covering all modules by @Copilot in https://github.com/gojue/ecapture/pull/919 ### 🔧 CI/CD & Tooling * feat: enhance release workflow with pre-release detection and Docker tagging by @cfc4n * docs: add comprehensive documentation for eCapture project and update compilation references by @cfc4n ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.5.2...v2.0.0
# v1.5.2 (2025-12-27) ## What's Changed * add entry for android 16 by @jeromekleinen in https://github.com/gojue/ecapture/pull/899 * comment out early returns in SSL_write by @jeromekleinen in https://github.com/gojue/ecapture/pull/903 * Optimized the FD fetch logic of openssl by @cfc4n in https://github.com/gojue/ecapture/pull/905 * feat(gotls): support Go binaries built with -ldflags="-s -w" by @wocaolideTwistzz in https://github.com/gojue/ecapture/pull/907 * refactor: remove kernel version detect for less than 5.2 by @cfc4n in https://github.com/gojue/ecapture/pull/906 ## New Contributors * @jeromekleinen made their first contribution in https://github.com/gojue/ecapture/pull/899 * @wocaolideTwistzz made their first contribution in https://github.com/gojue/ecapture/pull/907 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.5.1...v1.5.2
# v1.5.1 (2025-12-07) ## What's Changed * fix (iworker): handle empty payload and ignore EOF error in parser write. by @cfc4n in https://github.com/gojue/ecapture/pull/897 ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.5.0...v1.5.1
# v1.5.0 (2025-12-07) ## What's Changed * feat: support OpenSSL 3.5.4 by @namoen0301 in https://github.com/gojue/ecapture/pull/857 * build(deps): bump golang.org/x/crypto from 0.38.0 to 0.45.0 by @dependabot[bot] in https://github.com/gojue/ecapture/pull/864 * Add protobuf-based WebSocket client example and fix ecaptureq documentation by @Copilot in https://github.com/gojue/ecapture/pull/868 * docs: update READMEs with protobuf protocol links and refactor visualizer docs by @zenyanle in https://github.com/gojue/ecapture/pull/869 * feat: add eCapture Issue Responder template for Copilot Agent. by @cfc4n in https://github.com/gojue/ecapture/pull/873 * feat: add eCapture PR Agent Profile. by @cfc4n in https://github.com/gojue/ecapture/pull/878 * fix: prevent nil pointer panic in gnutls probe when setup fails by @Copilot in https://github.com/gojue/ecapture/pull/879 * bugfix(gotls_kern): use actual data_len while reading payload by @h0x0er in https://github.com/gojue/ecapture/pull/882 * fix(ecaptureq): adjust heartbeat frequency and trigger immediate ping by @zenyanle in https://github.com/gojue/ecapture/pull/884 * feat: add support for BoringSSL on Android 16 with updated offsets by @cfc4n in https://github.com/gojue/ecapture/pull/885 * Fix HTTP/2 parser logging spurious "unexpected EOF" errors during TLS capture by @Copilot in https://github.com/gojue/ecapture/pull/886 * feat: add e2e testing framework and multiple HTTPS client examples by @cfc4n in https://github.com/gojue/ecapture/pull/887 * Add comprehensive e2e tests for TLS, GnuTLS, and GoTLS modules with CI integration by @Copilot in https://github.com/gojue/ecapture/pull/888 * feat: add remote configuration update API documentation and event forwarding details by @cfc4n in https://github.com/gojue/ecapture/pull/889 * Enhance e2e tests with content verification and multi-mode coverage by @Copilot in https://github.com/gojue/ecapture/pull/890 * fix(gotls): correct event output logic and support protobuf by @zenyanle in https://github.com/gojue/ecapture/pull/891 * fix: simplify PR comment condition to trigger on all pull requests by @cfc4n in https://github.com/gojue/ecapture/pull/894 ## New Contributors * @namoen0301 made their first contribution in https://github.com/gojue/ecapture/pull/857 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.4.3...v1.5.0
# v1.4.3 (2025-10-12) ## What's Changed * fix: resolve kernel 4.19 compatibility issue with .rodata maps in eBPF bytecode by @Copilot in https://github.com/gojue/ecapture/pull/846 * bugfix: keep nanoseconds precision for timestamps by @h0x0er in https://github.com/gojue/ecapture/pull/850 * Refactor: Migrate Agent-Server Communication Protocol to Protobuf by @zenyanle in https://github.com/gojue/ecapture/pull/851 * bugfix: update permissions and improve error handling in PR comment workflow by @cfc4n in https://github.com/gojue/ecapture/pull/853 * feat: update eCapture logo and enhance eCaptureQ GUI application section in README files by @cfc4n in https://github.com/gojue/ecapture/pull/854 ## New Contributors * @Copilot made their first contribution in https://github.com/gojue/ecapture/pull/846 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.4.2...v1.4.3
# v1.4.2 (2025-09-27) ## What's Changed * feat: add eCaptureQ GUI application documentation in English, Chinese… by @cfc4n in https://github.com/gojue/ecapture/pull/836 * kern/gotls_kern: refactored event creation logic by @h0x0er in https://github.com/gojue/ecapture/pull/839 * feat: enhance PR build debug workflow with permissions and detailed completion message by @cfc4n in https://github.com/gojue/ecapture/pull/843 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.4.1...v1.4.2
# v1.4.1 (2025-08-23) ## What's Changed * fix: refactor event logging to use new CollectorWriter and improve error handling by @cfc4n in https://github.com/gojue/ecapture/pull/821 * typo: comment in cmd packages by @webfrogs in https://github.com/gojue/ecapture/pull/827 * bugfix: support keylog mode for OpenSSL 3.0.12 by @foxayy in https://github.com/gojue/ecapture/pull/826 * feat: update Go version to 1.24.6 across multiple configuration files by @cfc4n in https://github.com/gojue/ecapture/pull/828 ## New Contributors * @webfrogs made their first contribution in https://github.com/gojue/ecapture/pull/827 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.4.0...v1.4.1
# v1.4.0 (2025-08-11) ## What's Changed * feat: implement WebSocket client and server for log transmission by @cfc4n in https://github.com/gojue/ecapture/pull/806 * Fix: Correctly resolve relative paths in /etc/ld.so.conf by @foxayy in https://github.com/gojue/ecapture/pull/808 * fix: missing trailing bytes for some keys in gotls keylog by @yhlooo in https://github.com/gojue/ecapture/pull/812 * feat: add WebSocket server and PacketData structure for log handling by @cfc4n in https://github.com/gojue/ecapture/pull/810 * feat: refactor event types to use unified Type structure across events by @cfc4n in https://github.com/gojue/ecapture/pull/814 * feat: add GitHub Actions workflow for PR debug builds and artifact uploads by @cfc4n in https://github.com/gojue/ecapture/pull/815 * fix: update GitHub Actions workflow for PR debug builds and artifact uploads by @cfc4n in https://github.com/gojue/ecapture/pull/817 * fix: correct return statements and improve error handling in BoringSSL by @cfc4n in https://github.com/gojue/ecapture/pull/816 * feat: implement OpenSSL version downgrade logic and improve logging by @cfc4n in https://github.com/gojue/ecapture/pull/819 * feat: update OpenSSL version offsets for 3.0, 3.2, 3.3, 3.4, and 3.5 by @cfc4n in https://github.com/gojue/ecapture/pull/820 ## New Contributors * @foxayy made their first contribution in https://github.com/gojue/ecapture/pull/808 * @yhlooo made their first contribution in https://github.com/gojue/ecapture/pull/812 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.3.1...v1.4.0
# v1.3.1 (2025-06-29) ## What's Changed * fix: share same hpack decoder for one tuple connect #744 by @chilli13 in https://github.com/gojue/ecapture/pull/798 * fix: Improve bash path detection and correct probe attachment by @zenyanle in https://github.com/gojue/ecapture/pull/805 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.3.0...v1.3.1
# v1.3.0 (2025-06-22) ## What's Changed * feat: enhance BPF core read macros and add new utility functions by @cfc4n in https://github.com/gojue/ecapture/pull/797 * feat: support gnutls early secret by @yuweizzz in https://github.com/gojue/ecapture/pull/801 * fix: keylog lost in openssl by @yuweizzz in https://github.com/gojue/ecapture/pull/802 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.2.0...v1.3.0
# v1.2.0 (2025-06-14) ## What's Changed * feat: add JetBrains logo and acknowledgements to README files by @cfc4n in https://github.com/gojue/ecapture/pull/793 * feat: Implement dual lifecycle management for eventWorker by @zenyanle in https://github.com/gojue/ecapture/pull/785 * rorate: add eventroratesize, eventroratetime to support file rorate #720 by @chilli13 in https://github.com/gojue/ecapture/pull/794 * feat: define early_secret in SSL structures for enhanced security by @cfc4n in https://github.com/gojue/ecapture/pull/792 ## New Contributors * @zenyanle made their first contribution in https://github.com/gojue/ecapture/pull/785 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.1.0...v1.2.0
# v1.1.0 (2025-05-30) ## What's Changed * feat: allow capture icmp protocol by @yuweizzz in https://github.com/gojue/ecapture/pull/779 * opt: redesign the truncate effect logic to reduce memory cost in text mode #718 by @chilli13 in https://github.com/gojue/ecapture/pull/775 * fix: clean up SSLDataEvent string methods and improve logging #776 by @cfc4n in https://github.com/gojue/ecapture/pull/777 * fix: improve logging for truncated events and update string formatting by @cfc4n in https://github.com/gojue/ecapture/pull/780 * feat: support openssl version 3.5.0 #783 by @chilli13 in https://github.com/gojue/ecapture/pull/787 * fix: avoid writing empty decryption secrets block in savePcapng method by @cfc4n in https://github.com/gojue/ecapture/pull/786 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.0.2...v1.1.0
# v1.0.2 (2025-05-03) ## What's Changed * feat: add support for OpenSSL 3.3.3 and 3.4.1, update version mappings by @cfc4n in https://github.com/gojue/ecapture/pull/769 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.0.1...v1.0.2
# v1.0.1 (2025-04-08) ## What's Changed * fix: update clang version to 10 in installation scripts by @cfc4n in https://github.com/gojue/ecapture/pull/758 * refactor: support loopback interface, remove loopback device checks from pcap probe files by @cfc4n in https://github.com/gojue/ecapture/pull/762 **Full Changelog**: https://github.com/gojue/ecapture/compare/v1.0.0...v1.0.1
# v1.0.0 Stable Versions (2025-03-25) ## 🚀 eCapture Features Overview eCapture is a powerful network traffic capture and decryption tool focusing on TLS/SSL protocol transparency and analysis. It supports multiple protocols and architectures, providing efficient and flexible capture and decryption capabilities. --- ### Core Features 1. **Multi-Protocol Support** - Supports TLS, gnutls, nss, openssl, and other encryption protocols, compatible with different versions of SSL/TLS implementations. 2. **Smart Packet Capture** - Based on eBPF technology, enabling efficient network data capture and protocol parsing. Supports IPv4, IPv6 dual-stack and 4-tuple filtering. 3. **Master Key Capture** - Supports TLS 1.2 and 1.3 protocol master key capture. Integrates with Wireshark for decryption, allowing direct viewing of encrypted traffic in plain text. 4. **Modular Architecture** - Modular design allows for easy extension and flexible configuration of different protocol modules. 5. **Cross-Platform Support** - Supports Linux, Android, and other platforms, compatible with ARM64 and x86 architectures, adapting to different environments. --- ### Features - **Automation** Automatically detects SSL/TLS library versions, intelligently identifies CO-RE and non-CO-RE modes, optimizes memory usage. - **Flexible Configuration** Supports custom filters, log files, decryption modes (keylog, pcap, text), and multiple output formats. - **High Performance** High-efficiency data processing based on eBPF, supports large-scale concurrent captures and long-term packet capturing. - **Strong Compatibility** Supports multiple SSL/TLS library versions, including openssl 1.1.1, 3.0.x, boringssl, etc. - **Extensibility** Provides Wireshark plugin support for easy data analysis and visualization. --- ### Technical Advantages - **eBPF Engine** Utilizes advanced eBPF technology to improve capture and decryption efficiency, reducing system resource usage. - **Modular Architecture** Core functionality is modularized for easy extension and maintenance. - **Intelligence** Automatically detects the runtime environment and intelligently adapts to different protocols and architectures. --- ### Application Scenarios 1. **Network Debugging** Real-time capture and decryption of TLS/SSL traffic to assist in development and debugging. 2. **Security Analysis** Analyze encrypted communications to identify potential security vulnerabilities. 3. **Protocol Research** Study TLS/SSL protocol implementations and analyze traffic characteristics. 4. **Monitoring and Auditing** Monitor network communications, record, and audit sensitive operations. ### Links 1. [eCapture旁观者](https://ecapture.cc) 2. [eCapture Github](https://github.com/gojue/ecapture) 3. 微信公众号 ![ecapture-wechat](./images/wechat_gzhh.png) **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.5...v1.0.0
# v0.9.5 (2025-03-08) ## What's Changed * fix: incorrect stream id in http2 protocol data frame by @yuweizzz in https://github.com/gojue/ecapture/pull/737 * Fix: #740, the bug of incomplete SSL data for excessively long lengths. by @cfc4n in https://github.com/gojue/ecapture/pull/742 * improve: provide opts to set the truncate size in text mode to reduce memory cost by @yuweizzz in https://github.com/gojue/ecapture/pull/731 * improve: handle COMPRESSION_ERROR to reduce the error log displayed by @yuweizzz in https://github.com/gojue/ecapture/pull/745 * fix: #739 the tuple to be unreachable. by @cfc4n in https://github.com/gojue/ecapture/pull/741 * improve: add frame length by @yuweizzz in https://github.com/gojue/ecapture/pull/748 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.4...v0.9.5
# v0.9.4 (2025-02-16) ## What's Changed * feat(boringssl): add support Android15 BoringSSL by @cfc4n in https://github.com/gojue/ecapture/pull/723 * feat: support ipv6 4-tuple (#724) by @chilli13 in https://github.com/gojue/ecapture/pull/728 * improve: include a stream id field when parse http2 event by @yuweizzz in https://github.com/gojue/ecapture/pull/734 * tuple: bugfix for tuple ipv4 dst ip info by @chilli13 in https://github.com/gojue/ecapture/pull/735 ## New Contributors * @chilli13 made their first contribution in https://github.com/gojue/ecapture/pull/728 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.3...v0.9.4
# v0.9.3 (2025-01-18) ## What's Changed * fix(make): improve error handling and clean target logic in Makefile by @cfc4n in https://github.com/gojue/ecapture/pull/713 * fix: incorrect CAP_BPF check method by @hengyoush in https://github.com/gojue/ecapture/pull/715 * feat(ci): update GitHub Action runners with Linux arm64 host by @cfc4n in https://github.com/gojue/ecapture/pull/722 ## New Contributors * @hengyoush made their first contribution in https://github.com/gojue/ecapture/pull/715 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.2...v0.9.3
# v0.9.2 (2024-12-29) ## What's Changed * Limit GitHub action serialization and increase CI caching function by @cfc4n in https://github.com/gojue/ecapture/pull/698 * fix : add openssl_3_1_0 target by @cuijing90 in https://github.com/gojue/ecapture/pull/704 * performance: use first h2 frame header detect instead of read first frame from whole payload by @yuweizzz in https://github.com/gojue/ecapture/pull/705 * fix #697, When building in nocore mode, use only non-core bytecode les by default. by @cfc4n in https://github.com/gojue/ecapture/pull/708 * fix: check CAP_BPF by capget syscall by @Asphaltt in https://github.com/gojue/ecapture/pull/707 * fixed the issue of missing cross-compilation environment. by @cfc4n in https://github.com/gojue/ecapture/pull/709 * fix(ci): fix github action release notes generation by @cfc4n in https://github.com/gojue/ecapture/pull/710 ## New Contributors * @cuijing90 made their first contribution in https://github.com/gojue/ecapture/pull/704 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.1...v0.9.2
# v0.9.1 (2024-12-18) ## What's Changed * fix: invalid indirect read from stack by @Asphaltt in https://github.com/gojue/ecapture/pull/694 * fix: use other hooks to probe 5-tuple by @Asphaltt in https://github.com/gojue/ecapture/pull/695 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.9.0...v0.9.1
# v0.9.0 (2024-12-15) ## What's Changed * fix: pcap filter not work as expected by @yuweizzz in https://github.com/gojue/ecapture/pull/680 * feat support capture zsh command by @SenberHu in https://github.com/gojue/ecapture/pull/683 * feat: detect CAP_BPF by @Asphaltt in https://github.com/gojue/ecapture/pull/681 * feat: Enrich addr info with remote addr info by @Asphaltt in https://github.com/gojue/ecapture/pull/684 * fix ecapture docker images CVE-2024-24790 by @cfc4n in https://github.com/gojue/ecapture/pull/687 * fix #685, the Processor print "incoming chan is full",and exit. by @cfc4n in https://github.com/gojue/ecapture/pull/686 * feat: Support for new version detection feature. by @cfc4n in https://github.com/gojue/ecapture/pull/688 * build(deps): bump golang.org/x/crypto from 0.23.0 to 0.31.0 by @dependabot in https://github.com/gojue/ecapture/pull/690 * feat: Clean map when destroy socket by @Asphaltt in https://github.com/gojue/ecapture/pull/691 ## New Contributors * @SenberHu made their first contribution in https://github.com/gojue/ecapture/pull/683 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.12...v0.9.0
# v0.8.12 (2024-12-02) ## What's Changed * Fix the version number string cannot be found in the dynamic library of boringssl. by @cfc4n in https://github.com/gojue/ecapture/pull/679 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.11...v0.8.12
# v0.8.11 (2024-12-01) ## What's Changed * fix(user/module): read version from libcrypto.so by @xxxxxliil in https://github.com/gojue/ecapture/pull/661 * fix MariaDB typo in README.md by @robertsilen in https://github.com/gojue/ecapture/pull/672 * Add a reminder for failure when hooking libnss3.so. by @cfc4n in https://github.com/gojue/ecapture/pull/677 ## New Contributors * @robertsilen made their first contribution in https://github.com/gojue/ecapture/pull/672 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.10...v0.8.11
# v0.8.10 (2024-11-16) ## What's Changed * feat(user/module): add ossl version 3.4.0 support by @xxxxxliil in https://github.com/gojue/ecapture/pull/660 * docs: fix jp translation by @ame-yu in https://github.com/gojue/ecapture/pull/663 * feat: support keylog and pcap mode in gnutls by @yuweizzz in https://github.com/gojue/ecapture/pull/654 * Fix the parameter error issue of the uprobe type hook. by @cfc4n in https://github.com/gojue/ecapture/pull/665 * chore: remove unused flags `BuildRequires` in rpmBuild.spec by @cfc4n in https://github.com/gojue/ecapture/pull/666 * builder: fix init script fails to run on ubuntu 24.04 system #667 by @cfc4n in https://github.com/gojue/ecapture/pull/668 ## New Contributors * @ame-yu made their first contribution in https://github.com/gojue/ecapture/pull/663 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.9...v0.8.10
# v0.8.9 (2024-10-26) ## What's Changed * typo: 3中 --> 3种 by @CC11001100 in https://github.com/gojue/ecapture/pull/641 * fix: SSLDataEvent's fd is 0 Error by @yuweizzz in https://github.com/gojue/ecapture/pull/642 * fix: couldn't find bpf bytecode file error by @yuweizzz in https://github.com/gojue/ecapture/pull/650 ## New Contributors * @CC11001100 made their first contribution in https://github.com/gojue/ecapture/pull/641 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.8...v0.8.9 # v0.8.8 (2024-10-09) ## What's Changed * Fix the bug that the arm64 version cannot work (#649) by @cfc4n in https://github.com/gojue/ecapture/pull/648 * builder: docerk build error: header not found by @cfc4n in https://github.com/gojue/ecapture/pull/648 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.7...v0.8.8
# v0.8.7 (2024-10-07) ## What's Changed * feat: remove tcp packet limitation by @yuweizzz in https://github.com/gojue/ecapture/pull/619 * kern: support openssl 3.3.2/3.2.3/3.1.7/3.0.15 by @cfc4n in https://github.com/gojue/ecapture/pull/624 * workflows: update linux source tgz file version. by @cfc4n in https://github.com/gojue/ecapture/pull/644 * fix the issue with retrieving the return value of the Read function in the Golang TLS module. by @cfc4n in https://github.com/gojue/ecapture/pull/646 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.6...v0.8.7
# v0.8.6 (2024-09-06) ## What's Changed * GitHub action codecov by @cfc4n in https://github.com/gojue/ecapture/pull/594 * fix: fix undeclared identifier error when make in debug mode by @yuweizzz in https://github.com/gojue/ecapture/pull/593 * user: adjusted the timing of the display of the kernel version is too low by @cfc4n in https://github.com/gojue/ecapture/pull/607 * kern: support uid/pid filter in ebpf TC hook. by @cfc4n in https://github.com/gojue/ecapture/pull/606 * fix: fallback to default version with warn by @xxxxxliil in https://github.com/gojue/ecapture/pull/613 * chore: Use `-tags 'netgo'` in bulding process to avoid SIGSEGV because of the different version of glibc in dfferent Linux distros by @Zheaoli in https://github.com/gojue/ecapture/pull/616 ## New Contributors * @xxxxxliil made their first contribution in https://github.com/gojue/ecapture/pull/613 * @Zheaoli made their first contribution in https://github.com/gojue/ecapture/pull/616 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.5...v0.8.6
# v0.8.5 (2024-08-19) ## What's Changed * feat: parse http2 data in text mode by @yuweizzz in https://github.com/gojue/ecapture/pull/580 * pkg: add http2 request/response unit test. by @cfc4n in https://github.com/gojue/ecapture/pull/583 * feat: allow capture ipv6 packet by @yuweizzz in https://github.com/gojue/ecapture/pull/586 * workflows: remove Qodana CI workflow. by @cfc4n in https://github.com/gojue/ecapture/pull/589 * Constant parameter notice by @cfc4n in https://github.com/gojue/ecapture/pull/591 * user: split loggers, which are divided into loggers and event collectors by @cfc4n in https://github.com/gojue/ecapture/pull/592 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.4...v0.8.5
# v0.8.4 (2024-07-09) ## What's Changed * add possible linux kernel config path by @w568w in https://github.com/gojue/ecapture/pull/561 * workflows: add Qodana by @cfc4n in https://github.com/gojue/ecapture/pull/563 * fix create output.log failed. by @cfc4n in https://github.com/gojue/ecapture/pull/566 * pkg: fix send on closed channel by @cfc4n in https://github.com/gojue/ecapture/pull/567 * fix: DumpResponse error in HEAD request by @yuweizzz in https://github.com/gojue/ecapture/pull/572 * fix: truncated body dump error by @yuweizzz in https://github.com/gojue/ecapture/pull/573 * kern: support openssl 3.3.* by @cfc4n in https://github.com/gojue/ecapture/pull/575 * kern: Adjust the timing of key acquisition to distinguish between TLS by @cfc4n in https://github.com/gojue/ecapture/pull/576 ## New Contributors * @w568w made their first contribution in https://github.com/gojue/ecapture/pull/561 * @yuweizzz made their first contribution in https://github.com/gojue/ecapture/pull/572 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.3...v0.8.4
# v0.8.3 (2024-06-01) ## What's Changed * user: fix #553, `hashLen` is not allowed to be more than 64 bytes by @cfc4n in https://github.com/gojue/ecapture/pull/554 * cli: update docker usage by @cfc4n in https://github.com/gojue/ecapture/pull/556 * kern: Support for the non-Android boringssl library has been added. by @cfc4n in https://github.com/gojue/ecapture/pull/555 * user: format clientRandom string in gotls module by @cfc4n in https://github.com/gojue/ecapture/pull/557 * cli: support logger level by @cfc4n in https://github.com/gojue/ecapture/pull/558 * use kprobe/__sys_connect inseated uprobe/connect. by @cfc4n in https://github.com/gojue/ecapture/pull/559 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.2...v0.8.3
# v0.8.2 (2024-05-19) ## What's Changed * android version compilation has failed. by @cfc4n in https://github.com/gojue/ecapture/pull/548 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.1...v0.8.2
# v0.8.1 (2024-05-19) ## What's Changed * makefile: Optimized the generation mechanism of kernel header files by @cfc4n in https://github.com/gojue/ecapture/pull/536 * add dockerfile by @sancppp in https://github.com/gojue/ecapture/pull/537 * cli: Use a formatted logger rs/zerolog by @cfc4n in https://github.com/gojue/ecapture/pull/539 * utils: supported openssl 1.1.1w, 3.0.13, 3.1.5, 3.2.1 by @cfc4n in https://github.com/gojue/ecapture/pull/540 * BPF name should be appended after _core/_noncore by @darren in https://github.com/gojue/ecapture/pull/545 * user: fixed #542, masterkey being written to pcapng multiple times. by @cfc4n in https://github.com/gojue/ecapture/pull/546 * user: prepare for service-oriented architecture. by @cfc4n in https://github.com/gojue/ecapture/pull/541 ## New Contributors * @darren made their first contribution in https://github.com/gojue/ecapture/pull/545 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.8.0...v0.8.1
# v0.8.0 (2024-05-04) ## 🚀 Breaking Changes - for User: No need to distinguish between CO-RE and non-CO-RE versions, automatically identified by eCapture. - 无需区分CO-RE和non-CO-RE版本，由eCapture自动识别。 - for Developer: Supports cross-compilation for both amd64 and arm64 CPU architectures, building CO-RE and non-CO-RE versions respectively. - 支持在amd64\arm64两个CPU架构下的交叉编译，分别构建CO-RE和non-CO-RE版本 ## What's Changed * chore: rename ecapture module name. by @cfc4n in https://github.com/gojue/ecapture/pull/530 * Fix keylog mode not working correctly on certain OpenSSL versions by @AmazingPP in https://github.com/gojue/ecapture/pull/534 * feat: support CORE and non-CORE mode in one by @cfc4n in https://github.com/gojue/ecapture/pull/532 * workflows: change steps.get_tags.outputs.VERSION to github.ref_name by @sancppp in https://github.com/gojue/ecapture/pull/535 ## New Contributors * @AmazingPP made their first contribution in https://github.com/gojue/ecapture/pull/534 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.7...v0.8.0
# v0.7.7 (2024-04-21) ## What's Changed * [Fix] get textStart from pclnTable by @wlingze in https://github.com/gojue/ecapture/pull/516 * fix: amd64, offset read error issue for PIE executable. PR #516 by @cfc4n in https://github.com/gojue/ecapture/pull/517 * makefile: used CC=$(CROSS_COMPILE)gcc for CGO compile. by @cfc4n in https://github.com/gojue/ecapture/pull/519 * user: return error when detect openssl version failed. by @cfc4n in https://github.com/gojue/ecapture/pull/521 * user : fixed the invalid address reference of the SSL_in_before symbol OpenSSL 1.0.2k. by @cfc4n in https://github.com/gojue/ecapture/pull/520 * feat: support cross-compilation for workflows. by @cfc4n in https://github.com/gojue/ecapture/pull/523 * readme: improve English README.md translation and add TOCs by @zhoukuncheng in https://github.com/gojue/ecapture/pull/525 * build(deps): bump golang.org/x/net from 0.17.0 to 0.23.0 by @dependabot in https://github.com/gojue/ecapture/pull/528 ## New Contributors * @wlingze made their first contribution in https://github.com/gojue/ecapture/pull/516 * @zhoukuncheng made their first contribution in https://github.com/gojue/ecapture/pull/525 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.6...v0.7.7
# v0.7.6 (2024-03-30) ## What's Changed * fix #500 to avoid potential hang and event loss by @ruitianzhong in https://github.com/gojue/ecapture/pull/501 * fix issue#504 by @sancppp in https://github.com/gojue/ecapture/pull/506 * tentative fix to address bash problem #490 by @ruitianzhong in https://github.com/gojue/ecapture/pull/510 * Fix cant found RET offset in gotls mode. fix #502. by @cfc4n in https://github.com/gojue/ecapture/pull/512 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.5...v0.7.6
# v0.7.5 (2024-03-03) ## What's Changed * Improve makefile by @cfc4n in https://github.com/gojue/ecapture/pull/488 * Fix: init GoTLSProbe.tcPacketsChan #492 by @ruitianzhong in https://github.com/gojue/ecapture/pull/493 * fix: avoid printing confusing message when input contains special character by @ruitianzhong in https://github.com/gojue/ecapture/pull/495 * correctly update ContentLength for uncompressed response body by @ruitianzhong in https://github.com/gojue/ecapture/pull/498 * add -race flags for `go test` and fix data race warning by @ruitianzhong in https://github.com/gojue/ecapture/pull/499 * openssl: encode the value of fd (ssl->wbio->num) to gen uuid, rather than an unexpected random number by @wuyexkx in https://github.com/gojue/ecapture/pull/494 ## New Contributors * @ruitianzhong made their first contribution in https://github.com/gojue/ecapture/pull/493 * @wuyexkx made their first contribution in https://github.com/gojue/ecapture/pull/494 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.4...v0.7.5
# v0.7.4 (2024-02-24) ## 🚀 Breaking Changes eCapture supports [Pcap Filter Syntax] (https://www.tcpdump.org/manpages/pcap-filter.7.html), and you can use the pcap filter expression to filter network packets like tcpdump. In the tls\gotls module, when the running mode is 'pcap', the pcap filter expression is supported, which can be set in the last parameter of the command line, for example: ------ eCapture支持[Pcap Filter Syntax](https://www.tcpdump.org/manpages/pcap-filter.7.html)，你可以像tcpdump一样使用pcap filter表达式来过滤网络包。 在tls\gotls模块中，当运行模式为`pcap`时，支持pcap filter表达式，在命令行最后的参数中设定，例如： ```shell ecapture tls -m pcap -i wlan0 -w save.pcapng host 192.168.1.1 and tcp port 443 ``` ![](https://github.com/gojue/ecapture/blob/master/images/ecapture-help-v0.8.9.svg) ## What's Changed * Update probe_bash.go by @sancppp in https://github.com/gojue/ecapture/pull/479 * docs: Optimized the error message in the gotls module.(fix: #482) by @cfc4n in https://github.com/gojue/ecapture/pull/484 * feat: Support pcap-filter expression for pcap mode by @Asphaltt in https://github.com/gojue/ecapture/pull/478 * chore: Pcap filter tidy,support ubuntu arm64 to make libpcap by @cfc4n in https://github.com/gojue/ecapture/pull/487 ## New Contributors * @sancppp made their first contribution in https://github.com/gojue/ecapture/pull/479 * @Asphaltt made their first contribution in https://github.com/gojue/ecapture/pull/478 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.3...v0.7.4
# v0.7.3 (2024-01-28) ## What's Changed * makefile: Optimize the feature list for the Android version by @cfc4n in https://github.com/gojue/ecapture/pull/457 * user: support event processor by @cfc4n in https://github.com/gojue/ecapture/pull/462 * chore: remove refs to deprecated io/ioutil by @testwill in https://github.com/gojue/ecapture/pull/465 * user: fix concurrent map read and map write #467 by @cfc4n in https://github.com/gojue/ecapture/pull/468 * utils: support openssl 3.1.0-3.1.4 and 3.0.9-3.0.12 by @cfc4n in https://github.com/gojue/ecapture/pull/469 * user: imporve dynamic link library path loading logic on aarch64 ubuntu by @cfc4n in https://github.com/gojue/ecapture/pull/470 * user: imporve #463, impact on the performance of the tested program by @cfc4n in https://github.com/gojue/ecapture/pull/471 * kern: support openssl 3.2.x , change ssl_st to ssl_connection_st by @cfc4n in https://github.com/gojue/ecapture/pull/472 ## New Contributors * @testwill made their first contribution in https://github.com/gojue/ecapture/pull/465 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.2...v0.7.3
# v0.7.2 (2024-01-01) ## What's Changed * user: improve pcapng writer, flush every 2s. by @cfc4n in https://github.com/gojue/ecapture/pull/455 * builder: add debian package build script. by @cfc4n in https://github.com/gojue/ecapture/pull/456 ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.1...v0.7.2
# v0.7.1 (2023-12-23) ## What's Changed * cli: reduce mapsize to 1024 * PAGESIZE. by @cfc4n in https://github.com/gojue/ecapture/pull/440 * Add optimization in openssl detection logic to consume less memory by @h0x0er in https://github.com/gojue/ecapture/pull/438 * cli: fix nss module panic by @mannkafai in https://github.com/gojue/ecapture/pull/444 * build(deps): bump golang.org/x/crypto from 0.14.0 to 0.17.0 by @dependabot in https://github.com/gojue/ecapture/pull/448 * pkg: support android on docker(redroid). by @cfc4n in https://github.com/gojue/ecapture/pull/453 ## New Contributors * @mannkafai made their first contribution in https://github.com/gojue/ecapture/pull/444 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.7.0...v0.7.1
# v0.7.0 (2023-12-03) ## 🚀 Breaking Changes - Split `nss/gnutls/openssl` into three separate submodules. Corresponding to the `./ecapture nss`, `./ecapture gnutls`, `ecapture tls` commands. - Support `keylog` mode, equivalent to the functionality of the `SSLKEYLOGFILE` environment variable. Captures SSL/TLS communication keys directly without the need for changes in the target process. - Refactor the mode parameters supported by the `openssl`(aka tls) module using the `-m`parameter, with values `text`, `pcap`,`keylog`. - `pcap` mode: Set with `-m pcap` or `-m pcapng` parameters. When using this mode, it is necessary to specify `--pcapfile` and `-i` parameters. The default value for the `--pcapfile` parameter is `ecapture_openssl.pcapng`. - `keylog` mode: Set with `-m keylog` or `-m key` parameters. When using this mode, it is necessary to specify `--keylogfile`, defaulting to `ecapture_masterkey.log`. - `text` mode: Default mode when `-m` parameter is unspecified. Outputs all plaintext packets in text form. (As of v0.7.0, no longer captures communication keys, please use `keylog` mode instead.) - Refactor the mode parameters supported by the `gotls` module, similar to the `openssl` module, without further details. - Optimize the memory size of eBPF Map, specify with the `--mapsize` parameter, defaulting to 5120 KB. - Remove the `-w` parameter, use `--pcapfile` parameter instead. - Change `log-addr` parameter to `logaddr`, with unchanged functionality. Thanks to the genius idea from @blaisewang. ------ * 将nss/gnutls/openssl拆分为独立的三个子模块。分别对应`./ecapture nss`、`./ecapture gnutls`、`ecapture tls`三个子命令。 * 支持`keylog`模式，等同于`SSLKEYLOGFILE`环境变量的功能，无需目标进程改动，直接捕获SSL/TLS通信密钥。 * 重构`openssl`(aka tls)模块支持的模式参数，使用`-m`参数指定，分别为`text`,`pcap`,`keylog`三个值。 * `pcap`模式：`-m pcap`或`-m pcapng`参数来设定。当使用本模式时，必需指定`--pcapfile`、`-i`这两个参数才能使用。 其中`--pcapfile`参数的默认值为`ecapture_openssl.pcapng`。 * `keylog`模式：`-m keylog`或`-m key`参数来设定。当使用本模式时，必需指定`--keylogfile`，默认为`ecapture_masterkey.log`。 * `text`模式：`-m`参数不指定时，默认为本模式。将以文本形式输出所有的明文数据包。（自v0.7.0起，不再捕获通讯密钥，请使用`keylog`模式代替） * 重构`gotls`模块支持的模式参数，与`openssl`模块一样，不再赘述。 * 优化eBPF Map的内存大小，使用`--mapsize`参数指定，默认为5120 KB。 * 移除`-w`参数，请使用`--pcapfile`参数代替。 * 更改`log-addr`参数为`logaddr`，功能含义不变。 感谢 @blaisewang 的天才思路。 ### Demo of keylog Mode Usage Using eCapture to capture communication keys in real-time and combining it with tshark for real-time decryption enables the real-time plaintext output of encrypted traffic. The steps are as follows: 使用`eCapture`实时捕获通信密钥，并结合`tshark`实时解密，可以做到实时的加密流量明文输出。步骤如下： #### Terminal 1 Start the keylog mode of eCapture first. 先启动eCapture的`keylog`模式 ```shell ecapture tls -m keylog --keylogfile=ecapture_masterkey.log ``` ### Terminal 2 Start the tshark tool by specifying tls.keylog_file as the captured key file by eCapture, named ecapture_masterkey. 再启动`tshark`工具，指定`tls.keylog_file`为eCapture捕获的密钥文件`ecapture_masterkey` **http 1.x** ```shell tshark -o tls.keylog_file:ecapture_masterkey.log -Y http -T fields -e http.file_data -f "port 443" -i eth0 ``` **http 2.0** ```shell tshark -o tls.keylog_file:ecapture_masterkey.log -Y http2 -T fields -e http2.data.data -f "port 443" -i eth0 ``` Afterward, any software that uses the eCapture HOOK with OpenSSL libraries can achieve real-time decryption and display of all encrypted communication traffic without requiring any modifications to these software applications. 之后，其他使用`eCapture` HOOK的openssl类库的软件，所有加密通讯的流量，都可以实现实时解密并展示了，无需这些软件做任何改动。 See [issue #432](https://github.com/gojue/ecapture/issues/432) for more detail. ## What's Changed * ignore connect symbol cant found. by @cfc4n in https://github.com/gojue/ecapture/pull/431 * Add support for stripped go binaries by @h0x0er in https://github.com/gojue/ecapture/pull/426 * splitting gnutls/nss module from tls module lists. by @cfc4n in https://github.com/gojue/ecapture/pull/434 * user: custom mapSize flag. improve memory usage #433 . by @cfc4n in https://github.com/gojue/ecapture/pull/435 * add the `model` flag to distinguish the captured modes, support keylog captured. by @cfc4n in https://github.com/gojue/ecapture/pull/436 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.6...v0.7.0
# v0.6.6 (2023-11-19) ## What's Changed * add ubunutu23.04 aarch64 clang-15 into init_env.sh by @BiteFoo in https://github.com/gojue/ecapture/pull/413 * Decode kernel time to user time by @h0x0er in https://github.com/gojue/ecapture/pull/418 * Fix : openssl event output invalid with hex mode by @cfc4n in https://github.com/gojue/ecapture/pull/421 * user : Set the connect hook as an optional parameter. by @cfc4n in https://github.com/gojue/ecapture/pull/423 ## New Contributors * @BiteFoo made their first contribution in https://github.com/gojue/ecapture/pull/413 * @h0x0er made their first contribution in https://github.com/gojue/ecapture/pull/418 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.5...v0.6.6
# v0.6.5 (2023-11-11) ## What's Changed * supports all ports when target_port is set to 0. by @cfc4n in https://github.com/gojue/ecapture/pull/409 * support for the boringssl library on Android 12\13\14. by @cfc4n in https://github.com/gojue/ecapture/pull/410 * update golang version to 1.21 from 1.18 by @cfc4n in https://github.com/gojue/ecapture/pull/412 * 支持所有端口的网络数据捕获(target_port为0时) by @cfc4n in https://github.com/gojue/ecapture/pull/409 * 在Android 12\13\14上，支持borlingssl类库的明文捕获 by @cfc4n in https://github.com/gojue/ecapture/pull/410 * 更新Golang类库到1.21，cilium/ebpf类库到0.12.3 by @cfc4n in https://github.com/gojue/ecapture/pull/412 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.4...v0.6.5
# v0.6.4 (2023-10-15) ## What's Changed * bugfix: Hook the ssl_set_fd function to get FD. by @cfc4n in https://github.com/gojue/ecapture/pull/399 * build(deps): bump golang.org/x/net from 0.7.0 to 0.17.0 by @dependabot in https://github.com/gojue/ecapture/pull/402 * refactor : Shared Object (so) path load logic by @cfc4n in https://github.com/gojue/ecapture/pull/401 * improve: add missing eBPF maps parameters. by @cfc4n in https://github.com/gojue/ecapture/pull/405 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.3...v0.6.4
# v0.6.3 (2023-09-27) ## What's Changed * fix : out of silice range. by @cfc4n in https://github.com/gojue/ecapture/pull/398 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.2...v0.6.3
# v0.6.2 (2023-09-24) ## What's Changed * openssl module: add some prompts when the kernel is less than 5.2 by @cfc4n in https://github.com/gojue/ecapture/pull/387 * refactor: removal of deprecated flag support. by @cfc4n in https://github.com/gojue/ecapture/pull/388 * Revert ip address by @cfc4n in https://github.com/gojue/ecapture/pull/391 * fix : OpenSSL's file descriptor is always 0 by @cfc4n in https://github.com/gojue/ecapture/pull/393 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.1...v0.6.2
# v0.6.1 (2023-07-16) ## What's Changed * fix #378 , error: use of undeclared identifier 'KBUILD_MODNAME' by @cfc4n in https://github.com/gojue/ecapture/pull/379 * feat:add openssl 1.1.1u and 3.0.9 by @cfc4n in https://github.com/gojue/ecapture/pull/380 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.6.0...v0.6.1
# v0.6.0 (2023-07-02) ## 🚀 Breaking Changes Associating process information with network packets. usage: `cp utils/ecapture.lua ~/.wireshark/plugins` . ![](images/ecapture-pid.png) ![](images/ecapture-wireshark-lua-plugin.png) ## What's Changed * code refactoring by @cfc4n in https://github.com/gojue/ecapture/pull/371 * Tls response unexpected eof by @cfc4n in https://github.com/gojue/ecapture/pull/372 * modify func isCOntainerCgroup to isContainerCgroup, and where referenced by @chusyclub in https://github.com/gojue/ecapture/pull/374 * feat: Associate corresponding process information with each network packet. by @cfc4n in https://github.com/gojue/ecapture/pull/376 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.5.3...v0.6.0
# v0.5.3 (2023-05-21) ## What's Changed * user: fixes slice out of range by @cfc4n in https://github.com/gojue/ecapture/pull/366 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.5.2...v0.5.3
# v0.5.2 (2023-05-01) ## What's Changed * add CircleLinux rpm and mannul build support by @bella485 in https://github.com/gojue/ecapture/pull/345 * gomod: update github.com/mdlayher/netlink to v1.7.1 by @cfc4n in https://github.com/gojue/ecapture/pull/348 * use makefile to build rpm by @xjas in https://github.com/gojue/ecapture/pull/344 * fix : DumpResponse error: unexpected EOF by @cfc4n in https://github.com/gojue/ecapture/pull/349 * bugfix: Error unknown flag gobin (fixes #354 ) by @cfc4n in https://github.com/gojue/ecapture/pull/355 * GitHub actions deprecating by @cfc4n in https://github.com/gojue/ecapture/pull/356 * kern : support gotls request and response by @cfc4n in https://github.com/gojue/ecapture/pull/357 * user: fixes the network card ID cannot be found when writing to a pcapng file. (#347) by @cfc4n in https://github.com/gojue/ecapture/pull/358 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.5.1...v0.5.2
# v0.5.1 (2023-04-08) ## What's Changed * user: add ifname's default value of gotls module. by @cfc4n in https://github.com/gojue/ecapture/pull/332 * kern: fix wrong uid by @lazybetrayer in https://github.com/gojue/ecapture/pull/334 * support rpm build by @xjas in https://github.com/gojue/ecapture/pull/341 * pkg : add proc(go version) unit testing by @cfc4n in https://github.com/gojue/ecapture/pull/342 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.5.0...v0.5.1
# v0.5.0 (2023-03-10) ## What's Changed * fix: typo in the section name by @spacewander in https://github.com/gojue/ecapture/pull/311 * user : increase buffer size of ebpf map. (improve #291 , #314) by @cfc4n in https://github.com/gojue/ecapture/pull/315 * build(deps): bump golang.org/x/net from 0.0.0-20211112202133-69e39bad7dc2 to 0.7.0 by @dependabot in https://github.com/gojue/ecapture/pull/320 * refactor : rename Golang TLS module name to gotls from gossl . by @cfc4n in https://github.com/gojue/ecapture/pull/319 * refactor: Use camel case instead of snake case. by @cfc4n in https://github.com/gojue/ecapture/pull/321 * kern: fix typo in bpf_tracing.h by @eltociear in https://github.com/gojue/ecapture/pull/323 * Add JA readme by @eltociear in https://github.com/gojue/ecapture/pull/324 * Gotls crash : incorrect variable used. (fixes:#322) by @cfc4n in https://github.com/gojue/ecapture/pull/325 * kern: refactor golang ABI by register and stack. by @cfc4n in https://github.com/gojue/ecapture/pull/326 * feat: add Gotls master secrets module. by @cfc4n in https://github.com/gojue/ecapture/pull/329 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.12...v0.5.0
# v0.4.12 (2023-02-10) ## What's Changed * pkg: get GoVersion by `buildinfo` package from ELF (by golang compiled) (#262) by @cfc4n in https://github.com/gojue/ecapture/pull/295 * docs: fixes supported kernel version on arm64(aarch64). (#296) by @cfc4n in https://github.com/gojue/ecapture/pull/298 * user: fixes slice bounds out of range bug (#297) by @cfc4n in https://github.com/gojue/ecapture/pull/299 * kern: fixes constant value of type uint64. (#301) by @cfc4n in https://github.com/gojue/ecapture/pull/302 * package: update gojue/ebpfmanager to v0.4.1 by @cfc4n in https://github.com/gojue/ecapture/pull/305 * docs: update README.md by @onism68 in https://github.com/gojue/ecapture/pull/306 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.11...v0.4.12
# v0.4.11 (2023-01-07) ## What's Changed * builder: fix typos (#285) by @cfc4n in https://github.com/gojue/ecapture/pull/286 * Tls 13 masterkey is taken wrong (fixes #283) by @cfc4n in https://github.com/gojue/ecapture/pull/284 * fix(gossl): invalid memory address or nil pointer by @luckymrwang in https://github.com/gojue/ecapture/pull/288 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.10...v0.4.11
# v0.4.10 (2022-12-11) ## What's Changed * builder: add curl shell to install develop environment. by @cfc4n in https://github.com/gojue/ecapture/pull/272 * docs : update minimal kernel version as 4.18 (#274) by @cfc4n in https://github.com/gojue/ecapture/pull/275 * kern: capture https plaintext failed with boringssl TLS 1.3 on android #271 by @cfc4n in https://github.com/gojue/ecapture/pull/279 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.9...v0.4.10
# v0.4.9 (2022-11-19) ## What's Changed * constant value has to be of type uint64 (#261) by @cfc4n in https://github.com/gojue/ecapture/pull/264 * builder: rename android non-core archive file name by @cfc4n in https://github.com/gojue/ecapture/pull/266 * chore(openssl/boringssl): remove redundant calculation by @blaisewang in https://github.com/gojue/ecapture/pull/267 * makefile : support make parallel （#265） by @cfc4n in https://github.com/gojue/ecapture/pull/268 * disable gnutls/nss modules on Android. by @cfc4n in https://github.com/gojue/ecapture/pull/269 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.8...v0.4.9
# v0.4.8 (2022-11-05) ## Breaking Changes 1. Changed license to Apache License 2.0 from AGPL 3.0. 2. Supported versions of openssl are 1.1.0* , 1.0.2* . 3. Supported minimum version of Clang is 9.0. 4. Added GitHub release action of Android X86_64 binaries(default: non-CORE version). ## What's Changed * user : Tolower openssl version strings. by @cfc4n in https://github.com/gojue/ecapture/pull/250 * cli : remove other modules on android. by @cfc4n in https://github.com/gojue/ecapture/pull/251 * utils: add eCapture lua script for wireshark plugin. by @cfc4n in https://github.com/gojue/ecapture/pull/248 * feat: updated new openssl version by @cfc4n in https://github.com/gojue/ecapture/pull/255 * feat : support openssl 1.1.0* and 1.0.2* by @cfc4n in https://github.com/gojue/ecapture/pull/257 * fix: Build failed on clang10 (#256) by @cfc4n in https://github.com/gojue/ecapture/pull/258 * docs : Change license to Apache License 2.0 by @cfc4n in https://github.com/gojue/ecapture/pull/259 * workflows : release Android x86_64 use nocore model. by @cfc4n in https://github.com/gojue/ecapture/pull/260 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.4.7...v0.4.8
# v0.4.7 (2022-10-23) ## Breaking Changes **add `--ssl_version` flag to set the SSL libraries version** supported ssl libraries version lists: - openssl 1.1.1* , (1.1.1a - 1.1.1r) - openssl 3.0.* , (3.0.0 - 3.0.6) - boringssl 1.1.1 ```bash ecapture tls ecapture tls --hex --pid=3423 ecapture tls -l save.log --pid=3423 ecapture tls --libssl=/lib/x86_64-linux-gnu/libssl.so.1.1 ecapture tls -w save_3_0_5.pcapng --ssl_version="openssl 3.0.5" --libssl=/lib/x86_64-linux-gnu/libssl.so.3 ecapture tls -w save_android.pcapng -i wlan0 --libssl=/apex/com.android.conscrypt/lib64/libssl.so --ssl_version="boringssl 1.1.1" --port 443 ``` ## What's Changed * feat : support openssl 3.0 @cfc4n in https://github.com/gojue/ecapture/pull/244 * feat: automate openssl offset header file generation @blaisewang in https://github.com/gojue/ecapture/pull/241
# v0.4.6 (2022-10-15) ## What's Changed * user/module : compatiable Linux kernel less or more than 5.2 @cfc4n in https://github.com/gojue/ecapture/pull/238
# v0.4.5 (2022-10-10) ## What's Changed * kern: capture master secrets for tls 1.3 @cfc4n in https://github.com/gojue/ecapture/pull/232
# v0.4.4 (2022-10-03) ## What's Changed * feat: add support TLSv1.3 decryption by @blaisewang in https://github.com/gojue/ecapture/pull/209 * user/module : hex model output. by @cfc4n in https://github.com/gojue/ecapture/pull/220 * user/module : use const for SSL masterKey function hook. by @cfc4n in https://github.com/gojue/ecapture/pull/217 * kern: rodata map not supported on kernel 4.19 or older by @cfc4n in https://github.com/gojue/ecapture/pull/223 * kern: http2 response packet decode failed. by @cfc4n in https://github.com/gojue/ecapture/pull/225
# v0.4.3 (2022-09-09) ## What's Changed * fix: use cipher id to derive secret by @blaisewang in https://github.com/gojue/ecapture/pull/192 * kern: get ssl_session in the `*SSL_get_session()` order . by @cfc4n in https://github.com/gojue/ecapture/pull/193
# v0.4.2 (2022-09-04) ## What's Changed * refactor user package. by @cfc4n in https://github.com/gojue/ecapture/pull/183 * pkg/event_processor: DefaultParser init(). by @cfc4n in https://github.com/gojue/ecapture/pull/186 * Fix: correct ssl_st member offsets by @blaisewang in https://github.com/gojue/ecapture/pull/184 * Boringssl decrypt failed by @cfc4n in https://github.com/gojue/ecapture/pull/188
# v0.4.1 (2022-08-21) ## What's Changed * kern : define variable target_port always. by @cfc4n in https://github.com/gojue/ecapture/pull/157 * workflows : build nocore version for Android default. by @cfc4n in https://github.com/gojue/ecapture/pull/159 * pkg : Ifname default value. by @cfc4n in https://github.com/gojue/ecapture/pull/161 * user : skip loopback network interface by @cfc4n in https://github.com/gojue/ecapture/pull/163 * user : tls models exit gracefully. by @cfc4n in https://github.com/gojue/ecapture/pull/165 * git: ignore .check* files by @blaisewang in https://github.com/gojue/ecapture/pull/168 * pkg : fix config file parse failed, when as gzip format. by @cfc4n in https://github.com/gojue/ecapture/pull/169 * fix gzip read err by @4ft35t in https://github.com/gojue/ecapture/pull/175 * pkg/util/ebpf : add unit testing for kernel CONFIG reader by @cfc4n in https://github.com/gojue/ecapture/pull/176 * user : fix incorrect TimeStamp by @cfc4n in https://github.com/gojue/ecapture/pull/179 * cli/cmd : print version info by @cfc4n in https://github.com/gojue/ecapture/pull/177 * kern : support boringssl offset for Android 12. by @cfc4n in https://github.com/gojue/ecapture/pull/181
# v0.4.0 (2022-08-07) ## Breaking Changes **Support : capture plaintext packet as pcapng files for openssl TLS encryption.** > **Note:** > > Support `Wireshark` to open directly. Do not need to setting up `Master Secrets` files. > > Capture `raw packet` by Traffic Control eBPF filter. Added `Master Secrets` information into pcapng > with `Decryption Secrets Block` (DSB). > **Warning** > > change `loggerFile` flag as `-l` from `-w` , because `-w` is reserved for `Wireshark`, and keep same as `-w` > for `tcpdump`. use `ecapture -h` for help. > change `master secrets` filename from `ecapture_masterkey_[pid].log` to `ecapture_masterkey.log`. ## What's Changed * new feature: capture TLS 1.3 master secret by @cfc4n in https://github.com/gojue/ecapture/pull/143 * user : echo String() or StringHex() by CLI argument. by @cfc4n in https://github.com/gojue/ecapture/pull/149 * cli/cmd : clean up all probe while process exit. (#150) by @cfc4n in https://github.com/gojue/ecapture/pull/151 * save as Pcapng files #145 by @cfc4n in https://github.com/gojue/ecapture/pull/148 * user : Support writing pcapng files with Decryption Secrets Block (DSB). by @cfc4n in https://github.com/gojue/ecapture/pull/153
# v0.3.0 (2022-07-20) ## Breaking Changes **Capture TLS master_key ,save to file. Support openssl `1.1.1.X` . `TLS 1.2` .** Quick Guide: - use `ecapture` to capture TLS master_key, will save master secret to `ecapture_masterkey_[pid].log`. - use `tcpdump` to capture and save packets to `xxx.pcapng` file. - open `xxx.pcapng` file with `wireshark`. - Setting : `Wireshark` --> `Preferences` --> `Protocols` --> `TLS` --> `(Pre)-Master-Secret log filename`, select `ecapture_masterkey_[pid].log`. - Using : right click packet item, select `follow` -> `HTTP Stream` / `HTTP/2 Stream` ## What's Changed * all : refactor event_processor EventType. by @cfc4n in https://github.com/gojue/ecapture/pull/134 * fixed #138 : You have an error in your yaml syntax on line 79 by @cfc4n in https://github.com/gojue/ecapture/pull/139 * New feature: capture openssl masterkey #27 by @cfc4n in https://github.com/gojue/ecapture/pull/140 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.2.2...v0.3.0
# v0.2.2 (2022-07-09) ## What's Changed * workflows: build failed on aarch 64 ubuntu : 'linux/kconfig.h' file not found #125 by @cfc4n in https://github.com/gojue/ecapture/pull/126 * Makefile: shell running,with a unexcepted result: lost DKERNEL_LESS_5_2 on kernel 4.15 #129 by @cfc4n in https://github.com/gojue/ecapture/pull/132 * ebpf: remove detection of BPF config when running at container #127 by @cfc4n in https://github.com/gojue/ecapture/pull/128 ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.2.1...v0.2.2
# v0.2.1 (2022-07-05) ## What's Changed * pkg : fix Kernel config read failed, error:Config not found #117 by @cfc4n in https://github.com/gojue/ecapture/pull/123 * user : Clean up unnecessary information. fix #122 by @cfc4n in https://github.com/gojue/ecapture/pull/124 ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.2.0...v0.2.1
# v0.2.0 (2022-07-04) ## What's Changed * Directly search so in search path when /usr/bin/curl is not exist by @tiann in https://github.com/gojue/ecapture/pull/97 * Add GitHub Action ：Golangci lint by @cfc4n in https://github.com/gojue/ecapture/pull/99 * Add Chinese name 旁观者. by @cfc4n in https://github.com/gojue/ecapture/pull/103 * build: change tar.gz file path in checksum.txt by @cfc4n in https://github.com/gojue/ecapture/pull/104 * Support Golang HTTPS introspection by @chenhengqi in https://github.com/gojue/ecapture/pull/100 * New Feature: support Android without GKI (kernel version > 4.18) by @cfc4n in https://github.com/gojue/ecapture/pull/107 * fixed :#108 tls module cannot to capture payload on Aarch64 kernel 4.18 by @huzai9527 in https://github.com/gojue/ecapture/pull/109 * fixed #108: ip address lost on aarch64 kernel 4.18 by @cfc4n in https://github.com/gojue/ecapture/pull/111 * New feature: add payload parser. by @cfc4n in https://github.com/gojue/ecapture/pull/113 * document: message friendly by @cfc4n in https://github.com/gojue/ecapture/pull/119 ## New Contributors * @tiann made their first contribution in https://github.com/gojue/ecapture/pull/97 * @chenhengqi made their first contribution in https://github.com/gojue/ecapture/pull/100 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.1.10...v0.2.0
# v0.1.10 (2022-06-20) ## What's Changed * user : fixed bug. #76 libpthread.so not found. by @cfc4n in https://github.com/gojue/ecapture/pull/77 * Support for ARM64 architecture by @cfc4n in https://github.com/gojue/ecapture/pull/75 * fixed: outputing blank text on linux 4.18 #81 by @cfc4n in https://github.com/gojue/ecapture/pull/82 * New feature: update ebpfmanager package to 0.3.0 by @cfc4n in https://github.com/gojue/ecapture/pull/83 * New feature: #80 event filter by uid by @cfc4n in https://github.com/gojue/ecapture/pull/84 * New feature: #85 event filter by uid for module tls by @cfc4n in https://github.com/gojue/ecapture/pull/86 * New feature: #87 support Android GKI by @cfc4n in https://github.com/gojue/ecapture/pull/88 * fixed: #92 github checkout error while a PR sent. by @cfc4n in https://github.com/gojue/ecapture/pull/93 * New Feature: #79 Auto release for android gki by @cfc4n in https://github.com/gojue/ecapture/pull/94 ## New Contributors **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.1.9...v0.1.10
# v0.1.9 (2022-06-11) ## 🚀 Features - code refactoring: event dispatcher - PR: #58 - add notes for how to use ecapture in other libs - PR: #60 - * : add TLS/SSL Version info (openssl). - PR: #62 ## 🐛 Fixes - Add nosearch argument to skip auto search lib path - PR: #70 ## What's Changed * code refactoring: event dispatcher by @cfc4n in https://github.com/gojue/ecapture/pull/58 * add notes for how to use ecapture in other libs by @xjas in https://github.com/gojue/ecapture/pull/60 * add TLS/SSL Version info (openssl). by @cfc4n in https://github.com/gojue/ecapture/pull/62 * Update README.md by @nfsec in https://github.com/gojue/ecapture/pull/63 * fix some typos by @cuishuang in https://github.com/gojue/ecapture/pull/68 * Add nosearch argument to skip auto search lib path by @vincentmli in https://github.com/gojue/ecapture/pull/70 ## New Contributors * @xjas made their first contribution in https://github.com/gojue/ecapture/pull/60 * @nfsec made their first contribution in https://github.com/gojue/ecapture/pull/63 * @cuishuang made their first contribution in https://github.com/gojue/ecapture/pull/68 * @vincentmli made their first contribution in https://github.com/gojue/ecapture/pull/70 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.1.8...v0.1.9
# v0.1.8 (2022-05-08) ## What's Changed * ADD mysqld dispatch_command return value. by @cfc4n in https://github.com/gojue/ecapture/pull/44 * autogen vmlinux header file to compatible current OS by @cfc4n in https://github.com/gojue/ecapture/pull/50 * feat: support postgres query hook by @yihong0618 in https://github.com/gojue/ecapture/pull/51 * added return value of bash module. by @huzai9527 in https://github.com/gojue/ecapture/pull/52 * change bash line size to 256 bytes by @yindex in https://github.com/gojue/ecapture/pull/55 * add errnumber flag for command bash by @huzai9527 in https://github.com/gojue/ecapture/pull/56 ## New Contributors * @huzai9527 made their first contribution in https://github.com/gojue/ecapture/pull/52 * @yindex made their first contribution in https://github.com/gojue/ecapture/pull/55 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.1.7...v0.1.8
# v0.1.7 (2022-04-22) ### What's Changed * user: fix #29 ubuntu21.10 error :connect symbol cant found by @cfc4n in https://github.com/gojue/ecapture/pull/30 * support no co-re version on linux kernel >= 5.2 by @cfc4n in https://github.com/gojue/ecapture/pull/32 * merge two Makefile files. by @cfc4n in https://github.com/gojue/ecapture/pull/33 * images : fix #34 Inaccurate/Confusing Diagrams by @cfc4n in https://github.com/gojue/ecapture/pull/36 * Fix #37 Shared object dependence by @cfc4n in https://github.com/gojue/ecapture/pull/38 * README grammar fix by @chriskaliX in https://github.com/gojue/ecapture/pull/35 * Fix #39 .rodata: map create: read- and write-only maps not supported (requires >= v5.2) by @cfc4n in https://github.com/gojue/ecapture/pull/40 * set clang version lower to 9 from 12 by @cfc4n in https://github.com/gojue/ecapture/pull/41 ### New Contributors * @cfc4n made their first contribution in https://github.com/gojue/ecapture/pull/30 **Full Changelog**: https://github.com/gojue/ecapture/compare/v0.1.6...v0.1.7
# v0.1.6 (2022-04-07) - 更新mysqld数据库审计模块 - 更新tls网络捕获模块 ## mysqld - 支持mysql5.7/8.0, MariadDB 10.5+的Mysqld数据库的查询审计。 - 自动识别mysqld版本 。 - 自动查找hook的sql 查询函数。 ## tls - 支持openssl的IP地址关联 - 支持网络IP地址的存储、关联到网络数据中。 - 支持自定义libpthread.so路径指定（定位connect函数）。
# v0.1.5 (2022-03-25) - 增加mysqld数据库审计模块 ## mysqld 模块 - 支持mysql5.6的mariaDB数据库的查询审计 - 默认path目录为/usr/sbin/mariadb 。 - 支持function name、offset两个参数自定义。
# v0.1.4 (2022-03-22) - 调整运行环境检测方式 - 判断BTF支持的方法，改为优先判断`/sys/kernel/btf/vmlinux`文件，以及其他BTF特征的`vmlinux-*`目录等 。 - 增加运行原理图。 ## tls(openssl) 模块 - 支持gnutls 、 nspr 两个类库的数据捕获 - 重命名子命令，由`openssl`改为`tls`
# v0.1.3 (2022-03-20) - 增加运行环境检测 - 检测linux kernel必须大于4.18 。 - 检测kernel config中CONFIG_DEBUG_INFO_BTF必须有，且值为y。 - 去除编译生成的文件（./bin/、./assets/、./user/bytecode/） - 整理go mod依赖文件
# v0.1.1 (2022-03-19) - 模块拆分，启用子命令模式 - 增加全局可选PID参数，针对特定PID进行数据捕获 - 增加hexdump打印模式 ## openssl模块 - 支持自定义openssl的so路径。 - 支持hex进制的数据输出 ## bash模块 - 支持自定义bash路径参数 - 支持自定义readline.so路径参数 - 支持hex进制的数据输出
# v0.1.0 (2022-03-17) ## openssl模块 - 增加openssl的libssl.so的SSL/TLS数据抓包功能。 - 根据wget路径，自动选择libssl.so路径。 ## bash模块 - 自动根据ENV查找bash - 根据bash自动查找`readline.so`，并进行bash命令捕获 ================================================ FILE: CODE_OF_CONDUCT.md ================================================ # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cfc4n.cs@gmail.com. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. ================================================ FILE: CONTRIBUTING.md ================================================ # How to contribute eCapture is AGPL-3.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into eCapture. [//]: # (# Email and chat) ## Getting started - Fork the repository on GitHub - Read the [README.md](./README.md) for build instructions ## Reporting bugs and creating issues Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](.github/ISSUE_TEMPLATE/bug_report.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. ## Contribution flow This is a rough outline of what a contributor's workflow looks like: - Create a topic branch from where to base the contribution. This is usually main. - Make commits of logical units. - Make sure commit messages are in the proper format (see below). - Push changes in a topic branch to a personal fork of the repository. - Submit a pull request to gojue/ecapture. [//]: # (- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file.) Thanks for contributing! ### Code style The coding style suggested by the Golang community is used in eCapture. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details. Please follow this style to make eCapture easy to review, maintain and develop. ### Format of the commit message We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why. ``` cli: update module name "mysqld56" to "mysqld" . add shortflag for "debug" flag. Fixes #6 ``` The format can be described more formally as follows: ``` :