friedkiwi/go-clamav
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
ca110us 2022-03-23 18:47:29 +08:00
commit 547b470f29
13 changed files with 17450 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
.idea
.vscode

339
LICENSE Normal file
View File

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Go bindings for the ClamAV antivirus library (http://clamav.net)
Copyright (C) 2013 mirtchovski
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.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
{signature of Ty Coon}, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# go-clamav
go-clamav is go wrapper for [libclamav](https://docs.clamav.net/manual/Development/libclamav.html)
## Environment
### Ubuntu
```bash
apt-get update && apt-get install -y \
`# install tools` \
gcc make pkg-config python3 python3-pip python3-pytest valgrind \
`# install clamav dependencies` \
check libbz2-dev libcurl4-openssl-dev libjson-c-dev libmilter-dev \
libncurses5-dev libpcre2-dev libssl-dev libxml2-dev zlib1g-dev
python3 -m pip install --user cmake / apt-get install cmake
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Download the source from the clamav [downloads page](https://www.clamav.net/downloads)
```bash
tar xzf clamav-[ver].tar.gz
cd clamav-[ver]
mkdir build && cd build
cmake ..
cmake --build .
ctest
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
Refer to the `example` directory
## Reference
[mirtchovski/clamav](https://github.com/mirtchovski/clamav)
*This project was written because `mirtchovski/clamav` no longer supports the new version `clamav`*

43
README_CN.md Normal file
View File

@ -0,0 +1,43 @@
# go-clamav
go-clamav 是 go 语言对 [libclamav](https://docs.clamav.net/manual/Development/libclamav.html) 的封装
## 环境
### Ubuntu
```bash
apt-get update && apt-get install -y \
`# install tools` \
gcc make pkg-config python3 python3-pip python3-pytest valgrind \
`# install clamav dependencies` \
check libbz2-dev libcurl4-openssl-dev libjson-c-dev libmilter-dev \
libncurses5-dev libpcre2-dev libssl-dev libxml2-dev zlib1g-dev
python3 -m pip install --user cmake / apt-get install cmake
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Download the source from the clamav [downloads page](https://www.clamav.net/downloads)
```bash
tar xzf clamav-[ver].tar.gz
cd clamav-[ver]
mkdir build && cd build
cmake ..
cmake --build .
ctest
sudo cmake --build . --target install
```
其他 Linux 发行版参照 [clamav documentation](https://docs.clamav.net/manual/Installing/Installing-from-source-Unix.html)
## 快速开始
参考 `example` 目录
## 参考
[mirtchovski/clamav](https://github.com/mirtchovski/clamav)
*因为 `mirtchovski/clamav` 不再支持新版本 `clamav`，所以写了该项目*

304
clamav.go Normal file
View File

@ -0,0 +1,304 @@
// Use of this source code is governed by a
// license that can be found in the LICENSE file.
// Package clamav is go wrapper for libclamav see https://docs.clamav.net/manual/Development/libclamav.html
package goclamav
/*
#cgo CFLAGS: -g -Wall
#cgo LDFLAGS: -lclamav
#include <clamav.h>
#include <stdlib.h>
*/
import "C"
import (
"errors"
"fmt"
"os"
"sync"
"unsafe"
)
// Callback is used to store the interface passed to ScanFileCb. This
// object is then returned in each ClamAV callback for the duration of the
// file scan
type Callback struct {
sync.Mutex
nextID uintptr
cb map[unsafe.Pointer]interface{}
}
var callbacks = Callback{
cb: map[unsafe.Pointer]interface{}{},
}
func setContext(i interface{}) unsafe.Pointer {
cptr := C.malloc(1)
if cptr == nil {
panic("C malloc")
}
callbacks.Lock()
defer callbacks.Unlock()
callbacks.cb[cptr] = i
return cptr
}
func findContext(key unsafe.Pointer) interface{} {
callbacks.Lock()
defer callbacks.Unlock()
if v, ok := callbacks.cb[key]; ok {
return v
}
return nil
}
func deleteContext(key unsafe.Pointer) error {
callbacks.Lock()
defer callbacks.Unlock()
if _, ok := callbacks.cb[key]; ok {
delete(callbacks.cb, key)
C.free(key)
return nil
}
return errors.New("no context to delete")
}
type Clamav struct {
engine *C.struct_cl_engine
signo uint
options *C.struct_cl_scan_options
}
// Init new clamav instance
func (c *Clamav) Init(options SCAN_OPTIONS) error {
c.engine = (*C.struct_cl_engine)(C.cl_engine_new())
scanOptions := &C.struct_cl_scan_options{
general: C.uint(options.General),
heuristic: C.uint(options.Heuristic),
parse: C.uint(options.Parse),
mail: C.uint(options.Mail),
dev: C.uint(options.Dev),
}
c.options = scanOptions
ret := ErrorCode(C.cl_init(CL_INIT_DEFAULT))
if ret != CL_SUCCESS {
err := Strerr(ret)
return err
}
return nil
}
// Use the CvdVerify to verify a database directly:
// As the comment block explains, this will load-test the database. Be advised
// that for some larger databases, this may use a fair bit system RAM.
func (c *Clamav) CvdVerify(path string) error {
_, err := os.Stat(path)
existed := !os.IsNotExist(err)
if !existed {
err := errors.New(fmt.Sprintf("db %s is not exists!", path))
return err
}
fp := C.CString(path)
defer C.free(unsafe.Pointer(fp))
ret := ErrorCode(C.cl_cvdverify(fp))
if ret != CL_SUCCESS {
err := Strerr(ret)
return err
}
return nil
}
// Load clamav virus database
func (c *Clamav) LoadDB(path string, dbopts uint) (uint, error) {
_, err := os.Stat(path)
existed := !os.IsNotExist(err)
if !existed {
err := errors.New(fmt.Sprintf("db %s is not exists!", path))
return 0, err
}
var signo uint
fp := C.CString(path)
defer C.free(unsafe.Pointer(fp))
ret := ErrorCode(C.cl_load(fp, (*C.struct_cl_engine)(c.engine), (*C.uint)(unsafe.Pointer(&signo)), C.uint(dbopts)))
if ret != CL_SUCCESS {
err := Strerr(ret)
return 0, err
}
return signo, nil
}
// When all required databases are loaded you should prepare the detection engine by calling CompileEngine
func (c *Clamav) CompileEngine() error {
ret := ErrorCode(C.cl_engine_compile((*C.struct_cl_engine)(c.engine)))
if ret != CL_SUCCESS {
err := Strerr(ret)
return err
}
return nil
}
// SetNum sets a number in the specified field of the engine configuration.
// Certain fields accept only 32-bit numbers, silently truncating the higher bits
// of the engine config. See dat.go for more information.
func (c *Clamav) EngineSetNum(field EngineField, num uint64) error {
ret := ErrorCode(C.cl_engine_set_num((*C.struct_cl_engine)(c.engine), C.enum_cl_engine_field(field), C.longlong(num)))
if ret != CL_SUCCESS {
err := Strerr(ret)
return err
}
return nil
}
// GetNum acquires a number from the specified field of the engine configuration. Tests show that
// the ClamAV library will not overflow 32-bit fields, so a GetNum on a 32-bit field can safely be
// cast to uint32.
func (c *Clamav) EngineGetNum(field EngineField) (uint64, error) {
var ret ErrorCode
ne := (*C.struct_cl_engine)(c.engine)
num := uint64(C.cl_engine_get_num(ne, C.enum_cl_engine_field(field), (*C.int)(unsafe.Pointer(&ret))))
if ret != CL_SUCCESS {
err := Strerr(ret)
return num, err
}
return num, nil
}
// Free the memory allocated to clamav instance, Free should be called
// when the engine is no longer in use.
func (c *Clamav) Free() int {
return int(C.cl_engine_free((*C.struct_cl_engine)(c.engine)))
}
// ScanMapCb scans custom data
func (c *Clamav) ScanMapCB(fmap *Fmap, fileName string, context interface{}) (uint, string, error) {
var scanned C.ulong
var virusName *C.char
fn := C.CString(fileName)
defer C.free(unsafe.Pointer(fn))
// find where to store the context in our callback map. we do _not_ pass the context to
// C directly because aggressive garbage collection will move it around
ctx := setContext(context)
// cleanup
defer deleteContext(ctx)
ret := ErrorCode(C.cl_scanmap_callback((*C.cl_fmap_t)(fmap), fn, &virusName, &scanned, (*C.struct_cl_engine)(c.engine), (*C.struct_cl_scan_options)(c.options), unsafe.Pointer(ctx)))
defer CloseMemory(fmap)
// clean
if ret == CL_SUCCESS {
return 0, "", nil
}
// virus
if ret == CL_VIRUS {
return uint(scanned), C.GoString(virusName), Strerr(ret)
}
// error
return 0, "", Strerr(ret)
}
// ScanFile scans a single file for viruses using the ClamAV databases. It returns the number of bytes
// read from the file (if found), the virus name and an error code.
// If the file is clean, the virus name is empty and the error code is nil,but if the file is insecure, the
// error code is "Virus(es) detected" and virus name is the matching rule.
func (c *Clamav) ScanFile(path string) (uint, string, error) {
fp := C.CString(path)
defer C.free(unsafe.Pointer(fp))
var virusName *C.char
var scanned C.ulong
ret := ErrorCode(C.cl_scanfile(fp, &virusName, &scanned, (*C.struct_cl_engine)(c.engine), (*C.struct_cl_scan_options)(c.options)))
// clean
if ret == CL_SUCCESS {
return uint(scanned), "", nil
}
// virus
if ret == CL_VIRUS {
return uint(scanned), C.GoString(virusName), Strerr(ret)
}
// error
return 0, "", Strerr(ret)
}
// ScanFileCb scans a single file for viruses using the ClamAV databases and using callbacks from
// ClamAV to read/resolve file data. The callbacks can be used to scan files in memory, to scan multiple
// files inside archives, etc. The function returns the number of bytes
// read from the file (if found), the virus name and an error code.
// If the file is clean, the virus name is empty and the error code is nil,but if the file is insecure, the
// error code is "Virus(es) detected" and virus name is the matching rule.
// The context argument will be sent back to the callbacks, so effort must be made to retain it
// throughout the execution of the scan from garbage collection
func (c *Clamav) ScanFileCB(path string, context interface{}) (uint, string, error) {
fp := C.CString(path)
defer C.free(unsafe.Pointer(fp))
// find where to store the context in our callback map. we do _not_ pass the context to
// C directly because aggressive garbage collection will move it around
ctx := setContext(context)
// cleanup
defer deleteContext(ctx)
var virusName *C.char
var scanned C.ulong
ret := ErrorCode(C.cl_scanfile_callback(fp, &virusName, &scanned, (*C.struct_cl_engine)(c.engine), (*C.struct_cl_scan_options)(c.options), ctx))
// clean
if ret == CL_SUCCESS {
return 0, "", nil
}
// virus
if ret == CL_VIRUS {
return uint(scanned), C.GoString(virusName), Strerr(ret)
}
// error
return 0, "", Strerr(ret)
}
// ScanDesc scans a file descriptor for viruses using the ClamAV databases. It returns the number of bytes
// read from the file (if found), the virus name and an error code.
// If the file is clean, the virus name is empty and the error code is nil,but if the file is insecure, the
// error code is "Virus(es) detected" and virus name is the matching rule.
func (c *Clamav) ScanDesc(desc int32, fileName string) (uint, string, error) {
var scanned C.ulong
var virusName *C.char
fn := C.CString(fileName)
defer C.free(unsafe.Pointer(fn))
ret := ErrorCode(C.cl_scandesc(C.int(desc), fn, &virusName, &scanned, (*C.struct_cl_engine)(c.engine), (*C.struct_cl_scan_options)(c.options)))
// clean
if ret == CL_SUCCESS {
return 0, "", nil
}
// virus
if ret == CL_VIRUS {
return uint(scanned), C.GoString(virusName), Strerr(ret)
}
// error
return 0, "", Strerr(ret)
}
// OpenMemory creates an object from the given memory that can be scanned using ScanMapCb
func OpenMemory(start []byte) *Fmap {
return (*Fmap)(C.cl_fmap_open_memory(unsafe.Pointer(&start[0]), C.size_t(len(start))))
}
// CloseMemory destroys the fmap associated with an in-memory object
func CloseMemory(f *Fmap) {
C.cl_fmap_close((*C.cl_fmap_t)(f))
}

167
define.go Normal file
View File

@ -0,0 +1,167 @@
package goclamav
/*
#cgo CFLAGS: -g -Wall
#cgo LDFLAGS: -lclamav
#include <clamav.h>
#include <stdlib.h>
*/
import "C"
import "errors"
// ErrorCode models ClamAV errors
type ErrorCode C.cl_error_t
// scan options
type SCAN_OPTIONS struct {
General uint
Parse uint
Heuristic uint
Mail uint
Dev uint
}
// Fmap models in-memory files
type Fmap C.cl_fmap_t
const (
/* libclamav specific */
CL_CLEAN ErrorCode = C.CL_CLEAN
CL_SUCCESS ErrorCode = C.CL_SUCCESS
CL_VIRUS ErrorCode = C.CL_VIRUS
CL_ENULLARG ErrorCode = C.CL_ENULLARG
CL_EARG ErrorCode = C.CL_EARG
CL_EMALFDB ErrorCode = C.CL_EMALFDB
CL_ECVD ErrorCode = C.CL_ECVD
CL_EVERIFY ErrorCode = C.CL_EVERIFY
CL_EUNPACK ErrorCode = C.CL_EUNPACK
/* I/O and memory errors */
CL_EOPEN ErrorCode = C.CL_EOPEN
CL_ECREAT ErrorCode = C.CL_ECREAT
CL_EUNLINK ErrorCode = C.CL_EUNLINK
CL_ESTAT ErrorCode = C.CL_ESTAT
CL_EREAD ErrorCode = C.CL_EREAD
CL_ESEEK ErrorCode = C.CL_ESEEK
CL_EWRITE ErrorCode = C.CL_EWRITE
CL_EDUP ErrorCode = C.CL_EDUP
CL_EACCES ErrorCode = C.CL_EACCES
CL_ETMPFILE ErrorCode = C.CL_ETMPFILE
CL_ETMPDIR ErrorCode = C.CL_ETMPDIR
CL_EMAP ErrorCode = C.CL_EMAP
CL_EMEM ErrorCode = C.CL_EMEM
CL_ETIMEOUT ErrorCode = C.CL_ETIMEOUT
/* internal (not reported outside libclamav) */
CL_BREAK ErrorCode = C.CL_BREAK
CL_EMAXREC ErrorCode = C.CL_EMAXREC
CL_EMAXSIZE ErrorCode = C.CL_EMAXSIZE
CL_EMAXFILES ErrorCode = C.CL_EMAXFILES
CL_EFORMAT ErrorCode = C.CL_EFORMAT
CL_EPARSE ErrorCode = C.CL_EPARSE
CL_EBYTECODE ErrorCode = C.CL_EBYTECODE /* may be reported in testmode */
CL_EBYTECODE_TESTFAIL ErrorCode = C.CL_EBYTECODE_TESTFAIL /* may be reported in testmode */
/* c4w error codes */
CL_ELOCK ErrorCode = C.CL_ELOCK
CL_EBUSY ErrorCode = C.CL_EBUSY
CL_ESTATE ErrorCode = C.CL_ESTATE
CL_VERIFIED ErrorCode = C.CL_VERIFIED /* The binary has been deemed trusted */
CL_ERROR ErrorCode = C.CL_ERROR /* Unspecified / generic error */
/* no error codes below this line please */
CL_ELAST_ERROR ErrorCode = C.CL_ELAST_ERROR
)
// CL_INIT_DEFAULT is a macro that can be passed to cl_init() representing the default initialization settings
const CL_INIT_DEFAULT C.uint = C.CL_INIT_DEFAULT
// Wraps the corresponding error message
func Strerr(code ErrorCode) error {
err := errors.New(C.GoString(C.cl_strerror(C.int(code))))
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
const (
CL_DB_PHISHING DBOptions = C.CL_DB_PHISHING
CL_DB_PHISHING_URLS DBOptions = C.CL_DB_PHISHING_URLS
CL_DB_PUA DBOptions = C.CL_DB_PUA
CL_DB_CVDNOTMP DBOptions = C.CL_DB_CVDNOTMP /* obsolete */
CL_DB_OFFICIAL DBOptions = C.CL_DB_OFFICIAL /* internal */
CL_DB_PUA_MODE DBOptions = C.CL_DB_PUA_MODE
CL_DB_PUA_INCLUDE DBOptions = C.CL_DB_PUA_INCLUDE
CL_DB_PUA_EXCLUDE DBOptions = C.CL_DB_PUA_EXCLUDE
CL_DB_COMPILED DBOptions = C.CL_DB_COMPILED /* internal */
CL_DB_DIRECTORY DBOptions = C.CL_DB_DIRECTORY /* internal */
CL_DB_OFFICIAL_ONLY DBOptions = C.CL_DB_OFFICIAL_ONLY
CL_DB_BYTECODE DBOptions = C.CL_DB_BYTECODE
CL_DB_SIGNED DBOptions = C.CL_DB_SIGNED /* internal */
CL_DB_BYTECODE_UNSIGNED DBOptions = C.CL_DB_BYTECODE_UNSIGNED /* Caution: You should never run bytecode signatures from untrusted sources. Doing so may result in arbitrary code execution. */
CL_DB_UNSIGNED DBOptions = C.CL_DB_UNSIGNED /* internal */
CL_DB_BYTECODE_STATS DBOptions = C.CL_DB_BYTECODE_STATS
CL_DB_ENHANCED DBOptions = C.CL_DB_ENHANCED
CL_DB_PCRE_STATS DBOptions = C.CL_DB_PCRE_STATS
CL_DB_YARA_EXCLUDE DBOptions = C.CL_DB_YARA_EXCLUDE
CL_DB_YARA_ONLY DBOptions = C.CL_DB_YARA_ONLY
)
// EngineField selects a particular engine settings field
type EngineField C.enum_cl_engine_field
// Engine settings
const (
CL_ENGINE_MAX_SCANSIZE EngineField = C.CL_ENGINE_MAX_SCANSIZE /* uint64_t */
CL_ENGINE_MAX_FILESIZE EngineField = C.CL_ENGINE_MAX_FILESIZE /* uint64_t */
CL_ENGINE_MAX_RECURSION EngineField = C.CL_ENGINE_MAX_RECURSION /* uint32_t */
CL_ENGINE_MAX_FILES EngineField = C.CL_ENGINE_MAX_FILES /* uint32_t */
CL_ENGINE_MIN_CC_COUNT EngineField = C.CL_ENGINE_MIN_CC_COUNT /* uint32_t */
CL_ENGINE_MIN_SSN_COUNT EngineField = C.CL_ENGINE_MIN_SSN_COUNT /* uint32_t */
CL_ENGINE_PUA_CATEGORIES EngineField = C.CL_ENGINE_PUA_CATEGORIES /* (char *) */
CL_ENGINE_DB_OPTIONS EngineField = C.CL_ENGINE_DB_OPTIONS /* uint32_t */
CL_ENGINE_DB_VERSION EngineField = C.CL_ENGINE_DB_VERSION /* uint32_t */
CL_ENGINE_DB_TIME EngineField = C.CL_ENGINE_DB_TIME /* time_t */
CL_ENGINE_AC_ONLY EngineField = C.CL_ENGINE_AC_ONLY /* uint32_t */
CL_ENGINE_AC_MINDEPTH EngineField = C.CL_ENGINE_AC_MINDEPTH /* uint32_t */
CL_ENGINE_AC_MAXDEPTH EngineField = C.CL_ENGINE_AC_MAXDEPTH /* uint32_t */
CL_ENGINE_TMPDIR EngineField = C.CL_ENGINE_TMPDIR /* (char *) */
CL_ENGINE_KEEPTMP EngineField = C.CL_ENGINE_KEEPTMP /* uint32_t */
CL_ENGINE_BYTECODE_SECURITY EngineField = C.CL_ENGINE_BYTECODE_SECURITY /* uint32_t */
CL_ENGINE_BYTECODE_TIMEOUT EngineField = C.CL_ENGINE_BYTECODE_TIMEOUT /* uint32_t */
CL_ENGINE_BYTECODE_MODE EngineField = C.CL_ENGINE_BYTECODE_MODE /* uint32_t */
CL_ENGINE_MAX_EMBEDDEDPE EngineField = C.CL_ENGINE_MAX_EMBEDDEDPE /* uint64_t */
CL_ENGINE_MAX_HTMLNORMALIZE EngineField = C.CL_ENGINE_MAX_HTMLNORMALIZE /* uint64_t */
CL_ENGINE_MAX_HTMLNOTAGS EngineField = C.CL_ENGINE_MAX_HTMLNOTAGS /* uint64_t */
CL_ENGINE_MAX_SCRIPTNORMALIZE EngineField = C.CL_ENGINE_MAX_SCRIPTNORMALIZE /* uint64_t */
CL_ENGINE_MAX_ZIPTYPERCG EngineField = C.CL_ENGINE_MAX_ZIPTYPERCG /* uint64_t */
CL_ENGINE_FORCETODISK EngineField = C.CL_ENGINE_FORCETODISK /* uint32_t */
CL_ENGINE_DISABLE_CACHE EngineField = C.CL_ENGINE_DISABLE_CACHE /* uint32_t */
CL_ENGINE_DISABLE_PE_STATS EngineField = C.CL_ENGINE_DISABLE_PE_STATS /* uint32_t */
CL_ENGINE_STATS_TIMEOUT EngineField = C.CL_ENGINE_STATS_TIMEOUT /* uint32_t */
CL_ENGINE_MAX_PARTITIONS EngineField = C.CL_ENGINE_MAX_PARTITIONS /* uint32_t */
CL_ENGINE_MAX_ICONSPE EngineField = C.CL_ENGINE_MAX_ICONSPE /* uint32_t */
CL_ENGINE_MAX_RECHWP3 EngineField = C.CL_ENGINE_MAX_RECHWP3 /* uint32_t */
CL_ENGINE_MAX_SCANTIME EngineField = C.CL_ENGINE_MAX_SCANTIME /* uint32_t */
CL_ENGINE_PCRE_MATCH_LIMIT EngineField = C.CL_ENGINE_PCRE_MATCH_LIMIT /* uint64_t */
CL_ENGINE_PCRE_RECMATCH_LIMIT EngineField = C.CL_ENGINE_PCRE_RECMATCH_LIMIT /* uint64_t */
CL_ENGINE_PCRE_MAX_FILESIZE EngineField = C.CL_ENGINE_PCRE_MAX_FILESIZE /* uint64_t */
CL_ENGINE_DISABLE_PE_CERTS EngineField = C.CL_ENGINE_DISABLE_PE_CERTS /* uint32_t */
CL_ENGINE_PE_DUMPCERTS EngineField = C.CL_ENGINE_PE_DUMPCERTS /* uint32_t */
)

3394
example/db/main.ldb Normal file
View File

File diff suppressed because one or more lines are too long

5095
example/db/main.ndb Normal file
View File

File diff suppressed because it is too large Load Diff

8008
example/db/online_20220222.yar Normal file
View File

File diff suppressed because it is too large Load Diff

1
example/db/version Normal file
View File

@ -0,0 +1 @@
20220222

51
example/main.go Normal file
View File

@ -0,0 +1,51 @@
package main
import (
"fmt"
clamav "github.com/ca110us/go-clamav"
)
func main() {
// new clamav instance
c := new(clamav.Clamav)
err := c.Init(clamav.SCAN_OPTIONS{
General: 0,
Parse: clamav.CL_SCAN_PARSE_ARCHIVE | clamav.CL_SCAN_PARSE_ELF,
Heuristic: 0,
Mail: 0,
Dev: 0,
})
if err != nil {
panic(err)
}
// free clamav memory
defer c.Free()
// load db
signo, err := c.LoadDB("./db", uint(clamav.CL_DB_DIRECTORY))
if err != nil {
panic(err)
}
fmt.Println("db load succeed:", signo)
// compile engine
err = c.CompileEngine()
if err != nil {
panic(err)
}
c.EngineSetNum(clamav.CL_ENGINE_MAX_SCANSIZE, 1024*1024*40)
c.EngineSetNum(clamav.CL_ENGINE_PCRE_MAX_FILESIZE, 1024*1024*20)
c.EngineSetNum(clamav.CL_ENGINE_MAX_SCANTIME, 9000)
c.EngineSetNum(clamav.CL_ENGINE_PCRE_MATCH_LIMIT, 1000)
c.EngineSetNum(clamav.CL_ENGINE_PCRE_RECMATCH_LIMIT, 500)
// fmt.Println(c.EngineGetNum(clamav.CL_ENGINE_PCRE_RECMATCH_LIMIT))
// scan
scanned, msg, err := c.ScanFile("./test_file/nmap")
fmt.Println(scanned, msg, err)
}

BIN
example/test_file/nmap Normal file
View File

Binary file not shown.

3
go.mod Normal file
View File

@ -0,0 +1,3 @@
module github.com/ca110us/go-clamav
go 1.18