040038e10bc19725b399b70b3e52409e9ec01343
[~helmut/ssdeep.git] / fuzzy.c
1 /* ssdeep
2  * Copyright (C) 2002 Andrew Tridgell <tridge@samba.org>
3  * Copyright (C) 2006 ManTech International Corporation
4  * Copyright (C) 2013 Helmut Grohne <helmut@subdivi.de>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * Earlier versions of this code were named fuzzy.c and can be found at:
21  *     http://www.samba.org/ftp/unpacked/junkcode/spamsum/
22  *     http://ssdeep.sf.net/
23  */
24
25 #include <assert.h>
26 #include <stdint.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #if defined(__GNUC__) && __GNUC__ >= 3
32 #define likely(x)       __builtin_expect(!!(x), 1)
33 #define unlikely(x)     __builtin_expect(!!(x), 0)
34 #else
35 #define likely(x) x
36 #define unlikely(x) x
37 #endif
38
39 #define SPAMSUM_LENGTH 64
40 #define FUZZY_MAX_RESULT (SPAMSUM_LENGTH + (SPAMSUM_LENGTH/2 + 20))
41 #define ROLLING_WINDOW 7
42 #define MIN_BLOCKSIZE 3
43 #define HASH_PRIME 0x01000193
44 #define HASH_INIT 0x28021967
45
46 struct roll_state {
47         unsigned char window[ROLLING_WINDOW];
48         uint32_t h1, h2, h3;
49         uint32_t n;
50 };
51
52 static void roll_init(/*@out@*/ struct roll_state *self) {
53         memset(self, 0, sizeof(struct roll_state));
54 }
55
56 /*
57  * a rolling hash, based on the Adler checksum. By using a rolling hash
58  * we can perform auto resynchronisation after inserts/deletes
59
60  * internally, h1 is the sum of the bytes in the window and h2
61  * is the sum of the bytes times the index
62
63  * h3 is a shift/xor based rolling hash, and is mostly needed to ensure that
64  * we can cope with large blocksize values
65  */
66 static void roll_hash(struct roll_state *self, unsigned char c) {
67         self->h2 -= self->h1;
68         self->h2 += ROLLING_WINDOW * (uint32_t)c;
69
70         self->h1 += (uint32_t)c;
71         self->h1 -= (uint32_t)self->window[self->n % ROLLING_WINDOW];
72
73         self->window[self->n % ROLLING_WINDOW] = c;
74         self->n++;
75
76         /* The original spamsum AND'ed this value with 0xFFFFFFFF which
77          * in theory should have no effect. This AND has been removed
78          * for performance (jk) */
79         self->h3 <<= 5;
80         self->h3 ^= c;
81 }
82
83 static uint32_t roll_sum(const struct roll_state *self) {
84         return self->h1 + self->h2 + self->h3;
85 }
86
87 /* A simple non-rolling hash, based on the FNV hash. */
88 static uint32_t sum_hash(unsigned char c, uint32_t h) {
89         return (h * HASH_PRIME) ^ c;
90 }
91
92 /* A blockhash contains a signature state for a specific (implicit) blocksize.
93  * The blocksize is given by the start_blocksize from ssdeep_context times two
94  * to the power of the position of the element in the blockhashes member of
95  * ssdeep_context (head position = 0). The h and halfh members are the FNV
96  * hashes, where halfh stops to be reset after digest is SPAMSUM_LENGTH/2 long.
97  * The halfh hash is needed be able to truncate digest for the second output
98  * hash to stay compatible with ssdeep output. */
99 struct blockhash_context {
100         uint32_t h, halfh;
101         char digest[SPAMSUM_LENGTH];
102         unsigned int dlen;
103         /*@null@*/ struct blockhash_context *next;
104 };
105
106 struct ssdeep_context {
107         unsigned int start_blocksize;
108         struct blockhash_context *blockhashes;
109         size_t total_size;
110         struct roll_state roll;
111 };
112
113 static int ssdeep_init(/*@out@*/ struct ssdeep_context *self) {
114         self->blockhashes = malloc(sizeof(struct blockhash_context));
115         if(NULL == self->blockhashes)
116                 return -1;
117         self->start_blocksize = MIN_BLOCKSIZE;
118         self->blockhashes->h = HASH_INIT;
119         self->blockhashes->halfh = HASH_INIT;
120         self->blockhashes->dlen = 0;
121         self->blockhashes->next = NULL;
122         self->total_size = 0;
123         roll_init(&self->roll);
124         return 0;
125 }
126
127 static const char *b64 =
128         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
129
130 static int ssdeep_engine_step(struct ssdeep_context *self, unsigned char c) {
131         size_t h;
132         unsigned int bs;
133         struct blockhash_context *bh;
134         /* At each character we update the rolling hash and the normal hashes.
135          * When the rolling hash hits a reset value then we emit a normal hash
136          * as a element of the signature and reset the normal hash. */
137         roll_hash(&self->roll, c);
138         h = roll_sum(&self->roll);
139
140         for(bh = self->blockhashes; NULL != bh; bh = bh->next) {
141                 bh->h = sum_hash(c, bh->h);
142                 bh->halfh = sum_hash(c, bh->halfh);
143         }
144
145         bs = self->start_blocksize;
146         bh = self->blockhashes;
147         while(bh != NULL) {
148                 /* With growing blocksize almost no runs fail the next test. */
149                 if(likely(h % bs != bs - 1))
150                         /* Once this condition is false for one bs, it is
151                          * automatically false for all further bs. I.e. if
152                          * h === -1 (mod 2*bs) then h === -1 (mod bs). */
153                         break;
154                 /* We don't need bs until next iteration. Update now, so we
155                  * don't forget about it. */
156                 bs *= 2;
157                 /* We have hit a reset point. We now emit hashes which are
158                  * based on all characters in the piece of the message between
159                  * the last reset point and this one */
160                 if(unlikely(0 == bh->dlen)) { /* Can only happen 30 times. */
161                         /* First step for this blocksize. Clone next. */
162                         assert(NULL == bh->next);
163                         bh->next = malloc(sizeof(
164                                         struct blockhash_context));
165                         if(NULL == bh->next)
166                                 return -1;
167                         bh->next->h = bh->h;
168                         bh->next->dlen = 0;
169                         bh->next->next = NULL;
170                 }
171                 if(bh->dlen < SPAMSUM_LENGTH - 1) {
172                         /* We can have a problem with the tail overflowing. The
173                          * easiest way to cope with this is to only reset the
174                          * normal hash if we have room for more characters in
175                          * our signature. This has the effect of combining the
176                          * last few pieces of the message into a single piece
177                          * */
178                         bh->digest[bh->dlen++] = b64[bh->h % 64];
179                         bh->h = HASH_INIT;
180                         if(bh->dlen < SPAMSUM_LENGTH / 2)
181                                 bh->halfh = HASH_INIT;
182                 } else if(NULL != bh->next &&
183                                 (size_t)self->start_blocksize * SPAMSUM_LENGTH <
184                                         self->total_size &&
185                                 bh->next->dlen >= SPAMSUM_LENGTH / 2 &&
186                                 bh == self->blockhashes) {
187                         /* Operating on the currently smallest blocksize and
188                          * the next blocksize is already large enough. */
189                         self->start_blocksize *= 2;
190                         bh = bh->next;
191                         free(self->blockhashes);
192                         self->blockhashes = bh;
193                         continue;
194                 }
195                 bh = bh->next;
196         }
197         ++self->total_size;
198         return 0;
199 }
200
201 static int ssdeep_engine(struct ssdeep_context *self,
202                 const unsigned char *buffer, size_t buffer_size) {
203         for( ;buffer_size > 0; ++buffer, --buffer_size)
204                 if(ssdeep_engine_step(self, *buffer) < 0)
205                         return -1;
206         return 0;
207 }
208
209 static void ssdeep_digest(const struct ssdeep_context *self,
210                 /*@out@*/ char *result) {
211         unsigned int bs = self->start_blocksize;
212         uint32_t h = roll_sum(&self->roll);
213         int i, remain = FUZZY_MAX_RESULT - 1;
214         const struct blockhash_context *bh = self->blockhashes, *bhp;
215         /* Verify that our elimination was not overeager. */
216         assert(bs == MIN_BLOCKSIZE ||
217                         (size_t)bs / 2 * SPAMSUM_LENGTH < self->total_size);
218
219         /* Initial blocksize guess. */
220         while((size_t)bs * SPAMSUM_LENGTH < self->total_size) {
221                 bs *= 2;
222                 assert(bh->next != NULL);
223                 bh = bh->next;
224         }
225         /* Adapt blocksize guess to actual digest length. */
226         while(bs > self->start_blocksize && bh->dlen < SPAMSUM_LENGTH / 2) {
227                 bs /= 2;
228                 /* Slow version of bh = bh->prev; */
229                 for(bhp = self->blockhashes; bhp->next != bh; bhp = bhp->next)
230                         ;
231                 bh = bhp;
232         }
233         assert(bh != NULL);
234         assert(!(bs > MIN_BLOCKSIZE && bh->dlen < SPAMSUM_LENGTH / 2));
235
236         i = snprintf(result, (size_t)remain, "%u:", bs);
237         /* In theory snprintf can fail. It is unclear how though, so we assume
238          * that it doesn't for simplicity. */
239         assert(i > 0);
240         assert(i < remain);
241         remain -= i;
242         result += i;
243         i = (int)bh->dlen;
244         if(i > remain)
245                 i = remain;
246         memcpy(result, bh->digest, (size_t)i);
247         result += i;
248         remain -= i;
249         if(remain > 0 && h != 0) {
250                 *result++ = b64[bh->h % 64];
251                 --remain;
252         }
253         if(remain > 0) {
254                 *result++ = ':';
255                 --remain;
256         }
257         if(NULL != bh->next) {
258                 bh = bh->next;
259                 i = (int)bh->dlen;
260                 if(i > SPAMSUM_LENGTH / 2 - 1)
261                         i = SPAMSUM_LENGTH / 2 - 1;
262                 if(i > remain)
263                         i = remain;
264                 memcpy(result, bh->digest, (size_t)i);
265                 result += i;
266                 remain -= i;
267                 if(remain > 0 && h != 0) {
268                         *result++ = b64[bh->halfh % 64];
269                         --remain;
270                 }
271         } else if(remain > 0 && h != 0) {
272                 assert(bh->dlen == 0);
273                 *result++ = b64[bh->h % 64];
274                 --remain;
275         }
276         *result = '\0';
277 }
278
279 static void ssdeep_clear(struct ssdeep_context *self) {
280         struct blockhash_context *bh, *bhn;
281         bh = self->blockhashes;
282         while(bh) {
283                 bhn = bh->next;
284                 free(bh);
285                 bh = bhn;
286         }
287 }
288
289 int fuzzy_hash_buf(const unsigned char *buf, uint32_t buf_len,
290                 /*@out@*/ char *result) {
291         struct ssdeep_context ctx[1];
292         if(ssdeep_init(ctx) < 0)
293                 return -1;
294         if(ssdeep_engine(ctx, buf, buf_len) < 0) {
295                 ssdeep_clear(ctx);
296                 return -1;
297         }
298         ssdeep_digest(ctx, result);
299         ssdeep_clear(ctx);
300         return 0;
301 }
302
303 int fuzzy_hash_stream(FILE *handle, /*@out@*/ char *result) {
304         struct ssdeep_context ctx[1];
305         unsigned char buffer[4096];
306         size_t n;
307         if(ssdeep_init(ctx) < 0)
308                 return -1;
309         for(;;) {
310                 n = fread(buffer, 1, 4096, handle);
311                 if(0 == n)
312                         break;
313                 if(ssdeep_engine(ctx, buffer, n) < 0)
314                         goto errout;
315         }
316         if(ferror(handle) != 0)
317                 goto errout;
318         ssdeep_digest(ctx, result);
319         ssdeep_clear(ctx);
320         return 0;
321 errout:
322         ssdeep_clear(ctx);
323         return -1;
324 }
325
326 #ifdef S_SPLINT_S
327 typedef size_t off_t;
328 #endif
329
330 int fuzzy_hash_file(FILE *handle, /*@out@*/ char *result) {
331         off_t fpos;
332         int status;
333         fpos = ftello(handle);
334         if(fseek(handle, 0, SEEK_SET) < 0)
335                 return -1;
336         status = fuzzy_hash_stream(handle, result);
337         if(status == 0)
338                 if(fseeko(handle, fpos, SEEK_SET) < 0)
339                         return -1;
340         return status;
341 }
342
343 int fuzzy_hash_filename(const char *filename, /*@out@*/ char *result) {
344         int status;
345         FILE *handle = fopen(filename, "rb");
346         if(NULL == handle)
347                 return -1;
348         status = fuzzy_hash_stream(handle, result);
349         /* We cannot do anything about an fclose failure. */
350         (void)fclose(handle);
351         return status;
352 }
353
354 #ifdef S_SPLINT_S
355 extern /*@only@*/ /*@null@*/ char *realpath(const char *,
356                 /*@null@*/ const char *);
357 #endif
358
359 int main(int argc, char **argv) {
360         char digest[FUZZY_MAX_RESULT], *p;
361         int i;
362         puts("ssdeep,1.1--blocksize:hash:hash,filename");
363         for(i = 1; i < argc; ++i) {
364                 p = realpath(argv[i], NULL);
365                 if(p == NULL)
366                         return 1;
367                 if(fuzzy_hash_filename(argv[i], digest) < 0) {
368                         free(p);
369                         return 1;
370                 }
371                 printf("%s,\"%s\"\n", digest, p);
372                 free(p);
373         }
374         return 0;
375 }