libclamav/blob.c
b151ef55
 /*
  *  Copyright (C) 2002 Nigel Horne <njh@bandsman.co.uk>
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation; either version 2 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
9c8806fb
 static	char	const	rcsid[] = "$Id: blob.c,v 1.40 2005/04/04 13:52:46 nigelhorne Exp $";
8b242bb9
 
 #if HAVE_CONFIG_H
 #include "clamav-config.h"
 #endif
b151ef55
 
1e06e1ab
 #include <stdio.h>
b151ef55
 #include <stdlib.h>
 #include <string.h>
1e06e1ab
 #include <errno.h>
b566d781
 #include <fcntl.h>
1e06e1ab
 
5eeffbb9
 #include <sys/param.h>	/* for NAME_MAX */
1e06e1ab
 
88d3f0be
 #ifdef	C_DARWIN
b151ef55
 #include <sys/types.h>
 #endif
1e06e1ab
 
b151ef55
 #include "mbox.h"
 #include "blob.h"
 #include "others.h"
 
 #ifndef	CL_DEBUG
 #define	NDEBUG	/* map CLAMAV debug onto standard */
 #endif
 
7f80268d
 #ifndef	O_BINARY
 #define	O_BINARY	0
 #endif
 
b151ef55
 #include <assert.h>
 
df78d3be
 #ifdef	C_MINGW
 #include <windows.h>
 #endif
 
b151ef55
 blob *
 blobCreate(void)
 {
 #ifdef	CL_DEBUG
 	blob *b = (blob *)cli_calloc(1, sizeof(blob));
b23b3379
 	if(b)
df78d3be
 		b->magic = BLOBCLASS;
27a375f2
 	cli_dbgmsg("blobCreate\n");
b151ef55
 	return b;
 #else
 	return (blob *)cli_calloc(1, sizeof(blob));
 #endif
 }
 
 void
 blobDestroy(blob *b)
 {
27a375f2
 #ifdef	CL_DEBUG
 	cli_dbgmsg("blobDestroy %d\n", b->magic);
 #else
 	cli_dbgmsg("blobDestroy\n");
 #endif
 
b151ef55
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 
 	if(b->name)
 		free(b->name);
 	if(b->data)
 		free(b->data);
 #ifdef	CL_DEBUG
df78d3be
 	b->magic = INVALIDCLASS;
b151ef55
 #endif
 	free(b);
 }
 
 void
 blobArrayDestroy(blob *blobList[], int n)
 {
4d9c0ca8
 	assert(blobList != NULL);
 
27a375f2
 	while(--n >= 0) {
 		cli_dbgmsg("blobArrayDestroy: %d\n", n);
 		if(blobList[n]) {
 			blobDestroy(blobList[n]);
 			blobList[n] = NULL;
 		}
 	}
b151ef55
 }
 
e6b25cd3
 /*ARGSUSED*/
b151ef55
 void
e6b25cd3
 blobSetFilename(blob *b, const char *dir, const char *filename)
b151ef55
 {
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 	assert(filename != NULL);
 
f92f5b94
 	cli_dbgmsg("blobSetFilename: %s\n", filename);
 
b151ef55
 	if(b->name)
 		free(b->name);
 
f92f5b94
 	b->name = strdup(filename);
b151ef55
 
f92f5b94
 	if(b->name)
 		sanitiseName(b->name);
b151ef55
 }
 
 const char *
 blobGetFilename(const blob *b)
 {
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 
1e06e1ab
 	return b->name;
b151ef55
 }
 
9c8806fb
 int
