docs(README): добавлена ссылка на интеграцию с EvoBGP в документацию; обновлено описание приложения BGP и расширен каталог разрешений
Build and Push Auth Portal Docker Image / build-and-push (push) Successful in 2m56s
Build and Push Auth Portal Docker Image / create-release (push) Skipped

This commit is contained in:
Denozordec
2026-07-18 23:24:00 +07:00
parent 0fa4b7adea
commit cfbe1fceda
3 changed files with 117 additions and 5 deletions
+2
View File
@@ -27,6 +27,8 @@ pnpm --filter web dev # :5175
См. [`docs/integrate-cfdm.md`](docs/integrate-cfdm.md) — то же для Cloudflare Domain Manager (`cfdm:*`, порт Vite `5174`).
См. [`docs/integrate-evobgp.md`](docs/integrate-evobgp.md) — EvoBGP (`bgp:*`), dual auth JWT + API keys, ownership modules/peers/firewall.
Корень:
```bash
+98
View File
@@ -0,0 +1,98 @@
# Интеграция auth-portal ↔ EvoBGP
Единый вход: пользователь логинится на auth-portal, получает JWT, переходит в EvoBGP с токеном в URL fragment. EvoBGP API проверяет JWT и права `bgp:*`. API-ключи EvoBGP (viewer/editor/operator/node/firewall) остаются для автоматизации и нод.
## Архитектура
```
Browser → EvoBGP UI (нет token)
→ redirect AUTH_PORTAL_URL/?return_to=…/auth/callback
→ login
→ redirect return_to#access_token=…
→ EvoBGP /auth/callback сохраняет token
→ API Authorization: Bearer <JWT>
```
Общий секрет: `JWT_SECRET` / `AUTH_JWT_SECRET` (HS256). Issuer: `ISSUER` / `AUTH_ISSUER`.
App id в портале: **`bgp`**.
## Permissions ↔ UI
| Permission | UI |
|------------|-----|
| `bgp:dashboard:read` | `/dashboard` |
| `bgp:modules:read` / `write` | `/modules` |
| `bgp:lookup:read` | `/lookup` |
| `bgp:network:read` / `write` | `/network` (пиры и спикеры) |
| `bgp:directories:read` / `write` | `/directories` |
| `bgp:operations:read` / `write` / `admin` | `/operations` (admin = apply/rollback) |
| `bgp:firewall:read` / `write` | `/firewall` |
| `bgp:schedule:read` / `write` | `/schedule` |
| `bgp:monitoring:read` | `/monitoring` |
| `bgp:access:admin` | `/access` (API-ключи) |
| `bgp:tenant_settings:admin` | `/tenant-settings` |
| `bgp:settings:read` | `/settings` |
Иерархия: `admin``write``read` в рамках одной секции.
Пример обычного пользователя: app `bgp` + только `bgp:dashboard:read` и `bgp:lookup:read`.
### Ownership
Ресурсы modules / peers / firewall (clients, rules), созданные через JWT, имеют `created_by_user_id`. Видят и редактируют: создатель и portal `is_admin` (или API key `operator`). API keys без user id — tenant-wide scope.
## Локальный запуск
### 1. auth-portal
```bash
cd auth-portal
pnpm install
# JWT_SECRET=dev-secret-change-me
# RETURN_TO_ALLOWLIST=.shnt.top,localhost,http://localhost:5173,…EvoBGP web origin
pnpm --filter @authportal/api dev # :8080
pnpm --filter web dev # :5175
```
```env
# apps/web/.env.local
VITE_BGP_APP_URL=http://localhost:5176
```
Bootstrap: выдайте app **bgp** и нужные `bgp:*` permissions.
### 2. EvoBGP
```env
AUTH_REQUIRED=true
AUTH_JWT_SECRET=dev-secret-change-me
AUTH_ISSUER=https://auth.shnt.top
AUTH_PORTAL_URL=http://localhost:5175
EVOBGP_PORTAL_TENANT_ID=<uuid tenant>
```
```env
# apps/web/.env.local
VITE_AUTH_ENABLED=true
VITE_AUTH_PORTAL_URL=http://localhost:5175
```
## App Switcher
Публичный конфиг: `GET {AUTH_PORTAL_URL}/api/v1/app-switcher`.
`CURRENT_APP_ID = bgp`. Редактор ссылок — portal `/admin/apps`.
## Logout (SSO)
Очистить локальный JWT → `AUTH_PORTAL_URL/logout` (не `/?return_to=`).
## Troubleshooting
| Симптом | Причина |
|---------|---------|
| 401 на API | Нет/битый Bearer; разные `JWT_SECRET` |
| 403 нет доступа к приложению | В portal не выдан app `bgp` |
| 403 на раздел | Нет `bgp:<section>:…` |
| JWT без tenant | Не задан `EVOBGP_PORTAL_TENANT_ID` |
| return_to rejected | origin EvoBGP не в `RETURN_TO_ALLOWLIST` |
+17 -5
View File
@@ -31,7 +31,7 @@ export const APPS: AppMeta[] = [
{
id: 'bgp',
title: 'EvoBGP',
description: 'Модули, peers, сеть и apply',
description: 'Модули, сеть, операции и мониторинг BGP',
url: 'https://bgp.shnt.top',
},
]
@@ -90,12 +90,24 @@ export const PERMISSION_CATALOG: AppPermissionCatalog[] = [
appId: 'bgp',
title: 'EvoBGP',
sections: [
section('dashboard', 'Панель', 'KPI и обзор', ['read']),
section('modules', 'Модули', 'Модули префиксов'),
section('peers', 'Peers', 'BGP peers'),
section('network', 'Сеть', 'Спикеры и сеть'),
section('apply', 'Apply', 'Apply / rollback', ['write']),
section('lookup', 'Проверка', 'IP/домен в списках и community', ['read']),
section('network', 'Сеть', 'BGP-пиры и спикеры'),
section('directories', 'Справочники', 'Communities и DoH'),
section('operations', 'Операции', 'Ревизии (read/write) и apply/rollback (admin)', [
'read',
'write',
'admin',
]),
section('firewall', 'Файрвол', 'Клиенты и правила'),
section('schedule', 'Задачи', 'Расписание refresh'),
section('monitoring', 'Мониторинг', 'Health и BIRD', ['read']),
section('access', 'Доступ', 'API-ключи', ['admin']),
section('settings', 'Настройки', 'Настройки tenant', ['admin']),
section('tenant_settings', 'Настройки BIRD', 'Tenant BIRD config', [
'admin',
]),
section('settings', 'Настройки UI', 'Токен и подключение', ['read']),
],
},
]