Skip to content

Commit c9beee2

Browse files
authored
docs: Update the document version to 0.4.6 (#363)
* docs: Update README with version `0.4.6` and improvements
1 parent f1f0907 commit c9beee2

File tree

3 files changed

+44
-73
lines changed

3 files changed

+44
-73
lines changed

README.md

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# HackBrowserData
66

7-
[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) [![unit tests](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml) [![Coverage Status](https://coveralls.io/repos/github/moonD4rk/HackBrowserData/badge.svg)](https://coveralls.io/github/moonD4rk/HackBrowserData)
7+
[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![Build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) [![Tests](https://github.com/moonD4rk/HackBrowserData/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/test.yml) [![Coverage Status](https://coveralls.io/repos/github/moonD4rk/HackBrowserData/badge.svg)](https://coveralls.io/github/moonD4rk/HackBrowserData)
88

99
[中文说明](https://github.com/moonD4rk/HackBrowserData/blob/master/README_ZH.md)
1010

@@ -89,52 +89,46 @@ Installation of `HackBrowserData` is dead-simple, just download [the release for
8989
9090
### Building from source
9191

92-
only support `go 1.21+` with go generics and log/slog standard library.
92+
only support `go 1.21+` with go generics and `log/slog` standard library.
9393

9494
```bash
9595
$ git clone https://github.com/moonD4rk/HackBrowserData
9696

9797
$ cd HackBrowserData/cmd/hack-browser-data
9898

99-
$ CGO_ENABLED=1 go build
99+
$ go build
100100
```
101101

102102
### Cross compile
103103

104-
Need install target OS's `gcc` library, here's an example of use `Mac` building for `Windows` and `Linux`
104+
Here's an example of use `macOS` building for `Windows` and `Linux`
105105

106106
#### For Windows
107107

108108
```shell
109-
brew install mingw-w64
110-
111-
CGO_ENABLED=1 GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-gcc go build
109+
GOOS=windows GOARCH=amd64 go build
112110
```
113111

114112
#### For Linux
115113

116114
````shell
117-
brew install FiloSottile/musl-cross/musl-cross
118-
119-
CC=x86_64-linux-musl-gcc CXX=x86_64-linux-musl-g++ GOARCH=amd64 GOOS=linux CGO_ENABLED=1 go build -ldflags "-linkmode external -extldflags -static"
115+
GOOS=linux GOARCH=amd64 go build
120116
````
121117

122118
### Run
123119

124120
You can double-click to run, or use command line.
125121

126-
```
127-
PS C:\test> .\hack-browser-data.exe -h
122+
```powershell
123+
PS C:\Users\moond4rk\Desktop> .\hack-browser-data.exe -h
128124
NAME:
129125
hack-browser-data - Export passwords|bookmarks|cookies|history|credit cards|download history|localStorage|extensions from browser
130-
131126
USAGE:
132127
[hack-browser-data -b chrome -f json --dir results --zip]
133128
Export all browsing data (passwords/cookies/history/bookmarks) from browser
134129
Github Link: https://github.com/moonD4rk/HackBrowserData
135-
136130
VERSION:
137-
0.4.5
131+
0.4.6
138132
139133
GLOBAL OPTIONS:
140134
--verbose, --vv verbose (default: false)
@@ -147,29 +141,27 @@ GLOBAL OPTIONS:
147141
--help, -h show help
148142
--version, -v print the version
149143
144+
```
145+
146+
For example, the following is an automatic scan of the browser on the current computer, outputting the decryption results in `JSON` format and compressing as `zip`.
150147

151-
PS C:\test> .\hack-browser-data.exe -b all -f json --dir results --zip
152-
[NOTICE] [browser.go:46,pickChromium] find browser Chrome success
153-
[NOTICE] [browser.go:46,pickChromium] find browser Microsoft Edge success
154-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_download.json success
155-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_password.json success
156-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_creditcard.json success
157-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_bookmark.json success
158-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_cookie.json success
159-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_history.json success
160-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_history.json success
161-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_download.json success
162-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_password.json success
163-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_creditcard.json success
164-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_bookmark.json success
165-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_cookie.json success
148+
```powershell
149+
PS C:\Users\moond4rk\Desktop> .\hack-browser-data.exe -b all -f json --dir results --zip
166150
151+
PS C:\Users\moond4rk\Desktop> ls -l .\results\
152+
Directory: C:\Users\moond4rk\Desktop\results
153+
154+
Mode LastWriteTime Length Name
155+
---- ------------- ------ ----
156+
-a---- 7/15/2024 10:55 PM 44982 results.zip
167157
```
158+
159+
168160
### Run with custom browser profile folder
169161

170162
If you want to export data from a custom browser profile folder, you can use the `-p` parameter to specify the path of the browser profile folder. PS: use double quotes to wrap the path.
171-
```
172-
PS C:\Users\User\Desktop> .\hack-browser-data.exe -b chrome -p "C:\Users\User\AppData\Local\Microsoft\Edge\User Data\Default"
163+
```powershell
164+
PS C:\Users\moond4rk\Desktop> .\hack-browser-data.exe -b chrome -p "C:\Users\User\AppData\Local\Microsoft\Edge\User Data\Default"
173165
174166
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_creditcard.csv success
175167
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_bookmark.csv success
@@ -179,11 +171,6 @@ PS C:\Users\User\Desktop> .\hack-browser-data.exe -b chrome -p "C:\Users\User\Ap
179171
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_password.csv success
180172
```
181173

182-
### Some other projects based on HackBrowserData
183-
[Sharp-HackBrowserData](https://github.com/S3cur3Th1sSh1t/Sharp-HackBrowserData)
184-
185-
[Reflective-HackBrowserData](https://github.com/idiotc4t/Reflective-HackBrowserData)
186-
187174
## Contributing
188175

189176
We welcome and appreciate any contributions made by the community (GitHub issues/pull requests, email feedback, etc.).

README_ZH.md

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -86,51 +86,45 @@
8686
8787
### 从源码编译
8888

89-
仅支持 `go 1.18+` 以后版本,一些函数使用到了泛型
89+
支持 `go 1.21+` 以后版本,一些函数使用了泛型基础库
9090

9191
``` bash
9292
$ git clone https://github.com/moonD4rk/HackBrowserData
9393

9494
$ cd HackBrowserData/cmd/hack-browser-data
9595

96-
$ CGO_ENABLED=1 go build
96+
$ go build
9797
```
9898

9999
### 跨平台编译
100100

101-
由于用到了 `go-sqlite3` 库,在跨平台编译时需提前安装支持目标平台的 `GCC` 工具,下面以 `MacOS` 下分别编译 `Windows``Linux` 程序为例:
101+
`macOS` 分别编译 `Windows``Linux` 程序为例:
102102

103103
#### Windows
104104

105105
``` shell
106-
brew install mingw-w64
107-
108-
CGO_ENABLED=1 GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-gcc go build
106+
GOOS=windows GOARCH=amd64 go build
109107
```
110108

111109
#### Linux
112110

113111
``` shell
114-
brew install FiloSottile/musl-cross/musl-cross
115-
116-
CC=x86_64-linux-musl-gcc CXX=x86_64-linux-musl-g++ GOARCH=amd64 GOOS=linux CGO_ENABLED=1 go build -ldflags "-linkmode external -extldflags -static"
112+
GOOS=linux GOARCH=amd64 go build
117113
```
118114

119115
### 运行
120116
双击直接运行,也可以使用命令行调用相应的命令。
121117

122-
```
123-
PS C:\test> .\hack-browser-data.exe -h
118+
```powershell
119+
PS C:\Users\moond4rk\Desktop> .\hack-browser-data.exe -h
124120
NAME:
125121
hack-browser-data - Export passwords|bookmarks|cookies|history|credit cards|download history|localStorage|extensions from browser
126-
127122
USAGE:
128123
[hack-browser-data -b chrome -f json --dir results --zip]
129124
Export all browsing data (passwords/cookies/history/bookmarks) from browser
130125
Github Link: https://github.com/moonD4rk/HackBrowserData
131-
132126
VERSION:
133-
0.4.5
127+
0.4.6
134128
135129
GLOBAL OPTIONS:
136130
--verbose, --vv verbose (default: false)
@@ -142,31 +136,21 @@ GLOBAL OPTIONS:
142136
--full-export, --full is export full browsing data (default: true)
143137
--help, -h show help
144138
--version, -v print the version
139+
```
145140

141+
举例:下面是自动扫描当前电脑上的浏览器数据,以 `JSON` 格式输出解密结果并压缩为 `zip` 文件
146142

147-
PS C:\test> .\hack-browser-data.exe -b all -f json --dir results --zip
148-
[NOTICE] [browser.go:46,pickChromium] find browser Chrome success
149-
[NOTICE] [browser.go:46,pickChromium] find browser Microsoft Edge success
150-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_download.json success
151-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_password.json success
152-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_creditcard.json success
153-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_bookmark.json success
154-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_cookie.json success
155-
[NOTICE] [browsingdata.go:59,Output] output to file results/microsoft_edge_history.json success
156-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_history.json success
157-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_download.json success
158-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_password.json success
159-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_creditcard.json success
160-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_bookmark.json success
161-
[NOTICE] [browsingdata.go:59,Output] output to file results/chrome_cookie.json success
143+
```powershell
144+
PS C:\Users\moond4rk\Desktop> .\hack-browser-data.exe -b all -f json --dir results --zip
162145
146+
PS C:\Users\moond4rk\Desktop> ls -l .\results\
147+
Directory: C:\Users\moond4rk\Desktop\results
148+
149+
Mode LastWriteTime Length Name
150+
---- ------------- ------ ----
151+
-a---- 7/15/2024 10:55 PM 44982 results.zip
163152
```
164153

165-
### 基于此工具的一些其他项目
166-
[Sharp-HackBrowserData](https://github.com/S3cur3Th1sSh1t/Sharp-HackBrowserData)
167-
168-
[Reflective-HackBrowserData](https://github.com/idiotc4t/Reflective-HackBrowserData)
169-
170154
## Contributors
171155

172156
![贡献者](/CONTRIBUTORS.svg)

cmd/hack-browser-data/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ func Execute() {
2929
app := &cli.App{
3030
Name: "hack-browser-data",
3131
Usage: "Export passwords|bookmarks|cookies|history|credit cards|download history|localStorage|extensions from browser",
32-
UsageText: "[hack-browser-data -b chrome -f json -dir results --zip]\nExport all browsing data (passwords/cookies/history/bookmarks) from browser\nGithub Link: https://github.com/moonD4rk/HackBrowserData",
33-
Version: "0.4.5",
32+
UsageText: "[hack-browser-data -b chrome -f json --dir results --zip]\nExport all browsing data (passwords/cookies/history/bookmarks) from browser\nGithub Link: https://github.com/moonD4rk/HackBrowserData",
33+
Version: "0.4.6",
3434
Flags: []cli.Flag{
3535
&cli.BoolFlag{Name: "verbose", Aliases: []string{"vv"}, Destination: &verbose, Value: false, Usage: "verbose"},
3636
&cli.BoolFlag{Name: "compress", Aliases: []string{"zip"}, Destination: &compress, Value: false, Usage: "compress result to zip"},

0 commit comments

Comments
 (0)