Added funcitonality for invalid login

.github/workflows/main.yml

@@ -16,6 +16,7 @@ jobs:
       AWS_COGNITO_CLIENT_SECRET: ${{ secrets.AWS_COGNITO_CLIENT_SECRET }}
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      API_KEY: ${{ secrets.API_KEY}}
 
     steps:
     - name: Checkout code

.gitignore

@@ -0,0 +1,8 @@
+neo_dolfin/transactions_ut.db
+Neo_Dolfin/.DS_Store
+neo_dolfin/protean-aria-405907-0f8cb84fda97.json
+neo_dolfin/audit.txt
+neo_dolfin/logs/dolfin.log
+neo_dolfin/logs/dolfin-app.log
+neo_dolfin/logs/dolfin-basiq.log
+neo_dolfin/logs/dolfin-users.log

README.md

@@ -1,12 +1,13 @@
 # NE0 DolFin 
-Updated: 29/08/2023
+Updated: 3/4/2024
 
 ## Branch Management
 ### Authorised Code Owners:
-* Shane Dzartov (@SDzartov)
-* Jackson Thompson (@thompsonjac)
-* Christopher Russo (@CRussoDeakin)
-
+* JUNKAI JIANG (userstarwind)
+* HEERA MOHANADAS (hmm007)
+* GIMSARA KENULA ELGIRIYAGE (GimsaraK)
+* AIDEN JOHN WILTSHIRE (AiderRate)
+
 ### GitHub Management 
 #### Branch Structure
 ##### master
@@ -70,66 +71,38 @@ git push origin your-branch-name --force
 ### Requirements:
 * IDE, like *Visual Studio Code*
 * Python Version == **3.11**
-* AWS CLI installed on your local machine.
+* GitHub Desktop (RECOMMENDED)
 
-## {NEW} MFA CONFIG SET UP
-* In order for the SignIn route to function post MFA, you must ensure that your AWS CLI is installed and you have a configure file:
+### Deploy Neo_Dolfin to ***Localhost***
+* Pull this repo and select this branch, if you are unconfident in your GIT bash skills, please download GitHub Desktop: https://desktop.github.com/
+* Once you have the repo folder open in your IDE, do the following in the BELOW ORDER:
+	* Open a terminal window and move into the neo_dolfin directory via the terminal command: ```cd <path/to>/GitHub/NEO_Dolfin/neo_dolfin```
+ 		* (**NOTE: INSERT YOUR PATH AS REQUIRED, YOUR PATH MAY DIFFER**)  
+  * Initiate a new *venv* env using the following terminal command: ```python -m venv venv``` 
+  * Activate the *venv* env using the following terminal command: ```venv\scripts\activate``` or ```source venv/bin/activate``` if using a mac
+  * Install the required libraries into the *venv* env using the following terminal command: ```pip install -r requirements.txt``` 
+  * To run the flask application, use the following terminal command: ```python app.py``` 
+  * Navigate to ```127.0.0.8000``` in your web browser.
+
+** __Newer Mac "Illegal Hardware" resolution__
 
