proxmark3/doc/md/Installation_Instructions/macOS-MacPorts-Installation-Instructions.md

macOS - MacPorts automatic installation

Table of Contents

• macOS - MacPorts automatic installation
• Table of Contents
  • Main prerequisite
  • Installing latest releases
  • Build from source
• Clone the Iceman repository
  • Compile the project
    • the button trick
  • Run it

Main prerequisite

^Top

1. Have MacPorts installed. Visit https://www.macports.org/ for more information.

Installing stable releases directly

^Top

Packaging for latest releases are available on MacPorts with the port name proxmark3-iceman, with a variant for PM3GENERIC firmwares available as +pm3generic.

Installing is as simple as sudo port install proxmark3-iceman and if you want to install for PM3GENERIC, you can run sudo port install proxmark3-iceman +pm3generic instead.

Build from source

^Top

These instructions will show how to setup the environment on OSX to the point where you'll be able to clone and compile the repo by yourself, as on Linux, Windows, etc.

1. Have MacPorts installed. Visit https://www.macports.org/ for more information.

   • Since you're going to compile directly; this will require a bit more setup, you first need to set up your PATH variable (we assume your MacPorts prefix is located at its default, which is /opt/local) in your shell rc file:

     export MACPORTS_PREFIX="/opt/local"
     
     # Proxmark3 build system does not auto-detect MacPorts installations
     # (this is sort of intentional). So USE_MACPORTS has to be set first.
     export USE_MACPORTS=1
     
     # GNU coreutils is a required dependency for Proxmark3.
     # Please install it with `sudo port install coreutils`.
     export PATH="$MACPORTS_PREFIX/libexec/gnubin:$MACPORTS_PREFIX/bin:$MACPORTS_PREFIX/sbin:$PATH"
     

     For a somewhat seamless development environment, you can use these in your shell rc file:

     export C_INCLUDE_PATH="$MACPORTS_PREFIX/include:$C_INCLUDE_PATH"
     export CPLUS_INCLUDE_PATH="$MACPORTS_PREFIX/include:$CPLUS_INCLUDE_PATH"
     export LIBRARY_PATH="$MACPORTS_PREFIX/lib:$LIBRARY_PATH"
     export LDFLAGS="-L$MACPORTS_PREFIX/lib $LDFLAGS"
     export CFLAGS="-I$MACPORTS_PREFIX/include $CFLAGS"
     export CPPFLAGS="-isystem$MACPORTS_PREFIX/include -I$MACPORTS_PREFIX/include $CPPFLAGS"
     export PKG_CONFIG_PATH="$MACPORTS_PREFIX/lib/pkgconfig:$MACPORTS_PREFIX/share/pkgconfig:$PKG_CONFIG_PATH"
     

2. Install dependencies:

   sudo port install \
   	gd2 \
   	lz4 \
   	qt5 \
   	bzip2 \
   	lua54 \
   	jansson \
   	readline \
   	coreutils \
   	openssl11 \
   	pkgconfig \
   	python312 \
   	qt5-qtbase \
   	py312-pexpect \
   	py312-bitstring \
   	py312-sslcrypto \
   	py312-ansicolors \
   	arm-none-eabi-gcc \
   	arm-none-eabi-binutils
   

3. Clamp Python version for pkg-config

   MacPorts doesn't handle Python version defaults when it comes to pkg-config. So even if you have done:

   sudo port install python312 cython312
   
   sudo port select --set python python312  # this also makes calls to "python" operate on python3.12
   sudo port select --set python3 python312
   sudo port select --set cython cython312
   

   This won't set a default python3.pc (and python3-embed.pc) under the MacPorts pkgconfig includes folder.

   To fix that, you can either follow these steps:

   cd /opt/local/lib/pkgconfig
   sudo ln -svf python-3.12.pc python3.pc
   sudo ln -svf python-3.12-embed.pc python3-embed.pc
   

   Or you can use a framework definition in your shell rc file:

   export MACPORTS_FRAMEWORKS_DIR="$MACPORTS_PREFIX/Library/Frameworks"
   export PYTHON_FRAMEWORK_DIR="$MACPORTS_FRAMEWORKS_DIR/Python.framework/Versions/3.12"
   export PKG_CONFIG_PATH="$PYTHON_FRAMEWORK_DIR/lib/pkgconfig:$PKG_CONFIG_PATH"
   

4. (optional) Install makefile dependencies:

   sudo port install recode astyle
   

Clone the Iceman repository

^Top

git clone https://github.com/RfidResearchGroup/proxmark3.git
cd proxmark3

Compile the project

^Top

Now you're ready to follow the compilation instructions. From there, you can follow the original instructions. Take extra note to instructions if you don't have a Proxmark3 RDV4 device.

To flash on OS X, better to enter the bootloader mode manually, else you may experience errors.

the button trick

^Top

With your Proxmark3 unplugged from your machine, press and hold the button on your Proxmark3 as you plug it into a USB port. You can release the button, two of the four LEDs should stay on. You're in bootloader mode, ready for the next step. In case the two LEDs don't stay on when you're releasing the button, you've an old bootloader, start over and keep the button pressed during the whole flashing procedure.

Run it

^Top

To use the compiled client, you can use pm3 script, it is a wrapper of the proxmark3 client that handles automatic detection of your proxmark.

pm3

If you want to manually select serial port, remember that the Proxmark3 port is /dev/tty.usbmodemiceman1, so commands become:

proxmark3 /dev/ttyACM0  =>  proxmark3 /dev/tty.usbmodemiceman1