clamrb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d80319ba09033729946002cb5210dc5e307f55b5c150c9e84fbd58714a0c3c3
-  data.tar.gz: e4b415697de5596cc54f6c9d8f9340389909f610579e38032c159eaafd455a34
+  metadata.gz: ee48d033a2f6004ad93b96da388662eb239d01728751b39fe04350d2a1e564ac
+  data.tar.gz: cb0bb2b613050912a5742dcf20c3029a181844e69bbb1303828de32865365984
 SHA512:
-  metadata.gz: 5b17c574a53574170539476ecf00159cbe509104c32f80fe24acb2278d4570ee197ec11ba148632aa0e5cbf62f1708370b2d99d9b1f6fb240c2435e33c0b8588
-  data.tar.gz: 9cb4348b76d66dd679a37ae5277a12932232062848b3cd39177d17fb2438c2a7bc2f0cc27a9343543d6f22d95aff6ac59dfc37d9163cce4afd5fd69df8710245
+  metadata.gz: 0bd8f61cd8cca53b0c2fd696db4fb6976d620d8a4a38d72b0d66c282b7d9a2a1ae384313b580da93ac8f54256c6ea7495ddbb7ae329a43458aad8e329ce9f422
+  data.tar.gz: f65c82ba6877d67747c90dcf0fa903fcd3f5fdb39405f25e8d06d64de17ffeab5f8ae37a10c351e44c16276c6940998228035084c6c870d31e37e635a44e6c05

data/.gitignore

@@ -1,2 +1,5 @@
 *.o
 *.so
+*.gem
+Makefile
+*.log

data/README.md

@@ -20,12 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
+To create an instance of `Clamrb` and scan a file use the following example:
+
 ```ruby
 clamrb = Clamrb.new
-clamrb.scan "file.txt"
+result = clamrb.scan "file.txt"
  => #<Clamrb::Result:0x00000000012d2458 @status=:infected, @identifier="Eicar-Test-Signature">
 ```
 
+There are convenience predicate methods on the `Clamrb::Result` object returned from the scan. These methods allow you to quickly determine the status of the file:
+
+```ruby
+result.safe?
+=> false
+result.error?
+=> false
+result.virus?
+=> true
+```
+
+## Performance
+
+Creating a new instance of `Clamrb` causes ClamAV to load its database and initialize its engine. This can take a few seconds in some scenarios. To keep your application performing well you should create an instance of `Clamrb` during the startup sequence of your application and reuse it for your scans to keep overall scan latency to a minimum.
+
+## Dependencies
+
+This gem does not have any ruby dependencies, however, it does rely on some external libraries on the system. To install clamrb you will need a compiler and the associated tools for building native ruby gems, clamav, libclamav, and the associated headers. You can review the [docker](docker) folder to see which dependencies are necessary to install and run this library.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/abedra/clamrb.

data/clamrb.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clamrb/version"
+
+Gem::Specification.new do |s|
+  s.name          = 'clamrb'
+  s.version       = Clamrb::VERSION
+  s.date          = '2018-11-23'
+  s.licenses      = ['MIT']
+  s.summary       = 'Ruby interface to Clam AV'
+  s.description   = 'Native Ruby extension for running clamav scans'
+  s.authors       = ['Aaron Bedra']
+  s.email         = 'aaron@aaronbedra.com'
+  s.extensions    = ['ext/clamrb/extconf.rb']
+  s.homepage      = 'https://github.com/abedra/clamrb'
+  s.require_paths = ["lib"]
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "rake", "~> 10.0"
+end

data/docker/centos/Dockerfile

@@ -0,0 +1,7 @@
+FROM centos:latest
+
+RUN yum -y install epel-release
+RUN yum -y update
+RUN yum -y install gcc make pkg-config ruby ruby-devel clamav clamav-lib clamav-devel
+RUN pkg-config --list-all
+RUN gem install clamrb

data/docker/debian/Dockerfile

@@ -0,0 +1,7 @@
+FROM debian:latest
+
+RUN apt-get -y update
+RUN apt-get -y upgrade
+RUN apt-get -y install gcc make pkg-config ruby-full clamav libclamav-dev
+
+RUN gem install clamrb

data/docker/ubuntu/Dockerfile

@@ -0,0 +1,8 @@
+FROM ubuntu:latest
+
+RUN apt-get -y update
+RUN apt-get -y upgrade
+RUN apt-get -y install gcc make pkg-config ruby-full clamav libclamav-dev
+
+RUN gem install clamrb
+

