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