华为云CodeNavi自定义规则开发插件(VSCode IDE版本)使用指南

举报
yd_296685231 发表于 2024/06/26 11:40:55 2024/06/26
【摘要】 本插件的功能是基于DSL语言编写自定义规则,进行代码扫描,生成自定义规则源码。

CodeNavi VSCode IDE自定义规则开发插件

本插件的功能是基于DSL语言编写自定义规则,进行代码扫描,生成自定义规则源码。
DSL编写指南

插件使用指南

1.下载安装VSCode IDE编辑器
2.插件市场找到我们插件并下载安装
3.开始使用

1.下载安装VSCode IDE编辑器

vscode官网
image.png

2.插件市场搜索CodeNavi

image.png

3.等待下载和安装

image.png

4.开始使用

image.png

插件功能介绍

1.规则编写(支持语法联想,高亮)

创建.kirin文件,编写DSL查询语句(文件名即为后续的规则名,如:ResourceInjection.kirin)
image.png

1.1 语法校验

检查DSL规则编写的语法正确性
image.png

1.2 格式化

格式化当前编写的规则,让排版更整齐易读
image.png

2.代码扫描

打开.kirin文件,在所写规则上,右击点击CodeNavi -> scan菜单,选择源码路径,点击scan

  • 源码支持单文件和文件夹
  • lib路径支持java的三方依赖路径
    image.png

3.查看告警结果

CodeNavi_panel面板中查看告警信息,点击可导航到源码中
image.png

4.生成checkerId

用户想自定义填写checkerId时,可在这里生成一个id去使用
image.png

5.生成.json规则用于华为云CodeArtsCheck平台在线扫描

  • .kirin规则扫描代码后会在同目录下OutputReport文件夹生成.json格式的规则文件,用户上传至华为云平台使用。
  • 用户可在生成后json的description字段中根据想要检测的问题类型来修改规则告警时的提示信息。
  • .json规则上传codecheck使用要求:文件名和checker字段的值需保持一致,且均为SecH_xxx格式。
    (如用户创建ResourceInjection.kirin文件,检查后生成的json文件名和checker字段值会自动转换为SecH_ResourceInjection.json)。
    image.png

6. json规则格式校验

可检查json规则的字段属性是否符合规范,文件名和checker字段值是否一致。
image.png

DSL编写指南

DSL编写指南

上传CodeArtsCheck平台使用

CodeArtsCheck平台

1.进入代码检查首页,点击规则模块,点击新建规则

image.png

2.上传规则源码

image.png

3.规则集中选用自定义规则

image.png

4.配置任务以生效

image.png
image.png

  • 进入代码检查任务设置
  • 选中刚才设置的规则集
  • 点击检查参数,点击按钮开启编译工具,选择编译工具及其版本,填写扫描项目的编译命令,最后点击确认
  • 点击开始检查
【版权声明】本文为华为云社区用户原创内容,未经允许不得转载,如需转载请自行联系原作者进行授权。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。