-### MAC OS
-* Ensure that you have an AWS Credentials file in your root directory 
-	* If you have not done this, use the AWS CLI and run the command ```aws configure``` to configure an AWS Profile.
-	* After that, open the configure file via the command: ```nano ~/.aws/credentials.```. Make sure the code matches the below example and press ```CNTRL+O``` , ```ENTER``` , ```CNTRL+X ```
-* Ensure that your AWS credentials file is in the correct format. The format is given below:
-```
-[default]
-aws_access_key_id=<>
-aws_secret_access_key=<>
-```
-* Verify with the command: ```aws configure list```
-
-### WINDOWS
-#Method 1
-*  * Ensure that you have an AWS Credentials file in your root directory 
-	* If you have not done this, use the AWS CLI and run the command ```aws configure``` to configure an AWS Profile.
-	* Move into that directory via: ```cd %userprofile%\.aws ```
-	* After that, open the configure file via the command: ```nano credentials```. Make sure the code matches the below example and press ```CNTRL+O``` , ```ENTER``` , ```CNTRL+X ```
-* Ensure that your AWS credentials file is in the correct format. The format is given below:
-```
-[default]
-aws_access_key_id=<>
-aws_secret_access_key=<>
-```
-* Verify with the command: ```aws configure list```
-
-
-#Method 2 - Use the proceedure below if you don't have the AWS CLI installed Or a ```cd %userprofile%\.aws ``` directory and credentials file does not exist
-*  * Install the latest version of the AWS CLI for Windows from: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
-*  * Ensure that you have an AWS Credentials file in your root directory (%userprofile%/.aws/configure)
-	* If you do not have a configure file, use the AWS CLI from the command prompt via running the command ```aws configure``` to configure an AWS Profile.
-	* Press Enter to accept the default options for AWS Access Key ID, AWS Secret Access Key, Default region name, Default output format.
- 	* Change directory into your user profile directory ```cd %userprofile% ``` 
-	* Make a directory called .aws via the following command: ```mkdir .aws ```
-   	* Move into that directory via: ```cd .aws ```
-	* Create the 'configure' file (with no extension - ie: configure) using notepad, Visual Studio Code or another text editor.  Make sure the code matches the below, save the file and close the text editor
-```
-[default]
-aws_access_key_id=<>
-aws_secret_access_key=<>
-```
-* Verify with the command: ```aws configure list```
+It is possible to run DolFin on a Mac, however if you are using a newer Mac with Apple Silicon you may receive an “Illegal Hardware Instruction” error on running the “python app.py” command.  To resolve this error perform the following steps: 
+* Install MiniForge from this link - https://github.com/conda-forge/miniforge 
+* Rerun the command “pip install requirements.txt” 
+
+These steps will ensure you have the correct python dependencies for the M1/M2/M3 chipset. 
 
-### Deploy to ***Localhost***
+### Deploy Dolfin_Analytica to ***Localhost***
 * Pull this repo and select this branch, if you are unconfident in your GIT bash skills, please download GitHub Desktop: https://desktop.github.com/
 * Once you have the repo folder open in your IDE, do the following in the BELOW ORDER:
-	* Open a terminal window and move into the neo_dolfin directory via the terminal command: ```cd <path/to>/GitHub/dolfin_fe/neo_dolfin```
+	* Open a terminal window and move into the neo_dolfin directory via the terminal command: ```cd <path/to>/GitHub/NEO_Dolfin/dolfin_analytica```
  		* (**NOTE: INSERT YOUR PATH AS REQUIRED, YOUR PATH MAY DIFFER**)  
-  * Initiate a new *venv* env using the following terminal command: ```python -m venv venv``` 
+  * Initiate a new *venv* env using the following terminal command: ```python -m venv venv2``` 
   * Activate the *venv* env using the following terminal command: ```venv\scripts\activate```
-  * Inside your IDE, create a new file inside your neo_dolfin folder called: ```.env``` (**MAKE SURE TO INCLUDE THE "." AT THE BEGINNING**) 
-	* Ask one of the team leads for the credentials, that you must paste into the .env file and then save the file. 
   * Install the required libraries into the *venv* env using the following terminal command: ```pip install -r requirements.txt``` 
   * To run the flask application, use the following terminal command: ```python app.py``` 
-  * Navigate to ```127.0.0.1``` in your web browser. 
+  * Navigate to ```127.0.0.5000``` in your web browser. 
+
 
 ### {NEW} Testing
 We have testing scripts enabled for this application. 
@@ -139,5 +112,17 @@ We have testing scripts enabled for this application.
 **PLEASE RUN THE PYTEST AND ATTACH THE LOG TEXT/SCREENSHOT TO YOUR PULL REQUEST**
 ***Warnings are OKAY, Fails will result in the PULL request not being reviewed.*** 
 
-## EC2 Deployment 
-***WORK IN PROGRESS***
+## GCP Deployment 
+
+The GCP deployment deploys the following infrastrcuture using Terraform:
+
+- VPC
+- Cloud SQL database
+- VM running a containerised version of anomaly detection
+
+### Requirements:
+* GCP command line tools
+* Terraform
+* Docker desktop
+
+[Further instructions](dolfin_infra/Readme.md) can be found in the dolfin_infra folder

dolfin_analytica/.gitignore

@@ -0,0 +1,21 @@
+# Ignore virtual environment
+venv2\Lib\
+venv2/
+
+# Ignore .env file
+.env
+
+# Ignore the qr.png file
+qr.png
+
+# pycache
+.pytest_cache
+test/__pycache__
+__pycache__
+.DS_store
+
+# my chages
+test.html
+changes.txt
+snippets.txt
+white_arrow.png

