diff --git a/caddy_worker.py b/caddy_worker.py index 2bc1ad4..48af2e0 100644 --- a/caddy_worker.py +++ b/caddy_worker.py @@ -11,6 +11,22 @@ class CaddyWorker: @staticmethod def search_cert_caddy(path_to_caddy_certs, site_name): + """ + Ищет сертификат и приватный ключ Caddy для указанного домена. + + Ожидаемая структура: + // + .crt + .key + + Args: + path_to_caddy_certs: Путь к папке с сертификатами Caddy. + site_name: Имя домена, для которого выполняется поиск. + + Returns: + Path: Путь к файлу сертификата .crt. + None: Если папка, сертификат или приватный ключ не найдены. + """ directory = Path(path_to_caddy_certs) cert_folder = directory / site_name @@ -37,6 +53,21 @@ class CaddyWorker: @staticmethod def get_cert_info(path_to_crt_file) -> CertInfo | None: + """ + Читает сертификат и извлекает информацию о нём. + + Определяет Common Name, SHA-256 отпечаток, дату окончания + действия сертификата, путь к приватному ключу и папку Caddy. + + Args: + path_to_crt_file: Путь к PEM-файлу сертификата. + + Returns: + CertInfo: Информация о сертификате. + None: Если файл не найден, не удалось прочитать сертификат + или в сертификате отсутствует Common Name. + """ + cert_path = Path(path_to_crt_file) if not cert_path.is_file(): logging.error(f"Certificate file not found: {cert_path}") @@ -78,6 +109,23 @@ class CaddyWorker: @staticmethod def convert_to_dsm(path_to_dir_cert, path_to_save) -> DSMInfo | None: + """ + Подготавливает сертификат Caddy для импорта в DSM. + + Проверяет сертификат и приватный ключ, проверяет их соответствие, + разделяет цепочку сертификатов и сохраняет PEM-файлы во временную + папку. + + Args: + path_to_dir_cert: Путь к папке сертификата Caddy. + path_to_save: Путь к основной папке для сохранения данных + сертификатов. + + Returns: + DSMInfo: Пути к файлам, необходимым для импорта в DSM. + None: Если сертификат или ключ некорректны либо произошла + ошибка при подготовке файлов. + """ cert_dir = Path(path_to_dir_cert) save_dir = Path(path_to_save) / cert_dir.name / "tmp" @@ -115,7 +163,7 @@ class CaddyWorker: save_dir.mkdir(parents=True, exist_ok=True) cert_pem_path = save_dir / "cert.pem" - inter_pem_chain = save_dir / "fullchain.pem" + inter_pem_chain = save_dir / "path_inter_pem_chain.pem" try: diff --git a/dsm_worker.py b/dsm_worker.py index a5976a0..6795b6a 100644 --- a/dsm_worker.py +++ b/dsm_worker.py @@ -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 diff --git a/main.py b/main.py index 717e453..2b8aa9c 100644 --- a/main.py +++ b/main.py @@ -8,7 +8,19 @@ import shutil from structs import CertInfo, DSMAuthInfo def main(): + """ + Запускает основной процесс проверки и обновления сертификатов. + Последовательно: + - загружает настройки; + - удаляет данные неиспользуемых сертификатов; + - ищет сертификаты Caddy; + - определяет сертификаты, требующие обновления; + - при необходимости авторизуется в DSM; + - импортирует обновлённые сертификаты; + - назначает их соответствующим сервисам; + - завершает сессию DSM. + """ service_worker = ServiceFunctions() settings = service_worker.load_config() @@ -33,7 +45,7 @@ def main(): return #Получили все сертификаты которые нужнго обновить - if not dsm_worker.auth_in_DSM(Path(settings.credentials)): + if not dsm_worker.auth_in_DSM(settings.credentials): logging.error(f"Authentication in DSM failed") raise RuntimeError("Authentication in DSM failed") @@ -67,16 +79,24 @@ def main(): shutil.rmtree(path_to_dsm_cert) continue - dsm_info = dsm_worker.import_cert(pem_cert) - if not dsm_info: - logging.error(f"Error in import DSM certificate") - shutil.rmtree(path_to_dsm_cert) - continue + try: + dsm_info = dsm_worker.import_cert(pem_cert) - if not dsm_worker.set_cert_on_service(list_services, dsm_info): - logging.error(f"Set cert in DSM failed") - shutil.rmtree(path_to_dsm_cert) - continue + if not dsm_info: + logging.error("Error in import DSM certificate") + shutil.rmtree(path_to_dsm_cert) + continue + + if not dsm_worker.set_cert_on_service(list_services, dsm_info): + logging.error("Set cert in DSM failed") + shutil.rmtree(path_to_dsm_cert) + continue + + finally: + service_worker.remove_tmp_certificates( + settings.path_to_save_folder, + cert + ) finally: dsm_worker.logout_dsm() diff --git a/service_functions.py b/service_functions.py index a72fef4..43414cc 100644 --- a/service_functions.py +++ b/service_functions.py @@ -10,6 +10,21 @@ from caddy_worker import CaddyWorker class ServiceFunctions: def save_cert_info(self, cert_info: CertInfo, path_to_save_folder: Path): + """ + Сохраняет информацию о сертификате в JSON-файл. + + JSON используется для последующего сравнения сертификата Caddy + с ранее загруженным в DSM сертификатом. + + Args: + cert_info: Информация о сертификате Caddy. + path_to_save_folder: Папка для хранения информации + о сертификатах. + + Returns: + Path: Путь к папке с сохранённой информацией сертификата. + """ + data = asdict(cert_info) save_dir = path_to_save_folder / cert_info.dir_caddy_cert.name @@ -28,6 +43,21 @@ class ServiceFunctions: @staticmethod def get_login_pass_from_file(path_to_file: Path): + """ + Читает данные для авторизации в DSM из файла. + + Файл должен содержать параметры: + username=<логин> + password=<пароль> + + Args: + path_to_file: Путь к файлу с учётными данными. + + Returns: + DSMCredentials: Логин и пароль для авторизации. + None: Если файл не найден, не читается или отсутствует + логин либо пароль. + """ if not path_to_file.is_file(): logging.error(f"Secret file not found: {path_to_file}") @@ -68,6 +98,19 @@ class ServiceFunctions: def load_config(self): + """ + Загружает настройки приложения из файла config.conf. + + Читает список доменов и основные параметры приложения: + пути к сертификатам, файлу учётных данных, папке хранения + данных и URL DSM. + + Returns: + ApplSettings: Настройки приложения. + + Raises: + FileNotFoundError: Если файл config.conf не найден. + """ config_path = Path(__file__).parent / "config.conf" if not config_path.is_file(): @@ -77,13 +120,29 @@ class ServiceFunctions: config = ConfigParser(allow_no_value=True) config.read(config_path, encoding="utf-8") - domains = list(config["ListDomains"].keys()) + required_settings = [ + "pathToCredentials", + "pathToCaddyCert", + "pathToSaveFolder", + "urlNas", + ] + if not config.has_section("Settings"): + raise ValueError("Missing [Settings] section") + + for setting in required_settings: + if not config.has_option("Settings", setting): + raise ValueError( + f"Missing setting '{setting}' in [Settings]" + ) + + + domains = list(config["ListDomains"].keys()) appl_settings = ApplSettings( list_domains = domains, path_to_caddy_cert = Path(config.get("Settings", "pathToCaddyCert")), - credentials = config.get("Settings", "pathToCredentials"), + credentials = Path(config.get("Settings", "pathToCredentials")), path_to_save_folder = Path(config.get("Settings", "pathToSaveFolder")), nas_url = config.get("Settings", "urlNas"), ) @@ -91,6 +150,18 @@ class ServiceFunctions: def search_caddy_cert(self, path_to_caddy_cert: Path, list_domains: list): + """ + Ищет папки сертификатов для настроенных доменов Caddy. + + Args: + path_to_caddy_cert: Путь к папке с сертификатами Caddy. + list_domains: Список доменов из конфигурации. + + Returns: + list: Список доменов, для которых найдена папка сертификата. + None: Если папка Caddy не существует или список доменов пуст. + """ + update_certs = [] if not path_to_caddy_cert.is_dir(): @@ -114,6 +185,22 @@ class ServiceFunctions: @staticmethod def remove_unnecessary_dsm_certs(path_to_dsm_certs_data: Path, list_domains: list): + """ + Удаляет локальные данные сертификатов неиспользуемых доменов. + + Сравнивает существующие папки с сертификатами со списком доменов + из конфигурации и удаляет папки доменов, которых больше нет + в настройках. + + Args: + path_to_dsm_certs_data: Путь к папке с сохранёнными данными + сертификатов. + list_domains: Список актуальных доменов из конфигурации. + + Returns: + bool: True, если проверка и удаление завершились успешно. + False, если произошла ошибка. + """ if not path_to_dsm_certs_data.is_dir(): logging.error(f"DSM cert folder <{path_to_dsm_certs_data}> not found") @@ -145,6 +232,23 @@ class ServiceFunctions: def check_update_certs(self, path_to_dsm_certs_data: Path, path_to_caddy_certs: Path, candidates_update_certs: list): + """ + Определяет сертификаты Caddy, которые необходимо обновить в DSM. + + Для каждого домена сравнивает SHA-256 отпечаток текущего + сертификата Caddy с отпечатком, сохранённым после предыдущего + обновления. + + Args: + path_to_dsm_certs_data: Путь к локальным данным сертификатов, + загруженных в DSM. + path_to_caddy_certs: Путь к сертификатам Caddy. + candidates_update_certs: Список доменов, для которых найдены + сертификаты Caddy. + + Returns: + list: Список доменов, сертификаты которых требуют обновления. + """ if not path_to_dsm_certs_data.is_dir(): logging.error(f"Path to certs dir not found: {path_to_dsm_certs_data}") @@ -182,10 +286,26 @@ class ServiceFunctions: logging.error(f"Cert not found: {dsm_cert_info}") continue - with open(dsm_cert_info, "r", encoding='utf-8') as file: - data_dsm_cert = json.load(file) + try: + with open(dsm_cert_info, "r", encoding="utf-8") as file: + data_dsm_cert = json.load(file) + except (OSError, json.JSONDecodeError) as e: + logging.error( + f"Cannot read DSM certificate info {dsm_cert_info}: {e}" + ) + continue - if data_dsm_cert["domain_name"] != caddy_cert_info.domain_name: + domain_name = data_dsm_cert.get("domain_name") + fingerprint = data_dsm_cert.get("fingerprint") + + if not domain_name or not fingerprint: + logging.error( + f"Invalid certificate info file: {dsm_cert_info}" + ) + continue + + + if domain_name != caddy_cert_info.domain_name: logging.info( f"Cert DSM: {data_dsm_cert['domain_name']} " f"is not located in the caddy cert " @@ -193,7 +313,7 @@ class ServiceFunctions: ) continue - if data_dsm_cert["fingerprint"] != caddy_cert_info.fingerprint: + if fingerprint != caddy_cert_info.fingerprint: need_update_certs.append(cert) logging.info(f"Cert: {cert} added to update") else: @@ -201,3 +321,37 @@ class ServiceFunctions: return need_update_certs + @staticmethod + def remove_tmp_certificates(path_to_save_folder: Path, domain: str) -> bool: + """ + Удаляет временные файлы сертификата после завершения операции. + + Удаляется папка tmp конкретного домена, содержащая PEM-файлы, + подготовленные для импорта в DSM. + + Args: + path_to_save_folder: Основная папка для хранения данных + сертификатов. + domain: Домен, для которого удаляются временные файлы. + + Returns: + bool: True, если временная папка удалена или уже отсутствует. + False, если удалить папку не удалось. + """ + + tmp_dir = path_to_save_folder / domain / "tmp" + + if not tmp_dir.is_dir(): + logging.info(f"Temporary certificate folder not found: {tmp_dir}") + return True + + try: + shutil.rmtree(tmp_dir) + logging.info(f"Temporary certificate folder removed: {tmp_dir}") + return True + + except OSError as e: + logging.error( + f"Cannot remove temporary certificate folder {tmp_dir}: {e}" + ) + return False \ No newline at end of file diff --git a/structs.py b/structs.py index 9e1a10b..4bd9948 100644 --- a/structs.py +++ b/structs.py @@ -1,4 +1,3 @@ -from ast import List from dataclasses import dataclass from datetime import datetime from pathlib import Path @@ -33,8 +32,8 @@ class DSMCredentials: @dataclass class ApplSettings: - list_domains: List - credentials : str + list_domains: list[str] + credentials : Path path_to_caddy_cert: Path path_to_save_folder: Path nas_url: str \ No newline at end of file