release 0.0.1

Небольшой рефакторинг. Добавил функционал удаления временных файлов.
Добавил описания методов
This commit is contained in:
Fedorov Dmitriy
2026-08-28 19:44:24 +03:00
parent f3acfc2bbf
commit 97b7ba23db
5 changed files with 371 additions and 64 deletions
+130 -44
View File
@@ -33,6 +33,18 @@ class DSMWorker:
self.token: str | None = None
def auth_in_DSM(self, path_to_secret) -> bool:
"""
Выполняет авторизацию в Synology DSM.
После успешной авторизации сохраняет SID и SynoToken
для последующих запросов к API DSM.
Args:
path_to_secret: Путь к файлу с логином и паролем DSM.
Returns:
bool: True при успешной авторизации, иначе False.
"""
dsm_cred = ServiceFunctions.get_login_pass_from_file(path_to_secret)
if dsm_cred is None:
@@ -101,6 +113,17 @@ class DSMWorker:
def get_list_certs(self):
"""
Получает список сертификатов, установленных в DSM.
Для запроса используется текущая авторизованная сессия DSM.
Returns:
dict: Данные со списком сертификатов DSM.
None: Если пользователь не авторизован или запрос завершился
ошибкой.
"""
if not self.sid or not self.token:
logging.error("DSM authentication required")
return None
@@ -149,6 +172,22 @@ class DSMWorker:
return result.get("data")
def import_cert(self, dsm_info: DSMInfo) -> DSMInfo | None:
"""
Импортирует сертификат и приватный ключ в DSM.
Если сертификат с таким именем уже существует, его ID используется
для обновления существующего сертификата. В противном случае
создаётся новый сертификат.
Args:
dsm_info: Информация и пути к файлам сертификата,
подготовленным для DSM.
Returns:
DSMInfo: Переданный объект с заполненным ID сертификата DSM.
None: Если импорт завершился ошибкой.
"""
if not self.sid or not self.token:
logging.error("DSM authentication required")
return None
@@ -275,6 +314,17 @@ class DSMWorker:
def get_list_services(self, list_certs):
"""
Формирует список сервисов DSM и назначенных им сертификатов.
Args:
list_certs: Данные, полученные методом get_list_certs().
Returns:
list: Список сервисов с ID текущего сертификата.
None: Если данные о сертификатах отсутствуют или имеют
некорректный формат.
"""
services = []
if not list_certs:
@@ -296,9 +346,15 @@ class DSMWorker:
for certificate in certificates:
for service in certificate.get("services", []):
certificate_id = certificate.get("id")
if not certificate_id:
logging.warning("Certificate without ID found in DSM")
continue
services.append({
"service": service,
"old_id": certificate["id"],
"old_id": certificate_id,
"id": None,
})
@@ -306,6 +362,21 @@ class DSMWorker:
def set_cert_on_service(self, list_services, dsm_info: DSMInfo) -> bool:
"""
Назначает сертификат DSM соответствующему сервису.
Если сервис уже использует указанный сертификат, запрос к DSM
не выполняется.
Args:
list_services: Список сервисов DSM с текущими сертификатами.
dsm_info: Информация об импортированном сертификате,
включая его ID в DSM.
Returns:
bool: True, если сертификат успешно назначен сервису
или уже был назначен. False при ошибке.
"""
if not self.sid or not self.token:
logging.error("DSM authentication required")
@@ -407,51 +478,66 @@ class DSMWorker:
def logout_dsm(self) -> bool:
if not self.sid:
logging.info("DSM session is not active")
"""
Завершает текущую сессию DSM.
Выполняет выход из DSM по текущему SID и очищает данные
авторизации после успешного выхода.
Returns:
bool: True, если сессия успешно завершена или не была активна.
False, если DSM не удалось выполнить выход.
"""
try:
if not self.sid:
logging.info("DSM session is not active")
return True
url = f"{self.dsm_url}/webapi/entry.cgi"
params = {
"api": self.AUTH_API,
"version": self.AUTH_VERSION,
"method": "logout",
"_sid": self.sid,
}
try:
response = requests.get(
url,
params=params,
timeout=30,
verify=False,
)
response.raise_for_status()
except requests.RequestException as e:
logging.error(f"DSM logout request failed: {e}")
return False
try:
result = response.json()
except ValueError as e:
logging.error(f"DSM returned invalid JSON: {e}")
return False
if not result.get("success"):
error = result.get("error", {})
logging.error(
f"DSM logout failed: code={error.get('code')}"
)
return False
self.sid = None
self.token = None
logging.info("DSM session successfully closed")
return True
url = f"{self.dsm_url}/webapi/entry.cgi"
params = {
"api": self.AUTH_API,
"version": self.AUTH_VERSION,
"method": "logout",
"_sid": self.sid,
}
try:
response = requests.get(
url,
params=params,
timeout=30,
verify=False,
)
response.raise_for_status()
except requests.RequestException as e:
logging.error(f"DSM logout request failed: {e}")
return False
try:
result = response.json()
except ValueError as e:
logging.error(f"DSM returned invalid JSON: {e}")
return False
if not result.get("success"):
error = result.get("error", {})
logging.error(
f"DSM logout failed: code={error.get('code')}"
)
return False
self.sid = None
self.token = None
logging.info("DSM session successfully closed")
return True
finally:
self.sid = None
self.token = None