├── API-1.0.0
├── CREDITS
├── ssdeep.php
├── config.w32
├── config.m4
├── README
├── LICENSE
├── php_ssdeep.h
├── ax_libssdeep.m4
├── tests
    └── ssdeep.phpt
├── examples
    └── example.php
├── ssdeep.c
├── package.xml
└── .github
    └── workflows
        └── build-test-and-release.yml


/API-1.0.0:
--------------------------------------------------------------------------------
1 | API release notes.
2 | 


--------------------------------------------------------------------------------
/CREDITS:
--------------------------------------------------------------------------------
1 | ssdeep
2 | Simon Holywell
3 | 


--------------------------------------------------------------------------------
/ssdeep.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | $br = (php_sapi_name() == "cli")? "":"<br>";
 3 | 
 4 | if(!extension_loaded('ssdeep')) {
 5 | 	dl('ssdeep.' . PHP_SHLIB_SUFFIX);
 6 | }
 7 | $module = 'ssdeep';
 8 | $functions = get_extension_funcs($module);
 9 | echo "Functions available in the test extension:$br\n";
10 | foreach($functions as $func) {
11 |     echo $func."$br\n";
12 | }
13 | 


--------------------------------------------------------------------------------
/config.w32:
--------------------------------------------------------------------------------
 1 | // vim:ft=javascript
 2 | 
 3 | ARG_WITH("ssdeep", "ssdeep support", "no");
 4 | 
 5 | if (PHP_SSDEEP != "no") {
 6 | 	if (CHECK_LIB("fuzzy_a.lib;fuzzy.lib", "ssdeep", PHP_SSDEEP) &&
 7 | 		CHECK_HEADER_ADD_INCLUDE("fuzzy.h", "CFLAGS_SSDEEP") &&
 8 | 		CHECK_HEADER_ADD_INCLUDE("edit_dist.h", "CFLAGS_SSDEEP")) {
 9 | 		EXTENSION("ssdeep", "ssdeep.c");
10 | 	} else {
11 | 		WARNING("ssdeep not enabled; libraries and headers not found");
12 | 	}
13 | }
14 | 


--------------------------------------------------------------------------------
/config.m4:
--------------------------------------------------------------------------------
 1 | PHP_ARG_WITH(ssdeep, for ssdeep support,
 2 | [  --with-ssdeep[=DIR]        Include ssdeep support. DIR is the optional path to the ssdeep directory.], yes)
 3 | PHP_ARG_ENABLE(ssdeep-debug, whether to enable build debug output,
 4 | [  --enable-ssdeep-debug        ssdeep: Enable debugging during build], no, no)
 5 | 
 6 | if test "$PHP_SSDEEP" != "no"; then
 7 |   withssdeep="$PHP_SSDEEP"
 8 |   ssdeep_enabledebug="$PHP_SSDEEP_DEBUG"
 9 |   dnl Pass in the library directory name specified by PHP - defaults to lib
10 |   ssdeep_libdirname="$PHP_LIBDIR"
11 | 
12 |   dnl Include common ssdeep availability test function
13 |   m4_include(ax_libssdeep.m4)
14 |   AX_SSDEEP
15 | 
16 |   if test $SSDEEP_FOUND = "yes"; then
17 |       PHP_CHECK_LIBRARY($SSDEEP_LIB_NAME, fuzzy_compare,
18 |       [
19 |         dnl Add the neccessary paths (vars declared in ax_libssdeep.m4)
20 |         PHP_ADD_INCLUDE($SSDEEP_INCLUDEDIR_NO_FLAG)
21 |         PHP_ADD_LIBRARY_WITH_PATH($SSDEEP_LIB_NAME, $SSDEEP_LIBDIR_NO_FLAG, SSDEEP_SHARED_LIBADD)
22 |         AC_DEFINE(HAVE_SSDEEP, 1, [Whether you have SSDEEP])
23 |       ],[
24 |         AC_MSG_ERROR([ssdeep lib not found. See config.log for more information.])
25 |       ],[$SSDEEP_LIBDIR]
26 |       )
27 |       PHP_NEW_EXTENSION(ssdeep, ssdeep.c, $ext_shared)
28 |       PHP_SUBST(SSDEEP_SHARED_LIBADD)
29 |   fi
30 | else
31 |   AC_MSG_RESULT([ssdeep was not enabled])
32 |   AC_MSG_ERROR([Enable ssdeep to build this extension.])
33 | fi
34 | 


--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
 1 | # ssdeep PECL extension for PHP
 2 | 
 3 | Fuzzy hashing makes it easy to identify similar or almost identical text by simply comparing two hashes against each other.
 4 | 
 5 | The ssdeep project page describes it as 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".
 6 | 
 7 | For an in depth paper explaining context triggered piecewise hashes please see http://dfrws.org/2006/proceedings/12-Kornblum.pdf
 8 | 
 9 | ## ssdeep API Information
10 | 
11 | Requires at least ssdeep v2.5.
12 | 
13 | This extensions wraps the ssdeep fuzzy hashing API created by Jesse Kornblum.
14 | 
15 | For more information about ssdeep, the API and context triggered piecewise hashing please see http://ssdeep.sourceforge.net/
16 | 
17 | ## ssdeep Licensing Exemption
18 | 
19 | Although ssdeep and the fuzzy hashing API are usually licensed under GNU GPLv2 Jesse Kornblum has licenced them to PECL under the terms of the Perl Artistic Licence with the following declaration:
20 | "I hereby license ssdeep, the current version and all subsequent versions, under the terms of the Perl Artistic License, for inclusion into the PECL."
21 | See http://news.php.net/php.pecl.dev/7625 for the verbatim email.
22 | 
23 | ## libfuzzy Windows builds
24 | 
25 | Windows PECL dependencies are available from windows.php.net: https://windows.php.net/downloads/pecl/deps/
26 | 
27 | There are build sources on github: https://github.com/winlibs/ssdeep although it is unclear what the source of 2.14.1 builds on windows.php.net is because this has the latest version of ssdeep as 2.13.
28 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | PECL ssdeep PHP Extension Licence
 2 | -------
 3 | This extension is under the BSD Licence:
 4 | 
 5 | Copyright (c) 2018, Simon Holywell
 6 | All rights reserved.
 7 | 
 8 | Redistribution and use in source and binary forms, with or without
 9 | modification, are permitted provided that the following conditions are met:
10 | 
11 | * Redistributions of source code must retain the above copyright notice, this
12 |   list of conditions and the following disclaimer.
13 | 
14 | * Redistributions in binary form must reproduce the above copyright notice,
15 |   this list of conditions and the following disclaimer in the documentation
16 |   and/or other materials provided with the distribution.
17 | 
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 | 
29 | 
30 | ssdeep Licensing Exemption
31 | -------
32 | 
33 | Although ssdeep and the fuzzy hashing API are usually licensed under GNU GPLv2 Jesse Kornblum has licenced them to PECL under the terms of the Perl Artistic Licence with the following declaration:
34 | "I hereby license ssdeep, the current version and all subsequent versions, under the terms of the Perl Artistic License, for inclusion into the PECL."
35 | See http://news.php.net/php.pecl.dev/7625 for the verbatim email.
36 | 


