import debugproxy

This is a source dump from the debugproxy repository minus the
deployment ansible code and load testing code.

The history prior to this has been removed as it was too difficult to
check if there was any sensitive information in it. Maybe it can be
added later.

Most of this code was writen 2 to 3 years ago and there have been a
handful of commits since then fixing minor bugs and some minor updates
in the deployment scripts.

Author: tarnacious

.gitignore

@@ -0,0 +1,19 @@
+bin
+/data
+include
+/lib
+/proxyui/dist
+share
+lib64
+.cache
+*.egg-info
+*__pycache__*
+pyvenv.cfg
+pip-selfcheck.json
+/proxyweb/static/gen/
+.webassets-cache
+tags
+.sass-cache
+*.pyc
+*.retry
+

config/__init__.py

@@ -0,0 +1,17 @@
+from flask.config import Config
+import os
+import concurrent_log_handler
+
+def read_config() -> Config:
+    config = Config("")
+    env_settings_file = os.environ.get('DEBUGPROXY_SETTING_FILE',
+                                       './config/default_settings.py')
+    config.from_pyfile(env_settings_file)
+
+    # update the config with any values found in the environment
+    for key in config.keys():
+        env_value = os.environ.get(key)
+        if env_value:
+            config[key] = env_value
+
+    return config

config/default_settings.py

@@ -0,0 +1,72 @@
+# *****************************
+# Environment specific settings
+# *****************************
+
+# Flask settings
+SECRET_KEY = 'een3Teinigh4BeeYaesh4ahtegheejei5Ooyeipeingi4thaho' # type: str
+
+# SQLAlchemy settings
+SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:password@localhost/website' # type: str
+
+DATA_PATH = "./data"
+
+# Flask-Mail settings
+MAIL_USERNAME = ''
+MAIL_PASSWORD = ''
+MAIL_DEFAULT_SENDER = ''
+MAIL_SERVER = ''
+MAIL_PORT = 587
+MAIL_USE_SSL = True
+MAIL_USE_TLS = True
+
+LOG_FILE = '/tmp/website.log'
+
+REDIS_HOST = "localhost"
+REDIS_PORT = "6379"
+
+# Script / server urls
+PROXYUI_URL = 'http://localhost:4000/client/main.js'
+PROXYWEBSOCKET_URL = 'ws://localhost:8081/updates'
+PROXYSERVER_PORT = '8080'
+PROXYSERVER_URL = 'localhost:8080'
+PROXYWEBSOCKET_ZMQ_LISTEN_ADDRESS = 'tcp://127.0.0.1:5555'
+
+PROXYSERVER_CHANNEL = 'channel:proxyserver'
+WEBSOCKET_CHANNEL = 'channel:websocket'
+WORKER_QUEUE = 'queue:workers'
+
+WEBSITE_URL = "http://localhost:5000"
+DEBUG=True
+RELOAD=True
+
+RATE_LIMITS = [
+    (10000, 60 * 60),
+    (5000, 10 * 60),
+    (1000, 60),
+    (50, 3)
+]
+
+# Application settings
+APP_NAME = "debugproxy"
+APP_SYSTEM_ERROR_SUBJECT_LINE = APP_NAME + " system error"
+
+# Flask settings
+CSRF_ENABLED = True
+
+# Flask-User settings
+USER_APP_NAME = APP_NAME
+USER_ENABLE_CHANGE_PASSWORD = True  # Allow users to change their password
+USER_ENABLE_CHANGE_USERNAME = False  # Allow users to change their username
+USER_ENABLE_CONFIRM_EMAIL = True  # Force users to confirm their email
+USER_ENABLE_FORGOT_PASSWORD = True  # Allow users to reset their passwords
+USER_ENABLE_EMAIL = True  # Register with Email
+USER_ENABLE_RETYPE_PASSWORD = True  # Prompt for `retype password` in:
+USER_ENABLE_USERNAME = False  # Register and Login with username
+USER_AFTER_LOGIN_ENDPOINT = 'home.home_page'
+USER_AFTER_LOGOUT_ENDPOINT = 'home.home_page'
+USER_ENABLE_REGISTRATION = True
+USER_ENABLE_INVITATION = True
+USER_REQUIRE_INVITATION = True
+USER_SEND_PASSWORD_CHANGED_EMAIL = False
+
+TEMPLATES_AUTO_RELOAD = True

config/logging.ini

