vercel_auth.py 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. """Helpers for reporting Vercel Sandbox authentication state."""
  2. from __future__ import annotations
  3. import os
  4. from dataclasses import dataclass
  5. _TOKEN_TUPLE_VARS = ("VERCEL_TOKEN", "VERCEL_PROJECT_ID", "VERCEL_TEAM_ID")
  6. @dataclass(frozen=True)
  7. class VercelAuthStatus:
  8. ok: bool
  9. label: str
  10. detail_lines: tuple[str, ...]
  11. def describe_vercel_auth() -> VercelAuthStatus:
  12. """Return Vercel auth status without exposing secret values."""
  13. present_token_vars = tuple(name for name in _TOKEN_TUPLE_VARS if os.getenv(name))
  14. missing_token_vars = tuple(name for name in _TOKEN_TUPLE_VARS if not os.getenv(name))
  15. if os.getenv("VERCEL_OIDC_TOKEN"):
  16. details = [
  17. "mode: OIDC",
  18. "active env: VERCEL_OIDC_TOKEN",
  19. "note: OIDC tokens are development-only; use access-token auth for deployments and long-running processes",
  20. ]
  21. if present_token_vars:
  22. details.append(f"also present: {', '.join(present_token_vars)}")
  23. return VercelAuthStatus(True, "OIDC token via VERCEL_OIDC_TOKEN", tuple(details))
  24. if not missing_token_vars:
  25. return VercelAuthStatus(
  26. True,
  27. "access token + project/team via VERCEL_TOKEN, VERCEL_PROJECT_ID, VERCEL_TEAM_ID",
  28. ("mode: access token", "active env: VERCEL_TOKEN, VERCEL_PROJECT_ID, VERCEL_TEAM_ID"),
  29. )
  30. if present_token_vars:
  31. return VercelAuthStatus(
  32. False,
  33. f"partial access-token auth (missing {', '.join(missing_token_vars)})",
  34. (
  35. "mode: incomplete access token",
  36. f"present env: {', '.join(present_token_vars)}",
  37. f"missing env: {', '.join(missing_token_vars)}",
  38. "recommended: set VERCEL_TOKEN, VERCEL_PROJECT_ID, and VERCEL_TEAM_ID together",
  39. ),
  40. )
  41. return VercelAuthStatus(
  42. False,
  43. "not configured",
  44. ("recommended: set VERCEL_TOKEN, VERCEL_PROJECT_ID, and VERCEL_TEAM_ID",
  45. "development-only alternative: set VERCEL_OIDC_TOKEN"),
  46. )