BADFUNC.BO.GETOPT : Use of getopt

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

C and C++

Binaries

BADFUNC.BO.GETOPT : Use of getopt

Summary

A use of getopt(), getopt_long(), or getopt_long_only(), which may be vulnerable to internal buffer overflows depending on the implementation.

Properties

Class Name

Use of getopt

Significance

security

Mnemonic

BADFUNC.BO.GETOPT

Categories

AUTOSARC++14	AUTOSARC++14:A5-2-5	An array or container shall not be accessed beyond its range.
CWE	CWE:120	Buffer Copy without Checking Size of Input ('Classic Buffer Overflow')
	CWE:676	Use of Potentially Dangerous Function
CERT-C	CERT-C:API02-C	Functions that read or write to or from an array should take an argument to specify the source or target size
CERT-CPP	CERT-CPP:CTR52-CPP	Guarantee that library functions do not overflow
DISA-6r1	DISA-6r1:V-222612	The application must not be vulnerable to overflow attacks.
DISA-5r3	DISA-5r3:V-70277	The application must not be vulnerable to overflow attacks.
DISA-4r3	DISA-4r3:V-70277	The application must not be vulnerable to overflow attacks.
DISA-3r10	DISA-3r10:V-6165	The designer will ensure the application does not have buffer overflows, use functions known to be vulnerable to buffer overflows, and does not use signed values for memory allocation where permitted by the programming language.
BSI	BSI:GETOPT	Use of getopt
OWASP-2021	OWASP-2021:A4	Insecure design
OWASP-2025	OWASP-2025:A06	Insecure Design

Availability

Available for C and C++.

Enabling

Checks for this warning class are disabled by default. To enable them, add the following WARNING_FILTER rule to the project configuration file.

WARNING_FILTER += allow class="Use of getopt"

To enable all BSI-related classes, including all BSI-specific BADFUNC classes, use the bsi configuration preset.

Resolution

Are the implementations of getopt(), getopt_long(), and getopt_long_only() you are using prone to internal buffer overflows?

if YES:	When you see a Use of getopt warning, make sure that appropriate size bounds on the inputs are enforced. If so, you can change the warning state to Suppressed. Alternatively, upgrade your library to a version that does not have these vulnerabilities.
if NO:	there is no need to enable this warning class.

Relevant Configuration File Parameters

This class is implemented using a BAD_FUNCTION_* rule set in the general template configuration file.

To include an additional function or set of functions in the checks for this class, create a new set of BAD_FUNCTION_* rules in which the BAD_FUNCTION_REGEX setting matches the function or set of functions you want to check and the remaining rules match those in the other sets for this class.
To remove a function or set of functions from the checks for this class, edit the configuration file to comment out the corresponding set of BAD_FUNCTION_* rules.

The following configuration file parameters affect checks for this warning class.

To report problems with this documentation, please visit https://support.codesecure.com/.