@@ -0,0 +1,21 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=stream_handler
+
+[formatters]
+keys=formatter
+
+[logger_root]
+level=DEBUG
+handlers=stream_handler
+
+[handler_stream_handler]
+class=StreamHandler
+level=DEBUG
+formatter=formatter
+args=(sys.stderr,)
+
+[formatter_formatter]
+format=%(asctime)s %(name)-12s %(levelname)-8s %(message)s

database/__init__.py

@@ -0,0 +1 @@
+from database.database import init_db, create_all, drop_all, session, Session

database/database.py

@@ -0,0 +1,33 @@
+from config import read_config
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import scoped_session, sessionmaker
+from sqlalchemy.ext.declarative import declarative_base
+
+
+config = read_config()
+database_uri = config["SQLALCHEMY_DATABASE_URI"]
+
+engine = create_engine(database_uri, convert_unicode=True)
+Session = sessionmaker(autocommit=False,
+                       autoflush=False,
+                       bind=engine)
+db_session = scoped_session(Session)
+session = db_session
+Base = declarative_base()
+Base.query = db_session.query_property()
+
+def create_all():
+    import database.models
+    Base.metadata.create_all(bind=engine)
+
+def drop_all():
+    import database.models
+    Base.metadata.drop_all(bind=engine)
+
+def init_db():
+    # import all modules here that might define models so that
+    # they will be registered properly on the metadata.  Otherwise
+    # you will have to import them first before calling init_db()
+    import database.models
+    Base.metadata.create_all(bind=engine)

database/models.py

