Python Ssdeep

https://python-ssdeep.readthedocs.io/en/latest/
Admin
A documentation for the Python fuzzy hashing library ssdeep.
Tokens:3,098
Snippets:55
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install pre-commit

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Install the pre-commit tool, which helps manage and run pre-commit hooks for code quality checks.

```bash
$ pip install pre-commit
```

--------------------------------

### Install python-ssdeep

Source: https://python-ssdeep.readthedocs.io/en/latest/index.html

Install the python-ssdeep library using pip. This command fetches and installs the latest version from the Python Package Index.

```bash
$ pip install ssdeep

```

--------------------------------

### Install pre-commit Hooks

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Install the pre-commit hooks into your local repository. These hooks run automatically before each commit.

```bash
$ pre-commit install
```

--------------------------------

### Install Packages from EPEL for ssdeep on CentOS 7 (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary development tools and Python packages, utilizing the ssdeep library from the EPEL repository on CentOS 7 for Python 2.

```bash
$ sudo yum groupinstall "Development Tools"
$ sudo yum install epel-release
$ sudo yum install libffi-devel python-devel python-pip ssdeep-devel ssdeep-libs

```

--------------------------------

### Install Python Module with Included ssdeep Lib on Ubuntu 12.04 (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs pip3 and then builds and installs the python-ssdeep module using an included ssdeep library on Ubuntu 12.04 for Python 3.

```bash
$ sudo easy_install3 pip
$ sudo BUILD_LIB=1 pip3 install ssdeep

```

--------------------------------

### Install Python 3 Dependencies on Fedora

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary development tools and libraries for Python 3 ssdeep integration on Fedora.

```bash
$ sudo dnf groupinstall "Development Tools"
$ sudo dnf install libffi-devel python3-devel python3-pip ssdeep-devel ssdeep-libs

```

--------------------------------

### Install Python 2 Dependencies on Fedora

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary development tools and libraries for Python 2 ssdeep integration on Fedora.

```bash
$ sudo dnf groupinstall "Development Tools"
$ sudo dnf install libffi-devel python-devel python-pip ssdeep-devel ssdeep-libs

```

--------------------------------

### Install Packages on Debian 8/9 for ssdeep from Debian Repo (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary build tools and Python packages, utilizing the ssdeep library from the Debian repository on Debian 8/9 for Python 2.

```bash
$ sudo apt-get install build-essential libffi-dev python python-dev python-pip libfuzzy-dev

```

--------------------------------

### Install and Activate Virtual Environment

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Create a virtual environment for managing project dependencies and activate it. This isolates project dependencies.

```bash
$ python3 -m venv venv_git
$ source venv_git/bin/activate
```

--------------------------------

### Install Packages on Debian 8/9 for ssdeep from Debian Repo (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary build tools and Python packages, utilizing the ssdeep library from the Debian repository on Debian 8/9 for Python 3.

```bash
$ sudo apt-get install build-essential libffi-dev python3 python3-dev python3-pip libfuzzy-dev

```

--------------------------------

### Configure Git User Information

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Set your username and email for Git commits. This is a one-time setup.

```bash
$ git config user.name 'Your Name'
$ git config user.email 'your.email@example.org'
```

--------------------------------

### Install Python Module with EPEL ssdeep Lib on CentOS 7 (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using the ssdeep library from the EPEL repository on CentOS 7 for Python 2.

```bash
$ sudo pip install ssdeep

```

--------------------------------

### Install Development Tools and Packages on CentOS 7 (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary development tools and Python packages for building the ssdeep module with an included ssdeep library on CentOS 7 for Python 2.

```bash
$ sudo yum groupinstall "Development Tools"
$ sudo yum install epel-release
$ sudo yum install libffi-devel python-devel python-pip automake autoconf libtool

```

--------------------------------

### Install Python Module with Included ssdeep Lib on Ubuntu 16.04 (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using an included ssdeep library on Ubuntu 16.04 for Python 3.

```bash
$ BUILD_LIB=1 pip3 install ssdeep

```

--------------------------------

### Install Python Module with Included ssdeep Lib on Ubuntu 16.04 (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using an included ssdeep library on Ubuntu 16.04 for Python 2.

```bash
$ BUILD_LIB=1 pip install ssdeep

```

--------------------------------

### Install Packages on Ubuntu 12.04 for Included ssdeep Lib (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary build tools and Python packages for building the ssdeep module with an included ssdeep library on Ubuntu 12.04 for Python 3.

```bash
$ sudo apt-get install build-essential libffi-dev python3 python3-dev python3-setuptools automake autoconf libtool

```

