minvws / puzi-php
PHP library to read data from an UZI pass.
Installs: 3 871
Dependents: 2
Suggesters: 0
Security: 0
Stars: 8
Watchers: 13
Forks: 5
Open Issues: 0
Language:Shell
Requires
- php: >=7.4
- ext-json: *
- phpseclib/phpseclib: ^3.0.5
- psr/http-message: ^1.0
Requires (Dev)
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.5
- symfony/http-foundation: ^5
- vimeo/psalm: ^4
Suggests
- ext-gmp: Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.
- ext-openssl: Install the OpenSSL extension in order to speed up a wide variety of cryptographic operations.
This package is auto-updated.
Last update: 2024-10-08 18:22:42 UTC
README
pUZI php
Proficient UZI pass reader in php.
The UZI card is part of an authentication mechanism for medical staff and doctors working in the Netherlands. The cards are distributed by the CIBG. More information and the relevant client software can be found at www.uziregister.nl (in Dutch).
pUZI is a simple and functional module which allows you to use the UZI cards as authentication mechanism. It consists of:
- a reader that interprets the PKCS11 data the card middleware provides to the webserver and returns an UziUser object in return (this repository).
- middleware (currently only for the Laravel framework) that allows authentication and user creation based on UZI cards.
For documentation, software and to apply for an UZI card, please check out www.uziregister.nl.
pUZI is available under the EU PL licence. It was created early 2021 during the COVID19 campaign as part of the vaccination registration project BRBA for the ‘Ministerie van Volksgezondheid, Welzijn & Sport, programma Realisatie Digitale Ondersteuning.’
Questions and contributions are welcome via GitHub.
Requirements
- PHP >= 7.4
Apache config (or NginX equivalent):
SSLEngine on SSLProtocol -all +TLSv1.3 SSLHonorCipherOrder on SSLCipherSuite ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384 SSLVerifyClient require SSLVerifyDepth 3 SSLCACertificateFile /path/to/uziCA.crt SSLOptions +StdEnvVars +ExportCertData
Installation
Composer
composer require minvws/puzi-php
Manual
Add the following to your composer.json
and then run composer install
.
{ "require": { "minvws/puzi-php": "^v2.0" } }
Usage
// Request from your framework/controller $uzi = new \MinVWS\PUZI\UziReader(); $user = $uzi->getDataFromRequest($request); print $user->getUziNumber(); // In case of no request (deprecated): $uzi = new \MinVWS\PUZI\UziReader(); $user = $uzi->getData(); print $user->getUziNumber(); var_dump($user->toArray());
array(9) {
'agb_code' =>
string(8) "00000000"
'card_type' =>
string(1) "N"
'given_name' =>
string(4) "john"
'oid_ca' =>
string(25) "2.16.528.1.1003.1.3.5.5.2"
'role' =>
string(6) "01.015"
'subscriber_number' =>
string(6) "90000111"
'sur_name' =>
string(12) "doe-11111111"
'uzi_number' =>
string(8) "11111111"
'uzi_version' =>
string(1) "1"
'serial_number' =>
string(8) "11111111"
}
This package also allows validation of the request:
$allowedTypes = [ UziConstants::UZI_TYPE_CARE_PROVIDER, UziConstants::UZI_TYPE_NAMED_EMPLOYEE, ]; $allowedRoles = [ UziConstants::UZI_ROLE_DOCTOR, UziConstants::UZI_ROLE_PHARMACIST, ]; $validator = new UziValidator(new UziReader(), true, $allowedTypes, $allowedRoles); if ($validator->isValid($request)) { print "Validated as doctor or pharmasist"; }
You can use either isValid()
, which returns a boolean, or validate()
which throws an exception when
not correctly validated.
Uses
- phpseclib - PHP Secure Communications Library
Used by
- puzi-laravel - Laravel wrapper for proficient UZI pass reader for Laravel 8 or later.
- puzi-auth-bundle - UZI authentication bundle for Symfony for Symfony 4 or later.
Alternatives
- Python - pUZI-python
- Go - go-uzi-middleware
- .NET - UZI Card Authentication Server
Contributing
-
Fork the Project
-
Ensure you have Composer installed (see Composer Download Instructions)
-
Install Development Dependencies
composer install
-
Create a Feature Branch
-
(Recommended) Run the Test Suite
vendor/bin/phpunit
-
(Recommended) Check whether your code conforms to our Coding Standards by running
vendor/bin/phpstan analyse vendor/bin/psalm vendor/bin/phpcs
-
Send us a Pull Request