SAST 静态代码分析平台命令行接口介绍（上半部分）

SAST 静态代码分析平台命令行接口介绍SAST 静态代码分析平台的命令行工具可在不打开浏览器的情况下完成登录、License 查看、规则包查询、检测配置创建、项目创建、检测触发、状态查询、缺陷查看、报告导出和安全门禁控制。适用场景本地命令行操作批处理脚本Jenkins / GitLab CI / 其它 CI/CD 流水线自动化安全质量门禁软件工厂集成下面通过命令行调用方式介绍其接口。F:\sastsast.exe --helpUsage: sast.exe [OPTIONS] COMMAND [ARGS]...SAST 静态代码分析平台 CLI 工具login 配置并测试 SAST 登录信息。license 查看当前 License 信息。list-configs 列出所有检测配置规则集。list-packages 列出所有可用的规则包按语言分组。create-config 创建新的检测配置选择规则包。list-projects 列出所有项目。create-project 创建新项目支持文件上传、Git、SVN。check 触发项目检测。status 查看检测状态。results 查看项目缺陷列表。gate 执行安全门禁检查缺陷数量超过阈值时返回失败退出码。overview 查看项目概览信息和检测统计。export 导出检测报告。import-license 导入 license 文件到 SAST 平台无需登录。登录F:\sastsast.exe login用户名 [admin]:密码 [Aa123456789]:✓ 登录成功 userId406880036587843584配置已保存到 F:\sast\.sast-cli.json列出配置F:\sastsast.exe list-configs --helpUsage: sast.exe list-configs [OPTIONS]列出所有检测配置规则集。例如F:\sastsast.exe list-configs --json[{id: 69f0baf9f50a150369c0aed9,configName: test2,defaultConfig: false,descirbe: ,customCodeRuleIdList: [],cloneAnalysis: false,codeMeasure: true,packageIdList: [{id: 655506805702799361,custom: false},{id: 935254844024041473,custom: false},……列出规则集F:\sastsast.exe list-packages -L C部分C语言规则集如下Json格式更全面信息自定义规则集F:\sastsast.exe create-config --helpUsage: sast.exe create-config [OPTIONS]创建新的检测配置自定义规则集。F:\sastsast.exe create-config --name jg -p 590251247135895553 -p 979802312564551681 -p 896376215945097217 -p 696806415918182401 -p 1129872533265592321[DEBUG] API 返回数据: {status: 0, data: 6a00232e5fbb425ce27f490c, areSuccess: True}✓ 检测配置创建成功 configId6a00232e5fbb425ce27f490c名称: jg规则包数: 5使用方法: sast create-project --name xxx --files xxx --config-id 6a00232e5fbb425ce27f490c如果添加—json参数则返回结构如下F:\sastsast.exe create-config --name jg1 -p 590251247135895553 -p 979802312564551681 -p 896376215945097217 -p 696806415918182401 -p 1129872533265592321 --json[DEBUG] API 返回数据: {status: 0, data: 6a0026355fbb425ce27f4915, areSuccess: True}{success: true,configId: 6a0026355fbb425ce27f4915,name: jg1,packageCount: 5,codeMeasure: true,cloneAnalysis: false,describe: }企业可以建立自己所处的行业建立所需的检测规则集执行完成后自己返回的编号即可在创建项目中使用。创建项目Usage: sast.exe create-project [OPTIONS]创建新项目支持文件上传、Git、SVN。必须指定 --files、--git 或 --svn 中的一种导入方式。检测规则选择二选一:--config-id 使用已有的检测配置--package 直接指定规则包如 GJB 8114、MISRA 2012自动创建配置使用 --check 在创建后自动触发检测。F:\sastsast.exe create-project --name demo --files F:\sast\testcase\postgres-x2.zip --config-id 6a00232e5fbb425ce27f490c如果想创建项目后即刻启动检测则添加 –check参数F:\sastsast.exe create-project --name demo --files F:\sast\testcase\postgres-x2.zip --config-id 6a00232e5fbb425ce27f490c –check返回json格式F:\sastsast.exe status -p 6a002ac15fbb425ce27f491b --json{projectName: demo,projectLanguage: [C],srcCount: 1117308,checkDate: ,star: false,analysisStatus: 1,updateStatus: 0,importType: file,creatorId: 406880036587843584,creatorName: admin,organization: 0,id: 6a002ac15fbb425ce27f491b,analysisStatusText: 检测中,running: false}查看执行日志F:\sastsast.exe logs -p 6a002ac15fbb425ce27f491b无检测日志项目可能正在检测中请使用 --follow / -f 实时查看。上半部分结束