feat(opnsense): синхронизировать подписки Xray через API плагина os-xray
ansible-core-mon / deploy (push) Successful in 26s
ansible-core-net / deploy (push) Successful in 52s
ansible-core-secrets / deploy (push) Successful in 16s
ansible-ger-nod-02 / deploy (push) Successful in 1m21s
ansible-opnsense / deploy (push) Failing after 5s
ansible-rus-central / deploy (push) Successful in 51s

- роль opnsense/xray: instances.yml как источник правды, ссылки vless://
  из Infisical /services/opnsense-xray, конвертер в outbound_config,
  переключение активной подписки с validate/testconnect и откатом
- deploy-machine.sh: выгрузка /services/opnsense-xray для машины opnsense
- временный workflow xray-secrets-seed для первичного сидинга ссылок
This commit is contained in:
karpenok committed 2026-11-12 21:26:56 +07:00
1 parent 32194a55a1
commit 21f106993f
7 files changed
+472

No files matched your search

+47
View File
@@ -0,0 +1,47 @@
# ВРЕМЕННЫЙ workflow: разовый сидинг VLESS-ссылок в Infisical /services/opnsense-xray.
# Ссылки приходят из репозиторных секретов XRAY_SEED_* (в логах маскируются).
# После успешного прогона workflow и секреты удаляются.
name: xray-secrets-seed
on:
workflow_dispatch:
jobs:
seed:
runs-on: homelab
container:
image: homelab-ansible:latest
timeout-minutes: 10
steps:
- name: Записать VLESS-ссылки в Infisical
env:
INFISICAL_CLIENT_ID: ${{ secrets.INFISICAL_CLIENT_ID }}
INFISICAL_CLIENT_SECRET: ${{ secrets.INFISICAL_CLIENT_SECRET }}
FIN_01: ${{ secrets.XRAY_SEED_FIN_01 }}
GERM_01: ${{ secrets.XRAY_SEED_GERM_01 }}
GERM_02: ${{ secrets.XRAY_SEED_GERM_02 }}
run: |
set -euo pipefail
export INFISICAL_PROJECT_ID="806e7f09-5838-492a-946b-2d69b96876ab"
export INFISICAL_DOMAIN="http://192.168.1.102:8080/api"
TOKEN=$(infisical login \
--domain="${INFISICAL_DOMAIN}" \
--method=universal-auth \
--client-id="${INFISICAL_CLIENT_ID}" \
--client-secret="${INFISICAL_CLIENT_SECRET}" \
--plain)
infisical secrets folders create \
--domain="${INFISICAL_DOMAIN}" --token="${TOKEN}" \
--env=prod --projectId="${INFISICAL_PROJECT_ID}" \
--path="/services" --name="opnsense-xray" --silent 2>/dev/null || true
infisical secrets set \
--domain="${INFISICAL_DOMAIN}" --token="${TOKEN}" \
--env=prod --projectId="${INFISICAL_PROJECT_ID}" \
--path="/services/opnsense-xray" \
"FIN_01=${FIN_01}" "GERM_01=${GERM_01}" "GERM_02=${GERM_02}" \
--silent
echo "Infisical /services/opnsense-xray: записаны ключи FIN_01, GERM_01, GERM_02"
+2
View File
@@ -105,6 +105,8 @@ case "$machine" in
opnsense)
eval "$(infisical export --domain="${INFISICAL_DOMAIN}" --token="${TOKEN}" --env=prod --projectId="${INFISICAL_PROJECT_ID}" --path="/services/netbird" --format=dotenv-export --silent)"
eval "$(infisical export --domain="${INFISICAL_DOMAIN}" --token="${TOKEN}" --env=prod --projectId="${INFISICAL_PROJECT_ID}" --path="/services/opnsense" --format=dotenv-export --silent)"
# VLESS-ссылки подписок Xray (роль opnsense/xray; ключи — в instances.yml).
eval "$(infisical export --domain="${INFISICAL_DOMAIN}" --token="${TOKEN}" --env=prod --projectId="${INFISICAL_PROJECT_ID}" --path="/services/opnsense-xray" --format=dotenv-export --silent 2>/dev/null || true)"
export NETBIRD_SETUP_KEY="${NETBIRD_SETUP_KEY:-}"
export OPNSENSE_API_KEY="${OPNSENSE_API_KEY:-}"
export OPNSENSE_API_SECRET="${OPNSENSE_API_SECRET:-}"
+2
View File
@@ -5,3 +5,5 @@
roles:
- role: opnsense/netbird
tags: [netbird]
- role: opnsense/xray
tags: [xray]
@@ -0,0 +1,13 @@
---
opnsense_host: "192.168.1.1:4433"
opnsense_api_key: "{{ lookup('env', 'OPNSENSE_API_KEY') }}"
opnsense_api_secret: "{{ lookup('env', 'OPNSENSE_API_SECRET') }}"
# Общие параметры инстансов: один TUN и один SOCKS-порт обслуживают шлюз
# PROXY на OPNsense, поэтому активна строго одна подписка.
xray_socks5_listen: "192.168.1.1"
xray_socks5_port: "1080"
xray_tun_interface: "proxytun2socks0"
xray_mtu: "1500"
xray_bypass_networks: "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
xray_loglevel: "warning"
@@ -0,0 +1,21 @@
# Источник правды для подписок Xray на OPNsense (роль opnsense/xray).
#
# secret — имя ключа в Infisical /services/opnsense-xray (prod).
# Значение ключа — полная vless:// ссылка. Секреты в git не класть.
# active — активна ровно одна подписка (true): TUN-интерфейс и SOCKS-порт
# общие, параллельно работать несколько подписки не могут.
# Переключение = поменять active местами и запушить: пайплайн сам
# пересоздаст инстансы, провалидирует конфиг и переключит соединение.
#
# Добавление подписки: ключ в Infisical + строка здесь + push.
# Удаление: убрать строку (инстанс будет удалён из OPNsense).
instances:
- name: "🇫🇮Fin-01"
secret: FIN_01
active: true
- name: "🇩🇪Germ-01"
secret: GERM_01
active: false
- name: "🇩🇪Germ-02"
secret: GERM_02
active: false
+90
View File
@@ -0,0 +1,90 @@
#!/usr/bin/env python3
"""Конвертер vless:// ссылки в outbound JSON для os-xray (outbound_config).
Ссылка читается из argv[1] или stdin. Результат — компактный JSON одного
outbound-объекта (protocol vless), совместимый с xray-core.
Поддерживает: transports xhttp/ws/grpc/tcp/h2/kcp, security reality/tls/none.
Отличие от import/parse плагина: сохраняет extra (xmux и пр.) для xhttp
и не добавляет пустые поля (flow, spiderX), чтобы конфиг не менялся молча.
"""
import json
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()
link = link.strip().strip("\"'")
if not link.startswith("vless://"):
sys.exit("error: link must start with vless://")
parsed = urlparse(link)
uuid = parsed.username
host = parsed.hostname
port = parsed.port
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?...")
network = params.get("type", "tcp")
security = params.get("security", "reality")
user = {"id": uuid, "encryption": params.get("encryption", "none")}
flow = params.get("flow", "")
if network == "tcp" and flow:
user["flow"] = flow
outbound = {
"tag": "proxy",
"protocol": "vless",
"settings": {"vnext": [{"address": host, "port": port, "users": [user]}]},
"streamSettings": {"network": network, "security": security},
}
ss = outbound["streamSettings"]
if security == "reality":
ss["realitySettings"] = {
"serverName": params.get("sni", ""),
"fingerprint": params.get("fp", "chrome"),
"publicKey": params.get("pbk", ""),
"shortId": params.get("sid", ""),
}
elif security == "tls":
tls = {"serverName": params.get("sni", ""), "fingerprint": params.get("fp", "chrome")}
if params.get("alpn"):
tls["alpn"] = params["alpn"].split(",")
ss["tlsSettings"] = tls
transport_key = {
"xhttp": "xhttpSettings",
"splithttp": "splithttpSettings",
"ws": "wsSettings",
"grpc": "grpcSettings",
"h2": "httpSettings",
"kcp": "kcpSettings",
"tcp": "tcpSettings",
}.get(network)
if transport_key:
t = {}
for param, field in (("path", "path"), ("host", "host"), ("mode", "mode"),
("serviceName", "serviceName")):
if params.get(param):
t[field] = params[param]
if params.get("extra"):
try:
t["extra"] = json.loads(unquote(params["extra"]))
except json.JSONDecodeError:
sys.exit("error: extra is not valid JSON")
if network == "grpc" and "serviceName" in t:
t = {"serviceName": t["serviceName"]}
if t or network == "grpc":
ss[transport_key] = t
json.dump(outbound, sys.stdout, separators=(",", ":"), ensure_ascii=False)
sys.stdout.write("\n")
if __name__ == "__main__":
main()
+297
View File
@@ -0,0 +1,297 @@
---
# Синхронизация подписок Xray на OPNsense с файлом instances.yml.
# Управление через API плагина os-xray (/api/xray/...), как в роли opnsense/netbird.
- name: Проверить обязательные секреты OPNsense
ansible.builtin.assert:
that:
- opnsense_api_key is defined and opnsense_api_key | length > 0
- opnsense_api_secret is defined and opnsense_api_secret | length > 0
fail_msg: "Отсутствуют OPNSENSE_API_KEY / OPNSENSE_API_SECRET (Infisical /services/opnsense)."
- name: Прочитать список подписок
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: Сконвертировать ссылки в outbound_config
ansible.builtin.command: python3 {{ role_path }}/files/vless_to_outbound.py
args:
stdin: "{{ lookup('env', item.secret, default='') }}"
register: xray_conv
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/search"
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/toggle/{{ 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/get/{{ 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/add"
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/set/{{ 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]
vars:
cur: "{{ item.1.json.instance }}"
want: "{{ xray_payloads[item.0.name] }}"
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 | default('')) != 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
no_log: true
- name: Записать флаг необходимости перезапуска
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:
uuid: "{{ (xray_added.results | default([]) | selectattr('item.name', 'equalto', active_name) | map(attribute='json.uuid') | first)
or (xray_current.json.rows | default([]) | selectattr('name', 'equalto', active_name) | map(attribute='uuid') | first) }}"
active_name: "{{ xray_desired | selectattr('active') | map(attribute='name') | first }}"
- 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 }}"
- 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/toggle/{{ 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/del/{{ 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"
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
- 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 | default('не запускался (без изменений)') }}"