--------------------------------------------------------------------------------
/php_ssdeep.h:
--------------------------------------------------------------------------------
 1 | /**
 2 |  *
 3 |  * php_ssdeep
 4 |  *
 5 |  * http://treffynnon.github.com/php_ssdeep/
 6 |  *
 7 |  * A PHP extension to expose ssdeep functionality for fuzzy
 8 |  * hashing and comparing.
 9 |  *
10 |  * Version 1.1.1
11 |  *
12 |  * BSD Licensed.
13 |  *
14 |  * Copyright (c) 2018, Simon Holywell
15 |  * All rights reserved.
16 |  *
17 |  * Redistribution and use in source and binary forms, with or without
18 |  * modification, are permitted provided that the following conditions are met:
19 |  *
20 |  * * Redistributions of source code must retain the above copyright notice, this
21 |  *   list of conditions and the following disclaimer.
22 |  *
23 |  * * Redistributions in binary form must reproduce the above copyright notice,
24 |  *   this list of conditions and the following disclaimer in the documentation
25 |  *   and/or other materials provided with the distribution.
26 |  *
27 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
30 |  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
31 |  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 |  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
33 |  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
34 |  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
35 |  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 |  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 |  *
38 |  */
39 | 
40 | #ifndef PHP_SSDEEP_H
41 | #   define PHP_SSDEEP_H 1
42 | #   define PHP_SSDEEP_VERSION "1.1.1"
43 | #   define PHP_SSDEEP_EXTNAME "ssdeep"
44 |     PHP_FUNCTION(ssdeep_fuzzy_hash);
45 |     PHP_FUNCTION(ssdeep_fuzzy_compare);
46 |     PHP_FUNCTION(ssdeep_fuzzy_hash_filename);
47 | 
48 |     extern zend_module_entry php_ssdeep_module_entry;
49 | #   define phpext_php_ssdeep_ptr &php_ssdeep_module_entry
50 | 
51 | #if PHP_MAJOR_VERSION < 7
52 | typedef int strsize_t;
53 | #define _RETURN_STRING(s)  RETURN_STRING(s, 0);
54 | #else
55 | typedef size_t strsize_t;
56 | #define _RETURN_STRING(s)  { RETVAL_STRING(s); efree(s); return; }
57 | #endif
58 | 
59 | #endif
60 | 


--------------------------------------------------------------------------------
/ax_libssdeep.m4:
--------------------------------------------------------------------------------
  1 | #####
  2 | #
  3 | # SYNOPSIS
  4 | #
  5 | #   AX_SSDEEP()
  6 | #
  7 | # DESCRIPTION
  8 | #
  9 | #   This macro provides tests of availability for the SSDEEP library and headers.
 10 | #
 11 | #   This macro calls:
 12 | #
 13 | #     AC_SUBST(SSDEEP_LIBDIR)
 14 | #     AC_SUBST(SSDEEP_LIBS)
 15 | #     AC_SUBST(SSDEEP_INCLUDEDIR)
 16 | #
 17 | #####
 18 | AC_DEFUN([AX_SSDEEP], [
 19 |   AC_MSG_CHECKING(for ssdeep)
 20 | 
 21 |   AC_CANONICAL_HOST
 22 |   LIB_EXTENSION="so"
 23 |   case $host_os in
 24 |     darwin*)
 25 |       LIB_EXTENSION="dylib"
 26 |       ;;
 27 |   esac
 28 | 
 29 |   SSDEEP_LIB_NAME="fuzzy"
 30 |   SSDEEP_LIB_FILENAME="lib$SSDEEP_LIB_NAME.$LIB_EXTENSION"
 31 |   SSDEEP_INCLUDE_FILENAME="$SSDEEP_LIB_NAME.h"
 32 | 
 33 |   if test -z "$withssdeep" -o "$withssdeep" = "yes"; then
 34 |     for i in "/usr/$ssdeep_libdirname" "/usr/$ssdeep_libdirname/x86_64-linux-gnu" "/usr/$ssdeep_libdirname/aarch64-linux-gnu" "/usr/local/$ssdeep_libdirname"; do
 35 |       if test -f "$i/$SSDEEP_LIB_FILENAME"; then
 36 |         SSDEEP_LIB_PATH="$i"
 37 |       fi
 38 |     done
 39 |   elif test "$withssdeep" != "no"; then
 40 |     for i in "$withssdeep" "$withssdeep/$ssdeep_libdirname" "$withssdeep/.libs"; do
 41 |       if test -f "$i/$SSDEEP_LIB_FILENAME"; then
 42 |         SSDEEP_LIB_PATH="$i"
 43 |       fi
 44 |     done
 45 |   else
 46 |     AC_MSG_ERROR(["Cannot build whilst ssdeep is disabled."])
 47 |   fi
 48 | 
 49 |   if test "$SSDEEP_LIB_PATH" = ""; then
 50 |     AC_MSG_ERROR(["Could not find '$SSDEEP_LIB_FILENAME'. Try specifying the path to the ssdeep build directory."])
 51 |   fi
 52 | 
 53 |   SSDEEP_LIBDIR="-L$SSDEEP_LIB_PATH"
 54 |   SSDEEP_LIBS="-l$SSDEEP_LIB_NAME"
 55 |   SSDEEP_LIBDIR_NO_FLAG="$SSDEEP_LIB_PATH"
 56 | 
 57 |   if test -z "$withssdeep" -o "$withssdeep" = "yes"; then
 58 |     for i in /usr/include /usr/local/include; do
 59 |       if test -f "$i/$SSDEEP_INCLUDE_FILENAME"; then
 60 |         SSDEEP_INCLUDEDIR="$i"
 61 |       fi
 62 |     done
 63 |   elif test "$withssdeep" != "no"; then
 64 |     for i in "$withssdeep" "$withssdeep/.." "$withssdeep/include"; do
 65 |       if test -f "$i/$SSDEEP_INCLUDE_FILENAME"; then
 66 |         SSDEEP_INCLUDEDIR="$i"
 67 |       fi
 68 |     done
 69 |   else
 70 |     AC_MSG_ERROR(["Cannot build whilst ssdeep is disabled."])
 71 |   fi
 72 | 
 73 |   if test "$SSDEEP_INCLUDEDIR" = ""; then
 74 |     AC_MSG_ERROR(["Could not find ssdeep '$SSDEEP_INCLUDE_FILENAME' header file. Try specifying the path to the ssdeep build directory."])
 75 |   fi
 76 |   
 77 |   SSDEEP_INCLUDEDIR_NO_FLAG="$SSDEEP_INCLUDEDIR"
 78 |   SSDEEP_INCLUDEDIR="-I$SSDEEP_INCLUDEDIR"
 79 | 
 80 |   AC_MSG_RESULT([$SSDEEP_LIBDIR, $SSDEEP_INCLUDEDIR_NO_FLAG])
 81 |     
 82 |   AC_DEFINE([SSDEEP_ENABLED], [1], [Enables ssdeep])
 83 |   
 84 |   SSDEEP_FOUND="yes"
 85 |   
 86 |   if test "$ssdeep_enabledebug" = "yes"; then
 87 |     echo " "
 88 |     echo " "
 89 |     echo " "
 90 |     echo "======================== Debug =============================="
 91 |     echo " "
 92 |     echo "\$host_os                    :  $host_os"
 93 |     echo "\$SSDEEP_LIB_NAME            :  $SSDEEP_LIB_NAME"
 94 |     echo "\$SSDEEP_LIB_FILENAME        :  $SSDEEP_LIB_FILENAME"
 95 |     echo "\$SSDEEP_INCLUDE_FILENAME    :  $SSDEEP_INCLUDE_FILENAME"
 96 |     echo "\$SSDEEP_INC_DIR             :  $SSDEEP_INCLUDEDIR"
 97 |     echo "\$SSDEEP_INCLUDEDIR_NO_FLAG  :  $SSDEEP_INCLUDEDIR_NO_FLAG"
 98 |     echo "\$SSDEEP_LIBDIR              :  $SSDEEP_LIBDIR"
 99 |     echo "\$SSDEEP_LIBDIR_NO_FLAG      :  $SSDEEP_LIBDIR_NO_FLAG"
100 |     echo "\$SSDEEP_FOUND               :  $SSDEEP_FOUND"
101 |     echo "\$withssdeep                 :  $withssdeep"
102 |     echo "\$ssdeep_enabledebug         :  $ssdeep_enabledebug"
103 |     echo " "
104 |     echo "============================================================="
105 |     echo " "
106 |     echo " "
107 |     echo " "
108 |   fi
109 |   
110 |   AC_SUBST(SSDEEP_LIBDIR)
111 |   AC_SUBST(SSDEEP_LIBS)
112 |   AC_SUBST(SSDEEP_INCLUDEDIR)
113 | ])
114 | 


