1.源代码审计工具之：SonarQube
2.Sonarqube代码质量管理工具搭建
3.SonarQube和Fortify的源译区别对比
4.自定义sonar插件-脚手架
源代码审计工具之：SonarQube
SonarQube是一个开源的代码分析平台，用于持续分析和评估项目源代码的码编质量。它能检测出项目中的源译重复代码、潜在bug、码编代码规范和安全性漏洞等问题，源译并通过web UI展示结果。码编无秘 源码
1. Sonar简介
1.1 SonarQube是源译什么？
1. 代码质量和安全扫描和分析平台。
2. 多维度分析代码：代码量、码编安全隐患、源译编写规范隐患、码编重复度、源译复杂度、码编代码增量、源译测试覆盖率等。码编
3. 支持+编程语言的源译代码扫描和分析，包括Java、Python、C#、JavaScript、Go、萌小集淘宝客源码C++等。
4. 涵盖了编程语言的静态扫描规则：代码编写规范和安全规范。
5. 能够与代码编辑器、CI/CD平台完美集成。
6. 能够与SCM集成，可以直接在平台上看到代码问题是由哪位开发人员提交。
7. 帮助程序猿写出更干净、更安全的代码。
静态扫描主要针对开发人员编写的源代码。
通过定义好的代码质量和安全规则，对开发人员编写的代码进行扫描和分析。
将分析的结果多维护的呈现出来，以方便开发人员进行代码的优化和规范编写。
1.2 SonarQube的各个功能：
1.2.1 代码可靠性
1. BUG检测
2. 设置需要的代码标准
3. 代码异味
4. 代码安全性
5. 对于开发的各个路径进行检测
1.2.2 软件安全性
1. Security Hotspots: 代码存在安全问题的部分
2. Vulnerabilities: 代码是否存在漏洞
1.3 SonarQube如何工作？
Sonar静态代码扫描由两部分组成：SonarQube平台和sonar-scanner扫描器。
SonarQube: web界面管理平台。
1）展示所有的项目代码的质量数据。
2）配置质量规则、管理项目、配置通知、javafx数据库源码配置SCM等。
SonarScanner: 代码扫描工具。
专门用来扫描和分析项目代码。支持+语言。
代码扫描和分析完成之后，会将扫描结果存储到数据库当中，在SonarQube平台可以看到扫描数据。
SonarQube和sonarScanner之间的关系：
2 检测
Sonar是一个用于代码质量管理的开源平台，用于管理源代码的质量，可以从七个维度检测代码质量。通过插件形式，可以支持包括Java、C#、C/C++、PL/SQL、Cobol、JavaScript、Groovy等等二十几种编程语言的代码质量管理与检测。
2.1 Rules提示
2.1.1 Rule界面
2.1.2 Rule正确实例提示
2.2 糟糕的文档共享小程序源码复杂度分布
文件、类、方法等，如果复杂度过高将难以改变，这会使得开发人员难以理解它们，且如果没有自动化的单元测试，对于程序中的任何组件的改变都将可能导致需要全面的回归测试。
2.3 重复
显然程序中包含大量复制粘贴的代码是质量低下的，Sonar可以展示源码中重复严重的地方。
2.4 缺乏单元测试
Sonar可以很方便地统计并展示单元测试覆盖率。
2.5 没有代码标准
Sonar可以通过PMD、CheckStyle、Findbugs等等代码规则检测工具规范代码编写。
2.6 没有足够的或者过多的注释
没有注释将使代码可读性变差，特别是当不可避免地出现人员变动时，程序的可读性将大幅下降，而过多的注释又会使得开发人员将精力过多地花费在阅读注释上，亦违背初衷。
2.7 潜在的bug
Sonar可以通过PMD、CheckStyle、多指数共振源码下载Findbugs等等代码规则检测工具检测出潜在的bug。
2.8 糟糕的设计（原文Spaghetti Design，意大利面式设计）
通过Sonar可以找出循环，展示包与包、类与类之间的相互依赖关系，可以检测自定义的架构规则；通过Sonar可以管理第三方的jar包，可以利用LCOM4检测单个任务规则的应用情况，检测耦合。
3. Sonar组成
4. Sonar集成过程
开发人员在他们的IDE中使用SonarLint运行分析本地代码。
开发人员将他们的代码提交到代码管理平台中（SVN、GIT等），
持续集成工具自动触发构建，调用SonarScanner对项目代码进行扫描分析，
分析报告发送到SonarQube Server中进行加工，
SonarQube Server加工并且保存分析报告到SonarQube Database中，通过UI显示分析报告。
Sonarqube代码质量管理工具搭建
SonarQube是一款专注于持续分析和评估项目源代码质量的平台，它具备代码质量检查、安全漏洞扫描以及代码规范验证等功能，旨在辅助开发者编写更加清晰和安全的高质量代码。
以下是关于SonarQube搭建和Jenkins集成的简要说明：
1. SonarQube搭建
在搭建SonarQube时，可以选择社区版本，但请注意社区版本不支持多分支功能，因此需要安装第三方分支插件sonarqube-community-branch-plugin。
1.1 环境准备
由于SonarQube依赖ES，因此需要确保ES的vm.max_map_count大于，并且进程打开文件数量要足够。
通过修改/etc/sysctl.conf文件来调整vm.max_map_count值，同时修改/etc/security/limits.conf文件以增加相应的配置。
1.2 SonarQube安装
下载并解压SonarQube，然后修改conf/sonar.conf文件，通过环境变量设置Java执行路径。
1.3 安装分支插件
下载并选择1..0版本，将下载的jar文件复制到SonarQube安装目录下的extensions/plugins中，并在conf/sonar.conf中添加相应配置。
1.4 启动SonarQube
启动正常后，在http://hostip:访问，登录默认账号/密码为admin/admin，第一次登录需修改密码。
2. Jenkins集成
将SonarQube集成到Jenkins中，包括安装SonarQube插件，并在构建配置中设置分析步骤。
3. 踩坑总结
1. ES环境检测问题
2. Sonar分支插件安装版本匹配问题
3. 分支插件启动后需添加执行参数sonar.branch.name，否则会报错
4. Node.js版本要求，Java版本要求，在Jenkins流水线中可以通过tool选择当前工具版本
5. 代码排除格式
SonarQube和Fortify的区别对比
在寻找可靠的源代码扫描工具时，SonarQube和Fortify经常被提及。作为这两个产品的中国核心合作伙伴，苏州华克斯信息科技有限公司在此为您揭示它们之间的区别。
SonarQube是一个全面的代码质量分析平台，其核心在于提升代码质量，它能检测出项目中的漏洞和逻辑问题，支持多语言的插件。其价值主要体现在对代码的深度分析和管理上，包括可靠性、安全性、可维护性等七个维度。
相比之下，Fortify SCA是一款专门针对软件源代码安全的静态分析工具。它通过五大核心分析引擎来检测漏洞，并与内置的安全规则集进行匹配，突出安全问题。在测试用例WebGoat的对比中，Fortify在安全级别上显示出更强的扫描能力，发现条Critical和High级别的漏洞。
SonarQube则更侧重于代码质量问题，如重复代码、复杂度等，扫描出条阻断和严重级别漏洞，以及2K+条软件质量问题。然而，当涉及到深度安全漏洞，如跨文件处理和数据处理逻辑时，SonarQube的分析能力相较于Fortify有所不足，特别是对于复杂的污点传播问题。
总的来说，如果主要关注代码质量和一般性漏洞，SonarQube是个不错的选择。而如果你特别关注软件安全，尤其是高级别的安全漏洞，那么Fortify SCA可能是更为精准的工具。两者各有侧重，用户应根据项目需求进行选择。
自定义sonar插件-脚手架
企业需求多样化，标准的sonar规则集及阿里的P3C规则集难以满足所有场景。故此，自定义sonar插件成为企业优化代码质量的必要手段。鉴于当前自定义插件开发缺乏统一框架，实现过程复杂，本文章提供了一个易于遵循的骨架项目（请访问文末提供的GitHub源码），旨在简化开发者自定义sonar插件的流程。
针对sonar 7.9版本，我们构建了自定义sonarPMD插件的骨架项目，其余版本只需调整相关项目版本即可。此框架主要基于以下两个项目进行源码修改以实现兼容性。
项目适用版本为sonar 7.9。
该项目包含以下三个模块：
1. **integration-test**：负责集成测试，确保自定义功能的正确性。
2. **sonar-pmd-custom-rules**：此模块用于编写及验证自定义规则，编写完毕后，将规则安装至本地仓库。
3. **sonar-pmd-plugin**：负责集成 **sonar-pmd-custom-rules** 模块，生成sonar插件。
若无需自定义规则集，开发者可直接从 **2. 开发一个自定义规则** 部分开始操作。整个流程包括：
1. **自定义规则集**：根据需求创建新规则。
2. **开发一个自定义规则**：遵循项目文档编写规则。
3. **测试你的规则**：通过集成测试验证规则效果。
4. **在sonar中导入你的规则**：将自定义规则集成至sonar环境。
完整项目源码已提供，期待您的探索与贡献，共同提升代码质量。
