eagleas / clamav
watch download tarball
public
Forks1Right
Watchers4Right
Description: ClamAV Ruby bindings
Homepage:
Clone URL: git://github.com/eagleas/clamav.git
clamav /
name age
history
message
file .gitignore Mon Apr 06 10:44:59 -0700 2009 .gitignore [eagleas]
file ChangeLog Tue Apr 07 10:06:15 -0700 2009 Version 0.3.0 [eagleas]
file README.rdoc Tue Apr 07 10:26:37 -0700 2009 Fix README.rdoc [eagleas]
directory ext/ Tue Apr 07 08:06:55 -0700 2009 Add optional db_options to new() [eagleas]
file rakefile Tue Apr 07 10:06:15 -0700 2009 Version 0.3.0 [eagleas]
directory spec/ Tue Apr 07 09:25:26 -0700 2009 Add ClamAV#signo spec [eagleas]
directory tools/ Mon Aug 04 08:09:45 -0700 2008 Initial commit [eagleas]
README.rdoc

ClamAV

ClamAV Ruby binding gem.

INSTALL:

$ sudo gem install clamav

REQUIREMENTS:

clamav >= 0.95, libclamav6, libclamav-dev

SYNOPSIS:

ClamAV.new([options[, db_options]])

  return:
    ClamAV instance

Options:

  • CL_SCAN_STDOPT (default) equal CL_SCAN_ARCHIVE | CL_SCAN_MAIL | CL_SCAN_OLE2 | CL_SCAN_PDF | CL_SCAN_HTML | CL_SCAN_PE | CL_SCAN_ALGORITHMIC | CL_SCAN_ELF
  • CL_SCAN_RAW
  • CL_SCAN_BLOCKENCRYPTED
  • CL_SCAN_BLOCKBROKEN
  • CL_SCAN_MAILURL
  • CL_SCAN_PHISHING_BLOCKSSL
  • CL_SCAN_PHISHING_BLOCKCLOAK
  • CL_SCAN_STRUCTURED
  • CL_SCAN_STRUCTURED_SSN_NORMAL
  • CL_SCAN_STRUCTURED_SSN_STRIPPED
  • CL_SCAN_PARTIAL_MESSAGE
  • CL_SCAN_HEURISTIC_PRECEDENCE

DB options:

  • CL_DB_STDOPT (default) equal CL_DB_PHISHING | CL_DB_PHISHING_URLS
  • CL_DB_PUA
  • CL_DB_CVDNOTMP
  • CL_DB_PUA_MODE
  • CL_DB_PUA_INCLUDE
  • CL_DB_PUA_EXCLUDE

See ClamAV documentation and sources for details.

ClamAV#scanfile(filename[, options])

  options default CL_SCAN_STDOPT

  return:
    virusname or ClamAV returncode(Fixnum)

ClamAV#reload()

  reload virus db if changed

  return:
    1 - reload successful
    0 - reload unnecessary

ClamAV#setlimit(param, value)

ClamAV#getlimit(param)

ClamAV#setstring(param, value)

ClamAV#getstring(param)

  get or set default values internal settings.

Params:

  • CL_ENGINE_MAX_SCANSIZE, /* integer */
  • CL_ENGINE_MAX_FILESIZE, /* integer */
  • CL_ENGINE_MAX_RECURSION, /* integer */
  • CL_ENGINE_MAX_FILES, /* integer */
  • CL_ENGINE_MIN_CC_COUNT, /* integer */
  • CL_ENGINE_MIN_SSN_COUNT, /* integer */
  • CL_ENGINE_PUA_CATEGORIES, /* string */
  • CL_ENGINE_DB_OPTIONS, /* integer */
  • CL_ENGINE_DB_VERSION, /* integer */
  • CL_ENGINE_DB_TIME, /* integer unixtime (readonly) */
  • CL_ENGINE_AC_ONLY, /* integer */
  • CL_ENGINE_AC_MINDEPTH, /* integer */
  • CL_ENGINE_AC_MAXDEPTH, /* integer */
  • CL_ENGINE_TMPDIR, /* string */
  • CL_ENGINE_KEEPTMP /* integer */

See ClamAV documentation and sources for details.

ClamaAV#signo()

  get loaded signatures count

LICENSE:

GNU General Public License

Copyright© 2008-2009 Alexander Oryol <eagle.alex@gmail.com>

THANKS:

Based on project clamavr-0.2.0

raa.ruby-lang.org/project/clamavr/

Copyright© 2003-2007 MoonWolf <moonwolf@moonwolf.com>