2019-07-13 03:16:51 +08:00
# Installing on Windows
2021-01-20 21:15:43 +08:00
< a id = "top" > < / a >
## Table of Contents
* [Installing dev-environment with ProxSpace ](#installing-dev-environment-with-proxspace )
* [Installing pre-compiled binaries with ProxSpace ](#installing-pre-compiled-binaries-with-proxspace )
* [Installing dev-environment with WSL 1 ](#installing-dev-environment-with-wsl-1 )
2019-07-13 03:16:51 +08:00
There are two ways to install, build and use Proxmark3 on Windows:
* Using Gator96100 **ProxSpace** , a package to assist in your Windows installation of MinGW
2020-08-13 17:00:58 +08:00
* Using native **WSL 1** , if you're running a Windows 10 version recent enough (FCU 1709 or later)
2019-04-08 06:38:00 +08:00
2021-01-20 21:15:43 +08:00
We have listed three ways to use these two setups (dev environment vs pre-compiled binaries)
2019-04-08 06:38:00 +08:00
---
2021-01-20 21:15:43 +08:00
## Installing dev-environment with ProxSpace
^[Top](#top)
2019-04-08 06:38:00 +08:00
2019-07-13 03:16:51 +08:00
## Video Installation guide
2021-01-20 21:15:43 +08:00
_note: this video is a bit out-of-date but still informative_
2019-07-13 03:16:51 +08:00
[![Windows Installation tutorial ](https://github.com/5w0rdfish/Proxmark3-RDV4-ParrotOS/blob/master/screenshot-www.youtube.com-2019.03.17-20-44-33.png )](https://youtu.be/zzF0NCMJnYU "Windows Installation Tutorial")
2019-04-08 06:38:00 +08:00
2021-01-20 21:32:16 +08:00
## Driver Installation ( Windows 7 )
_note: for Windows 7 you will this step. On a later Windows edition skip this._
2019-04-08 06:38:00 +08:00
2019-07-13 03:16:51 +08:00
Install required drivers for your Windows installation. You may need admin privileges to do this.
2020-09-06 20:49:09 +08:00
Step by step guides are online such as [RyscCorps ](https://store.ryscc.com/blogs/news/how-to-install-a-proxmark3-driver-on-windows-10 ).
2019-04-08 06:38:00 +08:00
2020-09-17 05:03:47 +08:00
## Download ProxSpace repo
2019-04-08 06:38:00 +08:00
2019-08-30 01:06:11 +08:00
Download the Gator96100 ProxSpace package from https://github.com/Gator96100/ProxSpace/releases
2019-04-08 06:38:00 +08:00
2019-07-13 03:16:51 +08:00
Extract 'ProxSpace' to a location path without spaces.
2020-09-17 12:32:42 +08:00
Good example
```
D:\OneDrive\Documents\GitHub
```
Bad example
```
C:\My Documents\My Projects\proxspace
^
```
2019-04-08 06:38:00 +08:00
2019-07-13 03:16:51 +08:00
If you're running Windows in a Virtualbox guest, make sure not to install ProxSpace on a vbox shared drive. (It's ok later to move the `/pm3` subfolder to a shared drive and edit the `*.bat` )
## Launch ProxSpace
2020-09-17 05:03:47 +08:00
Run `runme64.bat` .
2019-07-13 03:16:51 +08:00
You'll get a Bash prompt and your home directory should become the ProxSpace `pm3` sub-directory.
Please note you will need to use `/` in paths as you are using Bash.
## Clone the RRG/Iceman repository
2019-04-08 06:38:00 +08:00
```sh
2019-07-13 03:16:51 +08:00
cd
2019-04-08 06:38:00 +08:00
git clone https://github.com/RfidResearchGroup/proxmark3.git
2019-07-13 03:16:51 +08:00
cd proxmark3
2019-04-08 06:38:00 +08:00
```
2019-05-06 01:53:58 +08:00
2019-07-13 06:36:10 +08:00
If you're a contributing developer, you probably want to be able to use `make style` . If so, you've to install astyle:
```sh
pacman -S mingw-w64-x86_64-astyle
```
2019-07-13 03:16:51 +08:00
## Compile and use the project
2019-04-08 06:38:00 +08:00
2019-11-05 04:11:41 +08:00
To use the compiled client, the only differences are that executables end with `.exe` (e.g. `proxmark3.exe` ) and that the Proxmark3 port is one of your `comX` ports where "X" is the com port number assigned to proxmark3 under Windows, so commands like `proxmark3 /dev/ttyACMX` become `proxmark3.exe comX` .
2019-07-13 03:16:51 +08:00
2021-01-20 21:32:16 +08:00
## Done!
2019-09-10 01:55:55 +08:00
Now you're ready to follow the [compilation instructions ](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md ).
2019-07-13 03:16:51 +08:00
2021-01-20 21:32:16 +08:00
2021-01-20 21:15:43 +08:00
# Installing pre-compiled binaries with ProxSpace
^[Top](#top)
to be done (tcprst)
# Installing dev-environment with WSL 1
^[Top](#top)
2019-07-13 03:16:51 +08:00
2020-09-17 12:45:09 +08:00
WSL 1 requires to run on Windows 10 version 1709 or above. Previous windows versions didn't have support for COM ports.
2019-04-08 06:38:00 +08:00
2020-09-17 12:45:09 +08:00
### stay away from WSL 2
2020-08-13 17:00:58 +08:00
*Microsoft introduced WSL 2 starting on Windows 10 version 2004 with Hyper-V powering its virtualization; As of 2020-08-13, WSL 2 does not support USB and Serial.*
2020-09-17 12:45:09 +08:00
###
Install WSL 1 with e.g. the standard Ubuntu. You can follow the guide on [Microsoft Docs ](https://docs.microsoft.com/en-us/windows/wsl/install-win10 ) but be careful to follow WSL 1 specific instructions! When they recommend you to restart, you must restart.
2019-04-08 06:38:00 +08:00
2019-07-13 03:16:51 +08:00
For WSL configuration, see [Manage and configure Windows Subsystem for Linux ](https://docs.microsoft.com/en-us/windows/wsl/wsl-config ).
2019-09-24 17:45:38 +08:00
Make sure your WSL can launch Windows processes to get the `pm3` scripts working (cf `interop` in the WSL settings).
2019-07-13 03:16:51 +08:00
## X Server Installation
2019-07-13 06:36:10 +08:00
If you want to run the graphical components of the Proxmark3 client, you need to install a X Server such as [VcXsrv ](https://sourceforge.net/projects/vcxsrv/ ) or [Xming ](https://sourceforge.net/projects/xming/ ) and launch it, e.g. by executing XLaunch.
2019-07-13 03:16:51 +08:00
2021-01-20 21:15:43 +08:00
2020-09-17 12:45:09 +08:00
## Window terminal Installation
Microsoft has recent released a new terminal for their OS. It is much better experience than old `cmd.exe` so we strongly recommend installing it.
It is also open sourced, ref [terminal ](https://github.com/microsoft/terminal ). You can download and install from here: [windows terminal ](https://aka.ms/terminal )
2019-07-13 03:16:51 +08:00
## Dependencies
2020-09-17 12:45:09 +08:00
Enter WSL prompt (`wsl` or `start windows terminal` ) and from there, follow the [Linux Installation Instructions ](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md ) for Ubuntu, summarized here below:
2019-07-13 03:16:51 +08:00
2020-09-15 23:36:07 +08:00
Make sure your WSL guest OS is up-to-date first
2019-07-13 03:16:51 +08:00
```sh
sudo apt-get update
2020-09-15 23:36:07 +08:00
sudo apt-get upgrade -y
sudo apt-get auto-remove -y
```
Install dependencies
```sh
2019-09-02 04:51:08 +08:00
sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \
2020-06-07 23:43:39 +08:00
libreadline-dev gcc-arm-none-eabi libnewlib-dev libbz2-dev qtbase5-dev
2019-07-13 03:16:51 +08:00
```
2020-09-17 12:45:09 +08:00
_note_
2019-09-02 04:51:08 +08:00
If you don't need the graphical components of the Proxmark3 client, you can skip the installation of `qtbase5-dev` .
2019-07-13 03:16:51 +08:00
## Clone the RRG/Iceman repository
```sh
git clone https://github.com/RfidResearchGroup/proxmark3.git
```
## Compile and use the project
2019-04-08 06:38:00 +08:00
2020-09-17 12:45:09 +08:00
To use the compiled client, the only difference is that the Proxmark3 port is translated from your `comX` port where ** "X"** is the com port number assigned to proxmark3 under Windows, to a `/dev/ttySX` , so commands become:
2019-05-06 01:53:58 +08:00
2019-09-10 01:55:55 +08:00
```sh
proxmark3 /dev/ttyACM0 => proxmark3 /dev/ttySX
```
2019-05-06 01:53:58 +08:00
2020-09-17 12:45:09 +08:00
Depending on the Windows version, you might need to give permission to the current user to access `/dev/ttySX` : (change **X** to your port number)
2019-04-08 06:38:00 +08:00
```sh
2019-07-13 06:06:19 +08:00
ls -al /dev/ttySX
groups|grep dialout
2019-07-13 03:16:51 +08:00
```
2019-07-13 06:06:19 +08:00
If group ownership is `dialout` and your user is member of `dialout` group, all is fine. Else you'll have to provide access to `/dev/ttySX` : (Unfortunately the access rights of the port won't survive and will have to be fixed again next time.)
```sh
sudo chmod 666 /dev/ttySX
```
2019-07-13 03:16:51 +08:00
If you installed a X Server and compiled the Proxmark3 with QT4 support, you've to export the `DISPLAY` environment variable:
```sh
export DISPLAY=:0
```
and add it to your Bash profile for the next times:
```sh
echo "export DISPLAY=:0" >> ~/.bashrc
```
2019-07-14 23:58:47 +08:00
Note that it may take a quite long time for a freshly plugged Proxmark3 to be visible on a WSL /dev/ttySX port.
2019-09-10 01:55:55 +08:00
2021-01-20 21:32:16 +08:00
## Done!
2019-09-10 01:55:55 +08:00
Now you're ready to follow the [compilation instructions ](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md ).
2019-10-06 15:40:50 +08:00