@@ -0,0 +1,191 @@
+from datetime import datetime
+
+from config import read_config
+from flask_user import UserMixin
+from itsdangerous import TimedJSONWebSignatureSerializer, SignatureExpired, \
+                         BadSignature
+import sqlalchemy as db
+from database.database import Base
+from sqlalchemy.orm import relationship, backref
+
+config = read_config()
+
+class Organization(Base):
+    __tablename__ = 'organizations'
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String(50),
+                     nullable=False,
+                     server_default=u'',
+                     unique=True)
+    users = relationship('User', backref=backref('users'))
+
+
+class User(Base, UserMixin):
+    __tablename__ = 'users'
+    id = db.Column(db.Integer, primary_key=True)
+
+    # User authentication information (required for Flask-User)
+    email = db.Column(db.Unicode(255),
+                      nullable=False,
+                      server_default=u'',
+                      unique=True)
+
+    confirmed_at = db.Column(db.DateTime())
+    password = db.Column(db.String(255), nullable=False, server_default='')
+    reset_password_token = db.Column(db.String(100),
+                                     nullable=False,
+                                     server_default='')
+
+    # User information
+    active = db.Column('is_active',
+                       db.Boolean(),
+                       nullable=False,
+                       server_default='0')
+
+    first_name = db.Column(db.Unicode(50), nullable=False, server_default=u'')
+    last_name = db.Column(db.Unicode(50), nullable=False, server_default=u'')
+
+    created_at = db.Column(db.DateTime(timezone=True), default=db.func.now())
+
+    # Relationships
+    roles = relationship('Role', secondary='users_roles',
+                            backref=backref('users', lazy='dynamic'))
+
+    organization_id = db.Column(db.Integer(),
+                                db.ForeignKey('organizations.id',
+                                              ondelete='CASCADE'),
+                                nullable=False)
+
+    proxy_sessions = relationship('ProxySession',
+                                  cascade='all,delete',
+                                  backref=backref('proxy_sessions'))
+
+    @property
+    def is_admin(self) -> bool:
+        return self.has_role('admin')
+
+    def generate_auth_token(self) -> str:
+        sig = TimedJSONWebSignatureSerializer(
+            config['SECRET_KEY'],
+            expires_in=config['TOKEN_INVALIDATION_SECONDS']
+        )
+        return sig.dumps({'id':self.id})
+
+    @staticmethod
+    def verify_auth_token(token: str) -> bool:
+        s = TimedJSONWebSignatureSerializer(config['SECRET_KEY'])
+        try:
+            data = s.loads(token)
+        except SignatureExpired:
+            return None
+        except BadSignature:
+            return None
+        return User.get_by_id(data['id'])
+
+    @classmethod
+    def get_by_id(cls, record_id: str) -> Base:
+        if any(
+                (isinstance(record_id, str) and record_id.isdigit(),
+                 isinstance(record_id, (int, float))),
+        ):
+            return cls.query.get(int(record_id))
+        return None
+
+
+class ProxySession(Base):
+    __tablename__ = 'proxy_session'
+    id = db.Column(db.Integer(), primary_key=True)
+
+    user_id = db.Column(db.Integer(),
+                        db.ForeignKey('users.id',
+                                      ondelete='CASCADE'),
+                        nullable=False)
+
+    username = db.Column(db.String(255),
+                         nullable=False,
+                         unique=True)
+
+    password = db.Column(db.String(255),
+                         nullable=False)
+
+    is_active = db.Column(db.Boolean(),
+                          nullable=False,
+                          server_default='1')
+
+    requests = relationship('Request',
+                                cascade="all,delete",
+                                backref=backref('requests'))
+
+    intercepts = relationship('Intercept',
+                                cascade="all,delete",
+                                backref=backref('intercepts'))
+
+    created_at = db.Column(db.DateTime(timezone=True), default=db.func.now())
+    updated_at = db.Column(db.DateTime(timezone=True), default=db.func.now())
+
+
+class Intercept(Base):
+    __tablename__ = 'intercept'
+
+    id = db.Column(db.Integer(), primary_key=True)
+
+    session_id = db.Column(db.Integer(),
+                           db.ForeignKey('proxy_session.id',
+                                         ondelete='CASCADE'),
+                           nullable=False)
+
+    query = db.Column(db.String(255),
+                      nullable=False)
+
+    method = db.Column(db.String(255),
+                       nullable=False)
+
+# CREATE INDEX CONCURRENTLY request_key_index ON request (key);
+# CREATE INDEX CONCURRENTLY request_session_id_index ON request (session_id);
+# CREATE INDEX CONCURRENTLY request_created_at_index ON request (created_at);
+# ALTER TABLE request SET (autovacuum_vacuum_scale_factor = 0.0);
+# ALTER TABLE request SET (autovacuum_vacuum_threshold = 5000);
+# ALTER TABLE request SET (autovacuum_analyze_scale_factor = 0.0);
+# ALTER TABLE request SET (autovacuum_analyze_threshold = 5000);
+
+class Request(Base):
+    __tablename__ = 'request'
+
+    id = db.Column(db.Integer(), primary_key=True)
+
+    key = db.Column(db.String(255),
+                    nullable=False)
+
+    session_id = db.Column(db.Integer(),
+                           db.ForeignKey('proxy_session.id',
+                                         ondelete='CASCADE'),
+                           nullable=False)
+
+    state = db.Column(db.JSON())
+    proxyserver = db.Column(db.String(50), nullable=False)
+    created_at = db.Column(db.DateTime(timezone=True), default=db.func.now())
+
+
+class Role(Base):
+    __tablename__ = 'roles'
+    id = db.Column(db.Integer(), primary_key=True)
+    name = db.Column(db.String(50), nullable=False, server_default=u'', unique=True)  # for @roles_accepted()
+    label = db.Column(db.Unicode(255), server_default=u'')  # for display purposes
+
+
+class UsersRoles(Base):
+    __tablename__ = 'users_roles'
+    id = db.Column(db.Integer(), primary_key=True)
+    user_id = db.Column(db.Integer(), db.ForeignKey('users.id', ondelete='CASCADE'))
+    role_id = db.Column(db.Integer(), db.ForeignKey('roles.id', ondelete='CASCADE'))
+
+
+class UserInvitation(Base):
+    __tablename__ = 'user_invite'
+    id = db.Column(db.Integer, primary_key=True)
+    email = db.Column(db.String(255), nullable=False)
+    # save the user of the invitee
+    invited_by_user_id = db.Column(db.Integer, db.ForeignKey('users.id'))
+    # token used for registration page to identify user registering
+    token = db.Column(db.String(100), nullable=False, server_default='')
+    created_at = db.Column(db.DateTime(timezone=True), default=db.func.now())

default.nix

@@ -0,0 +1,28 @@
+with import <nixpkgs> {};
+let
+  my-python-packages = python-packages: [
+    python-packages.pip
+    python-packages.setuptools
+  ];
+  my-python = python37.withPackages my-python-packages;
+in
+  pkgs.mkShell {
+    buildInputs = [
+      bashInteractive
+      my-python
+      libffi
+      openssl
+      libxml2
+      postgresql
+      libxslt
+      sass
+      nodejs
+    ];
+    shellHook = ''
+      export PATH=$PATH:"$(pwd)/.build/pip_packages/bin"
+      export PIP_PREFIX="$(pwd)/.build/pip_packages"
+      export PYTHONPATH="$(pwd)/.build/pip_packages/bin:$PYTHONPATH"
+      export PYTHONPATH="$(pwd)/.build/pip_packages/lib/python3.7/site-packages:$PYTHONPATH"
+      unset SOURCE_DATE_EPOCH
+    '';
+  }