cccs-ssdeep 3.4.2__tar.gz

cccs_ssdeep-3.4.2/CHANGELOG.rst

@@ -0,0 +1,85 @@
+Changelog
+=========
+
+3.x (`master`_)
+~~~~~~~~~~~~~~~
+
+.. note:: This version is not yet released and is under development.
+
+3.4.1 (2021-12-13)
+~~~~~~~~~~~~~~~~~~
+
+* Add internal build improvements
+* Update CI pipelines
+
+3.4 (2019-10-01)
+~~~~~~~~~~~~~~~~
+
+* Update documentation
+* Replace Jenkins and Travis CI with Drone CI
+* Add new copy() function to Hash() and PseudoHash() class
+* Add new attributes to Hash() and PseudoHash() class
+  * name
+  * block_size
+
+3.3 (2018-01-10)
+~~~~~~~~~~~~~~~~
+
+* Update ssdeep lib to 2.14.1
+* Fix issues with Travis CI
+* Add additional CI test with Python 3.6
+* Build docs during CI builds
+* Remove deprecated PKGBUILD
+
+3.2 (2016-11-27)
+~~~~~~~~~~~~~~~~
+
+* Update ssdeep lib to 2.13(thanks to Charles Lindsay)
+* Update install instructions
+* Add additional CI tests on CentOS 7, Debian 8 and Ubuntu 14.04/16.04
+
+3.1.1 (2014-12-20)
+~~~~~~~~~~~~~~~~~~
+
+* Updated ssdeep lib to 2.12
+* Added additional tests
+* Fixed build issues on Windows(thanks to Paul Chaignon)
+* Added option to run tests with PyPy3
+* Fixed build to prevent automake version missmatch errors
+* Updated documentation
+
+3.1 (2014-08-07)
+~~~~~~~~~~~~~~~~
+
+* Fix build issue with ssdeep < 2.10
+
+3.0 (2014-06-25)
+~~~~~~~~~~~~~~~~
+
+* Completely rewritten to use CFFI
+* Interface in the spirit of hashlib
+* Use pytest and tox for tests
+* Use installed fuzzy lib by default
+
+2.9-0.3 (2013-03-12)
+~~~~~~~~~~~~~~~~~~~~
+
+* Fix build issue with Python 2.6
+
+2.9-0.2 (2012-10-11)
+~~~~~~~~~~~~~~~~~~~~
+
+* Fixing small bug in setup.py
+
+2.9-0.1 (2012-08-01)
+~~~~~~~~~~~~~~~~~~~~
+
+* Updated ssdeep from 2.5 to 2.9
+* Added Python 3.x support
+
+2.5 (2010-09-03)
+~~~~~~~~~~~~~~~~
+
+* Initial release
+
+.. _`master`: https://github.com/DinoTools/python-ssdeep

cccs_ssdeep-3.4.2/CONTRIBUTING.rst

@@ -0,0 +1,95 @@
+..
+    This file is part of the python-ssdeep
+
+    SPDX-FileCopyrightText: 2017-2020 PhiBo (DinoTools)
+
+    SPDX-License-Identifier: LGPL-3.0-or-later
+
+Contributing
+============
+
+First of all, thank you for your interest in contributing to this project!
+
+
+Filing bug reports
+------------------
+
+Bug reports are very welcome.
+Please file them on the `GitHub issue tracker`_.
+Good bug reports come with extensive descriptions of the error and how to reproduce it.
+Try to use the provided issue template, it should be displayed by the GitHub website when creating a new issue.
+
+
+Patches
+-------
+
+All patches should be submitted in the form of pull requests to the main repository, `DinoTools/python-ssdeep`_.
+These pull requests should satisfy the following properties:
+
+Code
+^^^^
+
+- A pull request should focus on **one** particular improvement or change.
+- Create different pull requests for unrelated features or bugfixes.
+- Python code should follow `PEP 8`_, especially in the "do what code around you does" sense.
+- Add test if possible
+
+
+Documentation
+^^^^^^^^^^^^^
+
+When introducing new functionality, please remember to write documentation.
+
+First time setup
+^^^^^^^^^^^^^^^^
+
+- Download and install the `latest version of git`_
+- Configure git with your username and email
+
+.. code::
+
+    $ git config user.name 'Your Name'
+    $ git config user.email 'your.email@example.org'
+
+- Make sure you have a `GitHub account`_
+- Fork `DinoTools/python-ssdeep`_ to your GitHub account by using the Fork button
+- Clone the main repository locally
+
+.. code::
+
+    $ git clone https://github.com/DinoTools/python-ssdeep.git
+    $ cd python-ssdeep
+
+- Add your fork as a remote to push your work to. Replace <username> with your username.
+
+.. code::
+
+    $ git remote add fork https://github.com/<username>/python-ssdeep
+
+- Install `pre-commit`_ by using a virtualenv.
+
+.. code::
+
+    $ python3 -m venv venv_git
+    $ source venv_git/bin/activate
+    $ pip install pre-commit
+
+- Install pre-commit hooks.
+
+.. code::
+
+    $ pre-commit install
+
+Review
+------
+
+Finally, pull requests must be reviewed before merging.
+Everyone can perform reviews; this is a very valuable way to contribute, and is highly encouraged.
+
+
+.. _GitHub issue tracker: https://github.com/DinoTools/python-ssdeep/issues
+.. _DinoTools/python-ssdeep: https://github.com/DinoTools/python-ssdeep
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
+.. _latest version of git: https://git-scm.com/downloads
+.. _GitHub account: https://github.com/join
+.. _pre-commit: https://pre-commit.com/

