Merge pull request #616 from Yamato-Security/615-enhancement-combining-u-and-r-options

enhancement combining u and r options
2022-07-03 08:40:23 +09:00
parent bc464b6c6f 2a981640eb
commit 14e8341c7d
7 changed files with 83 additions and 41 deletions
--- a/CHANGELOG-Japanese.md
+++ b/CHANGELOG-Japanese.md
@@ -1,5 +1,19 @@
 # 変更点

+## v1.4.2 [2022/07/XX]
+
+**新機能:**
+
+- XXX
+
+**改善:**
+
+- `--update-rules` オプションを利用する時に、更新対象のレポジトリを`--rules`オプションで指定できるようにした。 (#615) (@hitenkoku)
+
+**バグ修正:**
+
+- XXX
+
 ## v1.4.1 [2022/06/30]

 **改善:**
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changes

+## v1.4.2 [2022/07/XX]
+
+**New Features:**
+
+- XXX
+
+**Enhancements:**
+
+- Combining the two options, you can now update rules with `--update-rules` option to a custom rules directory with the `--rules` option. (#615) (@hitenkoku)
+
+**Bug Fixes:**
+
+- XXX
+
 ## v1.4.1 [2022/06/30]

 **Enhancements:**
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -169,7 +169,7 @@ checksum = "4acbb09d9ee8e23699b9634375c72795d095bf268439da88562cf9b501f181fa"
 dependencies = [
 "camino",
 "cargo-platform",
- "semver 1.0.11",
+ "semver 1.0.12",
 "serde",
 "serde_json",
 ]
@@ -220,9 +220,9 @@ dependencies = [

 [[package]]
 name = "clap"
-version = "3.2.7"
+version = "3.2.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b7b16274bb247b45177db843202209b12191b631a14a9d06e41b3777d6ecf14"
+checksum = "190814073e85d238f31ff738fcb0bf6910cedeb73376c87cd69291028966fd83"
 dependencies = [
 "atty",
 "bitflags",
@@ -678,7 +678,7 @@ dependencies = [
 "base64",
 "bytesize",
 "chrono",
- "clap 3.2.7",
+ "clap 3.2.8",
 "crossbeam-utils",
 "csv",
 "downcast-rs",
@@ -914,7 +914,7 @@ dependencies = [
 "anyhow",
 "atty",
 "chrono",
- "clap 3.2.7",
+ "clap 3.2.8",
 "file-chunker",
 "indicatif",
 "memmap2",
@@ -1476,9 +1476,9 @@ dependencies = [

 [[package]]
 name = "semver"
-version = "1.0.11"
+version = "1.0.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3d92beeab217753479be2f74e54187a6aed4c125ff0703a866c3147a02f0c6dd"
+checksum = "a2333e6df6d6598f2b1974829f853c2b4c5f4a6e503c10af918081aa6f8564e1"
 dependencies = [
 "serde",
 ]
@@ -1491,18 +1491,18 @@ checksum = "388a1df253eca08550bef6c72392cfe7c30914bf41df5269b68cbd6ff8f570a3"

 [[package]]
 name = "serde"
-version = "1.0.137"
+version = "1.0.138"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1"
+checksum = "1578c6245786b9d168c5447eeacfb96856573ca56c9d68fdcf394be134882a47"
 dependencies = [
 "serde_derive",
 ]

 [[package]]
 name = "serde_derive"
-version = "1.0.137"
+version = "1.0.138"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be"
+checksum = "023e9b1467aef8a10fb88f25611870ada9800ef7e22afce356bb0d2387b6f27c"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -1902,9 +1902,9 @@ checksum = "5bd2fe26506023ed7b5e1e315add59d6f584c621d037f9368fea9cfb988f368c"

 [[package]]
 name = "unicode-normalization"
-version = "0.1.20"
+version = "0.1.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "81dee68f85cab8cf68dec42158baf3a79a1cdc065a8b103025965d6ccb7f6cbd"
+checksum = "854cbdc4f7bc6ae19c820d44abdc3277ac3e1b2b93db20a636825d9322fb60e6"
 dependencies = [
 "tinyvec",
 ]
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "hayabusa"
-version = "1.4.1"
+version = "1.4.2-dev"
 authors = ["Yamato Security @SecurityYamato"]
 edition = "2021"

--- a/2
+++ b/2
--- a/src/main.rs
+++ b/src/main.rs
@@ -114,7 +114,9 @@ impl App {
        }

        if configs::CONFIG.read().unwrap().args.update_rules {
-            match UpdateRules::update_rules() {
+            match UpdateRules::update_rules(
+                configs::CONFIG.read().unwrap().args.rules.to_str().unwrap(),
+            ) {
                Ok(output) => {
                    if output != "You currently have the latest rules." {
                        write_color_buffer(
--- a/src/options/update_rules.rs
+++ b/src/options/update_rules.rs
@@ -20,12 +20,12 @@ pub struct UpdateRules {}

 impl UpdateRules {
    /// update rules(hayabusa-rules subrepository)
-    pub fn update_rules() -> Result<String, git2::Error> {
+    pub fn update_rules(rule_path: &str) -> Result<String, git2::Error> {
        let mut result;
        let mut prev_modified_time: SystemTime = SystemTime::UNIX_EPOCH;
        let mut prev_modified_rules: HashSet<String> = HashSet::default();
        let hayabusa_repo = Repository::open(Path::new("."));
-        let hayabusa_rule_repo = Repository::open(Path::new("rules"));
+        let hayabusa_rule_repo = Repository::open(Path::new(rule_path));
        if hayabusa_repo.is_err() && hayabusa_rule_repo.is_err() {
            write_color_buffer(
                &BufferWriter::stdout(ColorChoice::Always),
@@ -35,45 +35,57 @@ impl UpdateRules {
            )
            .ok();
            // execution git clone of hayabusa-rules repository when failed open hayabusa repository.
-            result = UpdateRules::clone_rules();
+            result = UpdateRules::clone_rules(Path::new(rule_path));
        } else if hayabusa_rule_repo.is_ok() {
            // case of exist hayabusa-rules repository
            UpdateRules::_repo_main_reset_hard(hayabusa_rule_repo.as_ref().unwrap())?;
            // case of failed fetching origin/main, git clone is not executed so network error has occurred possibly.
-            prev_modified_rules = UpdateRules::get_updated_rules("rules", &prev_modified_time);
-            prev_modified_time = fs::metadata("rules").unwrap().modified().unwrap();
+            prev_modified_rules = UpdateRules::get_updated_rules(rule_path, &prev_modified_time);
+            prev_modified_time = fs::metadata(rule_path).unwrap().modified().unwrap();
            result = UpdateRules::pull_repository(&hayabusa_rule_repo.unwrap());
        } else {
            // case of no exist hayabusa-rules repository in rules.
            // execute update because submodule information exists if hayabusa repository exists submodule information.

-            prev_modified_time = fs::metadata("rules").unwrap().modified().unwrap();
-            let rules_path = Path::new("rules");
+            prev_modified_time = fs::metadata(rule_path).unwrap().modified().unwrap();
+            let rules_path = Path::new(rule_path);
            if !rules_path.exists() {
                create_dir(rules_path).ok();
            }
-            let hayabusa_repo = hayabusa_repo.unwrap();
-            let submodules = hayabusa_repo.submodules()?;
-            let mut is_success_submodule_update = true;
-            // submodule rules erase path is hard coding to avoid unintentional remove folder.
-            fs::remove_dir_all(".git/.submodule/rules").ok();
-            for mut submodule in submodules {
-                submodule.update(true, None)?;
-                let submodule_repo = submodule.open()?;
-                if let Err(e) = UpdateRules::pull_repository(&submodule_repo) {
-                    AlertMessage::alert(&format!("Failed submodule update. {}", e)).ok();
-                    is_success_submodule_update = false;
+            if rule_path == "./rules" {
+                let hayabusa_repo = hayabusa_repo.unwrap();
+                let submodules = hayabusa_repo.submodules()?;
+                let mut is_success_submodule_update = true;
+                // submodule rules erase path is hard coding to avoid unintentional remove folder.
+                fs::remove_dir_all(".git/.submodule/rules").ok();
+                for mut submodule in submodules {
+                    submodule.update(true, None)?;
+                    let submodule_repo = submodule.open()?;
+                    if let Err(e) = UpdateRules::pull_repository(&submodule_repo) {
+                        AlertMessage::alert(&format!("Failed submodule update. {}", e)).ok();
+                        is_success_submodule_update = false;
+                    }
+                }
+                if is_success_submodule_update {
+                    result = Ok("Successed submodule update".to_string());
+                } else {
+                    result = Err(git2::Error::from_str(&String::default()));
                }
-            }
-            if is_success_submodule_update {
-                result = Ok("Successed submodule update".to_string());
            } else {
-                result = Err(git2::Error::from_str(&String::default()));
+                write_color_buffer(
+                    &BufferWriter::stdout(ColorChoice::Always),
+                    None,
+                    "Attempting to git clone the hayabusa-rules repository into the rules folder.",
+                    true,
+                )
+                .ok();
+                // execution git clone of hayabusa-rules repository when failed open hayabusa repository.
+                result = UpdateRules::clone_rules(rules_path);
            }
        }
        if result.is_ok() {
            let updated_modified_rules =
-                UpdateRules::get_updated_rules("rules", &prev_modified_time);
+                UpdateRules::get_updated_rules(rule_path, &prev_modified_time);
            result = UpdateRules::print_diff_modified_rule_dates(
                prev_modified_rules,
                updated_modified_rules,
@@ -129,10 +141,10 @@ impl UpdateRules {
    }

    /// git clone でhauyabusa-rules レポジトリをrulesフォルダにgit cloneする関数
-    fn clone_rules() -> Result<String, git2::Error> {
+    fn clone_rules(rules_path: &Path) -> Result<String, git2::Error> {
        match Repository::clone(
            "https://github.com/Yamato-Security/hayabusa-rules.git",
-            "rules",
+            rules_path,
        ) {
            Ok(_repo) => {
                println!("Finished cloning the hayabusa-rules repository.");