Skip to content

implement package io5 #886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

MichaelRFairhurst
Copy link
Contributor

Description

Implement package IO5

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • FIO03-C
    • FIO21-C
    • POS30-C
  • Queries have been modified for the following rules:
    • rule number here

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
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.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

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

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@Copilot Copilot AI review requested due to automatic review settings April 10, 2025 22:46
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request implements package IO5 by adding new query tests and documentation for CERT rules FIO03-C, FIO21-C, and POS30-C. Key changes include:

  • New test cases for FIO21-C and FIO03-C demonstrating compliant and noncompliant file operations.
  • Updated markdown documentation for POS30-C, FIO21-C (including two queries on temporary file creation), and FIO03-C.
  • A modification to qlpack.yml to set a default suite file.

Reviewed Changes

Copilot reviewed 26 out of 39 changed files in this pull request and generated no comments.

Show a summary per file
File Description
c/cert/test/rules/FIO21-C/test.c Added test cases illustrating noncompliant and compliant file operations related to temporary file creation.
c/cert/test/rules/FIO03-C/test.c Added test examples for secure and insecure file opening functions.
c/cert/src/rules/POS30-C/IncorrectNullTerminationOfReadlink.md Updated documentation for correct use of readlink().
c/cert/src/rules/FIO21-C/PossiblyPredictableTemporaryFileCreation.md New documentation describing the risks of predictable temporary file names.
c/cert/src/rules/FIO21-C/ExploitableTemporaryFileCreation.md New documentation on exploitable temporary file creation scenarios.
c/cert/src/rules/FIO03-C/FopenWithNonExclusiveFileCreationMode.md New documentation on securely opening files without unintended file creation.
c/cert/src/qlpack.yml Updated with a default suite file for the package.
Files not reviewed (13)
  • c/cert/src/codeql-suites/cert-c-default.qls: Language not supported
  • c/cert/src/codeql-suites/cert-c-recommendation.qls: Language not supported
  • c/cert/src/codeql-suites/cert-default.qls: Language not supported
  • c/cert/src/rules/FIO03-C/FopenWithNonExclusiveFileCreationMode.ql: Language not supported
  • c/cert/src/rules/FIO21-C/ExploitableTemporaryFileCreation.ql: Language not supported
  • c/cert/src/rules/FIO21-C/PossiblyPredictableTemporaryFileCreation.ql: Language not supported
  • c/cert/src/rules/POS30-C/IncorrectNullTerminationOfReadlink.ql: Language not supported
  • c/cert/test/rules/FIO03-C/FopenWithNonExclusiveFileCreationMode.expected: Language not supported
  • c/cert/test/rules/FIO03-C/FopenWithNonExclusiveFileCreationMode.qlref: Language not supported
  • c/cert/test/rules/FIO21-C/ExploitableTemporaryFileCreation.expected: Language not supported
  • c/cert/test/rules/FIO21-C/ExploitableTemporaryFileCreation.qlref: Language not supported
  • c/cert/test/rules/FIO21-C/PossiblyPredictableTemporaryFileCreation.expected: Language not supported
  • c/cert/test/rules/FIO21-C/PossiblyPredictableTemporaryFileCreation.qlref: Language not supported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant