clamav/libclamav/readdb.h
Val Snyder 8d485b9bfd
FIPS-compliant CVD signing and verification
Add X509 certificate chain based signing with PKCS7-PEM external
signatures distributed alongside CVD's in a custom .cvd.sign format.
This new signing and verification mechanism is primarily in support
of FIPS compliance.

Fixes: https://github.com/Cisco-Talos/clamav/issues/564

Add a Rust implementation for parsing, verifying, and unpacking CVD
files.

Now installs a 'certs' directory in the app config directory
(e.g. <prefix>/etc/certs). The install location is configurable.
The CMake option to configure the CVD certs directory is:
  `-D CVD_CERTS_DIRECTORY=PATH`

New options to set an alternative CVD certs directory:
- Commandline for freshclam, clamd, clamscan, and sigtool is:
  `--cvdcertsdir PATH`
- Env variable for freshclam, clamd, clamscan, and sigtool is:
  `CVD_CERTS_DIR`
- Config option for freshclam and clamd is:
  `CVDCertsDirectory PATH`

Sigtool:
- Add sign/verify commands.
- Also verify CDIFF external digital signatures when applying CDIFFs.
- Place commonly used commands at the top of --help string.
- Fix up manpage.

Freshclam:
- Will try to download .sign files to verify CVDs and CDIFFs.
- Fix an issue where making a CLD would only include the CFG file for
daily and not if patching any other database.

libclamav.so:
- Bump version to 13:0:1 (aka 12.1.0).
- Also remove libclamav.map versioning.
  Resolves: https://github.com/Cisco-Talos/clamav/issues/1304
- Add two new API's to the public clamav.h header:
  ```c
  extern cl_error_t cl_cvdverify_ex(const char *file,
                                    const char *certs_directory);

  extern cl_error_t cl_cvdunpack_ex(const char *file,
                                    const char *dir,
                                    bool dont_verify,
                                    const char *certs_directory);
  ```
  The original `cl_cvdverify` and `cl_cvdunpack` are deprecated.
- Add `cl_engine_field` enum option `CL_ENGINE_CVDCERTSDIR`.
  You may set this option with `cl_engine_set_str` and get it
  with `cl_engine_get_str`, to override the compiled in default
  CVD certs directory.

libfreshclam.so: Bump version to 4:0:0 (aka 4.0.0).

Add sigtool sign/verify tests and test certs.

Make it so downloadFile doesn't throw a warning if the server
doesn't have the .sign file.

Replace use of md5-based FP signatures in the unit tests with
sha256-based FP signatures because the md5 implementation used
by Python may be disabled in FIPS mode.
Fixes: https://github.com/Cisco-Talos/clamav/issues/1411

CMake: Add logic to enable the Rust openssl-sys / openssl-rs crates
to build against the same OpenSSL library as is used for the C build.
The Rust unit test application must also link directly with libcrypto
and libssl.

Fix some log messages with missing new lines.

Fix missing environment variable notes in --help messages and manpages.

Deconflict CONFDIR/DATADIR/CERTSDIR variable names that are defined in
clamav-config.h.in for libclamav from variable that had the same name
for use in clamav applications that use the optparser.

The 'clamav-test' certs for the unit tests will live for 10 years.
The 'clamav-beta.crt' public cert will only live for 120 days and will
be replaced before the stable release with a production 'clamav.crt'.
2025-03-26 19:33:25 -04:00

220 lines
8.1 KiB
C