data/lib/clamrb/result.rb

@@ -5,5 +5,17 @@ class Clamrb
     def initialize(status, identifier = nil)
       @status, @identifier = status, identifier
     end
+
+    def safe?
+      status != :infected
+    end
+
+    def virus?
+      status == :infected
+    end
+
+    def error?
+      status == :unknown
+    end
   end
 end

data/lib/clamrb/version.rb

@@ -0,0 +1,3 @@
+module Clamrb
+  VERSION = "0.0.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clamrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aaron Bedra
@@ -49,12 +49,15 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- ext/clamrb/Makefile
+- clamrb.gemspec
+- docker/centos/Dockerfile
+- docker/debian/Dockerfile
+- docker/ubuntu/Dockerfile
 - ext/clamrb/clamrb.c
 - ext/clamrb/extconf.rb
-- ext/clamrb/mkmf.log
 - lib/clamrb.rb
 - lib/clamrb/result.rb
+- lib/clamrb/version.rb
 homepage: https://github.com/abedra/clamrb
 licenses:
 - MIT

data/ext/clamrb/Makefile

@@ -1,263 +0,0 @@
-
-SHELL = /bin/sh
-
-# V=0 quiet, V=1 verbose.  other values don't work.
-V = 0
-Q1 = $(V:1=)
-Q = $(Q1:0=@)
-ECHO1 = $(V:1=@ :)
-ECHO = $(ECHO1:0=@ echo)
-NULLCMD = :
-
-#### Start of system configuration section. ####
-
-srcdir = .
-topdir = /home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0
-hdrdir = $(topdir)
-arch_hdrdir = /home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0/x86_64-linux
-PATH_SEPARATOR = :
-VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
-prefix = $(DESTDIR)/home/abedra/.rvm/rubies/ruby-2.5.1
-rubysitearchprefix = $(rubylibprefix)/$(sitearch)
-rubyarchprefix = $(rubylibprefix)/$(arch)
-rubylibprefix = $(libdir)/$(RUBY_BASE_NAME)
-exec_prefix = $(prefix)
-vendorarchhdrdir = $(vendorhdrdir)/$(sitearch)
-sitearchhdrdir = $(sitehdrdir)/$(sitearch)
-rubyarchhdrdir = $(rubyhdrdir)/$(arch)
-vendorhdrdir = $(rubyhdrdir)/vendor_ruby
-sitehdrdir = $(rubyhdrdir)/site_ruby
-rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
-vendorarchdir = $(vendorlibdir)/$(sitearch)
-vendorlibdir = $(vendordir)/$(ruby_version)
-vendordir = $(rubylibprefix)/vendor_ruby
-sitearchdir = $(sitelibdir)/$(sitearch)
-sitelibdir = $(sitedir)/$(ruby_version)
-sitedir = $(rubylibprefix)/site_ruby
-rubyarchdir = $(rubylibdir)/$(arch)
-rubylibdir = $(rubylibprefix)/$(ruby_version)
-sitearchincludedir = $(includedir)/$(sitearch)
-archincludedir = $(includedir)/$(arch)
-sitearchlibdir = $(libdir)/$(sitearch)
-archlibdir = $(libdir)/$(arch)
-ridir = $(datarootdir)/$(RI_BASE_NAME)
-mandir = $(datarootdir)/man
-localedir = $(datarootdir)/locale
-libdir = $(exec_prefix)/lib
-psdir = $(docdir)
-pdfdir = $(docdir)
-dvidir = $(docdir)
-htmldir = $(docdir)
-infodir = $(datarootdir)/info
-docdir = $(datarootdir)/doc/$(PACKAGE)
-oldincludedir = $(DESTDIR)/usr/include
-includedir = $(prefix)/include
-localstatedir = $(prefix)/var
-sharedstatedir = $(prefix)/com
-sysconfdir = $(prefix)/etc
-datadir = $(datarootdir)
-datarootdir = $(prefix)/share
-libexecdir = $(exec_prefix)/libexec
-sbindir = $(exec_prefix)/sbin
-bindir = $(exec_prefix)/bin
-archdir = $(rubyarchdir)
-
-
-CC = gcc
-CXX = g++
-LIBRUBY = $(LIBRUBY_SO)
-LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
-LIBRUBYARG_SHARED = -Wl,-rpath,$(libdir) -L$(libdir) -l$(RUBY_SO_NAME)
-LIBRUBYARG_STATIC = -Wl,-rpath,$(libdir) -L$(libdir) -l$(RUBY_SO_NAME)-static
-empty =
-OUTFLAG = -o $(empty)
-COUTFLAG = -o $(empty)
-CSRCFLAG = $(empty)
-
-RUBY_EXTCONF_H = 
-cflags   = $(optflags) $(debugflags) $(warnflags)
-cxxflags = $(optflags) $(debugflags) $(warnflags)
-optflags = -O3
-debugflags = -ggdb3
-warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wno-tautological-compare -Wno-parentheses-equality -Wno-constant-logical-operand -Wno-self-assign -Wunused-variable -Wimplicit-int -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wmisleading-indentation -Wno-packed-bitfield-compat -Wsuggest-attribute=noreturn -Wsuggest-attribute=format -Wimplicit-fallthrough=0 -Wduplicated-cond -Wrestrict
-CCDLFLAGS = -fPIC
-CFLAGS   = $(CCDLFLAGS) $(cflags)  -fPIC $(ARCH_FLAG)
-INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir)
-DEFS     = 
-CPPFLAGS =   $(DEFS) $(cppflags)
-CXXFLAGS = $(CCDLFLAGS) $(cxxflags) $(ARCH_FLAG)
-ldflags  = -L. -fstack-protector -rdynamic -Wl,-export-dynamic
-dldflags = -Wl,--compress-debug-sections=zlib 
-ARCH_FLAG = 
-DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
-LDSHARED = $(CC) -shared
-LDSHAREDXX = $(CXX) -shared
-AR = ar
-EXEEXT = 
-
-RUBY_INSTALL_NAME = $(RUBY_BASE_NAME)
-RUBY_SO_NAME = ruby
-RUBYW_INSTALL_NAME = 
-RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version)
-RUBYW_BASE_NAME = rubyw
-RUBY_BASE_NAME = ruby
-
-arch = x86_64-linux
-sitearch = $(arch)
-ruby_version = 2.5.0
-ruby = $(bindir)/$(RUBY_BASE_NAME)
-RUBY = $(ruby)
-ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/backward.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h
-
-RM = rm -f
-RM_RF = $(RUBY) -run -e rm -- -rf
-RMDIRS = rmdir --ignore-fail-on-non-empty -p
-MAKEDIRS = /usr/bin/mkdir -p
-INSTALL = /usr/bin/install -c
-INSTALL_PROG = $(INSTALL) -m 0755
-INSTALL_DATA = $(INSTALL) -m 644
-COPY = cp
-TOUCH = exit >
-
-#### End of system configuration section. ####
-
-preload = 
-libpath = . $(libdir)
-LIBPATH =  -L. -L$(libdir) -Wl,-rpath,$(libdir)
-DEFFILE = 
-
-CLEANFILES = mkmf.log
-DISTCLEANFILES = 
-DISTCLEANDIRS = 
-
-extout = 
-extout_prefix = 
-target_prefix = /clamrb
-LOCAL_LIBS = 
-LIBS = $(LIBRUBYARG_SHARED) -lclamav  -lpthread -ldl -lcrypt -lm   -lc
-ORIG_SRCS = clamrb.c
-SRCS = $(ORIG_SRCS) 
-OBJS = clamrb.o
-HDRS = 
-LOCAL_HDRS = 
-TARGET = clamrb
-TARGET_NAME = clamrb
-TARGET_ENTRY = Init_$(TARGET_NAME)
-DLLIB = $(TARGET).so
-EXTSTATIC = 
-STATIC_LIB = 
-
-TIMESTAMP_DIR = .
-BINDIR        = $(bindir)
-RUBYCOMMONDIR = $(sitedir)$(target_prefix)
-RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
-RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
-HDRDIR        = $(rubyhdrdir)/ruby$(target_prefix)
-ARCHHDRDIR    = $(rubyhdrdir)/$(arch)/ruby$(target_prefix)
-TARGET_SO_DIR =
-TARGET_SO     = $(TARGET_SO_DIR)$(DLLIB)
-CLEANLIBS     = $(TARGET_SO) 
-CLEANOBJS     = *.o  *.bak
-
-all:    $(DLLIB)
-static: $(STATIC_LIB)
-.PHONY: all install static install-so install-rb
-.PHONY: clean clean-so clean-static clean-rb
-
-clean-static::
-clean-rb-default::
-clean-rb::
-clean-so::
-clean: clean-so clean-static clean-rb-default clean-rb
-		-$(Q)$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time
-
-distclean-rb-default::
-distclean-rb::
-distclean-so::
-distclean-static::
-distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb
-		-$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
-		-$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
-		-$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true
-
-realclean: distclean
-install: install-so install-rb
-
-install-so: $(DLLIB) $(TIMESTAMP_DIR)/.sitearchdir.-.clamrb.time
-	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
-clean-static::
-	-$(Q)$(RM) $(STATIC_LIB)
-install-rb: pre-install-rb do-install-rb install-rb-default
-install-rb-default: pre-install-rb-default do-install-rb-default
-pre-install-rb: Makefile
-pre-install-rb-default: Makefile
-do-install-rb:
-do-install-rb-default:
-pre-install-rb-default:
-	@$(NULLCMD)
-$(TIMESTAMP_DIR)/.sitearchdir.-.clamrb.time:
-	$(Q) $(MAKEDIRS) $(@D) $(RUBYARCHDIR)
-	$(Q) $(TOUCH) $@
-
-site-install: site-install-so site-install-rb
-site-install-so: install-so
-site-install-rb: install-rb
-
-.SUFFIXES: .c .m .cc .mm .cxx .cpp .o .S
-
-.cc.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.cc.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-.mm.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.mm.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-.cxx.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.cxx.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-.cpp.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.cpp.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-.c.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.c.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-.m.o:
-	$(ECHO) compiling $(<)
-	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
-
-.m.S:
-	$(ECHO) translating $(<)
-	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
-
-$(TARGET_SO): $(OBJS) Makefile
-	$(ECHO) linking shared-object clamrb/$(DLLIB)
-	-$(Q)$(RM) $(@)
-	$(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
-
-
-
-$(OBJS): $(HDRS) $(ruby_headers)

data/ext/clamrb/mkmf.log

@@ -1,34 +0,0 @@
-have_library: checking for -lclamav... -------------------- yes
-
-"gcc -o conftest -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0/x86_64-linux -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0/ruby/backward -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0 -I.    -O3 -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wno-tautological-compare -Wno-parentheses-equality -Wno-constant-logical-operand -Wno-self-assign -Wunused-variable -Wimplicit-int -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wmisleading-indentation -Wno-packed-bitfield-compat -Wsuggest-attribute=noreturn -Wsuggest-attribute=format -Wimplicit-fallthrough=0 -Wduplicated-cond -Wrestrict  -fPIC conftest.c  -L. -L/home/abedra/.rvm/rubies/ruby-2.5.1/lib -Wl,-rpath,/home/abedra/.rvm/rubies/ruby-2.5.1/lib -L. -fstack-protector -rdynamic -Wl,-export-dynamic     -Wl,-rpath,/home/abedra/.rvm/rubies/ruby-2.5.1/lib -L/home/abedra/.rvm/rubies/ruby-2.5.1/lib -lruby  -lpthread -ldl -lcrypt -lm   -lc"
-checked program was:
-/* begin */
-1: #include "ruby.h"
-2: 
-3: int main(int argc, char **argv)
-4: {
-5:   return 0;
-6: }
-/* end */
-
-"gcc -o conftest -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0/x86_64-linux -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0/ruby/backward -I/home/abedra/.rvm/rubies/ruby-2.5.1/include/ruby-2.5.0 -I.    -O3 -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wno-tautological-compare -Wno-parentheses-equality -Wno-constant-logical-operand -Wno-self-assign -Wunused-variable -Wimplicit-int -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wmisleading-indentation -Wno-packed-bitfield-compat -Wsuggest-attribute=noreturn -Wsuggest-attribute=format -Wimplicit-fallthrough=0 -Wduplicated-cond -Wrestrict  -fPIC conftest.c  -L. -L/home/abedra/.rvm/rubies/ruby-2.5.1/lib -Wl,-rpath,/home/abedra/.rvm/rubies/ruby-2.5.1/lib -L. -fstack-protector -rdynamic -Wl,-export-dynamic     -Wl,-rpath,/home/abedra/.rvm/rubies/ruby-2.5.1/lib -L/home/abedra/.rvm/rubies/ruby-2.5.1/lib -lruby -lclamav  -lpthread -ldl -lcrypt -lm   -lc"
-checked program was:
-/* begin */
- 1: #include "ruby.h"
- 2: 
- 3: /*top*/
- 4: extern int t(void);
- 5: int main(int argc, char **argv)
- 6: {
- 7:   if (argc > 1000000) {
- 8:     printf("%p", &t);
- 9:   }
-10: 
-11:   return 0;
-12: }
-13: 
-14: int t(void) { ; return 0; }
-/* end */
-
---------------------
-