brmdoor_libnfc/README.md
2015-12-04 17:10:13 +01:00

48 lines
1.5 KiB
Markdown

# Brmdoor via libnfc
This is an access-control system implementation via contactless ISO 14443A cards
and a PN53x-based reader. So you basically swipe your card, and if it's in
database, the door unlocks.
It's primarily intended for Raspberry Pi, but can work for other plaforms that
can work with libnfc (including common x86 systems).
Info about authorized users and their cards and keys is stored in sqlite database.
## Building
You need just to run `make`. Additional dependencies:
- [SWIG](http://www.swig.org/)
- [WiringPi2 pythonic binding](https://github.com/WiringPi/WiringPi2-Python) (for switching lock on Raspberry)
- you may have to change `python2.7-config` to `python-config` on some older systems in Makefile
## Howto
1. Create the database
python create_authenticator_db.py authenthicator_db.sqlite
2. Copy sample config file, edit your pins, DB file location, timeouts
cp brmdoor_nfc.config.sample brmdoor_nfc.config
3. Add some users
- either authenthication by UID, e.g.:
brmdoor_adduser.py -c brmdoor_nfc.config -a uid 34795FCC SomeUserName
- authenthication by Yubikey's HMAC-SHA1 programmed on slot 2
brmdoor_adduser.py -c brmdoor_nfc.config -a hmac 40795FCCAB0701 SomeUserName 000102030405060708090a0b0c0d0e0f31323334
- to program Yubikey slot 2 to use HMAC with given key, use:
ykpersonalize -2 -ochal-resp -ohmac-sha1 -ohmac-lt64 -oserial-api-visible
Finally, run the daemon:
python brmdoor_nfc_daemon.py brmdoor_nfc.config