diff --git a/others/spec_sheets_generation_script/exports/clamav.md b/others/spec_sheets_generation_script/exports/clamav.md new file mode 100644 index 0000000..08ac2d0 --- /dev/null +++ b/others/spec_sheets_generation_script/exports/clamav.md @@ -0,0 +1,184 @@ +# ClamAV + +## Metadata + +- **Identifier**: `clamav` +- **Maturity**: Production + +### Categories + +- Antimalware +- Host Protection + +## Description + +Clam AntiVirus (ClamAV) is a free software, cross-platfom antimalware toolkit able to detect many types of malware, including viruses. ClamAV includes a command-line scanner, automatic database updater, and a scalable multi-threaded daemon running on an anti-virus engine from a shared library. FreshClam is a virus database update tool for ClamAV. ClamAV Daemon checks periodically for virus database definition updates, downloads, installs them, and notifies clamd to refresh it's in-memory virus database cache. + +## Actions + + + + + + + + + + + + + + + + +
IdentifierDescriptionExpected Parameters Keys and Types
start_scanStarts the scan containing the predifined scan options: Quarantine Location and Scan Log Location. Also, it requires the input of Scan Location.scan_location (STRING)
+ +## Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IdentifierDescriptionTypePropertiesDefault Value
daily_infected_files_detectedTotal number of infected files detected todayINTEGERMETRIC, READ_ONLY
quarantine_locationThe location where the infected files will be moved to after the on-demand/crontab scans. Select a directory in which the quarantine will take place if you would like to change.STRINGMANDATORY, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE/opt/mutablesecurity/clamav/quarantine/
scan_day_of_monthThe day (1-31, or * for any) of the month when the crontab scan will take placeSTRINGOPTIONAL, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE*
scan_day_of_weekThe day (0-6, SUN-SAT, 7 for Sunday or * for any) of the week when the crontab scan will take placeSTRINGOPTIONAL, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLEMON
scan_hourThe hour (0-23, or * for any) when the crontab scan will take placeSTRINGOPTIONAL, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE0
scan_locationThe location where the on-demand/crontab scans will take place.Select a different directory if you would like to change.STRINGMANDATORY, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE/
scan_log_locationThe location of the generated logs after the on-demand/crontab scans.Chose a file in which the logs will be stored if you would like to change.STRINGMANDATORY, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE/opt/mutablesecurity/clamav/logs/logs.txt
scan_minuteThe minute (0-59, or * for any) when the crontab scan will take placeSTRINGOPTIONAL, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE0
scan_monthThe month (1-12, JAN-DEC, or * for any) when the crontab scan will take placeSTRINGOPTIONAL, WITH_DEFAULT_VALUE, CONFIGURATION, NON_DEDUCTIBLE, WRITABLE*
total_infected_files_detectedTotal number of infected files detected overallINTEGERMETRIC, READ_ONLY
versionInstalled versionSTRINGMETRIC, READ_ONLY
+ +## Logs + + + + + + + + + + + + + + +
IdentifierDescription
logsThe logs generated by ClamAV and FreshClam
+ +## Tests + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IdentifierDescriptionType
active_databaseChecks if the ClamAV virus database service is active.OPERATIONAL
eicar_detectionCreates a EICAR-STANDARD-ANTIVIRUS-TEST-FILE and checks if ClamAV is able to detect it.SECURITY
internet_accessChecks if host has Internet access.REQUIREMENT
ubuntuChecks if the operating system is Ubuntu.REQUIREMENT
+ +## References + +- [https://www.clamav.net/](https://www.clamav.net/) +- [https://github.com/Cisco-Talos/clamav](https://github.com/Cisco-Talos/clamav) +- [https://docs.clamav.net/Introduction.html](https://docs.clamav.net/Introduction.html) diff --git a/others/spec_sheets_generation_script/exports/solutions.json b/others/spec_sheets_generation_script/exports/solutions.json index 1c07e16..1d0d905 100644 --- a/others/spec_sheets_generation_script/exports/solutions.json +++ b/others/spec_sheets_generation_script/exports/solutions.json @@ -1 +1 @@ -[{"identifier": "teler", "full_name": "teler", "maturity": "Production", "description": "teler is a real-time intrusion detection and threat alert based on web log. Targets only nginx installed on Ubuntu.", "categories": ["Web Intrusion Detection System"]}, {"identifier": "fail2ban", "full_name": "Fail2ban", "maturity": "Production", "description": "Fail2ban is an intrusion prevention software framework that protects Unix-like servers from brute-force attacks. It scans log files and bans IP addresses conducting too many failed operations (for example, login attempts). This module targets Debian-based operating systems and has already set a SSH jail.", "categories": ["Host Intrusion Prevention System"]}, {"identifier": "suricata", "full_name": "Suricata", "maturity": "Under refactoring", "description": "Suricata is the leading independent open source threat detection engine. By combining intrusion detection (IDS), intrusion prevention (IPS), network security monitoring (NSM) and PCAP processing, Suricata can quickly identify, stop, and assess even the most sophisticated attacks.", "categories": ["Network Intrusion Detection and Prevention System"]}, {"identifier": "lets_encrypt", "full_name": "Let's Encrypt x Certbot", "maturity": "Under refactoring", "description": "Let's Encrypt is a free, automated, and open certificate authority brought to you by the nonprofit Internet Security Research Group (ISRG). Certbot is a free, open source software tool for automatically using Let's Encrypt certificates on manually-administrated websites to enable HTTPS.", "categories": ["Encryption for Web Applications"]}] \ No newline at end of file +[{"identifier": "clamav", "full_name": "ClamAV", "maturity": "Production", "description": "Clam AntiVirus (ClamAV) is a free software, cross-platfom antimalware toolkit able to detect many types of malware, including viruses. ClamAV includes a command-line scanner, automatic database updater, and a scalable multi-threaded daemon running on an anti-virus engine from a shared library. FreshClam is a virus database update tool for ClamAV. ClamAV Daemon checks periodically for virus database definition updates, downloads, installs them, and notifies clamd to refresh it's in-memory virus database cache.", "categories": ["Antimalware", "Host Protection"]}, {"identifier": "teler", "full_name": "teler", "maturity": "Production", "description": "teler is a real-time intrusion detection and threat alert based on web log. Targets only nginx installed on Ubuntu.", "categories": ["Web Intrusion Detection System"]}, {"identifier": "fail2ban", "full_name": "Fail2ban", "maturity": "Production", "description": "Fail2ban is an intrusion prevention software framework that protects Unix-like servers from brute-force attacks. It scans log files and bans IP addresses conducting too many failed operations (for example, login attempts). This module targets Debian-based operating systems and has already set a SSH jail.", "categories": ["Host Intrusion Prevention System"]}, {"identifier": "lets_encrypt", "full_name": "Let's Encrypt x Certbot", "maturity": "Under refactoring", "description": "Let's Encrypt is a free, automated, and open certificate authority brought to you by the nonprofit Internet Security Research Group (ISRG). Certbot is a free, open source software tool for automatically using Let's Encrypt certificates on manually-administrated websites to enable HTTPS.", "categories": ["Encryption for Web Applications"]}, {"identifier": "suricata", "full_name": "Suricata", "maturity": "Under refactoring", "description": "Suricata is the leading independent open source threat detection engine. By combining intrusion detection (IDS), intrusion prevention (IPS), network security monitoring (NSM) and PCAP processing, Suricata can quickly identify, stop, and assess even the most sophisticated attacks.", "categories": ["Network Intrusion Detection and Prevention System"]}] \ No newline at end of file