feat: 23 опкод для регистрации, смс шлюз, докер

This commit is contained in:
zavolo
2026-03-15 13:25:40 -04:00
parent d4d5dd5530
commit 2d09f52c2e
29 changed files with 1088 additions and 29 deletions

12
sms-gateway/Dockerfile Normal file
View File

@@ -0,0 +1,12 @@
FROM python:3.12-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
EXPOSE 8000
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

90
sms-gateway/README.md Normal file
View File

@@ -0,0 +1,90 @@
# Смс шлюз
Микросервис для отправки SMS-кодов с маршрутизацией по провайдерам в зависимости от страны.
## Требования
- Docker и Docker Compose
## Запуск
```bash
docker compose up -d
```
Сервис доступен на порту `8100`, API монтируется по префиксу `/sms-gateway`.
## Конфигурация
Все настройки находятся в `config.yaml`. Перезагрузка конфига без перезапуска:
```bash
curl -X POST http://localhost:8100/sms-gateway/admin/reload
```
### Провайдеры
Два типа провайдеров:
**`sms_api`** — внешний HTTP-сервис, отправляет реальное SMS. Параметры:
- `base_url` — базовый адрес сервиса
- `send_endpoint` — эндпоинт отправки (по умолчанию `/auth/code`)
- `timeout` — таймаут запроса в секундах
**`lk_api`** — внутренний провайдер, SMS не отправляет. Генерирует код и сохраняет его в Redis для отображения в личном кабинете.
### Маршрутизация
Правила задаются в `routing.rules`. Для каждого правила указываются префиксы номеров, основной провайдер и опциональный fallback. Если ни одно правило не совпало — используется `default_provider`.
Пример: номера `+7` идут через `sms_api`, при недоступности — через `lk_api`. Все остальные номера сразу через `lk_api`.
### Rate limiting
Настраивается в `settings.rate_limit`:
- `max_attempts` — максимум запросов с одного номера
- `window_seconds` — окно в секундах
## API
### Отправка кода
```
POST /sms-gateway/sms/send
{"phone_number": "+79001234567"}
```
### Личный кабинет
Получить все ожидающие коды:
```
GET /sms-gateway/lk/codes
```
Получить код по номеру:
```
GET /sms-gateway/lk/code?phone=+79001234567
```
Получить и удалить код (разовое считывание):
```
DELETE /sms-gateway/lk/code?phone=+79001234567
```
### Администрирование
Проверить, какой провайдер выберется для номера:
```
GET /sms-gateway/admin/routing/resolve?phone=+79001234567
```
Список правил маршрутизации:
```
GET /sms-gateway/admin/routing/rules
```
Список активных провайдеров:
```
GET /sms-gateway/admin/providers
```
## Swagger
Документация доступна по адресу: `http://localhost:8100/sms-gateway/docs`

79
sms-gateway/app/config.py Normal file
View File

@@ -0,0 +1,79 @@
from __future__ import annotations
import os
from functools import lru_cache
from pathlib import Path
from typing import Any
import yaml
from pydantic import BaseModel
class ProviderConfig(BaseModel):
type: str
enabled: bool = True
model_config = {"extra": "allow"}
def extra(self) -> dict[str, Any]:
return dict(self.__pydantic_extra__) if self.__pydantic_extra__ else {}
class RoutingRule(BaseModel):
name: str
prefixes: list[str]
provider: str
fallback: str | None = None
def matches(self, phone: str) -> bool:
normalized = phone if phone.startswith("+") else f"+{phone}"
for prefix in sorted(self.prefixes, key=len, reverse=True):
if normalized.startswith(prefix):
return True
return False
class RoutingConfig(BaseModel):
rules: list[RoutingRule] = []
default_provider: str = "lk_api"
default_fallback: str | None = None
class RateLimitSettings(BaseModel):
enabled: bool = True
max_attempts: int = 3
window_seconds: int = 600
class AppSettings(BaseModel):
log_codes: bool = True
code_ttl_seconds: int = 300
rate_limit: RateLimitSettings = RateLimitSettings()
class RedisConfig(BaseModel):
host: str = "redis"
port: int = 6379
db: int = 0
password: str | None = None
def url(self) -> str:
if self.password:
return f"redis://:{self.password}@{self.host}:{self.port}/{self.db}"
return f"redis://{self.host}:{self.port}/{self.db}"
class Config(BaseModel):
providers: dict[str, ProviderConfig]
routing: RoutingConfig
settings: AppSettings = AppSettings()
redis: RedisConfig = RedisConfig()
def resolve_provider(self, phone: str) -> tuple[str, str | None]:
for rule in self.routing.rules:
if rule.matches(phone):
return rule.provider, rule.fallback
return self.routing.default_provider, self.routing.default_fallback
@lru_cache(maxsize=1)
def load_config() -> Config:
path = Path(os.getenv("CONFIG_PATH", "config.yaml"))
if not path.exists():
raise FileNotFoundError(f"Конфиг не найден: {path}")
with open(path, encoding="utf-8") as f:
raw = yaml.safe_load(f)
return Config.model_validate(raw)
def reload_config() -> Config:
load_config.cache_clear()
return load_config()