cccs_ssdeep-3.4.2/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

cccs_ssdeep-3.4.2/MANIFEST.in

@@ -0,0 +1,12 @@
+include CHANGELOG.rst
+include CONTRIBUTING.rst
+include LICENSE
+include README.rst
+include tox.ini
+graft docs
+prune docs/build
+graft src/ssdeep-lib
+graft tests
+
+global-exclude __pycache__
+global-exclude *.py[co]

cccs_ssdeep-3.4.2/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: cccs-ssdeep
+Version: 3.4.2
+Summary: Python wrapper for the ssdeep library
+Home-page: http://github.com/cccs-rs/python-ssdeep
+Author: PhiBo (DinoTools)
+License: LGPLv3+
+Keywords: ssdeep
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
+Requires-Dist: cffi>=1.0.0
+Provides-Extra: docstest
+Requires-Dist: doc8; extra == "docstest"
+Requires-Dist: readme_renderer>=16.0; extra == "docstest"
+Requires-Dist: sphinx; extra == "docstest"
+Requires-Dist: sphinx_rtd_theme; extra == "docstest"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+ssdeep Python Wrapper
+=====================
+
+This is a straightforward Python wrapper for `ssdeep by Jesse Kornblum`_, which is a library for computing context
+triggered piecewise hashes (CTPH). Also called fuzzy hashes, CTPH can match inputs that have homologies. Such inputs
+have sequences of identical bytes in the same order, although bytes in between these sequences may be different in both
+content and length.
+
+.. image:: https://img.shields.io/pypi/v/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/l/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/pyversions/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: Python Versions
+
+.. image:: https://readthedocs.org/projects/python-ssdeep/badge/
+    :target: https://python-ssdeep.readthedocs.io/en/latest/
+    :alt: Latest Docs
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/codeql-analysis.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/codeql-analysis.yml
+    :alt: CodeQL tests
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/python-linux.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/python-linux.yml
+    :alt: CI test status on Linux
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/debian.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/debian.yml
+    :alt: CI test status on Debian
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/ubuntu.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/ubuntu.yml
+    :alt: CI test status on Debian
+
+
+How to use it
+=============
+
+To compute a fuzzy hash, use ``hash`` function:
+
+.. code-block:: pycon
+
+    >>> import ssdeep
+    >>> hash1 = ssdeep.hash('Also called fuzzy hashes, Ctph can match inputs that have homologies.')
+    >>> hash1
+    '3:AXGBicFlgVNhBGcL6wCrFQEv:AXGHsNhxLsr2C'
+    >>> hash2 = ssdeep.hash('Also called fuzzy hashes, CTPH can match inputs that have homologies.')
+    >>> hash2
+    '3:AXGBicFlIHBGcL6wCrFQEv:AXGH6xLsr2C'
+
+The ``compare`` function returns the match between 2 hashes, an integer value from 0 (no match) to 100.
+
+.. code-block:: pycon
+
+    >>> ssdeep.compare(hash1, hash2)
+    22
+
+
+More examples are available in the `python-ssdeep documentation`_.
+
+Install
+=======
+
+If all requirements are met it is possible to install the wrapper by using pip or easy_install.
+
+.. code-block:: console
+
+    $ pip install ssdeep
+
+The build will fail if the ssdeep library isn't installed.
+To use the included version of the ssdeep library use the following command.
+
+.. code-block:: console
+
+    $ BUILD_LIB=1 pip install ssdeep
+
+For more information have a look at the `python-ssdeep documentation`_.
+
+Tested on ...
+=============
+
+* CentOS 7
+* Debian 8, 9
+* Ubuntu 14.04, 16.04, 18.04
+
+Documentation
+=============
+
+Feel free to use the prebuild `python-ssdeep documentation`_ or use the steps below to build the documentation.
+
+.. code-block:: console
+
+    $ cd docs
+    $ pip install -r requirements.txt
+    $ make html
+
+Licensing
+=========
+
+The code is licensed under the terms of the LGPLv3+.
+
+This wrapper includes the unchanged source distribution of `ssdeep version 2.14.1`_. It is licensed under the GPLv2.
+
+.. _ssdeep by Jesse Kornblum: https://ssdeep-project.github.io/ssdeep/
+.. _ssdeep version 2.14.1: https://github.com/ssdeep-project/ssdeep/releases/tag/release-2.14.1
+.. _python-ssdeep documentation: https://python-ssdeep.readthedocs.io

