arti/Estonian-ID-card-mobile-authenticator-POC
1
0
Fork 0
mirror of https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC.git synced 2024-11-25 23:31:00 +02:00
Code Packages Releases Wiki Activity

Added more information about using the application.

Henrik Lepson 2021-10-10 17:36:30 +03:00
parent 6f299f67f7
commit abde36242b
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Release-notes.md

@ -4,13 +4,37 @@
* The smartphone must support NFC technology and it must be enabled
* The user must have an Estonian ID card with NFC capability (issued since 2018)
_Knowledge of Estonian might be useful as the application is in Estonian language at the moment. The English language support will be added during the iteration 3. If one does not understand Estonian then the guide at the bottom of the release notes might be useful._
### Installing the application on the phone
The first option is to open the MobileAuthApp folder of the project on the Android Studio and use the smartphone instead of an emulator (the application does not work with emulators because real ID card has to be scanned, which an emulator can not do) to run the application. This way the application gets installed on the phone automatically.
More information about using real devices with Android studio: https://developer.android.com/studio/run/device
The second and more reliable option is to get the .apk that is generated under the Artifacts of GitHub Actions when the project is built. Download the .apk file and move it to the smartphone and install it (phone permissions might have to be changed because it is not installed through Google Play). After the application has been installed it should open as any other application.
More info about installing third party applications to the Android phones: https://www.androidauthority.com/how-to-install-apks-31494/
**NB! Before using the application make sure that the NFC is enabled on the phone, otherwise information can not be read from the ID card.**
### What's New?
* The GitHub Actions has been set up. Now .apk file is generated automatically whenever new code is pushed to the repository.
* The mobile authentication application can now read public information from the Estonian ID cards that have NFC interfance. This functionality is covered in more detail by [use case #5](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Cases#use-case-5).
_NB! Currently the application does not throw a specific error message when the ID card is removed too fast, but the 90 second timer and the wrong CAN error messages are shown to the user._
_NB! Currently the application does not throw a specific error message when the ID card is removed too fast (may throw incorrectly "wrong CAN" exception instead), but the 90 second timer and the wrong CAN error messages are shown to the user when the time runs out or CAN is wrong._
### What's Changed?
* The documentation of the project has been updated. All functional requirements are now covered by use cases and the existing two requirements from the iteration 1 have been changed to better represent the system under development.
### Additional guide about using the application
1. Make sure that NFC is enabled on the phone.
1. Open the application on the phone using one of the methods mentioned above.
1. To begin click "Alusta".
1. Enter the CAN (Card Authenticaton Number) of the ID card. It is under the photo on the ID card with a title "KASUTAJA ALLKIRI/HOLDER'S SIGNATURE".
1. Click "Edasi" to proceed.
1. Put the ID card against the smartphone.
1. Wait until the application says "Kaart on tuvastatud." and don't move the ID card until the application says "Andmed loetud".
1. Click "Edasi" to proceed.
1. The application now displays full name and the national identification number of the ID card holder.
1. Click "Unusta" to make the application forget the data and to go the beginning.