nyx-scanner 0.6.1

A multi-language static analysis tool for detecting security vulnerabilities
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

//! Field-sensitive Steensgaard alias / points-to analysis.
//!
//! Sibling to [`crate::ssa::heap`]: where heap tracks per-value
//! container identity for element abstractions, this module tracks
//! field-sensitive points-to so the engine can distinguish a receiver
//! from a sub-field. `c.mu.Lock()` acquires on `Field(c, mu)`, not `c`,
//! so the resource-lifecycle pass doesn't mis-attribute the acquire.
//! Cross-method field flow (method A writes `this.cache`, method B
//! reads it) observes the shared `Field(SelfParam, cache)` location.

pub mod analysis;
pub mod domain;

pub use analysis::{
    PointsToFacts, analyse_body, extract_field_points_to, is_container_read_callee_pub,
    is_container_write_callee,
};
pub use domain::{AbsLoc, LocId, LocInterner, PointsToSet, PtrProxyHint};

/// Returns whether the field-sensitive pointer analysis is enabled.
/// Set `NYX_POINTER_ANALYSIS=0` (or `false`) to disable.
#[inline]
pub fn is_enabled() -> bool {
    !matches!(
        std::env::var("NYX_POINTER_ANALYSIS").ok().as_deref(),
        Some("0") | Some("false") | Some("FALSE")
    )
}