ssdeep Python Wrapper 技术文档

1. 安装指南

首先，请确保您的系统中已经安装了pip工具。如果尚未安装，请参考Python官方文档进行安装。

安装ssdeep Python Wrapper可以通过以下命令进行：

$ pip install ssdeep

如果遇到构建失败的情况，可能是因为系统中没有安装ssdeep库。此时，您可以尝试使用以下命令安装：

$ BUILD_LIB=1 pip install ssdeep

2. 项目的使用说明

本项目提供了一个简单易用的Python包装器，用于计算上下文触发分块散列（CTPH），也称为模糊散列。它可以匹配具有同源性的输入，即输入具有相同顺序的相同字节序列，尽管序列之间的字节在内容和长度上可能有所不同。

计算模糊散列

使用hash函数计算模糊散列：

>>> import ssdeep
>>> hash1 = ssdeep.hash('Also called fuzzy hashes, Ctph can match inputs that have homologies.')
>>> hash1
'3:AXGBicFlgVNhBGcL6wCrFQEv:AXGHsNhxLsr2C'

比较散列

compare函数可以返回两个散列之间的匹配程度，返回值是一个从0（不匹配）到100的整数。

>>> ssdeep.compare(hash1, hash2)
22

更多示例可以在python-ssdeep文档中找到。

3. 项目API使用文档

本项目主要包含以下两个API：

• ssdeep.hash(input_string): 计算输入字符串的模糊散列。
• ssdeep.compare(hash1, hash2): 比较两个模糊散列的匹配程度。

4. 项目安装方式

如前所述，可以使用pip工具安装本项目。以下是安装命令：

$ pip install ssdeep

如果需要使用包含的ssdeep库版本，可以使用以下命令：

$ BUILD_LIB=1 pip install ssdeep

测试环境

本项目已在以下环境中进行测试：

• CentOS 7
• Debian 8, 9
• Ubuntu 14.04, 16.04, 18.04

许可

本项目代码遵循LGPLv3+协议。同时，本项目包含了未修改的ssdeep版本2.14.1源码，它遵循GPLv2协议。