gdsoumya/authenza

Authenza is a simplified implementation of an Identity as a Service(IDaaS) product. IDaas or Identity as a service is a SaaS-based IAM offering that allows organizations to manage authentication and access controls to provide secure access to their growing number of software and SaaS applications. Authenza implements Bio-metric Multi-Factor Authentication using your regular Android device, making authentication and authorization experience more simpler and easily adaptable.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Authenza requires Docker, Android Studio and an Android device (with fingerprint scanner) running Android Version 9.0+ .

Getting the project.

$ git clone https://github.com/gdsoumya/authenza.git
or 
Download and extract the Zip-File

Setting up the .env file

Create a .env file at the root of the project, it is used by docker to get the required environment variables to start up the different containers. Here is the template for the .env file. Replace the values as needed.

DB_USER=<db_user_name>
DB_PASSWORD=<db_password>
DB_NAME=<db_name>
SMTP_SERVER=<smtp_server>
SMTP_PORT=<smtp_port>
EMAIL_ID=<email_address>
EMAIL_PASSWORD=<email_password>
API_KEY=<api_key_generated_from_org_dashboard>
CLIENT_ID=<client_id_generated_from_org_dashboard>
BASE_URL=<url_for_server>

An example of the .env file would look like :

DB_USER=postgres
DB_PASSWORD=12345678
DB_NAME=authenza
SMTP_SERVER=smtp.gmail.com
SMTP_PORT=587
EMAIL_ID=<gmail_id>
EMAIL_PASSWORD=<gmail_password>
API_KEY=<api_key>
CLIENT_ID=<client_id>
BASE_URL=http://localhost

If you are using Gmail as the email service you may have to turn on Less Secure Application Access.
At first you may put any random value for the API_KEY and CLIENT_ID, later on after creating an API_KEY from the org dashboard you can change the values and restart docker-compose.

Setting up the Android APK

Before you can build the android APK you need to change the base url in the source code, find the java files

app/src/main/java/com/example/fingerprint_protection/scannerActivity.java
app/src/main/java/com/example/fingerprint_protection/fingerPrint_Auth.java

And replace http://localhost with you own BASE_URL. You can then build the apk and run it on your android device (version 9.0+).

Starting the Server

To start the server

$ cd authenza
$ docker-compose up

A Nginx Server will be exposed, it will listen on 0.0.0.0:80, you can access the server using http://0.0.0.0 or using http://BASE_URL using your browser. The following are the root paths for Organization and Org-Client UIs respectively :

http://BASE_URL/org
http://BASE_URL/client

A simplified architecture for the setup can be seen below.

Points to Remember

The Org-Client UI will not function until correct API_KEY and CLIENT_ID is supplied, to do this you need to start the server once and register a Org account and create an API Key. You can then stop the previous server and put the details in the .env file and restart the server using :

$ docker-compose up

Contributors

Soumya Ghosh Dastidar : Backend
Niraj Singh : Android
Abhinav Ghosh : Front-End
Bivas Ranjan Das : Fron-End
Kaustav Ghosh : Front-End

gdsoumya / authenza