Artica Meta: ClamAV policy
Set the ClamAV antivirus engine and its signature exclusions of a fleet of Artica nodes from Artica Meta, and check the signature state of each node.
Back to Artica Meta · Artica Meta: Policies
The ClamAV policy sets the antivirus engine of a fleet of Artica nodes from the Meta console.
It carries the settings of the ClamAV status page and a list of signature exclusions.
The node list also shows the state of the signatures of each node.
Before this policy, each node was set by hand.
Scan limits, extra signature databases, the daemon watchdog and the reload policy could differ from one node to the next.
The policy imposes the same values on every attached node.
What the policy carries
The policy has two parts.
Each part is either Not defined or defined.
- A setting left Not defined is not sent.
Each node keeps its own value. - A defined setting is imposed on every attached node at the next Apply.
- The exclusion list works the same way.
When it is not defined, each node keeps its own exclusions.
The policy never installs or enables ClamAV.
Enabling the ClamAV service stays on each node.
On a node where ClamAV is disabled, the policy is stored but the daemon is left alone.
Settings
| Section | Setting | Values |
|---|---|---|
| Scan limits | Maximum stream length | 1 to 4096 MB |
| Scan limits | Maximum file size | 1 to 4096 MB |
| Scan limits | Maximum files in an archive | 1 to 1000000 |
| Scan limits | Maximum archive nesting | 1 to 64 |
| Scan limits | Scan URLs for phishing | On or off |
| Signature databases | SecuriteInfo databases | On or off |
| Signature databases | SecuriteInfo update interval | 5 minutes to 2 days |
| Signature databases | Unofficial databases | On or off |
| Daemon watchdog | Restart the daemon every | Never, or 15 minutes to 8 hours |
| Daemon watchdog | Restart the daemon above (memory) | 0 (disabled), or 1500 to 65536 MB |
| Reload policy | Non-blocking database reloads | On or off |
| Reload policy | No reload during production hours | On or off |
The SecuriteInfo update interval is only used when the SecuriteInfo databases are enabled.
The production hours themselves are set on each node.
They are not part of the policy.
Signature exclusions
An exclusion is a signature name, as ClamAV reports it.
For example Win.Test.EICAR_HDB-1.
ClamAV no longer reports a file that matches an excluded signature.
The name is case-sensitive.
The exclusions of the policy are added to the exclusions created on each node.
They never replace them.
- An exclusion created on a node stays when a policy is attached.
- A policy exclusion is always written, even when the node already has a local exclusion with the same name.
ClamAV receives each exclusion only once. - An exclusion can be disabled in the policy.
It stays in the list but ClamAV ignores it.
A policy holds at most 5000 exclusions.
The same limit applies after the policies of a node are merged.
Requirements
- Artica Meta.
- Nodes running Artica, with ClamAV installed.
- debian-agent 1.2.0 or later on every attached node.
- An articarest version on the node that serves the ClamAV policy.
Deploy in order: Artica Meta first, then the nodes.
A node with an older agent stays pending.
The reason says that Artica and the debian-agent must be updated.
Create the policy
- Open Artica Meta > Policies.
- Click New policy, choose the type ClamAV and enter a name.
- In the Settings tab, define the settings you want to impose.
- In the Exclusions tab, add signature names, one per line.
- In the Targets tab, attach agents or groups of agents.
- Click Apply.
Nothing is sent before Apply.
Import from a node
Click Import ClamAV from a node to start from a node that is already set up.
Meta creates a policy named after the node, with the settings of the node and the exclusions created on it.
The policy is attached to the node but not applied.
Check it, then click Apply.
Some items cannot be carried by a policy.
Meta lists them after the import, with the reason.
A node that already has a ClamAV policy attached, directly or through a group, cannot be imported.
What happens on the node
The node writes the defined settings and the policy exclusions.
Then it rebuilds the ClamAV configuration.
The node respects its own reload policy.
A change that only touches the exclusions never restarts the ClamAV daemon.
New signatures load at the next reload allowed by the node.
If No reload during production hours is on, that reload waits for the end of the production hours.
If something fails, the node restores its previous configuration.
A temporary error leaves the delivery pending, and Meta sends the policy again.
While the policy holds the node, the local console changes:
- The ClamAV status page shows a banner.
The settings defined by the policy are read-only.
The other settings stay editable. - The exclusion page marks the policy exclusions Artica Meta.
They cannot be changed or deleted on the node.
The exclusions created on the node stay editable.
Detaching a node
When a node no longer receives any ClamAV policy, it is released.
- The policy exclusions are removed from the node.
- The exclusions created on the node stay.
- The settings keep their current value.
- The lock on the local console is lifted.
If Meta is gone, run this command on the node:
articarest -clamav-meta-release
Delivery status
The Delivery status tab shows the last sending of the policy to each node.
Click a node name to open its ClamAV state.
ClamAV state of a node
In Artica Meta > Agents list, a node where ClamAV is enabled shows a ClamAV tag.
Click it to open the ClamAV state window.
The window is read-only.
It never changes anything on the node.
It shows:
- ClamAV service: installed, enabled, running, version and memory used.
It also tells whether a policy manages the node. - Last update: date and result of the last signature download, with the last error.
- Signature databases: one card per database.
Each card shows the date, the version, the number of signatures and the age of the database.
| State | Meaning |
|---|---|
| Up to date | Updated less than 24 hours ago |
| Aging | Updated between 24 hours and 3 days ago |
| Outdated | Not updated for more than 3 days |
| Empty | No signature |
The main, daily and bytecode databases are marked Official.
The others (SecuriteInfo, unofficial databases) are marked Third party.
A node without ClamAV shows ClamAV is not installed on this node.
A node with an older agent shows Update needed.
Clusters
The policy follows the cluster.
A cluster slave receives it through its master.
The master copies its ClamAV settings and its exclusions to its slaves.
An HaCluster client is not redirected to its load balancer.
It receives the policy and applies it like any other node.
Each Squid of an HaCluster runs its own ClamAV daemon.
ClamAV policy and tenants
A tenant creates ClamAV policies for its own nodes.
It can open the ClamAV state of its own nodes only.
Known limits
- The production hours are not part of the policy.
- A node where ClamAV is disabled stores the settings and the exclusions.
It does not configure or start the ClamAV daemon. - The window shows the last state read on the node.
Click Refresh to read it again.