NFC-Tools/README.md

30 lines
1.1 KiB
Markdown

# EZGG LAN NFC Tools
This repository contains the tooling around NFC readers/writers.
Currently supported NFC Device: ACR 1252U
## Installation
Make sure you have the apt packages `python3-dev` and `libpcsclite-dev` installed before installing the dependencies from `requirements.txt`.
## Configuration
The root path of the installation (next to `NfcReaderService.py`) needs to contain the `hmac_key.txt`. The correct key can be retrieved from sys admin.
## Tools:
- card_reader
- Standalone: Reads single card and prints content
- Library: API for extracting user ID from card
- card_writer
- Standalone: Takes user ID as console input, writes it securely to card
- NfcReaderService
- Standalone: Continuously reads cards and writes decrypted user ID as keyboard output
## Intended usage
Start `NfcReaderService` on terminals where LAN team needs to verify guest identity, EZGG LAN manager then reads user ID from clipboard.
`NfcReaderService` may be used as part of a systemd unit, to automate the startup process. See service file for additional info.
Run `card_writer` when preparing tickets.