Re-movery 使用教程

Re-movery 使用教程

Re-movery Re-movery 项目地址: https://gitcode.com/gh_mirrors/re/Re-movery

1. 项目介绍

Re-Movery 是一个基于代码克隆检测技术，用于发现和修复潜在安全漏洞的开源工具。它支持Python和Go两种语言的实现，Go版本在性能和并发处理上进行了优化。Re-Movery 能够检测代码库中已知的漏洞代码克隆，不仅能够发现完全相同的代码克隆，还能识别经过修改的漏洞代码。

2. 项目快速启动

Python版本

安装依赖

首先，确保您的环境中已安装Python。接着执行以下命令安装依赖：

pip install -r requirements.txt
pip install -e .

创建配置文件

接着，创建一个config.json配置文件：

{
  "processing": {
    "num_processes": 4,
    "enable_cache": true
  }
}

运行扫描

配置完成后，运行以下命令开始扫描指定的代码路径：

movery /path/to/your/code

Go版本

安装Go

确保安装了Go语言环境（版本1.21或更高）。

克隆仓库

克隆Re-Movery的仓库：

git clone https://github.com/heyangxu/Re-movery.git
cd Re-movery

构建项目

在Go目录下构建项目：

cd go
go build -o movery ./cmd/movery

运行扫描

以下是一些基本的命令行操作：

• 扫描单个文件：

./movery scan --file path/to/file.py

• 扫描目录：

./movery scan --dir path/to/directory

• 排除特定文件或目录：

./movery scan --dir path/to/directory --exclude "node_modules,*.min.js"

• 生成HTML报告：

./movery scan --dir path/to/directory --output report.html

• 启用并行处理：

./movery scan --dir path/to/directory --parallel

• 启用增量扫描：

./movery scan --dir path/to/directory --incremental

3. 应用案例和最佳实践

在实施Re-Movery时，以下是一些最佳实践：

• 在CI/CD流程中集成Re-Movery，以便在代码提交时自动检测漏洞。
• 定期运行Re-Movery以监控代码库中的变化，并及时修复新出现的安全问题。
• 对于大型代码库，利用并行处理和结果缓存机制来提高效率。

4. 典型生态项目

Re-Movery 可以与其他开源安全工具和CI/CD平台集成，例如：

• GitHub Actions：自动化的代码扫描和漏洞检测。
• GitLab CI：持续集成的安全检测流程。
• Jenkins：自动化构建和漏洞扫描。

通过集成这些工具，可以创建一个更加安全、自动化的开发环境。

Re-movery Re-movery 项目地址: https://gitcode.com/gh_mirrors/re/Re-movery