bearersh/broker

bearer/broker

镜像概述和主要用途

Bearer Broker用于在Bearer与Git仓库（如GitHub Enterprise、GitHub.com和GitLab Server）之间代理访问。Broker服务器与客户端建立应用隧道，将来自Bearer的请求代理到Git仓库。客户端运行在用户的内部网络中，确保敏感数据保持在网络边界内。

核心功能和特性

• 访问代理：在Bearer与Git仓库之间建立安全的请求代理通道
• 应用隧道：服务器与客户端之间建立专用应用隧道，保障通信安全
• 内部部署：客户端部署在用户内部网络，防止敏感数据外泄
• 多平台支持：兼容GitHub.com、GitHub Enterprise、GitLab.com及自托管GitLab
• 安全认证：通过令牌进行身份验证，确保访问权限可控

使用场景和适用范围

适用于需要保护Git仓库不直接暴露到互联网，但又需允许Bearer访问这些仓库的企业环境。特别适合使用GitHub Enterprise或自托管GitLab的组织，需在保持网络安全边界的同时，实现Bearer对内部Git仓库的访问。

使用方法和配置说明

Broker客户端以Docker镜像形式发布，可通过Docker Compose或Helm进行部署。根据Git服务类型，需配置相应的环境变量。

GitHub.com

必要环境变量

• BEARER_TOKEN：Bearer Broker令牌，从Bearer组织设置页面获取
• GITHUB_TOKEN：具有完整repo作用域的个人访问令牌

部署方法

方法1：使用docker-compose.yml

Docker镜像可在Docker Hub获取：bearersh/broker:latest

yaml
version: "3"
services:
  bearer-broker:
    image: bearersh/broker:latest
    environment:
      - BEARER_TOKEN=<your-bearer-token>
      - GITHUB_TOKEN=<your-github-token>

方法2：使用Helm

shell
$ helm install --set BEARER_TOKEN=<your-bearer-token> \
               --set GITHUB_TOKEN=<your-github-token> \
               --repo <https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/> \
               bearer-broker bearer-broker

GitHub Enterprise

必要环境变量

• BEARER_TOKEN：Bearer Broker令牌，从Bearer组织设置页面获取
• GITHUB_TOKEN：具有完整repo作用域的个人访问令牌
• GITHUB_BASE_URL：GitHub Enterprise实例的基础URL（例如：github.bearer.com）

部署方法

方法1：使用docker-compose.yml

yaml
version: "3"
services:
  bearer-broker:
    image: bearersh/broker:latest
    environment:
      - BEARER_TOKEN=<your-bearer-token>
      - GITHUB_TOKEN=<your-github-token>
      - GITHUB_BASE_URL=<your-github-instance-url>

方法2：使用Helm

shell
$ helm install --set BEARER_TOKEN=<your-bearer-token> \
               --set GITHUB_BASE_URL=<your-github-instance-url> \
               --set GITHUB_TOKEN=<your-github-token> \
               --repo <https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/> \
               bearer-broker bearer-broker

GitLab.com

必要环境变量

• BEARER_TOKEN：Bearer Broker令牌，从Bearer组织设置页面获取
• GITLAB_TOKEN：具有api和read_repository作用域的个人访问令牌

部署方法

方法1：使用docker-compose.yml

yaml
version: "3"
services:
  bearer-broker:
    image: bearersh/broker:latest
    environment:
      - BEARER_TOKEN=<your-bearer-token>
      - GITLAB_TOKEN=<your-gitlab-token>

方法2：使用Helm

shell
$ helm install --set BEARER_TOKEN=<your-bearer-token> \
               --set GITLAB_TOKEN=<your-gitlab-token> \
               --repo <https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/> \
               bearer-broker bearer-broker

自托管GitLab

必要环境变量

• BEARER_TOKEN：Bearer Broker令牌，从Bearer组织设置页面获取
• GITLAB_TOKEN：具有api和read_repository作用域的个人访问令牌
• GITLAB_BASE_URL：自托管GitLab实例的基础URL（例如：gitlab.bearer.com）

部署方法

方法1：使用docker-compose.yml

yaml
version: "3"
services:
  bearer-broker:
    image: bearersh/broker:latest
    environment:
      - BEARER_TOKEN=<your-bearer-token>
      - GITLAB_TOKEN=<your-gitlab-token>
      - GITLAB_BASE_URL=<your-gitlab-instance-url>

方法2：使用Helm

shell
$ helm install --set BEARER_TOKEN=<your-bearer-token> \
               --set GITLAB_BASE_URL=<your-gitlab-instance-url> \
               --set GITLAB_TOKEN=<your-gitlab-token> \
               --repo <https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/> \
               bearer-broker bearer-broker

变更日志

v2.0.0

修复

• 修复JIRA在不存在工单时的恐慌问题
• 实现部分检出功能
• 不再以root用户运行Broker
• 增加文件上传超时时间
• 修复树根部父节点空指针错误
• 在分支树操作中包含仓库和分支信息
• 修复空指针解引用问题
• 为检测器添加恢复机制

维护

• 升级Scanner版本
• 清理未使用的遗留代码
• 清理检测器
• 整理依赖项
• 允许路径被发现
• 处理实例变量
• 仅在相关时报告路径
• 移除gradle命令
• 重新添加依赖组
• 使用组更新测试
• 扩展环境检测
• 为PHP添加插值支持

