Simple tutorial

2026-07-02 16:24:27 +08:00 · 2021-09-22 15:45:49 +08:00
parent c277844cf4
commit c2514602e8
33 changed files with 124 additions and 26 deletions
@@ -0,0 +1,118 @@
+# Proxmark3GUI
+![downloads](https://img.shields.io/github/downloads/wh201906/Proxmark3GUI/total)  
+
+一个自制的[Proxmark3](https://github.com/Proxmark/proxmark3) GUI，可在Windows/Linux系统下运行
+
+[English](../../README.md)
+
+***
+
+## 功能
+
+ 快速查找可用端口并连接
+ 支持直接输入PM3命令(官方版/冰人版)
+ 有针对于Mifare卡（IC卡）的图形界面
+    + 支持不同大小的卡片(MINI, 1K, 2K, 4K)
+    + 支持编辑Mifare扇区数据
+    + 支持读取全卡/选中扇区，读卡逻辑更加智能
+    + 支持写入全卡/选中扇区
+    + 可以打开二进制/文本格式的扇区数据文件
+    + 分析访问控制位（Access Bits）
+    + 支持UID卡操作（UID快速读写，UFUID锁卡）
+ 支持部分低频命令
+ 自定义UI界面，各选项卡可拆分组合
+ ...
+
+***
+
+## 预览图
+![preview](preview_zh_CN.png)  
+
+ [更多预览](../preview/previews.md)  
+
+***
+
+ ## 关于冰人版
+ [冰人版](https://github.com/RfidResearchGroup/proxmark3)(Iceman/RRG)的客户端和固件更新更为激进，相比官方版具有更多的功能  
+ 此GUI所有功能均兼容冰人版（在v4.13441上测试通过）  
+
+***
+
+## 关于预编译Windows客户端
+
+一位国外大佬 [Gator96100](https://github.com/Gator96100) 做了个 [ProxSpace](https://github.com/Gator96100/ProxSpace) 以便在Windows平台上编译PM3固件和客户端，他还把自己编译好的客户端放到了[网站](https://www.proxmarkbuilds.org/)上  
+release页面中有含客户端的GUI。这个GUI也可以搭配你自己的客户端使用  
+(本来打算在CSDN下载里面放几个最新版客户端的，结果不能把下载币改为0)  
+感谢大佬  
+
+***
+
+## 在Linux系统下编译
+
+    cd ~
+    sudo apt-get update
+    sudo apt-get install qt5-default libqt5serialport5 libqt5serialport5-dev 
+    git clone https://github.com/wh201906/Proxmark3GUI.git --depth=1
+    cd Proxmark3GUI
+    mkdir build
+    cd build
+    qmake ../
+    make
+    make clean
+    cp -r ../lang ./
+    cp -r ../config ./
+    ./Proxmark3GUI
+
+***
+## 教程
+[1.快速上手](../tutorial/Quickstart/quickstart_zh_CN.md)
+***
+## 更新日志:
+
+### V0.2.2
+ 从外部文件加载客户端命令格式  
+ 修复 [#20](https://github.com/wh201906/Proxmark3GUI/issues/20), [#21](https://github.com/wh201906/Proxmark3GUI/issues/21), [#22](https://github.com/wh201906/Proxmark3GUI/issues/22)  
+ 兼容冰人版客户端 v4.13441
+
+### V0.2.1
+ 优化MIFARE Classic读卡逻辑
+ 修复 [#16](https://github.com/wh201906/Proxmark3GUI/issues/16) （配合新版RRG固件时无法读取扇区数据）
+ 修复 [#15](https://github.com/wh201906/Proxmark3GUI/issues/15) （路径中支持空格）
+
+### V0.2
+ 使用浮动窗口，界面配置更加灵活  
+ 支持部分低频命令  
+ 修复原始命令选项卡中的一个Bug  
+
+### V0.1.4
+ 优化性能  
+ 优化用户界面  
+ 自动搜索可用端口  
+ 支持高分屏  
+ 可通过外部脚本配置环境变量  
+(在客户端需要配置环境变量时很有用)  
+ 全功能兼容冰人版（在v4.9237上测试通过）  
+ 支持指定客户端工作路径
+ 修复部分bug
+
+### V0.1.3
+ 修复访问控制位解码器
+ 写多个块时显示写入结果
+
+### V0.1.2
+ 优化读卡逻辑
+ UI自定义
+ 自动保存客户端路径
+ 添加访问控制位解码器（也可用于自己构造访问控制位）（有bug，请使用V0.1.3或更高版本）
+ 支持仅读写选中块
+ 支持部分冰人功能
+ 修复部分bug
+
+### V0.1.1
+ 完成整个Mifare模块（支持模拟卡和嗅探功能）
+
+### V0.1
+ 支持处理Mifare卡片及相关数据文件
+
+### V0.0.1
+ 一个带串口选择框的实验版本
@@ -0,0 +1,20 @@
+## Previews
+
+Raw Command:  
+![raw_command](raw_command.gif) 
+
+Mifare Nested Attack:  
+![nested_attack](mf_nested_attack.gif)  
+
+Mifare Load File:  
+![mf_loadfile](mf_loadfile.gif)  
+
+Mifare Edit File:  
+![mf_editfile](mf_editfile.gif)  
+
+Mifare Trailer Decoder:  
+![mf_trailer](mf_trailer.gif)
+
+Dock Widget:  
+![dock1](dock1.png)  
+![dock2](dock2.png)  
@@ -0,0 +1,44 @@
+# Quickstart
+
+***
+**On Windows**
+***
+## Use GUI with included client
+(1) Download the GUI with included client on [release](https://github.com/wh201906/Proxmark3GUI/releases) page  
+![](download_withclient.png)  
+
+(2) Extract the .7z file to a path. The target path should not contain non-ASCII characters  
+![](pm3guipath.png)  
+
+(3) Open Proxmark3GUI.exe in the GUI folder, then select the language and click "OK". Now you can use it  
+![](pm3gui.png)  
+![](language.png)  
+
+## Use the GUI with your own client
+(1) Download the standalone GUI on [release](https://github.com/wh201906/Proxmark3GUI/releases) page  
+![](download.png)  
+
+(2) Extract the .7z file to a path. The target path should not contain non-ASCII characters. Make sure the client path and the GUI path are different.  
+
+(3) Open the GUI. Input the client path in the "Client Path" editbox on the top of the main window.  
+![](pm3path.png)  
+
+(4) Go to "Settings" panel. Input the config file path which matching the client you use.  
+![](configpath.png)  
+
+(5) If setup.bat is required, input the script path in the "Preload script path" editbox.
+![](preloadpath.png)  
+
+(6) If using RRG/Iceman repo, input "-p \<port\> -f" in the "Start arguments" editbox.
+![](args.png)  
+
+***
+**On Linux**
+***
+(1) Build the GUI by following the instructions on [README](../../../README.md)  
+(2) Config the GUI with the same steps of "On Windows"->"Use the GUI with your own client"  
+(3) You might need to change "\<port\>" to "/dev/\<port\>" in "Settings"->"Start arguments" editbox  
+![](args_linux.png)  
+
+(4) If you are using Raspbian(Raspberry OS), you might need to check "Keep the client active even the PM3 hardware is disconnected." in the "Steeings" panel  
+![](keep.png)  
@@ -0,0 +1,48 @@
+# 快速上手
+
+***
+**Windows用户**
+***
+## 使用包含客户端的版本
+(1) 直接下载[release](https://github.com/wh201906/Proxmark3GUI/releases)当中包含客户端的版本即可  
+![](download_withclient.png)  
+（例如Vx.x.x-win-Officialclient.7z或Vx.x.x-win-RRGclient.7z，前者为官方客户端，后者为冰人版/RRG客户端）  
+
+(2) 下载完成后将压缩包内所有内容解压到不含中文的路径当中  
+![](pm3guipath.png)  
+
+(3) 双击GUI目录下的Proxmark3GUI.exe，选择语言，点击OK，即可正常运行  
+![](pm3gui.png)  
+![](language_zh_CN.png)  
+***
+
+## 使用现有客户端
+(1) 下载[release](https://github.com/wh201906/Proxmark3GUI/releases)当中不包含客户端的版本  
+![](download.png)  
+
+(2) 解压到不含中文的路径当中  
+（注意，GUI所在目录和PM3客户端所在目录不能相同）  
+
+(3) 双击打开，选择语言，在顶端“客户端路径”当中填入proxmark3.exe的路径  
+![](pm3path_zh_CN.png)  
+
+(4) 进入“设置”面板，根据自己使用的客户端类型（官方版/冰人版）选择正确的配置文件  
+（./config/config_official.json或./config/config_rrgv4.13.json）  
+![](configpath_zh_CN.png)  
+
+(5) 若客户端启动时需要双击setup.bat启动，而setup.bat内会设置客户端运行时的环境变量，则需要在“预加载脚本路径”当中填入setup.bat的路径  
+![](preloadpath_zh_CN.png)  
+
+(6) 若使用的是冰人固件，则可能需要在“启动参数”当中填入“-p \<port\> -f”  
+![](args_zh_CN.png)  
+
+***
+**Linux用户**
+***
+(1) 参考[README](../../README/README_zh_CN.md)当中的编译步骤手动编译Proxmark3GUI  
+(2) 参考“Windows用户”->“使用现有客户端”的(2)~(6)步进行配置  
+(3) “设置”->“启动参数”当中可能需要将“\<port\>”改为“/dev/\<port\>”  
+![](args_linux_zh_CN.png)  
+
+(4) 若使用树莓派Raspbian系统且连接成功若干秒后PM3会自动断开，则需要在“设置”面板中勾选“在PM3断开后保持客户端运行”  
+![](keep_zh_CN.png)