Awesome
Vault App
<p> <img src="GitHub Repo Assets/vaultHeader.png" height="290"> </p>About
Vault is a two factor authenticator app which generates time based OTPs(One Time Passwords). It uses the HMAC type of message authentication involving SHA1 cryptographic function. This is based on TOTP(Time based One Time Passwords) algorithm.
Steps for running the app
- Download the Xcode 13.3 on macOS 12.3.
- Clone this repository.
- Open the Vault.swiftpm(Swift Playgrounds app project) using Xcode.
- Build and run the app on iPhone 13 Pro Simulator(works on any other iOS device).
Technologies Used
Project Components
For demonstration purposes, the project contains two sections in itself - the Vault app (which is the two factor authenticator app) and the Wallets app (which is a list of wallets, each having a secret key that is shared between the authenticator and the respective wallet). The Wallets app is a simulation of a generic wallet app, which are secured with 2 factor authentication. In order to open a wallet, the user would first need to go to the Vault app and check for the real time OTP(generated every 60 seconds). Then the user needs to enter that OTP in the wallet login screen. Entering the correct OTP would let them access the wallet details.
Features
-
The Vault app generates a new OTP every 60 seconds using the secret key of the respective wallet. It also contains a circular progress bar for each wallet showing the time left for that OTP to expire.
-
The Wallet app contains a list of wallets, each having a unique secret key. A wallet can be unlocked using the OTP for that respective wallet only. Thus it is secured by the Vault app. Once the wallet is unlocked, the user gets to the wallet details page. The wallet details page contains the portfolio for that respective wallet.
-
The project also contains the How It Works section. Here the user is presented with a horizontal carousel of cards which explain the working of Two Factor Authentication process.
-
The project has a very intuitive UI in each of its sections. It also has a touch of neumorphic UI with some of the cards having shadows as well as beautiful gradient colours as well as logos.
App Walkthrough
Onboarding
- On entering the app, we first see the splash screen with the Vault app logo and it's description.
- Then we get to the Onboarding page tab views, where the app presents the purpose of Vault app and 2 factor authentication in form of a story.
- The user has the option to view all these tabs to get more information, or they could simply skip the entire flow.
- Here we see that on scrolling a tab, the user observes a wave effect in the User Interface. This was built using a rotation logic for RoundedRectangte element in SwiftUI.
- Overall this flow creates a smooth onboarding experience for a user, as well as gaining their interest towards the app!
App Home
- Moving on from the Onboarding, we get to the App Home section of the app.
- Here we see that there are 2 cards placed. One for the Vault app (2 factor authenticator) and second one for the Wallet app (List of Wallets which are secured by 2 factor authentication). Note: We have 2 different cards/parts of the app because of demonstration purposes.
- Clicking on any of this would take the user to the respective pages of the app.
- At the bottom we have a Tab Bar which has App Home selected. It has another tab for the How it Works section.
- Both the cards(Vault & the Wallet) have a beautiful neumorphic look with an aesthetic background as well as card shadow. The logo on the cards make it very easy for the user to understand the purpose of the card.
| <img src="https://user-images.githubusercontent.com/43038748/166064695-30a18848-49f6-48e2-8983-a8e8e37e1837.png" width="2560"> <br> App Home Screen |
|---|
Vault App Page
- On clicking the Vault card on the App Home section, we get to the Vault(2 factor authenticator) page.
- Here we see the list of real time based OTPs of different wallets presented in form of a ListView in front of the user.
- Each of the List element has the wallet name at the top. Then it has the real time OTP in a larger text size. And on its side, it has a real time circular progress bar which shows the time left before this 0TP expires for a wallet.
- At the top the NavigationBar has also been integrated, with the Vault app logo at the tab bar center and the Back button to navigate to the App Home.
Wallet App Pages
- On clicking the Wallet card on the App Home section, we get to the Wallet(List of Wallets) page.
- Here we see the list of wallets, each of which are secured by 2 factor authentication.
- Each card in the list represents a wallet, namely - MyCrypto, YouPay and Stonkup.
- For a particular card, we see the logo of the Wallet.
- It's followed by a Unlock button which is used to unlock a particular Wallet using real time OTP.
- Each card has a shadow alongside it, which gives it a simple yet aesthetic look.
Let's try to Unlock a Wallet
- In order to unlock a wallet we first need to see the real time generated OTP from the Vault App page.
- Then we need to go to the Wallets App page and enter that OTP in the respective wallet.
- For example: In the following video, the OTP generated for MyCrypto Wallet is 716528. This is observed from going into the Vault app page.
- Then we go to the Wallets app page and click on Unlock Wallet for MyCrypto Wallet.
- We are then asked to enter the OTP in the given textfields.
- On entering the correct OTP, we click on the Verify button and then the wallet is unlocked and we get to the wallet details page for MyCrypto wallet.
- Here the User Interface is very intuitive and easy to use for a user. There is a separate Unlock button for each of the Wallets which makes it clear for the user, which wallet they want to Unlock.
Entering an Invalid OTP
- Let's consider another case where the user enters a wrong OTP. In that case the wallet does not unlock and the user is presented with an alert overlay that they have entered a wrong OTP.
- For example: In the following video, the OTP generated at that moment of time is 504019.
- We then go to the Wallets App page and try to unlock the MyCrypto Wallet.
- But we enter the OTP to be different, in this case 504018. On clicking on Verify, we see an alert overlay in the app asking us to check the OTP again.
- Thus it is verified that a wallet can only be unlocked by using its real time generated OTP in the Vault App page. Also a wallet can only be opened by their own OTP and not by OTP of other wallets.
How it Works Section
- Apart from the App Home section, we have another section in the app called How It Works.
- On selecting the How It Works section from the tab bar, we get to this section.
- Here the user is presented with information about how 2 factor authentication works behind the scenes, in form of a horizontal carousel of cards.
- Each of the cards has different texts, images to explain concepts around 2 factor authentication like Time based OTP Algorithm(TOTP), SHA1 Cryptographic Function and HMAC based OTP Algorithm(HOTP).
- This carousel is a horizontal list of scrollable cards. This kind of a User Interface helps to maintain the user's interest in this section, as they are presented with a lot of new information.