mainframe.models.orm

Attributes

package_rules

Classes

Base	Mixin class to indicate when mapping this class, also convert it to be
Status	Package status.
Scan	The scans.
OpenGrepScan	An isolated OpenGrep shadow scan for one canonical package scan.
DownloadURL	Download URLs.
Rule	YARA rules.
AlertingConfiguration	Durable alerting configuration shared by Mainframe clients.
Suppression	A durable package-version alert suppression.

Module Contents

class mainframe.models.orm.Base

Bases: sqlalchemy.orm.MappedAsDataclass, sqlalchemy.orm.DeclarativeBase

Mixin class to indicate when mapping this class, also convert it to be a dataclass.

See also

orm_declarative_native_dataclasses - complete background on SQLAlchemy native dataclass mapping

Added in version 2.0.

class mainframe.models.orm.Status(*args, **kwds)

Bases: enum.Enum

Package status.

QUEUED - Waiting to be sent to a worker PENDING - Waiting for a response from a worker FINISHED - Verdict received from worker FAILED - Something went wrong with the client when scanning this package

QUEUED = 'queued'

PENDING = 'pending'

FINISHED = 'finished'

FAILED = 'failed'

mainframe.models.orm.package_rules

class mainframe.models.orm.Scan

Bases: Base

The scans.

__tablename__: str = 'scans'

__table_args__

scan_id: sqlalchemy.orm.Mapped[uuid.UUID]

name: sqlalchemy.orm.Mapped[str]

version: sqlalchemy.orm.Mapped[str]

status: sqlalchemy.orm.Mapped[Status]

score: sqlalchemy.orm.Mapped[int | None]

inspector_url: sqlalchemy.orm.Mapped[str | None]

rules: sqlalchemy.orm.Mapped[list[Rule]]

download_urls: sqlalchemy.orm.Mapped[list[DownloadURL]]

queued_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

queued_by: sqlalchemy.orm.Mapped[str]

pending_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

pending_by: sqlalchemy.orm.Mapped[str | None]

attempt_count: sqlalchemy.orm.Mapped[int]

assignment_id: sqlalchemy.orm.Mapped[uuid.UUID | None]

dead_lettered_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

finished_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

finished_by: sqlalchemy.orm.Mapped[str | None]

reported_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

reported_by: sqlalchemy.orm.Mapped[str | None]

report_summary: sqlalchemy.orm.Mapped[str | None]

fail_reason: sqlalchemy.orm.Mapped[str | None]

commit_hash: sqlalchemy.orm.Mapped[str | None]

class mainframe.models.orm.OpenGrepScan

Bases: Base

An isolated OpenGrep shadow scan for one canonical package scan.

__tablename__: str = 'opengrep_scans'

__table_args__

scan_id: sqlalchemy.orm.Mapped[uuid.UUID]

status: sqlalchemy.orm.Mapped[Status]

alerted_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

queued_at: sqlalchemy.orm.Mapped[datetime.datetime]

queued_by: sqlalchemy.orm.Mapped[str]

pending_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

pending_by: sqlalchemy.orm.Mapped[str | None]

attempt_count: sqlalchemy.orm.Mapped[int]

assignment_id: sqlalchemy.orm.Mapped[uuid.UUID | None]

dead_lettered_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

finished_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

finished_by: sqlalchemy.orm.Mapped[str | None]

fail_reason: sqlalchemy.orm.Mapped[str | None]

commit_hash: sqlalchemy.orm.Mapped[str | None]

duration_ms: sqlalchemy.orm.Mapped[int | None]

findings: sqlalchemy.orm.Mapped[list[dict[str, Any]]]

publication_id: sqlalchemy.orm.Mapped[uuid.UUID | None]

publication_claimed_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

discord_alert_message_id: sqlalchemy.orm.Mapped[int | None]

discord_message_id: sqlalchemy.orm.Mapped[int | None]

discord_thread_id: sqlalchemy.orm.Mapped[int | None]

published_chunks: sqlalchemy.orm.Mapped[int]

published_at: sqlalchemy.orm.Mapped[datetime.datetime | None]

class mainframe.models.orm.DownloadURL

Bases: Base

Download URLs.

__tablename__: str = 'download_urls'

id: sqlalchemy.orm.Mapped[uuid.UUID]

scan_id: sqlalchemy.orm.Mapped[str]

url: sqlalchemy.orm.Mapped[str]

class mainframe.models.orm.Rule

Bases: Base

YARA rules.

__tablename__: str = 'rules'

id: sqlalchemy.orm.Mapped[uuid.UUID]

name: sqlalchemy.orm.Mapped[str]

class mainframe.models.orm.AlertingConfiguration

Bases: Base

Durable alerting configuration shared by Mainframe clients.

__tablename__: str = 'alerting_configuration'

__table_args__

id: sqlalchemy.orm.Mapped[int]

production_score_threshold: sqlalchemy.orm.Mapped[int]

updated_at: sqlalchemy.orm.Mapped[datetime.datetime]

updated_by: sqlalchemy.orm.Mapped[str]

class mainframe.models.orm.Suppression

Bases: Base

A durable package-version alert suppression.

__tablename__: str = 'suppressions'

__table_args__

suppression_id: sqlalchemy.orm.Mapped[uuid.UUID]

package_name: sqlalchemy.orm.Mapped[str]

package_version: sqlalchemy.orm.Mapped[str]

created_by: sqlalchemy.orm.Mapped[str]

updated_by: sqlalchemy.orm.Mapped[str]

rules: sqlalchemy.orm.Mapped[list[str] | None]

created_at: sqlalchemy.orm.Mapped[datetime.datetime]

updated_at: sqlalchemy.orm.Mapped[datetime.datetime]