mirror of
https://github.com/Routstr/routstr-core.git
synced 2026-07-30 15:26:14 +00:00
Jeroen UbbinkandClaude Opus 4.8
8aa2fa5c4a
Provide an offline recovery command that sets a new admin password directly in the Secret store, for operators locked out of the admin UI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
105 lines
3.2 KiB
Python
105 lines
3.2 KiB
Python
"""Recover admin access by resetting the stored admin password (issue #553).
|
|
|
|
The lockout escape hatch for an operator who has lost the admin password. It
|
|
talks to the ``secrets`` table directly and deliberately does *not* require
|
|
``ROUTSTR_SECRET_KEY``: the admin password is scrypt-hashed (key-independent),
|
|
so recovery works even when the encryption key is missing or has changed.
|
|
|
|
Two explicit, mutually exclusive actions — running with no arguments only prints
|
|
help, so the password can't be reset by accident:
|
|
|
|
python scripts/reset_admin_password.py --password <new-password>
|
|
Hash and store <new-password> now.
|
|
|
|
python scripts/reset_admin_password.py --regenerate
|
|
Clear the stored hash; the next node startup generates a fresh random
|
|
password and logs it once (with the /admin URL).
|
|
"""
|
|
|
|
import argparse
|
|
import asyncio
|
|
import sys
|
|
import time
|
|
|
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
|
|
from routstr.core.db import create_session, get_secret, set_admin_password
|
|
from routstr.core.vault import MIN_PASSWORD_LENGTH
|
|
|
|
|
|
def build_parser() -> argparse.ArgumentParser:
|
|
parser = argparse.ArgumentParser(
|
|
prog="reset_admin_password",
|
|
description="Reset the node's admin password (recovery from lockout).",
|
|
)
|
|
action = parser.add_mutually_exclusive_group()
|
|
action.add_argument(
|
|
"--password",
|
|
metavar="NEW_PASSWORD",
|
|
help=f"set this as the new admin password (min {MIN_PASSWORD_LENGTH} chars)",
|
|
)
|
|
action.add_argument(
|
|
"--regenerate",
|
|
action="store_true",
|
|
help="clear the password so the next startup generates and logs a new one",
|
|
)
|
|
return parser
|
|
|
|
|
|
async def apply_reset(
|
|
session: AsyncSession,
|
|
*,
|
|
password: str | None = None,
|
|
regenerate: bool = False,
|
|
) -> str:
|
|
"""Perform the requested reset against ``session``; return a status message."""
|
|
if password is not None:
|
|
if len(password) < MIN_PASSWORD_LENGTH:
|
|
raise ValueError(
|
|
f"New password must be at least {MIN_PASSWORD_LENGTH} characters"
|
|
)
|
|
await set_admin_password(session, password)
|
|
return "Admin password updated."
|
|
|
|
if regenerate:
|
|
secret = await get_secret(session)
|
|
secret.admin_password_hash = None
|
|
secret.updated_at = int(time.time())
|
|
session.add(secret)
|
|
await session.commit()
|
|
return (
|
|
"Admin password cleared. The next node startup will generate a new "
|
|
"one and log it once with the /admin URL."
|
|
)
|
|
|
|
return ""
|
|
|
|
|
|
async def _run(password: str | None, regenerate: bool) -> str:
|
|
async with create_session() as session:
|
|
return await apply_reset(
|
|
session, password=password, regenerate=regenerate
|
|
)
|
|
|
|
|
|
def main(argv: list[str] | None = None) -> int:
|
|
parser = build_parser()
|
|
args = parser.parse_args(argv)
|
|
|
|
if args.password is None and not args.regenerate:
|
|
parser.print_help()
|
|
return 0
|
|
|
|
try:
|
|
message = asyncio.run(_run(args.password, args.regenerate))
|
|
except ValueError as exc:
|
|
print(f"error: {exc}", file=sys.stderr)
|
|
return 2
|
|
|
|
print(message)
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
raise SystemExit(main())
|