/*
* Copyright (C) 2013-2025 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
* Copyright (C) 2007-2013 Sourcefire, Inc.
* Copyright (C) 2002-2007 Tomasz Kojm <tkojm@clamav.net>
*
* Authors: Tomasz Kojm
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
#ifndef __READDB_H
#define __READDB_H
#if HAVE_CONFIG_H
#include "clamav-config.h"
#endif
#include "clamav.h"
#include "str.h"
#include "cvd.h"
#include "matcher.h"
#define MAX_LDB_SUBSIGS 64
struct cli_matcher;
/* NOTE: We don't include .info in CLI_DBEXT because they are only used for
* one specific purpose - verifying the contents of database container files.
* This list is geared towards file extensions of files that users can provide
* to ClamAV directly. */
#ifdef HAVE_YARA
#define CLI_DBEXT(ext) \
( \
cli_strbcasestr(ext, ".db") || \
cli_strbcasestr(ext, ".hdb") || \
cli_strbcasestr(ext, ".hdu") || \
cli_strbcasestr(ext, ".fp") || \
cli_strbcasestr(ext, ".mdb") || \
cli_strbcasestr(ext, ".mdu") || \
cli_strbcasestr(ext, ".hsb") || \
cli_strbcasestr(ext, ".hsu") || \
cli_strbcasestr(ext, ".sfp") || \
cli_strbcasestr(ext, ".msb") || \
cli_strbcasestr(ext, ".msu") || \
cli_strbcasestr(ext, ".ndb") || \
cli_strbcasestr(ext, ".ndu") || \
cli_strbcasestr(ext, ".ldb") || \
cli_strbcasestr(ext, ".ldu") || \
cli_strbcasestr(ext, ".sdb") || \
cli_strbcasestr(ext, ".zmd") || \
cli_strbcasestr(ext, ".rmd") || \
cli_strbcasestr(ext, ".pdb") || \
cli_strbcasestr(ext, ".gdb") || \
cli_strbcasestr(ext, ".wdb") || \
cli_strbcasestr(ext, ".cbc") || \
cli_strbcasestr(ext, ".ftm") || \
cli_strbcasestr(ext, ".cfg") || \
cli_strbcasestr(ext, ".cvd") || \
cli_strbcasestr(ext, ".cld") || \
cli_strbcasestr(ext, ".cud") || \
cli_strbcasestr(ext, ".cdb") || \
cli_strbcasestr(ext, ".cat") || \
cli_strbcasestr(ext, ".crb") || \
cli_strbcasestr(ext, ".idb") || \
cli_strbcasestr(ext, ".ioc") || \
cli_strbcasestr(ext, ".yar") || \
cli_strbcasestr(ext, ".yara") || \
cli_strbcasestr(ext, ".pwdb") || \
cli_strbcasestr(ext, ".ign") || \
cli_strbcasestr(ext, ".ign2") || \
cli_strbcasestr(ext, ".imp"))
#define CLI_DBEXT_SIGNATURE(ext) \
( \
cli_strbcasestr(ext, ".cvd") || \
cli_strbcasestr(ext, ".cld"))
#else
#define CLI_DBEXT(ext) \
( \
cli_strbcasestr(ext, ".db") || \
cli_strbcasestr(ext, ".hdb") || \
cli_strbcasestr(ext, ".hdu") || \
cli_strbcasestr(ext, ".fp") || \
cli_strbcasestr(ext, ".mdb") || \
cli_strbcasestr(ext, ".mdu") || \
cli_strbcasestr(ext, ".hsb") || \
cli_strbcasestr(ext, ".hsu") || \
cli_strbcasestr(ext, ".sfp") || \
cli_strbcasestr(ext, ".msb") || \
cli_strbcasestr(ext, ".msu") || \
cli_strbcasestr(ext, ".ndb") || \
cli_strbcasestr(ext, ".ndu") || \
cli_strbcasestr(ext, ".ldb") || \
cli_strbcasestr(ext, ".ldu") || \
cli_strbcasestr(ext, ".sdb") || \
cli_strbcasestr(ext, ".zmd") || \
cli_strbcasestr(ext, ".rmd") || \
cli_strbcasestr(ext, ".pdb") || \
cli_strbcasestr(ext, ".gdb") || \
cli_strbcasestr(ext, ".wdb") || \
cli_strbcasestr(ext, ".cbc") || \
cli_strbcasestr(ext, ".ftm") || \
cli_strbcasestr(ext, ".cfg") || \
cli_strbcasestr(ext, ".cvd") || \
cli_strbcasestr(ext, ".cld") || \
cli_strbcasestr(ext, ".cud") || \
cli_strbcasestr(ext, ".cdb") || \
cli_strbcasestr(ext, ".cat") || \
cli_strbcasestr(ext, ".crb") || \
cli_strbcasestr(ext, ".idb") || \
cli_strbcasestr(ext, ".ioc") || \
cli_strbcasestr(ext, ".pwdb") || \
cli_strbcasestr(ext, ".ign") || \
cli_strbcasestr(ext, ".ign2") || \
cli_strbcasestr(ext, ".imp"))
#define CLI_DBEXT_SIGNATURE(ext) \
( \
cli_strbcasestr(ext, ".cvd") || \
cli_strbcasestr(ext, ".cld"))
#endif
char *cli_virname(const char *virname, unsigned int official);
/**
* @brief Parse & load a body-based pattern for a logical signature (LDB or Yara)
* that may have subsignature modifiers at the end.
*
* This function creates a new pattern with the required modification before calling
* cli_add_content_match_pattern() to load the content patterns to match with the AC matcher or BM matcher.
*
* For more info about subsignature modifiers: https://docs.clamav.net/manual/Signatures/LogicalSignatures.html#subsignature-modifiers
*
* @param root
* @param virname
* @param hexsig
* @param sigopts
* @param rtype
* @param type
* @param offset
* @param lsigid
* @param options
* @return cl_error_t
*/
cl_error_t cli_sigopts_handler(struct cli_matcher *root, const char *virname, const char *hexsig,
uint8_t sigopts, uint16_t rtype, uint16_t type,
const char *offset, const uint32_t *lsigid, unsigned int options);
/**
* @brief Parse body-based patterns that DO NOT have subsignature modifiers.
*
* This function will split up body-based signature patterns that have {n-m} and * wildcards
* into multiple subsignatures, adding each.
*
* @param root
* @param virname
* @param hexsig
* @param sigopts
* @param rtype
* @param type
* @param offset
* @param lsigid
* @param options
* @return cl_error_t
*/
cl_error_t cli_add_content_match_pattern(struct cli_matcher *root, const char *virname, const char *hexsig,
uint8_t sigopts, uint16_t rtype, uint16_t type,
const char *offset, const uint32_t *lsigid, unsigned int options);
/**
* @brief Parse a subsignature from a logical signature.
*
* Called once for each subsignature in a logical signature.
* Not for use in other signature types (ndb, yara, etc).
*
* This function determines what type of subsignature it is, whether that's:
* - a macro subsignature
* - a pcre subsignature
* - a byte compare subsignature
* - a fuzzy hash subsignature
* - or else treated as a file content matching subsignature.
*
* @param root
* @param virname
* @param hexsig
* @param offset
* @param lsigid An array of 2 uint32_t numbers: lsig_id and subsig_id. May be NULL for testing.
* @param options
* @param current_subsig_index
* @param num_subsigs
* @param tdb
* @return cl_error_t
*/
cl_error_t readdb_parse_ldb_subsignature(struct cli_matcher *root, const char *virname, char *hexsig,
const char *offset, const uint32_t *lsigid, unsigned int options,
int current_subsig_index, int num_subsigs, struct cli_lsig_tdb *tdb);
cl_error_t cli_load(const char *filename, struct cl_engine *engine, unsigned int *signo, unsigned int options, struct cli_dbio *dbio, void *sign_verifier);
char *cli_dbgets(char *buff, unsigned int size, FILE *fs, struct cli_dbio *dbio);
cl_error_t cli_initroots(struct cl_engine *engine, unsigned int options);
#ifdef HAVE_YARA
cl_error_t cli_yara_init(struct cl_engine *engine);
void cli_yara_free(struct cl_engine *engine);
#endif
#endif