dolfin_analytica/app.py

@@ -0,0 +1,112 @@
+from flask import Flask, render_template, request, redirect, url_for, session
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy import create_engine, inspect
+import secrets
+import bcrypt
+import os
+import time
+import datetime
+
+app = Flask(__name__)
+
+@app.route('/', methods=['GET', 'POST'])
+def landing():
+    if request.method == 'POST':
+        # Access form data using request.form
+        username = request.form['username']
+        password = request.form['password']
+
+        if username == 'dsuser':
+            if password == 'dolfin123':
+
+        # After processing the data, you can redirect to the /loading route
+                return redirect(url_for('loading'))
+
+    return render_template('landing.html')
+
+# SQL Database Configure
+app.config['SECRET_KEY'] = secrets.token_hex(16) 
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(os.path.dirname(os.path.abspath(__file__)), 'db/user_database.db')
+
+# SQL Database Configure
+db = SQLAlchemy(app)
+
+class User(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String(80), unique=True, nullable=False)
+    email = db.Column(db.String(80), unique=True, nullable=False)
+    password = db.Column(db.String(255), nullable=False)
+
+class UserTestMap(db.Model):
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    userid = db.Column(db.String(80), unique=True, nullable=False)
+    testid = db.Column(db.Integer, nullable=False)
+
+class UserAuditLog(db.Model):
+    timestamp = db.Column(db.DateTime, primary_key=True, default=datetime.datetime.now)
+    username = db.Column(db.String(80), nullable=False)
+    action = db.Column(db.String(80), nullable=False)
+    message = db.Column(db.String(255), nullable=False)
+
+try:
+    with app.app_context():
+        db.create_all()
+except Exception as e:
+     print("Error creating database:", str(e))
+
+#Logging authentication and output to txt file
+def add_user_audit_log(username, action, message):
+    new_log = UserAuditLog(username=username, action=action, message=message)
+    print(new_log)
+    db.session.add(new_log)
+    db.session.commit() 
+    with open("audit.txt", 'a') as file:
+        file.write(f"[{new_log.timestamp}] [user-{action}]  username: {username}:  {message}\n")
+
+
+#LOGIN ROUTE
+@app.route('/login', methods=['GET', 'POST'])
+def login():
+    if request.method == 'POST':
+
+        input_username = request.form['username']
+        input_password = request.form['password']
+
+        # Retrieve the user from the database
+        user = User.query.filter_by(username=input_username).first()
+
+        # Check if the user exists and the password is correct with stored hash
+        if user and bcrypt.checkpw(input_password.encode('utf-8'), user.password):
+            # Successful login, set a session variable to indicate that the user is logged in
+            session['user_id'] = user.username 
+
+            # If successful, check if test user or real user.
+            row = UserTestMap.query.filter_by(userid = input_username).first()
+            testId = 0
+            if row != None:
+                testId = row.testid
+                print('######### test id:', testId)
+
+            #Successful login
+            add_user_audit_log(input_username, 'login-success', 'User logged in successfully.')
+            # redirect to  main.
+            return redirect('/main')
+
+        ## Otherwise:
+        # log un-successful authentication challenge
+        add_user_audit_log(input_username, 'login-fail', 'User login failed.')
+        return 'Login failed. Please check your credentials.'
+
+    return render_template('login.html')  # Create a login form in the HTML template
+
+
+@app.route('/loading')
+def loading():
+    return render_template('loading.html')
+
+@app.route('/main')
+def main():
+    return render_template('main.html')
+
+if __name__ == '__main__':
+    app.run(debug=True)

dolfin_analytica/audit.txt

@@ -0,0 +1,4 @@
+[2023-12-05 14:12:27.042636] [user-login-fail]  username: genie:  User login failed.
+[2023-12-05 14:12:41.626831] [user-login-success]  username: tester:  User logged in successfully.
+[2023-12-05 14:12:54.632698] [user-login-success]  username: django:  User logged in successfully.
+[2023-12-05 14:13:13.296527] [user-login-success]  username: richard:  User logged in successfully.

dolfin_analytica/requirements.txt

@@ -0,0 +1,7 @@
+blinker==1.7.0
+click==8.1.7
+Flask==3.0.0
+itsdangerous==2.1.2
+Jinja2==3.1.2
+MarkupSafe==2.1.3
+Werkzeug==3.0.1