Added changes from #107 (without dependency changes).

kylefarris · Mar 18, 2024 · 78141b8 · 78141b8
1 parent 364b6c6
commit 78141b8
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 34 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,16 +18,21 @@ jobs:
         run: sudo apt-get install clamav clamav-daemon
       - name: Restart Freshclam
         run: sudo systemctl restart clamav-freshclam
-      - name: Chill for 30 seconds
-        run: sleep 30
-      - name: Restart ClamD
-        run: sudo systemctl restart clamav-daemon
-      - name: Chill for 30 seconds again
-        run: sleep 30
+      - name: Wait for freshclam to be up to date
+        run: |
+          until sudo grep "$(date | cut -c -10)" /var/log/clamav/freshclam.log | grep -Eq 'Clamd was NOT notified|Clamd successfully notified about the update.'; do sleep 1; done;
+          sudo tail /var/log/clamav/freshclam.log
+      - name: Remove Syslog from ClamD Config & Restard ClamD
+        run: |
+          sudo systemctl stop clamav-daemon;
+          sudo sed -i /syslog/d /lib/systemd/system/clamav-daemon.service;
+          sudo systemctl daemon-reload;
+          cat /lib/systemd/system/clamav-daemon.service;
+          sudo systemctl start clamav-daemon;
       - name: Install OpenSSL
         run: sudo apt-get install openssl
       - name: Generate Key Pair for TLS
-        run: openssl req -new -sha256 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -newkey ed25519 -keyout key.pem -nodes -x509 -days 365 -out cert.pem
+        run: openssl req -new -sha256 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -addext "subjectAltName = DNS:localhost,IP:127.0.0.1,IP:::1" -newkey ed25519 -keyout key.pem -nodes -x509 -days 365 -out cert.pem
       - name: Install stunnel
         run: sudo apt-get install stunnel4
       - name: Install / Trust certificate
@@ -39,9 +44,13 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Set stunnel config
-        run: sudo cp tests/stunnel.conf /etc/stunnel/
+        run: |
+          sudo cp tests/stunnel.conf /etc/stunnel/
+          sudo sed -i "s/\/var\/run\/clamd.scan\/clamd.sock/$(sudo cat /etc/clamav/clamd.conf |grep "LocalSocket "|cut -d " " -f 2 | sed 's/\//\\\//g')/" /etc/stunnel/stunnel.conf
       - name: Restart stunnel
-        run: sudo /etc/init.d/stunnel4 restart
+        run: |
+          sudo systemctl restart stunnel4;
+          sudo ss -tlnp;
       - name: Open ~ for all users to read
         run: chmod 755 ~
       - name: Use Node.js ${{ matrix.node-version }}
@@ -50,5 +59,17 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm ci
+      - name: Wait for ClamD Socket
+        run: |
+          sudo systemctl status clamav-daemon
+          until [ -S $(cat /etc/clamav/clamd.conf |grep "LocalSocket "|cut -d ' ' -f 2) ]; do sleep 1; done
       - name: Run tests
         run: npm test
+        env:
+          NODE_EXTRA_CA_CERTS: /usr/local/share/ca-certificates/snakeoil.crt
+      - name: debug?
+        if: ${{ failure() }}
+        run: |
+          sudo journalctl -e -u stunnel4;
+          sudo journalctl -e -u clamav-daemon;
+          echo 'PING' | openssl s_client --connect localhost:3311 -ign_eof;
diff --git a/Makefile b/Makefile
@@ -10,7 +10,7 @@ test: all
 	@mkdir -p tests/mixed_scan_dir/folder1
 	@mkdir -p tests/mixed_scan_dir/folder2
 	@touch tests/clamscan-log
-	@./node_modules/.bin/mocha --exit --trace-warnings --trace-deprecation --retries 0 --full-trace --timeout 5000 --check-leaks --reporter spec $(TESTS)
+	@./node_modules/.bin/mocha --exit --trace-warnings --trace-deprecation --retries 1 --full-trace --timeout 5000 --check-leaks --reporter spec $(TESTS)
 
 clean:
 	rm -rf node_modules
diff --git a/tests/index.js b/tests/index.js
@@ -22,7 +22,7 @@ const goodFileList = `${__dirname}/good_files_list.txt`;
 const badScanDir = `${__dirname}/bad_scan_dir`;
 const badScanFile = `${badScanDir}/bad_file_1.txt`;
 const badFileList = `${__dirname}/bad_files_list.txt`;
