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-21 21:31:01 +02:00
Code Packages Releases Wiki Activity
Page: Release notes
Pages
Comparison with other solutions Error codes Home Peer Review Response Peer review for "STELLA app" project Project Summary Project Vision Project plan Release notes Test reports Use Case Tests Use Cases User stories
14 Release notes
Henrik Lepson edited this page 2021-12-06 22:20:52 +02:00
Table of Contents

Iteration 4 release notes

The user experience of the mobile application has been gone through big changes. The main focus of this iteration was improving the usability and speed (from the point of an user) of the application that was built during the last 3 iterations.

  • It is no longer necessary to click on any buttons in order to read information such as name, expiration date etc from the ID card. If the user has saved CAN and the application with the home screen is running on the foreground, it is only necessary to put the ID card against the smartphone.
  • During the authentication process, when the information has been read from the ID card the application proceeds automatically now. Clicking on buttons is no longer necessary (previously the button could cause problems when it was clicked too fast, but this is not a problem anymore).
  • The CAN is now saved automatically when the user has entered a 6 digit input to the CAN field.
  • The PIN 1 notification dialogue has been replaced with a switch toggle that enables saving the PIN 1. The toggle state is persistent so it is not necessary to turn it off each time the application has been launched.
  • The features that have been implemented so far should be now bug free.
  • The application listens to the NFC adapter changes in the reader mode, which means that if the user forgots to turn NFC it is not necessary to restart the app when in the reader mode.

In addition the documentation has been updated to reflect the current state of the development.

Iteration 3 release notes

What's New?

The settings menu was added to the application, which allows the user to save the CAN and the PIN 1 on the phone. If the CAN and PIN 1 are saved they are automatically entered. If the CAN does not match the CAN of the ID card the saved CAN is deleted.

The application now has english language support. The application displays estonian or english language according to the locale settings of the user's smartphone. The default language is english.

A test mobile app was created that can launch the MobileAuthApp with an intent. In the end the user is automatically returned to the MobileAuthApp.

A demo backend application based on Spring Boot and Kotlin was added to the project. The backend provides the nonce value with a GET request and can validate the token that it receives with a POST request.

The user interface flow has been reworked so that it detects whether the app was launched by the user itself or it has been launched by another application or a website.

What's Changed?

The reader mode of the application now displays the document's expiration date, citizenship and sex of the user in addition to full name and national identity number.

The order of CAN and PIN fragments is changed in the application.

Known Bugs?

When the application has been launched by the website it does not close entirely, but goes to the background, when user wants to cancel the auth process.

Iteration 2 release notes

For guidance how to run the project look at Readme

APK for iteration 2 release can be downloaded from here: https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/actions/runs/1326585501

More info about installing third party applications on 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 interface. This functionality is covered in more detail by use case #5.

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.
  2. Open the application on the phone using one of the methods mentioned above.
  3. To begin click "Alusta".
  4. 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".
  5. Click "Edasi" to proceed.
  6. Put the ID card against the smartphone.
  7. Wait until the application says "Kaart on tuvastatud." and don't move the ID card until the application says "Andmed loetud".
  8. Click "Edasi" to proceed.
  9. The application now displays full name and the national identification number of the ID card holder.
  10. Click "Unusta" to make the application forget the data and to go the beginning.