pyClamd-0.3.9/0000775000175000017500000000000012356550265013033 5ustar xaelxael00000000000000pyClamd-0.3.9/example.py0000664000175000017500000000127312352063024015027 0ustar xaelxael00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- import pyclamd # Create object for using unix socket or network socket cd = pyclamd.ClamdAgnostic() # test if server is OK cd.ping() # print version print "Version : \n{0}\n".format(cd.version()) # force a db reload cd.reload() # print stats print "\n{0}\n".format(cd.stats()) # write test file with EICAR test string open('/tmp/EICAR','w').write(cd.EICAR()) # write test file without virus pattern open('/tmp/NO_EICAR','w').write('no virus in this file') # scan files print "\n{0}\n".format(cd.scan_file('/tmp/EICAR')) print "\n{0}\n".format(cd.scan_file('/tmp/NO_EICAR')) # scan a stream print "\n{0}\n".format(cd.scan_stream(cd.EICAR())) pyClamd-0.3.9/PKG-INFO0000664000175000017500000000217412356550265014134 0ustar xaelxael00000000000000Metadata-Version: 1.1 Name: pyClamd Version: 0.3.9 Summary: pyClamd is a python interface to Clamd (Clamav daemon). Home-page: http://xael.org/norman/python/pyclamd/ Author: Alexandre Norman Author-email: norman()xael.org License: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+) Download-URL: http://xael.org/norman/python/pyclamd/ Description: pyClamd is a python interface to Clamd (Clamav daemon). By using pyClamd, you can add virus detection capabilities to your python software in an efficient and easy way. Instead of pyClamav which uses libclamav, pyClamd may be used by a closed source product. Keywords: python,clamav,antivirus,scanner,virus,libclamav Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Programming Language :: Python Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+) Classifier: Operating System :: OS Independent Classifier: Topic :: System Classifier: Topic :: Security pyClamd-0.3.9/pyclamd.html0000664000175000017500000010100012356550261015336 0ustar xaelxael00000000000000 Python: module pyclamd
 
 
pyclamd (version 0.3.9)		index
/home/xael/ESPACE_KM/python/pyclamd/pyclamd.py

pyclamd.py
 
Author : Alexandre Norman - norman()xael.org
Contributors :
 - JB :  Joe Brandt  - brandt.joe () gmail.com
 - JS : Joni Salonen - joni.salonen () qindel.com
 - PL :  Philippe Lagadec - philippe.lagadec()laposte.net
 - SK : Scott Kitterman - debian () kitterman.com
 - TK :  Thomas Kastner - tk()underground8.com
 - TKL : Thomas Kluyver - thomas () kluyver.me.uk
 - TT :  Theodoropoulos Theodoros (TeD TeD) - sbujam()gmail.com
Licence : LGLPv3+
 
Usage :
 
Test strings :
^^^^^^^^^^^^
 
>>> import pyclamd
>>> try:
...     cd = pyclamd.ClamdUnixSocket()
...     # test if server is reachable
...     cd.ping()
... except pyclamd.ConnectionError:
...     # if failed, test for network socket
...     cd = pyclamd.ClamdNetworkSocket()
...     try:
...         cd.ping()
...     except pyclamd.ConnectionError:
...         raise ValueError('could not connect to clamd server either by unix or network socket')
True
>>> print(cd.version().split()[0])
ClamAV
>>> print(cd.reload())
RELOADING
>>> print(cd.stats().split()[0])
POOLS:
>>> void = open('/tmp/EICAR','w').write(cd.EICAR())
>>> void = open('/tmp/NO_EICAR','w').write('no virus in this file')
>>> cd.scan_file('/tmp/EICAR')['/tmp/EICAR']
('FOUND', 'Eicar-Test-Signature')
>>> cd.scan_file('/tmp/NO_EICAR') is None
True
>>> cd.scan_stream(cd.EICAR())['stream']
('FOUND', 'Eicar-Test-Signature')
>>> directory = cd.contscan_file('/tmp/')
>>> directory['/tmp/EICAR']
('FOUND', 'Eicar-Test-Signature')
>>> # Testing encoding with non latin characters (Chinese ideograms taken from random site, don't know what it mean, sorry)
>>> void = open('/tmp/EICAR-éèô请收藏我们的网址','w').write(cd.EICAR())
>>> r = cd.scan_file('/tmp/EICAR-éèô请收藏我们的网址')
>>> print(list(r.keys())[0])
/tmp/EICAR-éèô请收藏我们的网址
>>> print(r['/tmp/EICAR-éèô请收藏我们的网址'])
('FOUND', 'Eicar-Test-Signature')
>>> import os
>>> os.remove('/tmp/EICAR')
>>> os.remove('/tmp/NO_EICAR')
>>> os.remove('/tmp/EICAR-éèô请收藏我们的网址')

 
Modules
       
