easy_sast

简单的萨斯特

Easy_sast是一个用于集成管道中的Docker容器，将应用程序的构建工件提交给静态分析工具。这是以一种旨在促进类似功能的其他容器的构建模式来开发的，并与Veracode的静态分析产品一起本地集成。

• 特征
• Quickstart
• 用法
• 贡献

easy_sast可以通过运行docker pull seiso/easy_sast从Docker Hub获得

有关高级用法和更多信息，请参见Wiki。

特征

该代码基础是根据崎visto的宣言而开发的。因此，是：

• 易于使用：使用直觉了解DevOps的工作流选项和配置。
• 易于配置：实用的默认值以及许多配置选项，例如配置文件，环境变量和/或CLI参数。
• 清晰可理解的代码：定期使用类型提示，关键字参数和归一化代码样式，使理解代码的意图变得容易。
• 设计为可靠的：错误处理，自动化安全验证和普遍验证。
• 经过100％测试：所有提交的单位测试的100％代码覆盖范围。
• 100％始终格式化：docker，make，yaml和python的覆盖。

Quickstart

先决条件

为了构建和运行此项目，我们建议您拥有Docker 18.09或更新，查找，Git，Gnu Make和Python 3。

设置

集成要求

为了与VeraCode集成，您需要：

• 能够生成您的应用程序的调试构建。

• 拥有一个有效的帐户和许可证，可以使用下面概述的Veracode的SAST产品API。

• 在您打算使用的Veracode分析中心中有一个应用程序。

• 将您的Veracode凭据导出为环境变量：

   export VERACODE_API_KEY_ID=EXAMPLE
   export VERACODE_API_KEY_SECRET=EXAMPLE
  

入门

1. 构建Docker图像：

   make build

2. 运行Docker容器，将其传递给您的API凭据，并将包含您的构建工件的目录安装到 /构建中：

   docker run --env-file <( env | grep ^VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

在用法和Wiki中概述了其他详细信息和配置选项。

用法

命令行

usage: main.py [-h] [--config-file CONFIG_FILE] [--version]
               [--debug | --verbose]

optional arguments:
  -h, --help                          show this help message and exit
  --config-file CONFIG_FILE           specify a config file
  --version                           show program ' s version number and exit
  --debug                             enable debug level logging
  --verbose                           enable info level logging

有两种建议的方法将信息传递到运行时easy_sast：

1. 将环境变量传递到使用--env-file docker run 。例如：

   docker run --env-file <( env | grep VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

2. 您可能还希望通过将您的论点附加到docker run中，将论点传递给容器中的Python。例如：

   docker run -e VERACODE_API_KEY_ID=EXAMPLE -e VERACODE_API_KEY_SECRET=EXAMPLE seiso/easy_sast:latest --debug

是否想了解更高级的用法，例如优化拉动请求的SAST？查看Wiki。

支持的Veracode API

• 上传API
• 结果API

请注意，至少您的VeraCode用户必须有权访问上传API及其getApplist.do端点。

如果您想看到更多的Veracode API或工作流程与这些API进行交互的支持，请打开一个问题并告诉我们！

贡献

1. 分叉存储库
2. 通过git checkout -b feature/description创建功能分支
3. 进行更改
4. 通过git commit -am 'Summarize the changes here'
5. 创建一个新的拉请请求（操作方法）