From: "flichtenheld (Code Review)"
Date: Mon, 13 Apr 2026 11:55:18 +0000
In-Reply-To:
References:
Reply-To: frank@...2641..., arne-openvpn@...1227...,
openvpn-devel@lists.sourceforge.net
Message-ID:
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Disposition: inline
Content-Type: multipart/alternative; boundary="ktLWMMz/64M="; charset=UTF-8
Subject: [Openvpn-devel] [M] Change in openvpn[master]: dev-tools: Add
script to run cppcheck against the code-base
List-Id:
List-Unsubscribe: ,
List-Archive:
List-Post:
List-Help:
List-Subscribe: ,
To: plaisthos
Cc: openvpn-devel
--ktLWMMz/64M=
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Attention is currently required from: plaisthos.
Hello plaisthos,
I'd like you to reexamine a change. Please visit
http://gerrit.openvpn.net/c/openvpn/+/1620?usp=3Demail
to look at the new patch set (#5).
Change subject: dev-tools: Add script to run cppcheck against the code-base
......................................................................
dev-tools: Add script to run cppcheck against the code-base
Also add a suitable suppressions-list file to
make it possible to run it without reporting
errors.
Tested with cppcheck 2.19.0 (Ubuntu 26.04).
Change-Id: I125cf63f11257d7245ead2f7feafb86b841580a5
Signed-off-by: Frank Lichtenheld
---
M Makefile.am
A dev-tools/cppcheck-suppression
A dev-tools/run-cppcheck.sh
3 files changed, 120 insertions(+), 0 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/20/1620/5
diff --git a/Makefile.am b/Makefile.am
index 362ae96..2df7eea 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -89,3 +89,10 @@
doxygen:
$(MAKE) -C doc/doxygen doxygen
+
+.PHONY: cppcheck
+cppcheck:
+ BUILD_DIR=3D"$(abs_top_builddir)" \
+ SOURCE_DIR=3D"$(abs_top_srcdir)" \
+ INCLUDE_FLAGS=3D"$(LIBNL_GENL_CFLAGS)" \
+ "$(top_srcdir)/dev-tools/run-cppcheck.sh"
diff --git a/dev-tools/cppcheck-suppression b/dev-tools/cppcheck-suppression
new file mode 100644
index 0000000..1f31edb
--- /dev/null
+++ b/dev-tools/cppcheck-suppression
@@ -0,0 +1,87 @@
+# We start with --enable=3Dall, but then suppress some issues that have to=
o many
+# occurences right now. They still should be fixed at some point
+constParameter
+constParameterCallback
+constParameterPointer
+constVariable
+constVariablePointer
+variableScope
+# We have a lot of library includes, not all of them are really required,
+# so ignore them
+missingIncludeSystem
+# cppcheck doesn't understand about check_malloc_return, so these are
+# usually misleading
+nullPointerOutOfMemory
+nullPointerArithmeticOutOfMemory
+# These are specific false-positives (FP) or ignored (IGN) issues
+# We might want to move some of them to inline-suppression to avoid
+# the static line-numbers
+# IGN: multi code does weird things with pointers to local variables...
+autoVariables:src/openvpn/multi.c:4177
+autoVariables:src/openvpn/multi_io.c:280
+# IGN: the code header =3D 0 | (OPCODE << P_OPCODE_SHIFT) is used intentio=
nally
+badBitmaskCheck:src/openvpn/mudp.c
+badBitmaskCheck:tests/unit_tests/openvpn/test_pkt.c
+# IGN: event code uses a pointer to store integers
+intToPointerCast:src/openvpn/multi_io.c
+intToPointerCast:src/openvpn/forward.c
+# FP: crt_error is always true on Unix, but not Windows
+knownConditionTrueFalse:src/openvpn/error.h:380
+# FP: code needs to accomodate many different defines
+knownConditionTrueFalse:src/openvpn/event.c:1148
+# FP: dco_win support has "false" stubs
+knownConditionTrueFalse:src/openvpn/forward.c
+knownConditionTrueFalse:src/openvpn/init.c
+knownConditionTrueFalse:src/openvpn/multi_io.c:163
+# FP: cppcheck thinks that management_query_user_pass is always true,
+# but no idea why
+knownConditionTrueFalse:src/openvpn/misc.c:97
+# FP: cert_uri_supported is a wrapper around defines, so it's
+# always constant but differs depending on OpenSSL version
+knownConditionTrueFalse:src/openvpn/ssl_openssl.c:1258
+# FP: cppcheck doesn't understand that the function changes szErrMessage
+knownConditionTrueFalse:src/tapctl/main.c:704
+knownConditionTrueFalse:src/openvpnmsica/dllmain.c:164
+# FP: cppcheck seems to be confused since we cast the pointer to integer
+memleak:src/plugins/down-root/down-root.c:337
+# FP: eventmsg.h is not built on Unix
+missingInclude:src/openvpnserv/common.c:25
+# IGN: strlen(NULL) is not nice code, but seems to work
+nullPointerRedundantCheck:src/openvpn/init.c:299
+# IGN: We reuse the same variable name due to macro usage
+shadowVariable:src/openvpn/options.c:2580
+shadowVariable:src/openvpn/options.c:2598
+# FP: yes, t_prev is unitialized, but t_prev_len is 0, so that's handled
+uninitvar:src/openvpn/crypto_epoch.c:60
+# FP: yes, parm is unitialized, but parm_len is 0, so that's handled
+uninitvar:src/openvpn/options_parse.c:148
+# FP: uninit is fine when it is a return parameter
+ctuuninitvar:src/openvpn/crypto_mbedtls_legacy.c:698
+uninitvar:src/openvpnserv/interactive.c:1935
+uninitvar:src/tapctl/main.c:566
+# FP: cppcheck doesn't account for short-circuiting
+unreadVariable:src/openvpn/manage.c:682
+unusedFunction:src/openvpn/siphash_reference.c
+# FP: exported as DLL
+unusedFunction:src/openvpnmsica/*.c
+# FP: loaded as plugins
+unusedFunction:src/plugins/*
+unusedFunction:sample/sample-plugins/*
+# FP: wmain
+unusedFunction:src/tapctl/main.c:613
+unusedFunction:tests/unit_tests/openvpnserv/test_openvpnserv.c
+# IGN: keep mocking around for future use
+unusedFunction:tests/unit_tests/openvpn/mock_msg.c
+# FP: doesn't account for --wrap
+unusedFunction:tests/unit_tests/openvpn/test_tls_crypt.c
+unusedFunction:/usr/include/*
+# IGN: old code that is difficult to test (MSG_ERRQUEUE), ignore for now
+unusedStructMember:src/openvpn/mtu.c:281
+# FP: used implictly by NL macros
+unusedStructMember:src/openvpn/networking_sitnl.c
+# IGN: keep explanatory fields in test data
+unusedStructMember:tests/unit_tests/openvpn/test_pkcs11.c
+# IGN: nicer to assign generic "arg" early
+variableScope:src/openvpn/networking_sitnl.c:1390
+# IGN: nicer to keep the "variable" earlier
+variableScope:src/openvpnserv/interactive.c:2687
diff --git a/dev-tools/run-cppcheck.sh b/dev-tools/run-cppcheck.sh
new file mode 100755
index 0000000..674fc092
--- /dev/null
+++ b/dev-tools/run-cppcheck.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -eu
+
+SCRIPT_DIR=3D$(dirname $(readlink -e "${BASH_SOURCE[0]}"))
+: ${SOURCE_DIR:=3D$SCRIPT_DIR/..}
+: ${BUILD_DIR:=3D$PWD}
+: ${INCLUDE_FLAGS:=3D}
+CPPCHECK_DIR=3D"${BUILD_DIR}/cppcheck_build_dir"
+
+set -x
+
+mkdir -p "$CPPCHECK_DIR"
+cd "${SOURCE_DIR}"
+cppcheck -j$(nproc) \
+ -DHAVE_CONFIG_H -U_WIN32 \
+ -DMBEDTLS_SSL_PROTO_TLS1_3 -DMBEDTLS_SSL_KEYING_MATERIAL_EXPORT \
+ -I./include/ -I./tests/unit_tests/openvpn/ \
+ -I./src/compat/ -I./src/openvpn/ -I./src/openvpnserv/ -I./src/plugins/au=
th-pam/ \
+ -I"${BUILD_DIR}" -I"${BUILD_DIR}/include/" $INCLUDE_FLAGS \
+ --enable=3Dall \
+ --suppressions-list=3D"${SCRIPT_DIR}/cppcheck-suppression" \
+ --cppcheck-build-dir=3D"${CPPCHECK_DIR}" \
+ --check-level=3Dexhaustive \
+ --error-exitcode=3D1 \
+ src/ tests/ sample/
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1620?usp=3Demail
To unsubscribe, or for help writing mail filters, visit http://gerrit.openv=
pn.net/settings?usp=3Demail
Gerrit-MessageType: newpatchset
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I125cf63f11257d7245ead2f7feafb86b841580a5
Gerrit-Change-Number: 1620
Gerrit-PatchSet: 5
Gerrit-Owner: flichtenheld
Gerrit-Reviewer: plaisthos
Gerrit-CC: openvpn-devel
Gerrit-Attention: plaisthos
--ktLWMMz/64M=
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Attention is cur=
rently required from: plaisthos.
flichtenheld uploaded patch set #5 to this change.
<=
p>View C=
hange
dev-tools: Add script to run cppcheck against th=
e code-base
Also add a suitable suppressions-list file to
make it=
possible to run it without reporting
errors.
Tested with cppchec=
k 2.19.0 (Ubuntu 26.04).
Change-Id: I125cf63f11257d7245ead2f7feafb86=
b841580a5
Signed-off-by: Frank Lichtenheld <frank@...2641...>
-=
--
M Makefile.am
A dev-tools/cppcheck-suppression
A dev-tools/run-=
cppcheck.sh
3 files changed, 120 insertions(+), 0 deletions(-)
=
pre>git pull ssh://gerrit.openvpn.net:29418/openvpn refs/chan=
ges/20/1620/5
diff --git a/Makefile.am b/Makefile.am
index 362ae96..2df7eea 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -89,3 +89,10 @@
doxygen:
$(MAKE) -C doc/doxygen doxyg=
en
+
+.PHONY: cppcheck
+cppcheck:
+ BUILD_DIR=3D"$(abs_top_builddir)" \
+ SOURCE_DIR=3D"$(=
abs_top_srcdir)" \
+ INCLUDE_FLAGS=3D"$(LIBNL_GENL_CFLAGS)" \
+ "$(top_srcdir)/dev-tools/run-cpp=
check.sh"
diff --git a/dev-tools/cppcheck-suppression =
b/dev-tools/cppcheck-suppression
new file mode 100644
index 0000000..1f31edb
--- /dev/null
<=
span>+++ b/dev-tools/cppcheck-suppression
@@ -0,0 +1,87 @@<=
/span>
+# We start with --en=
able=3Dall, but then suppress some issues that have too many
+# occurences right now. They still=
should be fixed at some point
+constParameter
+constParameterCallback
+constParameterPointer
+constVariable
+constVariablePointer
+variableScope
+=
# We have a lot of library includes, not all of them are really required,=
span>
+# so ignore them
+missingIncludeSystem
+# cppcheck doesn't =
understand about check_malloc_return, so these are
+# usually misleading
+nullPointerOutOfMemory
+nullPointerArithmeticOutOfMemory
+# These are specific fals=
e-positives (FP) or ignored (IGN) issues
+# We might want to move some of them to inline-suppres=
sion to avoid
+# the =
static line-numbers
+=
# IGN: multi code does weird things with pointers to local variables...
+autoVariables:src/openv=
pn/multi.c:4177
+auto=
Variables:src/openvpn/multi_io.c:280
+# IGN: the code header =3D 0 | (OPCODE << P_OPCODE_S=
HIFT) is used intentionally
+badBitmaskCheck:src/openvpn/mudp.c
+badBitmaskCheck:tests/unit_tests/openvpn/test_pkt.c<=
/span>
+# IGN: event code us=
es a pointer to store integers
+intToPointerCast:src/openvpn/multi_io.c
+intToPointerCast:src/openvpn/forward.c
+# FP: crt_error is always=
true on Unix, but not Windows
+knownConditionTrueFalse:src/openvpn/error.h:380
+# FP: code needs to accomodate many =
different defines
+kn=
ownConditionTrueFalse:src/openvpn/event.c:1148
+# FP: dco_win support has "false" stub=
s
+knownConditionTrue=
False:src/openvpn/forward.c
+knownConditionTrueFalse:src/openvpn/init.c
+knownConditionTrueFalse:src/openvpn/multi_io=
.c:163
+# FP: cppchec=
k thinks that management_query_user_pass is always true,
+# but no idea why
+knownConditionTrueFalse:src/openvpn/misc=
.c:97
+# FP: cert_uri=
_supported is a wrapper around defines, so it's
+# always constant but differs depending o=
n OpenSSL version
+kn=
ownConditionTrueFalse:src/openvpn/ssl_openssl.c:1258
+# FP: cppcheck doesn't understand tha=
t the function changes szErrMessage
+knownConditionTrueFalse:src/tapctl/main.c:704
+knownConditionTrueFalse:src/openv=
pnmsica/dllmain.c:164
+# FP: cppcheck seems to be confused since we cast the pointer to integer<=
/span>
+memleak:src/plugins/=
down-root/down-root.c:337
+# FP: eventmsg.h is not built on Unix
+missingInclude:src/openvpnserv/common.c:25+# IGN: strlen(NULL) is not n=
ice code, but seems to work
+nullPointerRedundantCheck:src/openvpn/init.c:299
+# IGN: We reuse the same variable name=
due to macro usage
+=
shadowVariable:src/openvpn/options.c:2580
+shadowVariable:src/openvpn/options.c:2598
<=
span style=3D"color: hsl(120, 100%, 40%);">+# FP: yes, t_prev is unitialize=
d, but t_prev_len is 0, so that's handled
+uninitvar:src/openvpn/crypto_epoch.c:60
+# FP: yes, parm is unitialize=
d, but parm_len is 0, so that's handled
+uninitvar:src/openvpn/options_parse.c:148
+# FP: uninit is fine when it =
is a return parameter
+ctuuninitvar:src/openvpn/crypto_mbedtls_legacy.c:698
+uninitvar:src/openvpnserv/interactive.c:=
1935
+uninitvar:src/t=
apctl/main.c:566
+# F=
P: cppcheck doesn't account for short-circuiting
+unreadVariable:src/openvpn/manage.c:682=
span>
+unusedFunction:src/op=
envpn/siphash_reference.c
+# FP: exported as DLL
+unusedFunction:src/openvpnmsica/*.c
+# FP: loaded as plugins
+unusedFunction:src/plugins/*
+unusedFunction:sample/sample-plugins/*=
+# FP: wmain<=
br>+unusedFunction:src/tapctl/m=
ain.c:613
+unusedFunc=
tion:tests/unit_tests/openvpnserv/test_openvpnserv.c
+# IGN: keep mocking around for future use=
+unusedFunction:test=
s/unit_tests/openvpn/mock_msg.c
+# FP: doesn't account for --wrap
+unusedFunction:tests/unit_tests/openvpn/test_t=
ls_crypt.c
+unusedFun=
ction:/usr/include/*
=
+# IGN: old code that is difficult to test (MSG_ERRQUEUE), ignore for now=
span>
+unusedStructMember:sr=
c/openvpn/mtu.c:281
+=
# FP: used implictly by NL macros
+unusedStructMember:src/openvpn/networking_sitnl.c
<=
span style=3D"color: hsl(120, 100%, 40%);">+# IGN: keep explanatory fields =
in test data
+unusedS=
tructMember:tests/unit_tests/openvpn/test_pkcs11.c
+# IGN: nicer to assign generic "arg&quo=
t; early
+variableSco=
pe:src/openvpn/networking_sitnl.c:1390
+# IGN: nicer to keep the "variable" earlier
+variableScope:src/open=
vpnserv/interactive.c:2687
diff --git a/dev-tools/run-cppch=
eck.sh b/dev-tools/run-cppcheck.sh
new file mode 100755
index 0000000..674fc092
--- /dev/null+++ b/dev-tools/run-cppcheck.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
=
+
+set -eu
+
+SCRIP=
T_DIR=3D$(dirname $(readlink -e "${BASH_SOURCE[0]}"))
<=
span style=3D"color: hsl(120, 100%, 40%);">+: ${SOURCE_DIR:=3D$SCRIPT_DIR/.=
.}
+: ${BUILD_DIR:=3D=
$PWD}
+: ${INCLUDE_FL=
AGS:=3D}
+CPPCHECK_DI=
R=3D"${BUILD_DIR}/cppcheck_build_dir"
+
+set -x
+
+mkdir -p "$CPPCHEC=
K_DIR"
+cd "=
;${SOURCE_DIR}"
=
+cppcheck -j$(nproc) \
+ -DHAVE_CONFIG_H -U_WIN32 \
+ -DMBEDTLS_SSL_PROTO_TLS1_3 -DMBEDTLS_SSL_KEYING_MATERI=
AL_EXPORT \
+ -I./in=
clude/ -I./tests/unit_tests/openvpn/ \
+ -I./src/compat/ -I./src/openvpn/ -I./src/openvpnserv/ =
-I./src/plugins/auth-pam/ \
+ -I"${BUILD_DIR}" -I"${BUILD_DIR}/include/" $I=
NCLUDE_FLAGS \
+ --e=
nable=3Dall \
+ --su=
ppressions-list=3D"${SCRIPT_DIR}/cppcheck-suppression" \+ --cppcheck-build-dir=3D&qu=
ot;${CPPCHECK_DIR}" \
+ --check-level=3Dexhaustive \
+ --error-exitcode=3D1 \
+ src/ tests/ sample/
To view, visit change 1620. To unsubscribe, or for help writing mail filt=
ers, visit setti=
ngs.
Gerrit-MessageType: newpatchset
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I125cf63f11257d7245ead2f7fea=
fb86b841580a5
Gerrit-Change-Number: 1620
Gerrit-PatchSet: 5
Gerrit-Owner: flichtenheld <frank@...2723...=
.>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...=
.1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...=
ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...=
..1227...>
=
--ktLWMMz/64M=--