base64
socket
struct

 
Classes
       
exceptions.ValueError(exceptions.StandardError)
BufferTooLongError
_ClamdGeneric(__builtin__.object)
ClamdNetworkSocket
ClamdUnixSocket
socket.error(exceptions.IOError)
ConnectionError

 
class BufferTooLongError(exceptions.ValueError)
    Class for errors with clamd using INSTREAM with a buffer lenght > StreamMaxLength in /etc/clamav/clamd.conf
 
 
Method resolution order:
BufferTooLongError
exceptions.ValueError
exceptions.StandardError
exceptions.Exception
exceptions.BaseException
__builtin__.object
Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)
Methods inherited from exceptions.ValueError:
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
Data and other attributes inherited from exceptions.ValueError:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)
Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class ClamdNetworkSocket(_ClamdGeneric)
    Class for using clamd with a network socket
 
 
Method resolution order:
ClamdNetworkSocket
_ClamdGeneric
__builtin__.object
Methods defined here:
__init__(self, host='127.0.0.1', port=3310, timeout=None)
Network Class initialisation
host (string) : hostname or ip address
port (int) : TCP port
timeout (float or None) : socket timeout
Methods inherited from _ClamdGeneric:
EICAR(self)
returns Eicar test string
contscan_file(self, file)
Scan a file or directory given by filename
Do not stop on error or virus found.
Scan with archive support enabled.
 
file (string): filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}
  - None: if no virus found
 
May raise:
  - ConnectionError: in case of communication problem
multiscan_file(self, file)
Scan a file or directory given by filename using multiple threads (faster on SMP machines).
Do not stop on error or virus found.
Scan with archive support enabled.
 
file (string): filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}
  - None: if no virus found
 
May raise:
  - ConnectionError: in case of communication problem
ping(self)
Send a PING to the clamav server, which should reply
by a PONG.
 
return: True if the server replies to PING
 
May raise:
  - ConnectionError: if the server do not reply by PONG
reload(self)
Force Clamd to reload signature database
 
return: (string) "RELOADING"
 
May raise:
  - ConnectionError: in case of communication problem
scan_file(self, file)
Scan a file or directory given by filename and stop on first virus or error found.
Scan with archive support enabled.
 
file (string) : filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: "virusname"}
  - None: if no virus found
 
May raise :
  - ConnectionError: in case of communication problem
  - socket.timeout: if timeout has expired
scan_stream(self, buffer_to_test)
Scan a buffer
 
buffer_to_test (string): buffer to scan
 
return either:
  - (dict): {filename1: "virusname"}
  - None: if no virus found
 
May raise :
  - BufferTooLongError: if the buffer size exceeds clamd limits
  - ConnectionError: in case of communication problem
shutdown(self)
Force Clamd to shutdown and exit
 
return: nothing
 
May raise:
  - ConnectionError: in case of communication problem
stats(self)
Get Clamscan stats
 
return: (string) clamscan stats
 
May raise:
  - ConnectionError: in case of communication problem
version(self)
Get Clamscan version
 
return: (string) clamscan version
 
May raise:
  - ConnectionError: in case of communication problem
Data descriptors inherited from _ClamdGeneric:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ClamdUnixSocket(_ClamdGeneric)
    Class for using clamd with an unix socket
 
 
Method resolution order:
ClamdUnixSocket
_ClamdGeneric
__builtin__.object
Methods defined here:
__init__(self, filename=None, timeout=None)
Unix Socket Class initialisation
 
filename (string) : unix socket filename or None to get the socket from /etc/clamav/clamd.conf
timeout (float or None) : socket timeout
Methods inherited from _ClamdGeneric:
EICAR(self)
returns Eicar test string
contscan_file(self, file)
Scan a file or directory given by filename
Do not stop on error or virus found.
Scan with archive support enabled.
 
file (string): filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}
  - None: if no virus found
 
May raise:
  - ConnectionError: in case of communication problem
