github/RRG-Proxmark3
1
0
Fork 0
mirror of https://github.com/RfidResearchGroup/proxmark3.git synced 2025-08-14 18:48:13 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

path notes: updates

Browse source
This commit is contained in:
Philippe Teuwen 2019-09-05 00:11:34 +02:00
commit 505eb0a3ca
1 changed files with 174 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

257
doc/path_notes.md
View file

@ -1,109 +1,178 @@
# Notes on paths.
With the recent (2019-09-01) changes and creation of _make install_ command it is still easy to get lost.
With the recent (2019-09-01) changes and creation of `make install` command it is still easy to get lost.
We are adapting the client to use searchFile when creating or calling a Proxmark3 command with a filename.
Here is where it tries to find the file and in which precedense order it takes.
If you install the Proxmark tools yourself with `make install`, they will go under the prefix `/usr/local/` but if you install the tools from your distro, there are chances the path is `/usr` so you'll have to adapth the paths presented here.
# Installed elements
## Binaries
The main Proxmark3 executables / shellscripts will be copied to
`/usr/local/bin/`
* executables: `proxmark3`, `proxmark3-flasher`
* scripts: `pm3`, `pm3-flash-all`, `pm3-flash-bootloader`, `pm3-flash-fullimage`
Some more executable / scripts will be copied to
`/usr/local/share/proxmark3/tools`
* executables: `mfkey32`, `mfkey32v2`, `mfkey64`, `nonce2key`
* scripts: `pm3_eml2lower.sh`, `pm3_eml2upper.sh`, `pm3_mfdread.py`, `pm3_mfd2eml.py`, `pm3_eml2mfd.py`, `findbits.py`, `rfidtest.pl`, `xorcheck.py`
#
```
/usr/share/proxmark3
/usr/local/share/proxmark3
```
## Firmwares
## binary paths
This is where the Proxmark3 executable / shellscripts will be copied to.
```
/usr/share/proxmark3/bin
/usr/local/share/proxmark3/bin
```
The recovery / firmware files will be copied to
This is where the tools executable / scripts will be copied to
```
/usr/share/proxmark3/tools
/usr/local/share/proxmark3/tools
```
executables: mfkey32, mfkey32v2, mfkey64, nonce2key,
scripts: pm3_eml2lower.sh, pm3_eml2upper.sh, pm3_mfdread.py, pm3_mfd2eml.py, pm3_eml2mfd.py, findbits.py, rfidtest.pl, xorcheck.py
`/usr/local/share/proxmark3/firmware`
## JTAG stuff
This is where JTAG configurations will be copied to
```
/usr/share/proxmark3/jtag_openocd
/usr/local/share/proxmark3/tools/jtag_openocd
```
* Proxmark3 firmware: `bootrom.elf`, `fullimage.elf`, `proxmark3_recovery.bin` (used for JTAG)
* SIM firmware: `sim011.bin`, `sim011.sha512.txt`
## Traces
# Traces
Proxmark3 client has a lot of sample trace files for many different low frequency tags. They will be copied to
```
/usr/share/proxmark3/traces
/usr/local/share/proxmark3/traces
```
`/usr/local/share/proxmark3/traces`
# Firmware paths
This is where the recovery / firmware files will be copied to.
bootrom.elf, fullimage.elf, proxmark3_recovery.bin (used for JTAG), sim011.bin, sim011.sha512.txt
## JTAG-related stuff
JTAG configurations and helper scripts for OpenOCD will be copied to
`/usr/local/share/proxmark3/jtag_openocd`
## Proxmark3 client files: dictionaries
Dictionaries used by the client will be copied to
```
/usr/share/proxmark3/firmware
/usr/local/share/proxmark3/firmware
/usr/local/share/proxmark3/dictionaries
```
## User given paths
```
~/.proxmark3/
./
```
## Proxmark3 client essential files
```
/resources
/dictionaries
/lualibs
/luascripts
/cmdscripts
```
## seaching for a file
First instance where a file is found will be used in the client.
1. share (install paths)
2. $HOME/.proxmark3 (user home directory
3. ./ (current working directory)
## .history / log files
We have now a rolling log file, created new per day. All those logfiles and the .history file is found
```
~/.proxmar3/history.txt
~/.proxmar3/log_%Y%m%d.txt
```
## What is where?
/resources
The needed files for commands like hardnested, fido, EMV, iClass.
/dictionaries
Here you find the default dictionaries or your own used for commands like `hf mf chk`, `hf mf fchk`, `lf t55xx chk`
Here you find the default dictionaries used for commands like `hf mf chk`, `hf mf fchk`, `lf t55xx chk`
A dictionary file is a text based file with one key per line in hexdecimal form.
The length of the key is decided by the Proxmark3 client for the different commands. All chars afterwards on line is ignored.
if key isn't a hex number, the key is igonored.
- t55xx, Mifare Ultralight/NTAG - uses 4 hexbytes (11223344)
- t55xx, Mifare Ultralight/NTAG - uses 4 hexbytes (11223344)
- Mifare classic uses 6 hexbytes (112233445566)
- iClass uses 8 hexbytes (1122334455667788)
/luascripts
Here you find existing lua scripts available, or where you put your own custom lua scripts. Look at existing scripts for ideas how to create your own scripts.
See [here](#proxmark3-client-files-and-traces) how to add your own dictionaries.
/lualibs
Here is the supporting lua libraries used for lua scripts. basically reused functions in a lua file like converting string to hex etc.
## Proxmark3 client files: cmd scripts
/cmdscripts
Here you find the proxmark3 client command line scripts. The client can run a text file containing Proxmark3 commands.
Cmd scripts used by the client will be copied to
a samplefile could be like this.
```
/usr/local/share/proxmark3/cmdscripts
```
See [here](#proxmark3-client-files-and-traces) how to add your own cmd scripts.
## Proxmark3 client files: Lua libraries and scripts
Lua libraries and scripts used by the client will be copied to
```
/usr/local/share/proxmark3/lualibs
/usr/local/share/proxmark3/luascripts
```
`lualibs` contains the supporting lua libraries used for lua scripts. Basically reused functions in a lua file like converting string to hex etc.
See [here](#proxmark3-client-files-and-traces) how to add your own Lua scripts.
## Proxmark3 client files: various resources
Various resources used by the client will be copied to
```
/usr/local/share/proxmark3/resources
```
It comprises the needed files for commands like hardnested, fido, EMV, iClass.
See [here](#proxmark3-client-files-and-traces) how to add your own resources.
## Documentation
Documentation will be copied to
`/usr/local/share/doc/proxmark3`
# User files
The client will make use of a personal directory `~/.proxmark3` (or more precisely `$HOME/.proxmark3`)
## .history / log files
We have now a rolling log file, created new per day. All these logfiles and the history file are now located at
```
~/.proxmark3/history.txt
~/.proxmark3/log_YYYYMMDD.txt
```
## Proxmark3 client files and traces
If you wants to add scripts, dictionaries or other resources, you can use the same structure as the installed directory structure and add your own files there, e.g.
```
~/.proxmark3/cmdscripts/mycmdscript.cmd
~/.proxmark3/dictionaries/mydict.dic
~/.proxmark3/luascripts/myluascript.lua
~/.proxmark3/resources/oids.json
~/.proxmark3/traces/mylftrace.pm3
```
If you add a file with the same name as the file provided with the Proxmark3 installation, it will take precedence.
See also [Scripts](#scripts) on how to write your own scripts.
# Seaching files
With the directory structure explained above, the client applies some heuristics to find its files or the files you specified in command line.
## TL;DR
It adds the expected suffix if you didn't provide it yet, then it looks (by order of precedence):
1. in the current directory, or in the path if you provided also a path, so it works with autocompletion
2. in the `~/.proxmark3` directory structure as seen above, so it works with your stuffs
3. in the repo directory structure, so it works as usual if used from the Git repo
4. in the installed directory structure, so it works when installed
## Gory details
The client is using _searchFile_ (in _client/fileutils.c_) when calling a Proxmark3 command with a filename or when the client needs to find its files.
_searchFile_ takes as argument a relative path *pm3dir*, a file to search and possibly a *suffix*.
So for example when using _searchFile_ over a filename supposed to be a dictionary file, it's called with *pm3dir=dictionaries/* and *suffix=.dic*.
When a user provides a filename (including possibly a path), _searchFile_ will search different locations and return as soon as a file is found:
* Add the suffix if the suffix is not yet present, so: *foo* -> *foo.dic* and *foo.dic* -> *foo.dic*
* If the filename is an absolute path (*/tmp/foo.dic*), take it as it is, try to access the file and return.
* If the filename is an explicit relative path (*./foo.dic*), take it as it is, try to access the file from the current directory and return.
* Try to find the filename as relative path (*foo.dic* -> *./foo.dic*), so filenames provided by CLI autocompletion work as expected.
* Try to find the filename in the *pm3dir* relative to the user directory *$HOME/.proxmark3* (*foo.dic* -> *~/.proxmark3/dictionaries/foo.dic*)
* Try to find the filename in the *pm3dir* relative to where the client binary is when in the repo configuration (*foo.dic* -> *$(path_to_dir_of_proxmark3_bin)/dictionaries/foo.dic*), so when the client is executed from a repo workdir, filenames are searched in the expected location.
* Try to find the filename in the *pm3dir* relative to where the client binary is when in the installed configuration (*foo.dic* -> *$(path_to_dir_of_proxmark3_bin)/../share/proxmark3/dictionaries/foo.dic* which resolves to e.g. */usr/share/proxmark3/dictionaries/foo.dic* or */usr/local/share/proxmark3/dictionaries/foo.dic*), so when the client is executed from a repo workdir, filenames are searched in the expected location.
# Scripts
We've seen that you can provide your own Lua or cmd scripts.
Look at existing scripts for ideas how to create your own scripts.
For cmd scripts, the command line scripts, the client can run a text file containing Proxmark3 commands.
A samplefile could be like this.
```
$> cat myscript.cmd
@ -114,7 +183,29 @@ rem done
```
You call it with:
`$> pm3 -c myscript.cmd`
The client will execute eachone of the commands in order and then exit. There are also a possibility to remain in the client afterward with the -i parameter
`pm3 -c myscript.cmd -i`
`$> pm3 -s myscript.cmd`
The client will execute each one of the commands in order and then exit. There is also a possibility to remain in the client afterwards with the -i parameter:
`$> pm3 -s myscript.cmd -i`
You can place it in `~/.proxmark3/cmdscripts/` and it will be found automatically.
You can skip the extension, so `pm3 -s myscript` works equally.
You can also use the magic of shebangs to make an executable script, e.g. taking the example above, we can write:
```
$> cat myscript.cmd
#!/usr/bin/env -S pm3 -s
hf 14a info
hf mfu info
$> chmod +x myscript.cmd
$> ./myscript.cmd
```
And it will be executed invoking the `pm3` script!
Or use `#!/usr/bin/env -S proxmark3 -s` if your script is intended to work offline.