Crate clamav_client

source ·
Expand description

Rust ClamAV Client

A simple ClamAV client to send files, in-memory data, and Tokio streams to clamd for antivirus scanning.

Please note: The functions ping_socket, scan_file_socket, scan_buffer_socket, and scan_stream_socket are only available on Unix platforms.

Workflow status

Installation

Add this to your Cargo.toml:

[dependencies]
clamav-client = "0.4.2"

To use the async functions in clamav_client::tokio, add this to your Cargo.toml:

[dependencies]
clamav-client = { version = "0.4.2", features = ["tokio"] }

To scan Tokio streams, enable the tokio-stream feature instead and add this to your Cargo.toml:

[dependencies]
clamav-client = { version = "0.4.2", features = ["tokio-stream"] }

Preliminary support for async-std is also available by enabling the async-std feature:

[dependencies]
clamav-client = { version = "0.4.2", features = ["async-std"] }

Usage

let clamd_host_address = "localhost:3310";

// Ping clamd to make sure the server is available and accepting TCP connections
let clamd_available = match clamav_client::ping_tcp(clamd_host_address) {
    Ok(ping_response) => ping_response == b"PONG\0",
    Err(_) => false,
};

if !clamd_available {
    println!("Cannot ping clamd at {}", clamd_host_address);
    return;
}

// Scan file for viruses
let file_path = "tests/eicar.txt";
let scan_file_response = clamav_client::scan_file_tcp(file_path, clamd_host_address, None).unwrap();
let file_clean = clamav_client::clean(&scan_file_response).unwrap();
if file_clean {
    println!("No virus found in {}", file_path);
} else {
    println!("The file {} is infected!", file_path);
}

// Scan in-memory data for viruses
let buffer = br#"X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*"#;
let scan_buffer_response = clamav_client::scan_buffer_tcp(buffer, clamd_host_address, None).unwrap();
let data_clean = clamav_client::clean(&scan_buffer_response).unwrap();
if data_clean {
    println!("No virus found");
} else {
    println!("The data is infected!");
}

Usage - Async with Tokio

#[cfg(feature = "tokio")]
async fn tokio_example() {
    let clamd_host_address = "localhost:3310";

    // Ping clamd asynchronously and await the result
    let clamd_available = match clamav_client::tokio::ping_tcp(clamd_host_address).await {
        Ok(ping_response) => ping_response == b"PONG\0",
        Err(_) => false,
    };

    if !clamd_available {
        println!("Cannot ping clamd at {}", clamd_host_address);
        return;
    }

    let file_path = "tests/eicar.txt";
    let buffer = br#"X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*"#;

    // Concurrently scan a file and a data buffer for viruses
    let (scan_file_result, scan_buffer_result) = tokio::join!(
        clamav_client::tokio::scan_file_tcp(file_path, clamd_host_address, None),
        clamav_client::tokio::scan_buffer_tcp(buffer, clamd_host_address, None)
    );

    let scan_file_response = scan_file_result.unwrap();
    let file_clean = clamav_client::clean(&scan_file_response).unwrap();
    if file_clean {
        println!("No virus found in {}", file_path);
    } else {
        println!("The file {} is infected!", file_path);
    }

    let scan_buffer_response = scan_buffer_result.unwrap();
    let data_clean = clamav_client::clean(&scan_buffer_response).unwrap();
    if data_clean {
        println!("No virus found");
    } else {
        println!("The data is infected!");
    }
}

More examples can be found in the tests.

Development

Testing locally

For the tests to pass, you should start clamd as follows:

clamd -F --config-file=tests/clamav/clamd.conf --datadir=tests/clamav/database/

and then run cargo test --all-features to cover all tests.

It doesn’t really matter how you start clamd, as long as the options from clamd.conf are the same for your configuration.

Contributors

Modules

Functions

  • clean
    Checks whether the ClamAV response indicates that the scanned content is clean or contains a virus
  • ping_socket
    Sends a ping request to ClamAV using a Unix socket connection
  • ping_tcp
    Sends a ping request to ClamAV using a TCP connection
  • scan_buffer_socket
    Scans a data buffer for viruses using a Unix socket connection
  • scan_buffer_tcp
    Scans a data buffer for viruses using a TCP connection
  • scan_file_socket
    Scans a file for viruses using a Unix socket connection
  • scan_file_tcp
    Scans a file for viruses using a TCP connection

Type Aliases