Home

Awesome

zricethezav/gitleaks explain translate-svg

<!-- [![size-img]][size] -->

「 审核git存储库的密码 」

中文 | english

校对 ✅

<!-- doc-templite START generated --> <!-- repo = 'zricethezav/gitleaks' --> <!-- commit = '03c53d297840ee6f6b7f82f1c94a2df8aa0d528c' --> <!-- time = '2018-10-27' -->
翻译的原文与日期最新更新更多
commit⏰ 2018-10-27last中文翻译
<!-- doc-templite END generated -->

贡献

欢迎 👏 勘误/校对/更新贡献 😊 具体贡献请看

生活

If help, buy me coffee —— 营养跟不上了，给我来瓶营养快线吧! 💰

<p align="center"> <img alt="gitleaks" src="https://raw.githubusercontent.com/zricethezav/gifs/master/gitleaks5.png" height="140" /> <p align="center"> <a href="https://travis-ci.org/zricethezav/gitleaks"><img alt="Travis" src="https://img.shields.io/travis/zricethezav/gitleaks/master.svg?style=flat-square"></a> </p> </p>

审核git存储库的密码

Gitleaks为您提供了一种在git源代码库中，查找未加密的密码和其他不需要的数据类型的方法.

作为其核心功能的一部分,它提供了;

它已经成功地用于许多不同的场景,包括;

示例执行

<p align="left"> <img src="https://cdn.rawgit.com/zricethezav/5bf8259b7fea0170becffc06b8588edb/raw/f762769fe20ef3669bff34612b1bede6457631e6/termtosvg_je8bp82s.svg"> </p>

安装

Go语言实现,gitleaks当然可以用二进制形式提供,适用于许多流行的平台和操作系统类型，都在发布页面.或者,通过Docker执行, 其可直接使用Go安装,如下所示;

Docker
# 运行 gitleaks 搞搞 公共存储库
docker run --rm --name=gitleaks zricethezav/gitleaks -v -r  https://github.com/zricethezav/gitleaks.git

# 运行 gitleaks 搞搞 已clone到 /tmp/ 的本地存储库
docker run --rm --name=gitleaks -v /tmp/:/code/  zricethezav/gitleaks -v --repo-path=/code/gitleaks

# 运行 gitleaks 搞搞 一个指定的 Github Pull request
docker run --rm --name=gitleaks -e GITHUB_TOKEN={your token} zricethezav/gitleaks --github-pr=https://github.com/owner/repo/pull/9000
Go
go get -u github.com/zricethezav/gitleaks

用法和选项

gitleaks具有多种配置选项,可以在运行时，或根据您的特定要求，对配置文件进行调整.

Usage:
  gitleaks [OPTIONS]

Application Options:
  -r, --repo=          审核Repo url
      --github-user=   审核的Github用户
      --github-org=    审计的Github组织
      --github-url=    GitHub API基本URL，用于GitHub Enterprise。 例：https://github.example.com/api/v3/ (default: https://api.github.com/)
      --github-pr=     审核的Github PR url。 这不会clone存储库。 必须设置GITHUB_TOKEN
  -b, --branch=        要审核的分支名称（默认为HEAD）
  -c, --commit=        commit 的 sha码
      --depth=         最大提交深度
      --repo-path=     repo路径
      --owner-path=    所有者目录的路径（已发现的repos）
      --threads=       gitleaks产生的最大线程数
      --disk           克隆repo（s）到磁盘
      --all-refs       对所有refs运行审计
      --single-search= 单个正则表达式来搜索
      --config=        gitleaks配置的路径
      --ssh-key=       ssh-key的路径
      --exclude-forks  排除审核 组织/用户 的fork
  -e, --entropy=       在审计期间包括entropy-墒检查。 entropy量表：0.0（无entropy） - 8.0（最大entropy）
  -l, --log=           日志级别
  -v, --verbose        显示gitleaks审计的详细输出
      --report=        写报告文件的路径
      --redact         从日志消息和报告中，编辑秘密
      --version        版本号
      --sample-config  打印示例配置文件

Help Options:
  -h, --help           Show this help message

退出代码

Gitleaks提供一致的现有代码,以协助自动化工作流程,如CICD平台和批量扫描.

这些可以与报告输出文件一起有效地使用,以检测有意义的数据，并将其返回给用户或外部系统,以确定是否已检测到泄漏,以及它们所在位置.

代码返回码是:

leaks == 泄露-漏洞

0: no leaks
1: leaks present
2: error encountered

附加信息