Smart Card Access Control System

RFID Card check member entrance

Requirements

1. Docker Engine
2. Python
3. Flask micro web framework

1. Getting started

Move from the command line in the 'universome-authentication' folder and run the following command start the project.

docker compose up

The application can be used from the http://127.0.0.1:8000 The CoAP Server can be used from the http://127.0.0.1:5683

1.1 Design

• MVC design pattern in Flask
• MVC and MVT design patterns

2. Application factory

The application factory is coded into the file _init_.py The library python-dotenv can be used to load important initial configuration parameters.

2.1 Home page - Descrizione

Al primo avvio, l'intero sistema vien configurato affinchè il Database disponga del profilo di amministratore di base e consenta l'inserimento di nuovi utenti, dopo aver inizializzato il database. Viene fatta una verifica facendo degli inserimenti di test per verificare se le operazioni di Lettura, Creazione, Aggiornamento ed Eliminazione vengono effettuate correttamente.

La Home page dell'applicativo conterrà un messaggio di Benvenuto, con una sezione "Chi siamo" e un pulsante per effettuare l'accesso a chi è registrato.

2.2 Dashboard dell'amministratore

La dashboard dell'amministratore, consente la registrazione di nuovi utenti al sistema, o nuovi terminali.

2.3 Profilo utente

APPROCCIO SHAZAM: Il client invia una richiesta al server che si desidera avvicinare un Tag RFID e rimane in attesa della risposta dal server per la convalida.

2.3.1 Utente normale

Un profili "Utente normale" è un profilo assegnato ad un soggetto, membro del progetto, che darà la possibilità di aggiornare, modificare e cancellare le proprie informazioni dal sistema.

2.3.2 Terminale

Un profilo con ruolo "Terminale" è un profilo assegnato ad un dispositivo che potrà leggere e verificare gli utenti registrati, per controllare se hanno accesso o no alla sede.

Per ogni dispositivo distribuito all'interno degli spazi dell'ateneo, questo verrà configurato con un profilo autorizzato solo alla lettura. I membri

3. Security

3.1 Password Hashing

Use BCrypt module from Flask Extension

3. Tests

Testing the Flask Web App

1. REST APIs tests
2. CoAP tests
3. Python script tests.

3.2

Testing the CoAP Server endpoint CoRE Resource Discovery: When a client discovers the list of resources hosted by a server, their attributes, and other link relations by accessing "/.well-known/core".

Example request: aiocoap-client coap://localhost:5683/.well-known/core

Sending a GET request to a resource: Example request: aiocoap-client -m GET coap://localhost:5683/[RESOURCE-PATH]

Sending a GET request to a resource with payload: Example request: aiocoap-client -m GET --payload "CONTENT" coap://localhost:5683/[RESOURCE-PATH]

Sending a PUT request to an Observable resource with a payload: Example request aiocoap-client -m PUT --payload="2024-07-01 12:59:33,Marco,ZZYY,False" coap://localhost:5683/unauthorized

1. Getting started

4.1 Attach Arduino to /dev/ttyACM0 in WSL

Important: The USBIPD Utility use network drivers to attach devices to WSL. Check Firewall configuration or disable it. Run the Command Line with administrator privileges

> usbipd list # Find the Arduino device
# If STATE is "Not shared" run
> usbipd bind --busid [ARDUINO BUSID] # Put device in STATE: Shared
# If STATE is "Shared" run
> usbipd attach --wsl --busid [ARDUINO BUSID]

From the WSL terminal, check if /dev/ttyACM0 exists, running

$ ls /dev/tty*

4. Deployment

