cargo-mend 0.20.0

Opinionated visibility auditing for Rust crates and workspaces
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use anyhow::Result;

use super::annotation::VisibilityAnnotation;
use super::annotation::VisibilitySyntax;
use super::policy;
use super::policy::SignatureExposure;
use super::use_sites::ParentFacadeAnalysis;
use crate::compiler::persistence::FindingsSink;

mod classify;
mod finding_params;
mod record;
mod visibility_context;
mod visit;

pub(super) use classify::CrateKind;
pub(super) use classify::ModuleLocation;
pub(super) use classify::ParentVisibility;
pub(super) use finding_params::AllowanceReason;
pub(super) use finding_params::FindingParams;
pub(super) use finding_params::SuspiciousPubAssessment;
pub(super) use finding_params::SuspiciousPubInput;
pub(super) use visibility_context::ItemCategory;
pub(super) use visibility_context::ItemInfo;
pub(super) use visibility_context::VisibilityContext;
pub(super) use visibility_context::collect_and_store_findings;

#[derive(Clone, Copy)]
pub(super) enum ExposureConsumers {
    AllVisibilityFindings,
    ForbiddenAnnotation,
}

pub(super) fn signature_exposure_for_annotation(
    ctx: &VisibilityContext<'_, '_>,
    item: &ItemInfo<'_>,
    annotation: &VisibilityAnnotation<'_>,
    consumers: ExposureConsumers,
) -> Result<SignatureExposure> {
    if !annotation_consumes_signature_exposure(annotation.syntax(), consumers) {
        return Ok(SignatureExposure::Contained);
    }
    policy::signature_exposure_reach(ctx, item.def_id, item.file_path, item.name)
}

const fn annotation_consumes_signature_exposure(
    syntax: VisibilitySyntax,
    consumers: ExposureConsumers,
) -> bool {
    let forbidden_annotation = matches!(
        syntax,
        VisibilitySyntax::Crate
            | VisibilitySyntax::InCrate
            | VisibilitySyntax::InParent
            | VisibilitySyntax::InCurrent
            | VisibilitySyntax::InPath(_)
    );
    forbidden_annotation
        || matches!(
            (syntax, consumers),
            (
                VisibilitySyntax::Public,
                ExposureConsumers::AllVisibilityFindings
            )
        )
}

pub(super) fn record_forbidden_visibility_annotation(
    ctx: &VisibilityContext<'_, '_>,
    item: &ItemInfo<'_>,
    annotation: &VisibilityAnnotation<'_>,
    parent_facade_analysis: Option<&ParentFacadeAnalysis<'_>>,
    sink: &mut FindingsSink,
) -> Result<bool> {
    let finding_context = classify::visibility_finding_context(ctx, item);
    let signature_exposure = signature_exposure_for_annotation(
        ctx,
        item,
        annotation,
        ExposureConsumers::ForbiddenAnnotation,
    )?;
    record::record_forbidden_visibility_annotation(
        ctx,
        item,
        annotation,
        &finding_context,
        parent_facade_analysis,
        signature_exposure,
        sink,
    )
}

#[cfg(test)]
mod tests {
    use super::ExposureConsumers;
    use super::VisibilitySyntax;
    use super::annotation_consumes_signature_exposure;
    use crate::compiler::visibility::annotation::PathSpelling;

    #[test]
    fn signature_exposure_analysis_is_lazy_by_annotation_consumer() {
        for consumers in [
            ExposureConsumers::AllVisibilityFindings,
            ExposureConsumers::ForbiddenAnnotation,
        ] {
            assert!(!annotation_consumes_signature_exposure(
                VisibilitySyntax::Private,
                consumers,
            ));
        }
        assert!(annotation_consumes_signature_exposure(
            VisibilitySyntax::Public,
            ExposureConsumers::AllVisibilityFindings,
        ));
        assert!(!annotation_consumes_signature_exposure(
            VisibilitySyntax::Public,
            ExposureConsumers::ForbiddenAnnotation,
        ));
        for syntax in [
            VisibilitySyntax::Crate,
            VisibilitySyntax::InCrate,
            VisibilitySyntax::InParent,
            VisibilitySyntax::InCurrent,
            VisibilitySyntax::InPath(PathSpelling::CrateRooted),
            VisibilitySyntax::InPath(PathSpelling::Relative),
        ] {
            assert!(annotation_consumes_signature_exposure(
                syntax,
                ExposureConsumers::ForbiddenAnnotation,
            ));
        }
    }
}