Overview

• This application handles user management functionalities - user profile creation, updation.
• Updates User KYC and bank account details.
• Encrypts and decrypts PII(Personally Identifiable Information) data using AWS KMS.
• Prevents PII(Personally Identifiable Information) data from getting hacked.
• Saves User profile images, KYC documents in Amazon S3 bucket
• Authenticates and authorises users using otp sent to mobile number or email
• The generated OTP are stored in redis cache to authenticate and authorize the users
• Implementation of email service is done using SMTP server hosted in AWS and Spring email
• Implementation of sending otp to mobile number is done using Twilio API
• A user profile is created using an email and mobile number and other basic information
• A user is authenticated with the otp shared along with either mobile number or email.
• If a user doesn't exists with a given email or mobile number, An error message is displayed "User Not Found"
• If a user exists and checks user is authorized to perform an operation
• If a user is not authorized, an error message is displayed "Access is denied for user to perform this opertaion"

There are three types of users

• Super admin - Allowed to create admin users
• Admin - Allowed to create other admin users
• Customer - customer profile updates are permitted

Technologies

• Java 17.0 or more
• Spring Boot
• MySQL
• AWS KMS
• Amazon S3
• Spring Data JPA
• AWS CLI
• Maven
• Spring email
• Twilio

Getting Started

• Setup and install Java, Maven, MySQL and execute the provided SQL scripts
• Create a Twilio account using the url https://www.twilio.com/en-us, get "Account SID", "Auth token" and create a messaging serivce in Twilio and get "service id" and update them in application.properties file.
• Create an SMTP server through cloud provider (ex: amazon ses) or any mail providers, get the login credentials and update the below properties in application.properties file.
  • "spring.mail.host" - SMTP Server
  • "spring.mail.username" - SMTP user name
  • "spring.mail.password" - SMTP password
• Install redis server in local environment as specified in [https://redis.io/docs/latest/operate/oss_and_stack/install/archive/install-redis/]
• start redis server from terminal using the command redis-server
• update redis host and port in application.properties file

Creating an AWS KMS Key

• KMS is a service provided by AWS to encrypt and decrypt PII data.
• A single KMS key generates different encrypted values for the same data.
• login to AWS console [https://signin.aws.amazon.com/signin] .
• Create a AWS KMS Symmetric key. Symmetric key is the one which is used to encrypt and decrypt PII data.
• Navigate to KMS and create a symmetric customer managed key using the below steps:
  1. Configure Key, select key type - symmetric,Key usage - encrypt and decrypt, Key material origin - KMS, Regionality - Single-region-key.
  2. Add labels and description for the key.
  3. Define key administrative permissions - Select IAM users and roles authorised to manage key via KMS API.
  4. Define key usage permissions - Select IAM users and roles authorised to use this key in cryptographic operations.
  5. Click on finish, AWS KMS Key is generated.
  6. Once the key is generated an ARN is available for the key, use it in code to encrypt and decrypt data.
  7. Please find the screenshots for your reference.

Configure the IAM users

• Configure the access key and secret key of IAM users in local environment using AWS CLI who are authorized to access the KMS key and smtp server hosted in Amazon ses.

Create an Amazon S3 buckets

• Create two buckets with predefined values.
• "mtb-kyc-images" to store kyc images of users.
• "mtb-profile-images" to store profile images of users.
• restrict public access to s3 buckets.
• provide access for above buckets to IAM users who have access to the application.

Create database tables

• Create a MySQL database
• Execute the provided SQL scripts
• Update the datasource related attributes in application.properties file

API Documentation

• Run the application and access the below url to view the API documentation:
  • http://localhost:8080/swagger-ui/index.html