change readme
This commit is contained in:
@@ -72,16 +72,14 @@ You can check out sample CSV and manually edited XLSX timeline results [here](ht
|
||||
* JSON support for sending alerts to Elastic Stack/Splunk, etc...
|
||||
|
||||
# Downloads
|
||||
You can `git clone` the repository with the following command:
|
||||
You can download latests Hayabusa from Release.
|
||||
|
||||
You can also `git clone` the repository with the following command and compile binary from source code.:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Yamato-Security/hayabusa.git
|
||||
```
|
||||
|
||||
You can also manually download and extract Hayabusa from [https://github.com/Yamato-Security/hayabusa](https://github.com/Yamato-Security/hayabusa).
|
||||
|
||||
After that, you need to download a pre-compiled binary for Windows or macOS at the [Releases](https://github.com/Yamato-Security/hayabusa/releases) page and save it to the `hayabusa\bin` folder.
|
||||
|
||||
There are two different versions of the evtx library being used when compiled: `0.6.7` and `0.7.2`.
|
||||
The `0.7.2` version should work but we have only tested it with `0.6.7` so please use that version if you experience any problems with `0.7.2`.
|
||||
|
||||
@@ -113,7 +111,7 @@ git clone https://github.com/Yamato-Security/hayabusa-sample-evtx.git
|
||||
> Note: You need to run the binary from the Hayabusa root directory.
|
||||
|
||||
# Usage
|
||||
> Note: You need to run the Hayabusa binary from the Hayabusa root directory. Example: `.\bin\hayabusa.exe`
|
||||
> Note: You need to run the Hayabusa binary from the Hayabusa root directory. Example: `.\hayabusa.exe`
|
||||
|
||||
## Command line options
|
||||
```bash
|
||||
@@ -141,62 +139,62 @@ USAGE:
|
||||
## Usage examples
|
||||
* Run hayabusa against one Windows event log file:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -f eventlog.evtx
|
||||
.\hayabusa.exe -f eventlog.evtx
|
||||
```
|
||||
|
||||
* Run hayabusa against the sample-evtx directory with multiple Windows event log files:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx
|
||||
```
|
||||
|
||||
* Export to a single CSV file for further analysis with excel or timeline explorer:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -o results.csv
|
||||
```
|
||||
|
||||
* Only run hayabusa rules (the default is to run all the rules in `-r .\rules`):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa -o results.csv
|
||||
```
|
||||
|
||||
* Only run hayabusa rules for logs that are enabled by default on Windows:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default -o results.csv
|
||||
```
|
||||
|
||||
* Only run hayabusa rules for sysmon logs:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\sysmon -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\sysmon -o results.csv
|
||||
```
|
||||
|
||||
* Only run sigma rules:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\sigma -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\sigma -o results.csv
|
||||
```
|
||||
|
||||
* Enable deprecated rules (those with `status` marked as `deprecated`) and noisy rules (those whose rule ID is listed in `.\config\noisy-rules.txt`):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx --enable-noisy-rules --enable-deprecated-rules -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx --enable-noisy-rules --enable-deprecated-rules -o results.csv
|
||||
```
|
||||
|
||||
* Only run rules to analyze logons and output in the UTC timezone:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default\events\Security\Logons -u -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default\events\Security\Logons -u -o results.csv
|
||||
```
|
||||
|
||||
* Run on a live Windows machine (requires Administrator privileges) and only detect alerts (potentially malicious behavior):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d C:\Windows\System32\winevt\Logs -m low
|
||||
.\hayabusa.exe -d C:\Windows\System32\winevt\Logs -m low
|
||||
```
|
||||
|
||||
* Get event ID statistics:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -f Security.evtx -s
|
||||
.\hayabusa.exe -f Security.evtx -s
|
||||
```
|
||||
|
||||
* Print verbose information (useful for determining which files take long to process, parsing errors, etc...):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -v
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -v
|
||||
```
|
||||
|
||||
* Verbose output example:
|
||||
|
||||
@@ -73,16 +73,14 @@ CSVと手動で編集したXLSXのタイムライン結果のサンプルは[こ
|
||||
* JSONへの出力→Elastic Stack/Splunkへのインポート
|
||||
|
||||
# ダウンロード
|
||||
以下の`git clone`コマンドでレポジトリをダウンロードできます:
|
||||
Hayabusaは[https://github.com/Yamato-Security/hayabusa](https://github.com/Yamato-Security/hayabusa)のReleaseから最新版をダウンロードできます。
|
||||
|
||||
または、以下の`git clone`コマンドでレポジトリをダウンロードし、ソースコードからコンパイルして使用することも可能です。
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Yamato-Security/hayabusa.git
|
||||
```
|
||||
|
||||
または、手動で[https://github.com/Yamato-Security/hayabusa](https://github.com/Yamato-Security/hayabusa)からHayabusaをダウンロードすることもできます。
|
||||
|
||||
その後、Windows、macOS用のコンパイル済みバイナリを[Releases](https://github.com/Yamato-Security/Hayabusa/releases)からダウンロードして、`hayabusa\bin`のディレクトリに置く必要があります。
|
||||
|
||||
evtxライブラリのバージョン(`0.6.7`と`0.7.2`)毎に、コンパイルされたバイナリが用意されています。
|
||||
`0.7.2`バージョンでも動作するはずですが、`0.6.7`でしかテストしていませんので、`0.7.2`で問題が発生した場合はそちらをご利用ください。
|
||||
|
||||
@@ -142,62 +140,62 @@ USAGE:
|
||||
## 使用例
|
||||
* 1 つのWindowsイベントログファイルに対してHayabusaを実行します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -f eventlog.evtx
|
||||
.\hayabusa.exe -f eventlog.evtx
|
||||
```
|
||||
|
||||
* 複数のWindowsイベントログファイルのあるsample-evtxディレクトリに対して、Hayabusaを実行します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx
|
||||
```
|
||||
|
||||
* 1 つのCSVファイルにエクスポートして、EXCELやTimeline Explorerでさらに分析することができます:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -o results.csv
|
||||
```
|
||||
|
||||
* Hayabusaルールのみを実行します(デフォルトでは `-r .\rules` にあるすべてのルールが利用されます):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa -o results.csv
|
||||
```
|
||||
|
||||
* Windowsでデフォルトで有効になっているログに対してのみ、Hayabusaルールを実行します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\default -o results.csv
|
||||
```
|
||||
|
||||
* Sysmonログに対してのみHayabusaルールを実行します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\sysmon -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\hayabusa\sysmon -o results.csv
|
||||
```
|
||||
|
||||
* Sigmaルールのみを実行します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\sigma -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r .\rules\sigma -o results.csv
|
||||
```
|
||||
|
||||
* 廃棄(deprecated)されたルール(`status`が`deprecated`になっているルール)とノイジールール(`.\config\noisy-rules.txt`にルールIDが書かれているルール)を有効にします:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx --enable-deprecated-rules --enable-noisy-rules -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx --enable-deprecated-rules --enable-noisy-rules -o results.csv
|
||||
```
|
||||
|
||||
* ログオン情報を分析するルールのみを実行し、UTCタイムゾーンで出力します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -r ./rules/Hayabusa/default/events/Security/Logons -u -o results.csv
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -r ./rules/Hayabusa/default/events/Security/Logons -u -o results.csv
|
||||
```
|
||||
|
||||
* 起動中のWindows端末上で実行し(Administrator権限が必要)、アラート(悪意のある可能性のある動作)のみを検知します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d C:\Windows\System32\winevt\Logs -m low
|
||||
.\hayabusa.exe -d C:\Windows\System32\winevt\Logs -m low
|
||||
```
|
||||
|
||||
* イベントIDの統計情報を取得します:
|
||||
```bash
|
||||
.\bin\hayabusa.exe -f Security.evtx -s
|
||||
.\hayabusa.exe -f Security.evtx -s
|
||||
```
|
||||
|
||||
* 詳細なメッセージを出力します(処理に時間がかかるファイル、パースエラー等を特定するのに便利):
|
||||
```bash
|
||||
.\bin\hayabusa.exe -d .\hayabusa-sample-evtx -v
|
||||
.\hayabusa.exe -d .\hayabusa-sample-evtx -v
|
||||
```
|
||||
|
||||
* Verbose出力の例:
|
||||
|
||||
2
logs/.gitignore
vendored
Normal file
2
logs/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
*
|
||||
!.gitignore
|
||||
@@ -1 +0,0 @@
|
||||
Don't delete this file.
|
||||
Reference in New Issue
Block a user