-const mixedScanDir = `${__dirname}/mixed_scan_dir`
+const mixedScanDir = `${__dirname}/mixed_scan_dir`;
 const passthruFile = `${__dirname}/output`;
 const noVirusUrl = 'https://raw.githubusercontent.com/kylefarris/clamscan/master/README.md';
 const fakeVirusFalseNegatives = [
@@ -459,7 +459,7 @@ describe('isInfected', () => {
 
     it('should require second parameter to be a callback function (if truthy value provided)', () => {
         expect(() => clamscan.isInfected(goodScanFile), 'nothing provided').to.not.throw(Error);
-        expect(() => clamscan.isInfected(goodScanFile, () => { }), 'good function provided').to.not.throw(Error);
+        expect(() => clamscan.isInfected(goodScanFile, () => {}), 'good function provided').to.not.throw(Error);
         expect(() => clamscan.isInfected(goodScanFile, undefined), 'undefined provided').to.not.throw(Error);
         expect(() => clamscan.isInfected(goodScanFile, null), 'null provided').to.not.throw(Error);
         expect(() => clamscan.isInfected(goodScanFile, ''), 'empty string provided').to.not.throw(Error);
@@ -1139,7 +1139,7 @@ describe('scanDir', () => {
     });
 
     it('should require the second parameter to be a callback function (if supplied)', () => {
-        const cb = (err, goodFiles, badFiles) => { };
+        const cb = (err, goodFiles, badFiles) => {};
         expect(() => clamscan.scanDir(goodScanDir, cb), 'good function provided').to.not.throw(Error);
         expect(() => clamscan.scanDir(goodScanDir), 'nothing provided').to.not.throw(Error);
         expect(() => clamscan.scanDir(goodScanDir, undefined), 'undefined provided').to.not.throw(Error);
@@ -1617,27 +1617,55 @@ describe('passthrough', () => {
     }
 });
 
-describe('tls', () => {
-    let clamscan;
+if (process.env.CI) {
+    describe('tls', () => {
+        let clamscan;
 
-    it('Connects to clamd server via a TLS proxy', async () => {
-        clamscan = await resetClam({
-            clamdscan: {
-                host: 'localhost',
-                port: 3311,
-                tls: true,
-            },
+        it('Connects to clamd server via a TLS proxy on localhost', async () => {
+            clamscan = await resetClam({
+                clamdscan: {
+                    host: 'localhost',
+                    port: 3311,
+                    socket: false,
+                    tls: true,
+                },
+            });
+            (await clamscan._ping()).end();
         });
-        (await clamscan._ping()).end();
-    });
 
-    it('Connects to clamd server via a TLS proxym on localhost', async () => {
-        clamscan = await resetClam({
-            clamdscan: {
-                port: 3311,
-                tls: true,
-            },
+        it('Connects to clamd server via a TLS proxy on 127.0.0.1', async () => {
+            clamscan = await resetClam({
+                clamdscan: {
+                    host: '127.0.0.1',
+                    port: 3311,
+                    socket: false,
+                    tls: true,
+                },
+            });
+            (await clamscan._ping()).end();
+        });
+
+        it('Connects to clamd server via a TLS proxy on ::1', async () => {
+            clamscan = await resetClam({
+                clamdscan: {
+                    host: '::1',
+                    port: 3311,
+                    socket: false,
+                    tls: true,
+                },
+            });
+            (await clamscan._ping()).end();
+        });
+
+        it('Connects to clamd server via a TLS proxy on implicit localhost', async () => {
+            clamscan = await resetClam({
+                clamdscan: {
+                    host: false,
+                    port: 3311,
+                    socket: false,
+                    tls: true,
+                },
+            });
         });
-        (await clamscan._ping()).end();
     });
-});
+}
diff --git a/tests/stunnel.conf b/tests/stunnel.conf
@@ -1,5 +1,5 @@
 [clamd-tls]
-accept = 3311
-connect = 3310
+accept = :::3311
+connect = /var/run/clamd.scan/clamd.sock
 cert = /etc/stunnel/cert.pem
 key = /etc/stunnel/key.pem