Implement BannedAPIs package
#909
Open
+2,763
−136
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a query to identify uses of terminating program functions. [a]
Make the results easier to understand by reporting calls in macro expansions in the macros themselves, if they are defined by the developers of this project.
This header shouldn't exist.
A query for reporting the use of variadic functions. [a]
And remove duplicate definitions
This is not a "real" header - definitions should be in stdint.h and cstdint.
- Replace int aliases with include of stdint.h - Add str/wcs function stubs - Add header guards
Add a query to detect uses of a number of common unsafe string handling functions. [a]
This supports accurate detection of usage of banned functions: - Detects both accesses and calls - Reports the macro definition if the use is within a macro defined in the users code. - Otherwise reports the location of the expression.
Use library to avoid duplication.
Add a new query for detecting uses of the banned function `system`. [a]
A new query to report uses of the raw pointer constructors of the std::unique_ptr and std::shared_ptr classes. [a]
Add a new query to detect uses of prohibited character handling functions.
Add query for banned locale functions. [a]
Adds a new query to detect use of banned cstring functions. [a]
New query to detect banned uses of the csetjmp header. [a]
There was a problem hiding this comment.
Pull Request Overview
This PR introduces the new BannedAPIs query package and integrates it into the C++ coding-standards metadata, while also refreshing several C++ standard-library test stubs.
- Add autogenerated
BannedAPIs.qllwith queries and wire them intoRuleMetadata.qll - Update C++ standard-library test headers under
cpp/common/test/includes/standard-library - Refresh documentation in
CommonTypes.qllto match new header naming
Reviewed Changes
Copilot reviewed 70 out of 70 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| cpp/common/src/codingstandards/cpp/exclusions/RuleMetadata.qll | Import and register the BannedAPIs package |
| cpp/common/src/codingstandards/cpp/exclusions/cpp/BannedAPIs.qll | Add autogenerated queries for banned APIs |
| cpp/common/test/includes/standard-library/ctype.h | Revise include stub for C character functions |
| cpp/common/test/includes/standard-library/cctype | Provide std:: mappings for C character functions |
| cpp/autosar/src/codingstandards/cpp/CommonTypes.qll | Update doc comment to reference cstdint |
Comments suppressed due to low confidence (3)
cpp/common/test/includes/standard-library/ctype.h:4
- These extern declarations live in the global namespace but the closing
} // namespace stdwas removed. Wrap these declarations innamespace std { … }so that calls likestd::isalnumresolve correctly.
extern int isalnum(int);
cpp/autosar/src/codingstandards/cpp/CommonTypes.qll:4
- [nitpick] The comment refers to
cstdintgenerically but elsewhere you includestdint.h. Clarify whether this maps to<cstdint>or the legacy header to avoid confusion.
* Implementations of the C/C++ Fixed Width Types from cstdint.
cpp/common/test/includes/standard-library/cctype:10
- The stub maps
isgraph(and similarlyisprint,ispunct) intostd::butctype.hdoes not declare these prototypes. Addextern int isgraph(int);(and the others) to the underlyingctype.hstub so they compile.
using ::isgraph;
| @@ -0,0 +1,18 @@ | |||
| #pragma once | |||
There was a problem hiding this comment.
[nitpick] This header uses both #pragma once and include guards. Consider removing the redundancy by choosing one style for consistency across stubs.
Copilot uses AI. Check for mistakes.
Comment on lines
+1
to
+2
| #ifndef _GHLIBCPP_CWCTYPE | ||
| #define _GHLIBCPP_CWCTYPE |
There was a problem hiding this comment.
[nitpick] The stub uses an include guard but no #pragma once, while other stubs mix both. Unify header guard patterns for clarity.
Suggested change
| #ifndef _GHLIBCPP_CWCTYPE | |
| #define _GHLIBCPP_CWCTYPE | |
| #pragma once |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements the BannedAPIs package.
As many of these rules required the detection of banned functions, I've written a library (
BannedFunctions) to help identify different uses (e.g. calls, accesses etc.), and to aggregate reports in macro definitions.I've also updated quite a few of the C++ stubs (unlike the C stubs, these are all written by hand). I suspect there may be some broken tests - will update the PR after CI/CD has run.
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.