-
Notifications
You must be signed in to change notification settings - Fork 83
/
helpers.rs
290 lines (247 loc) · 8.91 KB
/
helpers.rs
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
use crate::{Krate, Krates};
use anyhow::{Context, Error};
use log::{debug, info};
pub use rustsec::{advisory::Id, lockfile::Lockfile, Database, Vulnerability};
use std::path::{Path, PathBuf};
use url::Url;
/// Whether the database will be fetched or not
#[derive(Copy, Clone)]
pub enum Fetch {
Allow,
Disallow,
}
/// A collection of [`Database`]s that is used to query advisories
/// in many different databases.
///
/// [`Database`]: https://docs.rs/rustsec/0.21.0/rustsec/database/struct.Database.html
pub struct DbSet {
dbs: Vec<(Url, Database)>,
}
impl DbSet {
pub fn load(
root: Option<impl AsRef<Path>>,
mut urls: Vec<Url>,
fetch: Fetch,
) -> Result<Self, Error> {
let root_db_path = match root {
Some(root) => {
let user_root = root.as_ref();
if user_root.starts_with("~") {
match home::home_dir() {
Some(home) => home.join(user_root.strip_prefix("~").unwrap()),
None => {
log::warn!(
"unable to resolve path '{}', falling back to the default advisory path",
user_root.display()
);
// This would only succeed of CARGO_HOME was explicitly set
home::cargo_home()
.context("failed to resolve CARGO_HOME")?
.join("advisory-dbs")
}
}
} else {
user_root.to_owned()
}
}
None => home::cargo_home()
.context("failed to resolve CARGO_HOME")?
.join("advisory-dbs"),
};
if urls.is_empty() {
info!(
"No advisory database configured, falling back to default '{}'",
rustsec::repository::git::DEFAULT_URL
);
urls.push(Url::parse(rustsec::repository::git::DEFAULT_URL).unwrap());
}
use rayon::prelude::*;
let mut dbs = Vec::with_capacity(urls.len());
urls.into_par_iter()
.map(|url| load_db(&url, root_db_path.clone(), fetch).map(|db| (url, db)))
.collect_into_vec(&mut dbs);
Ok(Self {
dbs: dbs.into_iter().collect::<Result<Vec<_>, _>>()?,
})
}
pub fn iter(&self) -> impl Iterator<Item = &(Url, Database)> {
self.dbs.iter()
}
pub fn has_advisory(&self, id: &Id) -> bool {
self.dbs.iter().any(|db| db.1.get(id).is_some())
}
}
/// Convert an advisory url to a directory underneath a specified root
fn url_to_path(mut db_path: PathBuf, url: &Url) -> Result<PathBuf, Error> {
let (ident, _) = crate::index::url_to_local_dir(url.as_str())?;
db_path.push(ident);
Ok(db_path)
}
fn load_db(db_url: &Url, root_db_path: PathBuf, fetch: Fetch) -> Result<Database, Error> {
use rustsec::repository::git::Repository;
let db_path = url_to_path(root_db_path, db_url)?;
let db_repo = match fetch {
Fetch::Allow => {
debug!("Fetching advisory database from '{}'", db_url);
Repository::fetch(db_url.as_str(), &db_path, true /* ensure_fresh */)
.context("failed to fetch advisory database")?
}
Fetch::Disallow => {
debug!("Opening advisory database at '{}'", db_path.display());
Repository::open(&db_path).context("failed to open advisory database")?
}
};
debug!("loading advisory database from {}", db_path.display());
let res = Database::load_from_repo(&db_repo).context("failed to load advisory database");
debug!(
"finished loading advisory database from {}",
db_path.display()
);
res
}
pub fn load_lockfile(path: &krates::Utf8Path) -> Result<Lockfile, Error> {
let mut lockfile = Lockfile::load(path)?;
// Remove the metadata as it is irrelevant
lockfile.metadata = Default::default();
Ok(lockfile)
}
pub struct PrunedLockfile(pub(crate) Lockfile);
impl PrunedLockfile {
pub fn prune(mut lf: Lockfile, krates: &Krates) -> Self {
// Remove any packages from the rustsec's view of the lockfile that we
// have filtered out of the graph we are actually checking
lf.packages
.retain(|pkg| krate_for_pkg(krates, pkg).is_some());
Self(lf)
}
}
#[inline]
pub(crate) fn krate_for_pkg<'a>(
krates: &'a Krates,
pkg: &rustsec::package::Package,
) -> Option<(krates::NodeId, &'a Krate)> {
krates
.krates_by_name(pkg.name.as_str())
.find(|(_, kn)| {
pkg.version == kn.krate.version
&& match (&pkg.source, &kn.krate.source) {
(Some(psrc), Some(ksrc)) => psrc == ksrc,
(None, None) => true,
_ => false,
}
})
.map(|(ind, krate)| (ind, &krate.krate))
}
pub use rustsec::warning::{Kind, Warning};
pub struct Report {
pub vulnerabilities: Vec<Vulnerability>,
pub notices: Vec<Warning>,
pub unmaintained: Vec<Warning>,
pub unsound: Vec<Warning>,
/// For backwards compatiblity with cargo-audit, we optionally serialize the
/// reports to JSON and output them in addition to the normal cargo-deny
/// diagnostics
pub serialized_reports: Vec<serde_json::Value>,
}
impl Report {
pub fn generate(
advisory_dbs: &DbSet,
lockfile: &PrunedLockfile,
serialize_reports: bool,
) -> Self {
use rustsec::advisory::Informational;
let settings = rustsec::report::Settings {
// We already prune packages we don't care about, so don't filter
// any here
target_arch: None,
target_os: None,
package_scope: None,
// We handle the severity ourselves
severity: None,
// We handle the ignoring of particular advisory ids ourselves
ignore: Vec::new(),
informational_warnings: vec![
Informational::Notice,
Informational::Unmaintained,
Informational::Unsound,
//Informational::Other("*"),
],
};
let mut vulnerabilities = Vec::new();
let mut notices = Vec::new();
let mut unmaintained = Vec::new();
let mut unsound = Vec::new();
let mut serialized_reports = Vec::with_capacity(if serialize_reports {
advisory_dbs.dbs.len()
} else {
0
});
for (url, db) in advisory_dbs.iter() {
let mut rep = rustsec::Report::generate(db, &lockfile.0, &settings);
if serialize_reports {
match serde_json::to_value(&rep) {
Ok(val) => serialized_reports.push(val),
Err(err) => {
log::error!("Failed to serialize report for database '{}': {}", url, err);
}
}
}
vulnerabilities.append(&mut rep.vulnerabilities.list);
for (kind, mut wi) in rep.warnings {
if wi.is_empty() {
continue;
}
match kind {
Kind::Notice => notices.append(&mut wi),
Kind::Unmaintained => unmaintained.append(&mut wi),
Kind::Unsound => unsound.append(&mut wi),
_ => unreachable!(),
}
}
}
Self {
vulnerabilities,
notices,
unmaintained,
unsound,
serialized_reports,
}
}
pub fn iter_warnings(&self) -> impl Iterator<Item = (Kind, &Warning)> {
self.notices
.iter()
.map(|wi| (Kind::Notice, wi))
.chain(self.unmaintained.iter().map(|wi| (Kind::Unmaintained, wi)))
.chain(self.unsound.iter().map(|wi| (Kind::Unsound, wi)))
}
}
#[cfg(test)]
mod test {
use super::url_to_path;
use url::Url;
#[test]
fn converts_url_to_path() {
let root_path = std::env::current_dir().unwrap();
{
let url = Url::parse("https://github.com/RustSec/advisory-db").unwrap();
assert_eq!(
url_to_path(root_path.clone(), &url).unwrap(),
root_path.join("github.com-2f857891b7f43c59")
);
}
{
let url = Url::parse("https://bare.com").unwrap();
assert_eq!(
url_to_path(root_path.clone(), &url).unwrap(),
root_path.join("bare.com-9c003d1ed306b28c")
);
}
{
let url = Url::parse("https://example.com/countries/việt nam").unwrap();
assert_eq!(
url_to_path(root_path.clone(), &url).unwrap(),
root_path.join("example.com-1c03f84825fb7438")
);
}
}
}