20
sms-gateway/app/deps.py Normal file
View File

@@ -0,0 +1,20 @@
from __future__ import annotations
from app.config import Config, load_config
from app.providers.registry import build_all_providers
from app.redis_client import get_redis
from app.service import SmsService
_service: SmsService | None = None
def init_service() -> None:
global _service
config = load_config()
providers = build_all_providers(config)
redis = get_redis()
_service = SmsService(config, providers, redis)
def get_sms_service() -> SmsService:
global _service
if _service is None:
init_service()
return _service

41
sms-gateway/app/main.py Normal file
View File

@@ -0,0 +1,41 @@
from __future__ import annotations
import logging
from contextlib import asynccontextmanager
from fastapi import FastAPI
from app.config import load_config
from app.redis_client import close_redis, init_redis
from app.routers import admin, lk, sms
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
)
logger = logging.getLogger(__name__)
@asynccontextmanager
async def lifespan(app: FastAPI):
config = load_config()
await init_redis(config.redis)
logger.info("Redis подключён: %s", config.redis.url())
logger.info(
"Провайдеры: %s | Правил маршрутизации: %d",
list(config.providers.keys()),
len(config.routing.rules),
)
yield
await close_redis()
logger.info("SMS Gateway остановлен")
app = FastAPI(
title="SMS Gateway",
description="Маршрутизация SMS по провайдерам в зависимости от страны",
version="1.0.0",
lifespan=lifespan,
root_path="/sms-gateway",
)
app.include_router(sms.router)
app.include_router(lk.router)
app.include_router(admin.router)
@app.get("/health")
async def health() -> dict:
return {"status": "ok"}

View File

@@ -0,0 +1,10 @@
from __future__ import annotations
from dataclasses import dataclass, field
@dataclass
class SendResult:
success: bool
provider: str
code: str | None = None
raw_response: dict = field(default_factory=dict)
error: str | None = None

View File

@@ -0,0 +1,10 @@
from __future__ import annotations
from abc import ABC, abstractmethod
from app.providers import SendResult
class BaseProvider(ABC):
name: str = "base"
@abstractmethod
async def send(self, phone_number: str, code: str | None = None) -> SendResult:
pass

View File

@@ -0,0 +1,36 @@
from __future__ import annotations
import logging
import random
import uuid
from app.config import ProviderConfig
from app.providers import SendResult
from app.providers.base import BaseProvider
logger = logging.getLogger(__name__)
class LkApiProvider(BaseProvider):
"""
Внутренний провайдер — SMS не шлёт.
Генерирует код, который отображается в личном кабинете.
Используется для всех стран кроме России.
"""
name = "lk_api"
def __init__(self, config: ProviderConfig | None = None) -> None:
pass
async def send(self, phone_number: str, code: str | None = None) -> SendResult:
normalized = phone_number if phone_number.startswith("+") else f"+{phone_number}"
if not code:
code = str(random.randint(10000, 99999))
request_uuid = str(uuid.uuid4())
logger.info(
"lk_api: код для ЛК | phone=%s code=%s uuid=%s",
normalized, code, request_uuid,
)
return SendResult(
success=True,
provider=self.name,
code=code,
raw_response={"code": int(code), "uuid": request_uuid, "note": "displayed in personal cabinet"},
)

View File

