momo-code-sec-inspector-java

momo-code-sec-inspector-java copied to clipboard

MOMO CODE SEC INSPECTOR

本插件作为Java项目静态代码安全审计工具，侧重于在编码过程中发现项目潜在的安全风险，并提供一键修复能力。

本插件利用IDEA原生Inspection机制检查项目，自动检查当前活跃窗口的活跃文件，检查速度快，占用资源少。

插件提供的规则名称均以"Momo"开头。

目录

1. 版本支持
2. 安装使用
3. 效果展示
4. 插件规则
5. 贡献代码
6. 注意事项
7. 关于我们

版本支持

Intellij IDEA ( Community / Ultimate ) >= 2018.3

已停止对2017.*的支持

安装使用

IDEA插件市场安装

IDEA插件市场搜索"immomo"安装。

使用：方法一

该插件会在您编码过程中自动扫描当前编辑的代码，并实时提醒安全风险。

使用：方法二

IDEA 提供Inspect Code功能支持对整个项目/指定范围文件进行自定义规则的扫描。

效果展示

演示一： XXE漏洞发现与一键修复

演示二： Mybatis XML Mapper SQL注入漏洞发现与一键修复

插件规则

贡献代码

项目结构

src
├── main
│   ├── java
│   │   └── com
│   │       └── immomo
│   │           └── momosec
│   │               ├── aspect
│   │               ├── entity
│   │               ├── fix
│   │               ├── lang
│   │               │   ├── java
│   │               │   │   ├── rule
│   │               │   │   │   └── momosecurity
│   │               │   │   │       └── {InspectionName}.java
│   │               │   │   └── utils
│   │               │   └── xml
│   │               │       └── rule
│   │               │           └── momosecurity
│   │               │               └── {InspectionName}.java
│   │               └── utils
│   └── resources
│       ├── META-INF
│       │   ├── description.html
│       │   ├── pluginIcon.svg
│       │   └── plugin.xml
│       └── inspectionDescriptions
│           └── {InspectionName}.html
└── test
    ├── java
    │   └── com
    │       └── immomo
    │           └── momosec
    │               └── lang
    │                   ├── java
    │                   │   ├── fix
    │                   │   └── rule
    │                   │       └── momosecurity
    │                   │           └── {InspectionName}Test.java
    │                   └── xml
    │                       └── rule
    │                           └── momosecurity
    │                               └── {InspectionName}Test.java
    ├── resources
    └── testData
        └── lang
            ├── java
            │   └── rule
            │       └── momosecurity
            │           └── {InspectionName}
            │               └──...
            └── xml
                └── rule
                    └── momosecurity
                        └── {InspectionName}
                            └──...

脚手架

# 新增检查规则
> python script/addInspection.py

# 删除检查规则
> python script/deleteInspection.py

单元测试

> ./gradlew :test

预发布打包

1. ./gradlew --no-daemon clean build -PMOMO_CODE_SEC_INSPECTOR_ENV=pre
2. build/distributions/*.zip 为待发布插件

发布打包

1. ./gradlew --no-daemon clean build -PMOMO_CODE_SEC_INSPECTOR_ENV=prod
2. build/distributions/*.zip 为待发布插件

注意事项

• 分支命名规则：

以版本号命名的分支，原则上代表支持的idea版本下限。

如branch为2018.3代表当前分支支持版本范围是>=2018.3 (或说from 183.* to *)。

插件具体支持idea版本范围见gradle.properties中idea_since_build与idea_until_build部分。

• 插件版本号命名规则：

原则上，插件版本号以支持的idea版本下限为大版本编号。

如插件当前版本为x.1，x为开发时所用IDEA版本编号，.1为插件发布版本。

需要注意的是，因IDEA更新机制问题，插件新版本号只能向上增长。

具体见gradle.properties的plugin_version字段。

• 版本号对应关系

关于我们

陌陌安全致力于以务实的工作保障陌陌旗下所有产品及亿万用户的信息安全，以开放的心态拥抱信息安全机构、团队与个人之间的共赢协作，以自由的氛围和丰富的资源支撑优秀同学的个人发展与职业成长。

Website：https://security.immomo.com

WeChat: