fix(docreader/auth): harden gRPC TLS/Token rollout from #1359
Follow-up to #1359. Addresses a set of correctness and security gaps in the initial docreader auth implementation. - docker-compose: inject GRPC_TLS_*/GRPC_TLS_SERVER_NAME/GRPC_AUTH_TOKEN into the WeKnora-app service. Without this the Go client never saw the knobs, so enabling token auth on the server broke every RPC. - client: bind tokenAuth.RequireTransportSecurity() to TLSEnabled so a bearer token cannot be sent over an insecure channel once TLS is on. - server: load_tls_credentials now raises TLSConfigError on misconfig (cert/key missing, file unreadable, mTLS without CA); main.py exits 1 instead of silently downgrading to insecure. - server: replace endswith("/Check"|"/Watch") health bypass with exact match against /grpc.health.v1.Health/{Check,Watch}. - server: compare tokens with hmac.compare_digest, warn on tokens < 16B. - server: AuthInterceptor now returns an abort handler matching the original RPC kind (unary/stream) and uses context.abort, so streaming RPCs surface UNAUTHENTICATED instead of INTERNAL. - internal/infrastructure/docparser/grpc_parser.go: drop the duplicated TLS/tokenAuth block and reuse docreader/client.LoadAuthConfigFromEnv + BuildDialOptions. Single source of truth for client-side auth. - Add GRPC_TLS_SERVER_NAME (client SNI override) and GRPC_MTLS_REQUIRE_CLIENT_CERT (server explicit mTLS toggle); document the differing CA semantics between client and server in .env*.example. - Reject half-configured client mTLS (cert XOR key) loudly. - Fix missing trailing newline in .env.lite.example. Verified locally: go build ./... and go vet ./... clean; auth.py fail-fast / token paths smoke-tested.
This commit is contained in:
+129
-42
@@ -3,14 +3,21 @@
|
||||
环境变量配置:
|
||||
TLS 相关:
|
||||
GRPC_TLS_ENABLED: 是否启用 TLS(true/false),默认 false
|
||||
GRPC_TLS_CERT: TLS 证书文件路径
|
||||
GRPC_TLS_KEY: TLS 私钥文件路径
|
||||
GRPC_TLS_CA: CA 证书路径(可选,用于 mTLS 双向认证)
|
||||
GRPC_TLS_CERT: TLS 证书文件路径(GRPC_TLS_ENABLED=true 时必填)
|
||||
GRPC_TLS_KEY: TLS 私钥文件路径(GRPC_TLS_ENABLED=true 时必填)
|
||||
GRPC_TLS_CA: CA 证书路径
|
||||
GRPC_MTLS_REQUIRE_CLIENT_CERT: 设为 true 时启用 mTLS,要求客户端
|
||||
出示由 GRPC_TLS_CA 签发的证书。未设置时默认按 GRPC_TLS_CA 是否
|
||||
存在自动判断(保留向后兼容)。
|
||||
|
||||
认证相关:
|
||||
GRPC_AUTH_TOKEN: 认证 Token,如果设置则启用认证
|
||||
|
||||
注意:当 GRPC_TLS_ENABLED=true 但任何 TLS 配置项缺失或加载失败时,
|
||||
本模块会抛出异常以触发 fail-fast,避免静默降级到明文。
|
||||
"""
|
||||
|
||||
import hmac
|
||||
import logging
|
||||
import os
|
||||
from typing import Optional
|
||||
@@ -20,9 +27,24 @@ import grpc
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class TLSConfigError(RuntimeError):
|
||||
"""TLS 配置错误,用于 fail-fast。"""
|
||||
|
||||
|
||||
def _env_bool(name: str, default: bool = False) -> bool:
|
||||
raw = os.getenv(name)
|
||||
if raw is None:
|
||||
return default
|
||||
return raw.strip().lower() in ("true", "1", "yes", "on")
|
||||
|
||||
|
||||
def load_tls_credentials() -> Optional[grpc.ServerCredentials]:
|
||||
tls_enabled = os.getenv("GRPC_TLS_ENABLED", "false").lower() == "true"
|
||||
if not tls_enabled:
|
||||
"""构建 server 端 TLS 凭据。
|
||||
|
||||
GRPC_TLS_ENABLED=false 时返回 None;为 true 时如果配置无效会抛出
|
||||
TLSConfigError,由调用方决定是否终止启动。
|
||||
"""
|
||||
if not _env_bool("GRPC_TLS_ENABLED", False):
|
||||
logger.info("TLS disabled (GRPC_TLS_ENABLED is not 'true')")
|
||||
return None
|
||||
|
||||
@@ -30,38 +52,105 @@ def load_tls_credentials() -> Optional[grpc.ServerCredentials]:
|
||||
key_path = os.getenv("GRPC_TLS_KEY")
|
||||
|
||||
if not cert_path or not key_path:
|
||||
logger.warning(
|
||||
"TLS enabled but certificate not configured (GRPC_TLS_CERT or GRPC_TLS_KEY not set)"
|
||||
raise TLSConfigError(
|
||||
"GRPC_TLS_ENABLED=true but GRPC_TLS_CERT/GRPC_TLS_KEY not set; "
|
||||
"refusing to start in plaintext mode"
|
||||
)
|
||||
return None
|
||||
|
||||
try:
|
||||
with open(cert_path, "rb") as f:
|
||||
cert_chain = f.read()
|
||||
with open(key_path, "rb") as f:
|
||||
private_key = f.read()
|
||||
except OSError as e:
|
||||
raise TLSConfigError(f"failed to read TLS cert/key: {e}") from e
|
||||
|
||||
ca_path = os.getenv("GRPC_TLS_CA")
|
||||
if ca_path:
|
||||
ca_path = os.getenv("GRPC_TLS_CA")
|
||||
require_client_auth = _env_bool(
|
||||
"GRPC_MTLS_REQUIRE_CLIENT_CERT",
|
||||
default=bool(ca_path),
|
||||
)
|
||||
|
||||
if require_client_auth and not ca_path:
|
||||
raise TLSConfigError(
|
||||
"GRPC_MTLS_REQUIRE_CLIENT_CERT=true requires GRPC_TLS_CA to be set"
|
||||
)
|
||||
|
||||
if ca_path:
|
||||
try:
|
||||
with open(ca_path, "rb") as f:
|
||||
ca_cert = f.read()
|
||||
credentials = grpc.ssl_server_credentials(
|
||||
[(private_key, cert_chain)],
|
||||
root_certificates=ca_cert,
|
||||
require_client_auth=True,
|
||||
)
|
||||
except OSError as e:
|
||||
raise TLSConfigError(f"failed to read CA cert: {e}") from e
|
||||
credentials = grpc.ssl_server_credentials(
|
||||
[(private_key, cert_chain)],
|
||||
root_certificates=ca_cert,
|
||||
require_client_auth=require_client_auth,
|
||||
)
|
||||
if require_client_auth:
|
||||
logger.info("TLS enabled with mTLS (mutual authentication)")
|
||||
else:
|
||||
credentials = grpc.ssl_server_credentials([(private_key, cert_chain)])
|
||||
logger.info("TLS enabled")
|
||||
logger.info("TLS enabled with CA configured (client auth optional)")
|
||||
else:
|
||||
credentials = grpc.ssl_server_credentials([(private_key, cert_chain)])
|
||||
logger.info("TLS enabled (1-way)")
|
||||
|
||||
return credentials
|
||||
except FileNotFoundError as e:
|
||||
logger.error(f"TLS certificate file not found: {e}")
|
||||
return None
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to load TLS credentials: {e}")
|
||||
return None
|
||||
return credentials
|
||||
|
||||
|
||||
# gRPC 健康检查标准服务路径,需在鉴权前放行,便于 K8s/Docker 探活。
|
||||
_HEALTH_METHODS = frozenset(
|
||||
{
|
||||
"/grpc.health.v1.Health/Check",
|
||||
"/grpc.health.v1.Health/Watch",
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def _make_abort_handler(original: Optional[grpc.RpcMethodHandler]) -> grpc.RpcMethodHandler:
|
||||
"""为给定的原 handler 构造一个匹配 RPC kind 的鉴权失败 handler。
|
||||
|
||||
如果原 handler 不可用(理论上不会发生,但作为兜底),返回 unary_unary。
|
||||
直接返回 None 而不是 set_code 也可,但显式调用 abort 能确保框架按
|
||||
UNAUTHENTICATED 收尾,且匹配 kind 防止 grpc 触发 INTERNAL。
|
||||
"""
|
||||
def _abort(_request, context):
|
||||
context.abort(
|
||||
grpc.StatusCode.UNAUTHENTICATED,
|
||||
"Invalid or missing authentication token",
|
||||
)
|
||||
|
||||
def _abort_stream(_request, context):
|
||||
context.abort(
|
||||
grpc.StatusCode.UNAUTHENTICATED,
|
||||
"Invalid or missing authentication token",
|
||||
)
|
||||
return
|
||||
yield # pragma: no cover - make this a generator
|
||||
|
||||
if original is None or original.unary_unary is not None:
|
||||
return grpc.unary_unary_rpc_method_handler(
|
||||
_abort,
|
||||
request_deserializer=getattr(original, "request_deserializer", None),
|
||||
response_serializer=getattr(original, "response_serializer", None),
|
||||
)
|
||||
if original.unary_stream is not None:
|
||||
return grpc.unary_stream_rpc_method_handler(
|
||||
_abort_stream,
|
||||
request_deserializer=original.request_deserializer,
|
||||
response_serializer=original.response_serializer,
|
||||
)
|
||||
if original.stream_unary is not None:
|
||||
return grpc.stream_unary_rpc_method_handler(
|
||||
_abort,
|
||||
request_deserializer=original.request_deserializer,
|
||||
response_serializer=original.response_serializer,
|
||||
)
|
||||
return grpc.stream_stream_rpc_method_handler(
|
||||
_abort_stream,
|
||||
request_deserializer=original.request_deserializer,
|
||||
response_serializer=original.response_serializer,
|
||||
)
|
||||
|
||||
|
||||
class AuthInterceptor(grpc.ServerInterceptor):
|
||||
@@ -75,9 +164,14 @@ class AuthInterceptor(grpc.ServerInterceptor):
|
||||
- value: "Bearer <token>" 或直接 "<token>"
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.auth_token = os.getenv("GRPC_AUTH_TOKEN")
|
||||
def __init__(self) -> None:
|
||||
token = os.getenv("GRPC_AUTH_TOKEN") or ""
|
||||
self.auth_token: Optional[bytes] = token.encode("utf-8") if token else None
|
||||
if self.auth_token:
|
||||
if len(self.auth_token) < 16:
|
||||
logger.warning(
|
||||
"GRPC_AUTH_TOKEN is shorter than 16 bytes; consider a stronger token"
|
||||
)
|
||||
logger.info("Token authentication enabled")
|
||||
else:
|
||||
logger.warning("Token authentication disabled (GRPC_AUTH_TOKEN not set)")
|
||||
@@ -87,25 +181,18 @@ class AuthInterceptor(grpc.ServerInterceptor):
|
||||
return continuation(handler_call_details)
|
||||
|
||||
method = handler_call_details.method
|
||||
if method.endswith("/Check") or method.endswith("/Watch"):
|
||||
if method in _HEALTH_METHODS:
|
||||
return continuation(handler_call_details)
|
||||
|
||||
metadata = dict(handler_call_details.invocation_metadata or [])
|
||||
token = metadata.get("authorization", "")
|
||||
raw = metadata.get("authorization", "") or ""
|
||||
if raw.startswith("Bearer "):
|
||||
raw = raw[7:]
|
||||
token_bytes = raw.encode("utf-8")
|
||||
|
||||
if token.startswith("Bearer "):
|
||||
token = token[7:]
|
||||
|
||||
if token != self.auth_token:
|
||||
logger.warning(f"Authentication failed for method: {method}")
|
||||
return self._unauthenticated_handler()
|
||||
if not hmac.compare_digest(token_bytes, self.auth_token):
|
||||
logger.warning("Authentication failed for method: %s", method)
|
||||
original = continuation(handler_call_details)
|
||||
return _make_abort_handler(original)
|
||||
|
||||
return continuation(handler_call_details)
|
||||
|
||||
def _unauthenticated_handler(self):
|
||||
def handler(request, context):
|
||||
context.set_code(grpc.StatusCode.UNAUTHENTICATED)
|
||||
context.set_details("Invalid or missing authentication token")
|
||||
return None
|
||||
|
||||
return grpc.unary_unary_rpc_method_handler(handler)
|
||||
|
||||
Reference in New Issue
Block a user