sdkt-audit 2.7.0

Static security analysis for Soroban contracts (Gap C).
Documentation 
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

//! `sdkt-audit` — static security analysis for Soroban contracts (Gap C).
//!
//! Offline, source-based heuristics for Soroban-specific logic/security bugs
//! the Rust compiler does not catch (missing auth, unauthenticated cross-contract
//! calls, unguarded initialize, suspicious move-after-use). No networking.
//!
//! ## Plugin authoring
//!
//! Implement [`AuditRule`], then register your rule with [`register_rule`] (or the
//! [`register_rule!`](crate::register_rule) macro). Built-in rules register
//! through the same [`RuleRegistry`]. See `docs/plugin-authoring.md`.

pub mod audit;
pub mod error;
pub mod plugin_abi;
pub mod plugin_doctor;
pub mod plugin_store;
pub mod registry;
pub mod rules;
pub mod sarif;
pub mod types;

#[cfg(feature = "plugins")]
pub mod plugin_loader;

#[cfg(feature = "wasm-plugins")]
pub mod plugin_abi_wasm;
#[cfg(feature = "wasm-plugins")]
pub mod plugin_loader_wasm;

pub use audit::{
    all_rules, audit_source, audit_source_with, audit_source_with_registry, audit_source_with_spec,
    scan_all_functions, scan_all_functions_str, AuditContext, AuditRule, FnScan,
};
pub use error::AuditError;
pub use plugin_doctor::{
    doctor, doctor_installed, doctor_installed_with_root, doctor_with_root, DoctorReport,
    DoctorStage, DoctorStageStatus, DOCTOR_SAMPLE_CONTRACT,
};
pub use plugin_store::{
    install_bundle, install_bundle_with_key, pack_bundle, verify_bundle, BundleVerification,
    InstallOpts, PluginMeta, StoreError,
};
pub use registry::{
    register_builtin_rules, register_rule, run_registered, BoxedRule, RuleRegistry,
};
pub use rules::{Auth001, Auth002, Auth003, Auth004, Move001};
pub use sarif::{
    report_to_sarif_string, report_to_sarif_string_multi_file, to_sarif, to_sarif_multi_file,
    SarifLog,
};
pub use types::{AuditReport, AuditSummary, Finding, RuleInfo, Severity};

#[cfg(feature = "plugins")]
pub use plugin_loader::{load_and_register, PluginLoadError, PluginRule};

#[cfg(feature = "wasm-plugins")]
pub use plugin_loader_wasm::{load_and_register_wasm, WasmPluginLoadError, WasmPluginRule};

/// Register a rule into the process-wide [`RuleRegistry`].
///
/// # Example
/// ```ignore
/// sdkt_audit::register_rule!(MyRule);
/// ```
#[macro_export]
macro_rules! register_rule {
    ($rule:expr) => {
        $crate::registry::register_rule(::std::boxed::Box::new($rule))
    };
}