bug fixes

CONTRIBUTING.md

@@ -24,9 +24,10 @@
 
 ## This project makes use of the following Flask libraries
 
-* Flask-blueprints for modularity and clean codebase,
+* Blueprints for modularity and clean codebase,
 * Flask-admin for Admin views and easy realtime management,
-* Flask-SQLAlchemy for SQL models, 
+* Flask-SQLAlchemy for SQL models,
+* Flask-Caching with redis for efficient caching,
 * Flask-login for session handling,
 * Flask-wtf for responsive forms,
 * Flask-mail for mail service,

src/FlaskRTBCTF/helpers.py

@@ -0,0 +1,20 @@
+""" Helper functions """
+
+import os
+import secrets
+
+
+def handle_secret_key(default="you-will-never-guess"):
+    sk = os.environ.get("SECRET_KEY", default)
+    if not sk:
+        sk = secrets.token_hex(16)
+        os.environ["SECRET_KEY"] = sk
+    return sk
+
+
+def handle_admin_pass(default="admin"):
+    passwd = os.environ.get("ADMIN_PASS", default)
+    if not passwd:
+        passwd = secrets.token_hex(16)
+        os.environ["ADMIN_PASS"] = passwd
+    return passwd

src/FlaskRTBCTF/models.py

@@ -0,0 +1,115 @@
+""" Models. """
+
+
+from datetime import datetime
+from itsdangerous import TimedJSONWebSignatureSerializer as Serializer
+
+from flask import current_app
+from FlaskRTBCTF.config import LOGGING
+from FlaskRTBCTF import db, login_manager
+from flask_login import UserMixin
+
+
+@login_manager.user_loader
+def load_user(user_id):
+    return User.query.get(int(user_id))
+
+
+# Machine Table
+
+
+class Machine(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String(64), nullable=False)
+    user_hash = db.Column(db.String(32), nullable=False)
+    root_hash = db.Column(db.String(32), nullable=False)
+    user_points = db.Column(db.Integer, default=0)
+    root_points = db.Column(db.Integer, default=0)
+    os = db.Column(db.String(16), nullable=False)
+    ip = db.Column(db.String(45), nullable=False)
+    hardness = db.Column(db.String(16), nullable=False, default="Easy")
+
+    score = db.relationship("Score", backref="machine", lazy=True)
+
+
+# User Table
+
+
+class User(db.Model, UserMixin):
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String(24), unique=True, nullable=False)
+    email = db.Column(db.String(88), unique=True, nullable=False)
+    password = db.Column(db.String(64), nullable=False)
+    isAdmin = db.Column(db.Boolean, default=False)
+    score = db.relationship("Score", backref="user", lazy=True, uselist=False)
+    if LOGGING:
+        logs = db.relationship("Logs", backref="user", lazy=True, uselist=False)
+
+    def get_reset_token(self, expires_sec=1800):
+        s = Serializer(current_app.config["SECRET_KEY"], expires_sec)
+        return s.dumps({"user_id": self.id}).decode("utf-8")
+
+    @staticmethod
+    def verify_reset_token(token):
+        s = Serializer(current_app.config["SECRET_KEY"])
+        try:
+            user_id = s.loads(token)["user_id"]
+        except Exception:
+            return None
+        return User.query.get(user_id)
+
+    def __repr__(self):
+        return f"User('{self.username}', '{self.email}'))"
+
+
+# Score Table
+
+
+class Score(db.Model):
+    user_id = db.Column(
+        db.Integer, db.ForeignKey("user.id"), nullable=False, primary_key=True
+    )
+    userHash = db.Column(db.Boolean, default=False)
+    rootHash = db.Column(db.Boolean, default=False)
+    points = db.Column(db.Integer)
+    timestamp = db.Column(db.DateTime(), default=datetime.utcnow)
+    machine_id = db.Column(db.Integer, db.ForeignKey("machine.id"), nullable=False)
+
+    def __repr__(self):
+        return f"Score('{self.user_id}', '{self.points}')"
+
+
+# Notifications Table
+
+
+class Notification(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    title = db.Column(db.String(30), nullable=False)
+    body = db.Column(db.TEXT(), nullable=False)
+    timestamp = db.Column(db.DateTime, default=datetime.utcnow)
+
+    def __repr__(self):
+        return f"Notif('{self.title}', '{self.body}')"
+
+
+# Logging Table
+
+
+if LOGGING:
+
+    class Logs(db.Model):
+        user_id = db.Column(
+            db.Integer, db.ForeignKey("user.id"), nullable=False, primary_key=True
+        )
+        accountCreationTime = db.Column(db.DateTime, nullable=False)
+        visitedMachine = db.Column(db.Boolean, default=False)
+        machineVisitTime = db.Column(db.DateTime, nullable=True)
+        userSubmissionTime = db.Column(db.DateTime, nullable=True)
+        rootSubmissionTime = db.Column(db.DateTime, nullable=True)
+        userOwnTime = db.Column(db.String, nullable=True)
+        rootOwnTime = db.Column(db.String, nullable=True)
+        userSubmissionIP = db.Column(db.String, nullable=True)
+        rootSubmissionIP = db.Column(db.String, nullable=True)
+
+        def __repr__(self):
+            return f"Logs('{self.user_id}','{self.visitedMachine}'"