--------------------------------------------------------------------------------
/tests/ssdeep.phpt:
--------------------------------------------------------------------------------
 1 | --TEST--
 2 | Test ssdeep fuzzy hashing functions
 3 | --FILE--
 4 | <?php
 5 | $string1 = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed enim ante. Suspendisse eu massa ut libero congue aliquam. Morbi vehicula, lacus id faucibus ullamcorper, ante dui sodales velit, et laoreet nisl elit sed quam. Mauris quis purus odio, sed ornare urna. Sed eleifend sem ut nisl ultrices nec varius arcu malesuada. Quisque gravida mollis dictum. Nulla in neque vel mauris tincidunt lacinia ac placerat augue. Sed nec condimentum nisl. Integer congue leo nec elit sollicitudin placerat. Donec quis quam non erat ultricies lacinia. Sed sit amet massa vel dolor semper convallis vitae placerat lacus. Pellentesque ipsum erat, ultrices in mollis tincidunt, cursus sed justo. Nunc metus lectus, vehicula a gravida eget, venenatis sed elit.
 6 | 
 7 | Sed et nisl dolor, vitae interdum nulla. Donec egestas diam sit amet urna tincidunt elementum nec eu purus. Proin eget egestas enim. Pellentesque lobortis mattis orci id sodales. Nunc imperdiet bibendum enim vitae adipiscing. In.';
 8 | 
 9 | $string2 = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed enim ante. Suspendisse eu massa ut libero congue aliquam. Morbi vehicula, lacus id faucibus ullamcorper, ante dui sodales velit, et laoreet nisl elit sed quam. Mauris quis purus odio, sed ornare urna. Sed eleifend sem ut nisl ultrices nec varius arcu malesuada. Quisque gravida mollis dictum. Nulla in neque vel mauris tincidunt lacinia ac placerat augue. Sed nec condimentum nisl. Integer congue leo nec elit sollicitudin placerat. Donec quis quam non erat ultricies lacinia. Sed sit amet massa vel dolor semper convallis vitae placerat lacus. Pellentesque ipsum erat, ultrices in mollis tincidunt, cursus sed justo. Nunc metus lectus, vehicula a gravida eget, venenatis sed elit.
10 | 
11 | Donec id porttitor sem. Vestibulum eu augue non enim feugiat bibendum eu pellentesque purus. Aenean tortor felis, tempor ullamcorper feugiat sed, convallis accumsan nunc. Cras sem justo, congue eu sollicitudin eget, vestibulum id ipsum. Vivamus pulvinar semper turpis ut lobortis. Nulla consequat ornare sem eu cursus. Suspendisse facilisis bibendum elit. Duis commodo condimentum dolor, nec mollis leo vulputate at. Morbi turpis elit, varius nec iaculis sit amet, suscipit vel turpis. Etiam faucibus, felis eget feugiat placerat, velit leo convallis diam, eget rhoncus elit quam in felis. Nunc condimentum purus at odio dictum nec hendrerit sapien placerat.
12 | 
13 | Mauris sit amet urna augue, ut fermentum tellus. Aliquam sit amet molestie arcu. Aenean sit amet sagittis nisl. Aenean eleifend tincidunt ipsum a commodo. Aliquam erat volutpat. Mauris venenatis, augue nec interdum pretium, libero diam venenatis massa, nec posuere libero metus in lorem. Quisque eget odio eget purus vulputate pharetra id ac quam. Aliquam.';
14 | 
15 | $file1 = dirname(__FILE__) . '/test1.data';
16 | $file2 = dirname(__FILE__) . '/test2.data';
17 | file_put_contents($file1, $string1 . $string2);
18 | file_put_contents($file2, $string2 . $string1);
19 | 
20 | $hash1 = ssdeep_fuzzy_hash($string1);
21 | var_dump($hash1);
22 | 
23 | $hash2 = ssdeep_fuzzy_hash($string2);
24 | var_dump($hash2);
25 | 
26 | $hash3 = ssdeep_fuzzy_hash_filename($file1);
27 | var_dump($hash3);
28 | 
29 | $hash4 = ssdeep_fuzzy_hash_filename($file2);
30 | var_dump($hash4);
31 | 
32 | $match = ssdeep_fuzzy_compare($hash1, $hash2);
33 | var_dump($match);
34 | 
35 | $match2 = ssdeep_fuzzy_compare($hash2, $hash3);
36 | var_dump($match2);
37 | 
38 | $match3 = ssdeep_fuzzy_compare($hash3, $hash4);
39 | var_dump($match3);
40 | ?>
41 | --CLEAN--
42 | <?php
43 | $file1 = dirname(__FILE__) . '/test1.data';
44 | $file2 = dirname(__FILE__) . '/test2.data';
45 | unlink($file1);
46 | unlink($file2);
47 | ?>
48 | --EXPECT--
49 | string(78) "24:FPlUMKVsgNfgmjFadP6WboWjb8tsH4RSXqMbLFpjwPDt4tFF:9lUajiiPbbnr4RSXqMbppMZ4t3"
50 | string(76) "48:9lUajiiPbbnr4RSXqMbLbmo03Rcq0K/cvhQ+3/M8M5BEaB6:9HFHsGqabmoMR18hQ+308sBdk"
51 | string(100) "48:9lUajiiPbbnr4RSXqMbppMZ4twUlUajiiPbbnr4RSXqMbLbmo03Rcq0K/cvhQ+3X:9HFHsGqCM6tNHFHsGqabmoMR18hQ+30k"
52 | string(100) "48:9lUajiiPbbnr4RSXqMbLbmo03Rcq0K/cvhQ+3/M8M5BEaB1UlUajiiPbbnr4RSXX:9HFHsGqabmoMR18hQ+308sBdsHFHsGqy"
53 | int(57)
54 | int(75)
55 | int(63)
56 | 


--------------------------------------------------------------------------------
/examples/example.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  *
 4 |  * php_ssdeep
 5 |  *
 6 |  * http://github.com/treffynnon/php_ssdeep
 7 |  *
 8 |  * A PHP extension to expose ssdeep functionality for fuzzy
 9 |  * hashing and comparing.
