Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix plugin downloading and prep bump for fuzz #695

Merged
merged 1 commit into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions config/Hipcheck.kdl
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
plugins {
plugin "mitre/activity" version="0.1.0" manifest="./plugins/activity/plugin.kdl"
plugin "mitre/binary" version="0.1.0" manifest="./plugins/binary/plugin.kdl"
plugin "mitre/fuzz" version="0.1.0" manifest="./plugins/fuzz/plugin.kdl"
plugin "mitre/review" version="0.1.0" manifest="./plugins/review/plugin.kdl"
plugin "mitre/typo" version="0.1.0" manifest="./plugins/typo/plugin.kdl"
plugin "mitre/affiliation" version="0.1.0" manifest="./plugins/affiliation/plugin.kdl"
plugin "mitre/entropy" version="0.1.0" manifest="./plugins/entropy/plugin.kdl"
plugin "mitre/churn" version="0.1.0" manifest="./plugins/churn/plugin.kdl"
plugin "mitre/activity" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/activity.kdl"
plugin "mitre/affiliation" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/affiliation.kdl"
plugin "mitre/binary" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/binary.kdl"
plugin "mitre/churn" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/churn.kdl"
plugin "mitre/entropy" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/entropy.kdl"
plugin "mitre/fuzz" version="0.1.1" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/fuzz.kdl"
plugin "mitre/review" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/review.kdl"
plugin "mitre/typo" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/typo.kdl"
}

patch {
plugin "mitre/github" {
api-token-var "HC_GITHUB_TOKEN"
}
}

analyze {
investigate policy="(gt 0.5 $)"
investigate-if-fail "mitre/typo" "mitre/binary"
Expand Down
5 changes: 2 additions & 3 deletions hipcheck/src/plugin/download_manifest.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// SPDX-License-Identifier: Apache-2.0

#[cfg(test)]
use crate::plugin::arch::KnownArch;
use crate::{
hc_error,
plugin::{arch::Arch, PluginVersion},
Expand All @@ -8,9 +10,6 @@ use crate::{
use kdl::{KdlDocument, KdlNode, KdlValue};
use std::{fmt::Display, str::FromStr};

#[cfg(test)]
use crate::plugin::arch::KnownArch;

// NOTE: the implementation in this crate was largely derived from RFD #0004

impl ParseKdlNode for url::Url {
Expand Down
1 change: 1 addition & 0 deletions hipcheck/src/plugin/plugin_manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ impl ParseKdlNode for Entrypoints {
.value()
.as_string()?
.to_string();

if let Err(_e) = entrypoints.insert(arch.clone(), entrypoint) {
log::error!("Duplicate entrypoint detected for [{}]", arch);
return None;
Expand Down
39 changes: 34 additions & 5 deletions hipcheck/src/plugin/retrieval.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@ use crate::{
error::Error,
hc_error,
plugin::{
download_manifest::DownloadManifestEntry, try_get_bin_for_entrypoint, ArchiveFormat,
DownloadManifest, HashAlgorithm, HashWithDigest, PluginId, PluginManifest,
download_manifest::DownloadManifestEntry, get_current_arch, try_get_bin_for_entrypoint,
ArchiveFormat, DownloadManifest, HashAlgorithm, HashWithDigest, PluginId, PluginManifest,
},
policy::policy_file::{ManifestLocation, PolicyPlugin},
util::{fs::file_sha256, http::agent::agent},
};
use flate2::read::GzDecoder;
use fs_extra::{dir::remove, file::write_all};
use pathbuf::pathbuf;
use std::{
collections::HashSet,
fs::File,
fs::{read_dir, rename, DirEntry, File},
io::{Read, Write},
path::{Path, PathBuf},
str::FromStr,
Expand All @@ -24,8 +25,6 @@ use tar::Archive;
use url::Url;
use xz2::read::XzDecoder;

use super::get_current_arch;

/// determine all of the plugins that need to be run and locate download them, if they do not exist
pub fn retrieve_plugins(
policy_plugins: &[PolicyPlugin],
Expand Down Expand Up @@ -56,6 +55,7 @@ fn retrieve_plugin(
if required_plugins.contains(&plugin_id) {
return Ok(());
}

// TODO: if the plugin.kdl file for the plugin already exists, then should we skip the retrieval process?
// if plugin_cache.plugin_kdl(&plugin_id).exists()

Expand Down Expand Up @@ -350,6 +350,35 @@ fn extract_plugin(
}
};

for child in read_dir(extract_dir)? {
let child = child?;

if child.file_type()?.is_file() {
continue;
}

for extracted_content in read_dir(child.path())? {
let extracted_content = extracted_content?;
move_to_extract_dir(extract_dir, &extracted_content)?;
}
}

Ok(())
}

fn move_to_extract_dir(extract_dir: &Path, entry: &DirEntry) -> Result<(), Error> {
let remaining_path = entry
.path()
.components()
.last()
.ok_or_else(|| hc_error!("no last component: {}", entry.path().display()))
.map(|component| {
let path: &Path = component.as_ref();
path.to_path_buf()
})?;

let new_path = pathbuf![extract_dir, &remaining_path];
rename(entry.path(), new_path)?;
Ok(())
}

Expand Down
4 changes: 2 additions & 2 deletions plugins/fuzz/plugin.kdl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
publisher "mitre"
name "fuzz"
version "0.1.0"
version "0.1.1"
license "Apache-2.0"

entrypoint {
Expand All @@ -11,5 +11,5 @@ entrypoint {
}

dependencies {
plugin "mitre/github" version="0.1.0" manifest="./plugins/github/plugin/github.kdl"
plugin "mitre/github" version="0.1.0" manifest="https://hipcheck.mitre.org/dl/plugin/mitre/github.kdl"
}
Loading