diff --git a/backend/alembic.ini b/backend/alembic.ini new file mode 100644 index 0000000..18c99e2 --- /dev/null +++ b/backend/alembic.ini @@ -0,0 +1,149 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s +# Or organize into date-based subdirectories (requires recursive_version_locations = true) +# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be installed by adding +# `alembic[tz]` to the pip requirements. +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to /versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +sqlalchemy.url = sqlite:///./dmarq.db + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/backend/alembic/README b/backend/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/backend/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/backend/alembic/env.py b/backend/alembic/env.py new file mode 100644 index 0000000..918a1d7 --- /dev/null +++ b/backend/alembic/env.py @@ -0,0 +1,82 @@ +import os +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# Override sqlalchemy.url with DATABASE_URL environment variable when present +database_url = os.environ.get("DATABASE_URL") +if database_url: + config.set_main_option("sqlalchemy.url", database_url) + +# Import all models so that autogenerate can detect them +from app.core.database import Base # noqa: E402 +import app.models.domain # noqa: E402, F401 +import app.models.report # noqa: E402, F401 +import app.models.user # noqa: E402, F401 + +target_metadata = Base.metadata + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/backend/alembic/script.py.mako b/backend/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/backend/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/backend/alembic/versions/88b549786e2d_initial_schema.py b/backend/alembic/versions/88b549786e2d_initial_schema.py new file mode 100644 index 0000000..970975c --- /dev/null +++ b/backend/alembic/versions/88b549786e2d_initial_schema.py @@ -0,0 +1,159 @@ +"""initial schema + +Revision ID: 88b549786e2d +Revises: +Create Date: 2026-03-29 11:36:11.612752 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '88b549786e2d' +down_revision: Union[str, Sequence[str], None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('domains', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('active', sa.Boolean(), nullable=True), + sa.Column('dmarc_policy', sa.String(), nullable=True), + sa.Column('spf_record', sa.String(), nullable=True), + sa.Column('dkim_selectors', sa.String(), nullable=True), + sa.Column('verified', sa.Boolean(), nullable=True), + sa.Column('verification_token', sa.String(), nullable=True), + sa.Column('created_at', sa.DateTime(), nullable=True), + sa.Column('updated_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_domains_active'), 'domains', ['active'], unique=False) + op.create_index('ix_domains_active_verified', 'domains', ['active', 'verified'], unique=False) + op.create_index(op.f('ix_domains_created_at'), 'domains', ['created_at'], unique=False) + op.create_index(op.f('ix_domains_id'), 'domains', ['id'], unique=False) + op.create_index(op.f('ix_domains_name'), 'domains', ['name'], unique=True) + op.create_index('ix_domains_policy', 'domains', ['dmarc_policy'], unique=False) + op.create_index('ix_domains_updated', 'domains', ['updated_at'], unique=False) + op.create_index(op.f('ix_domains_verified'), 'domains', ['verified'], unique=False) + op.create_table('users', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('email', sa.String(), nullable=False), + sa.Column('hashed_password', sa.String(), nullable=False), + sa.Column('is_active', sa.Boolean(), nullable=True), + sa.Column('is_superuser', sa.Boolean(), nullable=True), + sa.Column('is_verified', sa.Boolean(), nullable=True), + sa.Column('full_name', sa.String(), nullable=True), + sa.Column('organization', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_users_email'), 'users', ['email'], unique=True) + op.create_index(op.f('ix_users_id'), 'users', ['id'], unique=False) + op.create_table('dmarc_reports', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('domain_id', sa.Integer(), nullable=False), + sa.Column('report_id', sa.String(), nullable=False), + sa.Column('org_name', sa.String(), nullable=False), + sa.Column('begin_date', sa.Integer(), nullable=False), + sa.Column('end_date', sa.Integer(), nullable=False), + sa.Column('source_email', sa.String(), nullable=True), + sa.Column('policy', sa.String(), nullable=True), + sa.Column('subdomain_policy', sa.String(), nullable=True), + sa.Column('adkim', sa.String(length=1), nullable=True), + sa.Column('aspf', sa.String(length=1), nullable=True), + sa.Column('percentage', sa.Integer(), nullable=True), + sa.Column('processed_at', sa.DateTime(), nullable=True), + sa.Column('raw_data', sa.Text(), nullable=True), + sa.ForeignKeyConstraint(['domain_id'], ['domains.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_dmarc_reports_begin_date'), 'dmarc_reports', ['begin_date'], unique=False) + op.create_index('ix_dmarc_reports_domain_dates', 'dmarc_reports', ['domain_id', 'begin_date', 'end_date'], unique=False) + op.create_index(op.f('ix_dmarc_reports_domain_id'), 'dmarc_reports', ['domain_id'], unique=False) + op.create_index(op.f('ix_dmarc_reports_end_date'), 'dmarc_reports', ['end_date'], unique=False) + op.create_index(op.f('ix_dmarc_reports_id'), 'dmarc_reports', ['id'], unique=False) + op.create_index(op.f('ix_dmarc_reports_org_name'), 'dmarc_reports', ['org_name'], unique=False) + op.create_index('ix_dmarc_reports_policy', 'dmarc_reports', ['policy'], unique=False) + op.create_index('ix_dmarc_reports_processed', 'dmarc_reports', ['processed_at'], unique=False) + op.create_index(op.f('ix_dmarc_reports_report_id'), 'dmarc_reports', ['report_id'], unique=False) + op.create_table('user_domains', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('user_id', sa.Integer(), nullable=False), + sa.Column('domain_id', sa.Integer(), nullable=False), + sa.Column('role', sa.String(), nullable=False), + sa.Column('created_at', sa.DateTime(), nullable=True), + sa.ForeignKeyConstraint(['domain_id'], ['domains.id'], ), + sa.ForeignKeyConstraint(['user_id'], ['users.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_user_domains_id'), 'user_domains', ['id'], unique=False) + op.create_table('report_records', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('report_id', sa.Integer(), nullable=False), + sa.Column('source_ip', sa.String(), nullable=False), + sa.Column('count', sa.Integer(), nullable=False), + sa.Column('disposition', sa.String(), nullable=False), + sa.Column('dkim', sa.String(), nullable=True), + sa.Column('spf', sa.String(), nullable=True), + sa.Column('header_from', sa.String(), nullable=True), + sa.Column('envelope_from', sa.String(), nullable=True), + sa.Column('dkim_auth_details', sa.Text(), nullable=True), + sa.Column('spf_auth_details', sa.Text(), nullable=True), + sa.ForeignKeyConstraint(['report_id'], ['dmarc_reports.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_report_records_disposition', 'report_records', ['disposition', 'count'], unique=False) + op.create_index(op.f('ix_report_records_dkim'), 'report_records', ['dkim'], unique=False) + op.create_index(op.f('ix_report_records_header_from'), 'report_records', ['header_from'], unique=False) + op.create_index(op.f('ix_report_records_id'), 'report_records', ['id'], unique=False) + op.create_index(op.f('ix_report_records_report_id'), 'report_records', ['report_id'], unique=False) + op.create_index('ix_report_records_source_auth', 'report_records', ['source_ip', 'dkim', 'spf'], unique=False) + op.create_index(op.f('ix_report_records_source_ip'), 'report_records', ['source_ip'], unique=False) + op.create_index(op.f('ix_report_records_spf'), 'report_records', ['spf'], unique=False) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_report_records_spf'), table_name='report_records') + op.drop_index(op.f('ix_report_records_source_ip'), table_name='report_records') + op.drop_index('ix_report_records_source_auth', table_name='report_records') + op.drop_index(op.f('ix_report_records_report_id'), table_name='report_records') + op.drop_index(op.f('ix_report_records_id'), table_name='report_records') + op.drop_index(op.f('ix_report_records_header_from'), table_name='report_records') + op.drop_index(op.f('ix_report_records_dkim'), table_name='report_records') + op.drop_index('ix_report_records_disposition', table_name='report_records') + op.drop_table('report_records') + op.drop_index(op.f('ix_user_domains_id'), table_name='user_domains') + op.drop_table('user_domains') + op.drop_index(op.f('ix_dmarc_reports_report_id'), table_name='dmarc_reports') + op.drop_index('ix_dmarc_reports_processed', table_name='dmarc_reports') + op.drop_index('ix_dmarc_reports_policy', table_name='dmarc_reports') + op.drop_index(op.f('ix_dmarc_reports_org_name'), table_name='dmarc_reports') + op.drop_index(op.f('ix_dmarc_reports_id'), table_name='dmarc_reports') + op.drop_index(op.f('ix_dmarc_reports_end_date'), table_name='dmarc_reports') + op.drop_index(op.f('ix_dmarc_reports_domain_id'), table_name='dmarc_reports') + op.drop_index('ix_dmarc_reports_domain_dates', table_name='dmarc_reports') + op.drop_index(op.f('ix_dmarc_reports_begin_date'), table_name='dmarc_reports') + op.drop_table('dmarc_reports') + op.drop_index(op.f('ix_users_id'), table_name='users') + op.drop_index(op.f('ix_users_email'), table_name='users') + op.drop_table('users') + op.drop_index(op.f('ix_domains_verified'), table_name='domains') + op.drop_index('ix_domains_updated', table_name='domains') + op.drop_index('ix_domains_policy', table_name='domains') + op.drop_index(op.f('ix_domains_name'), table_name='domains') + op.drop_index(op.f('ix_domains_id'), table_name='domains') + op.drop_index(op.f('ix_domains_created_at'), table_name='domains') + op.drop_index('ix_domains_active_verified', table_name='domains') + op.drop_index(op.f('ix_domains_active'), table_name='domains') + op.drop_table('domains') + # ### end Alembic commands ### diff --git a/backend/app/models/domain.py b/backend/app/models/domain.py index 9c61c91..448d373 100644 --- a/backend/app/models/domain.py +++ b/backend/app/models/domain.py @@ -17,7 +17,7 @@ class Domain(Base): active = Column(Boolean, default=True, index=True) # DMARC policy information - dmarc_policy = Column(String, nullable=True, index=True) + dmarc_policy = Column(String, nullable=True) spf_record = Column(String, nullable=True) dkim_selectors = Column(String, nullable=True) # Comma-separated list of DKIM selectors diff --git a/backend/app/models/report.py b/backend/app/models/report.py index 3099054..e8df9ac 100644 --- a/backend/app/models/report.py +++ b/backend/app/models/report.py @@ -29,7 +29,7 @@ class DMARCReport(Base): percentage = Column(Integer, nullable=True) # Processing metadata - processed_at = Column(DateTime, default=datetime.utcnow, index=True) + processed_at = Column(DateTime, default=datetime.utcnow) raw_data = Column(Text, nullable=True) # Original XML content (optional) # Relationships