Update id48lib

* Add its own CMakeLists.txt
* Add id48 unit tests for its recovery API
* Add id48 unit tests for its generator API
* Add id48 espresso files, generator for those files, and validation test

* Proxmark3-specific:
  * update client/Makefile
  * update client/deps/id48lib.cmake
  *

Author: henrygab

.gitignore

@@ -45,13 +45,15 @@ Makefile.platform.*
 
 # cmake
 CMakeFiles/
-deps/
 client/CMakeFiles/
-client/deps/
+client/deps/**
+!client/deps/id48/
+!client/deps/id48/**
 client/build/
 client/android/build/
 CMakeCache.txt
 *.cmake
+.cache
 
 # Coverity
 cov-int/

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 This project uses the changelog in accordance with [keepchangelog](http://keepachangelog.com/). Please use this to write notable changes, which is not the same as git commit log...
 
 ## [unreleased][unreleased]
+- Updated id48lib (adds unit tests, better build management)
 - Added two trace files for Ultralight AES (@iceman1001)
 - Added support for Ultralight AES secure messaing in `hf 14a raw` (@iceman1001)
 - Added support for Ultralight AES secure messaging in `hf mfu info/rdbl/wrbl/dump/ndefread/wipe/setkey` (@iceman1001)

Makefile.host

@@ -26,6 +26,9 @@ endif
 ifeq ($(DEFSBEENHERE),)
     -include ../../../Makefile.defs
 endif
+ifeq ($(DEFSBEENHERE),)
+    -include ../../../../Makefile.defs
+endif
 ifeq ($(DEFSBEENHERE),)
     $(error Can't find Makefile.defs)
 endif

client/Makefile

@@ -74,8 +74,9 @@ HARDNESTEDLIB = $(HARDNESTEDLIBPATH)/libhardnested.a
 HARDNESTEDLIBLD =
 
 ## ID48
-ID48LIBPATH = ./deps/id48
-ID48LIBINC = -I$(ID48LIBPATH)
+## must be manually kept in sync with updates to deps/id48/CMakeLists.txt
+ID48LIBPATH = ./deps/id48/src
+ID48LIBINC = -I$(ID48LIBPATH)/../public
 ID48LIB = $(ID48LIBPATH)/libid48.a
 ID48LIBLD =
 

client/deps/id48/.gitignore

@@ -0,0 +1,52 @@
+# Now ignore any "build" directory anywhere under this directory
+build/
+**/build/
+
+*.log
+*.eml
+*.html
+*.o
+*.a
+*.d
+*.elf
+*.s19
+*.map
+*.bin
+*.dll
+*.moc.cpp
+*.z
+*.gz
+*.Td
+*.DS_Store
+*.exe
+*.dsym
+*.json
+*.old
+*.swp
+*.json.bak
+*.pyc
+*.bmp
+
+
+# cmake
+CMakeFiles/
+client/CMakeFiles/
+client/deps/**
+!client/deps/id48/
+!client/deps/id48/**
+client/build/
+client/android/build/
+CMakeCache.txt
+*.cmake
+.cache
+
+# Coverity
+cov-int/
+.coverity.conf
+
+# .tmp files are created during compilation
+*.tmp
+
+# local codeql
+_codeql*
+/codeql

client/deps/id48/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.21)
+
+project(id48_project LANGUAGES C CXX ASM)
+
+# Project-wide language standards (subdirectories inherit if not overridden)
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+add_subdirectory(src)
+add_subdirectory(tests)
+

client/deps/id48/README.md

@@ -48,3 +48,25 @@ provided the first half of the key, and at least one successful
 authentication trio of nonce, challenge, and response, then
 the library can recover all potentially valid values for the
 second half of the key.
+
+## Building
+
+This project uses CMake, and thus should be easy to integrate
+into any existing project using CMake.
+
+The following commands can be run from the root of this depot,
+and places all build artifacts into `./build`:
+
+```bash
+# Configure cmake for the current environment
+# -S: explicitly specify the source directory
+# -B: explicitly specify the directory for build artifacts
+cmake -S . -B build
+
+# Optionally (recommended) do a clean build each time
+cmake --build ./build --parallel --target clean
+
+# build everything
+cmake --build ./build --parallel --target all
+```
+

client/deps/id48/TECHNICAL.md

@@ -160,63 +160,63 @@ of the key influences a given output bit.
 Start state + key bit --> output
 
 
-| Start state | Key bit | Output |
-|-------|-------|----------------|
-| `s₀₀` | `K₃₉` | << hidden >>   |
-| `s₀₁` | `K₃₈` | << hidden >>   |
-| `s₀₂` | `K₃₇` | << hidden >>   |
-| `s₀₃` | `K₃₆` | << hidden >>   |
-| `s₀₄` | `K₃₅` | << hidden >>   |
-| `s₀₅` | `K₃₄` | << hidden >>   |
-| `s₀₆` | `K₃₃` | << hidden >>   |
-| `s₀₇` | `K₃₂` | `O₀₀ == frn₀₀` |
-| `s₀₈` | `K₃₁` | `O₀₁ == frn₀₁` |
-| `s₀₉` | `K₃₀` | `O₀₂ == frn₀₂` |
-| `s₁₀` | `K₂₉` | `O₀₃ == frn₀₃` |
-| `s₁₁` | `K₂₈` | `O₀₄ == frn₀₄` |
-| `s₁₂` | `K₂₇` | `O₀₅ == frn₀₅` |
-| `s₁₃` | `K₂₆` | `O₀₆ == frn₀₆` |
-| `s₁₄` | `K₂₅` | `O₀₇ == frn₀₇` |
-| `s₁₅` | `K₂₄` | `O₀₈ == frn₀₈` |
-| `s₁₆` | `K₂₃` | `O₀₉ == frn₀₉` |
-| `s₁₇` | `K₂₂` | `O₁₀ == frn₁₀` |
-| `s₁₈` | `K₂₁` | `O₁₁ == frn₁₁` |
-| `s₁₉` | `K₂₀` | `O₁₂ == frn₁₂` |
-| `s₂₀` | `K₁₉` | `O₁₃ == frn₁₃` |
-| `s₂₁` | `K₁₈` | `O₁₄ == frn₁₄` |
-| `s₂₂` | `K₁₇` | `O₁₅ == frn₁₅` |
-| `s₂₃` | `K₁₆` | `O₁₆ == frn₁₆` |
-| `s₂₄` | `K₁₅` | `O₁₇ == frn₁₇` |
-| `s₂₅` | `K₁₄` | `O₁₈ == frn₁₈` |
-| `s₂₆` | `K₁₃` | `O₁₉ == frn₁₉` |
-| `s₂₇` | `K₁₂` | `O₂₀ == frn₂₀` |
-| `s₂₈` | `K₁₁` | `O₂₁ == frn₂₁` |
-| `s₂₉` | `K₁₀` | `O₂₂ == frn₂₂` |
-| `s₃₀` | `K₀₉` | `O₂₃ == frn₂₃` |
-| `s₃₁` | `K₀₈` | `O₂₄ == frn₂₄` |
-| `s₃₂` | `K₀₇` | `O₂₅ == frn₂₅` |
-| `s₃₃` | `K₀₆` | `O₂₆ == frn₂₆` |
-| `s₃₄` | `K₀₅` | `O₂₇ == frn₂₇` |
-| `s₃₅` | `K₀₄` | `O₂₈ == grn₀₀` |
-| `s₃₆` | `K₀₃` | `O₂₉ == grn₀₁` |
-| `s₃₇` | `K₀₂` | `O₃₀ == grn₀₂` |
-| `s₃₈` | `K₀₁` | `O₃₁ == grn₀₃` |
-| `s₃₉` | `K₀₀` | `O₃₂ == grn₀₄` |
-| `s₄₀` | `0₁₄` | `O₃₃ == grn₀₅` |
-| `s₄₁` | `0₁₃` | `O₃₄ == grn₀₆` |
-| `s₄₂` | `0₁₂` | `O₃₅ == grn₀₇` |
-| `s₄₃` | `0₁₁` | `O₃₆ == grn₀₈` |
-| `s₄₄` | `0₁₀` | `O₃₇ == grn₀₉` |
-| `s₄₅` | `0₀₉` | `O₃₈ == grn₁₀` |
-| `s₄₆` | `0₀₈` | `O₃₉ == grn₁₁` |
-| `s₄₇` | `0₀₇` | `O₄₀ == grn₁₂` |
-| `s₄₈` | `0₀₆` | `O₄₁ == grn₁₃` |
-| `s₄₉` | `0₀₅` | `O₄₂ == grn₁₄` |
-| `s₅₀` | `0₀₄` | `O₄₃ == grn₁₅` |
-| `s₅₁` | `0₀₃` | `O₄₄ == grn₁₆` |
-| `s₅₂` | `0₀₂` | `O₄₅ == grn₁₇` |
-| `s₅₃` | `0₀₁` | `O₄₆ == grn₁₈` |
-| `s₅₄` | `0₀₀` | `O₄₇ == grn₁₉` |
+| Start state | Key bit | Output | Notes |
+|-------|-------|----------------|-------|
+| `s₀₀` | `K₃₉` | << hidden >>   | Seven ...          |
+| `s₀₁` | `K₃₈` | << hidden >>   | .. iterations ...  |
+| `s₀₂` | `K₃₇` | << hidden >>   | .. before ...      |
+| `s₀₃` | `K₃₆` | << hidden >>   | .. any ...         |
+| `s₀₄` | `K₃₅` | << hidden >>   | .. output ...      |
+| `s₀₅` | `K₃₄` | << hidden >>   | .. bits ...        |
+| `s₀₆` | `K₃₃` | << hidden >>   | .. seen.           |
+| `s₀₇` | `K₃₂` | `O₀₀ == frn₀₀` |           |
+| `s₀₈` | `K₃₁` | `O₀₁ == frn₀₁` |           |
+| `s₀₉` | `K₃₀` | `O₀₂ == frn₀₂` |           |
+| `s₁₀` | `K₂₉` | `O₀₃ == frn₀₃` |           |
+| `s₁₁` | `K₂₈` | `O₀₄ == frn₀₄` |           |
+| `s₁₂` | `K₂₇` | `O₀₅ == frn₀₅` |           |
+| `s₁₃` | `K₂₆` | `O₀₆ == frn₀₆` |           |
+| `s₁₄` | `K₂₅` | `O₀₇ == frn₀₇` |           |
+| `s₁₅` | `K₂₄` | `O₀₈ == frn₀₈` |           |
+| `s₁₆` | `K₂₃` | `O₀₉ == frn₀₉` |           |
+| `s₁₇` | `K₂₂` | `O₁₀ == frn₁₀` |           |
+| `s₁₈` | `K₂₁` | `O₁₁ == frn₁₁` |           |
+| `s₁₉` | `K₂₀` | `O₁₂ == frn₁₂` |           |
+| `s₂₀` | `K₁₉` | `O₁₃ == frn₁₃` |           |
+| `s₂₁` | `K₁₈` | `O₁₄ == frn₁₄` |           |
+| `s₂₂` | `K₁₇` | `O₁₅ == frn₁₅` |           |
+| `s₂₃` | `K₁₆` | `O₁₆ == frn₁₆` |           |
+| `s₂₄` | `K₁₅` | `O₁₇ == frn₁₇` |           |
+| `s₂₅` | `K₁₄` | `O₁₈ == frn₁₈` |           |
+| `s₂₆` | `K₁₃` | `O₁₉ == frn₁₉` |           |
+| `s₂₇` | `K₁₂` | `O₂₀ == frn₂₀` |           |
+| `s₂₈` | `K₁₁` | `O₂₁ == frn₂₁` |           |
+| `s₂₉` | `K₁₀` | `O₂₂ == frn₂₂` |           |
+| `s₃₀` | `K₀₉` | `O₂₃ == frn₂₃` |           |
+| `s₃₁` | `K₀₈` | `O₂₄ == frn₂₄` |           |
+| `s₃₂` | `K₀₇` | `O₂₅ == frn₂₅` |           |
+| `s₃₃` | `K₀₆` | `O₂₆ == frn₂₆` |           |
+| `s₃₄` | `K₀₅` | `O₂₇ == frn₂₇` | Last key bit that affects `frn`  |
+| `s₃₅` | `K₀₄` | `O₂₈ == grn₀₀` | Five bits of key affect `grn` |
+| `s₃₆` | `K₀₃` | `O₂₉ == grn₀₁` |                               |
+| `s₃₇` | `K₀₂` | `O₃₀ == grn₀₂` |                               |
+| `s₃₈` | `K₀₁` | `O₃₁ == grn₀₃` |                               |
+| `s₃₉` | `K₀₀` | `O₃₂ == grn₀₄` |                               |
+| `s₄₀` | `0₁₄` | `O₃₃ == grn₀₅` | Zero-fill start |
+| `s₄₁` | `0₁₃` | `O₃₄ == grn₀₆` |                 |
+| `s₄₂` | `0₁₂` | `O₃₅ == grn₀₇` |           |
+| `s₄₃` | `0₁₁` | `O₃₆ == grn₀₈` |           |
+| `s₄₄` | `0₁₀` | `O₃₇ == grn₀₉` |           |
+| `s₄₅` | `0₀₉` | `O₃₈ == grn₁₀` |           |
+| `s₄₆` | `0₀₈` | `O₃₉ == grn₁₁` |           |
+| `s₄₇` | `0₀₇` | `O₄₀ == grn₁₂` |           |
+| `s₄₈` | `0₀₆` | `O₄₁ == grn₁₃` |           |
+| `s₄₉` | `0₀₅` | `O₄₂ == grn₁₄` |           |
+| `s₅₀` | `0₀₄` | `O₄₃ == grn₁₅` |           |
+| `s₅₁` | `0₀₃` | `O₄₄ == grn₁₆` |           |
+| `s₅₂` | `0₀₂` | `O₄₅ == grn₁₇` |           |
+| `s₅₃` | `0₀₁` | `O₄₆ == grn₁₈` |           |
+| `s₅₄` | `0₀₀` | `O₄₇ == grn₁₉` |           |
 
 
 
@@ -525,7 +525,7 @@ FPGA logic if desired.
 
 There are sixteen (`16x`) blocks of memory, each storing a 16-bit value.
 Blocks may be protected (`P` column) as read-only (`RO`) or write-only (`WO`).
-`Lock₀` === Disable writingPermanent write-prevention when set to 1.
+`Lock₀` === Disable writing ... (?) write-prevention when set to 1.
 `Lock₁` === Pin-code lock
 
 | `Block` | `P`  | `Purpose`    | Bits (LSB first)           | Bits (MSB first)            |

client/deps/id48/espresso/output_g1.pla

@@ -0,0 +1,46 @@
+# ###################
+# Generating .PLA
+# ###################
+
+
+.i 5
+.o 1
+.ilb a l2 l3 l0 l6
+.ob g1
+00000  1
+00001  1
+00010  1
+00011  1
+00100  0
+00101  0
+00110  1
+00111  0
+01000  0
+01001  1
+01010  0
+01011  0
+01100  1
+01101  0
+01110  0
+01111  1
+10000  1
+10001  0
+10010  0
+10011  0
+10100  0
+10101  1
+10110  0
+10111  1
+11000  0
+11001  0
+11010  1
+11011  1
+11100  1
+11101  1
+11110  1
+11111  0
+.e
+
+# ###################
+# END OF .PLA
+# ###################

client/deps/id48/espresso/output_g2.pla

@@ -0,0 +1,46 @@
+# ###################
+# Generating .PLA
+# ###################
+
+
+.i 5
+.o 1
+.ilb l5 b m0 l4 m1
+.ob g2
+00000  1
+00001  1
+00010  1
+00011  1
+00100  0
+00101  0
+00110  0
+00111  1
+01000  0
+01001  1
+01010  0
+01011  0
+01100  1
+01101  0
+01110  1
+01111  0
+10000  1
+10001  0
+10010  0
+10011  0
+10100  0
+10101  1
+10110  1
+10111  0
+11000  0
+11001  0
+11010  1
+11011  1
+11100  1
+11101  1
+11110  0
+11111  1
+.e
+
+# ###################
+# END OF .PLA
+# ###################