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-06-02 17:30:11 +03:00
Code Releases Wiki Activity

Updated Use Cases (markdown)

Kevin 2021-11-10 18:27:47 +02:00
parent 411793681d
commit 88425a6be5
1 changed files with 54 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
Use-Cases.md

@ -15,8 +15,7 @@ User
**Extensions:**
 3. The length of the CAN entered by the user is not 6.
  a. The action of the next button is cancelled.
  b. The user is allowed to change the entered CAN.
  a. The system cancels the action triggered by the next button so the user can change the entered CAN.
**Related tasks:**
[MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-39](https://tvp-mobile-authentication.atlassian.net/browse/MOB-39), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40)
@ -46,8 +45,7 @@ User
**Extensions:**
 3. The length of the PIN1 that the user entered in the input field is not an integer in the range [4, 12].
  a. The action triggered by the next button is cancelled.
  b. The user is allowed to change the entered PIN1.
  a. The system cancels the action triggered by the next button so the user can change the entered PIN1.
**Related tasks:**
[MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40)
@ -74,8 +72,7 @@ User
**Extensions:**
 3. The length of the PIN2 that the user entered in the input field is not an integer in the range [5, 12].
  a. The action triggered by the next button is cancelled.
  b. The user is allowed to change the entered PIN2.
  a. The system cancels the action triggered by the next button so the user can change the entered PIN2.
**Related tasks:**
[MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37)
@ -98,7 +95,7 @@ User
**Main success scenario:**
1. The user opens the settings menu from the home screen of the application.
2. The user chooses the option to save the CAN of the ID card.
3. The user is asked to enter a CAN (includes Use Case #1).
3. The application asks the user to enter a CAN (includes Use Case #1).
4. The application notifies the user that the CAN has been saved to the application and displays it to the user.
**Extensions:**
@ -138,12 +135,12 @@ User
**Extensions:**
 4. The user fails to put the ID card against the smartphone in the 90 second time window.
  a. The process is cancelled and the user is returned to the home screen of the application.
  a. The system cancels the process and returns the user to the home screen of the application.
 5a. The CAN provided by the user does not match the CAN on the ID card.
  a. The application fails to establish a secure connection with the ID card over the NFC connection.
  b. The application notifies the user that the CAN provided was not valid and the user is returned to the home screen.
  b. The application notifies the user that the CAN provided was not valid and returns the user to the home screen.
 5b. The ID card is moved away from the smartphone NFC range before the information exchange between the smartphone and the ID card is completed.
  a. The application notifies the user that the connection to the ID card was lost and the user is returned to the home screen.
  a. The application notifies the user that the connection to the ID card was lost and returns the user to the home screen.
**Related tasks:**
[MOB-10](https://tvp-mobile-authentication.atlassian.net/browse/MOB-10), [MOB-16](https://tvp-mobile-authentication.atlassian.net/browse/MOB-16), [MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-39](https://tvp-mobile-authentication.atlassian.net/browse/MOB-39), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40), [MOB-52](https://tvp-mobile-authentication.atlassian.net/browse/MOB-52), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)
@ -174,21 +171,22 @@ The user has saved a valid PIN1 to the biometric authentication method.
**Primary actor:**
User
**Main success scenario:**
1. The user is shown a biometric authentication dialog that asks the user to touch a fingerprint sensor on the smartphone when PIN1 is needed during the authentication process.
1. The system displays a biometric authentication dialog that asks the user to touch a fingerprint sensor on the smartphone when PIN1 is needed during the authentication process.
2. The user touches a fingerprint sensor on the smartphone.
3. The fingerprint is detected and the application enters PIN1 for the user automatically.
3. The system detects the fingerprint.
4. The application enters PIN1 for the user automatically.
**Extensions:**
 1. The system is unable to access the smartphone's biometric authentication functionality.
  a. The application notifies the user that biometric authentication is currently unavailable.
  b. The user is asked to enter PIN1 manually (includes Use Case #2).
 2. The biometric authentication functionality does not accept the fingerprint provided by the user.
  b. The application asks the user to enter PIN1 manually (includes Use Case #2).
 3. The biometric authentication functionality does not accept the fingerprint provided by the user.
  a. The application notifies the user that biometric authentication has failed because the provided fingerprint does not match the expected fingerprint.
  b. The user is asked to enter PIN1 manually (includes Use Case #2).
 3. The PIN1 saved to the biometric authentication method is not valid.
  b. The application asks the user to enter PIN1 manually (includes Use Case #2).
 4. The PIN1 saved to the biometric authentication method is not valid.
  a. The system is not able to retrieve information from the ID card with an invalid PIN1.
  b. The user is notified that the PIN1 entered was not valid and the authentication process is cancelled.
  c. The biometric authentication mode is automatically turned off by the application in the settings menu until a new PIN1 is saved to this feature in order to avoid future use of this feature with an invalid PIN1.
  b. The application notifies the user that the PIN1 entered was not valid and cancels the authentication process.
  c. The application turns off biometric authentication mode until a new PIN1 is saved to this feature in the settings menu in order to avoid future use of this feature with an invalid PIN1.
**Related tasks:**
[MOB-28](https://tvp-mobile-authentication.atlassian.net/browse/MOB-28), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-38](https://tvp-mobile-authentication.atlassian.net/browse/MOB-38), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)
@ -207,8 +205,8 @@ The information has already been retrieved from the ID card.
**Primary actor:**
The authentication application
**Main success scenario:**
1. The information that has been retrieved from the ID card is used to create a JWT.
2. The application sends the JWT to a mobile application or a website that started the authentication application with an intent at the beginning.
1. The system uses information retrieved from the ID card to create a JWT.
2. The application sends the JWT to a mobile application or website that initially started the authentication application with an intent.
3. The authentication application closes itself.
**Extensions:**
@ -236,29 +234,29 @@ User
**Main success scenario:**
1. The user selects the authentication application option as a method for logging in.
2. The website starts the authentication application with an intent.
3. The authentication application asks the user to enter the CAN of the ID card (includes Use Case #1) if it is not saved to the application.
4. The authentication application asks the user to enter the PIN1 of the ID card (includes Use Case #3).
5. The authentication application asks the user to put the ID card against the smartphone in the 90 second time window.
3. The application asks the user to enter the CAN of the ID card (includes Use Case #1) if it is not saved to the application.
4. The application asks the user to enter the PIN1 of the ID card (includes Use Case #3).
5. The application asks the user to put the ID card against the smartphone in the 90 second time window.
6. The user puts the ID card against the smartphone.
7. The authentication application uses the provided CAN to establish a secure connection (PACE) with an ID card and PIN1 to retrieve protected information from the ID Card.
8. The information retrieved from the ID card is used to generate a JWT that is delivered to the website that started the authentication application in step 1.
7. The application uses the provided CAN to establish a secure connection (PACE) with an ID card and PIN1 to retrieve protected information from the ID Card.
8. The application uses information retrieved from the ID card to generate a JWT and delivers it to the website that started the authentication application in step 1.
**Extensions:**
 2. The authentication application is not found.
  a. The website informs the user that the login process failed as the application could not be found.
 6. The user fails to put the ID card against the smartphone in the 90 second time window.
  a. The application cancels the authentication process.
  b. The user is directed back to the website.
  b. The application directs the user back to the website.
 7a. The information exchange between the smartphone and ID card fails.
  a. The authentication application cancels the authentication process and the user is directed back to the website.
  a. The application cancels the authentication process and directs the user back to the website.
 7b. The CAN provided by the user did not match the CAN of the ID card.
  a. The application fails to establish a secure connection with the ID card via the NFC.
  b. The user is notified that the CAN provided was incorrect.
  c. The authentication process is cancelled and the user is directed back to the website along with a corresponding response.
  b. The application notifies the user that the provided CAN was incorrect.
  c. The application cancels the authentication process and directs the user back to the website along with a corresponding response.
 7c. The PIN1 provided by the user is not valid.
  a. The application fails to retrieve information protected by PIN1 from the ID card.
  b. The user is notified that the provided PIN1 was not correct.
  c. The authentication process is canceled and the user is directed back to the website along with a corresponding response.
  b. The application notifies the user that the provided PIN1 was not correct.
  c. The application cancels the authentication process and directs the user back to the website along with a corresponding response.
**Related tasks:**
[MOB-16](https://tvp-mobile-authentication.atlassian.net/browse/MOB-16), [MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-21](https://tvp-mobile-authentication.atlassian.net/browse/MOB-21), [MOB-23](https://tvp-mobile-authentication.atlassian.net/browse/MOB-23), [MOB-25](https://tvp-mobile-authentication.atlassian.net/browse/MOB-25), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40), [MOB-42](https://tvp-mobile-authentication.atlassian.net/browse/MOB-42), [MOB-43](https://tvp-mobile-authentication.atlassian.net/browse/MOB-43), [MOB-44](https://tvp-mobile-authentication.atlassian.net/browse/MOB-44), [MOB-48](https://tvp-mobile-authentication.atlassian.net/browse/MOB-48), [MOB-52](https://tvp-mobile-authentication.atlassian.net/browse/MOB-52), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)
@ -286,24 +284,24 @@ User
4. The application asks the user to enter a valid PIN2 (includes Use Case #2).
5. The application asks the user to put the ID card against the smartphone in the 90 second time window.
6. The user puts the ID card against the smartphone.
7. The application uses the provided CAN to establish a secure connection with an ID card using the NFC technology and then PIN2 to retrieve protected information from the card.
8. The retrieved information is used to generate a JWT for signature that is then delivered to the website that launched the application.
7. The application uses the provided CAN to establish a secure connection with an ID card using NFC technology and then PIN2 to retrieve protected information from the card.
8. The application uses the retrieved information to generate a JWT for signature and delivers it to the website that launched the application.
**Extensions:**
 2. The authentication application is not found.
  a. The website informs the user that the process of giving a signature has failed.
 4. The user fails to put the ID card against the smartphone in the 90 second time window.
  a. The authentication process is cancelled.
  b. The user is directed back to the website along with a corresponding response.
  a. The application cancels the authentication process.
  b. The application directs the user back to the website along with a corresponding response.
 7a. The CAN provided by the user does not match the CAN of the ID card.
  a. The application fails to establish a secure connection with an ID card.
  b. The process is canceled and the user is returned to the website along with a corresponding response.
  b. The application cancels the process and returns the user to the website along with a corresponding response.
 7b. The PIN2 provided by the user is not valid.
  a. The application fails to retrieve necessary information from the ID card.
  b. The process is canceled and the user is returned to the website along with a corresponding response.
  b. The application cancels the process and returns the user to the website along with a corresponding response.
 7c. The NFC connection between the ID card and the smartphone is lost during the communication.
  a. The application fails to retrieve information from the ID card.
  b. The process is canceled and the user is returned to the website along with a corresponding response.
  b. The application cancels the process and returns the user to the website along with a corresponding response.
**Related tasks:**
[MOB-16](https://tvp-mobile-authentication.atlassian.net/browse/MOB-16), [MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-22](https://tvp-mobile-authentication.atlassian.net/browse/MOB-22), [MOB-23](https://tvp-mobile-authentication.atlassian.net/browse/MOB-23), [MOB-25](https://tvp-mobile-authentication.atlassian.net/browse/MOB-25), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40), [MOB-42](https://tvp-mobile-authentication.atlassian.net/browse/MOB-42), [MOB-43](https://tvp-mobile-authentication.atlassian.net/browse/MOB-43), [MOB-44](https://tvp-mobile-authentication.atlassian.net/browse/MOB-44), [MOB-45](https://tvp-mobile-authentication.atlassian.net/browse/MOB-45), [MOB-50](https://tvp-mobile-authentication.atlassian.net/browse/MOB-50), [MOB-52](https://tvp-mobile-authentication.atlassian.net/browse/MOB-52), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)
@ -335,25 +333,24 @@ User
6. The authentication application asks the user to put the ID card against the smartphone in the 90 second time window.
7. The user puts the ID card against the smartphone.
8. The authentication application uses the provided CAN to establish a secure connection with an ID card and PIN1 to retrieve protected information from the ID Card.
9. The information retrieved from the ID card is used to generate a JWT and it is returned to the initial application that started the startActivityForResult intent with an OK message.
9. The authentication application uses the information retrieved from the ID card to generate a JWT and returns it to the initial application that started the startActivityForResult intent with an OK message.
**Extensions:**
 3. The authentication application is not found.
  a. The target application informs the user that the authentication process has failed.
 7. The user fails to put the ID card against the smartphone in the 90 second time window.
  a. The authentication process is canceled.
  b. The user is returned to the initial application along with a corresponding response.
 8a. The connection between the smartphone and the ID card is lost.
  a. The authentication application cancels the authentication process.
  b. The user is returned to the initial application that started along with a corresponding response.
  b. The application returns the user to the initial application along with a corresponding response.
 8a. The connection between the smartphone and the ID card is lost.
  a. The authentication application cancels the authentication process and returns the user to the initial application along with a corresponding response.
 8b. The CAN provided by the user does not match the CAN of the ID card.
  a. The application fails to establish a secure connection with the ID card via the NFC.
  b. The user is notified that the CAN provided was incorrect.
  c. The authentication process is canceled and the user is directed back to the initial application along with a corresponding response.
  a. The authentication application fails to establish a secure connection with the ID card via the NFC.
  b. The application notifies the user that the CAN provided was incorrect.
  c. The application cancels the authentication process and returns the user back to the initial application along with a corresponding response.
 8c. The PIN1 provided by the user is not valid.
  a. The application fails to retrieve information protected by PIN1 from the ID card.
  b. The user is notified that the provided PIN1 was not correct.
  c. The authentication process is canceled and the user is returned to the initial application along with a corresponding response.
  a. The authentication application fails to retrieve information protected by PIN1 from the ID card.
  b. The application notifies the user that the provided PIN1 was incorrect.
  c. The application cancels the authentication process and returns the user back to the initial application along with a corresponding response.
**Related tasks:**
[MOB-16](https://tvp-mobile-authentication.atlassian.net/browse/MOB-16), [MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-21](https://tvp-mobile-authentication.atlassian.net/browse/MOB-21), [MOB-23](https://tvp-mobile-authentication.atlassian.net/browse/MOB-23), [MOB-25](https://tvp-mobile-authentication.atlassian.net/browse/MOB-25), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40), [MOB-41](https://tvp-mobile-authentication.atlassian.net/browse/MOB-41), [MOB-43](https://tvp-mobile-authentication.atlassian.net/browse/MOB-43), [MOB-44](https://tvp-mobile-authentication.atlassian.net/browse/MOB-44), [MOB-48](https://tvp-mobile-authentication.atlassian.net/browse/MOB-48), [MOB-52](https://tvp-mobile-authentication.atlassian.net/browse/MOB-52), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)
@ -380,25 +377,24 @@ User
4. The authentication application asks the user to enter a valid PIN2 (includes Use Case #3).
5. The authentication application asks the user to put the ID card against the smartphone in the 90 second time window.
6. The user puts the ID card against the smartphone.
7. The application uses the provided CAN to establish a secure connection with an ID card using the NFC technology and then PIN2 to retrieve protected information from the card.
8. The information retrieved from the ID card is used to generate a JWT for signature and it is returned to the application that started the startActivityForResult intent with an OK message.
7. The authentication application uses the provided CAN to establish a secure connection with an ID card using NFC technology and then PIN2 to retrieve protected information from the card.
8. The application uses the information retrieved from the ID card to generate a JWT for signature and returns it along with an OK message to the application that started the startActivityForResult intent.
**Extensions:**
 2. The authentication application is not found.
  a. The initial application informs the user that the process of giving a signature has failed.
 6. The user fails to put the ID card against the smart phone in the provided 90 second time window.
  a. The signature process is cancelled.
  b. The user is returned to the initial application along with a corresponding response.
  a. The authentication application cancels the signature process.
  b. The application returns the user to the initial application along with a corresponding response.
 7a. The CAN provided by the user does not match the CAN of the ID card.
  a. The application fails to establish a secure connection with the ID card via NFC.
  b. The user is notified that the CAN provided was incorrect.
  a. The system fails to establish a secure connection with the ID card via NFC.
  b. The authentication application notifies the user that the CAN provided was incorrect.
 7b. The PIN2 provided by the user is not valid.
  a. The application fails to retrieve necessary information from the ID card.
  b. The process is canceled and the user is returned to the initial application along with a corresponding response.
  c. The authentication process is canceled and the user is directed back to the initial application along with a corresponding response.
  b. The application cancels the process and returns the user to the initial application along with a corresponding response.
 7c. The NFC connection between the ID card and the smartphone is lost during the communication.
  a. The application fails to retrieve information from the ID card.
  b. The process is canceled and the user is returned to the initial application along with a corresponding response.
  b. The application cancels the process and returns the user to the initial application along with a corresponding response.
**Related tasks:**
[MOB-16](https://tvp-mobile-authentication.atlassian.net/browse/MOB-16), [MOB-18](https://tvp-mobile-authentication.atlassian.net/browse/MOB-18), [MOB-22](https://tvp-mobile-authentication.atlassian.net/browse/MOB-22), [MOB-23](https://tvp-mobile-authentication.atlassian.net/browse/MOB-23), [MOB-25](https://tvp-mobile-authentication.atlassian.net/browse/MOB-25), [MOB-37](https://tvp-mobile-authentication.atlassian.net/browse/MOB-37), [MOB-40](https://tvp-mobile-authentication.atlassian.net/browse/MOB-40), [MOB-41](https://tvp-mobile-authentication.atlassian.net/browse/MOB-41), [MOB-43](https://tvp-mobile-authentication.atlassian.net/browse/MOB-43), [MOB-44](https://tvp-mobile-authentication.atlassian.net/browse/MOB-44), [MOB-50](https://tvp-mobile-authentication.atlassian.net/browse/MOB-50), [MOB-52](https://tvp-mobile-authentication.atlassian.net/browse/MOB-52), [MOB-53](https://tvp-mobile-authentication.atlassian.net/browse/MOB-53)