b151ef55
 blobAddData(blob *b, const unsigned char *data, size_t len)
 {
4d9c0ca8
 #ifdef	HAVE_GETPAGESIZE
0d252351
 	static int pagesize;
 	int growth;
4d9c0ca8
 #endif
 
b151ef55
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 	assert(data != NULL);
 
 	if(len == 0)
9c8806fb
 		return 0;
b151ef55
 
c7256385
 	if(b->isClosed) {
 		/*
 		 * Should be cli_dbgmsg, but I want to see them for now,
 		 * and cli_dbgmsg doesn't support debug levels
 		 */
 		cli_warnmsg("Reopening closed blob\n");
 		b->isClosed = 0;
 	}
4d9c0ca8
 	/*
 	 * The payoff here is between reducing the number of calls to
 	 * malloc/realloc and not overallocating memory. A lot of machines
 	 * are more tight with memory than one may imagine which is why
 	 * we don't just allocate a *huge* amount and be done with it. Closing
 	 * the blob helps because that reclaims memory. If you know the maximum
 	 * size of a blob before you start adding data, use blobGrow() that's
 	 * the most optimum
 	 */
 #ifdef	HAVE_GETPAGESIZE
0d252351
 	if(pagesize == 0) {
 		pagesize = getpagesize();
 		if(pagesize == 0)
 			pagesize = 4096;
 	}
 	growth = pagesize;
4e47c534
 	if(len >= (size_t)pagesize)
0d252351
 		growth = ((len / pagesize) + 1) * pagesize;
 
 	/*printf("len %u, growth = %u\n", len, growth);*/
 
4d9c0ca8
 	if(b->data == NULL) {
 		assert(b->len == 0);
 		assert(b->size == 0);
 
0d252351
 		b->size = growth;
 		b->data = cli_malloc(growth);
4d9c0ca8
 	} else if(b->size < b->len + len) {
0d252351
 		unsigned char *p = cli_realloc(b->data, b->size + growth);
4d9c0ca8
 
 		if(p == NULL)
9c8806fb
 			return -1;
4d9c0ca8
 
0d252351
 		b->size += growth;
4d9c0ca8
 		b->data = p;
 	}
 #else
b151ef55
 	if(b->data == NULL) {
 		assert(b->len == 0);
02c9dc2a
 		assert(b->size == 0);
 
b151ef55
 		b->size = len * 4;
 		b->data = cli_malloc(b->size);
 	} else if(b->size < b->len + len) {
c42ab0b0
 		unsigned char *p = cli_realloc(b->data, b->size + (len * 4));
 
 		if(p == NULL)
9c8806fb
 			return -1;
c42ab0b0
 
02c9dc2a
 		b->size += len * 4;
c42ab0b0
 		b->data = p;
b151ef55
 	}
4d9c0ca8
 #endif
b151ef55
 
b23b3379
 	if(b->data) {
 		memcpy(&b->data[b->len], data, len);
 		b->len += len;
 	}
9c8806fb
 	return 0;
b151ef55
 }
 
6a91c55b
 unsigned char *
b151ef55
 blobGetData(const blob *b)
 {
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 
2c66271b
 	if(b->len == 0)
 		return NULL;
b151ef55
 	return(b->data);
 }
 
 unsigned long
 blobGetDataSize(const blob *b)
 {
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
b151ef55
 
 	return(b->len);
 }
c7256385
 
 void
 blobClose(blob *b)
 {
4d9c0ca8
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
4fabe242
 
 	if(b->isClosed) {
 		cli_dbgmsg("Attempt to close a previously closed blob\n");
 		return;
 	}
4d9c0ca8
 
8a88fb93
 	/*
 	 * Nothing more is going to be added to this blob. If it'll save more
 	 * than a trivial amount (say 64 bytes) of memory, shrink the allocation
 	 */
 	if((b->size - b->len) >= 64) {
4d9c0ca8
 		if(b->len == 0) {	/* Not likely */
 			free(b->data);
 			b->data = NULL;
 			cli_dbgmsg("blobClose: recovered all %u bytes\n",
 				b->size);
 			b->size = 0;
 		} else {
 			unsigned char *ptr = cli_realloc(b->data, b->len);
 
 			if(ptr == NULL)
 				return;
 
 			cli_dbgmsg("blobClose: recovered %u bytes from %u\n",
 				b->size - b->len, b->size);
 			b->size = b->len;
 			b->data = ptr;
 		}
c7256385
 	}
8114307c
 	b->isClosed = 1;
c7256385
 }
 
 /*
  * Returns 0 if the blobs are the same
  */
 int
 blobcmp(const blob *b1, const blob *b2)
 {
 	unsigned long s1, s2;
 
 	assert(b1 != NULL);
 	assert(b2 != NULL);
 
 	if(b1 == b2)
 		return 0;
 
 	s1 = blobGetDataSize(b1);
 	s2 = blobGetDataSize(b2);
 
 	if(s1 != s2)
 		return 1;
 
4d9c0ca8
 	if((s1 == 0) && (s2 == 0))
 		return 0;
 
c7256385
 	return memcmp(blobGetData(b1), blobGetData(b2), s1);
 }
