pinoc 0.3.6

A CLI tool for setting up pinocchio program project
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

//! Frozen contract for `pinoc check`. Codes, ids, and the JSON shape of `Finding`
//! are a permanent compatibility surface once released; do not rename.
//!
//! Some of this surface has no caller until the first lint is registered.
#![allow(dead_code)]

use serde::Serialize;
use std::path::PathBuf;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Severity {
    Deny,
    Warn,
    Info,
}

/// Ordered weakest to strongest, so `confidence >= threshold` works directly.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Confidence {
    Heuristic,
    Likely,
    Definite,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Category {
    Acc,
    Cpi,
    Zc,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Backend {
    Syn,
    Dylint,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize)]
pub struct Span {
    pub file: String,
    pub line: usize,
    pub col: usize,
}

#[derive(Clone, Debug, Serialize)]
pub struct Finding {
    pub code: &'static str,
    pub id: &'static str,
    pub confidence: Confidence,
    pub severity: Severity,
    pub span: Span,
    pub evidence: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fix: Option<String>,
}

/// One program source file, parsed once and shared across every lint.
pub struct ParsedFile {
    pub path: PathBuf,
    pub src: String,
    pub ast: syn::File,
}

pub trait Lint {
    fn code(&self) -> &'static str;
    fn id(&self) -> &'static str;
    fn category(&self) -> Category;
    fn backend(&self) -> Backend;
    fn default_severity(&self) -> Severity;
    fn default_confidence(&self) -> Confidence;
    /// Raw findings for one file, before config severity and suppression. The
    /// struct-layout lints work here.
    fn run(&self, _file: &ParsedFile) -> Vec<Finding> {
        Vec::new()
    }
    /// Raw findings over the crate's handler fact tables. The account and CPI
    /// lints work here, since a handler's accounts can be used in other files.
    fn run_handlers(&self, _handlers: &[crate::check::facts::Handler]) -> Vec<Finding> {
        Vec::new()
    }
}