2fa-microservice

A microservice providing 2FA with Vonage.

Installation

Local

The project requires python version 3.11 to be avilable. To install the app, you will need install poetry. The lock file was generated in version 1.1.14, so same version must be used.

curl -sSL https://install.python-poetry.org | python3 - --version 1.1.14

Having poetry running, you can install the dependencies and the app:

poetry install

You're done! Now you can run the application and test it.

Docker

To avoid installing any dependencies locally you can run containerised version of this microservice using docker-compose.

Running application

In order to make everything work, setup all the required secrets in /app/envs/.local dotenv file (for local development) or in /app/envs/.docker if you're planning to run the application with docker.

Local

No matter you use docker-compose or you run server locally, you need to ensure that redis container is running. To do so, run:

docker-compose up -d redis

Then, just exec the command (from the root of the repository)

poetry run app/main.py

The application will be avilable on localhost:8000.

Docker

To run application in docker, just exec:

docker-compose up -d

The application should be avilable on the port 8000.

Usage

To perform 2FA, firstly call the application on

curl -v --location 'http://0.0.0.0:8000/2fa/init' \
--header 'Content-Type: application/json' \
--data '{"phone_number":"'"$PHONE_NUMBER"'" }'

Then you should receive the OTP to the PHONE_NUMBER. To finish 2FA, verify the code calling:

curl --location 'http://0.0.0.0:8000/2fa/verify' \
--header 'Content-Type: application/json' \
--data '{"phone_number": "'"$PHONE_NUMBER"'", "otp_code": "'"$OTP_CODE"'"}'

where OTP_CODE is the OTP code sent to the PHONE_NUMBER.

Testing

To run tests, you have to have local setup done. Then, you can exec:

poetry run pytest tests

Disclaimer: running integration tests require redis container to be running.

Contribute

Since I would like to keep my code readable, please use the pre-commit set up with .pre-commit-config.yaml config.

Areas for improvements

• Authentication: It wasn't listed as a part of requirements, but might be needed. There are various methods, including defining access rules inside of the k8s cluster (with ingress), so the implementation strongly depends on the business requirements.

• Authentication to Vonage: In real life scenario, I would prefer to generate token (possible with vonage api).

• Deployment workflow: Depending on the container repository and business requirements, there should be a workflow that builds and pushes image to the repository.

• Improved phone validation: Depending on the business requirements, I would add a better validation.