provenant-cli 0.0.21

Rust-based ScanCode-compatible scanner for licenses, package metadata, SBOMs, and provenance data.
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
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

//! Parser for Debian package metadata files.
//!
//! Extracts package metadata from Debian package management files using RFC 822
//! format parsing for control files and installed package databases.
//!
//! # Supported Formats
//! - `debian/control` (Source package control files - multi-paragraph)
//! - `/var/lib/dpkg/status` (Installed package database - multi-paragraph)
//! - `/var/lib/dpkg/status.d/*` (Distroless installed packages)
//! - `*.dsc` (Debian source control files)
//! - `*.orig.tar.*` (Original upstream tarballs)
//! - `*.debian.tar.*` (Debian packaging tarballs)
//! - `/var/lib/dpkg/info/*.list` (Installed file lists)
//! - `/var/lib/dpkg/info/*.md5sums` (Installed file checksums)
//! - `debian/copyright` (Copyright/license declarations)
//! - `*.deb` (Debian binary package archives)
//! - `control` (extracted from .deb archives)
//! - `md5sums` (extracted from .deb archives)
//!
//! # Key Features
//! - RFC 822 format parsing for control files
//! - Dependency extraction with scope tracking (Depends, Build-Depends, etc.)
//! - Debian vs Ubuntu namespace detection from version and maintainer fields
//! - Multi-paragraph record parsing for package databases
//! - License and copyright information extraction
//! - Package URL (purl) generation with namespace
//!
//! # Implementation Notes
//! - Uses RFC 822 parser from `crate::parsers::rfc822` module
//! - Multi-paragraph records separated by blank lines
//! - Graceful error handling with `warn!()` logs

mod control;
mod copyright;
mod deb;
mod dsc;
mod file_list;
mod tarball;
mod utils;

#[cfg(test)]
mod deb_extra_test;
#[cfg(test)]
mod scan_test;

pub use self::control::{
    DebianControlParser, DebianDistrolessInstalledParser, DebianInstalledParser,
};
pub use self::copyright::DebianCopyrightParser;
pub use self::deb::{
    DebianControlInExtractedDebParser, DebianDebParser, DebianMd5sumInPackageParser,
};
pub use self::dsc::DebianDscParser;
pub use self::file_list::{DebianInstalledListParser, DebianInstalledMd5sumsParser};
pub use self::tarball::{DebianDebianTarParser, DebianOrigTarParser};

use std::sync::LazyLock;

use crate::models::{DatasourceId, PackageData, PackageType};
use regex::Regex;

const PACKAGE_TYPE: PackageType = PackageType::Deb;

const MAX_ARCHIVE_SIZE: u64 = 1024 * 1024 * 1024;
const MAX_FILE_SIZE: u64 = 50 * 1024 * 1024;
const MAX_COMPRESSION_RATIO: usize = 100;

static DEP_RE: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(
        r"^\s*([a-zA-Z0-9][a-zA-Z0-9.+\-]+)\s*(?:\(([<>=!]+)\s*([^)]+)\))?\s*(?:\[.*\])?\s*$",
    )
    .expect("compile-time constant dependency regex")
});

fn default_package_data(datasource_id: DatasourceId) -> PackageData {
    PackageData {
        package_type: Some(PACKAGE_TYPE),
        datasource_id: Some(datasource_id),
        ..Default::default()
    }
}

const VERSION_CLUES_DEBIAN: &[&str] = &["deb"];
const VERSION_CLUES_UBUNTU: &[&str] = &["ubuntu"];

const MAINTAINER_CLUES_DEBIAN: &[&str] = &[
    "packages.debian.org",
    "lists.debian.org",
    "lists.alioth.debian.org",
    "@debian.org",
    "debian-init-diversity@",
];
const MAINTAINER_CLUES_UBUNTU: &[&str] = &["lists.ubuntu.com", "@canonical.com"];

struct DepFieldSpec {
    field: &'static str,
    scope: &'static str,
    is_runtime: bool,
    is_optional: bool,
}

const DEP_FIELDS: &[DepFieldSpec] = &[
    DepFieldSpec {
        field: "depends",
        scope: "depends",
        is_runtime: true,
        is_optional: false,
    },
    DepFieldSpec {
        field: "pre-depends",
        scope: "pre-depends",
        is_runtime: true,
        is_optional: false,
    },
    DepFieldSpec {
        field: "recommends",
        scope: "recommends",
        is_runtime: true,
        is_optional: true,
    },
    DepFieldSpec {
        field: "suggests",
        scope: "suggests",
        is_runtime: true,
        is_optional: true,
    },
    DepFieldSpec {
        field: "breaks",
        scope: "breaks",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "conflicts",
        scope: "conflicts",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "replaces",
        scope: "replaces",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "provides",
        scope: "provides",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "build-depends",
        scope: "build-depends",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "build-depends-indep",
        scope: "build-depends-indep",
        is_runtime: false,
        is_optional: false,
    },
    DepFieldSpec {
        field: "build-conflicts",
        scope: "build-conflicts",
        is_runtime: false,
        is_optional: false,
    },
];

const IGNORED_ROOT_DIRS: &[&str] = &["/.", "/bin", "/etc", "/lib", "/sbin", "/usr", "/var"];