ske087/digiserver-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make player token reset non-breaking (deferred rotation)

Browse Source 
The maintenance-page reset used to rotate auth_code immediately. Because the
token also guards the playlist endpoints, that stopped a player from syncing
content the instant the button was pressed -- before the player ever had a
chance to react -- and clients that do not understand the heartbeat's
401 auth_required would have stayed broken until redeployed.

Split the model behaviour:

* request_reauth()  -- sets the flag only (used by the admin reset endpoints
  and the automatic interval). The current token stays valid, so there is no
  outage while the player is being asked to re-authenticate.
* issue_new_token() -- replaces the token now (used by the existing
  "regenerate auth code" action, where the admin is shown the new value).
* mark_authenticated() -- if a reset was pending, this is where the old token
  is retired: a new token is issued and returned to the player in the
  /api/auth/player response.

Net effect: the reset is a request the player acts on, never a forced logout.
A player that ignores it keeps working and shows as "awaiting re-auth" in the
UI; one that handles it gets a fresh token and the old one stops working.

Maintenance page wording updated to match (request vs reset; "awaiting
re-auth" badge), plus a themed info note explaining it is not a forced logout.

Adds docs/player-auth-reset.md describing the protocol and exactly what the
player client (Kiwy-Signage) still needs to implement: detect 401 /
auth_required on the heartbeat (and on the token-guarded endpoints), re-run
POST /api/auth/player with the stored quick-connect code, save the new
auth_code and retry. No password or SSH redeploy required.

Verified end-to-end: token unchanged and still accepted after the request
(200), heartbeat answers 401 auth_required=token_reset, re-auth issues a
different token, the old token is then rejected (403) and the new one accepted
(200), flag cleared; the interval path only flags without rotating.
This commit is contained in:
scheianu
2026-10-14 23:14:11 +03:00
parent 4dc8506c9b
commit 6b0e51898c
6 changed files with 287 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/blueprints/admin.py
+20 -15
View File
@@ -1585,22 +1585,27 @@ def maintenance_set_interval():
@login_required
@admin_required
def maintenance_reset_token(player_id: int):
"""Reset a single player's authentication token."""
"""Request that a single player re-authenticate.
The token is not replaced here (see ``Player.request_reauth``): the player
is flagged, told to authenticate again on its next heartbeat, and receives
a fresh token at that point.
"""
try:
player = Player.query.get_or_404(player_id)
player.rotate_auth_token(force_reauth=True)
player.request_reauth()
db.session.commit()
log_action('info',
f'Auth token reset for player "{player.name}" '
f'Re-authentication requested for player "{player.name}" '
f'(ID: {player.id}) by {current_user.username}')
flash(f'Token reset for "{player.name}". It will re-authenticate on its '
f'next heartbeat.', 'success')
flash(f'"{player.name}" will be asked to re-authenticate on its next '
f'heartbeat and then receive a new token.', 'success')
except Exception as exc:
db.session.rollback()
log_action('error', f'Error resetting auth token: {exc}')
flash('Error resetting the authentication token.', 'danger')
log_action('error', f'Error requesting token reset: {exc}')
flash('Error requesting the re-authentication.', 'danger')
return redirect(url_for('admin.maintenance'))
@@ -1609,23 +1614,23 @@ def maintenance_reset_token(player_id: int):
@login_required
@admin_required
def maintenance_reset_all_tokens():
"""Reset the authentication token of every player."""
"""Request that every player re-authenticate (see ``request_reauth``)."""
try:
players = Player.query.all()
for player in players:
player.rotate_auth_token(force_reauth=True)
player.request_reauth()
db.session.commit()
log_action('info',
f'Auth tokens reset for all {len(players)} player(s) by '
f'{current_user.username}')
flash(f'Token reset for {len(players)} player(s). They will '
f're-authenticate on their next heartbeat.', 'success')
f'Re-authentication requested for all {len(players)} '
f'player(s) by {current_user.username}')
flash(f'{len(players)} player(s) will be asked to re-authenticate on '
f'their next heartbeat and then receive new tokens.', 'success')
except Exception as exc:
db.session.rollback()
log_action('error', f'Error resetting all auth tokens: {exc}')
flash('Error resetting the authentication tokens.', 'danger')
log_action('error', f'Error requesting all token resets: {exc}')
flash('Error requesting the re-authentications.', 'danger')
return redirect(url_for('admin.maintenance'))
app/blueprints/api.py
+23 -14
View File
@@ -115,8 +115,12 @@ def player_needs_reauth(player: Player):
* an explicit reset flag (``auth_reset_required``) set from the admin
maintenance page, individually or for every player; and
* the optional automatic expiry interval configured on that page — a token
older than ``reset_interval_days`` is rotated and the player is asked to
authenticate again.
older than ``reset_interval_days`` asks the player to authenticate again.
Both are *requests*, not enforcement: the flag is raised here and the token
is only replaced once the player actually re-authenticates (see
``Player.mark_authenticated``). That keeps a player which cannot handle the
request working instead of silently losing playlist sync.
Args:
player: The player sending the heartbeat.
@@ -139,9 +143,8 @@ def player_needs_reauth(player: Player):
return False, None
if datetime.utcnow() - issued >= timedelta(days=interval_days):
# Expire the token now: rotate it and flag the player, so the response
# below tells the client to restart authentication.
player.rotate_auth_token(force_reauth=True)
# Flag the player; the replacement token is issued when it re-auths.
player.request_reauth()
db.session.commit()
return True, 'token_expired'
@@ -199,10 +202,12 @@ def authenticate_player():
log_action('warning', f'Failed authentication attempt for hostname: {hostname}')
return jsonify({'error': 'Invalid credentials'}), 401
# Update player status and stamp the token. Marking the player as
# authenticated clears any pending re-authentication request set from the
# admin maintenance page, so a player that just re-authenticated stops
# being told to authenticate again.
# Update player status and finalise the token. If a re-authentication had
# been requested (admin reset or expiry interval), this is where the old
# token is retired: mark_authenticated() issues a brand-new one. The value
# is returned below as `auth_code`, so the player picks it up here. A
# player that re-authenticated with no request pending simply gets its
# issue time refreshed.
player.mark_authenticated()
player.update_status('online')
db.session.commit()
@@ -554,11 +559,15 @@ def receive_player_feedback():
return jsonify({'error': 'Invalid quickconnect code'}), 403
# ------------------------------------------------------------------
# Authentication-token reset.
# Re-authentication request.
#
# When an admin requests a token reset (or an automatic reset interval
# elapses), the heartbeat is answered with 401 + auth_required so the
# client restarts its authentication flow. The player's existing token
# is still valid at this point — it is replaced only once the client
# actually re-authenticates — so a player that does not understand this
# response keeps syncing instead of breaking.
#
# When the admin maintenance page resets a player's token (or an
# automatic reset interval has elapsed), the heartbeat is answered with
# 401 + auth_required so the client restarts its authentication flow.
# This runs before any feedback is recorded: the heartbeat is not a
# meaningful status update while the client is being asked to
# re-authenticate.
@@ -571,7 +580,7 @@ def receive_player_feedback():
'success': False,
'auth_required': True,
'reason': reauth_reason,
'message': 'Authentication token reset. Please re-authenticate.',
'message': 'Re-authentication required. Please authenticate again.',
}), 401
# Create feedback record
app/blueprints/players.py
+6 -4
View File
@@ -300,10 +300,12 @@ def regenerate_auth_code(player_id: int):
try:
player = Player.query.get_or_404(player_id)
# Issue a new auth code and stamp the issue time so the maintenance
# page's reset interval measures age from this point. A manual
# regenerate keeps its previous behaviour (no forced re-auth).
new_auth_code = player.rotate_auth_token(force_reauth=False)
# Issue a new auth code immediately and stamp the issue time so the
# maintenance page's reset interval measures age from this point. The
# admin is shown the new value, so an immediate swap is intended here —
# unlike the maintenance page, which only asks the player to re-auth.
new_auth_code = player.issue_new_token()
player.auth_reset_required = False
db.session.commit()
log_action('info', f'Auth code regenerated for player "{player.name}" (ID: {player_id})')
app/models/player.py
+40 -21
View File
@@ -41,8 +41,10 @@ class Player(db.Model):
# Authentication token lifecycle. ``auth_token_issued_at`` records when the
# current ``auth_code`` was handed out, so the maintenance page can expire
# tokens by age. ``auth_reset_required`` is set when the token has been
# invalidated; the next heartbeat then tells the player to re-authenticate.
# tokens by age. ``auth_reset_required`` is set when a re-authentication has
# been requested (by an admin, or by the automatic interval); the next
# heartbeat then tells the player to authenticate again, and the token is
# replaced at the moment it does. See :meth:`request_reauth`.
auth_token_issued_at = db.Column(db.DateTime, nullable=True)
auth_reset_required = db.Column(db.Boolean, default=False, nullable=False)
@@ -126,35 +128,52 @@ class Player(db.Model):
from app.extensions import bcrypt
return bcrypt.check_password_hash(self.quickconnect_code, code)
def rotate_auth_token(self, force_reauth: bool = True) -> str:
"""Issue a brand new authentication token for this player.
Rotating the token invalidates any token the player currently holds:
endpoints guarded by ``verify_player_auth`` will start returning 401
for the old value. Combined with ``auth_reset_required`` this makes the
player restart its authentication flow on the next heartbeat.
Args:
force_reauth: When True (default) also flag the player so the next
heartbeat asks it to re-authenticate.
def issue_new_token(self) -> str:
"""Replace the authentication token immediately.
The old token stops working at once, so this is only safe when the
caller can hand the new value straight to the player — i.e. during
authentication itself, or when an admin explicitly asks for a new code
to be shown in the UI. To *ask* a running player to re-authenticate,
use :meth:`request_reauth` instead.
Returns:
The newly generated auth code.
"""
import secrets
self.auth_code = secrets.token_urlsafe(16)
self.auth_token_issued_at = datetime.utcnow()
if force_reauth:
self.auth_reset_required = True
return self.auth_code
def request_reauth(self) -> None:
"""Ask the player to re-authenticate on its next heartbeat.
Deliberately *deferred*: the current token is left valid and only the
``auth_reset_required`` flag is set. The heartbeat then answers
``401 {auth_required: true}``, and when the player re-authenticates a
brand-new token is issued (:meth:`mark_authenticated`), at which point
the old one finally stops working.
Why not rotate at once: the token guards the playlist endpoints, so
rotating it immediately would stop a player from syncing content the
moment the admin pressed the button — before the player ever had the
chance to re-authenticate. Deferring makes the operation non-breaking
for players that do not (yet) react to the request.
"""
self.auth_reset_required = True
def mark_authenticated(self) -> None:
"""Record a successful authentication.
Stamps the token issue time and clears any pending reset request, so a
player that re-authenticates stops being told to authenticate again.
Stamps the token issue time and clears any pending reset request. If a
reset *was* pending, this is the point where the old token dies: a
brand-new token is generated (available afterwards as ``auth_code``)
so the caller's response hands the player a fresh credential.
"""
self.auth_token_issued_at = datetime.utcnow()
if self.auth_reset_required:
self.issue_new_token()
else:
self.auth_token_issued_at = datetime.utcnow()
self.auth_reset_required = False
def auth_token_age_days(self) -> Optional[float]:
app/templates/admin/maintenance.html
+32 -8
View File
@@ -27,6 +27,23 @@
color: #92400e;
}
/* Informational note (e.g. the "this is a request, not a forced logout"
explanation), themed so it stays readable in both modes. */
.maint-note {
padding: 10px 14px;
border-radius: 8px;
font-size: 0.875rem;
background: #e7f3ff;
border-left: 4px solid #0066cc;
color: #0c5460;
}
body.dark-mode .maint-note {
background: #1e3a5f;
border-left-color: #90cdf4;
color: #cbd5e1;
}
body.dark-mode .maint-badge-pending {
background: #4a3800;
color: #fbbf24;
@@ -93,9 +110,16 @@
<!-- ================= Player Authentication Tokens ================= -->
<div class="card" style="margin-bottom: 30px;">
<h2>🔑 Player Authentication Tokens</h2>
<p style="color: #6c757d; margin-bottom: 20px;">
Resetting a token invalidates the player's current credentials. On its next
heartbeat the player is told to authenticate again and receives a fresh token.
<p style="color: #6c757d; margin-bottom: 12px;">
Requests that a player authenticate again. The player is told on its next
heartbeat and receives a fresh token when it does — its current token stays
valid until then, so playlist syncing is not interrupted.
</p>
<p class="maint-note" style="margin-bottom: 20px;">
ℹ️ This asks the player to re-authenticate; it is not a forced logout. A player
whose software does not yet handle the request keeps working on its existing
token and simply stays <em>awaiting&nbsp;re-auth</em> below. Players do not need
a password — the quick-connect code they already hold is enough.
</p>
<form method="POST" action="{{ url_for('admin.maintenance_set_interval') }}"
@@ -124,9 +148,9 @@
</form>
<form method="POST" action="{{ url_for('admin.maintenance_reset_all_tokens') }}"
onsubmit="return confirm('Reset the authentication token for ALL players? Each player will re-authenticate on its next heartbeat.');"
onsubmit="return confirm('Ask ALL players to re-authenticate? Each one will be told on its next heartbeat and then receive a new token. Their current tokens keep working until then.');"
style="margin-bottom: 20px;">
<button type="submit" class="btn btn-danger">🔁 Reset All Player Tokens</button>
<button type="submit" class="btn btn-danger">🔁 Request Re-auth for All Players</button>
</form>
<div style="max-height: 460px; overflow-y: auto;">
@@ -169,7 +193,7 @@
</td>
<td style="padding: 10px;">
{% if player.auth_reset_required %}
<span class="maint-badge-pending">pending</span>
<span class="maint-badge-pending" title="The player has been asked to re-authenticate; the token is replaced once it does.">awaiting re-auth</span>
{% else %}
<span style="color: var(--text-secondary); font-size: 12px;">—</span>
{% endif %}
@@ -178,9 +202,9 @@
<form method="POST"
action="{{ url_for('admin.maintenance_reset_token', player_id=player.id) }}"
style="display: inline;"
onsubmit="return confirm('Reset the token for {{ player.name }}?');">
onsubmit="return confirm('Ask {{ player.name }} to re-authenticate?');">
<button type="submit" class="btn btn-warning btn-sm"
style="padding: 4px 10px; font-size: 12px;">🔁 Reset</button>
style="padding: 4px 10px; font-size: 12px;">🔁 Re-auth</button>
</form>
{% if player.auth_reset_required %}
<form method="POST"