sqc 0.4.84

Software Code Quality - CERT C compliance checker
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! API04-C: Provide a consistent and usable error-checking mechanism
//!
//! Functions should provide consistent and usable error-checking mechanisms.
//! Complex or inconsistent interfaces are sometimes ignored by programmers,
//! resulting in code that is not properly error checked.
//!
//! ## Examples:
//!
//! **Non-compliant:**
//! ```c
//! // strlcpy has inconsistent error checking - returns length, awkward comparison
//! if (strlcpy(dest, src, sizeof(dest)) >= sizeof(dest)) {
//!     // Handle error
//! }
//! ```
//!
//! **Compliant:**
//! ```c
//! // strcpy_m provides consistent error checking - returns errno_t
//! errno_t result = strcpy_m(dest, src);
//! if (result != 0) {
//!     // Handle error
//! }
//! ```

use crate::manifest::{RuleCategory, Severity};
use crate::rules::{CertRule, RuleViolation};
use crate::utility::cert_c::ast_utils::get_node_text;
use lang_parsing_substrate::query;
use tree_sitter::Node;

pub struct Api04C;

impl CertRule for Api04C {
    fn rule_id(&self) -> &'static str {
        "API04-C"
    }

    fn description(&self) -> &'static str {
        "Provide a consistent and usable error-checking mechanism"
    }

    fn severity(&self) -> Severity {
        Severity::Medium
    }

    fn category(&self) -> RuleCategory {
        RuleCategory::Recommendation
    }

    fn cert_id(&self) -> &'static str {
        "API04-C"
    }

    fn check(&self, node: &Node, source: &str) -> Vec<RuleViolation> {
        let mut violations = Vec::new();
        // Check for strlcpy() and strlcat() function calls
        // These functions have inconsistent error-checking mechanisms
        for call in query::find_descendants_of_kind(*node, "call_expression") {
            if let Some(function) = call.child_by_field_name("function") {
                let func_name = get_node_text(&function, source);

                if func_name == "strlcpy" || func_name == "strlcat" {
                    violations.push(RuleViolation {
                        rule_id: self.rule_id().to_string(),
                        severity: self.severity(),
                        message: format!(
                            "Use of '{}' function with inconsistent error-checking mechanism",
                            func_name
                        ),
                        file_path: String::new(),
                        line: call.start_position().row + 1,
                        column: call.start_position().column + 1,
                        suggestion: Some(
                            "Consider using functions with clearer return values like strcpy_s() or strcpy_m() \
                            that return errno_t for consistent error checking"
                                .to_string(),
                        ),
                        ..Default::default()
                    });
                }
            }
        }
        violations
    }
}