02c9dc2a
 
a6d49269
 /*
  * Return clamav return code
  */
 int
02c9dc2a
 blobGrow(blob *b, size_t len)
 {
 	assert(b != NULL);
df78d3be
 	assert(b->magic == BLOBCLASS);
02c9dc2a
 
 	if(len == 0)
a6d49269
 		return 0;
02c9dc2a
 
 	if(b->isClosed) {
 		/*
 		 * Should be cli_dbgmsg, but I want to see them for now,
 		 * and cli_dbgmsg doesn't support debug levels
 		 */
 		cli_warnmsg("Growing closed blob\n");
 		b->isClosed = 0;
 	}
 	if(b->data == NULL) {
 		assert(b->len == 0);
 		assert(b->size == 0);
 
 		b->data = cli_malloc(len);
8114307c
 		if(b->data)
 			b->size = len;
02c9dc2a
 	} else {
8114307c
 		unsigned char *ptr = cli_realloc(b->data, b->size + len);
 
 		if(ptr) {
 			b->size += len;
 			b->data = ptr;
 		}
02c9dc2a
 	}
a6d49269
 
 	return (b->data) ? 0 : CL_EMEM;
02c9dc2a
 }
1e06e1ab
 
 fileblob *
 fileblobCreate(void)
 {
 #ifdef	CL_DEBUG
 	fileblob *fb = (fileblob *)cli_calloc(1, sizeof(fileblob));
 	if(fb)
df78d3be
 		fb->b.magic = BLOBCLASS;
1e06e1ab
 	cli_dbgmsg("blobCreate\n");
 	return fb;
 #else
 	return (fileblob *)cli_calloc(1, sizeof(fileblob));
 #endif
 }
 
 void
 fileblobDestroy(fileblob *fb)
 {
 	assert(fb != NULL);
11d01b40
 	assert(fb->b.magic == BLOBCLASS);
1e06e1ab
 
84a3c2c2
 	if(fb->b.name && fb->fp) {
11d01b40
 		fclose(fb->fp);
 		cli_dbgmsg("fileblobDestroy: %s\n", fb->b.name);
 		if(!fb->isNotEmpty) {
4d9c0ca8
 			cli_dbgmsg("fileblobDestroy: not saving empty file\n");
 			unlink(fb->b.name);
 		}
1e06e1ab
 		free(fb->b.name);
 
 		assert(fb->b.data == NULL);
 	} else if(fb->b.data) {
 		cli_errmsg("fileblobDestroy: file not saved: report to bugs@clamav.net\n");
 		free(fb->b.data);
84a3c2c2
 		if(fb->b.name)
 			free(fb->b.name);
1e06e1ab
 	}
11d01b40
 #ifdef	CL_DEBUG
 	fb->b.magic = INVALIDCLASS;
 #endif
1e06e1ab
 	free(fb);
 }
 
 void
 fileblobSetFilename(fileblob *fb, const char *dir, const char *filename)
 {
 	int fd;
 	char fullname[NAME_MAX + 1];
 
 	if(fb->b.name)
 		return;
 
bb1e30f6
 	assert(filename != NULL);
 	assert(dir != NULL);
 
e6b25cd3
 	blobSetFilename(&fb->b, dir, filename);
1e06e1ab
 
 	/*
 	 * Reload the filename, it may be different from the one we've
 	 * asked for, e.g. '/'s taken out
 	 */
 	filename = blobGetFilename(&fb->b);
 
bb1e30f6
 	assert(filename != NULL);
 
3d68da87
 #ifdef	C_QNX6
 	/*
 	 * QNX6 support from mikep@kaluga.org to fix bug where mkstemp
 	 * can return ETOOLONG even when the file name isn't too long
 	 */
 	snprintf(fullname, sizeof(fullname), "%s/clamavtmpXXXXXXXXXXXXX", dir);
 #else
11d01b40
 	snprintf(fullname, sizeof(fullname) - 1, "%s/%.*sXXXXXX", dir,
 		(int)(sizeof(fullname) - 9 - strlen(dir)), filename);
3d68da87
 #endif
 
f0635204
 #if    defined(C_LINUX) || defined(C_BSD) || defined(HAVE_MKSTEMP) || defined(C_SOLARIS) || defined(C_CYGWIN) || defined(C_QNX6) || defined(C_KFREEBSD_GNU)
0d252351
 	cli_dbgmsg("fileblobSetFilename: mkstemp(%s)\n", fullname);
1e06e1ab
 	fd = mkstemp(fullname);
 #else
0703b66f
 	cli_dbgmsg("fileblobSetFilename: mktemp(%s)\n", fullname);
1e06e1ab
 	(void)mktemp(fullname);
 	fd = open(fullname, O_WRONLY|O_CREAT|O_EXCL|O_TRUNC|O_BINARY, 0600);
 #endif
 
 	if(fd < 0) {
 		cli_errmsg("Can't create temporary file %s: %s\n", fullname, strerror(errno));
11d01b40
 		cli_dbgmsg("%d %d\n", sizeof(fullname), strlen(fullname));
1e06e1ab
 		return;
 	}
 
 	cli_dbgmsg("Saving attachment as %s\n", fullname);
 
 	fb->fp = fdopen(fd, "wb");
 
 	if(fb->fp == NULL) {
 		cli_errmsg("Can't create file %s: %s\n", fullname, strerror(errno));
11d01b40
 		cli_dbgmsg("%d %d\n", sizeof(fullname), strlen(fullname));
1e06e1ab
 		close(fd);
 
 		return;
 	}
 	if(fb->b.data) {
 		if(fwrite(fb->b.data, fb->b.len, 1, fb->fp) != 1)
9c8806fb
 			cli_errmsg("fileblobSetFilename: Can't write to temporary file %s: %s\n", fullname, strerror(errno));
11d01b40
 		else
 			fb->isNotEmpty = 1;
1e06e1ab
 		free(fb->b.data);
 		fb->b.data = NULL;
 		fb->b.len = fb->b.size = 0;
 	}
 }
 
