rename functions and export them
[~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 #define NUM_BLOCKHASHES 31
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 SSDEEP_BS(index). The h and halfh members are the
94  * FNV hashes, where halfh stops to be reset after digest is SPAMSUM_LENGTH/2
95  * long. The halfh hash is needed be able to truncate digest for the second
96  * output hash to stay compatible with ssdeep output. */
97 struct blockhash_context {
98         uint32_t h, halfh;
99         char digest[SPAMSUM_LENGTH];
100         unsigned int dlen;
101 };
102
103 struct fuzzy_state {
104         unsigned int bhstart, bhend;
105         struct blockhash_context bh[NUM_BLOCKHASHES];
106         size_t total_size;
107         struct roll_state roll;
108 };
109
110 #define SSDEEP_BS(index) (((uint32_t)MIN_BLOCKSIZE) << (index))
111
112 /*@only@*/ /*@null@*/ struct fuzzy_state *fuzzy_new(void) {
113         struct fuzzy_state *self;
114         if(NULL == (self = malloc(sizeof(struct fuzzy_state))))
115                 return NULL;
116         self->bhstart = 0;
117         self->bhend = 1;
118         self->bh[0].h = HASH_INIT;
119         self->bh[0].halfh = HASH_INIT;
120         self->bh[0].dlen = 0;
121         self->total_size = 0;
122         roll_init(&self->roll);
123         return self;
124 }
125
126 static void fuzzy_try_fork_blockhash(struct fuzzy_state *self) {
127         struct blockhash_context *obh, *nbh;
128         if(self->bhend >= NUM_BLOCKHASHES)
129                 return;
130         assert(self->bhend > 0);
131         obh = self->bh + (self->bhend - 1);
132         nbh = obh + 1;
133         nbh->h = obh->h;
134         nbh->halfh = obh->halfh;
135         nbh->dlen = 0;
136         ++self->bhend;
137 }
138
139 static void fuzzy_try_reduce_blockhash(struct fuzzy_state *self) {
140         assert(self->bhstart < self->bhend);
141         if(self->bhend - self->bhstart < 2)
142                 /* Need at least two working hashes. */
143                 return;
144         if((size_t)SSDEEP_BS(self->bhstart) * SPAMSUM_LENGTH >=
145                         self->total_size)
146                 /* Initial blocksize estimate would select this or a smaller
147                  * blocksize. */
148                 return;
149         if(self->bh[self->bhstart + 1].dlen < SPAMSUM_LENGTH / 2)
150                 /* Estimate adjustment would select this blocksize. */
151                 return;
152         /* At this point we are clearly no longer interested in the
153          * start_blocksize. Get rid of it. */
154         ++self->bhstart;
155 }
156
157 static const char *b64 =
158         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
159
160 static void fuzzy_engine_step(struct fuzzy_state *self, unsigned char c) {
161         size_t h;
162         unsigned int i;
163         /* At each character we update the rolling hash and the normal hashes.
164          * When the rolling hash hits a reset value then we emit a normal hash
165          * as a element of the signature and reset the normal hash. */
166         roll_hash(&self->roll, c);
167         h = roll_sum(&self->roll);
168
169         for(i = self->bhstart; i < self->bhend; ++i) {
170                 self->bh[i].h = sum_hash(c, self->bh[i].h);
171                 self->bh[i].halfh = sum_hash(c, self->bh[i].halfh);
172         }
173
174         for(i = self->bhstart; i < self->bhend; ++i) {
175                 /* With growing blocksize almost no runs fail the next test. */
176                 if(likely(h % SSDEEP_BS(i) != SSDEEP_BS(i) - 1))
177                         /* Once this condition is false for one bs, it is
178                          * automatically false for all further bs. I.e. if
179                          * h === -1 (mod 2*bs) then h === -1 (mod bs). */
180                         break;
181                 /* We have hit a reset point. We now emit hashes which are
182                  * based on all characters in the piece of the message between
183                  * the last reset point and this one */
184                 if(unlikely(0 == self->bh[i].dlen)) {
185                         /* Can only happen 30 times. */
186                         /* First step for this blocksize. Clone next. */
187                         fuzzy_try_fork_blockhash(self);
188                 }
189                 if(self->bh[i].dlen < SPAMSUM_LENGTH - 1) {
190                         /* We can have a problem with the tail overflowing. The
191                          * easiest way to cope with this is to only reset the
192                          * normal hash if we have room for more characters in
193                          * our signature. This has the effect of combining the
194                          * last few pieces of the message into a single piece
195                          * */
196                         self->bh[i].digest[self->bh[i].dlen++] =
197                                 b64[self->bh[i].h % 64];
198                         self->bh[i].h = HASH_INIT;
199                         if(self->bh[i].dlen < SPAMSUM_LENGTH / 2)
200                                 self->bh[i].halfh = HASH_INIT;
201                 } else
202                         fuzzy_try_reduce_blockhash(self);
203         }
204 }
205
206 int fuzzy_update(struct fuzzy_state *self, const unsigned char *buffer,
207                 size_t buffer_size) {
208         self->total_size += buffer_size;
209         for( ;buffer_size > 0; ++buffer, --buffer_size)
210                 fuzzy_engine_step(self, *buffer);
211         return 0;
212 }
213
214 int fuzzy_digest(const struct fuzzy_state *self, /*@out@*/ char *result) {
215         unsigned int bi = self->bhstart;
216         uint32_t h = roll_sum(&self->roll);
217         int i, remain = FUZZY_MAX_RESULT - 1;
218         /* Verify that our elimination was not overeager. */
219         assert(bi == 0 || (size_t)SSDEEP_BS(bi) / 2 * SPAMSUM_LENGTH <
220                         self->total_size);
221
222         /* Initial blocksize guess. */
223         while((size_t)SSDEEP_BS(bi) * SPAMSUM_LENGTH < self->total_size) {
224                 ++bi;
225                 if(bi >= self->bhend)
226                         /* The input exceeds data types. */
227                         return -1;
228         }
229         /* Adapt blocksize guess to actual digest length. */
230         while(bi > self->bhstart && self->bh[bi].dlen < SPAMSUM_LENGTH / 2)
231                 --bi;
232         assert(!(bi > 0 && self->bh[bi].dlen < SPAMSUM_LENGTH / 2));
233
234         i = snprintf(result, (size_t)remain, "%u:", SSDEEP_BS(bi));
235         if(i <= 0)
236                 return -1;
237         assert(i < remain);
238         remain -= i;
239         result += i;
240         i = (int)self->bh[bi].dlen;
241         if(i > remain)
242                 i = remain;
243         memcpy(result, self->bh[bi].digest, (size_t)i);
244         result += i;
245         remain -= i;
246         if(remain > 0 && h != 0) {
247                 *result++ = b64[self->bh[bi].h % 64];
248                 --remain;
249         }
250         if(remain > 0) {
251                 *result++ = ':';
252                 --remain;
253         }
254         if(bi < self->bhend - 1) {
255                 ++bi;
256                 i = (int)self->bh[bi].dlen;
257                 if(i > SPAMSUM_LENGTH / 2 - 1)
258                         i = SPAMSUM_LENGTH / 2 - 1;
259                 if(i > remain)
260                         i = remain;
261                 memcpy(result, self->bh[bi].digest, (size_t)i);
262                 result += i;
263                 remain -= i;
264                 if(remain > 0 && h != 0) {
265                         *result++ = b64[self->bh[bi].halfh % 64];
266                         --remain;
267                 }
268         } else if(remain > 0 && h != 0) {
269                 assert(self->bh[bi].dlen == 0);
270                 *result++ = b64[self->bh[bi].h % 64];
271                 --remain;
272         }
273         *result = '\0';
274         return 0;
275 }
276
277 void fuzzy_free(/*@only@*/ struct fuzzy_state *self) {
278         free(self);
279 }
280
281 int fuzzy_hash_buf(const unsigned char *buf, uint32_t buf_len,
282                 /*@out@*/ char *result) {
283         struct fuzzy_state *ctx;
284         int ret = -1;
285         if(NULL == (ctx = fuzzy_new()))
286                 return -1;
287         if(fuzzy_update(ctx, buf, buf_len) < 0)
288                 goto out;
289         if(fuzzy_digest(ctx, result) < 0)
290                 goto out;
291         ret = 0;
292 out:
293         fuzzy_free(ctx);
294         return ret;
295 }
296
297 int fuzzy_hash_stream(FILE *handle, /*@out@*/ char *result) {
298         struct fuzzy_state *ctx;
299         unsigned char buffer[4096];
300         size_t n;
301         int ret = -1;
302         if(NULL == (ctx = fuzzy_new()))
303                 return -1;
304         for(;;) {
305                 n = fread(buffer, 1, 4096, handle);
306                 if(0 == n)
307                         break;
308                 if(fuzzy_update(ctx, buffer, n) < 0)
309                         goto out;
310         }
311         if(ferror(handle) != 0)
312                 goto out;
313         if(fuzzy_digest(ctx, result) < 0)
314                 goto out;
315         ret = 0;
316 out:
317         fuzzy_free(ctx);
318         return ret;
319 }
320
321 #ifdef S_SPLINT_S
322 typedef size_t off_t;
323 int fseeko(FILE *, off_t, int);
324 off_t ftello(FILE *);
325 #endif
326
327 int fuzzy_hash_file(FILE *handle, /*@out@*/ char *result) {
328         off_t fpos;
329         int status;
330         fpos = ftello(handle);
331         if(fseek(handle, 0, SEEK_SET) < 0)
332                 return -1;
333         status = fuzzy_hash_stream(handle, result);
334         if(status == 0)
335                 if(fseeko(handle, fpos, SEEK_SET) < 0)
336                         return -1;
337         return status;
338 }
339
340 int fuzzy_hash_filename(const char *filename, /*@out@*/ char *result) {
341         int status;
342         FILE *handle = fopen(filename, "rb");
343         if(NULL == handle)
344                 return -1;
345         status = fuzzy_hash_stream(handle, result);
346         /* We cannot do anything about an fclose failure. */
347         (void)fclose(handle);
348         return status;
349 }
350