2009-02-25 19:49:26 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
|
|
2010-03-10 19:14:19 +01:00
|
|
|
<!--Converted with LaTeX2HTML 2008 (1.71)
|
2009-02-25 19:49:26 +00:00
|
|
|
original version by: Nikos Drakos, CBLU, University of Leeds
|
|
|
|
|
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
|
|
|
|
|
* with significant contributions from:
|
|
|
|
|
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
2014-05-21 11:15:21 -04:00
|
|
|
<TITLE>Data scan functions</TITLE>
|
|
|
|
|
<META NAME="description" CONTENT="Data scan functions">
|
2009-02-25 19:49:26 +00:00
|
|
|
<META NAME="keywords" CONTENT="clamdoc">
|
|
|
|
|
<META NAME="resource-type" CONTENT="document">
|
|
|
|
|
<META NAME="distribution" CONTENT="global">
|
|
|
|
|
|
2010-03-10 19:14:19 +01:00
|
|
|
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
|
2009-02-25 19:49:26 +00:00
|
|
|
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
|
|
|
|
|
|
|
|
|
|
<LINK REL="STYLESHEET" HREF="clamdoc.css">
|
|
|
|
|
|
|
|
|
|
<LINK REL="next" HREF="node58.html">
|
|
|
|
|
<LINK REL="previous" HREF="node56.html">
|
2014-05-21 11:15:21 -04:00
|
|
|
<LINK REL="up" HREF="node49.html">
|
2009-02-25 19:49:26 +00:00
|
|
|
<LINK REL="next" HREF="node58.html">
|
|
|
|
|
</HEAD>
|
|
|
|
|
|
|
|
|
|
<BODY >
|
|
|
|
|
|
|
|
|
|
<DIV CLASS="navigation"><!--Navigation Panel-->
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html971"
|
2009-02-25 19:49:26 +00:00
|
|
|
HREF="node58.html">
|
|
|
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html967"
|
|
|
|
|
HREF="node49.html">
|
2009-02-25 19:49:26 +00:00
|
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html961"
|
2009-02-25 19:49:26 +00:00
|
|
|
HREF="node56.html">
|
|
|
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html969"
|
2009-02-25 19:49:26 +00:00
|
|
|
HREF="node1.html">
|
|
|
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
|
|
|
<BR>
|
2014-05-21 11:15:21 -04:00
|
|
|
<B> Next:</B> <A NAME="tex2html972"
|
|
|
|
|
HREF="node58.html">Memory</A>
|
|
|
|
|
<B> Up:</B> <A NAME="tex2html968"
|
|
|
|
|
HREF="node49.html">API</A>
|
|
|
|
|
<B> Previous:</B> <A NAME="tex2html962"
|
|
|
|
|
HREF="node56.html">Database checks</A>
|
|
|
|
|
<B> <A NAME="tex2html970"
|
2009-02-25 19:49:26 +00:00
|
|
|
HREF="node1.html">Contents</A></B>
|
|
|
|
|
<BR>
|
|
|
|
|
<BR></DIV>
|
|
|
|
|
<!--End of Navigation Panel-->
|
|
|
|
|
|
2014-05-21 11:15:21 -04:00
|
|
|
<H3><A NAME="SECTION00073800000000000000">
|
|
|
|
|
Data scan functions</A>
|
|
|
|
|
</H3>
|
|
|
|
|
It's possible to scan a file or descriptor using:
|
|
|
|
|
<PRE>
|
|
|
|
|
int cl_scanfile(const char *filename, const char **virname,
|
|
|
|
|
unsigned long int *scanned, const struct cl_engine *engine,
|
|
|
|
|
unsigned int options);
|
|
|
|
|
|
|
|
|
|
int cl_scandesc(int desc, const char **virname, unsigned
|
|
|
|
|
long int *scanned, const struct cl_engine *engine,
|
|
|
|
|
unsigned int options);
|
|
|
|
|
</PRE>
|
|
|
|
|
Both functions will store a virus name under the pointer <code>virname</code>,
|
|
|
|
|
the virus name is part of the engine structure and must not be released
|
|
|
|
|
directly. If the third argument (<code>scanned</code>) is not NULL, the
|
|
|
|
|
functions will increase its value with the size of scanned data (in
|
|
|
|
|
<code>CL_COUNT_PRECISION</code> units).
|
|
|
|
|
The last argument (<code>options</code>) specified the scan options and supports
|
|
|
|
|
the following flags (which can be combined using bit operators):
|
2010-03-10 19:14:19 +01:00
|
|
|
|
|
|
|
|
<UL>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_STDOPT</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
This is an alias for a recommended set of scan options. You
|
|
|
|
|
should use it to make your software ready for new features
|
|
|
|
|
in the future versions of libclamav.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_RAW</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Use it alone if you want to disable support for special files.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_ARCHIVE</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
This flag enables transparent scanning of various archive formats.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_BLOCKENCRYPTED</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
With this flag the library will mark encrypted archives as viruses
|
|
|
|
|
(Encrypted.Zip, Encrypted.RAR).
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_MAIL</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enable support for mail files.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_OLE2</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enables support for OLE2 containers (used by MS Office and .msi
|
|
|
|
|
files).
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_PDF</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enables scanning within PDF files.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_SWF</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enables scanning within SWF files, notably compressed SWF.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_PE</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
This flag enables deep scanning of Portable Executable files and
|
|
|
|
|
allows libclamav to unpack executables compressed with run-time
|
|
|
|
|
unpackers.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_ELF</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enable support for ELF files.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_BLOCKBROKEN</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
libclamav will try to detect broken executables and mark them as
|
|
|
|
|
Broken.Executable.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_HTML</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
This flag enables HTML normalisation (including ScrEnc
|
|
|
|
|
decryption).
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_ALGORITHMIC</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enable algorithmic detection of viruses.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_PHISHING_BLOCKSSL</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Phishing module: always block SSL mismatches in URLs.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_PHISHING_BLOCKCLOAK</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Phishing module: always block cloaked URLs.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_STRUCTURED</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Enable the DLP module which scans for credit card and SSN
|
|
|
|
|
numbers.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_STRUCTURED_SSN_NORMAL</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Search for SSNs formatted as xx-yy-zzzz.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_STRUCTURED_SSN_STRIPPED</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Search for SSNs formatted as xxyyzzzz.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_PARTIAL_MESSAGE</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Scan RFC1341 messages split over many emails. You will need to
|
|
|
|
|
periodically clean up <code>$TemporaryDirectory/clamav-partial</code>
|
|
|
|
|
directory.
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
2014-05-21 11:15:21 -04:00
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_HEURISTIC_PRECEDENCE</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
Allow heuristic match to take precedence. When enabled, if
|
|
|
|
|
a heuristic scan (such as phishingScan) detects a possible
|
|
|
|
|
virus/phish it will stop scan immediately. Recommended, saves CPU
|
|
|
|
|
scan-time. When disabled, virus/phish detected by heuristic scans
|
|
|
|
|
will be reported only at the end of a scan. If an archive
|
|
|
|
|
contains both a heuristically detected virus/phishing, and a real
|
|
|
|
|
malware, the real malware will be reported.
|
|
|
|
|
</LI>
|
|
|
|
|
<LI><SPAN CLASS="textbf">CL_SCAN_BLOCKMACROS</SPAN>
|
|
|
|
|
<BR>
|
|
|
|
|
OLE2 containers, which contain VBA macros will be marked infected
|
|
|
|
|
(Heuristics.OLE2.ContainsMacros).
|
|
|
|
|
|
2010-03-10 19:14:19 +01:00
|
|
|
</LI>
|
|
|
|
|
</UL>
|
2014-05-21 11:15:21 -04:00
|
|
|
All functions return <code>CL_CLEAN</code> when the file seems clean,
|
|
|
|
|
<code>CL_VIRUS</code> when a virus is detected and another value on failure.
|
|
|
|
|
<PRE>
|
|
|
|
|
...
|
|
|
|
|
const char *virname;
|
|
|
|
|
|
|
|
|
|
if((ret = cl_scanfile("/tmp/test.exe", &virname, NULL, engine,
|
|
|
|
|
CL_SCAN_STDOPT)) == CL_VIRUS) {
|
|
|
|
|
printf("Virus detected: %s\n", virname);
|
|
|
|
|
} else {
|
|
|
|
|
printf("No virus detected.\n");
|
|
|
|
|
if(ret != CL_CLEAN)
|
|
|
|
|
printf("Error: %s\n", cl_strerror(ret));
|
|
|
|
|
}
|
|
|
|
|
</PRE>
|
2009-02-25 19:49:26 +00:00
|
|
|
|
|
|
|
|
<P>
|
2010-03-10 19:14:19 +01:00
|
|
|
|
|
|
|
|
<DIV CLASS="navigation"><HR>
|
|
|
|
|
<!--Navigation Panel-->
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html971"
|
2010-03-10 19:14:19 +01:00
|
|
|
HREF="node58.html">
|
|
|
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html967"
|
|
|
|
|
HREF="node49.html">
|
2010-03-10 19:14:19 +01:00
|
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html961"
|
2010-03-10 19:14:19 +01:00
|
|
|
HREF="node56.html">
|
|
|
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
2014-05-21 11:15:21 -04:00
|
|
|
<A NAME="tex2html969"
|
2010-03-10 19:14:19 +01:00
|
|
|
HREF="node1.html">
|
|
|
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
|
|
|
<BR>
|
2014-05-21 11:15:21 -04:00
|
|
|
<B> Next:</B> <A NAME="tex2html972"
|
|
|
|
|
HREF="node58.html">Memory</A>
|
|
|
|
|
<B> Up:</B> <A NAME="tex2html968"
|
|
|
|
|
HREF="node49.html">API</A>
|
|
|
|
|
<B> Previous:</B> <A NAME="tex2html962"
|
|
|
|
|
HREF="node56.html">Database checks</A>
|
|
|
|
|
<B> <A NAME="tex2html970"
|
2010-03-10 19:14:19 +01:00
|
|
|
HREF="node1.html">Contents</A></B> </DIV>
|
|
|
|
|
<!--End of Navigation Panel-->
|
2009-02-25 19:49:26 +00:00
|
|
|
<ADDRESS>
|
2014-05-21 11:15:21 -04:00
|
|
|
Cisco 2014-05-21
|
2009-02-25 19:49:26 +00:00
|
|
|
</ADDRESS>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