9c8806fb
 int
1e06e1ab
 fileblobAddData(fileblob *fb, const unsigned char *data, size_t len)
 {
 	if(len == 0)
9c8806fb
 		return 0;
1e06e1ab
 
11d01b40
 	assert(data != NULL);
 
1e06e1ab
 	if(fb->fp) {
9c8806fb
 		if(fwrite(data, len, 1, fb->fp) != 1) {
1e06e1ab
 			cli_errmsg("fileblobAddData: Can't write %u bytes to temporary file %s: %s\n", len, fb->b.name, strerror(errno));
9c8806fb
 			return -1;
 		}
 		fb->isNotEmpty = 1;
 		return 0;
 	}
 	return blobAddData(&(fb->b), data, len);
1e06e1ab
 }
 
 const char *
 fileblobGetFilename(const fileblob *fb)
 {
 	return blobGetFilename(&(fb->b));
 }
f92f5b94
 
 /*
  * Different operating systems allow different characters in their filenames
a8dbefcd
  * FIXME: What does QNX want? There is no #ifdef C_QNX, but if there were
  *	it may be best to treat it like MSDOS
f92f5b94
  */
 void
 sanitiseName(char *name)
 {
 	while(*name) {
 #ifdef	C_DARWIN
 		*name &= '\177';
88d3f0be
 #endif
eae54f60
 		/* Also check for tab - "Heinz Martin" <Martin@hemag.ch> */
9b0deb31
 #if	defined(MSDOS) || defined(C_CYGWIN) || defined(WIN32) || defined(C_OS2)
eae54f60
 		if(strchr("/*?<>|\\\"+=,;:\t ", *name))
f92f5b94
 #else
 		if(*name == '/')
 #endif
 			*name = '_';
 		name++;
 	}
 }