10 |  *
11 |  * Version 1.1.1
12 |  *
13 |  * BSD Licensed.
14 |  *
15 |  * Copyright (c) 2018, Simon Holywell
16 |  * All rights reserved.
17 |  *
18 |  * Redistribution and use in source and binary forms, with or without
19 |  * modification, are permitted provided that the following conditions are met:
20 |  *
21 |  * * Redistributions of source code must retain the above copyright notice, this
22 |  *   list of conditions and the following disclaimer.
23 |  *
24 |  * * Redistributions in binary form must reproduce the above copyright notice,
25 |  *   this list of conditions and the following disclaimer in the documentation
26 |  *   and/or other materials provided with the distribution.
27 |  *
28 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31 |  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
32 |  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 |  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34 |  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35 |  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36 |  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 |  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 |  *
39 |  */
40 | 
41 | $string1 = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed enim ante. Suspendisse eu massa ut libero congue aliquam. Morbi vehicula, lacus id faucibus ullamcorper, ante dui sodales velit, et laoreet nisl elit sed quam. Mauris quis purus odio, sed ornare urna. Sed eleifend sem ut nisl ultrices nec varius arcu malesuada. Quisque gravida mollis dictum. Nulla in neque vel mauris tincidunt lacinia ac placerat augue. Sed nec condimentum nisl. Integer congue leo nec elit sollicitudin placerat. Donec quis quam non erat ultricies lacinia. Sed sit amet massa vel dolor semper convallis vitae placerat lacus. Pellentesque ipsum erat, ultrices in mollis tincidunt, cursus sed justo. Nunc metus lectus, vehicula a gravida eget, venenatis sed elit.
42 | 
43 | Sed et nisl dolor, vitae interdum nulla. Donec egestas diam sit amet urna tincidunt elementum nec eu purus. Proin eget egestas enim. Pellentesque lobortis mattis orci id sodales. Nunc imperdiet bibendum enim vitae adipiscing. In.';
44 | 
45 | $string2 = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed enim ante. Suspendisse eu massa ut libero congue aliquam. Morbi vehicula, lacus id faucibus ullamcorper, ante dui sodales velit, et laoreet nisl elit sed quam. Mauris quis purus odio, sed ornare urna. Sed eleifend sem ut nisl ultrices nec varius arcu malesuada. Quisque gravida mollis dictum. Nulla in neque vel mauris tincidunt lacinia ac placerat augue. Sed nec condimentum nisl. Integer congue leo nec elit sollicitudin placerat. Donec quis quam non erat ultricies lacinia. Sed sit amet massa vel dolor semper convallis vitae placerat lacus. Pellentesque ipsum erat, ultrices in mollis tincidunt, cursus sed justo. Nunc metus lectus, vehicula a gravida eget, venenatis sed elit.
46 | 
47 | Donec id porttitor sem. Vestibulum eu augue non enim feugiat bibendum eu pellentesque purus. Aenean tortor felis, tempor ullamcorper feugiat sed, convallis accumsan nunc. Cras sem justo, congue eu sollicitudin eget, vestibulum id ipsum. Vivamus pulvinar semper turpis ut lobortis. Nulla consequat ornare sem eu cursus. Suspendisse facilisis bibendum elit. Duis commodo condimentum dolor, nec mollis leo vulputate at. Morbi turpis elit, varius nec iaculis sit amet, suscipit vel turpis. Etiam faucibus, felis eget feugiat placerat, velit leo convallis diam, eget rhoncus elit quam in felis. Nunc condimentum purus at odio dictum nec hendrerit sapien placerat.
48 | 
49 | Mauris sit amet urna augue, ut fermentum tellus. Aliquam sit amet molestie arcu. Aenean sit amet sagittis nisl. Aenean eleifend tincidunt ipsum a commodo. Aliquam erat volutpat. Mauris venenatis, augue nec interdum pretium, libero diam venenatis massa, nec posuere libero metus in lorem. Quisque eget odio eget purus vulputate pharetra id ac quam. Aliquam.';
50 | 
51 | $file = __FILE__;
52 | 
53 | $hash1 = ssdeep_fuzzy_hash($string1);
54 |  echo 'Hash 1: ' . $hash1 . "\n";
55 | 
56 | $hash2 = ssdeep_fuzzy_hash($string2);
57 | echo 'Hash 2: ' . $hash2 . "\n";
58 | 
59 | $hash3 = ssdeep_fuzzy_hash_filename($file);
60 | echo 'Hash 3: ' . $hash3 . "\n";
61 | 
62 | $match = ssdeep_fuzzy_compare($hash1, $hash2);
63 | echo '1 & 2 Match:' . $match . "\n";
64 | 
65 | $match2 = ssdeep_fuzzy_compare($hash2, $hash3);
66 | echo '2 & 3 Match:' . $match2 . "\n";
67 | 


