e3aaff8e |
/* |
871177cd |
* Copyright (C) 2007-2009 Sourcefire, Inc. |
2023340a |
*
* Authors: Tomasz Kojm |
e3aaff8e |
*
* This program is free software; you can redistribute it and/or modify |
bb34cb31 |
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation. |
e3aaff8e |
*
* 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 |
48b7b4a7 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA. |
e3aaff8e |
*/
#ifndef __CLAMAV_H
#define __CLAMAV_H
#include <sys/types.h>
#include <sys/stat.h> |
b94e66c4 |
|
e3aaff8e |
#ifdef __cplusplus
extern "C"
{
#endif
#define CL_COUNT_PRECISION 4096
/* return codes */ |
871177cd |
typedef enum {
/* libclamav specific */
CL_CLEAN = 0,
CL_SUCCESS = 0,
CL_VIRUS,
CL_ENULLARG, |
2accc66f |
CL_EARG, |
871177cd |
CL_EMALFDB,
CL_ECVD,
CL_EVERIFY,
CL_EUNPACK, |
414abe87 |
|
871177cd |
/* I/O and memory errors */
CL_EOPEN,
CL_ECREAT,
CL_EUNLINK,
CL_ESTAT,
CL_EREAD,
CL_ESEEK,
CL_EWRITE,
CL_EDUP,
CL_EACCES,
CL_ETMPFILE,
CL_ETMPDIR,
CL_EMAP,
CL_EMEM, |
0378a9ab |
CL_ETIMEOUT, |
871177cd |
/* internal (not reported outside libclamav) */
CL_BREAK,
CL_EMAXREC,
CL_EMAXSIZE,
CL_EMAXFILES, |
8c0933ce |
CL_EFORMAT,
CL_EBYTECODE |
871177cd |
} cl_error_t; |
b5134815 |
|
f7470773 |
/* db options */ |
9f8098c0 |
#define CL_DB_PHISHING 0x2
#define CL_DB_PHISHING_URLS 0x8 |
70edb085 |
#define CL_DB_PUA 0x10 |
0c234f5f |
#define CL_DB_CVDNOTMP 0x20 /* obsolete */ |
b3df93db |
#define CL_DB_OFFICIAL 0x40 /* internal */ |
b023c36d |
#define CL_DB_PUA_MODE 0x80
#define CL_DB_PUA_INCLUDE 0x100
#define CL_DB_PUA_EXCLUDE 0x200 |
b3df93db |
#define CL_DB_COMPILED 0x400 /* internal */ |
99ca7f53 |
#define CL_DB_DIRECTORY 0x800 /* internal */ |
208ceae5 |
#define CL_DB_OFFICIAL_ONLY 0x1000 |
46e2863c |
#define CL_DB_BYTECODE 0x2000 |
de351ee1 |
#define CL_DB_SIGNED 0x4000 |
f7470773 |
|
b5134815 |
/* recommended db settings */ |
0c234f5f |
#define CL_DB_STDOPT (CL_DB_PHISHING | CL_DB_PHISHING_URLS | CL_DB_BYTECODE) |
cf85d0ca |
|
3805ebcb |
/* scan options */ |
26fbf6bd |
#define CL_SCAN_RAW 0x0
#define CL_SCAN_ARCHIVE 0x1
#define CL_SCAN_MAIL 0x2
#define CL_SCAN_OLE2 0x4
#define CL_SCAN_BLOCKENCRYPTED 0x8
#define CL_SCAN_HTML 0x10
#define CL_SCAN_PE 0x20
#define CL_SCAN_BLOCKBROKEN 0x40 |
6a4dd9dc |
#define CL_SCAN_MAILURL 0x80 /* ignored */ |
26fbf6bd |
#define CL_SCAN_BLOCKMAX 0x100 /* ignored */
#define CL_SCAN_ALGORITHMIC 0x200
#define CL_SCAN_PHISHING_BLOCKSSL 0x800 /* ssl mismatches, not ssl by itself*/
#define CL_SCAN_PHISHING_BLOCKCLOAK 0x1000
#define CL_SCAN_ELF 0x2000
#define CL_SCAN_PDF 0x4000
#define CL_SCAN_STRUCTURED 0x8000
#define CL_SCAN_STRUCTURED_SSN_NORMAL 0x10000
#define CL_SCAN_STRUCTURED_SSN_STRIPPED 0x20000 |
4270f93b |
#define CL_SCAN_PARTIAL_MESSAGE 0x40000 |
7f0d1148 |
#define CL_SCAN_HEURISTIC_PRECEDENCE 0x80000 |
b5134815 |
/* recommended scan settings */ |
e8637858 |
#define CL_SCAN_STDOPT (CL_SCAN_ARCHIVE | CL_SCAN_MAIL | CL_SCAN_OLE2 | CL_SCAN_PDF | CL_SCAN_HTML | CL_SCAN_PE | CL_SCAN_ALGORITHMIC | CL_SCAN_ELF) |
3805ebcb |
|
d46cdd59 |
/* cl_countsigs options */
#define CL_COUNTSIGS_OFFICIAL 0x1
#define CL_COUNTSIGS_UNOFFICIAL 0x2
#define CL_COUNTSIGS_ALL (CL_COUNTSIGS_OFFICIAL | CL_COUNTSIGS_UNOFFICIAL)
|
724b2bf7 |
struct cl_engine; |
99f817e7 |
struct cl_settings; |
3805ebcb |
|
724b2bf7 |
#define CL_INIT_DEFAULT 0x0 |
2accc66f |
extern int cl_init(unsigned int initoptions); |
e5916a51 |
|
b8fe70b3 |
extern struct cl_engine *cl_engine_new(void); |
2b459819 |
|
c45c4c3d |
enum cl_engine_field {
CL_ENGINE_MAX_SCANSIZE, /* uint64_t */
CL_ENGINE_MAX_FILESIZE, /* uint64_t */
CL_ENGINE_MAX_RECURSION, /* uint32_t */
CL_ENGINE_MAX_FILES, /* uint32_t */
CL_ENGINE_MIN_CC_COUNT, /* uint32_t */
CL_ENGINE_MIN_SSN_COUNT, /* uint32_t */ |
370892d0 |
CL_ENGINE_PUA_CATEGORIES, /* (char *) */ |
6396a96a |
CL_ENGINE_DB_OPTIONS, /* uint32_t */ |
370892d0 |
CL_ENGINE_DB_VERSION, /* uint32_t */ |
17799de2 |
CL_ENGINE_DB_TIME, /* time_t */ |
ab0d2f05 |
CL_ENGINE_AC_ONLY, /* uint32_t */
CL_ENGINE_AC_MINDEPTH, /* uint32_t */ |
33068e09 |
CL_ENGINE_AC_MAXDEPTH, /* uint32_t */
CL_ENGINE_TMPDIR, /* (char *) */ |
be43f951 |
CL_ENGINE_KEEPTMP, /* uint32_t */
CL_ENGINE_BYTECODE_SECURITY /* uint32_t */
};
enum bytecode_security {
CL_BYTECODE_TRUST_ALL=0, /* insecure, debug setting */
CL_BYTECODE_TRUST_SIGNED, /* default */
CL_BYTECODE_TRUST_NOTHING /* paranoid setting */ |
c45c4c3d |
}; |
a62ae54f |
|
2accc66f |
extern int cl_engine_set_num(struct cl_engine *engine, enum cl_engine_field field, long long num); |
bc93eda0 |
|
e4d9fb8e |
extern long long cl_engine_get_num(const struct cl_engine *engine, enum cl_engine_field field, int *err); |
2accc66f |
|
e4d9fb8e |
extern int cl_engine_set_str(struct cl_engine *engine, enum cl_engine_field field, const char *str); |
2accc66f |
|
e4d9fb8e |
extern const char *cl_engine_get_str(const struct cl_engine *engine, enum cl_engine_field field, int *err); |
7021b545 |
|
99f817e7 |
extern struct cl_settings *cl_engine_settings_copy(const struct cl_engine *engine);
extern int cl_engine_settings_apply(struct cl_engine *engine, const struct cl_settings *settings);
extern int cl_engine_settings_free(struct cl_settings *settings);
|
724b2bf7 |
extern int cl_engine_compile(struct cl_engine *engine); |
ed9753e9 |
|
b8fe70b3 |
extern int cl_engine_addref(struct cl_engine *engine); |
b023c36d |
|
724b2bf7 |
extern int cl_engine_free(struct cl_engine *engine); |
b94e66c4 |
|
e3aaff8e |
struct cl_stat {
char *dir;
struct stat *stattab; |
75ccac9f |
char **statdname; |
fe389c84 |
unsigned int entries; |
e3aaff8e |
};
|
b5134815 |
struct cl_cvd { /* field no. */
char *time; /* 2 */
unsigned int version; /* 3 */
unsigned int sigs; /* 4 */
unsigned int fl; /* 5 */ |
fe389c84 |
/* padding */ |
b5134815 |
char *md5; /* 6 */
char *dsig; /* 7 */
char *builder; /* 8 */
unsigned int stime; /* 9 */ |
8139fd99 |
};
|
e3aaff8e |
/* file scanning */ |
2accc66f |
extern int cl_scandesc(int desc, const char **virname, unsigned long int *scanned, const struct cl_engine *engine, unsigned int scanoptions); |
e3aaff8e |
|
2accc66f |
extern int cl_scanfile(const char *filename, const char **virname, unsigned long int *scanned, const struct cl_engine *engine, unsigned int scanoptions); |
e3aaff8e |
|
b5134815 |
/* database handling */ |
2accc66f |
extern int cl_load(const char *path, struct cl_engine *engine, unsigned int *signo, unsigned int dboptions); |
68a6f51f |
extern const char *cl_retdbdir(void); |
b5134815 |
/* engine handling */ |
e3aaff8e |
|
8000d078 |
/* CVD */ |
8139fd99 |
extern struct cl_cvd *cl_cvdhead(const char *file); |
e4ae7726 |
extern struct cl_cvd *cl_cvdparse(const char *head);
extern int cl_cvdverify(const char *file); |
8139fd99 |
extern void cl_cvdfree(struct cl_cvd *cvd);
|
b5134815 |
/* db dir stat functions */ |
e3aaff8e |
extern int cl_statinidir(const char *dirname, struct cl_stat *dbstat);
extern int cl_statchkdir(const struct cl_stat *dbstat);
extern int cl_statfree(struct cl_stat *dbstat);
|
d46cdd59 |
/* count signatures */
extern int cl_countsigs(const char *path, unsigned int countoptions, unsigned int *sigs);
|
b5134815 |
/* enable debug messages */ |
d4d14218 |
extern void cl_debug(void); |
e3aaff8e |
|
b5134815 |
/* software versions */
extern unsigned int cl_retflevel(void);
extern const char *cl_retver(void); |
e3aaff8e |
|
b5134815 |
/* others */ |
68a6f51f |
extern const char *cl_strerror(int clerror); |
e3aaff8e |
#ifdef __cplusplus |
23dc9e0b |
} |
e3aaff8e |
#endif
|
b5134815 |
#endif /* __CLAMAV_H */ |