2008-12-17 21:42:54 +00:00
|
|
|
/*
|
2025-02-14 10:24:30 -05:00
|
|
|
* Copyright (C) 2013-2025 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
|
2019-01-25 10:15:50 -05:00
|
|
|
* Copyright (C) 2008-2013 Sourcefire, Inc.
|
2008-12-17 21:42:54 +00:00
|
|
|
*
|
|
|
|
|
* Author: Tomasz Kojm <tkojm@clamav.net>
|
|
|
|
|
*
|
|
|
|
|
* 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 __OPTPARSER_H
|
|
|
|
|
#define __OPTPARSER_H
|
|
|
|
|
|
|
|
|
|
/* don't share bits! */
|
2018-12-03 12:37:58 -05:00
|
|
|
// clang-format off
|
|
|
|
|
#define OPT_CLAMD 1
|
|
|
|
|
#define OPT_FRESHCLAM 2
|
|
|
|
|
#define OPT_MILTER 4
|
|
|
|
|
#define OPT_CLAMSCAN 8
|
|
|
|
|
#define OPT_CLAMDSCAN 16
|
|
|
|
|
#define OPT_SIGTOOL 32
|
|
|
|
|
#define OPT_CLAMCONF 64
|
|
|
|
|
#define OPT_CLAMDTOP 128
|
|
|
|
|
#define OPT_CLAMBC 256
|
2024-02-25 12:43:56 -05:00
|
|
|
#define OPT_CLAMONACC 512
|
|
|
|
|
#define OPT_DEPRECATED 1024
|
2009-01-22 14:19:47 +00:00
|
|
|
|
2018-12-03 12:37:58 -05:00
|
|
|
#define CLOPT_TYPE_STRING 1 /* quoted/regular string */
|
|
|
|
|
#define CLOPT_TYPE_NUMBER 2 /* raw number */
|
2023-06-07 11:16:52 +02:00
|
|
|
#define CLOPT_TYPE_SIZE 3 /* number possibly followed by modifiers (K/k, M/m or G/g) */
|
2018-12-03 12:37:58 -05:00
|
|
|
#define CLOPT_TYPE_BOOL 4 /* boolean */
|
2023-06-07 11:16:52 +02:00
|
|
|
#define CLOPT_TYPE_SIZE64 5 /* 64-bit number possibly followed by modifiers (K/k, M/m or G/g) */
|
Add CMake build tooling
This patch adds experimental-quality CMake build tooling.
The libmspack build required a modification to use "" instead of <> for
header #includes. This will hopefully be included in the libmspack
upstream project when adding CMake build tooling to libmspack.
Removed use of libltdl when using CMake.
Flex & Bison are now required to build.
If -DMAINTAINER_MODE, then GPERF is also required, though it currently
doesn't actually do anything. TODO!
I found that the autotools build system was generating the lexer output
but not actually compiling it, instead using previously generated (and
manually renamed) lexer c source. As a consequence, changes to the .l
and .y files weren't making it into the build. To resolve this, I
removed generated flex/bison files and fixed the tooling to use the
freshly generated files. Flex and bison are now required build tools.
On Windows, this adds a dependency on the winflexbison package,
which can be obtained using Chocolatey or may be manually installed.
CMake tooling only has partial support for building with external LLVM
library, and no support for the internal LLVM (to be removed in the
future). I.e. The CMake build currently only supports the bytecode
interpreter.
Many files used include paths relative to the top source directory or
relative to the current project, rather than relative to each build
target. Modern CMake support requires including internal dependency
headers the same way you would external dependency headers (albeit
with "" instead of <>). This meant correcting all header includes to
be relative to the build targets and not relative to the workspace.
For example, ...
```c
include "../libclamav/clamav.h"
include "clamd/clamd_others.h"
```
... becomes:
```c
// libclamav
include "clamav.h"
// clamd
include "clamd_others.h"
```
Fixes header name conflicts by renaming a few of the files.
Converted the "shared" code into a static library, which depends on
libclamav. The ironically named "shared" static library provides
features common to the ClamAV apps which are not required in
libclamav itself and are not intended for use by downstream projects.
This change was required for correct modern CMake practices but was
also required to use the automake "subdir-objects" option.
This eliminates warnings when running autoreconf which, in the next
version of autoconf & automake are likely to break the build.
libclamav used to build in multiple stages where an earlier stage is
a static library containing utils required by the "shared" code.
Linking clamdscan and clamdtop with this libclamav utils static lib
allowed these two apps to function without libclamav. While this is
nice in theory, the practical gains are minimal and it complicates
the build system. As such, the autotools and CMake tooling was
simplified for improved maintainability and this feature was thrown
out. clamdtop and clamdscan now require libclamav to function.
Removed the nopthreads version of the autotools
libclamav_internal_utils static library and added pthread linking to
a couple apps that may have issues building on some platforms without
it, with the intention of removing needless complexity from the
source. Kept the regular version of libclamav_internal_utils.la
though it is no longer used anywhere but in libclamav.
Added an experimental doxygen build option which attempts to build
clamav.h and libfreshclam doxygen html docs.
The CMake build tooling also may build the example program(s), which
isn't a feature in the Autotools build system.
Changed C standard to C90+ due to inline linking issues with socket.h
when linking libfreshclam.so on Linux.
Generate common.rc for win32.
Fix tabs/spaces in shared Makefile.am, and remove vestigial ifndef
from misc.c.
Add CMake files to the automake dist, so users can try the new
CMake tooling w/out having to build from a git clone.
clamonacc changes:
- Renamed FANOTIFY macro to HAVE_SYS_FANOTIFY_H to better match other
similar macros.
- Added a new clamav-clamonacc.service systemd unit file, based on
the work of ChadDevOps & Aaron Brighton.
- Added missing clamonacc man page.
Updates to clamdscan man page, add missing options.
Remove vestigial CL_NOLIBCLAMAV definitions (all apps now use
libclamav).
Rename Windows mspack.dll to libmspack.dll so all ClamAV-built
libraries have the lib-prefix with Visual Studio as with CMake.
2020-08-13 00:25:34 -07:00
|
|
|
|
|
|
|
|
#ifdef _WIN32
|
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'.
2024-11-21 14:01:09 -05:00
|
|
|
|
|
|
|
|
extern char _DATADIR[MAX_PATH];
|
|
|
|
|
extern char _CONFDIR[MAX_PATH];
|
|
|
|
|
extern char _CERTSDIR[MAX_PATH];
|
|
|
|
|
extern char _CONFDIR_CLAMD[MAX_PATH];
|
|
|
|
|
extern char _CONFDIR_FRESHCLAM[MAX_PATH];
|
|
|
|
|
extern char _CONFDIR_MILTER[MAX_PATH];
|
|
|
|
|
|
|
|
|
|
#define OPT_DATADIR _DATADIR
|
|
|
|
|
#define OPT_CONFDIR _CONFDIR
|
|
|
|
|
#define OPT_CERTSDIR _CERTSDIR
|
|
|
|
|
#define OPT_CONFDIR_CLAMD _CONFDIR_CLAMD
|
|
|
|
|
#define OPT_CONFDIR_FRESHCLAM _CONFDIR_FRESHCLAM
|
|
|
|
|
#define OPT_CONFDIR_MILTER _CONFDIR_MILTER
|
|
|
|
|
|
|
|
|
|
#else /* !_WIN32 */
|
|
|
|
|
|
|
|
|
|
#define OPT_DATADIR DATADIR
|
|
|
|
|
#define OPT_CONFDIR CONFDIR
|
|
|
|
|
#define OPT_CERTSDIR CERTSDIR
|
|
|
|
|
#define OPT_CONFDIR_CLAMD CONFDIR PATHSEP "clamd.conf"
|
|
|
|
|
#define OPT_CONFDIR_FRESHCLAM CONFDIR PATHSEP "freshclam.conf"
|
|
|
|
|
#define OPT_CONFDIR_MILTER CONFDIR PATHSEP "clamav-milter.conf"
|
|
|
|
|
|
Add CMake build tooling
This patch adds experimental-quality CMake build tooling.
The libmspack build required a modification to use "" instead of <> for
header #includes. This will hopefully be included in the libmspack
upstream project when adding CMake build tooling to libmspack.
Removed use of libltdl when using CMake.
Flex & Bison are now required to build.
If -DMAINTAINER_MODE, then GPERF is also required, though it currently
doesn't actually do anything. TODO!
I found that the autotools build system was generating the lexer output
but not actually compiling it, instead using previously generated (and
manually renamed) lexer c source. As a consequence, changes to the .l
and .y files weren't making it into the build. To resolve this, I
removed generated flex/bison files and fixed the tooling to use the
freshly generated files. Flex and bison are now required build tools.
On Windows, this adds a dependency on the winflexbison package,
which can be obtained using Chocolatey or may be manually installed.
CMake tooling only has partial support for building with external LLVM
library, and no support for the internal LLVM (to be removed in the
future). I.e. The CMake build currently only supports the bytecode
interpreter.
Many files used include paths relative to the top source directory or
relative to the current project, rather than relative to each build
target. Modern CMake support requires including internal dependency
headers the same way you would external dependency headers (albeit
with "" instead of <>). This meant correcting all header includes to
be relative to the build targets and not relative to the workspace.
For example, ...
```c
include "../libclamav/clamav.h"
include "clamd/clamd_others.h"
```
... becomes:
```c
// libclamav
include "clamav.h"
// clamd
include "clamd_others.h"
```
Fixes header name conflicts by renaming a few of the files.
Converted the "shared" code into a static library, which depends on
libclamav. The ironically named "shared" static library provides
features common to the ClamAV apps which are not required in
libclamav itself and are not intended for use by downstream projects.
This change was required for correct modern CMake practices but was
also required to use the automake "subdir-objects" option.
This eliminates warnings when running autoreconf which, in the next
version of autoconf & automake are likely to break the build.
libclamav used to build in multiple stages where an earlier stage is
a static library containing utils required by the "shared" code.
Linking clamdscan and clamdtop with this libclamav utils static lib
allowed these two apps to function without libclamav. While this is
nice in theory, the practical gains are minimal and it complicates
the build system. As such, the autotools and CMake tooling was
simplified for improved maintainability and this feature was thrown
out. clamdtop and clamdscan now require libclamav to function.
Removed the nopthreads version of the autotools
libclamav_internal_utils static library and added pthread linking to
a couple apps that may have issues building on some platforms without
it, with the intention of removing needless complexity from the
source. Kept the regular version of libclamav_internal_utils.la
though it is no longer used anywhere but in libclamav.
Added an experimental doxygen build option which attempts to build
clamav.h and libfreshclam doxygen html docs.
The CMake build tooling also may build the example program(s), which
isn't a feature in the Autotools build system.
Changed C standard to C90+ due to inline linking issues with socket.h
when linking libfreshclam.so on Linux.
Generate common.rc for win32.
Fix tabs/spaces in shared Makefile.am, and remove vestigial ifndef
from misc.c.
Add CMake files to the automake dist, so users can try the new
CMake tooling w/out having to build from a git clone.
clamonacc changes:
- Renamed FANOTIFY macro to HAVE_SYS_FANOTIFY_H to better match other
similar macros.
- Added a new clamav-clamonacc.service systemd unit file, based on
the work of ChadDevOps & Aaron Brighton.
- Added missing clamonacc man page.
Updates to clamdscan man page, add missing options.
Remove vestigial CL_NOLIBCLAMAV definitions (all apps now use
libclamav).
Rename Windows mspack.dll to libmspack.dll so all ClamAV-built
libraries have the lib-prefix with Visual Studio as with CMake.
2020-08-13 00:25:34 -07:00
|
|
|
#endif
|
2018-12-03 12:37:58 -05:00
|
|
|
// clang-format on
|
2008-12-17 21:42:54 +00:00
|
|
|
|
|
|
|
|
struct optstruct {
|
|
|
|
|
char *name;
|
|
|
|
|
char *cmd;
|
|
|
|
|
char *strarg;
|
2009-05-05 13:33:11 +00:00
|
|
|
long long numarg;
|
2008-12-17 21:42:54 +00:00
|
|
|
int enabled;
|
|
|
|
|
int active;
|
2008-12-31 12:26:30 +00:00
|
|
|
int flags;
|
2008-12-17 21:42:54 +00:00
|
|
|
int idx;
|
|
|
|
|
struct optstruct *nextarg;
|
|
|
|
|
struct optstruct *next;
|
2008-12-30 10:33:43 +00:00
|
|
|
|
2009-01-19 19:41:27 +00:00
|
|
|
char **filename; /* cmdline */
|
2008-12-17 21:42:54 +00:00
|
|
|
};
|
|
|
|
|
|
2009-01-22 14:19:47 +00:00
|
|
|
struct clam_option {
|
|
|
|
|
const char *name;
|
|
|
|
|
const char *longopt;
|
|
|
|
|
char shortopt;
|
|
|
|
|
int argtype;
|
|
|
|
|
const char *regex;
|
2009-05-05 13:33:11 +00:00
|
|
|
long long numarg;
|
2025-05-24 14:27:15 -04:00
|
|
|
char *strarg;
|
2009-01-22 14:19:47 +00:00
|
|
|
int flags;
|
|
|
|
|
int owner;
|
|
|
|
|
const char *description;
|
|
|
|
|
const char *suggested;
|
|
|
|
|
};
|
|
|
|
|
|
2008-12-17 21:42:54 +00:00
|
|
|
const struct optstruct *optget(const struct optstruct *opts, const char *name);
|
|
|
|
|
|
|
|
|
|
void optfree(struct optstruct *opts);
|
|
|
|
|
|
2009-01-02 17:04:11 +00:00
|
|
|
struct optstruct *optparse(const char *cfgfile, int argc, char **argv, int verbose, int toolmask, int ignore, struct optstruct *oldopts);
|
2014-02-18 15:37:10 -05:00
|
|
|
struct optstruct *optadditem(const char *name, const char *arg, int verbose, int toolmask, int ignore, struct optstruct *oldopts);
|
2008-12-17 21:42:54 +00:00
|
|
|
|
|
|
|
|
#endif
|