commit scan options

Make Free() return Go error instead of C error code

.gitattributes

@@ -0,0 +1 @@
+*.yar linguist-vendored

README.md

@@ -34,6 +34,7 @@ sudo cmake --build . --target install
 For other Linux distributions, see [clamav documentation](https://docs.clamav.net/manual/Installing/Installing-from-source-Unix.html)
 
 ## Quick Start
+### Dynamic linking
 ```bash
 $ cd example && cat main.go
 ```
@@ -89,12 +90,31 @@ func main() {
 ```
 
 ```bash
-$ go run main.go
+$ CGO_LDFLAGS="-L/usr/local/lib -lclamav" go run main.go
 
 db load succeed: 9263
 209 YARA.Unix_Packer_UpxDetail.UNOFFICIAL Virus(es) detected
 ```
 
+If the `libclamav.so` file is not found, try it:
+
+```bash
+$ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib CGO_LDFLAGS="-L/usr/local/lib -lclamav" go run main.go
+
+db load succeed: 9263
+209 YARA.Unix_Packer_UpxDetail.UNOFFICIAL Virus(es) detected
+```
+
+### Static build
+```bash
+$ sudo bash ./prepare.sh
+$ SRCDIR=$(pwd)
+$ export CGO_CFLAGS="-g -Wall -I${SRCDIR}/clamav-mussels-cookbook/mussels/install/include"
+$ export CGO_LDFLAGS="-L${SRCDIR}/clamav-mussels-cookbook/mussels/install/lib -lclamav_static -lbz2_static -lclammspack_static -lclamunrar_iface_static -lclamunrar_static -lcrypto -ljson-c -lpcre2-8 -lpcre2-posix -lssl -lxml2 -lz -lm -ldl -lstdc++"
+$ CGO_ENABLED=1 go build --ldflags '--extldflags "-static -fpic"' main.go
+```
+
+
 ## Reference
 [mirtchovski/clamav](https://github.com/mirtchovski/clamav)
 

README_CN.md

@@ -34,6 +34,7 @@ sudo cmake --build . --target install
 其他 Linux 发行版参照 [clamav documentation](https://docs.clamav.net/manual/Installing/Installing-from-source-Unix.html)
 
 ## 快速开始
+### 动态链接
 ```bash
 $ cd example && cat main.go
 ```
@@ -89,12 +90,30 @@ func main() {
 ```
 
 ```bash
-$ go run main.go
+$ CGO_LDFLAGS="-L/usr/local/lib -lclamav" go run main.go
 
 db load succeed: 9263
 209 YARA.Unix_Packer_UpxDetail.UNOFFICIAL Virus(es) detected
 ```
 
+如果找不到 `libclamav.so` 文件，尝试如下：
+
+```bash
+$ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib CGO_LDFLAGS="-L/usr/local/lib -lclamav" go run main.go
+
+db load succeed: 9263
+209 YARA.Unix_Packer_UpxDetail.UNOFFICIAL Virus(es) detected
+```
+
+### 静态编译
+```bash
+$ sudo bash ./prepare.sh
+$ SRCDIR=$(pwd)
+$ export CGO_CFLAGS="-g -Wall -I${SRCDIR}/clamav-mussels-cookbook/mussels/install/include"
+$ export CGO_LDFLAGS="-L${SRCDIR}/clamav-mussels-cookbook/mussels/install/lib -lclamav_static -lbz2_static -lclammspack_static -lclamunrar_iface_static -lclamunrar_static -lcrypto -ljson-c -lpcre2-8 -lpcre2-posix -lssl -lxml2 -lz -lm -ldl -lstdc++"
+$ CGO_ENABLED=1 go build --ldflags '--extldflags "-static -fpic"' main.go
+```
+
 ## 参考
 [mirtchovski/clamav](https://github.com/mirtchovski/clamav)
 

clamav.go

@@ -5,9 +5,6 @@
 package goclamav
 
 /*
-#cgo CFLAGS: -g -Wall
-#cgo LDFLAGS: -L/usr/local/lib/ -lclamav
-
 #include <clamav.h>
 #include <stdlib.h>
 */
@@ -179,8 +176,12 @@ func (c *Clamav) EngineGetNum(field EngineField) (uint64, error) {
 
 // Free the memory allocated to clamav instance, Free should be called
 // when the engine is no longer in use.
-func (c *Clamav) Free() int {
+func (c *Clamav) Free() error {
-	return int(C.cl_engine_free((*C.struct_cl_engine)(c.engine)))
+	ret := ErrorCode(C.cl_engine_free((*C.struct_cl_engine)(c.engine)))
+	if ret == CL_SUCCESS {
+		return nil
+	}
+	return Strerr(ret)
 }
 
 // ScanMapCB scans custom data
@@ -201,7 +202,7 @@ func (c *Clamav) ScanMapCB(fmap *Fmap, fileName string, context interface{}) (ui
 	defer CloseMemory(fmap)
 	// clean
 	if ret == CL_SUCCESS {
-		return 0, "", nil
+		return uint(scanned), "", nil
 	}
 	// virus
 	if ret == CL_VIRUS {

define.go

@@ -1,9 +1,6 @@
 package goclamav
 
 /*
-#cgo CFLAGS: -g -Wall
-#cgo LDFLAGS: -L/usr/local/lib/ -lclamav
-
 #include <clamav.h>
 #include <stdlib.h>
 */
@@ -22,6 +19,54 @@ type SCAN_OPTIONS struct {
 	Dev       uint
 }
 
+const (
+	/* general */
+	CL_SCAN_GENERAL_ALLMATCHES           = 0x1  /* scan in all-match mode */
+	CL_SCAN_GENERAL_COLLECT_METADATA     = 0x2  /* collect metadata (--gen-json) */
+	CL_SCAN_GENERAL_HEURISTICS           = 0x4  /* option to enable heuristic alerts */
+	CL_SCAN_GENERAL_HEURISTIC_PRECEDENCE = 0x8  /* allow heuristic match to take precedence. */
+	CL_SCAN_GENERAL_UNPRIVILEGED         = 0x10 /* scanner will not have read access to files. */
+
+	/* parsing capabilities options */
+	CL_SCAN_PARSE_ARCHIVE = 0x1
+	CL_SCAN_PARSE_ELF     = 0x2
+	CL_SCAN_PARSE_PDF     = 0x4
+	CL_SCAN_PARSE_SWF     = 0x8
+	CL_SCAN_PARSE_HWP3    = 0x10
+	CL_SCAN_PARSE_XMLDOCS = 0x20
+	CL_SCAN_PARSE_MAIL    = 0x40
+	CL_SCAN_PARSE_OLE2    = 0x80
+	CL_SCAN_PARSE_HTML    = 0x100
+	CL_SCAN_PARSE_PE      = 0x200
+
+	/* heuristic alerting options */
+	CL_SCAN_HEURISTIC_BROKEN                  = 0x2    /* alert on broken PE and broken ELF files */
+	CL_SCAN_HEURISTIC_EXCEEDS_MAX             = 0x4    /* alert when files exceed scan limits (filesize, max scansize, or max recursion depth) */
+	CL_SCAN_HEURISTIC_PHISHING_SSL_MISMATCH   = 0x8    /* alert on SSL mismatches */
+	CL_SCAN_HEURISTIC_PHISHING_CLOAK          = 0x10   /* alert on cloaked URLs in emails */
+	CL_SCAN_HEURISTIC_MACROS                  = 0x20   /* alert on OLE2 files containing macros */
+	CL_SCAN_HEURISTIC_ENCRYPTED_ARCHIVE       = 0x40   /* alert if archive is encrypted (rar, zip, etc) */
+	CL_SCAN_HEURISTIC_ENCRYPTED_DOC           = 0x80   /* alert if a document is encrypted (pdf, docx, etc) */
+	CL_SCAN_HEURISTIC_PARTITION_INTXN         = 0x100  /* alert if partition table size doesn't make sense */
+	CL_SCAN_HEURISTIC_STRUCTURED              = 0x200  /* data loss prevention options, i.e. alert when detecting personal information */
+	CL_SCAN_HEURISTIC_STRUCTURED_SSN_NORMAL   = 0x400  /* alert when detecting social security numbers */
+	CL_SCAN_HEURISTIC_STRUCTURED_SSN_STRIPPED = 0x800  /* alert when detecting stripped social security numbers */
+	CL_SCAN_HEURISTIC_STRUCTURED_CC           = 0x1000 /* alert when detecting credit card numbers */
+	CL_SCAN_HEURISTIC_BROKEN_MEDIA            = 0x2000 /* alert if a file does not match the identified file format, works with JPEG, TIFF, GIF, PNG */
+
+	/* mail scanning options */
+	CL_SCAN_MAIL_PARTIAL_MESSAGE = 0x1
+
+	/* dev options */
+	CL_SCAN_DEV_COLLECT_SHA              = 0x1 /* Enables hash output in sha-collect builds - for internal use only */
+	CL_SCAN_DEV_COLLECT_PERFORMANCE_INFO = 0x2 /* collect performance timings */
+
+	/* cl_countsigs options */
+	CL_COUNTSIGS_OFFICIAL   = 0x1
+	CL_COUNTSIGS_UNOFFICIAL = 0x2
+	CL_COUNTSIGS_ALL        = (CL_COUNTSIGS_OFFICIAL | CL_COUNTSIGS_UNOFFICIAL)
+)
+
 // Fmap models in-memory files
 type Fmap C.cl_fmap_t
 
@@ -84,18 +129,6 @@ func Strerr(code ErrorCode) error {
 	return err
 }
 
-/* parsing capabilities options */
-const CL_SCAN_PARSE_ARCHIVE = C.CL_SCAN_PARSE_ARCHIVE
-const CL_SCAN_PARSE_ELF = C.CL_SCAN_PARSE_ELF
-const CL_SCAN_PARSE_PDF = C.CL_SCAN_PARSE_PDF
-const CL_SCAN_PARSE_SWF = C.CL_SCAN_PARSE_SWF
-const CL_SCAN_PARSE_HWP3 = C.CL_SCAN_PARSE_HWP3
-const CL_SCAN_PARSE_XMLDOCS = C.CL_SCAN_PARSE_XMLDOCS
-const CL_SCAN_PARSE_MAIL = C.CL_SCAN_PARSE_MAIL
-const CL_SCAN_PARSE_OLE2 = C.CL_SCAN_PARSE_OLE2
-const CL_SCAN_PARSE_HTML = C.CL_SCAN_PARSE_HTML
-const CL_SCAN_PARSE_PE = C.CL_SCAN_PARSE_PE
-
 /* db options */
 // clang-format off
 type DBOptions uint

example/prepare.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+# make static lib for clamav deps
+apt-get update
+apt-get install -y python3-pip
+apt-get install -y build-essential clang llvm
+apt-get install -y libstdc++6 libstdc++-6-dev
+apt-get install -y flex bison python3-dev pkg-config ninja-build
+python3 -m pip install mussels
+
+wget https://cmake.org/files/v3.21/cmake-3.21.5-linux-x86_64.tar.gz
+tar -zxvf cmake-3.21.5-linux-x86_64.tar.gz -C /usr/local/
+ln -s /usr/local/cmake-3.21.5-linux-x86_64/bin/cmake /usr/bin/cmake
+rm -rf cmake-3.21.5-linux-x86_64.tar.gz
+
+git clone --depth 1 https://github.com/ca110us/clamav-mussels-cookbook.git
+cd clamav-mussels-cookbook
+rm -rf  mussels/* &> /dev/null
+mkdir mussels &> /dev/null
+msl build libclamav_deps -t host-static -w mussels/work -i mussels/install
+cd -
+
+# make get clamav source code
+git clone https://github.com/Cisco-Talos/clamav.git
+cd clamav
+git checkout clamav-0.104.0
+cd -
+
+
+# libclamav
+cd clamav
+
+rm -rf  ./build/* &> /dev/null
+mkdir build &> /dev/null
+cd -
+export CLAMAV_DEPENDENCIES="$(pwd)/clamav-mussels-cookbook/mussels/install/"
+
+cd clamav/build
+
+cmake .. -G Ninja                                                      \
+    -DCMAKE_BUILD_TYPE="Release"                                       \
+    -DJSONC_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include/json-c"          \
+    -DJSONC_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libjson-c.a"             \
+    -DBZIP2_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include"                 \
+    -DBZIP2_LIBRARY_RELEASE="$CLAMAV_DEPENDENCIES/lib/libbz2_static.a" \
+    -DOPENSSL_ROOT_DIR="$CLAMAV_DEPENDENCIES"                          \
+    -DOPENSSL_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include"               \
+    -DOPENSSL_CRYPTO_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libcrypto.a"    \
+    -DOPENSSL_SSL_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libssl.a"          \
+    -DLIBXML2_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include/libxml2"       \
+    -DLIBXML2_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libxml2.a"             \
+    -DPCRE2_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include"                 \
+    -DPCRE2_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libpcre2-8.a"            \
+    -DZLIB_INCLUDE_DIR="$CLAMAV_DEPENDENCIES/include"                  \
+    -DZLIB_LIBRARY="$CLAMAV_DEPENDENCIES/lib/libz.a"                   \
+    -DENABLE_JSON_SHARED=OFF                                           \
+    -DENABLE_STATIC_LIB=ON                                             \
+    -DENABLE_SYSTEMD=OFF                                               \
+    -DENABLE_TESTS=OFF                                                 \
+    -DENABLE_LIBCLAMAV_ONLY=ON                                         \
+    -DENABLE_UNRAR=ON                                                  \
+    -DENABLE_SHARED_LIB=OFF                                            \
+    -DDATABASE_DIRECTORY=/var/lib/clamav                               \
+    -DCMAKE_INSTALL_PREFIX=install
+
+cmake --build .
+
+cd -
+
+rm -rf ./lib/*
+mkdir lib &> /dev/null
+cp clamav/build/libclamav/libclamav_static.a ./lib
+cp clamav/build/libclammspack/libclammspack_static.a ./lib
+cp clamav/build/libclamunrar/libclamunrar_static.a ./lib
+cp clamav/build/libclamunrar_iface/libclamunrar_iface_static.a ./lib
+
+cp "$CLAMAV_DEPENDENCIES/lib/libbz2_static.a" ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libjson-c.a" ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libcrypto.a" ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libssl.a" ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libxml2.a"  ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libpcre2-8.a"  ./lib
+cp "$CLAMAV_DEPENDENCIES/lib/libz.a" ./lib
+
+rm -rf ./include/*
+mkdir include &> /dev/null
+cp clamav/build/*.h ./include
+cp clamav/libclamav/clamav.h ./include
+
+cp ./include/* clamav-mussels-cookbook/mussels/install/include/
+cp ./lib/* clamav-mussels-cookbook/mussels/install/lib/