--------------------------------------------------------------------------------
/ssdeep.c:
--------------------------------------------------------------------------------
  1 | /**
  2 |  *
  3 |  * php_ssdeep
  4 |  *
  5 |  * http://treffynnon.github.com/php_ssdeep/
  6 |  *
  7 |  * A PHP extension to expose ssdeep functionality for fuzzy
  8 |  * hashing and comparing.
  9 |  *
 10 |  * Version 1.1.1
 11 |  *
 12 |  * BSD Licensed.
 13 |  *
 14 |  * Copyright (c) 2018, Simon Holywell
 15 |  * All rights reserved.
 16 |  *
 17 |  * Redistribution and use in source and binary forms, with or without
 18 |  * modification, are permitted provided that the following conditions are met:
 19 |  *
 20 |  * * Redistributions of source code must retain the above copyright notice, this
 21 |  *   list of conditions and the following disclaimer.
 22 |  *
 23 |  * * Redistributions in binary form must reproduce the above copyright notice,
 24 |  *   this list of conditions and the following disclaimer in the documentation
 25 |  *   and/or other materials provided with the distribution.
 26 |  *
 27 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 28 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 29 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 30 |  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 31 |  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 32 |  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 33 |  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 34 |  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 35 |  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 36 |  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 37 |  *
 38 |  */
 39 | 
 40 | #ifdef HAVE_CONFIG_H
 41 | #include "config.h"
 42 | #endif
 43 | 
 44 | #include "php.h"
 45 | #include "php_ini.h"
 46 | #include "ext/standard/info.h"
 47 | #include "SAPI.h"
 48 | #include "php_ssdeep.h"
 49 | #include <fuzzy.h>
 50 | 
 51 | /* For PHP 8 */
 52 | #ifndef TSRMLS_D
 53 | #define TSRMLS_D void
 54 | #define TSRMLS_DC
 55 | #define TSRMLS_C
 56 | #define TSRMLS_CC
 57 | #define TSRMLS_FETCH()
 58 | #endif
 59 | 
 60 | /* True global resources - no need for thread safety here */
 61 | ZEND_BEGIN_ARG_INFO_EX(arginfo_ssdeep_fuzzy_hash, 0, 0, 1)
 62 |     ZEND_ARG_INFO(0, to_hash)
 63 | ZEND_END_ARG_INFO()
 64 | 
 65 | ZEND_BEGIN_ARG_INFO_EX(arginfo_ssdeep_fuzzy_hash_filename, 0, 0, 1)
 66 |     ZEND_ARG_INFO(0, file_name)
 67 | ZEND_END_ARG_INFO()
 68 | 
 69 | ZEND_BEGIN_ARG_INFO_EX(arginfo_ssdeep_fuzzy_compare, 0, 0, 2)
 70 |     ZEND_ARG_INFO(0, signature1)
 71 |     ZEND_ARG_INFO(0, signature2)
 72 | ZEND_END_ARG_INFO()
 73 | 
 74 | /* {{{ ssdeep_functions[]
 75 |  */
 76 | const zend_function_entry ssdeep_functions[] = {
 77 |     PHP_FE(ssdeep_fuzzy_hash, arginfo_ssdeep_fuzzy_hash)
 78 |     PHP_FE(ssdeep_fuzzy_hash_filename, arginfo_ssdeep_fuzzy_hash_filename)
 79 |     PHP_FE(ssdeep_fuzzy_compare, arginfo_ssdeep_fuzzy_compare)
 80 | #ifdef PHP_FE_END
 81 |     PHP_FE_END
 82 | #else
 83 |     { NULL, NULL, NULL } /* Must be the last line in ssdeep_functions[] */
 84 | #endif
 85 | };
 86 | /* }}} */
 87 | 
 88 | /* {{{ PHP_MINFO_FUNCTION
 89 |  */
 90 | PHP_MINFO_FUNCTION(ssdeep) {
 91 |     php_info_print_table_start();
 92 |     php_info_print_table_row(2, PHP_SSDEEP_EXTNAME " Module", "enabled");
 93 |     php_info_print_table_row(2, "version", PHP_SSDEEP_VERSION);
 94 |     if (sapi_module.phpinfo_as_text) {
 95 |         /* No HTML for you */
 96 |         php_info_print_table_row(2, "By",
 97 |                 "Simon Holywell\nhttp://www.simonholywell.com");
 98 |     } else {
 99 |         /* HTMLified version */
100 |         php_printf("<tr>"
101 |                 "<td class=\"v\">By</td>"
102 |                 "<td class=\"v\">"
103 |                 "<a href=\"http://www.simonholywell.com\""
104 |                 " alt=\"Simon Holywell\">"
105 |                 "Simon Holywell"
106 |                 "</a></td></tr>");
107 |     }
108 |     php_info_print_table_end();
109 | }
110 | /* }}} */
111 | 
112 | /* {{{ proto string ssdeep_fuzzy_hash(string to_hash)
113 |  */
114 | PHP_FUNCTION(ssdeep_fuzzy_hash) {
115 |     char *hash = (char *) emalloc(FUZZY_MAX_RESULT);
116 |     char *to_hash;
117 |     strsize_t to_hash_len;
118 | 
119 |     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &to_hash, &to_hash_len) == FAILURE) {
120 |         RETURN_NULL();
121 |     }
122 | 
123 |     if (0 != fuzzy_hash_buf((unsigned char *) to_hash, (uint32_t)to_hash_len, hash)) {
124 |         RETURN_FALSE;
125 |     } else {
126 |         _RETURN_STRING(hash);
127 |     }
128 | }
129 | /* }}} */
130 | 
131 | /* {{{ proto string ssdeep_fuzzy_hash_filename(string file_name)
132 |  */
133 | PHP_FUNCTION(ssdeep_fuzzy_hash_filename) {
134 |     char *hash = (char *) emalloc(FUZZY_MAX_RESULT);
135 |     char *file_name;
136 |     strsize_t file_name_len;
137 | 
138 |     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file_name, &file_name_len) == FAILURE) {
139 |         RETURN_NULL();
140 |     }
141 | 
142 |     if (0 != fuzzy_hash_filename(file_name, hash)) {
143 |         RETURN_FALSE;
144 |     } else {
145 |         _RETURN_STRING(hash);
146 |     }
147 | }
148 | /* }}} */
149 | 
150 | /* {{{ proto long ssdeep_fuzzy_compare(string signature1, string signature2)
151 |  */
152 | PHP_FUNCTION(ssdeep_fuzzy_compare) {
153 |     char *signature1 = NULL;
154 |     strsize_t signature1_len;
155 |     char *signature2 = NULL;
156 |     strsize_t signature2_len;
157 |     int match;
158 |     
159 |     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &signature1, &signature1_len, &signature2, &signature2_len) == FAILURE) {
160 |         RETURN_NULL();
161 |     }
162 |     match = fuzzy_compare(signature1, signature2);
163 | 	
164 | 	if(match < 0 || match > 100) {
165 | 		RETURN_FALSE;
166 | 	} else {
167 | 		RETURN_LONG(match);
168 | 	}
169 | }
170 | /* }}} */
171 | 
172 | /* {{{ ssdeep_module_entry
173 |  */
174 | zend_module_entry ssdeep_module_entry = {
175 | #if ZEND_MODULE_API_NO >= 20010901
176 |     STANDARD_MODULE_HEADER,
177 | #endif
178 |     PHP_SSDEEP_EXTNAME,
179 |     ssdeep_functions,
180 |     NULL /* PHP_MINIT(ssdeep) */,
181 |     NULL /* PHP_MSHUTDOWN(ssdeep) */,
182 |     NULL /* PHP_RINIT(ssdeep) */, /* Replace with NULL if there's nothing to do at request start */
183 |     NULL /* PHP_RSHUTDOWN(ssdeep)*/, /* Replace with NULL if there's nothing to do at request end */
184 |     PHP_MINFO(ssdeep),
185 | #if ZEND_MODULE_API_NO >= 20010901
186 |     PHP_SSDEEP_VERSION,
187 | #endif
188 |     STANDARD_MODULE_PROPERTIES
189 | };
190 | /* }}} */
191 | 
192 | #ifdef COMPILE_DL_SSDEEP
193 | ZEND_GET_MODULE(ssdeep)
194 | #endif
195 | 