cccs_ssdeep-3.4.2/README.rst

@@ -0,0 +1,112 @@
+ssdeep Python Wrapper
+=====================
+
+This is a straightforward Python wrapper for `ssdeep by Jesse Kornblum`_, which is a library for computing context
+triggered piecewise hashes (CTPH). Also called fuzzy hashes, CTPH can match inputs that have homologies. Such inputs
+have sequences of identical bytes in the same order, although bytes in between these sequences may be different in both
+content and length.
+
+.. image:: https://img.shields.io/pypi/v/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/l/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/pyversions/ssdeep.svg
+    :target: https://pypi.python.org/pypi/ssdeep/
+    :alt: Python Versions
+
+.. image:: https://readthedocs.org/projects/python-ssdeep/badge/
+    :target: https://python-ssdeep.readthedocs.io/en/latest/
+    :alt: Latest Docs
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/codeql-analysis.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/codeql-analysis.yml
+    :alt: CodeQL tests
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/python-linux.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/python-linux.yml
+    :alt: CI test status on Linux
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/debian.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/debian.yml
+    :alt: CI test status on Debian
+
+.. image:: https://github.com/dinotools/python-ssdeep/actions/workflows/ubuntu.yml/badge.svg?branch=master
+    :target: https://github.com/DinoTools/python-ssdeep/actions/workflows/ubuntu.yml
+    :alt: CI test status on Debian
+
+
+How to use it
+=============
+
+To compute a fuzzy hash, use ``hash`` function:
+
+.. code-block:: pycon
+
+    >>> import ssdeep
+    >>> hash1 = ssdeep.hash('Also called fuzzy hashes, Ctph can match inputs that have homologies.')
+    >>> hash1
+    '3:AXGBicFlgVNhBGcL6wCrFQEv:AXGHsNhxLsr2C'
+    >>> hash2 = ssdeep.hash('Also called fuzzy hashes, CTPH can match inputs that have homologies.')
+    >>> hash2
+    '3:AXGBicFlIHBGcL6wCrFQEv:AXGH6xLsr2C'
+
+The ``compare`` function returns the match between 2 hashes, an integer value from 0 (no match) to 100.
+
+.. code-block:: pycon
+
+    >>> ssdeep.compare(hash1, hash2)
+    22
+
+
+More examples are available in the `python-ssdeep documentation`_.
+
+Install
+=======
+
+If all requirements are met it is possible to install the wrapper by using pip or easy_install.
+
+.. code-block:: console
+
+    $ pip install ssdeep
+
+The build will fail if the ssdeep library isn't installed.
+To use the included version of the ssdeep library use the following command.
+
+.. code-block:: console
+
+    $ BUILD_LIB=1 pip install ssdeep
+
+For more information have a look at the `python-ssdeep documentation`_.
+
+Tested on ...
+=============
+
+* CentOS 7
+* Debian 8, 9
+* Ubuntu 14.04, 16.04, 18.04
+
+Documentation
+=============
+
+Feel free to use the prebuild `python-ssdeep documentation`_ or use the steps below to build the documentation.
+
+.. code-block:: console
+
+    $ cd docs
+    $ pip install -r requirements.txt
+    $ make html
+
+Licensing
+=========
+
+The code is licensed under the terms of the LGPLv3+.
+
+This wrapper includes the unchanged source distribution of `ssdeep version 2.14.1`_. It is licensed under the GPLv2.
+
+.. _ssdeep by Jesse Kornblum: https://ssdeep-project.github.io/ssdeep/
+.. _ssdeep version 2.14.1: https://github.com/ssdeep-project/ssdeep/releases/tag/release-2.14.1
+.. _python-ssdeep documentation: https://python-ssdeep.readthedocs.io