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
+160 -6
View File
@@ -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