@@ -0,0 +1,34 @@
from __future__ import annotations
import logging
from app.config import Config, ProviderConfig
from app.providers.base import BaseProvider
from app.providers.lk_api import LkApiProvider
from app.providers.sms_api import SmsApiProvider
logger = logging.getLogger(__name__)
PROVIDER_REGISTRY: dict[str, type[BaseProvider]] = {
"sms_api": SmsApiProvider,
"lk_api": LkApiProvider,
}
def build_provider(name: str, config: ProviderConfig) -> BaseProvider | None:
cls = PROVIDER_REGISTRY.get(config.type)
if cls is None:
logger.error("Неизвестный тип провайдера: %s", config.type)
return None
if not config.enabled:
logger.debug("Провайдер %s отключён", name)
return None
return cls(config)
def build_all_providers(config: Config) -> dict[str, BaseProvider]:
result: dict[str, BaseProvider] = {}
for name, provider_cfg in config.providers.items():
provider = build_provider(name, provider_cfg)
if provider is not None:
result[name] = provider
logger.info("Провайдер загружен: %s (тип: %s)", name, provider_cfg.type)
if "lk_api" not in result:
result["lk_api"] = LkApiProvider()
logger.info("lk_api добавлен как fallback по умолчанию")
return result

View File

@@ -0,0 +1,52 @@
from __future__ import annotations
import logging
import httpx
from app.config import ProviderConfig
from app.providers import SendResult
from app.providers.base import BaseProvider
logger = logging.getLogger(__name__)
class SmsApiProvider(BaseProvider):
"""
Внешний SMS-сервис.
Отправляет реальное SMS, возвращает код и uuid.
Используется для России (+7).
"""
name = "sms_api"
def __init__(self, config: ProviderConfig) -> None:
extra = config.extra()
self.base_url: str = extra.get("base_url", "").rstrip("/")
self.send_endpoint: str = extra.get("send_endpoint", "/auth/code")
self.timeout: int = int(extra.get("timeout", 10))
async def send(self, phone_number: str, code: str | None = None) -> SendResult:
normalized = phone_number if phone_number.startswith("+") else f"+{phone_number}"
url = f"{self.base_url}{self.send_endpoint}"
payload: dict = {"phone_number": normalized}
if code:
payload["code"] = code
try:
async with httpx.AsyncClient(timeout=self.timeout) as client:
response = await client.post(
url,
json=payload,
headers={"accept": "application/json", "Content-Type": "application/json"},
)
response.raise_for_status()
data = response.json()
code = str(data.get("code", ""))
logger.info("sms_api: SMS отправлен на %s | uuid=%s code=%s", normalized, data.get("uuid"), code)
return SendResult(
success=True,
provider=self.name,
code=code,
raw_response=data,
)
except httpx.HTTPStatusError as e:
logger.error("sms_api HTTP %s для %s: %s", e.response.status_code, normalized, e)
return SendResult(success=False, provider=self.name, error=str(e))
except Exception as e:
logger.error("sms_api ошибка для %s: %s", normalized, e)
return SendResult(success=False, provider=self.name, error=str(e))

View File

@@ -0,0 +1,25 @@
from __future__ import annotations
import redis.asyncio as aioredis
from app.config import RedisConfig
_redis: aioredis.Redis | None = None
async def init_redis(cfg: RedisConfig) -> aioredis.Redis:
global _redis
_redis = aioredis.from_url(
cfg.url(),
encoding="utf-8",
decode_responses=True,
)
await _redis.ping()
return _redis
async def close_redis() -> None:
global _redis
if _redis:
await _redis.aclose()
_redis = None
def get_redis() -> aioredis.Redis:
if _redis is None:
raise RuntimeError("Redis не инициализирован")
return _redis

View File

View File

