Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: support port-only connection #122

Merged
merged 1 commit into from
Jul 3, 2024
Merged

fix: support port-only connection #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,12 @@ class NodeClam {
('preference' in this.settings && typeof this.settings.preference !== 'string') ||
!['clamscan', 'clamdscan'].includes(this.settings.preference)
) {
// If no valid scanner is found (but a socket/host is), disable the fallback to a local CLI scanning method
if (this.settings.clamdscan.socket || this.settings.clamdscan.host) {
// If no valid scanner is found (but a socket/port/host is), disable the fallback to a local CLI scanning method
if (this.settings.clamdscan.socket || this.settings.clamdscan.port || this.settings.clamdscan.host) {
this.settings.clamdscan.localFallback = false;
} else {
const err = new NodeClamError(
'Invalid virus scanner preference defined and no valid host/socket option provided!'
'Invalid virus scanner preference defined and no valid socket/port/host option provided!'
);
return hasCb ? cb(err, null) : reject(err);
}
Expand Down Expand Up @@ -238,11 +238,15 @@ class NodeClam {
) {
this.scanner = 'clamdscan';
} else {
// If preferred scanner is not a valid binary but there is a socket/host option, disable
// If preferred scanner is not a valid binary but there is a socket/port/host option, disable
// failover to local CLI implementation
if (!this.settings.clamdscan.socket && !this.settings.clamdscan.host) {
if (
!this.settings.clamdscan.socket &&
!this.settings.clamdscan.port &&
!this.settings.clamdscan.host
) {
const err = new NodeClamError(
'No valid & active virus scanning binaries are active and available and no host/socket option provided!'
'No valid & active virus scanning binaries are active and available and no socket/port/host option provided!'
);
return hasCb ? cb(err, null) : reject(err);
}
Expand All @@ -257,6 +261,7 @@ class NodeClam {
// Make sure quarantineInfected path exists at specified location
if (
!this.settings.clamdscan.socket &&
!this.settings.clamdscan.port &&
!this.settings.clamdscan.host &&
((this.settings.clamdscan.active === true && this.settings.clamdscan.localFallback === true) ||
this.settings.clamscan.active === true) &&
Expand All @@ -277,6 +282,7 @@ class NodeClam {
// If using clamscan, make sure definition db exists at specified location
if (
!this.settings.clamdscan.socket &&
!this.settings.clamdscan.port &&
!this.settings.clamdscan.host &&
this.scanner === 'clamscan' &&
this.settings.clamscan.db
Expand All @@ -292,8 +298,8 @@ class NodeClam {

// Make sure scanLog exists at specified location
if (
((!this.settings.clamdscan.socket && !this.settings.clamdscan.host) ||
((this.settings.clamdscan.socket || this.settings.clamdscan.host) &&
((!this.settings.clamdscan.socket && !this.settings.clamdscan.port && !this.settings.clamdscan.host) ||
((this.settings.clamdscan.socket || this.settings.clamdscan.port || this.settings.clamdscan.host) &&
this.settings.clamdscan.localFallback === true &&
this.settings.clamdscan.active === true) ||
(this.settings.clamdscan.active === false && this.settings.clamscan.active === true) ||
Expand All @@ -315,7 +321,7 @@ class NodeClam {
if (
this.scanner === 'clamdscan' &&
this.settings.clamdscan.bypassTest === false &&
(this.settings.clamdscan.socket || this.settings.clamdscan.host || this.settings.clamdscan.port)
(this.settings.clamdscan.socket || this.settings.clamdscan.port || this.settings.clamdscan.host)
) {
if (this.settings.debugMode)
console.log(`${this.debugLabel}: Initially testing socket/tcp connection to clamscan server.`);
Expand Down Expand Up @@ -885,7 +891,10 @@ class NodeClam {
};

// If user wants to connect via socket or TCP...
if (this.scanner === 'clamdscan' && (this.settings.clamdscan.socket || this.settings.clamdscan.host)) {
if (
this.scanner === 'clamdscan' &&
(this.settings.clamdscan.socket || this.settings.clamdscan.port || this.settings.clamdscan.host)
) {
const chunks = [];
let client;

Expand Down Expand Up @@ -1053,7 +1062,7 @@ class NodeClam {
}

// If user wants to scan via socket or TCP...
if (this.settings.clamdscan.socket || this.settings.clamdscan.host) {
if (this.settings.clamdscan.socket || this.settings.clamdscan.port || this.settings.clamdscan.host) {
// Scan using local unix domain socket (much simpler/faster process--especially with MULTISCAN enabled)
if (this.settings.clamdscan.socket) {
let client;
Expand Down Expand Up @@ -2032,7 +2041,11 @@ class NodeClam {
else if (typeof fileCb !== 'function' || !hasCb) {
// Scan locally via socket (either TCP or Unix socket)
// This is much simpler/faster process--potentially even more with MULTISCAN enabled)
if (this.settings.clamdscan.socket || (this.settings.clamdscan.port && this._isLocalHost())) {

if (
this.settings.clamdscan.socket ||
(this.settings.clamdscan.port && (!this.settings.clamdscan.host || this._isLocalHost()))
) {
let client;

try {
Expand Down Expand Up @@ -2213,7 +2226,7 @@ class NodeClam {
if (this.settings.debugMode) console.log(`${this.debugLabel}: Provided stream is readable.`);

// Verify that they have a valid socket or host/port config
if (!this.settings.clamdscan.socket && (!this.settings.clamdscan.port || !this.settings.clamdscan.host)) {
if (!this.settings.clamdscan.socket && !this.settings.clamdscan.port && !this.settings.clamdscan.host) {
const err = new NodeClamError(
{ clamdscanSettings: this.settings.clamdscan },
'Invalid information provided to connect to clamav service. A unix socket or port (+ optional host) is required!'
Expand Down
8 changes: 5 additions & 3 deletions tests/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,11 @@ describe('Initialized NodeClam module', () => {
expect(clamscan.scanner).to.eql('clamscan');
});

it('should fail if an invalid scanner preference is supplied when socket or host is not specified and localFallback is not false', () => {
it('should fail if an invalid scanner preference is supplied when socket or port or host is not specified and localFallback is not false', () => {
expect(resetClam({ preference: 'clamscan' }), 'valid scanner').to.not.be.rejectedWith(Error);
expect(resetClam({ preference: 'badscanner' }), 'invalid scanner').to.not.be.rejectedWith(Error);
expect(
resetClam({ clamdscan: { localFallback: true, socket: false, host: false }, preference: 'badscanner' }),
resetClam({ clamdscan: { localFallback: true, socket: false, port: false, host: false }, preference: 'badscanner' }),
'invalid scanner - no socket or host for local fallback'
).to.be.rejectedWith(Error);
});
Expand All @@ -230,6 +230,7 @@ describe('Initialized NodeClam module', () => {
active: true,
localFallback: true,
socket: false,
port: false,
host: false,
};
const clamscanOptions = { ...config.clamscan, path: `${__dirname}/should/not/exist`, active: true };
Expand All @@ -244,6 +245,7 @@ describe('Initialized NodeClam module', () => {
active: true,
localFallback: true,
socket: false,
port: false,
host: false,
};
const clamscanOptions = { ...config.clamscan, active: true };
Expand All @@ -257,7 +259,7 @@ describe('Initialized NodeClam module', () => {
});

it('should set definition database (clamscan) to null if specified db is not found', async () => {
const clamdScanOptions = { ...config.clamdscan, socket: false, host: false };
const clamdScanOptions = { ...config.clamdscan, socket: false, port: false, host: false };
const clamscanOptions = { ...config.clamscan, db: '/usr/bin/better_clam_db', active: true };

const options = { ...config, clamdscan: clamdScanOptions, clamscan: clamscanOptions, preference: 'clamscan' };
Expand Down