mirror of
https://github.com/quay/quay.git
synced 2026-01-27 18:42:52 +03:00
87 lines
2.9 KiB
Python
87 lines
2.9 KiB
Python
from abc import ABCMeta, abstractmethod, abstractproperty
|
|
|
|
from deprecation import deprecated
|
|
from six import add_metaclass
|
|
|
|
|
|
class InvalidConfigurationException(Exception):
|
|
"""
|
|
Exception raised when attempting to initialize a secscan model fails.
|
|
"""
|
|
|
|
|
|
@add_metaclass(ABCMeta)
|
|
class SecurityScannerInterface(object):
|
|
"""
|
|
Interface for code to work with the security scan data model.
|
|
|
|
This model encapsulates all access when speaking to an external security scanner, as well as any
|
|
data tracking in the database.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def load_security_information(
|
|
self, manifest_or_legacy_image, include_vulnerabilities=False, model_cache=None
|
|
):
|
|
"""
|
|
Loads the security information for the given manifest or legacy image, returning a
|
|
SecurityInformationLookupResult structure.
|
|
|
|
The manifest_or_legacy_image must be a Manifest or LegacyImage datatype from the
|
|
registry_model.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def perform_indexing(self, start_token=None, batch_size=None):
|
|
"""
|
|
Performs indexing of the next set of unindexed manifests/images.
|
|
|
|
If start_token is given, the indexing should resume from that point. Returns a new start
|
|
index for the next iteration of indexing. The tokens returned and given are assumed to be
|
|
opaque outside of this implementation and should not be relied upon by the caller to conform
|
|
to any particular format.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def perform_indexing_recent_manifests(self, batch_size=None):
|
|
"""
|
|
Performs indexing of a recent set of unindexed manifests/images.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def register_model_cleanup_callbacks(self, data_model_config):
|
|
"""
|
|
Registers any cleanup callbacks with the data model.
|
|
|
|
Typically, a callback is registered to remove the manifest/image from the security indexer
|
|
if it has been GCed in the data model.
|
|
"""
|
|
|
|
@abstractproperty
|
|
@deprecated(details="Only exposed for the legacy notification worker")
|
|
def legacy_api_handler(self):
|
|
"""
|
|
Exposes the legacy security scan API for legacy workers that need it or None if none.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def lookup_notification_page(self, notification_id, page_index=None):
|
|
"""
|
|
Performs the lookup of a page of results for an incoming notification from the security
|
|
scanner.
|
|
|
|
Returns a PaginatedNotificationResult or None if this engine doesn't support this method.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def process_notification_page(self, page_result):
|
|
"""
|
|
Processes the page of notification information given and yields UpdatedVulnerability's.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def mark_notification_handled(self, notification_id):
|
|
"""
|
|
Marks that a security notification from the scanner has been handled.
|
|
"""
|