• [uWSGI] (https://en.wikipedia.org/wiki/UWSGI)

4.1 Threaded mode

• Enable Threaded mode

Miscellaneous

Flask

1. Important: Application Context
2. Dinamyc HTML Page: JavaScript, fetch, and JSON - Flask

Database

1. [DB Browser for SQLite] (https://sqlitebrowser.org/)
2. [Database Connection and Cursor closing] (https://www.quora.com/What-is-the-difference-between-cursor-and-connection-when-performing-operations-on-databases)

Flask: Using SQLite 3 with Flask - Flask Doc

Other useful resources for Database

• Autoincrement - SQLite Doc

Database Cache

1. Redis

Styling

1. libsass - https://sass.github.io/libsass-python/index.html
2. libsass with Flask - https://sass.github.io/libsass-python/frameworks/flask.html

Error encountered

1. ImportError: cannot import name 'url_decode' from 'werkzeug.urls' (/opt/venv/lib/python3.10/site-packages/werkzeug/urls.py)
2. sqlite3.OperationalError: attempt to write a readonly database Solution: RUN chown ${UID}:${UID} instance -R in Dockerfile

A. Guides and resources

App

1. Python:

   • File __init__.py: https://betterstack.com/community/questions/what-is-init-py-for/
   • The Try, Except and Finally block: https://medium.com/analytics-vidhya/do-you-really-understand-try-finally-in-python-110cee4c1a8

2. Flask:

   • https://auth0.com/blog/best-practices-for-flask-api-development/
   • https://auth0.com/blog/developing-restful-apis-with-python-and-flask/
   • make_response() Docs: https://tedboy.github.io/flask/generated/flask.make_response.html
   • Flask.Request:
     • WerkZeug.Request subclass:

3. Flask-Login: https://flask-login.readthedocs.io/en/latest/

4. Flask-Bcrypt: https://flask-bcrypt.readthedocs.io/en/1.0.1/index.html

5. Flask-WTF - Documentation https://flask-wtf.readthedocs.io/en/1.2.x/quickstart/

6. WTForms - Crash course: https://wtforms.readthedocs.io/en/3.0.x/crash_course/

7. PySerial - Documentation: https://pyserial.readthedocs.io/en/latest/

8. Server-Sent Event: https://dev.to/cloudx/backend-to-frontend-communication-with-server-sent-events-56kf

9. Flask-SSE: https://flask-sse.readthedocs.io/en/latest/quickstart.html

10. Flask-CORS: https://flask-cors.readthedocs.io/en/3.0.10/

WebSocket in Flask

• For Real Time Client-Server communication, it is possible to use flask_socketio module.

Database

1. Timestamp: https://dev.mysql.com/doc/refman/8.0/en/timestamp-initialization.html

Environment

1. Virtual environment and container: https://stackoverflow.com/questions/48561981/activate-python-virtualenv-in-dockerfile
2. Baud rate: Common Baud rate
3. TTY: Keep TTY open in Docker
4. dmesg: Operation not permitted: Privileged Docker container
5. Permission problems in TTY from Docker to RaspberryOS

Container

1. Docker installation (for RPi 3B+ with aarch64, 64bit RaspberryOS): https://docs.docker.com/engine/install/debian/
2. Docker Compose Flask Sample: https://github.com/docker/awesome-compose/tree/master/flask
3. Static IP in container: https://stackoverflow.com/questions/39493490/provide-static-ip-to-docker-containers-via-docker-compose
4. Expose UDP ports: How do I publish a UDP Port on Docker? - stackoverflow.com

Hardware

1. Logic Level Shifter / Converter
   • Fake LLShttps://forum.arduino.cc/t/logic-level-shifter-problem/1138650

CoAP Protocol

1. aiocoap - https://github.com/chrysn/aiocoap
2. aiocoap Sample

Client, Toolkit IoT - https://github.com/IoT-Technology/IoT-Toolkit CoAP Wireshark Packet Analyzer - https://www.youtube.com/watch?v=RfCbpUYcjdc

B. Tutorials

Project structure

1. How to structure Flask project

Flask-Login

1. Add authentication to your app with Flask-Login
2. How to authenticate users in Flask
3. How Flask-Login works

Flask-Requests

1. Retrieve data from request

Credits

• Dr. Gianluca Carbone - Engineering and Computer Science student

License