--------------------------------

### Install Packages on Debian 7 for Included ssdeep Lib (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary build tools and Python packages for building the ssdeep module with an included ssdeep library on Debian 7 for Python 2.

```bash
$ sudo apt-get install build-essential libffi-dev python python-dev python-pip automake autoconf libtool

```

--------------------------------

### Install Packages on Debian 7 for Included ssdeep Lib (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Installs necessary build tools and Python packages for building the ssdeep module with an included ssdeep library on Debian 7 for Python 3.

```bash
$ sudo apt-get install build-essential libffi-dev python3 python3-dev python3-pip automake autoconf libtool

```

--------------------------------

### Install Python Module with Included ssdeep Lib on Debian 8/9 (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using an included ssdeep library on Debian 8/9 for Python 3.

```bash
$ sudo BUILD_LIB=1 pip3 install ssdeep

```

--------------------------------

### Install Python Module with Included ssdeep Lib on CentOS 7 (Python 2)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using an included ssdeep library on CentOS 7 for Python 2.

```bash
$ sudo BUILD_LIB=1 pip install ssdeep

```

--------------------------------

### Install Python Module with Ubuntu Repo ssdeep Lib on Ubuntu 16.04 (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using the ssdeep library from the official Ubuntu repository on Ubuntu 16.04 for Python 3.

```bash
$ pip3 install ssdeep

```

--------------------------------

### Install Python Module with Debian Repo ssdeep Lib on Debian 8/9 (Python 3)

Source: https://python-ssdeep.readthedocs.io/en/latest/installation.html

Builds and installs the python-ssdeep module using the ssdeep library from the Debian repository on Debian 8/9 for Python 3.

```bash
$ sudo pip3 install ssdeep

```

--------------------------------

### Compare Fuzzy Hashes

Source: https://python-ssdeep.readthedocs.io/en/latest/usage.html

Use the ssdeep.compare() function to get a match score between two fuzzy hashes. The score ranges from 0 (no match) to 100 (perfect match).

```python
ssdeep.compare(hash1, hash2)
```

--------------------------------

### Hash Class Interface

Source: https://python-ssdeep.readthedocs.io/en/latest/usage.html

Utilize the ssdeep.Hash class for a hashlib-like interface to compute hashes incrementally. Use update() to add data and digest() to get the current hash.

```python
h = ssdeep.Hash()
h.update('Also called fuzzy hashes, ')
h.digest()
```

```python
h.update('Ctph can match inputs that have homologies.')
h.digest()
```

--------------------------------

### Clone the Repository

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Clone the main python-ssdeep repository locally and navigate into the project directory.

```bash
$ git clone https://github.com/DinoTools/python-ssdeep.git
$ cd python-ssdeep
```

--------------------------------

### Import ssdeep module

Source: https://python-ssdeep.readthedocs.io/en/latest/usage.html

Import the necessary ssdeep module before use.

```python
import ssdeep
```

--------------------------------

### Compare Identical Hashes

Source: https://python-ssdeep.readthedocs.io/en/latest/faq.html

Demonstrates comparing two identical hashes generated from the same input. Note that the result can be 0 due to algorithm specifics, especially with short input data or insufficient patterns.

```python
>>> hash1 = ssdeep.hash('foo' * 4096)
>>> hash2 = ssdeep.hash('foo' * 4096)
>>> ssdeep.compare(hash1, hash2)
0

```

--------------------------------

### Add Fork as Remote

Source: https://python-ssdeep.readthedocs.io/en/latest/contributing.html

Add your GitHub fork as a remote repository to push your changes. Replace <username> with your actual GitHub username.

```bash
$ git remote add fork https://github.com/<username>/python-ssdeep
```

--------------------------------

### Hash File Contents

Source: https://python-ssdeep.readthedocs.io/en/latest/usage.html

Use the ssdeep.hash_from_file() function to compute the fuzzy hash of a file's contents by providing the file path.

```python
ssdeep.hash_from_file('/etc/resolv.conf')
```

--------------------------------

### Compute Fuzzy Hash

Source: https://python-ssdeep.readthedocs.io/en/latest/usage.html

Use the ssdeep.hash() function to compute a fuzzy hash of a given string. This is useful for comparing strings that are similar but not identical.

```python
hash1 = ssdeep.hash('Also called fuzzy hashes, Ctph can match inputs that have homologies.')
hash1
```

```python
hash2 = ssdeep.hash('Also called fuzzy hashes, CTPH can match inputs that have homologies.')
hash2
```
Tokens:
Raw