keyhog-sources 0.5.43

keyhog-sources: pluggable input backends for KeyHog (git, S3, GCS, Azure Blob, Docker, Web)
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
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

//! Pluggable input sources for KeyHog.
//!
//! Each source implements the [`keyhog_core::Source`] trait and yields [`keyhog_core::Chunk`]
//! values for the scanner. Sources are gated behind cargo features so only the
//! transitive dependencies you actually need are compiled.

#![allow(clippy::too_many_arguments)]

mod api;
mod blocking_thread;
mod capped_read;
mod compression_limits;
mod decode;
mod factory;
mod limits;
mod magic;
#[cfg(any(
    feature = "azure",
    feature = "s3",
    feature = "gcs",
    feature = "slack",
    feature = "github",
    feature = "gitlab",
    feature = "bitbucket"
))]
mod parallel_fetch;
#[cfg(any(
    feature = "git",
    feature = "docker",
    feature = "github",
    feature = "gitlab",
    feature = "bitbucket"
))]
mod process_excerpt;
mod safe_read;
mod skip;
pub(crate) mod timeouts;
#[cfg(any(
    feature = "web",
    feature = "github",
    feature = "gitlab",
    feature = "bitbucket"
))]
mod url_redaction;

/// Shared HTTP-client policy (proxy, TLS, UA) used by every source
/// + verifier site that talks to the network. Always compiled - the
/// `HttpClientConfig` type is the thread-through even when the
/// reqwest-backed builders are feature-gated out - so the CLI can
/// construct one without caring about which feature set is active.
pub mod http;

#[cfg(feature = "binary")]
mod binary;
#[cfg(feature = "bitbucket")]
mod bitbucket_workspace;
#[cfg(any(feature = "azure", feature = "s3", feature = "gcs"))]
mod cloud;
#[cfg(feature = "docker")]
mod docker;
mod filesystem;
#[cfg(feature = "gcs")]
mod gcs;
#[cfg(feature = "git")]
mod git;
#[cfg(feature = "github")]
mod github_collaboration;
#[cfg(feature = "github")]
mod github_org;
#[cfg(feature = "gitlab")]
mod gitlab_group;
mod har;
#[cfg(any(feature = "github", feature = "gitlab", feature = "bitbucket"))]
mod hosted_git;
#[cfg(feature = "s3")]
mod s3;
#[cfg(feature = "slack")]
mod slack;
mod stdin;
mod strings;
#[cfg(feature = "web")]
mod web;

pub use api::*;
pub(crate) use skip::{
    acquire_scan_read_lease, attach_scan_lease, enter_exclusive_scan_scope, gate_scan,
    record_skip_event, record_skip_events, reset_skip_counters, SourceSkipEvent,
};

/// Directory path components owned by the source default-exclude policy.
///
/// CLI filesystem surfaces compose this with their own consumer-specific
/// traversal policy so pre-scan traversal cannot drift from the scanner's
/// source-owned default excludes.
pub fn default_exclude_dir_components() -> &'static [String] {
    filesystem::default_exclude_dirs()
}

#[doc(hidden)]
pub use testing_facade::testing;

mod testing_facade;