-
Notifications
You must be signed in to change notification settings - Fork 200
/
utils.rs
1215 lines (1117 loc) · 40.2 KB
/
utils.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
extern crate base64;
extern crate csv;
extern crate regex;
use crate::detections::configs::CURRENT_EXE_PATH;
use crate::options::htmlreport;
use compact_str::{CompactString, ToCompactString};
use hashbrown::{HashMap, HashSet};
use itertools::Itertools;
use nested::Nested;
use std::path::{Path, PathBuf};
use std::thread::available_parallelism;
use chrono::Local;
use termcolor::{Color, ColorChoice};
use tokio::runtime::{Builder, Runtime};
use chrono::{DateTime, TimeZone, Utc};
use regex::Regex;
use serde_json::{json, Error, Map, Value};
use std::cmp::Ordering;
use std::fs::{read_to_string, File};
use std::io::prelude::*;
use std::io::{BufRead, BufReader};
use std::str;
use std::string::String;
use std::vec;
use std::{fs, io};
use termcolor::{BufferWriter, ColorSpec, WriteColor};
use super::configs::{EventKeyAliasConfig, OutputOption, STORED_EKEY_ALIAS};
use super::detection::EvtxRecordInfo;
use super::message::AlertMessage;
use crate::detections::field_data_map::{convert_field_data, FieldDataMap, FieldDataMapKey};
use crate::detections::field_extract::extract_fields;
use memchr::memmem;
pub fn concat_selection_key(key_list: &Nested<String>) -> String {
return key_list
.iter()
.fold("detection -> selection".to_string(), |mut acc, cur| {
acc = acc + " -> " + cur;
acc
});
}
pub fn check_regex(string: &str, regex_list: &[Regex]) -> bool {
for regex in regex_list {
if !regex.is_match(string) {
continue;
}
return true;
}
false
}
pub fn check_allowlist(target: &str, regexes: &[Regex]) -> bool {
for regex in regexes {
if regex.is_match(target) {
return true;
}
}
false
}
pub fn value_to_string(value: &Value) -> Option<String> {
match value {
Value::Null => Option::None,
Value::Bool(b) => Option::Some(b.to_string()),
Value::Number(n) => Option::Some(n.to_string()),
Value::String(s) => Option::Some(s.trim().to_string()),
Value::Array(_) => Option::None,
Value::Object(_) => Option::None,
}
}
pub fn read_txt(filename: &str) -> Result<Nested<String>, String> {
let filepath = if filename.starts_with("./") {
check_setting_path(&CURRENT_EXE_PATH.to_path_buf(), filename, true)
.unwrap()
.to_str()
.unwrap()
.to_string()
} else {
filename.to_string()
};
let f = File::open(filepath);
if f.is_err() {
let errmsg = format!("Cannot open file. [file:{filename}]");
return Result::Err(errmsg);
}
let reader = BufReader::new(f.unwrap());
Result::Ok(Nested::from_iter(
reader.lines().map(|line| line.unwrap_or_default()),
))
}
/// convert jsonl fmt string to serde_json Value iterator
pub fn read_jsonl_to_value(path: &str) -> Result<Box<dyn Iterator<Item = Value>>, String> {
let f = File::open(path);
if f.is_err() {
return Err("Cannot open file. [file:{path}]".to_string());
}
let reader = BufReader::new(f.unwrap());
let mut peekable_lines = reader.lines().peekable();
let first_line = peekable_lines.peek().unwrap();
let is_jsonl = match first_line {
Ok(s) => serde_json::from_str::<Value>(s).is_ok(),
Err(_) => false,
};
if is_jsonl {
let ret = peekable_lines
.filter_map(|s| s.ok())
.filter(|s| !s.trim().is_empty())
.map(|line| {
let v: Value = serde_json::from_str(&line).unwrap();
json!({"Event":{"EventData": v}})
});
return Ok(Box::new(ret));
}
Err("Conversion failed because it is not in JSONL format.".to_string())
}
/// convert json fmt string to serde_json Value iterator
pub fn read_json_to_value(path: &str) -> Result<Box<dyn Iterator<Item = Value>>, String> {
let f = fs::read_to_string(path);
if f.is_err() {
return Err("Cannot open file. [file:{path}]".to_string());
}
let contents = f.unwrap();
let json_values: Result<Vec<Value>, Error> = serde_json::from_str(&contents);
let value_converter = |record: Value| json!({"Event":{"EventData": record}});
match json_values {
Ok(values) => {
// JSON(Array)形式の場合
let ret = values.into_iter().map(value_converter);
Ok(Box::new(ret))
}
Err(_) => {
// jq形式の場合
let newline_replaced_contents = contents.replace(['\n', '\r'], "");
let json = format!(
"[{}]",
newline_replaced_contents
.split("}{")
.filter(|s| !s.trim().is_empty())
.join("},{")
);
let all_values_res: Result<Value, Error> = serde_json::from_str(&json);
if let Err(err_msg) = all_values_res {
return Err(err_msg.to_string());
}
let values = all_values_res.unwrap().as_array().unwrap().clone();
let ret = values.into_iter().map(value_converter);
Ok(Box::new(ret))
}
}
}
pub fn read_csv(filename: &str) -> Result<Nested<Vec<String>>, String> {
let f = File::open(filename);
if f.is_err() {
return Result::Err(format!("Cannot open file. [file:{filename}]"));
}
let mut contents: String = String::new();
let mut ret = Nested::<Vec<String>>::new();
let read_res = f.unwrap().read_to_string(&mut contents);
if let Err(e) = read_res {
return Result::Err(e.to_string());
}
let mut rdr = csv::ReaderBuilder::new().from_reader(contents.as_bytes());
rdr.records().for_each(|r| {
if r.is_err() {
return;
}
let line = r.unwrap();
let mut v = vec![];
line.iter().for_each(|s| v.push(s.to_string()));
ret.push(v);
});
Result::Ok(ret)
}
pub fn get_event_id_key() -> String {
"Event.System.EventID".to_string()
}
pub fn get_event_time() -> String {
"Event.System.TimeCreated_attributes.SystemTime".to_string()
}
pub fn str_time_to_datetime(system_time_str: &str) -> Option<DateTime<Utc>> {
if system_time_str.is_empty() {
return Option::None;
}
let rfc3339_time = DateTime::parse_from_rfc3339(system_time_str);
if rfc3339_time.is_err() {
return Option::None;
}
Utc.from_local_datetime(&rfc3339_time.unwrap().naive_utc())
.single()
}
/// serde:Valueの型を確認し、文字列を返します。
pub fn get_serde_number_to_string(
value: &serde_json::Value,
search_flag: bool,
) -> Option<CompactString> {
if value.is_string() {
let val_str = value.as_str().unwrap_or("");
if val_str.ends_with(',') {
Some(CompactString::from(val_str))
} else {
Option::Some(CompactString::from(val_str))
}
} else if value.is_object() && search_flag {
let map: Map<String, Value> = Map::new();
let val_obj = value.as_object().unwrap_or(&map);
let val = val_obj
.iter()
.map(|(k, v)| format!("{k}:{v}").replace('\"', ""))
.collect::<Nested<String>>()
.iter()
.join(" ¦ ");
Some(CompactString::from(val))
} else if value.is_null() || (value.is_object() && !search_flag) {
// Object type is not specified record value.
Option::None
} else {
Some(CompactString::from(value.to_string()))
}
}
pub fn get_event_value<'a>(
key: &str,
event_value: &'a Value,
eventkey_alias: &EventKeyAliasConfig,
) -> Option<&'a Value> {
if key.is_empty() {
return Option::None;
}
let event_key = eventkey_alias.get_event_key(key);
let mut ret: &Value = event_value;
if let Some(event_key) = event_key {
// get_event_keyが取得できてget_event_key_splitが取得できないことはないため、unwrapのチェックは行わない
let splits = eventkey_alias.get_event_key_split(key);
let mut start_idx = 0;
for key in splits.unwrap() {
if !ret.is_object() {
return Option::None;
}
let val = &event_key[start_idx..(*key + start_idx)];
ret = &ret[val];
start_idx += *key;
start_idx += 1;
}
Option::Some(ret)
} else {
let event_key = if !contains_str(key, ".") {
"Event.EventData.".to_string() + key
} else {
key.to_string()
};
for key in event_key.split('.') {
if !ret.is_object() {
return Option::None;
}
ret = &ret[key];
}
Option::Some(ret)
}
}
pub fn get_thread_num(thread_number: Option<usize>) -> usize {
let cpu_num = available_parallelism().unwrap();
thread_number.unwrap_or(cpu_num.into())
}
pub fn create_tokio_runtime(thread_number: Option<usize>) -> Runtime {
Builder::new_multi_thread()
.worker_threads(get_thread_num(thread_number))
.thread_name("hayabusa-thread")
.build()
.unwrap()
}
// EvtxRecordInfoを作成します。
pub fn create_rec_info(
mut data: Value,
path: String,
keys: &Nested<String>,
recovered_record: &bool,
no_pwsh_field_extraction: &bool,
) -> EvtxRecordInfo {
// 高速化のための処理
// 例えば、Value型から"Event.System.EventID"の値を取得しようとすると、value["Event"]["System"]["EventID"]のように3回アクセスする必要がある。
// この処理を高速化するため、rec.key_2_valueというhashmapに"Event.System.EventID"というキーで値を設定しておく。
// これなら、"Event.System.EventID"というキーを1回指定するだけで値を取得できるようになるので、高速化されるはず。
// あと、serde_jsonのValueからvalue["Event"]みたいな感じで値を取得する処理がなんか遅いので、そういう意味でも早くなるかも
// それと、serde_jsonでは内部的に標準ライブラリのhashmapを使用しているが、hashbrownを使った方が早くなるらしい。標準ライブラリがhashbrownを採用したためserde_jsonについても高速化した。
let mut key_2_values = HashMap::new();
let binding = STORED_EKEY_ALIAS.read().unwrap();
let eventkey_alias = binding.as_ref().unwrap();
let mut event_id = None;
let mut channel = None;
for key in keys.iter() {
let val = get_event_value(key, &data, eventkey_alias);
if val.is_none() {
continue;
}
let val = value_to_string(val.unwrap());
if val.is_none() {
continue;
}
if !*no_pwsh_field_extraction {
if key == "EventID" {
event_id.clone_from(&val);
}
if key == "Channel" {
channel.clone_from(&val);
}
}
key_2_values.insert(key.to_string(), val.unwrap());
}
if !*no_pwsh_field_extraction {
extract_fields(channel, event_id, &mut data, &mut key_2_values);
}
// EvtxRecordInfoを作る
let data_str = data.to_string();
EvtxRecordInfo {
evtx_filepath: path,
record: data,
data_string: data_str,
key_2_value: key_2_values,
recovered_record: *recovered_record,
}
}
/**
* 標準出力のカラー出力設定を指定した値に変更し画面出力を行う関数
*/
pub fn write_color_buffer(
wtr: &BufferWriter,
color: Option<Color>,
output_str: &str,
newline_flag: bool,
) -> io::Result<()> {
let mut buf = wtr.buffer();
buf.set_color(ColorSpec::new().set_fg(color)).ok();
if newline_flag {
writeln!(buf, "{output_str}").ok();
} else {
write!(buf, "{output_str}").ok();
}
wtr.print(&buf)
}
/// no-colorのオプションの指定があるかを確認し、指定されている場合はNoneをかえし、指定されていない場合は引数で指定されたColorをSomeでラップして返す関数
pub fn get_writable_color(color: Option<Color>, no_color: bool) -> Option<Color> {
if no_color {
None
} else {
color
}
}
/**
* CSVのrecord infoカラムに出力する文字列を作る
*/
pub fn create_recordinfos(
record: &Value,
field_data_map_key: &FieldDataMapKey,
field_data_map: &Option<FieldDataMap>,
) -> Vec<CompactString> {
let mut output = HashSet::new();
_collect_recordinfo(
&mut vec![],
"",
0,
record,
record,
&mut output,
(field_data_map, field_data_map_key),
);
let mut output_vec: Vec<&(String, String)> = output.iter().collect();
// 同じレコードなら毎回同じ出力になるようにソートしておく
output_vec.sort_by(|(left, left_data), (right, right_data)| {
let ord = left.cmp(right);
if ord == Ordering::Equal {
left_data.cmp(right_data)
} else {
ord
}
});
output_vec
.iter()
.map(|(key, value)| {
if let Some(map) = field_data_map.as_ref() {
if let Some(converted_str) =
convert_field_data(map, field_data_map_key, &key.to_lowercase(), value, record)
{
let val = remove_sp_char(converted_str);
return format!("{key}: {val}",).into();
}
}
let val = remove_sp_char(value.into());
format!("{key}: {val}").into()
})
.collect()
}
/**
* CSVのfieldsカラムに出力する要素を全て収集する
*/
fn _collect_recordinfo<'a>(
keys: &mut Vec<&'a str>,
parent_key: &'a str,
arr_index: usize,
org_value: &'a Value,
cur_value: &'a Value,
output: &mut HashSet<(String, String)>,
filed_data_converter: (&Option<FieldDataMap>, &FieldDataMapKey),
) {
match cur_value {
Value::Array(ary) => {
for (i, sub_value) in ary.iter().enumerate() {
_collect_recordinfo(
keys,
parent_key,
i,
org_value,
sub_value,
output,
filed_data_converter,
);
}
}
Value::Object(obj) => {
// lifetimeの関係でちょっと変な実装になっている
if !parent_key.is_empty() {
keys.push(parent_key);
}
for (key, value) in obj {
if key.eq("xmlns") {
continue;
}
// Event.Systemは出力しない
if key.eq("System") && keys.first().unwrap_or(&"").eq(&"Event") {
continue;
}
_collect_recordinfo(keys, key, 0, org_value, value, output, filed_data_converter);
}
if !parent_key.is_empty() {
keys.pop();
}
}
Value::Null => (),
_ => {
// 一番子の要素の値しか収集しない
let strval = value_to_string(cur_value);
if let Some(strval) = strval {
let mut strval = strval.chars().fold(String::default(), |mut acc, c| {
if (c.is_control() || c.is_ascii_whitespace())
&& !['\r', '\n', '\t'].contains(&c)
{
acc.push(' ');
} else {
acc.push(c);
};
acc
});
if arr_index > 0 {
let (field_data_map, field_data_map_key) = filed_data_converter;
let i = arr_index + 1;
let field = format!("{parent_key}[{i}]",).to_lowercase();
if let Some(map) = field_data_map {
let converted_str = convert_field_data(
map,
field_data_map_key,
field.as_str(),
strval.as_str(),
org_value,
);
if let Some(converted_str) = converted_str {
strval = converted_str.to_string();
}
}
}
output.insert((parent_key.to_string(), strval));
}
}
}
}
/**
* 最初の文字を大文字にする関数
*/
pub fn make_ascii_titlecase(s: &str) -> CompactString {
let mut c = s.trim().chars();
match c.next() {
None => CompactString::default(),
Some(f) => {
if !f.is_ascii() {
CompactString::from(s)
} else {
f.to_uppercase().collect::<CompactString>() + c.as_str()
}
}
}
}
/// base_path/path が存在するかを確認し、存在しなければカレントディレクトリを参照するpathを返す関数
pub fn check_setting_path(base_path: &Path, path: &str, ignore_err: bool) -> Option<PathBuf> {
if base_path.join(path).exists() {
Some(base_path.join(path))
} else if ignore_err {
Some(Path::new(path).to_path_buf())
} else {
None
}
}
/// rule configのファイルの所在を確認する関数。
pub fn check_rule_config(config_path: &PathBuf) -> Result<(), String> {
// rules/configのフォルダが存在するかを確認する
let exist_rule_config_folder = if config_path == &CURRENT_EXE_PATH.to_path_buf() {
check_setting_path(config_path, "rules/config", false).is_some()
} else {
check_setting_path(config_path, "", false).is_some()
};
if !exist_rule_config_folder {
return Err("The required rules and config files were not found. Please download them with the update-rules command.".to_string());
}
// 各種ファイルを確認する
let files = vec![
"channel_abbreviations.txt",
"target_event_IDs.txt",
"default_details.txt",
"level_tuning.txt",
"channel_eid_info.txt",
"eventkey_alias.txt",
];
let mut not_exist_file = vec![];
for file in &files {
if check_setting_path(config_path, file, false).is_none() {
not_exist_file.push(*file);
}
}
if !not_exist_file.is_empty() {
return Err(format!(
"Could not find the following config files: {}\nPlease specify a correct rules config directory.\n",
not_exist_file.join(", ")
));
}
Ok(())
}
///タイムゾーンに合わせた情報を情報を取得する関数
pub fn format_time(
time: &DateTime<Utc>,
date_only: bool,
output_option: &OutputOption,
) -> CompactString {
if !(output_option.utc || output_option.iso_8601) {
format_rfc(&time.with_timezone(&Local), date_only, output_option)
} else {
format_rfc(time, date_only, output_option)
}
}
/// return rfc time format string by option
fn format_rfc<Tz: TimeZone>(
time: &DateTime<Tz>,
date_only: bool,
time_args: &OutputOption,
) -> CompactString
where
Tz::Offset: std::fmt::Display,
{
if time_args.rfc_2822 {
if date_only {
time.format("%a, %e %b %Y").to_compact_string()
} else {
time.format("%a, %e %b %Y %H:%M:%S %:z").to_compact_string()
}
} else if time_args.rfc_3339 {
if date_only {
time.format("%Y-%m-%d").to_compact_string()
} else {
time.format("%Y-%m-%d %H:%M:%S%.6f%:z").to_compact_string()
}
} else if time_args.us_time {
if date_only {
time.format("%m-%d-%Y").to_compact_string()
} else {
time.format("%m-%d-%Y %I:%M:%S%.3f %p %:z")
.to_compact_string()
}
} else if time_args.us_military_time {
if date_only {
time.format("%m-%d-%Y").to_compact_string()
} else {
time.format("%m-%d-%Y %H:%M:%S%.3f %:z").to_compact_string()
}
} else if time_args.european_time {
if date_only {
time.format("%d-%m-%Y").to_compact_string()
} else {
time.format("%d-%m-%Y %H:%M:%S%.3f %:z").to_compact_string()
}
} else if time_args.iso_8601 {
if date_only {
time.format("%Y-%m-%d").to_compact_string()
} else {
time.format("%Y-%m-%dT%H:%M:%S%.fZ").to_compact_string()
}
} else if date_only {
time.format("%Y-%m-%d").to_compact_string()
} else {
time.format("%Y-%m-%d %H:%M:%S%.3f %:z").to_compact_string()
}
}
/// Check file path exist. If path is existed, output alert message.
pub fn check_file_expect_not_exist(path: &Path, exist_alert_str: String) -> bool {
let ret = path.exists();
if ret {
AlertMessage::alert(&exist_alert_str).ok();
}
ret
}
pub fn output_and_data_stack_for_html(
output_str: &str,
section_name: &str,
html_report_flag: &bool,
) {
write_color_buffer(
&BufferWriter::stdout(ColorChoice::Always),
None,
output_str,
true,
)
.ok();
if *html_report_flag {
let mut output_data = Nested::<String>::new();
output_data.extend(vec![format!("- {output_str}")]);
htmlreport::add_md_data(section_name, output_data);
}
}
pub fn contains_str(input: &str, check: &str) -> bool {
memmem::find(input.as_bytes(), check.as_bytes()).is_some()
}
pub fn output_profile_name(output_option: &Option<OutputOption>, stdout: bool) {
// output profile name
if let Some(profile_opt) = output_option {
// default profile name check
let default_profile_name = read_to_string(
check_setting_path(
&CURRENT_EXE_PATH.to_path_buf(),
"config/default_profile_name.txt",
true,
)
.unwrap()
.to_str()
.unwrap(),
)
.unwrap_or("n/a".into());
// user input profile option
let profile_name = profile_opt
.profile
.as_ref()
.unwrap_or(&default_profile_name);
let output_saved_str = format!("Output profile: {profile_name}");
if stdout {
println!("{output_saved_str}");
}
// profileの表示位置とHTMLの出力順が異なるため引数で管理をした
if !stdout && profile_opt.html_report.is_some() {
htmlreport::add_md_data(
"General Overview {#general_overview}",
Nested::from_iter(vec![format!("- {output_saved_str}")]),
);
}
}
}
/// コンピュータ名がフィルタリング対象であるかを判定する関数
pub fn is_filtered_by_computer_name(
record: Option<&Value>,
(include_computer, exclude_computer): (&HashSet<CompactString>, &HashSet<CompactString>),
) -> bool {
if let Some(computer_name) = record {
let computer_str = computer_name.as_str().unwrap_or_default().replace('\"', "");
if (!include_computer.is_empty() && !include_computer.contains(computer_str.as_str()))
|| (!exclude_computer.is_empty() && exclude_computer.contains(computer_str.as_str()))
{
return true;
}
}
false
}
///指定された秒数とミリ秒数から出力文字列を作成する関数。絶対値での秒数から算出してhh:mm:ss.fffの形式で出力する。
pub fn output_duration((mut s, mut ms): (i64, i64)) -> String {
if s < 0 {
s = -s;
ms = -ms;
}
let h = s / 3600;
s %= 3600;
let m = s / 60;
s %= 60;
format!("{h:02}:{m:02}:{s:02}.{ms:03}")
}
pub fn remove_sp_char(record_value: CompactString) -> CompactString {
let mut newline_replaced_cs: String = record_value
.replace('\n', "🛂n")
.replace('\r', "🛂r")
.replace('\t', "🛂t");
let mut prev = 'a';
newline_replaced_cs.retain(|ch| {
let retain_flag = (prev == ' ' && ch == ' ') || ch.is_control();
if !retain_flag {
prev = ch;
}
!retain_flag
});
newline_replaced_cs.trim().into()
}
#[cfg(test)]
mod tests {
use std::path::Path;
use crate::detections::field_data_map::FieldDataMapKey;
use crate::{
detections::{
configs::{
Action, CommonOptions, Config, CsvOutputOption, DetectCommonOption, InputOption,
OutputOption, StoredStatic,
},
utils::{self, check_setting_path, make_ascii_titlecase},
},
options::htmlreport::HTML_REPORTER,
};
use chrono::NaiveDate;
use compact_str::CompactString;
use hashbrown::{HashMap, HashSet};
use nested::Nested;
use regex::Regex;
use serde_json::Value;
use super::{output_duration, output_profile_name};
#[test]
fn test_create_recordinfos() {
let record_json_str = r#"
{
"Event": {
"System": {"EventID": 4103, "Channel": "PowerShell", "Computer":"DESKTOP-ICHIICHI"},
"UserData": {"User": "u1", "AccessMask": "%%1369", "Process":"lsass.exe"},
"UserData_attributes": {"xmlns": "http://schemas.microsoft.com/win/2004/08/events/event"}
},
"Event_attributes": {"xmlns": "http://schemas.microsoft.com/win/2004/08/events/event"}
}"#;
match serde_json::from_str(record_json_str) {
Ok(record) => {
let ret = utils::create_recordinfos(&record, &FieldDataMapKey::default(), &None);
// Systemは除外される/属性(_attributesも除外される)/key順に並ぶ
let expected = "AccessMask: %%1369 ¦ Process: lsass.exe ¦ User: u1".to_string();
assert_eq!(ret.join(" ¦ "), expected);
}
Err(_) => {
panic!("Failed to parse json record.");
}
}
}
#[test]
fn test_create_recordinfos2() {
// EventDataの特殊ケース
let record_json_str = r#"
{
"Event": {
"System": {"EventID": 4103, "Channel": "PowerShell", "Computer":"DESKTOP-ICHIICHI"},
"EventData": {
"Binary": "hogehoge",
"Data":[
"Data1",
"DataData2",
"",
"DataDataData3"
]
},
"EventData_attributes": {"xmlns": "http://schemas.microsoft.com/win/2004/08/events/event"}
},
"Event_attributes": {"xmlns": "http://schemas.microsoft.com/win/2004/08/events/event"}
}"#;
match serde_json::from_str(record_json_str) {
Ok(record) => {
let ret = utils::create_recordinfos(&record, &FieldDataMapKey::default(), &None);
// Systemは除外される/属性(_attributesも除外される)/key順に並ぶ
let expected = "Binary: hogehoge ¦ Data: ¦ Data: Data1 ¦ Data: DataData2 ¦ Data: DataDataData3"
.to_string();
assert_eq!(ret.join(" ¦ "), expected);
}
Err(_) => {
panic!("Failed to parse json record.");
}
}
}
#[test]
fn test_check_regex() {
let regexes: Vec<Regex> =
utils::read_txt("rules/config/regex/detectlist_suspicous_services.txt")
.unwrap()
.iter()
.map(|regex_str| Regex::new(regex_str).unwrap())
.collect();
let regextext = utils::check_regex("\\cvtres.exe", ®exes);
assert!(regextext);
let regextext = utils::check_regex("\\hogehoge.exe", ®exes);
assert!(!regextext);
}
#[test]
fn test_check_allowlist() {
let commandline = "\"C:\\Program Files\\Google\\Update\\GoogleUpdate.exe\"";
let allowlist: Vec<Regex> =
utils::read_txt("rules/config/regex/allowlist_legitimate_services.txt")
.unwrap()
.iter()
.map(|allow_str| Regex::new(allow_str).unwrap())
.collect();
assert!(utils::check_allowlist(commandline, &allowlist));
let commandline = "\"C:\\Program Files\\Google\\Update\\GoogleUpdate2.exe\"";
assert!(!utils::check_allowlist(commandline, &allowlist));
}
#[test]
/// Serde::Valueの数値型の値を文字列として返却することを確かめるテスト
fn test_get_serde_number_to_string() {
let json_str = r#"
{
"Event": {
"System": {
"EventID": 11111
}
}
}
"#;
let event_record: Value = serde_json::from_str(json_str).unwrap();
assert_eq!(
utils::get_serde_number_to_string(&event_record["Event"]["System"]["EventID"], false),
Some(CompactString::from("11111"))
);
}
#[test]
/// Serde::Valueの文字列型の値を文字列として返却することを確かめるテスト
fn test_get_serde_number_serde_string_to_string() {
let json_str = r#"
{
"Event": {
"EventData": {
"ComputerName": "HayabusaComputer1"
}
}
}
"#;
let event_record: Value = serde_json::from_str(json_str).unwrap();
assert_eq!(
utils::get_serde_number_to_string(
&event_record["Event"]["EventData"]["ComputerName"],
false
)
.unwrap(),
"HayabusaComputer1".to_owned()
);
}
#[test]
/// Serde::Valueのオブジェクト型の内容を誤って渡した際にNoneを返却することを確かめるテスト
fn test_get_serde_number_serde_object_ret_none() {
let json_str = r#"
{
"Event": {
"EventData": {
"ComputerName": "HayabusaComputer1"
}
}
}
"#;
let event_record: Value = serde_json::from_str(json_str).unwrap();
assert!(
utils::get_serde_number_to_string(&event_record["Event"]["EventData"], false).is_none()
);
}
#[test]
/// 文字列を与えてascii文字を大文字にするように対応する関数のテスト
fn test_make_ascii_titlecase() {
assert_eq!(make_ascii_titlecase("aaaa".to_string().as_mut()), "Aaaa");
assert_eq!(
make_ascii_titlecase("i am Test".to_string().as_mut()),
"I am Test"
);
assert_eq!(make_ascii_titlecase("β".to_string().as_mut()), "β");
}
#[test]
/// 与えられたパスからファイルの存在確認ができているかのテスト
fn test_check_setting_path() {
let exist_path = Path::new("./test_files").to_path_buf();
let not_exist_path = Path::new("not_exist_path").to_path_buf();
assert_eq!(
check_setting_path(¬_exist_path, "rules", true)
.unwrap()
.to_str()
.unwrap(),
"rules"
);
assert_eq!(
check_setting_path(¬_exist_path, "fake", true)
.unwrap()
.to_str()
.unwrap(),
"fake"
);
assert_eq!(
check_setting_path(&exist_path, "rules", true)
.unwrap()
.to_str()
.unwrap(),
exist_path.join("rules").to_str().unwrap()
);
assert_eq!(
check_setting_path(&exist_path, "fake", true)
.unwrap()
.to_str()
.unwrap(),
"fake"
);
}
#[test]
fn test_json_array_file_to_serde_json_value() {
// 存在しないパスはErr
let r = utils::read_json_to_value("invalid path");
assert!(r.is_err());
// JSON(Array)形式を変換できること
let path = "test_files/evtx/test.json";
let records = utils::read_json_to_value(path).unwrap();
let records: Vec<Value> = records.into_iter().collect();
assert_eq!(records.len(), 2);
assert_eq!(
records[0]["Event"]["EventData"]["@timestamp"],
"2020-05-02T02:55:26.493Z"
);
assert_eq!(