--------------------------------------------------------------------------------
/package.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <package packagerversion="1.10.5" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0"
  3 |   xmlns:tasks="http://pear.php.net/dtd/tasks-1.0"
  4 |   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5 |   xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0 http://pear.php.net/dtd/tasks-1.0.xsd
  6 |                       http://pear.php.net/dtd/package-2.0 http://pear.php.net/dtd/package-2.0.xsd">
  7 |   <name>ssdeep</name>
  8 |   <channel>pecl.php.net</channel>
  9 |   <summary>Fuzzy hashing makes it easy to identify similar or almost identical text by simply comparing two hashes against each other.</summary>
 10 |   <description><![CDATA[
 11 | The ssdeep project page describes it as a library for &quot;...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&quot;.
 12 | 
 13 | For an in depth paper explaining context triggered piecewise hashes please see http://dfrws.org/2006/proceedings/12-Kornblum.pdf
 14 | 
 15 | 
 16 | ssdeep API Information
 17 | ---------------------------
 18 | 
 19 | Requires at least ssdeep v2.5.
 20 | 
 21 | This extensions wraps the ssdeep fuzzy hashing API created by Jesse Kornblum.
 22 | 
 23 | For more information about ssdeep, the API and context triggered piecewise hashing please see http://ssdeep.sourceforge.net/
 24 | 
 25 | 
 26 | ssdeep Licensing Exemption
 27 | ---------------------------
 28 | 
 29 | Although ssdeep and the fuzzy hashing API are usually licensed under GNU GPLv2 Jesse Kornblum has licenced them to PECL under the terms of the Perl Artistic Licence with the following declaration:
 30 | &quot;I hereby license ssdeep, the current version and all subsequent versions, under the terms of the Perl Artistic License, for inclusion into the PECL.&quot;
 31 | See http://news.php.net/php.pecl.dev/7625 for the verbatim email.
 32 |  ]]></description>
 33 |   <lead>
 34 |     <name>Simon Holywell</name>
 35 |     <user>Treffynnon</user>
 36 |     <email>treffynnon@php.net</email>
 37 |     <active>yes</active>
 38 |   </lead>
 39 |   <date>2024-09-27</date>
 40 |   <time>15:54:00</time>
 41 |   <version>
 42 |     <release>1.1.1</release>
 43 |     <api>1.0.0</api>
 44 |   </version>
 45 |   <stability>
 46 |     <release>stable</release>
 47 |     <api>stable</api>
 48 |   </stability>
 49 |   <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
 50 |   <!-- latest release notes - should update <changelog> below with the same too -->
 51 |   <notes><![CDATA[
 52 | * Patch for PHP 8 support (remicollet)
 53 | 
 54 | For a complete list of changes see:
 55 | https://github.com/php/pecl-text-ssdeep/compare/1.1.0...1.1.1
 56 | ]]></notes>
 57 |   <contents>
 58 |     <dir name="/">
 59 |       <dir name="examples">
 60 |         <file name="example.php" role="doc" />
 61 |       </dir> <!-- /examples -->
 62 |       <dir name="tests">
 63 |         <file baseinstalldir="/" name="ssdeep.phpt" role="test" />
 64 |       </dir> <!--
 65 |             /tests -->
 66 |       <file name="ax_libssdeep.m4" role="src" />
 67 |       <file name="config.m4" role="src" />
 68 |       <file name="config.w32" role="src" />
 69 |       <file name="CREDITS" role="doc" />
 70 |       <file name="LICENSE" role="doc" />
 71 |       <file name="php_ssdeep.h" role="src" />
 72 |       <file name="README" role="doc" />
 73 |       <file name="ssdeep.c" role="src" />
 74 |     </dir> <!-- / -->
 75 |   </contents>
 76 |   <dependencies>
 77 |     <required>
 78 |       <php>
 79 |         <min>5.2.0</min>
 80 |       </php>
 81 |       <pearinstaller>
 82 |         <min>1.4.0b1</min>
 83 |       </pearinstaller>
 84 |     </required>
 85 |   </dependencies>
 86 |   <providesextension>ssdeep</providesextension>
 87 |   <extsrcrelease />
 88 |   <changelog>
 89 |     <release>
 90 |       <date>2024-09-27</date>
 91 |       <time>15:54:00</time>
 92 |       <version>
 93 |         <release>1.1.1</release>
 94 |         <api>1.0.0</api>
 95 |       </version>
 96 |       <stability>
 97 |         <release>stable</release>
 98 |         <api>stable</api>
 99 |       </stability>
100 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
101 |       <notes><![CDATA[
102 | * Patch for PHP 8 support (remicollet)
103 | 
104 | For a complete list of changes see:
105 | https://github.com/php/pecl-text-ssdeep/compare/1.1.0...1.1.1
106 | ]]></notes>
107 |     </release>
108 |     <release>
109 |       <date>2018-02-20</date>
110 |       <time>02:22:49</time>
111 |       <version>
112 |         <release>1.1.0</release>
113 |         <api>1.0.0</api>
114 |       </version>
115 |       <stability>
116 |         <release>stable</release>
117 |         <api>stable</api>
118 |       </stability>
119 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
120 |       <notes><![CDATA[
121 | * Patch for PHP 7 support (remicollet)
122 | * Add basic Windows support (weltling)
123 | 
124 | For a complete list of changes see:
125 | https://github.com/php/pecl-text-ssdeep/compare/1.0.4...1.1.0
126 | ]]></notes>
127 |     </release>
128 |     <release>
129 |       <date>2014-01-22</date>
130 |       <time>16:04:23</time>
131 |       <version>
132 |         <release>1.0.4</release>
133 |         <api>1.0.0</api>
134 |       </version>
135 |       <stability>
136 |         <release>stable</release>
137 |         <api>stable</api>
138 |       </stability>
139 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
140 |       <notes><![CDATA[
141 | This is a build maintenance release only so there is no need to upgrade.
142 | 
143 | - Make use of --with-libdir so installers can override the lib default (RHEL uses lib64 for example)
144 | - Clean up the build script to standardise the code constructs used
145 | - Add LICENSE, README and CREDITS to PECL package configuration
146 | 
147 | For a complete list of changes see:
148 | https://github.com/php/pecl-text-ssdeep/compare/1.0.3...1.0.4
149 | ]]></notes>
150 |     </release>
151 |     <release>
152 |       <date>2014-01-21</date>
153 |       <time>16:04:23</time>
154 |       <version>
155 |         <release>1.0.3</release>
156 |         <api>1.0.0</api>
157 |       </version>
158 |       <stability>
159 |         <release>stable</release>
160 |         <api>stable</api>
161 |       </stability>
162 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
163 |       <notes><![CDATA[
164 | Bug #60347 OSX can't build as .so hardcoded
165 | 
166 | For a complete list of changes see:
167 | https://github.com/php/pecl-text-ssdeep/compare/RELEASE_1_0_2...1.0.3
168 | ]]></notes>
169 |     </release>
170 |     <release>
171 |       <date>2010-11-10</date>
172 |       <time>16:04:23</time>
173 |       <version>
174 |         <release>1.0.2</release>
175 |         <api>1.0.0</api>
176 |       </version>
177 |       <stability>
178 |         <release>stable</release>
179 |         <api>stable</api>
180 |       </stability>
181 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
182 |       <notes><![CDATA[ 
183 | Patch bug in library availablity code when building with ssdeep path specified (--with-ssdeep=/tmp/ssdeep-2.6 for example) to the upstream packages build directory.
184 | ]]></notes>
185 |     </release>
186 |     <release>
187 |       <date>2010-11-06</date>
188 |       <time>16:04:23</time>
189 |       <version>
190 |         <release>1.0.1</release>
191 |         <api>1.0.0</api>
192 |       </version>
193 |       <stability>
194 |         <release>stable</release>
195 |         <api>stable</api>
196 |       </stability>
197 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
198 |       <notes><![CDATA[
199 | Add in better library availability checking script and remove extraneous docs, which are now available at http://php.net/ssdeep
200 | ]]></notes>
201 |     </release>
202 |     <release>
203 |       <date>2010-09-15</date>
204 |       <time>16:04:23</time>
205 |       <version>
206 |         <release>1.0.0</release>
207 |         <api>1.0.0</api>
208 |       </version>
209 |       <stability>
210 |         <release>stable</release>
211 |         <api>stable</api>
212 |       </stability>
213 |       <license uri="https://opensource.org/license/bsd-2-clause">BSD 2-Clause License</license>
214 |       <notes>Initial PECL compatible release.</notes>
215 |     </release>
216 |   </changelog>
217 | </package>


