mirror of
https://github.com/RfidResearchGroup/proxmark3.git
synced 2025-08-14 18:48:13 -07:00
reorganize doc
This commit is contained in:
Philippe Teuwen
parent
43833cc9ac
commit
4bb6b46713
23 changed files with 291 additions and 286 deletions
|
|
@ -0,0 +1,60 @@
|
|||
# Setup and build for ArchLinux
|
||||
|
||||
## Notes
|
||||
|
||||
Kali and ArchLinux users usually must kill their modem manager in order for the proxmark3 to enumerate properly.
|
||||
`sudo apt remove modemmanager`
|
||||
|
||||
## Manual Installation
|
||||
Run
|
||||
```sh
|
||||
sudo pacman -Sy base-devel p7zip libusb readline ncurses arm-none-eabi-newlib --needed
|
||||
```
|
||||
```sh
|
||||
yaourt -S termcap
|
||||
```
|
||||
|
||||
```sh
|
||||
sudo apt remove modemmanager
|
||||
```
|
||||
or
|
||||
```sh
|
||||
systemctl stop ModemManager
|
||||
systemctl disable ModemManager
|
||||
```
|
||||
|
||||
Clone fork
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
|
||||
Get the latest commits
|
||||
```sh
|
||||
git pull
|
||||
```
|
||||
|
||||
Install the blacklist rules and add user to dialout group (if you on a Linux/ubuntu/debian).
|
||||
If you do this one, you need to logout and login in again to make sure your rights got changed.
|
||||
```sh
|
||||
make udev
|
||||
```
|
||||
|
||||
Clean and complete compilation
|
||||
```sh
|
||||
make clean && make all
|
||||
```
|
||||
|
||||
Flash the BOOTROM & FULLIMAGE
|
||||
```sh
|
||||
client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
|
||||
```
|
||||
|
||||
Change into the client folder
|
||||
```sh
|
||||
cd client
|
||||
```
|
||||
|
||||
Run the client
|
||||
```sh
|
||||
./proxmark3 /dev/ttyACM0
|
||||
```
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
|
||||
## Coverity Scan Config & Run
|
||||
Download the Coverity Scan Self-buld and install it.
|
||||
You will need to configure ARM-NON-EABI- Compiler for it to use:
|
||||
|
||||
Configure
|
||||
|
||||
```sh
|
||||
cov-configure --comptype gcc --compiler /opt/devkitpro/devkitARM/bin/arm-none-eabi-gcc
|
||||
```
|
||||
|
||||
Run it (I'm running on Ubuntu)
|
||||
|
||||
```sh
|
||||
cov-build --dir cov-int make all
|
||||
```
|
||||
|
||||
Make a tarball
|
||||
|
||||
```sh
|
||||
tar czvf proxmark3.tgz cov-int
|
||||
```
|
||||
|
||||
Upload it to scan.coverity.com
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
# Kali Installation
|
||||
Kali users usually must kill their modem manager in order for the proxmark3 to enumerate properly.
|
||||
```sh
|
||||
sudo apt remove modemmanager
|
||||
```
|
||||
|
||||
# Video Installation guide
|
||||
[](https://youtu.be/t5eBPS6lV3E "Kali Linux Installation Tutorial")
|
||||
|
||||
|
||||
---
|
||||
## Manual Install
|
||||
First what we want to do is get an update for the system. If you need to upgrade do this **before** the install
|
||||
An upgrade was carried out prior to following these instructions.
|
||||
|
||||
### Update
|
||||
```sh
|
||||
sudo apt-get update
|
||||
```
|
||||
### Requirements.
|
||||
|
||||
```sh
|
||||
sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev \
|
||||
libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev gcc-arm-none-eabi
|
||||
```
|
||||
If you do get any issues during the requirements installation, I have found it to help using the synaptic package manager.
|
||||
|
||||
### Clone Fork
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
|
||||
### Change directory into the directory created
|
||||
```sh
|
||||
cd proxmark3
|
||||
```
|
||||
|
||||
### Get the latest commits
|
||||
```sh
|
||||
git pull
|
||||
```
|
||||
|
||||
### Remove Modem Manager
|
||||
```sh
|
||||
sudo apt remove modemmanager
|
||||
```
|
||||
### Reboot Kali
|
||||
```sh
|
||||
reboot
|
||||
```
|
||||
|
||||
### Change directory back to proxmark3
|
||||
```sh
|
||||
cd proxmark3
|
||||
```
|
||||
|
||||
### Clean and Compile
|
||||
Clean and complete compile
|
||||
|
||||
```sh
|
||||
make clean && make all
|
||||
```
|
||||
### Check Connection
|
||||
Once this is complete run the following comands to make sure the proxmark is being picked up by your computer.
|
||||
|
||||
```sh
|
||||
sudo dmesg | grep -i usb
|
||||
```
|
||||
It should show up as a CDC device:
|
||||
```sh
|
||||
[10416.555108] usb 2-1.2: Product: PM3
|
||||
[10416.555111] usb 2-1.2: Manufacturer: proxmark.org
|
||||
[10416.555871] cdc_acm 2-1.2:1.0: ttyACM0: USB ACM device
|
||||
```
|
||||
|
||||
### Flash the BOOTROM & FULLIMAGE
|
||||
```sh
|
||||
client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
|
||||
```
|
||||
> **Note** If you have any issues connecting or during the flash, follow the steps listed [here](https://github.com/RfidResearchGroup/proxmark3/issues/35) and use the command sudo apt remove modemmanager
|
||||
|
||||
|
||||
### Change into the client folder
|
||||
|
||||
```sh
|
||||
cd client
|
||||
```
|
||||
|
||||
### Run the client
|
||||
```sh
|
||||
./proxmark3 /dev/ttyACM0
|
||||
```
|
||||
|
||||
### Run a test command
|
||||
```sh
|
||||
hw tune
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
## Homebrew (Mac OS X)
|
||||
These instructions comes from @Chrisfu, where I got the proxmark3.rb scriptfile from.
|
||||
Further questions about Mac & Homebrew, contact @Chrisfu (https://github.com/chrisfu/)
|
||||
|
||||
1. Install homebrew if you haven't yet already done so: http://brew.sh/
|
||||
|
||||
2. Tap this repo: `brew tap RfidResearchGroup/proxmark3`
|
||||
|
||||
3. Install Proxmark3: `brew install proxmark3` for stable release or `brew install --HEAD proxmark3` for latest non-stable from GitHub.
|
||||
|
||||
Upgrading HomeBrew tap formula
|
||||
-----------------------------
|
||||
*This method is useful for those looking to run bleeding-edge versions of iceman's client. Keep this in mind when attempting to update your HomeBrew tap formula as this procedure could easily cause a build to break if an update is unstable on macOS.*
|
||||
|
||||
Tested on macOS High Sierra 10.13.2
|
||||
|
||||
*Note: This assumes you have already installed iceman's fork from HomeBrew as mentioned above*
|
||||
|
||||
1. Force HomeBrew to pull the latest source from github
|
||||
`brew upgrade --fetch-HEAD RfidResearchGroup/proxmark3`
|
||||
|
||||
2. Flash the bootloader & fullimage.elf
|
||||
* With your Proxmark3 unplugged from your machine, press and hold the button on your Proxmark 3 as you plug it into a USB port. Continue to hold the button until after this step is complete and the `proxmark3-flasher` command outputs "Have a nice day!"*
|
||||
`$ sudo proxmark3-flasher /dev/tty.usbmodem881 -b /usr/local/Cellar/proxmark3/HEAD-6a710ef/share/firmware/bootrom.elf /usr/local/Cellar/proxmark3/HEAD-6a710ef/share/firmware/fullimage.elf`
|
||||
|
||||
|
||||
`$ sudo proxmark3-flasher /dev/tty.usbmodem881 `
|
||||
|
||||
4. Enjoy the update
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
|
||||
# Parrot OS Installation
|
||||
|
||||
## Notes
|
||||
|
||||
Some further notes can be found at @5w0rdfish repo [Proxmark Installation for Parrot OS](https://github.com/5w0rdfish/Proxmark3-RDV4-ParrotOS)
|
||||
|
||||
# Video Installation guide
|
||||
[](https://youtu.be/Wl9AsrU4igo "ParrotOS Installation Tutorial")
|
||||
|
||||
|
||||
---
|
||||
## Manual Install
|
||||
First what we want to do is get an update for the system. If you need to upgrade do this **before** the install
|
||||
|
||||
### Update
|
||||
```sh
|
||||
sudo apt-get update
|
||||
```
|
||||
### Requirements.
|
||||
|
||||
```sh
|
||||
sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev \
|
||||
libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev gcc-arm-none-eabi
|
||||
```
|
||||
If you do get any issues during the requirements installation, I have found it to help using the synaptic package manager.
|
||||
|
||||
### Clone Fork
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
|
||||
### Change directory into the directory created
|
||||
```sh
|
||||
cd proxmark3
|
||||
```
|
||||
|
||||
### Get the latest commits
|
||||
```sh
|
||||
git pull
|
||||
```
|
||||
|
||||
### Make Udev
|
||||
Iceman has made the udev script which takes care of the blacklist rules. This should take care of the remove modem manager.
|
||||
The make udev command also create's an alias for the pm3 under /dev which you will use to connect to the proxmark.
|
||||
|
||||
```sh
|
||||
sudo make udev
|
||||
```
|
||||
|
||||
> **Note** If you have any issues connecting or during the flash, follow the steps listed [here](https://github.com/RfidResearchGroup/proxmark3/issues/35) and use the command sudo apt remove modemmanager
|
||||
|
||||
Log out and log back in again. And now we are all set to take the next step.
|
||||
|
||||
### Clean and Compile
|
||||
Clean and complete compilation *within the proxmark3 folder*
|
||||
|
||||
```sh
|
||||
make clean && make all
|
||||
```
|
||||
### Check Connection
|
||||
Once this is complete run the following comands to make sure the proxmark is being picked up by your computer.
|
||||
|
||||
```sh
|
||||
sudo dmesg | grep -i usb
|
||||
```
|
||||
It should show up as a CDC device:
|
||||
```sh
|
||||
[10416.555108] usb 2-1.2: Product: PM3
|
||||
[10416.555111] usb 2-1.2: Manufacturer: proxmark.org
|
||||
[10416.555871] cdc_acm 2-1.2:1.0: ttyACM0: USB ACM device
|
||||
```
|
||||
|
||||
### Flash the BOOTROM & FULLIMAGE
|
||||
```sh
|
||||
client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
|
||||
```
|
||||
### Change into the client folder
|
||||
|
||||
```sh
|
||||
cd client
|
||||
```
|
||||
### Run the client
|
||||
``` sh
|
||||
./proxmark3 /dev/pm #press tab on the keyboard for it to detect the proxmark
|
||||
```
|
||||
or
|
||||
|
||||
### Run the client
|
||||
```sh
|
||||
./proxmark3 /dev/ttyACM0
|
||||
```
|
||||
|
||||
### Run a test command
|
||||
```sh
|
||||
hw tune
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
# Setup and build for UBUNTU
|
||||
## Notes
|
||||
GC made updates to allow this to build easily on Ubuntu 14.04.2 LTS, 15.10 or 16.04
|
||||
See the [Proxmark3 Ubuntu wiki page](https://github.com/Proxmark/proxmark3/wiki/Ubuntu%20Linux)
|
||||
|
||||
A nice and cool install script made by @daveio is found here:
|
||||
https://github.com/daveio/attacksurface/blob/master/proxmark3/pm3-setup.sh
|
||||
|
||||
Iceman has also added this script to the fork.
|
||||
https://github.com/RfidResearchGroup/proxmark3/blob/master/install.sh
|
||||
|
||||
# Video Installation guide
|
||||
[](https://youtu.be/DThmkH8CdMo "Ubuntu Installation Tutorial")
|
||||
|
||||
---
|
||||
## Manual Installation
|
||||
### Update
|
||||
|
||||
```sh
|
||||
sudo apt-get update
|
||||
```
|
||||
### Requirements
|
||||
|
||||
```sh
|
||||
sudo apt-get install p7zip git build-essential libreadline5 libreadline-dev libusb-0.1-4 libusb-dev libqt4-dev perl pkg-config wget libncurses5-dev gcc-arm-none-eabi
|
||||
```
|
||||
|
||||
### Clone Fork
|
||||
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
### Change Directory
|
||||
|
||||
```sh
|
||||
cd proxmark3
|
||||
```
|
||||
|
||||
### Get the latest commits
|
||||
|
||||
```sh
|
||||
git pull
|
||||
```
|
||||
|
||||
### Install the blacklist rules and add user to dialout group.
|
||||
|
||||
```sh
|
||||
sudo make udev
|
||||
```
|
||||
|
||||
### Restart
|
||||
Restart Ubuntu
|
||||
|
||||
### Enter proxmark folder
|
||||
```sh
|
||||
cd proxmark3
|
||||
```
|
||||
### Clean and Compile
|
||||
```sh
|
||||
make clean && make all
|
||||
```
|
||||
### Check Connection
|
||||
Once this is complete run the following comands to make sure the proxmark is being picked up by your computer.
|
||||
|
||||
```sh
|
||||
sudo dmesg | grep -i usb
|
||||
```
|
||||
|
||||
### Flash the BOOTROM & FULLIMAGE
|
||||
```sh
|
||||
client/flasher /dev/ttyACM0 -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
|
||||
```
|
||||
|
||||
### Issues
|
||||
If you have issues with the install please try the following below or head on over to the proxmark forum.
|
||||
#### Remove Modem Manager
|
||||
|
||||
```sh
|
||||
sudo apt remove modemmanager
|
||||
```
|
||||
and then restart ubuntu.
|
||||
|
||||
### Change into the client folder
|
||||
```sh
|
||||
cd client
|
||||
```
|
||||
|
||||
### Run the client
|
||||
``` sh
|
||||
./proxmark3 /dev/pm #press tab on the keyboard for it to detect the proxmark
|
||||
```
|
||||
or
|
||||
|
||||
### Run the client
|
||||
```sh
|
||||
./proxmark3 /dev/ttyACM0
|
||||
```
|
||||
|
||||
### Run a test command
|
||||
```sh
|
||||
hw tune
|
||||
```
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
# Building on Windows
|
||||
You will need to use the Gator96100 Proxspace package to assist in your windows installation.
|
||||
This can be downloaded from https://github.com/Gator96100/ProxSpace/
|
||||
|
||||
## Notes
|
||||
If you receive gcc errors using v3.1 during build, download and use v2.2. This may help resolve the issue.
|
||||
|
||||
- https://github.com/Gator96100/ProxSpace/releases/tag/v3.1 (release v3.1 with gcc v7.3.0 )
|
||||
- https://github.com/Gator96100/ProxSpace/releases/tag/v2.2 (release v2.2 with gcc v5.3.0 arm-none-eabi-gcc v7.1.0)
|
||||
|
||||
---
|
||||
# Video Installation guide
|
||||
[](https://youtu.be/zzF0NCMJnYU "Windows Installation Tutorial")
|
||||
|
||||
## Manual Installation
|
||||
|
||||
### Driver Installation
|
||||
|
||||
Install required drivers for your windows installation. You will may need admin privileges to do this.
|
||||
(This is covered in the video) Step by step guides are online such as [RiscCorps](https://store.ryscc.com/blogs/news/how-to-install-a-proxmark3-driver-on-windows-10)
|
||||
|
||||
### Install Github
|
||||
|
||||
Install Github for Windows https://desktop.github.com/
|
||||
|
||||
### Download / clone Proxspace repo
|
||||
|
||||
Download the required proxspace repo. https://github.com/Gator96100/ProxSpace/
|
||||
|
||||
Extract 'ProxSpace' to a location on drive without spaces.
|
||||
For example D:\OneDrive\Documents\GitHub is ok whereas C:\My Documents\My Projects\proxspace is not.
|
||||
|
||||
### Clone RFID RESEARCH GROUP files
|
||||
|
||||
Clone fork
|
||||
```sh
|
||||
git clone https://github.com/RfidResearchGroup/proxmark3.git
|
||||
```
|
||||
### Copy files to Proxspace
|
||||
|
||||
Copy all the contents from the proxmark3 folder into the proxspace pm3 folder
|
||||
|
||||
### Run the .bat
|
||||
|
||||
Run runme.bat or runme64.bat depending on your Windows architecture.
|
||||
|
||||
Please note you will need to use / as you are using BASH.
|
||||
|
||||
### Make
|
||||
|
||||
CLEAN COMPILE inside the pm3 window.
|
||||
```sh
|
||||
make clean && make all
|
||||
```
|
||||
### Flash the image
|
||||
|
||||
Flash the BOOTROM & FULLIMAGE
|
||||
```sh
|
||||
client/flasher.exe comX -b bootrom/obj/bootrom.elf armsrc/obj/fullimage.elf
|
||||
```
|
||||
|
||||
### Run the client
|
||||
|
||||
Assuming you have Proxmark3 Windows drivers installed you can run the Proxmark software where "X" is the com port number assigned to proxmark3 under Windows.
|
||||
|
||||
Change into the client folder
|
||||
```sh
|
||||
cd client
|
||||
```
|
||||
|
||||
Run the client
|
||||
```sh
|
||||
./proxmark3.exe comX
|
||||
```
|
||||
|
||||
### Test
|
||||
|
||||
Check your firmware revision on the Proxmark III with
|
||||
```sh
|
||||
hw ver
|
||||
```
|
||||
For basic help type help. Or for help on a set of sub commands type the command followed by help. For example hf mf help.
|
||||
Make sure you head over to the use of [proxmark area](https://github.com/5w0rdfish/proxmark3/tree/master/Use_of_Proxmark) to help you get on your way!
|
||||
57
doc/md/Use_of_Proxmark/1_Validation.md
Normal file
57
doc/md/Use_of_Proxmark/1_Validation.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
## 1. Validating proxmark client functionality
|
||||
|
||||
If all went well you should get some information about the firmware and memory usage as well as the prompt, something like this.
|
||||
We should be able to answer ..can I connect to my proxmark device? does it respond?
|
||||
|
||||
>[=] UART Setting serial baudrate 460800
|
||||
>
|
||||
>Proxmark3 RFID instrument
|
||||
>
|
||||
> [ CLIENT ]
|
||||
>
|
||||
> client: iceman build for RDV40 with flashmem; smartcard;
|
||||
>
|
||||
> [ ARM ]
|
||||
>
|
||||
> bootrom: iceman/master/4517531c-dirty-unclean 2018-12-13 15:42:24
|
||||
>
|
||||
> os: iceman/master/5a34550a-dirty-unclean 2019-01-07 23:04:07
|
||||
>
|
||||
> [ FPGA ]
|
||||
>
|
||||
> LF image built for 2s30vq100 on 2018/ 9/ 8 at 13:57:51
|
||||
>
|
||||
> HF image built for 2s30vq100 on 2018/ 9/ 3 at 21:40:23
|
||||
>
|
||||
> [ Hardware ]
|
||||
>
|
||||
>--= uC: AT91SAM7S512 Rev B
|
||||
>
|
||||
>--= Embedded Processor: ARM7TDMI
|
||||
>
|
||||
>--= Nonvolatile Program Memory Size: 512K bytes, Used: 247065 bytes (47%) Free: 277223 bytes (53%)
|
||||
>
|
||||
>--= Second Nonvolatile Program Memory Size: None
|
||||
>
|
||||
>--= Internal SRAM Size: 64K bytes
|
||||
>
|
||||
>--= Architecture Identifier: AT91SAM7Sxx Series
|
||||
>
|
||||
>--= Nonvolatile Program Memory Type: Embedded Flash Memory
|
||||
>
|
||||
> pm3 -->
|
||||
|
||||
### Run the following commands
|
||||
pm3 --> hw status
|
||||
pm3 --> hw version
|
||||
pm3 --> hw tune
|
||||
|
||||
You are now ready to use your newly upgraded proxmark3 device. Many commands uses the **h** parameter to show a help text. The client uses a arcaic command structure which will be hard to grasp at first. Here are some commands to start off with.
|
||||
|
||||
pm3 --> hf
|
||||
pm3 --> hf 14a info
|
||||
pm3 --> lf
|
||||
pm3 --> lf search
|
||||
|
||||
### Quit client
|
||||
pm3 --> quit
|
||||
38
doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md
Normal file
38
doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
### First things on your RDV40
|
||||
You will need to run these commands to make sure your rdv4 is prepared
|
||||
|
||||
pm3 --> mem load f default_keys m
|
||||
pm3 --> mem load f default_pwd t
|
||||
pm3 --> mem load f default_iclass_keys i
|
||||
pm3 --> lf t55xx deviceconfig a 29 b 17 c 15 d 47 e 15 p
|
||||
|
||||
### Verify sim module firmware version
|
||||
To make sure you got the latest sim module firmware.
|
||||
_Lastest version is v3.11_
|
||||
|
||||
pm3 --> hw status
|
||||
|
||||
Find version in the long output, look for these two lines
|
||||
|
||||
#db# Smart card module (ISO 7816)
|
||||
#db# version.................v2.06
|
||||
|
||||
This version is obselete. The following command upgrades your device sim module firmware.
|
||||
Don't not turn of your device during the execution of this command.
|
||||
|
||||
pm3 --> sc upgrade f ../tools/simmodule/SIM011.BIN
|
||||
|
||||
You get the following output, this is a successful execution.
|
||||
|
||||
[!] WARNING - Smartcard socket firmware upgrade.
|
||||
[!] A dangerous command, do wrong and you will brick the smart card socket
|
||||
[+] Smartcard socket firmware uploading to PM3
|
||||
..
|
||||
[+] Smartcard socket firmware updating, don't turn off your PM3!
|
||||
#db# FW 0000
|
||||
#db# FW 0080
|
||||
#db# FW 0100
|
||||
#db# FW 0180
|
||||
#db# FW 0200
|
||||
#db# FW 0280
|
||||
[+] Smartcard socket firmware upgraded successful
|
||||
21
doc/md/Use_of_Proxmark/3_Commands-and-Features.md
Normal file
21
doc/md/Use_of_Proxmark/3_Commands-and-Features.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
|
||||
# Commands and Features
|
||||
|
||||
## New Features in RDV4
|
||||
|
||||
Further details coming soon
|
||||
|
||||
### Run the following commands
|
||||
pm3 --> hw status
|
||||
pm3 --> hw version
|
||||
pm3 --> hw tune
|
||||
|
||||
You are now ready to use your newly upgraded proxmark3 device. Many commands uses the **h** parameter to show a help text. The client uses a arcaic command structure which will be hard to grasp at first. Here are some commands to start off with.
|
||||
|
||||
pm3 --> hf
|
||||
pm3 --> hf 14a info
|
||||
pm3 --> lf
|
||||
pm3 --> lf search
|
||||
|
||||
### Quit client
|
||||
pm3 --> quit
|
||||
Loading…
Add table
Add a link
Reference in a new issue