@@ -0,0 +1,51 @@
from __future__ import annotations
import logging
from fastapi import APIRouter, Depends
from pydantic import BaseModel
from app.config import reload_config
from app.deps import get_sms_service, init_service
from app.service import SmsService
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/admin", tags=["Admin"])
class RoutingInfo(BaseModel):
phone: str
primary_provider: str
fallback_provider: str | None
@router.post("/reload", response_model=dict)
async def reload() -> dict:
"""Перечитать config.yaml без перезапуска сервиса."""
new_config = reload_config()
init_service()
providers = list(new_config.providers.keys())
rules_count = len(new_config.routing.rules)
logger.info("Конфиг перезагружен: провайдеры=%s правил=%d", providers, rules_count)
return {"success": True, "providers": providers, "routing_rules": rules_count}
@router.get("/routing/resolve", response_model=RoutingInfo)
async def resolve_routing(
phone: str,
service: SmsService = Depends(get_sms_service),
) -> RoutingInfo:
"""Проверить, какой провайдер будет выбран для номера."""
primary, fallback = service.config.resolve_provider(phone)
return RoutingInfo(phone=phone, primary_provider=primary, fallback_provider=fallback)
@router.get("/routing/rules", response_model=list[dict])
async def list_rules(
service: SmsService = Depends(get_sms_service),
) -> list[dict]:
"""Список всех правил маршрутизации."""
return [rule.model_dump() for rule in service.config.routing.rules]
@router.get("/providers", response_model=list[dict])
async def list_providers(
service: SmsService = Depends(get_sms_service),
) -> list[dict]:
"""Список активных провайдеров."""
return [
{"name": name, "type": name, "enabled": True}
for name in service.providers.keys()
]

View File

@@ -0,0 +1,43 @@
from __future__ import annotations
import logging
from fastapi import APIRouter, Depends, HTTPException, Query
from pydantic import BaseModel
from app.deps import get_sms_service
from app.service import SmsService
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/lk", tags=["Личный кабинет"])
class PendingCode(BaseModel):
phone: str
code: str
expires_in: int
@router.get("/codes", response_model=list[PendingCode])
async def list_codes(
service: SmsService = Depends(get_sms_service),
) -> list[PendingCode]:
items = await service.list_pending_codes()
return [PendingCode(**item) for item in items]
@router.get("/code", response_model=PendingCode)
async def get_code(
phone: str = Query(..., description="Номер телефона"),
service: SmsService = Depends(get_sms_service),
) -> PendingCode:
items = await service.list_pending_codes()
normalized = phone if phone.startswith("+") else f"+{phone}"
for item in items:
if item["phone"] == normalized:
return PendingCode(**item)
raise HTTPException(status_code=404, detail="Код не найден или истёк")
@router.delete("/code", response_model=dict)
async def consume_code(
phone: str = Query(..., description="Номер телефона"),
service: SmsService = Depends(get_sms_service),
) -> dict:
code = await service.consume_code(phone)
if code is None:
raise HTTPException(status_code=404, detail="Код не найден или истёк")
return {"success": True, "phone": phone, "consumed_code": code}

View File

@@ -0,0 +1,41 @@
from __future__ import annotations
import logging
from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel
from app.deps import get_sms_service
from app.service import RateLimitExceeded, SmsService
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/sms", tags=["SMS"])
class SendCodeRequest(BaseModel):
phone_number: str
class SendCodeResponse(BaseModel):
success: bool
provider: str
phone_number: str
code: str | None = None
error: str | None = None
@router.post("/send", response_model=SendCodeResponse)
async def send_code(
request: SendCodeRequest,
service: SmsService = Depends(get_sms_service),
) -> SendCodeResponse:
try:
result = await service.send_code(request.phone_number)
except RateLimitExceeded as e:
raise HTTPException(
status_code=429,
detail={"error": "Слишком много запросов для этого номера", "retry_after": e.retry_after},
headers={"Retry-After": str(e.retry_after)},
)
if not result.success:
raise HTTPException(status_code=502, detail=result.error or "Ошибка отправки SMS")
return SendCodeResponse(
success=True,
provider=result.provider,
phone_number=request.phone_number,
code=result.code,
)

View File