multiscan_file(self, file)
Scan a file or directory given by filename using multiple threads (faster on SMP machines).
Do not stop on error or virus found.
Scan with archive support enabled.
 
file (string): filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')}
  - None: if no virus found
 
May raise:
  - ConnectionError: in case of communication problem
ping(self)
Send a PING to the clamav server, which should reply
by a PONG.
 
return: True if the server replies to PING
 
May raise:
  - ConnectionError: if the server do not reply by PONG
reload(self)
Force Clamd to reload signature database
 
return: (string) "RELOADING"
 
May raise:
  - ConnectionError: in case of communication problem
scan_file(self, file)
Scan a file or directory given by filename and stop on first virus or error found.
Scan with archive support enabled.
 
file (string) : filename or directory (MUST BE ABSOLUTE PATH !)
 
return either :
  - (dict): {filename1: "virusname"}
  - None: if no virus found
 
May raise :
  - ConnectionError: in case of communication problem
  - socket.timeout: if timeout has expired
scan_stream(self, buffer_to_test)
Scan a buffer
 
buffer_to_test (string): buffer to scan
 
return either:
  - (dict): {filename1: "virusname"}
  - None: if no virus found
 
May raise :
  - BufferTooLongError: if the buffer size exceeds clamd limits
  - ConnectionError: in case of communication problem
shutdown(self)
Force Clamd to shutdown and exit
 
return: nothing
 
May raise:
  - ConnectionError: in case of communication problem
stats(self)
Get Clamscan stats
 
return: (string) clamscan stats
 
May raise:
  - ConnectionError: in case of communication problem
version(self)
Get Clamscan version
 
return: (string) clamscan version
 
May raise:
  - ConnectionError: in case of communication problem
Data descriptors inherited from _ClamdGeneric:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ConnectionError(socket.error)
    Class for errors communication with clamd
 
 
Method resolution order:
ConnectionError
socket.error
exceptions.IOError
exceptions.EnvironmentError
exceptions.StandardError
exceptions.Exception
exceptions.BaseException
__builtin__.object
Data descriptors inherited from socket.error:
__weakref__
list of weak references to the object (if defined)
Methods inherited from exceptions.IOError:
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
Data and other attributes inherited from exceptions.IOError:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from exceptions.EnvironmentError:
__reduce__(...)
__str__(...)
x.__str__() <==> str(x)
Data descriptors inherited from exceptions.EnvironmentError:
errno
exception errno
filename
exception filename
strerror
exception strerror
Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__unicode__(...)
Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
Functions
       
ClamdAgnostic()
Tries to connect to clamd using ClamdUnixSocket or if it fails, tries
with ClamdNetworkSocket and return the corresponding object.
Of course, it tries to connect with default settings...
contscan_file = wrapper(*args, **kw)
Deprecated API - use one of the Clamd*Socket classes instead.
init_network_socket(host='127.0.0.1', port=3310, timeout=None)
Deprecated API - use ClamdNetworkSocket instead.
init_unix_socket(filename=None)
Deprecated API - use ClamdUnixSocket instead.
multiscan_file = wrapper(*args, **kw)
Deprecated API - use one of the Clamd*Socket classes instead.
scan_file = wrapper(*args, **kw)
Deprecated API - use one of the Clamd*Socket classes instead.
version = wrapper(*args, **kw)
Deprecated API - use one of the Clamd*Socket classes instead.

 
Data
        __version__ = '0.3.9'
