Initializer script¶

Initialization script used to set necessary settings in ClamAV configuration file and correct permissions.

edeposit_clamd_init.REQUIRED_SETTINGS = {'MaxThreads': '2', 'LocalSocket': '/var/run/clamav/clamd.ctl', 'AllowSupplementaryGroups': 'true', 'ScanPE': 'true', 'FixStaleSocket': 'true', 'ReadTimeout': '180', 'LocalSocketMode': '666', 'LocalSocketGroup': '$groupname', 'ScanArchive': 'true', 'LogRotate': 'true', 'LogSyslog': 'false', 'User': '$username', 'LogTime': 'true', 'MaxConnectionQueueLength': '3', 'ScanELF': 'true', 'LogFile': '/var/log/clamav/clamav.log', 'PidFile': '/var/run/clamav/clamd.pid'}¶

All required settings is there, rest is not important.

edeposit_clamd_init.get_username()[source]¶

Return username depending on type of system (deb/suse).

edeposit_clamd_init.update_configuration(configuration)[source]¶

Set all configuration specified in REQUIRED_SETTINGS.

Parameters:	configuration (str) – Configuration file content.
Returns:	Updated configuration.
Return type:	str

edeposit_clamd_init.create_config(cnf_file, uid, overwrite)[source]¶

Creates configuration file and the directory where it should be stored and set correct permissions.

Parameters:	cnf_file (str) – Path to the configuration file. uid (int) – User ID - will be used for chown. overwrite (bool) – Overwrite the configuration with CLEAN_CONFIG.

edeposit_clamd_init.create_log(log_file, uid)[source]¶

Create log file and set necessary permissions.

Parameters:	log_file (str) – Path to the log file. uid (int) – User ID - will be used for chown.

edeposit_clamd_init.get_service_name()[source]¶

Return name of the daemon depending on the system type.

edeposit_clamd_init.main(*args, **kwargs)[source]¶

Create configuration and log file. Restart the daemon when configuration is done.

Parameters:	conf_file (str) – Path to the configuration file. overwrite (bool) – Overwrite the configuration file with clean config?

$ ./edeposit_clamd_init.py -h
usage: edeposit_clamd_init.py [-h] [-v] [-o] [-c CONFIG]

edeposit.amqp.antivirus ClamAV initializer.

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         Print logging messages.
  -o, --overwrite       Overwrite default configuration file. Don't worry,
                        your original file will be stored in backup_.
  -c CONFIG, --config CONFIG
                        Path to the configuration file. Default
                        /etc/clamav/clamd.conf.

antivirus package¶

There are two levels of abstraction - AMPQ API and python API.

AQMP API is higlevel API, where you send some structure, something happens in magick box and you get back another structure.

Python API is just collection of “lowlevel” python wrappers over ClamAV.

AMQP API¶

AMQP interface used by edeposit.amqp package.

antivirus.reactToAMQPMessage(message, send_back)[source]¶

React to given (AMQP) message. message is expected to be collections.namedtuple() structure from structures filled with all necessary data.

Parameters:	message (object) – One of the request objects defined in structures. send_back (fn reference) – Reference to function for responding. This is useful for progress monitoring for example. Function takes one parameter, which may be response structure/namedtuple, or string or whatever would be normally returned.
Returns:	Response class from structures.
Return type:	object
Raises:	ValueError – if bad type of message structure is given.

All AMQP communication structures can be found in structures submodule.

Antivirus wrapper¶

ClamAV wrapper to scan files for malware.

antivirus.antivirus.scan_file(path)[source]¶

Scan path for viruses using clamd or clamscan (depends on settings.USE_CLAMD.

Parameters:	path (str) – Relative or absolute path of file/directory you need to scan.
Returns:	{filename: ("FOUND", "virus type")} or blank dict.
Return type:	dict
Raises:	ValueError – When the server is not running. AssertionError – When the internal file doesn’t exists.

antivirus.antivirus.save_and_scan(filename, b64_data)[source]¶

Save b64_data to temporary file and scan it for viruses.

Parameters:	filename (str) – Name of the file - used as basename for tmp file. b64_data (str) – Content of the file encoded in base64.
Returns:	{filename: ("FOUND", "virus type")} or blank dict.
Return type:	dict

AMQP communication structures¶

Definitions of the communication structures used in edeposit.amqp.antivirus project.

class antivirus.structures.ScanFile[source]¶

Bases: antivirus.structures.ScanFile

Request to scan file.

Parameters:	filename (str) – Path of the file at your system. It will be used in result structure. b64_data (str) – Base64 encoded content of the file.
Returns:	ScanResult
Return type:	object

class antivirus.structures.UpdateDatabase[source]¶

Bases: antivirus.structures.UpdateDatabase

Request to update clamav database (= to run freshclam program).

Returns:	DatabaseUpdated
Return type:	object

class antivirus.structures.ScanResult[source]¶

Bases: antivirus.structures.ScanResult

Result of the file scan.

Parameters:	filename (str) – Name of the file as was specified in ScanFile request. result (dict) – Dictionary in following format:

{
    "local_path": ("RESULT", "TYPE")
}

Where RESULT is “FOUND” or string like that and TYPE is name of the malware.

Note

When no malware is found, result is blank dict.

class antivirus.structures.DatabaseUpdated[source]¶

Bases: antivirus.structures.DatabaseUpdated

Response to UpdateDatabase.

Attr:

log (str): Log of the freshclam run.

Settings and configuration¶

Module is containing all necessary global variables for the package.

Module also has the ability to read user-defined data from two paths:

• $HOME/_SETTINGS_PATH
• /etc/_SETTINGS_PATH

See _SETTINGS_PATH for details.

Example of the configuration file ($HOME/edeposit/antivirus.json):

{
    "USE_CLAMD": false
}

wrappers package¶

This package contains lowlevel wrappers over clamd, clamscan and freshclam.