@@ -0,0 +1,90 @@
from __future__ import annotations
import logging
import redis.asyncio as aioredis
from app.config import Config
from app.providers import SendResult
from app.providers.base import BaseProvider
logger = logging.getLogger(__name__)
RATE_KEY = "sms:rate:{phone}"
CODE_KEY = "sms:code:{phone}"
class RateLimitExceeded(Exception):
def __init__(self, retry_after: int) -> None:
self.retry_after = retry_after
super().__init__(f"Rate limit exceeded, retry after {retry_after}s")
class SmsService:
def __init__(self, config: Config, providers: dict[str, BaseProvider], redis: aioredis.Redis) -> None:
self.config = config
self.providers = providers
self.redis = redis
async def send_code(self, phone_number: str, code: str | None = None) -> SendResult:
normalized = phone_number if phone_number.startswith("+") else f"+{phone_number}"
await self._check_rate_limit(normalized)
primary_name, fallback_name = self.config.resolve_provider(normalized)
result = await self._try_send(primary_name, normalized, code=code)
if not result.success and fallback_name:
logger.warning(
"Провайдер %s недоступен для %s, пробуем fallback: %s",
primary_name, normalized, fallback_name,
)
result = await self._try_send(fallback_name, normalized, code=code)
if result.success and result.code:
ttl = self.config.settings.code_ttl_seconds
key = CODE_KEY.format(phone=normalized)
await self.redis.set(key, result.code, ex=ttl)
if self.config.settings.log_codes:
logger.info("Код сохранён: phone=%s code=%s provider=%s", normalized, result.code, result.provider)
return result
async def _check_rate_limit(self, phone: str) -> None:
rl = self.config.settings.rate_limit
if not rl.enabled:
return
key = RATE_KEY.format(phone=phone)
pipe = self.redis.pipeline()
pipe.incr(key)
pipe.ttl(key)
count, ttl = await pipe.execute()
if count == 1:
await self.redis.expire(key, rl.window_seconds)
ttl = rl.window_seconds
if count > rl.max_attempts:
retry_after = ttl if ttl > 0 else rl.window_seconds
logger.warning("Rate limit для %s: попытка %d/%d, retry_after=%ds", phone, count, rl.max_attempts, retry_after)
raise RateLimitExceeded(retry_after=retry_after)
async def _try_send(self, provider_name: str, phone: str, code: str | None = None) -> SendResult:
provider = self.providers.get(provider_name)
if provider is None:
logger.error("Провайдер не найден: %s", provider_name)
return SendResult(success=False, provider=provider_name, error=f"Provider '{provider_name}' not found")
return await provider.send(phone, code=code)
async def get_pending_code(self, phone_number: str) -> str | None:
normalized = phone_number if phone_number.startswith("+") else f"+{phone_number}"
key = CODE_KEY.format(phone=normalized)
return await self.redis.get(key)
async def consume_code(self, phone_number: str) -> str | None:
normalized = phone_number if phone_number.startswith("+") else f"+{phone_number}"
key = CODE_KEY.format(phone=normalized)
pipe = self.redis.pipeline()
pipe.get(key)
pipe.delete(key)
code, _ = await pipe.execute()
return code
async def list_pending_codes(self) -> list[dict]:
pattern = CODE_KEY.format(phone="*")
result = []
async for key in self.redis.scan_iter(pattern):
pipe = self.redis.pipeline()
pipe.get(key)
pipe.ttl(key)
code, ttl = await pipe.execute()
if code:
phone = key.replace("sms:code:", "")
result.append({"phone": phone, "code": code, "expires_in": max(ttl, 0)})
return result

34
sms-gateway/config.yaml Normal file
View File

@@ -0,0 +1,34 @@
providers:
sms_api:
type: sms_api
enabled: false
base_url: "http://localhost:8000"
send_endpoint: "/auth/code"
timeout: 10
lk_api:
type: lk_api
enabled: true
routing:
rules:
- name: "Russia"
prefixes: ["+7"]
provider: "sms_api"
fallback: "lk_api"
default_provider: "lk_api"
default_fallback: null
settings:
log_codes: true
code_ttl_seconds: 300
rate_limit:
enabled: true
max_attempts: 3
window_seconds: 600
redis:
host: "redis"
port: 6379
db: 0

View File

@@ -0,0 +1,28 @@
services:
sms-gateway:
build: .
ports:
- "8100:8000"
volumes:
- ./config.yaml:/app/config.yaml:ro
environment:
- CONFIG_PATH=/app/config.yaml
depends_on:
redis:
condition: service_healthy
restart: unless-stopped
redis:
image: redis:7-alpine
command: redis-server --save 60 1 --loglevel warning
volumes:
- redis_data:/data
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 5s
timeout: 3s
retries: 5
restart: unless-stopped
volumes:
redis_data:

View File

@@ -0,0 +1,6 @@
fastapi>=0.115.0
uvicorn[standard]>=0.30.0
httpx>=0.27.0
pydantic>=2.7.0
pyyaml>=6.0.1
redis>=5.0.0