From 0ab30d02a2c20b42c27d266f34ec29d82b76fb40 Mon Sep 17 00:00:00 2001
From: Mike Salvatore <mike.s.salvatore@gmail.com>
Date: Tue, 5 Jul 2022 11:02:27 -0400
Subject: [PATCH] Island: Add class docstring for ICredentialsRepository

---
 .../cc/repository/i_credentials_repository.py             | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/monkey/monkey_island/cc/repository/i_credentials_repository.py b/monkey/monkey_island/cc/repository/i_credentials_repository.py
index 769175301..74ab94628 100644
--- a/monkey/monkey_island/cc/repository/i_credentials_repository.py
+++ b/monkey/monkey_island/cc/repository/i_credentials_repository.py
@@ -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.