socketinst = None
pyClamd-0.3.9/README.txt0000664000175000017500000000506212356335622014532 0ustar xaelxael00000000000000pyClamd is a portable Python module to use the ClamAV antivirus engine on Windows, Linux, MacOSX and other platforms. It requires a running instance of the clamd daemon. License: pyClamd is released as open-source software under the LGPLv3 (or later) license. Download: see http://xael.org/norman/python/pyclamd/ How to install clamd: * For Windows: you need an unofficial version from http://hideout.ath.cx/clamav/ or http://oss.netfarm.it/clamav/ (http://w32.clamav.net does not provide clamd anymore, and neither does ClamWin) o Before running clamd, edit clamd.conf and make sure it is configured to use a TCP port instead of a Unix socket: LocalSocket should be disabled, TCPSocket and TCPAddr should be enabled. * For MacOSX: you may install ClamXav, and then run clamd from /usr/local/clamXav/sbin. * For other operating systems such as Linux and *BSD: http://www.clamav.org/download How to run clamd as a service on Windows: See http://www.andornot.com/blog/post/How-to-set-up-ClamAV-as-a-Windows-Service-to-scan-file-streams-on-demand.aspx or http://www.google.com/search?q=clamd+windows+service There used to be instructions on http://www.asspsmtp.org/wiki/ClamAV_Win32 to use either runclamd or the NJH Power Tools, but the website is not available anymore. How to use pyClamd: See source code or Alexandre Norman's website: http://xael.org/norman/python/pyclamd/ Here is an example on Unix: >>> import pyclamd >>> # Create object for using unix socket or network socket >>> cd = pyclamd.ClamdAgnostic() >>> # test if server is OK >>> cd.ping() True >>> # print version >>> print "Version : \n{0}".format(cd.version()) Version : ClamAV 0.98.1/19122/Sun Jun 22 08:24:11 2014 >>> # force a db reload >>> cd.reload() u'RELOADING' >>> # print stats >>> print "{0}".format(cd.stats()) POOLS: 1 STATE: VALID PRIMARY THREADS: live 1 idle 0 max 12 idle-timeout 30 QUEUE: 0 items STATS 0.000048 MEMSTATS: heap 6.098M mmap 0.000M used 3.770M free 2.337M releasable 0.132M pools 1 pools_used 268.122M pools_total 268.136M END >>> # write test file with EICAR test string >>> open('/tmp/EICAR','w').write(cd.EICAR()) >>> # write test file without virus pattern >>> open('/tmp/NO_EICAR','w').write('no virus in this file') >>> # scan files >>> print "{0}".format(cd.scan_file('/tmp/EICAR')) {u'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')} >>> print "{0}".format(cd.scan_file('/tmp/NO_EICAR')) None >>> # scan a stream >>> print "{0}".format(cd.scan_stream(cd.EICAR())) {u'stream': ('FOUND', 'Eicar-Test-Signature')} pyClamd-0.3.9/COPYING0000664000175000017500000010451310642030347014060 0ustar xaelxael00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. 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 them 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 prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. 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. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey 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; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If 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 convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU 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 that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. 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. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 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. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 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 state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 3 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, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program 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, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU 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. But first, please read . pyClamd-0.3.9/pyclamd.py0000664000175000017500000005774212356546751015062 0ustar xaelxael00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # LICENSE: # This program is free software; you can redistribute it and/or modify it under # the terms of the GNU Lesser General Public License as published by the Free # Software Foundation; either version 3 of the License, or (at your option) any # later version. See http://www.gnu.org/licenses/lgpl-3.0.txt. # # 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 Lesser General Public License for more # details. # # You should have received a copy of the GNU Lesser General Public License along # with this program; if not, write to the Free Software Foundation, Inc., # 675 Mass Ave, Cambridge, MA 02139, USA. #------------------------------------------------------------------------------ # CHANGELOG: # 2006-07-15 v0.1.1 AN: - released version # 2007-10-09 v0.2.0 PL: - fixed error with deprecated string exceptions # - added optional timeout to sockets to avoid blocking # operations # 2010-07-11 v0.2.1 AN: - change all raise exception (was deprecated), license # change to LGPL # 2010-07-12 v0.2.2 TK: - PEP8 compliance # isolating send and receive functions # 2012-11-20 v0.3.0 AN: - change API to class model # - using INSTREAM scan method instead of the deprecated STREAM # - added MULTISCAN method # - STATS now return full data on multiline # TK: - changes to API to make it more consistent # 2012-11-20 v0.3.1 AN: - typo change (Connextion to Connexion) # - Fixed Issue 3: scan_stream: AssertionError # 2013-04-20 v0.3.2 TT/AN: - improving encoding support for non latin filenames # TKL: - When pyclamd calls _recv_response, it appears to expect # that it will only get one result at a time. This is not # always the case: it may get multiple results separated # by newlines. # - Typos corrected with pyflakes # - Adding a compatibility layer for the most important # functions in the 0.2 API - init_*_socket, scan_file, # contscan_file, multiscan_file, and version. # 2013-04-21 v0.3.3 AN: - ClamdUnixSocket is now able to get unix socket name # from /etc/clamav/clamd.conf # 2013-11-16 v0.3.4 JB/AN: - Nasty encoding bug in scan_stream # 2014-06-22 v0.3.6 JS/AN: - correction in assert for filename (change to basestring) # 2014-06-23 v0.3.7 AN: - correction in README.txt and example.py # - adding pyclamd.ClamdAgnostic() # 2014-07-06 v0.3.8 AN: - License clarification (use of LGPLv3+) # 2014-07-06 v0.3.9 SK/AN: - Bug correction + setup.py improvment for building #------------------------------------------------------------------------------ # TODO: # - improve tests for Win32 platform (avoid to write EICAR file to disk, or # protect it somehow from on-access AV, inside a ZIP/GZip archive isn't enough) # - use SESSION/END commands to launch several scans in one session # (for example provide session mode in a Clamd class) # - add support for RAWSCAN commands ? # ? Maybe use os.abspath to ensure scan_file uses absolute paths for files #------------------------------------------------------------------------------ # Documentation : http://www.clamav.net/doc/latest/html/node28.html """ pyclamd.py Author : Alexandre Norman - norman()xael.org Contributors : - JB : Joe Brandt - brandt.joe () gmail.com - JS : Joni Salonen - joni.salonen () qindel.com - PL : Philippe Lagadec - philippe.lagadec()laposte.net - SK : Scott Kitterman - debian () kitterman.com - TK : Thomas Kastner - tk()underground8.com - TKL : Thomas Kluyver - thomas () kluyver.me.uk - TT : Theodoropoulos Theodoros (TeD TeD) - sbujam()gmail.com Licence : LGLPv3+ Usage : Test strings : ^^^^^^^^^^^^ >>> import pyclamd >>> try: ... cd = pyclamd.ClamdUnixSocket() ... # test if server is reachable ... cd.ping() ... except pyclamd.ConnectionError: ... # if failed, test for network socket ... cd = pyclamd.ClamdNetworkSocket() ... try: ... cd.ping() ... except pyclamd.ConnectionError: ... raise ValueError('could not connect to clamd server either by unix or network socket') True >>> print(cd.version().split()[0]) ClamAV >>> print(cd.reload()) RELOADING >>> print(cd.stats().split()[0]) POOLS: >>> void = open('/tmp/EICAR','w').write(cd.EICAR()) >>> void = open('/tmp/NO_EICAR','w').write('no virus in this file') >>> cd.scan_file('/tmp/EICAR')['/tmp/EICAR'] ('FOUND', 'Eicar-Test-Signature') >>> cd.scan_file('/tmp/NO_EICAR') is None True >>> cd.scan_stream(cd.EICAR())['stream'] ('FOUND', 'Eicar-Test-Signature') >>> directory = cd.contscan_file('/tmp/') >>> directory['/tmp/EICAR'] ('FOUND', 'Eicar-Test-Signature') >>> # Testing encoding with non latin characters (Chinese ideograms taken from random site, don't know what it mean, sorry) >>> void = open('/tmp/EICAR-éèô请收藏我们的网址','w').write(cd.EICAR()) >>> r = cd.scan_file('/tmp/EICAR-éèô请收藏我们的网址') >>> print(list(r.keys())[0]) /tmp/EICAR-éèô请收藏我们的网址 >>> print(r['/tmp/EICAR-éèô请收藏我们的网址']) ('FOUND', 'Eicar-Test-Signature') >>> import os >>> os.remove('/tmp/EICAR') >>> os.remove('/tmp/NO_EICAR') >>> os.remove('/tmp/EICAR-éèô请收藏我们的网址') """ __version__ = "0.3.9" # $Source$ import socket import struct import base64 ############################################################################ class BufferTooLongError(ValueError): """Class for errors with clamd using INSTREAM with a buffer lenght > StreamMaxLength in /etc/clamav/clamd.conf""" class ConnectionError(socket.error): """Class for errors communication with clamd""" ############################################################################ class _ClamdGeneric(object): """ Abstract class for clamd """ def EICAR(self): """ returns Eicar test string """ # Eicar test string (encoded for skipping virus scanners) EICAR = base64.b64decode('WDVPIVAlQEFQWzRcUFpYNTQoUF4pN0NDKTd9JEVJQ0FSLVNUQU5EQVJELUFOVElWSVJVUy1URVNU\nLUZJTEUhJEgrSCo=\n'.encode('ascii')).decode('ascii') return EICAR def ping(self): """ Send a PING to the clamav server, which should reply by a PONG. return: True if the server replies to PING May raise: - ConnectionError: if the server do not reply by PONG """ self._init_socket() try: self._send_command('PING') result = self._recv_response() self._close_socket() except socket.error: raise ConnectionError('Could not ping clamd server') if result == 'PONG': return True else: raise ConnectionError('Could not ping clamd server [{0}]'.format(result)) return def version(self): """ Get Clamscan version return: (string) clamscan version May raise: - ConnectionError: in case of communication problem """ self._init_socket() try: self._send_command('VERSION') result = self._recv_response() self._close_socket() except socket.error: raise ConnectionError('Could not get version information from server') return result def stats(self): """ Get Clamscan stats return: (string) clamscan stats May raise: - ConnectionError: in case of communication problem """ self._init_socket() try: self._send_command('STATS') result = self._recv_response_multiline() self._close_socket() except socket.error: raise ConnectionError('Could not get version information from server') return result def reload(self): """ Force Clamd to reload signature database return: (string) "RELOADING" May raise: - ConnectionError: in case of communication problem """ try: self._init_socket() self._send_command('RELOAD') result = self._recv_response() self._close_socket() except socket.error: raise ConnectionError('Could probably not reload signature database') return result def shutdown(self): """ Force Clamd to shutdown and exit return: nothing May raise: - ConnectionError: in case of communication problem """ try: self._init_socket() self._send_command('SHUTDOWN') self._recv_response() self._close_socket() except socket.error: raise ConnectionError('Could probably not shutdown clamd') def scan_file(self, file): """ Scan a file or directory given by filename and stop on first virus or error found. Scan with archive support enabled. file (string) : filename or directory (MUST BE ABSOLUTE PATH !) return either : - (dict): {filename1: "virusname"} - None: if no virus found May raise : - ConnectionError: in case of communication problem - socket.timeout: if timeout has expired """ assert isinstance(file, basestring), 'Wrong type for [file], should be a string [was {0}]'.format(type(file)) try: self._init_socket() self._send_command('SCAN {0}'.format(file)) except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) result='...' dr={} while result: try: result = self._recv_response() except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) if len(result) > 0: filename, reason, status = self._parse_response(result) if status == 'ERROR': dr[filename] = ('ERROR', '{0}'.format(reason)) return dr elif status == 'FOUND': dr[filename] = ('FOUND', '{0}'.format(reason)) self._close_socket() if not dr: return None return dr def multiscan_file(self, file): """ Scan a file or directory given by filename using multiple threads (faster on SMP machines). Do not stop on error or virus found. Scan with archive support enabled. file (string): filename or directory (MUST BE ABSOLUTE PATH !) return either : - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')} - None: if no virus found May raise: - ConnectionError: in case of communication problem """ assert isinstance(file, basestring), 'Wrong type for [file], should be a string [was {0}]'.format(type(file)) try: self._init_socket() self._send_command('MULTISCAN {0}'.format(file)) except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) result='...' dr={} while result: try: result = self._recv_response() except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) if len(result) > 0: for resline in result.splitlines(): filename, reason, status = self._parse_response(resline) if status == 'ERROR': dr[filename] = ('ERROR', '{0}'.format(reason)) elif status == 'FOUND': dr[filename] = ('FOUND', '{0}'.format(reason)) self._close_socket() if not dr: return None return dr def contscan_file(self, file): """ Scan a file or directory given by filename Do not stop on error or virus found. Scan with archive support enabled. file (string): filename or directory (MUST BE ABSOLUTE PATH !) return either : - (dict): {filename1: ('FOUND', 'virusname'), filename2: ('ERROR', 'reason')} - None: if no virus found May raise: - ConnectionError: in case of communication problem """ assert isinstance(file, basestring), 'Wrong type for [file], should be a string [was {0}]'.format(type(file)) try: self._init_socket() self._send_command('CONTSCAN {0}'.format(file)) except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) result='...' dr={} while result: try: result = self._recv_response() except socket.error: raise ConnectionError('Unable to scan {0}'.format(file)) if len(result) > 0: for resline in result.splitlines(): filename, reason, status = self._parse_response(resline) if status == 'ERROR': dr[filename] = ('ERROR', '{0}'.format(reason)) elif status == 'FOUND': dr[filename] = ('FOUND', '{0}'.format(reason)) self._close_socket() if not dr: return None return dr def scan_stream(self, buffer_to_test): """ Scan a buffer buffer_to_test (string): buffer to scan return either: - (dict): {filename1: "virusname"} - None: if no virus found May raise : - BufferTooLongError: if the buffer size exceeds clamd limits - ConnectionError: in case of communication problem """ try: self._init_socket() self._send_command('INSTREAM') max_chunk_size = 1024 # MUST be < StreamMaxLength in /etc/clamav/clamd.conf chunks_left = buffer_to_test while len(chunks_left)>0: chunk = chunks_left[:max_chunk_size] chunks_left = chunks_left[max_chunk_size:] #size = bytes.decode(struct.pack('!L', len(chunk))) size = struct.pack('!L', len(chunk)) #self.clamd_socket.send(str.encode('{0}{1}'.format(size, chunk))) #self.clamd_socket.send('{0}'.format(size) + chunk) self.clamd_socket.send(size) self.clamd_socket.send(chunk) # Terminating stream self.clamd_socket.send(struct.pack('!L', 0)) except socket.error: raise ConnectionError('Unable to scan stream') result='...' dr={} while result: try: result = self._recv_response() except socket.error: raise ConnectionError('Unable to scan stream') if len(result) > 0: if result == 'INSTREAM size limit exceeded. ERROR': raise BufferTooLongError(result) filename, reason, status = self._parse_response(result) if status == 'ERROR': dr[filename] = ('ERROR', '{0}'.format(reason)) elif status == 'FOUND': dr[filename] = ('FOUND', '{0}'.format(reason)) self._close_socket() if not dr: return None return dr def _send_command(self, cmd): """ `man clamd` recommends to prefix commands with z, but we will use \n terminated strings, as python<->clamd has some problems with \0x00 """ try: cmd = str.encode('n{0}\n'.format(cmd)) except UnicodeDecodeError: cmd = 'n{0}\n'.format(cmd) self.clamd_socket.send(cmd) return def _recv_response(self): """ receive response from clamd and strip all whitespace characters """ data = self.clamd_socket.recv(4096) try: response = bytes.decode(data).strip() except UnicodeDecodeError: response = data.strip() return response def _recv_response_multiline(self): """ receive multiple line response from clamd and strip all whitespace characters """ response = '' c = '...' while c != '': try: data = self.clamd_socket.recv(4096) try: c = bytes.decode(data).strip() except UnicodeDecodeError: response = data.strip() except socket.error: break response += '{0}\n'.format(c) return response def _close_socket(self): """ close clamd socket """ self.clamd_socket.close() return def _parse_response(self, msg): """ parses responses for SCAN, CONTSCAN, MULTISCAN and STREAM commands. """ msg = msg.strip() filename = msg.split(': ')[0] left = msg.split(': ')[1:] if isinstance(left, basestring): result = left else: result = ": ".join(left) if result != 'OK': parts = result.split() reason = ' '.join(parts[:-1]) status = parts[-1] else: reason, status = '', 'OK' return filename, reason, status ############################################################################ class ClamdUnixSocket(_ClamdGeneric): """ Class for using clamd with an unix socket """ def __init__(self, filename=None, timeout=None): """ Unix Socket Class initialisation filename (string) : unix socket filename or None to get the socket from /etc/clamav/clamd.conf timeout (float or None) : socket timeout """ # try to get unix socket from clamd.conf if filename is None: with open('/etc/clamav/clamd.conf', 'r') as conffile: for line in conffile.readlines(): try: if line.strip().split()[0] == 'LocalSocket': filename = line.strip().split()[1] break except IndexError: pass else: raise ConnectionError('Could not find clamd unix socket from /etc/clamav/clamd.conf') assert isinstance(filename, basestring), 'Wrong type for [file], should be a string [was {0}]'.format(type(file)) assert isinstance(timeout, (float, int)) or timeout is None, 'Wrong type for [timeout], should be either None or a float [was {0}]'.format(type(timeout)) _ClamdGeneric.__init__(self) self.unix_socket = filename self.timeout = timeout # tests the socket self._init_socket() self._close_socket() return def _init_socket(self): """ internal use only """ self.clamd_socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) if not self.timeout is None: self.clamd_socket.settimeout(self.timeout) try: self.clamd_socket.connect(self.unix_socket) except socket.error: raise ConnectionError('Could not reach clamd using unix socket ({0})'.format((self.unix_socket))) return ############################################################################ class ClamdNetworkSocket(_ClamdGeneric): """ Class for using clamd with a network socket """ def __init__(self, host='127.0.0.1', port=3310, timeout=None): """ Network Class initialisation host (string) : hostname or ip address port (int) : TCP port timeout (float or None) : socket timeout """ assert isinstance(host, str), 'Wrong type for [host], should be a string [was {0}]'.format(type(host)) assert isinstance(port, int), 'Wrong type for [port], should be an int [was {0}]'.format(type(port)) assert isinstance(timeout, (float, int)) or timeout is None, 'Wrong type for [timeout], should be either None or a float [was {0}]'.format(type(timeout)) _ClamdGeneric.__init__(self) self.host = host self.port = port self.timeout = timeout # tests the socket self._init_socket() self._close_socket() return def _init_socket(self): """ internal use only """ self.clamd_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) if not self.timeout is None: self.clamd_socket.settimeout(self.timeout) try: self.clamd_socket.connect((self.host, self.port)) except socket.error: raise ConnectionError('Could not reach clamd using network ({0}, {1})'.format(self.host, self.port)) return ############################################################################ def ClamdAgnostic(): """ Tries to connect to clamd using ClamdUnixSocket or if it fails, tries with ClamdNetworkSocket and return the corresponding object. Of course, it tries to connect with default settings... """ try: # Create object for using unix socket cd = ClamdUnixSocket() except ConnectionError: # if failed, test for network socket try: cd = ClamdNetworkSocket() except ConnectionError: raise ValueError("could not connect to clamd server either by unix or network socket") return cd ############################################################################ # Backwards compatibility API ############################################## socketinst = None def init_network_socket(host='127.0.0.1', port=3310, timeout=None): """Deprecated API - use ClamdNetworkSocket instead.""" global socketinst socketinst = ClamdNetworkSocket(host=host, port=port, timeout=timeout) def init_unix_socket(filename=None): """Deprecated API - use ClamdUnixSocket instead.""" global socketinst socketinst = ClamdUnixSocket(filename=filename) def _needs_socket(func): """Decorator to check that the global socket is initialised.""" def wrapper(*args, **kw): if socketinst is None: raise ConnectionError('socket not initialised') return func(*args, **kw) wrapper.__doc__ = func.__doc__ return wrapper @_needs_socket def scan_file(file): """Deprecated API - use one of the Clamd*Socket classes instead.""" return socketinst.scan_file(file) @_needs_socket def contscan_file(file): """Deprecated API - use one of the Clamd*Socket classes instead.""" return socketinst.contscan_file(file) @_needs_socket def multiscan_file(file): """Deprecated API - use one of the Clamd*Socket classes instead.""" return socketinst.multiscan_file(file) @_needs_socket def version(): """Deprecated API - use one of the Clamd*Socket classes instead.""" return socketinst.version() ############################################################################ def _non_regression_test(): """ This is for internal use """ import doctest doctest.testmod() return ############################################################################ def _print_doc(): """ This is for internal use """ import os os.system('pydoc ./{0}.py'.format(__name__)) return # MAIN ------------------- if __name__ == '__main__': _non_regression_test() ############################################################################ pyClamd-0.3.9/COPYING.LESSER0000664000175000017500000001674311352247751015073 0ustar xaelxael00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser 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 Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. pyClamd-0.3.9/__init__.py0000664000175000017500000000014512053742731015137 0ustar xaelxael00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- from pyclamd import __version__ from pyclamd import * pyClamd-0.3.9/setup.py0000664000175000017500000000330012356547455014550 0ustar xaelxael00000000000000 from distutils.core import setup, Extension pyclamd = Extension('pyclamd', sources = ['pyclamd.py']) # Install : python setup.py install # Register : python setup.py register try: import pyclamd except ImportError as x: # all we want is the version pyclamd.__version__ = 'unknown' setup (name = 'pyClamd', version = pyclamd.__version__, download_url = 'http://xael.org/norman/python/pyclamd/', package_dir={'pyclamd': ''}, packages=['pyclamd'], license ='License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)', author = 'Alexandre Norman', author_email = 'norman()xael.org', keywords='python, clamav, antivirus, scanner, virus, libclamav', url = 'http://xael.org/norman/python/pyclamd/', include_dirs = ['/usr/local/include'], description = 'pyClamd is a python interface to Clamd (Clamav daemon).', long_description = 'pyClamd is a python interface to Clamd (Clamav daemon). By using pyClamd, you can add virus detection capabilities to your python software in an efficient and easy way. Instead of pyClamav which uses libclamav, pyClamd may be used by a closed source product.', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Programming Language :: Python', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)', 'Operating System :: OS Independent', 'Topic :: System', 'Topic :: Security', ], )