Feature add fdscan

.github/workflows/tests.yml

@@ -0,0 +1,56 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: '*'
+
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'The branch, tag or SHA to release from'
+        required: true
+        default: 'master'
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python: [3.6]
+        os: [ubuntu-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.inputs.branch }}
+      - name: Use Python ${{ matrix.python }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install test dependencies
+        run: python -m pip install pytest
+
+      - name: Install current version of the clamd package
+        run: python -m pip install -e .
+
+      - name: Install and update clamav engine
+        run: |
+          sudo apt update
+          sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs --yes
+          sudo systemctl stop clamav-freshclam.service
+          sudo freshclam --verbose
+          sudo systemctl restart clamav-daemon.service
+
+      - name: Wait for 25 seconds until clamd socket becomes available
+        run: |
+          secs=25
+          while [[ $secs -gt 0 ]] && ! [[ -f "/var/run/clamav/clamd.ctl" ]];
+          do
+              echo -ne "$secs\033[0K\r"
+              sleep 1
+              : $((secs--))
+          done
+
+      - name: Run unit tests
+        run: pytest

CHANGES.md

@@ -0,0 +1,29 @@
+# Changes
+
+## 1.0.3 (unreleased)
+
+-   Nothing changed yet.
+
+## 1.0.2 (2014-08-21)
+
+-   Remove all dependencies. clamd is now standalone!
+-   Use plain setuptools no d2to1.
+-   Create universal wheel.
+
+## 1.0.1 (2013-03-06)
+
+-   Updated d2to1 dependency
+
+## 1.0.0 (2013-02-08)
+
+-   Change public interface, including exceptions
+-   Support Python 3.3, withdraw 2.5 support
+
+## 0.3.4 (2013-02-01)
+
+-   Use regex to parse file status reponse instead of complicated string
+    split/join
+
+## 0.3.3 (2013-01-28)
+
+-   First version of clamd that can be installed from PyPI

README.md

@@ -0,0 +1,62 @@
+# clamd
+
+`clamd` is a portable Python module to use the ClamAV anti-virus engine on Windows, Linux, MacOSX and other platforms. It requires a running instance of the clamd daemon.
+
+### History
+
+This is a fork of `pyClamd` (v0.2.0) created by Philippe Lagadec and published on [his](http://www.decalage.info/en/python/pyclamd) website, which in turn is a slightly improved version of `pyClamd` (v0.1.1) created by Alexandre Norman and published on [his](http://xael.org/norman/python/pyclamd/) website.
+
+## Installation
+
+Make sure you have installed both `clamav` engine and `clamav-daemon`, for instance, you can install it on Ubuntu by running the following commands:
+
+```bash
+apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
+freshclam  # update the database
+systemctl start clamav-daemon
+```
+
+```bash
+pip install clamd
+```
+
+## Usage/Examples
+
+To use with a Unix socket:
+
+```python
+>>> import clamd
+>>> cd = clamd.ClamdUnixSocket()
+>>> cd.ping()
+'PONG'
+>>> cd.version()                             # doctest: +ELLIPSIS
+'ClamAV ...
+>>> cd.reload()
+'RELOADING'
+```
+
+To scan a file:
+
+```python
+>>> open('/tmp/EICAR','wb').write(clamd.EICAR)
+>>> cd.scan('/tmp/EICAR')
+{'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')}
+```
+
+To scan a stream:
+```python
+>>> from io import BytesIO
+>>> cd.instream(BytesIO(clamd.EICAR))
+{'stream': ('FOUND', 'Eicar-Test-Signature')}
+```
+`clamav` daemon runs under `clamav` user and might not be able to scan files owned by other users or root user, in this case you can use `fdscan` function which opens a file and then passes the file descriptor to `clamav` daemon:
+
+```python
+>>> open('/tmp/EICAR','wb').write(clamd.EICAR)
+>>> cd.fdscan('/tmp/EICAR')
+{'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')}
+```
+
+## License
+
+clamd is released as open-source software under the LGPL license.

setup.cfg

@@ -1,5 +1,39 @@
-[nosetests]
-with-doctest=1
+[metadata]
+author = "Thomas Grainger"
+author_email = [email protected]
+classifiers =
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+license = GNU Library or Lesser General Public License (LGPL)
+name = clamd
+description = "Clamd is a python interface to Clamd (Clamav daemon)."
+long_description = file:README.md
+long_description_content_type = text/markdown
+keywords = python, clamav, antivirus, scanner, virus, libclamav, clamd
+project_urls =
+    Source Code = https://github.com/graingert/python-clamd
+    Change Log = https://github.com/graingert/python-clamd/blob/master/CHANGES.md
+url = https://github.com/graingert/python-clamd
+version = 1.0.3.dev0
 
-[wheel]
-universal=1
+[options]
+include_package_data = False
+zip_safe = True
+package_dir =
+    =src
+packages = find:
+python_requires = >=3.6
+
+[options.packages.find]
+where=src
+exclude =
+    src.tests
+
+[bdist_wheel]
+universal = 1
+
+[flake8]
+max_line_length = 117

setup.py

@@ -1,28 +1,4 @@
-#!/usr/bin/env python
-from ez_setup import use_setuptools
-use_setuptools()
+#!/usr/bin/env python3
+from setuptools import setup
 
-from setuptools import setup, find_packages
-
-readme = open('README.rst').read()
-history = open('CHANGES.rst').read().replace('.. :changelog:', '')
-
-setup(
-    name="clamd",
-    version='1.0.3.dev0',
-    author="Thomas Grainger",
-    author_email="[email protected]",
-    maintainer="Thomas Grainger",
-    maintainer_email = "[email protected]",
-    keywords = "python, clamav, antivirus, scanner, virus, libclamav, clamd",
-    description = "Clamd is a python interface to Clamd (Clamav daemon).",
-    long_description=readme + '\n\n' + history,
-    url="https://github.com/graingert/python-clamd",
-    package_dir={'': 'src'},
-    packages=find_packages('src', exclude="tests"),
-    classifiers = [
-        "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
-    ],
-    zip_safe=True,
-    include_package_data=False,
-)
+setup()

src/clamd/__init__.py

@@ -1,26 +1,22 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 try:
-    __version__ = __import__('pkg_resources').get_distribution('clamd').version
-except:
-    __version__ = ''
-
-# $Source$
-
+    __version__ = __import__("pkg_resources").get_distribution("clamd").version
+except ImportError:
+    __version__ = ""
 
-import socket
-import sys
-import struct
+import base64
 import contextlib
 import re
-import base64
+import socket
+import struct
+import sys
+from multiprocessing.reduction import sendfds
 
-scan_response = re.compile(r"^(?P<path>.*): ((?P<virus>.+) )?(?P<status>(FOUND|OK|ERROR))$")
+scan_response = re.compile(
+    r"^(?P<path>.*): ((?P<virus>.+) )?(?P<status>(FOUND|OK|ERROR))$"
+)
 EICAR = base64.b64decode(
-    b'WDVPIVAlQEFQWzRcUFpYNTQoUF4pN0NDKTd9JEVJQ0FSLVNUQU5E'
-    b'QVJELUFOVElWSVJVUy1URVNU\nLUZJTEUhJEgrSCo=\n'
+    b"WDVPIVAlQEFQWzRcUFpYNTQoUF4pN0NDKTd9JEVJQ0FSLVNUQU5E"
+    b"QVJELUFOVElWSVJVUy1URVNU\nLUZJTEUhJEgrSCo=\n"
 )
 
 
@@ -313,3 +309,16 @@ def _error_message(self, exception):
                 path=self.unix_socket,
                 msg=exception.args[1]
             )
+
+    def fdscan(self, file):
+        """Scan a file referenced by a file descriptor."""
+        try:
+            self._init_socket()
+            with open(file, mode="rb") as fp:
+                self._send_command("FILDES")
+                sendfds(self.clamd_socket, [fp.fileno()])
+                result = self._recv_response()
+                _, reason, status = self._parse_response(result)
+                return {file: (status, reason)}
+        finally:
+            self._close_socket()