Island: Add class docstring for ICredentialsRepository

This commit is contained in:
Mike Salvatore 2022-07-05 11:02:27 -04:00
parent 64e548957f
commit 0ab30d02a2
1 changed files with 8 additions and 0 deletions

View File

@ -5,6 +5,14 @@ from monkey_island.cc.services.telemetry.processing.credentials import Credentia
class ICredentialsRepository(ABC):
"""
Store credentials that can be used to propagate around the network.
This repository stores credentials that were either "configured" or "stolen". "Configured"
credentials are provided to the simulation as input. "Stolen" credentials are collected during
a simulation.
"""
def get_configured_credentials(self) -> Sequence[Credentials]:
"""
Retrieve credentials that were configured.