--------------------------------------------------------------------------------
/.github/workflows/build-test-and-release.yml:
--------------------------------------------------------------------------------
  1 | name: Build, test and Release PECL Extension
  2 | 
  3 | on:
  4 |   push:
  5 |     tags:
  6 |       - "*.*.*" # Trigger on version tags
  7 |   pull_request:
  8 |     branches:
  9 |       - master
 10 |   workflow_dispatch: # Allows manual trigger
 11 | 
 12 | jobs:
 13 |   check-version:
 14 |     runs-on: ubuntu-latest
 15 |     if: github.ref_type == 'tag'
 16 |     steps:
 17 |       - name: Check if tag is a valid version
 18 |         run: |
 19 |           TAG_NAME=$(echo "${GITHUB_REF#refs/tags/}")
 20 |           if [[ ! "$TAG_NAME" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
 21 |             echo "Error: Tag '$TAG_NAME' does not match semantic versioning format."
 22 |             exit 1
 23 |           fi
 24 |           echo "Tag '$TAG_NAME' is a valid version."
 25 | 
 26 |   build-linux:
 27 |     runs-on: ubuntu-latest
 28 |     strategy:
 29 |       fail-fast: false
 30 |       matrix:
 31 |         php-version: ["7.4", "8.0", "8.1", "8.2", "8.3"]
 32 |     outputs:
 33 |       latest-php-version: ${{ steps.set-latest-php-version.outputs.latest }}
 34 |     defaults:
 35 |       run:
 36 |         shell: bash
 37 | 
 38 |     steps:
 39 |       - name: Set latest PHP version
 40 |         id: set-latest-php-version
 41 |         run: echo "latest=${{ matrix.php-version }}" >> $GITHUB_ENV
 42 |         if: ${{ matrix.php-version == format('max', join(matrix.php-version)) }}
 43 | 
 44 |       - name: Checkout code
 45 |         uses: actions/checkout@v4
 46 | 
 47 |       - name: Setup PHP
 48 |         id: setup-php
 49 |         uses: shivammathur/setup-php@v2
 50 |         with:
 51 |           php-version: ${{ matrix.php-version }}
 52 | 
 53 |       - name: Install dependencies
 54 |         run: |
 55 |           sudo apt-get update
 56 |           sudo apt-get install -y build-essential autoconf libtool pkg-config git libfuzzy-dev
 57 | 
 58 |       - name: Build PECL Extension
 59 |         run: |
 60 |           phpize
 61 |           ./configure
 62 |           make
 63 | 
 64 |       - name: Run tests
 65 |         run: |
 66 |           make test
 67 | 
 68 |   build-windows:
 69 |     runs-on: ${{ matrix.os }}
 70 |     strategy:
 71 |       fail-fast: false
 72 |       matrix:
 73 |         os: [windows-2019, windows-latest]
 74 |         # not testing on PHP8 for windows at the moment because there is no libfuzzy dependency
 75 |         # compiled for it
 76 |         php-version: ["7.4"] #, "8.0", "8.1", "8.2", "8.3"]
 77 |         arch: [x64, x86]
 78 |         ts: [nts, ts]
 79 |         exclude:
 80 |           - { os: windows-latest, php-version: "7.4" }
 81 |           - { os: windows-2019, php-version: "8.0" }
 82 |           - { os: windows-2019, php-version: "8.1" }
 83 |           - { os: windows-2019, php-version: "8.2" }
 84 |           - { os: windows-2019, php-version: "8.3" }
 85 | 
 86 |     defaults:
 87 |       run:
 88 |         shell: powershell
 89 | 
 90 |     env:
 91 |       LIBFUZZY_DIR: ${{ github.workspace }}/libfuzzy
 92 | 
 93 |     steps:
 94 |       - name: Checkout code
 95 |         uses: actions/checkout@v4
 96 | 
 97 |       - name: Setup PHP
 98 |         id: setup-php-sdk
 99 |         uses: php/setup-php-sdk@v0.9
100 |         with:
101 |           arch: ${{ matrix.arch }}
102 |           ts: ${{ matrix.ts }}
103 |           version: ${{ matrix.php-version }}
104 | 
105 |       - name: Print PHP SDK properties
106 |         run: |
107 |           Write-Host "PHP SDK Toolset: ${{ steps.setup-php-sdk.outputs.toolset }}"
108 |           Write-Host "PHP SDK Prefix:  ${{ steps.setup-php-sdk.outputs.prefix }}"
109 |           Write-Host "PHP SDK VS:      ${{ steps.setup-php-sdk.outputs.vs }}"
110 | 
111 |       - name: Enable Developer Command Prompt
112 |         uses: ilammy/msvc-dev-cmd@v1
113 |         with:
114 |           arch: ${{matrix.arch}}
115 |           toolset: ${{steps.setup-php-sdk.outputs.toolset}}
116 | 
117 |       - name: Get latest ssdeep release info
118 |         id: ssdeep_release
119 |         env:
120 |           VC_VERSION: ${{ steps.setup-php-sdk.outputs.vs }}
121 |           ARCH: ${{ matrix.arch }}
122 |         run: |
123 |           $DOWNLOAD_URL = "https://windows.php.net/downloads/pecl/deps/"
124 | 
125 |           Write-Host "Looking up the latest libfuzzy (ssdeep) release for $env:ARCH architecture on $DOWNLOAD_URL"
126 | 
127 |           $webContent = Invoke-WebRequest -Uri $DOWNLOAD_URL
128 |           $regexPattern = "libfuzzy-[0-9\.]+-$env:VC_VERSION-$env:ARCH\.zip"
129 |           $matches = Select-String -InputObject $webContent.Content -Pattern $regexPattern
130 | 
131 |           if ($matches -eq $null) {
132 |             Write-Host "Error: No libfuzzy version found for architecture: $env:ARCH and VC version: $env:VC_VERSION"
133 |             exit 1
134 |           }
135 | 
136 |           $latestFile = $matches.Matches | ForEach-Object { $_.Value } | Sort-Object | Select-Object -Last 1
137 | 
138 |           Write-Host "Latest version found: $latestFile on $DOWNLOAD_URL"
139 | 
140 |           $zip_url = "$DOWNLOAD_URL$latestFile"
141 |           Write-Host "Download URL: $zip_url"
142 | 
143 |           echo "zip_url=$zip_url" >> $env:GITHUB_OUTPUT
144 |           echo "zip_file_name=$latestFile" >> $env:GITHUB_OUTPUT
145 | 
146 |       - name: Cache ssdeep download
147 |         id: cache_ssdeep
148 |         # explicit restore used to avoid slow cache issue
149 |         # https://github.com/actions/toolkit/issues/1578
150 |         uses: actions/cache/restore@v4
151 |         with:
152 |           path: |
153 |             ${{ github.workspace }}/libfuzzy
154 |           key: ssdeep-${{matrix.php-version}}-${{ steps.setup-php-sdk.outputs.vs }}-${{matrix.arch}}-${{ steps.ssdeep_release.outputs.zip_file_name }}
155 | 
156 |       - name: Download the latest libfuzzy Windows release
157 |         if: steps.cache_ssdeep.outputs.cache-hit != 'true'
158 |         env:
159 |           ZIP_URL: ${{ steps.ssdeep_release.outputs.zip_url }}
160 |           ZIP_FILE: "${{ github.workspace }}\\${{ steps.ssdeep_release.outputs.zip_file_name }}"
161 |         run: |
162 |           Invoke-WebRequest -Uri $env:ZIP_URL -OutFile $env:ZIP_FILE
163 | 
164 |       - name: Extract the downloaded zip file into the ssdeep directory
165 |         if: steps.cache_ssdeep.outputs.cache-hit != 'true'
166 |         id: extract_libfuzzy
167 |         env:
168 |           ZIP_FILE: "${{ github.workspace }}\\${{ steps.ssdeep_release.outputs.zip_file_name }}"
169 |         run: |
170 |           if ($env:ZIP_FILE -like "*.zip") {
171 |             Write-Host "Unzipping ${env:ZIP_FILE}..."
172 |             Expand-Archive -Path $env:ZIP_FILE -DestinationPath $env:LIBFUZZY_DIR -Force
173 |             Write-Host "libfuzzy extracted to $env:LIBFUZZY_DIR"
174 |           } else {
175 |             Write-Host "Error: The downloaded file is not a zip archive."
176 |             exit 1
177 |           }
178 | 
179 |       - name: Cache ssdeep save
180 |         id: cache_ssdeep_save
181 |         # explicit save used to avoid slow cache issue
182 |         # https://github.com/actions/toolkit/issues/1578
183 |         uses: actions/cache/save@v4
184 |         with:
185 |           path: |
186 |             ${{ github.workspace }}/libfuzzy
187 |           key: ssdeep-${{matrix.php-version}}-${{ steps.setup-php-sdk.outputs.vs }}-${{matrix.arch}}-${{ steps.ssdeep_release.outputs.zip_file_name }}
188 | 
189 |       - name: Add libfuzzy to LIB and INCLUDE
190 |         run: |
191 |           Write-Host "Adding $env:LIBFUZZY_DIR to LIB and INCLUDE environment variables"
192 | 
193 |           $libPath = Join-Path $env:LIBFUZZY_DIR "lib"
194 |           $includePath = Join-Path $env:LIBFUZZY_DIR "include"
195 | 
196 |           if ((Test-Path $libPath) -and (Test-Path $includePath)) {
197 |             $env:LIB += ";$libPath"
198 |             $env:INCLUDE += ";$includePath"
199 | 
200 |             # propagate the changes to the next steps
201 |             echo "LIB=$env:LIB" >> $env:GITHUB_ENV
202 |             echo "INCLUDE=$env:INCLUDE" >> $env:GITHUB_ENV
203 | 
204 |             Write-Host "LIB is now: $env:LIB"
205 |             Write-Host "INCLUDE is now: $env:INCLUDE"
206 |           } else {
207 |             Write-Host "Error: lib and include directories not found at $libPath and $includePath"
208 |             exit 1
209 |           }
210 | 
211 |       - name: List the contents of the working directory
212 |         run: |
213 |           Get-ChildItem -Path ${{ github.workspace }}
214 | 
215 |       - name: PHPize PECL Extension
216 |         shell: cmd
217 |         run: |
218 |           phpize
219 | 
220 |       - name: Configure PHP Extension
221 |         shell: cmd
222 |         run: |
223 |           configure --with-ssdeep --with-php-build=.\..\deps --with-prefix=${{ steps.setup-php-sdk.outputs.prefix }}
224 | 
225 |       - name: extract variables from Makefile (build_dir and dll_file)
226 |         id: extract_makefile_vars
227 |         shell: powershell
228 |         env:
229 |           DLL_FILE_NAME: php_ssdeep.dll
230 |         run: |
231 |           $makefileContent = Get-Content -Path ./Makefile -Raw
232 |           $buildDirsSub = [regex]::Match($makefileContent, "BUILD_DIRS_SUB=(.*)").Groups[1].Value.Trim()
233 |           $dllFullPath = Join-Path -Path $buildDirsSub -ChildPath $env:DLL_FILE_NAME
234 | 
235 |           echo "dll_path=$dllFullPath" >> $env:GITHUB_OUTPUT
236 |           echo "dll_file_name=$env:DLL_FILE_NAME" >> $env:GITHUB_OUTPUT
237 | 
238 |       - name: Build PHP Extension
239 |         shell: cmd
240 |         run: |
241 |           nmake
242 | 
243 |       - name: Verify the file was built
244 |         env:
245 |           dll_path: ${{ steps.extract_makefile_vars.outputs.dll_path }}
246 |         run: |
247 |           if (Test-Path $env:dll_path) {
248 |             Write-Host "The extension was built successfully."
249 |           } else {
250 |             Write-Host "Error: The extension was not built."
251 |             exit 1
252 |           }
253 | 
254 |       - name: Run tests
255 |         shell: cmd
256 |         run: |
257 |           nmake test TESTS="--show-diff -g FAIL,BORK,WARN,LEAK tests"
258 | 
259 |       - name: Copy the built extension to the workspace
260 |         id: copy_dll
261 |         run: |
262 |           Copy-Item -Path "${{ steps.extract_makefile_vars.outputs.dll_path }}" -Destination "${{ github.workspace }}"
263 | 
264 |           echo "dll_path_for_packaging=${{ github.workspace }}\\${{ steps.extract_makefile_vars.outputs.dll_file_name }}" >> $env:GITHUB_OUTPUT
265 | 
266 |       - name: Generate SHA256 sum of the built extension
267 |         id: generate_sha256
268 |         env:
269 |           SHA256_FILE: ${{ steps.copy_dll.outputs.dll_path_for_packaging }}.sha256
270 |         run: |
271 |           $checksum = Get-FileHash -Path ${{ steps.copy_dll.outputs.dll_path_for_packaging }} -Algorithm SHA256
272 |           $lowercaseChecksum = $checksum.Hash.ToLower()
273 |           [System.IO.File]::WriteAllText($env:SHA256_FILE, $lowercaseChecksum)
274 | 
275 |           Write-Host "SHA256 checksum: $lowercaseChecksum"
276 |           echo "sha256=$lowercaseChecksum" >> $env:GITHUB_OUTPUT
277 |           echo "sha256_file=$env:SHA256_FILE" >> $env:GITHUB_OUTPUT
278 | 
279 |       - name: Archive build artefacts
280 |         uses: actions/upload-artifact@v4
281 |         with:
282 |           name: php-ssdeep-${{ matrix.os }}-${{ matrix.arch }}-php${{ matrix.php-version }}-${{ matrix.ts }}
283 |           path: |
284 |             ${{ steps.copy_dll.outputs.dll_path_for_packaging }}
285 |             ${{ steps.generate_sha256.outputs.sha256_file }}
286 | 
287 |   release_for_upload_to_pecl:
288 |     if: github.ref_type == 'tag'
289 |     needs: [check-version, build-linux]
290 |     runs-on: ubuntu-latest
291 | 
292 |     steps:
293 |       - name: Checkout code
294 |         uses: actions/checkout@v4
295 | 
296 |       - name: Create a release of the extension
297 |         run: |
298 |           pear package
299 | 
300 |       - name: Check for ssdeep file matching semver in the current directory
301 |         id: check_file_exists
302 |         run: |
303 |           FILE_PATTERN="ssdeep-[0-9]+\.[0-9]+\.[0-9]+\.tgz"
304 | 
305 |           FILE_FOUND=$(ls -1 | grep -E ${FILE_PATTERN} | head -n 1)
306 | 
307 |           if [ -n "$FILE_FOUND" ]; then
308 |             echo "File ${FILE_FOUND} found in the current directory."
309 |             echo "file_name=${FILE_FOUND}" >> $GITHUB_OUTPUT
310 |           else
311 |             echo "File matching pattern ${FILE_PATTERN} not found."
312 |             exit 1
313 |           fi
314 | 
315 |       - name: Archive build artifacts
316 |         uses: actions/upload-artifact@v4
317 |         with:
318 |           name: ${{ steps.check_file_exists.outputs.file_name }}
319 |           path: |
320 |             ${{ github.workspace }}/${{ steps.check_file_exists.outputs.file_name }}
321 | 


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