特性

• 为Docker镜像添加标签
• 支持分支树消息的强制重新扫描标志
• 添加自定义HTML树 sitter解析器
• 为报告添加内存约束
• 为报告添加内存错误
• 添加恢复堆栈跟踪
• 支持扫描文件子集
• 添加获取分支树支持
• 添加对Golang嵌套对象的支持
• 为OpenAPI添加URLs
• 添加对HTML的扩展支持
• 为PHP添加HTML支持
• 改进SQL支持
• 添加ipynb支持
• 通过tree-sitter支持OpenAPI
• 简化检测器，去除依赖项

v1.5.3

修复

• 处理GitLab无统计信息的情况

v1.5.2

修复

• 为GitLab返回仓库大小而非项目大小
• 单独处理文件上传
• 更新扫描器
• 处理空路径上下文
• Paket依赖项问题

特性

• 增加队列大小

v1.5.1

修复

• 忽略禁用仓库的GitLab项目

v1.5.0

维护

• 更新扫描器
• 从扫描器中忽略区域文件
• 为构建模型创建可重用操作
• 添加可重用模型构建操作
• 使用子文件夹存放parser.h
• 将库路径添加到.envrc.example

其他

• 禁用git lfs
• 返回仓库总大小
• 修复Golang段错误
• 队列改进
• 仅在需要时触发扫描
• 延迟向服务器发送版本信息

特性

• 禁用git lfs
• 添加对GitHub/GitLab的问题支持
• 启动时发送UUID和版本
• 不忙时每10分钟发送一次available_to_scan操作
• 回复无关的扫描请求
• 使用不带机器学习模型的最新扫描器
• 使机器学习成为可选功能
• 支持Golang中的sprintf

修复

• 更新actioncable以避免多次订阅
• 更新扫描器以修复Golang问题
• 处理预测器错误
• 修复Golang因函数AST导致的段错误
• 发送消息前等待订阅
• 允许主机名中的百分号
• 将缺失的库位置添加到.envrc.example
• 正确排序上下文
• 使用正确的sitter头文件路径
• 更新以适配最新扫描器
• 支持列描述中的方向
• 修复测试

v1.4.1

修复

• 更新扫描器以修复检测器报告问题
• 为活动检测器添加路径

v1.4.0

特性

• 更新扫描器以修复yamlconfig错误
• 为解析器节点添加父节点
• 为envfile和yamlconfig接口检测添加目标
• 允许检测器声明文件
• 添加简单URL检测
• 为Ruby检测添加上下文
• 改进变量检测

修复

• 忽略YAML文件中的错误节点
• 为包运行检测器
• 拼写错误

其他

• 为Ruby检测添加上下文

v1.3.0

其他

• 更新扫描器
• 设置消息UUID
• 将messageuuid发送回服务器
• 指定区域
• 修复配置变量和域名
• Ruby和C#的环境变量提取
• 变量提取第一部分
• 添加简单个人数据检测器
• 检测文件夹是否为项目
• 返回相对路径
• 报告数据库上下文

特性

• 启动时发送版本信息 (#45)
• .Env/.Envrc环境变量检测
• 改进URL检测
• Java接口检测
• JavaScript接口检测
• 配置文件变量检测
• 带变量的Ruby API检测
• Ruby环境变量检测
• C#环境变量检测
• PHP环境变量检测
• JavaScript环境变量检测
• Golang环境变量检测
• Python环境变量检测
• Java环境变量检测
• Ruby个人数据检测
• 从Ruby个人数据中排除Gemfile
• 添加基准测试

维护

• 更新扫描器以支持j2文件
• 更新扫描器
• 切换回main分支用于 staging
• 整理模块

修复

• 使用staging标签
• 对Rails数据使用正确的大小写
• 配置变量解析
• 将规则解码从yaml改为json

v1.2.1

修复

• 更好地处理现有分支/PR

v1.2.0

特性

• 返回默认分支信息

v1.1.0

特性

• 启动时打印版本

v1.0.2

特性

• 添加仓库描述

v1.0.1

修复

• 使用最小访问级别而非成员资格查找GitLab项目
• 为GitLab返回正确的SCM类型
• 当速率限制头缺失时移除警告

v1.0

维护

• 将git添加到Docker镜像
• Docker镜像和CI配置

特性

• 单独排队扫描
• 发送调查ID而非仓库ID作为状态操作
• 返回仓库语言
• 不发送空提交者名称
• 为提交者添加最后提交时间
• 使用zerolog进行日志记录
• 发送提交计数
• 添加心跳
• 在单独的goroutine中处理消息
• 查找PR时检查分支名称
• 关闭拉取请求
• 支持枚举最新100个提交者
• 过期未完成的上传
• 更新到最新actioncable版本
• 使用actioncable选项函数
• 支持GitHub/GitLab企业版
• GitLab支持
• 通过环境变量指定URL
• 允许指定主机
• 带外上传扫描报告
• 支持检查审核状态
• 可能时重新打开现有PR
• 打开拉取请求
• 支持扫描仓库
• 将仓库ID与扫描数据一起返回
• 初始实现与仓库枚举

修复

• 更新actioncable库以允许空数据
• 为GitLab创建空提交
• 为提交者操作添加仓库标识符
• 将CA证书添加到Docker镜像
• 防止阻塞关闭
• 调试日志