diff --git a/.gitea/workflows/ansible-lint.yml b/.gitea/workflows/ansible-lint.yml index e15b8b6..5a7cb48 100644 --- a/.gitea/workflows/ansible-lint.yml +++ b/.gitea/workflows/ansible-lint.yml @@ -29,7 +29,9 @@ jobs: bash -n ansible/ci/deploy-machine.sh python3 -m py_compile ansible/ci/ansible-plan.py \ ansible/roles/core-net/remnawave/files/sync_remnawave.py \ - ansible/roles/rus-central/netbird/files/sync_access.py + ansible/roles/rus-central/netbird/files/sync_access.py \ + ansible/roles/opnsense/xray/files/vless_to_outbound.py \ + ansible/roles/opnsense/xray/files/sync_xray.py cd ansible ansible-playbook --syntax-check -i inventories/prod/hosts.yml playbooks/*.yml diff --git a/ansible/roles/opnsense/xray/files/sync_xray.py b/ansible/roles/opnsense/xray/files/sync_xray.py new file mode 100644 index 0000000..c721a20 --- /dev/null +++ b/ansible/roles/opnsense/xray/files/sync_xray.py @@ -0,0 +1,194 @@ +#!/usr/bin/env python3 +"""Идемпотентная синхронизация подписок Xray на OPNsense (os-xray API).""" + +from __future__ import annotations + +import base64 +import json +import os +import ssl +import sys +import urllib.error +import urllib.request +from typing import Any + +from vless_to_outbound import convert_vless + + +class OPNsenseXrayAPI: + """Минимальный клиент API плагина os-xray на OPNsense.""" + + def __init__(self, host: str, key: str, secret: str) -> None: + self.base_url = f"https://{host}/api/xray" + creds = base64.b64encode(f"{key}:{secret}".encode("utf-8")).decode("ascii") + self.auth_header = f"Basic {creds}" + self.ctx = ssl.create_default_context() + self.ctx.check_hostname = False + self.ctx.verify_mode = ssl.CERT_NONE + + def request(self, method: str, path: str, payload: dict[str, Any] | None = None) -> Any: + data = None + headers = {"Authorization": self.auth_header} + if payload is not None: + data = json.dumps(payload, ensure_ascii=False).encode("utf-8") + headers["Content-Type"] = "application/json" + + req = urllib.request.Request(f"{self.base_url}{path}", data=data, headers=headers, method=method) + try: + with urllib.request.urlopen(req, context=self.ctx, timeout=30) as resp: + raw = resp.read().decode("utf-8", errors="replace") + return json.loads(raw) if raw.strip() else {} + except urllib.error.HTTPError as exc: + body = exc.read().decode("utf-8", errors="replace") + raise RuntimeError(f"OPNsense API {method} {path} -> HTTP {exc.code}: {body}") from exc + + +def _selected_option(field: Any) -> str: + if isinstance(field, dict): + for k, v in field.items(): + if isinstance(v, dict) and v.get("selected") == 1: + return str(k) + return str(field or "") + + +def _has_drift(cur: dict[str, Any], want: dict[str, Any]) -> bool: + try: + cur_out = json.loads(cur.get("outbound_config") or "{}") + want_out = json.loads(want["outbound_config"]) + if cur_out != want_out: + return True + except json.JSONDecodeError: + if (cur.get("outbound_config") or "") != want["outbound_config"]: + return True + + return ( + cur.get("name") != want["name"] + or str(cur.get("enabled", "")) != str(want["enabled"]) + or (cur.get("socks5_listen") or "") != want["socks5_listen"] + or str(cur.get("socks5_port", "")) != str(want["socks5_port"]) + or (cur.get("tun_interface") or "") != want["tun_interface"] + or str(cur.get("mtu", "")) != str(want["mtu"]) + or (cur.get("bypass_networks") or "") != want["bypass_networks"] + or _selected_option(cur.get("loglevel")) != want["loglevel"] + ) + + +def main() -> int: + cfg = json.load(sys.stdin) + api_key = os.environ.get("OPNSENSE_API_KEY", "").strip() + api_secret = os.environ.get("OPNSENSE_API_SECRET", "").strip() + if not api_key or not api_secret: + print("Отсутствуют OPNSENSE_API_KEY / OPNSENSE_API_SECRET", file=sys.stderr) + return 1 + + instances = cfg.get("instances", []) + active_list = [i for i in instances if i.get("active")] + if len(active_list) != 1: + print("В instances.yml должна быть ровно одна подписка с active: true.", file=sys.stderr) + return 1 + active_name = active_list[0]["name"] + + desired: list[dict[str, Any]] = [] + for inst in instances: + link = os.environ.get(inst["secret"], "").strip() + if not link: + print(f"Подписка {inst['name']}: нет ссылки в Infisical (ключ {inst['secret']})", file=sys.stderr) + return 1 + try: + outbound = convert_vless(link) + except ValueError as exc: + print(f"Подписка {inst['name']}: {exc}", file=sys.stderr) + return 1 + desired.append( + { + "enabled": "1" if inst.get("active") else "0", + "name": inst["name"], + "outbound_config": outbound, + "socks5_listen": cfg["socks5_listen"], + "socks5_port": str(cfg["socks5_port"]), + "tun_interface": cfg["tun_interface"], + "mtu": str(cfg["mtu"]), + "bypass_networks": cfg["bypass_networks"], + "loglevel": cfg["loglevel"], + } + ) + + api = OPNsenseXrayAPI(cfg["opnsense_host"], api_key, api_secret) + current_rows = api.request("GET", "/instance/searchItem").get("rows") or [] + by_name = {r["name"]: r for r in current_rows if r.get("name")} + desired_names = {d["name"] for d in desired} + + stale = [r for r in current_rows if r.get("name") not in desired_names] + prev_active_stale = [r for r in stale if str(r.get("enabled")) == "1"] + + changes: list[str] = [] + for r in prev_active_stale: + api.request("POST", f"/instance/toggleItem/{r['uuid']}/0", {}) + changes.append(f"disabled stale {r['name']}") + + active_uuid = "" + for want in desired: + name = want["name"] + existing = by_name.get(name) + if not existing: + added = api.request("POST", "/instance/addItem", {"instance": want}) + uid = added.get("uuid", "") + changes.append(f"added {name}") + else: + uid = existing["uuid"] + cur = api.request("GET", f"/instance/getItem/{uid}").get("instance") or {} + if _has_drift(cur, want): + api.request("POST", f"/instance/setItem/{uid}", {"instance": want}) + changes.append(f"updated {name}") + if name == active_name: + active_uuid = uid + + if not active_uuid: + print("Активная подписка не найдена в OPNsense после синхронизации.", file=sys.stderr) + return 1 + + restart_needed = len(changes) > 0 + test_message = "не запускался (без изменений)" + test_ok = True + + if restart_needed: + val = api.request("POST", f"/service/validate/{active_uuid}", {}) + if val.get("result") != "ok": + print(f"xray -test отклонил конфиг активной подписки: {val.get('message')}", file=sys.stderr) + return 1 + api.request("POST", "/service/reconfigure", {}) + test = api.request("POST", f"/service/testconnect/{active_uuid}", {}) + test_ok = test.get("result") == "ok" + test_message = test.get("message") or str(test.get("result") or "") + if not test_ok and prev_active_stale: + for r in prev_active_stale: + api.request("POST", f"/instance/toggleItem/{r['uuid']}/1", {}) + api.request("POST", "/service/reconfigure", {}) + print(f"testconnect не прошёл ({test_message}), выполнен откат на прежнюю подписку", file=sys.stderr) + return 1 + + if not restart_needed or test_ok: + for r in stale: + api.request("POST", f"/instance/delItem/{r['uuid']}", {}) + changes.append(f"deleted stale {r['name']}") + + status_resp = api.request("GET", f"/service/status/{active_uuid}") + print( + json.dumps( + { + "changed": len(changes) > 0, + "changes": changes, + "instances": [d["name"] for d in desired], + "active": active_name, + "service_status": status_resp.get("status", "?"), + "restart_needed": restart_needed, + "test_message": test_message, + }, + ensure_ascii=False, + ) + ) + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/ansible/roles/opnsense/xray/files/vless_to_outbound.py b/ansible/roles/opnsense/xray/files/vless_to_outbound.py index 2ca157f..ff629f7 100755 --- a/ansible/roles/opnsense/xray/files/vless_to_outbound.py +++ b/ansible/roles/opnsense/xray/files/vless_to_outbound.py @@ -13,11 +13,11 @@ import sys from urllib.parse import unquote, urlparse, parse_qs -def main() -> None: - link = sys.argv[1] if len(sys.argv) > 1 else sys.stdin.read() +def convert_vless(link: str) -> str: + """Конвертирует vless:// ссылку в компактный JSON outbound-объекта.""" link = link.strip().strip("\"'") if not link.startswith("vless://"): - sys.exit("error: link must start with vless://") + raise ValueError("link must start with vless://") parsed = urlparse(link) uuid = parsed.username @@ -26,7 +26,7 @@ def main() -> None: params = {k: v[0] for k, v in parse_qs(parsed.query).items()} if not uuid or not host or not port: - sys.exit("error: link must look like vless://uuid@host:port?...") + raise ValueError("link must look like vless://uuid@host:port?...") network = params.get("type", "tcp") security = params.get("security", "reality") @@ -82,8 +82,16 @@ def main() -> None: if t or network == "grpc": ss[transport_key] = t - json.dump(outbound, sys.stdout, separators=(",", ":"), ensure_ascii=False) - sys.stdout.write("\n") + return json.dumps(outbound, separators=(",", ":"), ensure_ascii=False) + + +def main() -> None: + link = sys.argv[1] if len(sys.argv) > 1 else sys.stdin.read() + try: + out = convert_vless(link) + except ValueError as exc: + sys.exit(f"error: {exc}") + sys.stdout.write(out + "\n") if __name__ == "__main__": diff --git a/ansible/roles/opnsense/xray/tasks/main.yml b/ansible/roles/opnsense/xray/tasks/main.yml index 1118d25..a71be12 100644 --- a/ansible/roles/opnsense/xray/tasks/main.yml +++ b/ansible/roles/opnsense/xray/tasks/main.yml @@ -1,6 +1,6 @@ --- # Синхронизация подписок Xray на OPNsense с файлом instances.yml. -# Управление через API плагина os-xray (/api/xray/...), как в роли opnsense/netbird. +# Логика сравнения, валидации, testconnect и отката — в files/sync_xray.py. - name: Проверить обязательные секреты OPNsense ansible.builtin.assert: @@ -13,298 +13,50 @@ ansible.builtin.set_fact: xray_wanted: "{{ lookup('file', role_path ~ '/files/instances.yml') | from_yaml }}" -- name: Проверить, что активна ровно одна подписка - ansible.builtin.assert: - that: - - (xray_wanted.instances | selectattr('active') | list | length) == 1 - fail_msg: "В instances.yml должна быть ровно одна подписка с active: true." +- name: Подготовить окружение с VLESS-ссылками подписок + ansible.builtin.set_fact: + xray_sync_env: + OPNSENSE_API_KEY: "{{ opnsense_api_key }}" + OPNSENSE_API_SECRET: "{{ opnsense_api_secret }}" + no_log: true -- name: Сконвертировать ссылки в outbound_config - ansible.builtin.command: python3 {{ role_path }}/files/vless_to_outbound.py - args: - stdin: "{{ lookup('env', item.secret, default='') }}" - register: xray_conv +- name: Добавить секреты подписок в окружение sync_xray.py + ansible.builtin.set_fact: + xray_sync_env: "{{ xray_sync_env | combine({item.secret: lookup('env', item.secret, default='')}) }}" loop: "{{ xray_wanted.instances }}" loop_control: label: "{{ item.name }}" - changed_when: false no_log: true -- name: Проверить наличие ссылок и конвертацию - ansible.builtin.assert: - that: - - item.1.rc == 0 - fail_msg: >- - Подписка {{ item.0.name }}: нет ссылки в Infisical /services/opnsense-xray - (ключ {{ item.0.secret }}) или она не конвертируется. Проверьте секрет и формат vless://. - loop: "{{ xray_wanted.instances | zip(xray_conv.results) | list }}" - loop_control: - label: "{{ item.0.name }}" - no_log: true - -- name: Сформировать желаемое состояние - ansible.builtin.set_fact: - xray_desired: "{{ xray_desired | default([]) + [ { 'name': item.0.name, 'active': item.0.active | bool, 'outbound': item.1.stdout } ] }}" - loop: "{{ xray_wanted.instances | zip(xray_conv.results) | list }}" - loop_control: - label: "{{ item.0.name }}" - no_log: true - -- name: Получить текущие инстансы из OPNsense - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/searchItem" - method: GET - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - status_code: [200] - register: xray_current - -- name: Отобрать лишние инстансы (нет в instances.yml) - ansible.builtin.set_fact: - xray_stale: "{{ xray_current.json.rows | default([]) | rejectattr('name', 'in', xray_desired | map(attribute='name') | list) | list }}" - -- name: Отметить текущую активную подписку (для отката) - ansible.builtin.set_fact: - xray_prev_active: "{{ xray_current.json.rows | default([]) | selectattr('enabled', 'equalto', '1') | map(attribute='name') | list }}" - -- name: Отключить лишние активные инстансы - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/toggleItem/{{ item.uuid }}/0" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - loop: "{{ xray_stale | selectattr('enabled', 'equalto', '1') | list }}" - loop_control: - label: "{{ item.name }}" - register: xray_toggle_stale - changed_when: true - -- name: Прочитать полные поля существующих инстансов - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/getItem/{{ item.uuid }}" - method: GET - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - status_code: [200] - loop: "{{ xray_current.json.rows | default([]) | selectattr('name', 'in', xray_desired | map(attribute='name') | list) | list }}" - loop_control: - label: "{{ item.name }}" - register: xray_existing - -- name: Сформировать payload инстансов - ansible.builtin.set_fact: - xray_payloads: "{{ xray_payloads | default({}) | combine({ item.name: { 'enabled': '1' if item.active else '0', 'name': item.name, 'outbound_config': item.outbound, 'socks5_listen': xray_socks5_listen, 'socks5_port': xray_socks5_port, 'tun_interface': xray_tun_interface, 'mtu': xray_mtu, 'bypass_networks': xray_bypass_networks, 'loglevel': xray_loglevel } }) }}" - loop: "{{ xray_desired }}" - loop_control: - label: "{{ item.name }}" - no_log: true - -- name: Добавить новые подписки - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/addItem" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: - instance: "{{ xray_payloads[item.name] }}" - status_code: [200] - loop: "{{ xray_desired | rejectattr('name', 'in', xray_current.json.rows | default([]) | map(attribute='name') | list) | list }}" - loop_control: - label: "{{ item.name }}" - register: xray_added - changed_when: true - no_log: true - -- name: Обновить изменённые подписки - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/setItem/{{ item.0.uuid }}" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: - instance: "{{ xray_payloads[item.0.name] }}" - status_code: [200] +- name: Синхронизировать подписки Xray на OPNsense + ansible.builtin.command: "python3 {{ role_path }}/files/sync_xray.py" + args: + stdin: "{{ xray_sync_cfg | to_json }}" vars: - cur: "{{ item.1.json.instance }}" - want: "{{ xray_payloads[item.0.name] }}" - # loglevel — OptionField: getItem отдаёт не строку, а список опций - # с флагами selected. Вытаскиваем ключ выбранной опции. - cur_loglevel_sel: "{{ cur.loglevel | dict2items | default([]) | selectattr('value.selected', 'equalto', 1) | map(attribute='key') | list }}" - cur_loglevel: "{{ cur_loglevel_sel[0] if cur_loglevel_sel | length > 0 else '' }}" - drift: >- - {{ (cur.outbound_config | default('') | from_json) != (want.outbound_config | from_json) - or cur.name != want.name - or (cur.enabled | string) != want.enabled - or (cur.socks5_listen | default('')) != want.socks5_listen - or (cur.socks5_port | string) != want.socks5_port - or (cur.tun_interface | default('')) != want.tun_interface - or (cur.mtu | string) != want.mtu - or (cur.bypass_networks | default('')) != want.bypass_networks - or cur_loglevel != want.loglevel }} - loop: "{{ xray_current.json.rows | default([]) | selectattr('name', 'in', xray_desired | map(attribute='name') | list) | list | zip(xray_existing.results) | list }}" - loop_control: - label: "{{ item.0.name }}" - register: xray_updated - when: drift - changed_when: true + xray_sync_cfg: + opnsense_host: "{{ opnsense_host }}" + instances: "{{ xray_wanted.instances }}" + socks5_listen: "{{ xray_socks5_listen }}" + socks5_port: "{{ xray_socks5_port }}" + tun_interface: "{{ xray_tun_interface }}" + mtu: "{{ xray_mtu }}" + bypass_networks: "{{ xray_bypass_networks }}" + loglevel: "{{ xray_loglevel }}" + environment: "{{ xray_sync_env }}" + register: xray_sync_raw + changed_when: (xray_sync_raw.stdout | from_json).changed no_log: true -- name: Записать флаг необходимости перезапуска +- name: Разобрать итог синхронизации подписок Xray ansible.builtin.set_fact: - xray_restart_needed: "{{ xray_toggle_stale is changed or xray_added is changed or xray_updated is changed }}" - -- name: Определить uuid активной подписки - ansible.builtin.set_fact: - xray_active_uuid: "{{ uuid }}" - vars: - # first на пустой последовательности — фатальная ошибка, поэтому list + индекс - active_name: "{{ xray_desired | selectattr('active') | map(attribute='name') | first }}" - all_uuids: "{{ (xray_added.results | default([]) | selectattr('item.name', 'equalto', active_name) | map(attribute='json.uuid') | list) - + (xray_current.json.rows | default([]) | selectattr('name', 'equalto', active_name) | map(attribute='uuid') | list) }}" - uuid: "{{ all_uuids[0] if all_uuids | length > 0 else '' }}" - -- name: Проверить, что активная подписка найдена в OPNsense - ansible.builtin.assert: - that: - - xray_active_uuid | length > 0 - fail_msg: "Активная подписка не найдена в OPNsense после синхронизации инстансов." - -- name: Провалидировать конфиг активной подписки - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/service/validate/{{ xray_active_uuid }}" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - register: xray_validate - when: xray_restart_needed - -- name: Остановить при невалидном конфиге - ansible.builtin.assert: - that: - - xray_validate.json.result == 'ok' - fail_msg: "xray -test отклонил конфиг активной подписки: {{ xray_validate.json.message }}" - when: xray_restart_needed - -- name: Переконфигурировать сервис Xray - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/service/reconfigure" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - register: xray_reconfigure - when: xray_restart_needed - changed_when: true - -- name: Проверить соединение активной подписки - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/service/testconnect/{{ xray_active_uuid }}" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - register: xray_test - when: xray_restart_needed - -- name: Откатить переключение при нерабочем соединении - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/toggleItem/{{ item.uuid }}/1" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - loop: "{{ xray_current.json.rows | default([]) | selectattr('enabled', 'equalto', '1') | selectattr('name', 'in', xray_stale | map(attribute='name') | list) | list }}" - loop_control: - label: "{{ item.name }}" - when: - - xray_restart_needed - - xray_test.json.result | default('') != 'ok' - - xray_prev_active | length > 0 - changed_when: true - -- name: Снова включить прежнюю активную подписку (откат) - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/service/reconfigure" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - when: - - xray_restart_needed - - xray_test.json.result | default('') != 'ok' - - xray_prev_active | length > 0 - changed_when: true - -- name: Удалить лишние инстансы после успешного переключения - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/instance/delItem/{{ item.uuid }}" - method: POST - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - body_format: json - body: {} - status_code: [200] - loop: "{{ xray_stale }}" - loop_control: - label: "{{ item.name }}" - when: - - not xray_restart_needed or (xray_test.json.result | default('ok')) == 'ok' - changed_when: true - -- name: Проверить статус сервиса Xray - ansible.builtin.uri: - url: "https://{{ opnsense_host }}/api/xray/service/status/{{ xray_active_uuid }}" - method: GET - url_username: "{{ opnsense_api_key }}" - url_password: "{{ opnsense_api_secret }}" - force_basic_auth: true - validate_certs: false - status_code: [200] - register: xray_status + xray_sync: "{{ xray_sync_raw.stdout | from_json }}" - name: Итог синхронизации подписок Xray ansible.builtin.debug: msg: - - "Подписки: {{ xray_desired | map(attribute='name') | join(', ') }}" - - "Активна: {{ xray_desired | selectattr('active') | map(attribute='name') | first }}" - - "Статус сервиса: {{ xray_status.json.status | default('?') }}" - - "Перезапуск выполнен: {{ xray_restart_needed }}" - - "Тест соединения: {{ xray_test.json.message if xray_restart_needed else 'не запускался (без изменений)' }}" + - "Подписки: {{ xray_sync.instances | join(', ') }}" + - "Активна: {{ xray_sync.active }}" + - "Статус сервиса: {{ xray_sync.service_status }}" + - "Изменения: {{ xray_sync.changes }}" + - "Перезапуск выполнен: {{ xray_sync.restart_needed }}" + - "Тест соединения: {{ xray_sync.test_message }}"