1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
"""
Authentication: local password login and OAuth2 authorization-code (browser).
FastAPI security integration
----------------------------
- ``OAuth2PasswordBearer`` + ``APIKeyCookie``: extract PyGitWeb's opaque session id from
``Authorization: Bearer`` or the login cookie. This is *not* an IdP JWT; OpenAPI still
documents the password ``/token`` flow that mints these session ids.
- ``OAuth2PasswordRequestForm``: local ``POST /token`` only (resource-owner password grant).
- External IdP login (Google/GitHub) uses standard authorization-code redirects implemented
in ``auth_oauth``; ``OAuth2AuthorizationCodeBearer`` is intentionally not used because
clients never receive or send the provider's access token—only our session id.
"""
from __future__ import annotations
import hmac
from typing import Annotated
from fastapi import APIRouter, Depends, Form, HTTPException, Query, status
from fastapi.responses import HTMLResponse, RedirectResponse
from fastapi.security import APIKeyCookie, OAuth2PasswordBearer, OAuth2PasswordRequestForm
from pydantic import BaseModel
from pygitweb.auth_config import (
auth_config,
is_auth_configured,
is_local_auth_available,
is_oauth_auth_available,
)
from pygitweb.auth_oauth import OAUTH_STATE_COOKIE_NAME, oauth_router
from pygitweb.config import settings
from pygitweb.gravatar import gravatar_url
from pygitweb.password_hash import verify_password
from pygitweb.permissions import Permission, PermissionPrincipal, has_branch_read_permission
from pygitweb.projects import git_get_project_owner
from pygitweb.sessions import create_session, get_session, revoke_session
from pygitweb.templates_env import POSTAMBLE, PREAMBLE, env
ACCESS_TOKEN_COOKIE_NAME = "pygitweb_access_token"
LOGIN_COOKIE_MAX_AGE = 60 * 60 * 24 * 7
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token", auto_error=False)
_access_token_cookie = APIKeyCookie(name=ACCESS_TOKEN_COOKIE_NAME, auto_error=False)
TAG_AUTH = "auth"
TAG_AUTH_LOCAL = "auth - local"
TAG_AUTH_OAUTH = "auth - OAuth"
auth_router = APIRouter()
auth_router.include_router(oauth_router)
class User(BaseModel):
username: str
email: str | None = None
def principal_from_session(token: str | None) -> PermissionPrincipal | None:
if not token:
return None
rec = get_session(token)
if rec is None:
return None
return PermissionPrincipal(username=rec.username, email=rec.email)
def _anonymous_principal_for_permissions() -> PermissionPrincipal | None:
for entry in auth_config.local_users:
if getattr(entry, "assume_anonymous", False):
return PermissionPrincipal(username=entry.user, email=entry.email)
return None
def _principal_identity_for_permissions(token: str | None) -> str | None:
principal = principal_from_session(token)
if principal is not None:
return principal.identity
anonymous = _anonymous_principal_for_permissions()
if anonymous is not None:
return anonymous.identity
return None
def has_permission(
permission: Permission,
project: str | None = None,
*,
token: str | None = None,
) -> bool:
if not settings.AUTH:
return True
identity = _principal_identity_for_permissions(token)
if identity is None:
return False
return auth_config.oauth_permissions.has_permission(identity, permission, project)
def _owner_matches(project: str, token: str | None) -> bool:
if not settings.AUTH or not token:
return False
principal = principal_from_session(token)
if principal is None:
return False
owner = git_get_project_owner(project)
if not owner or not owner.strip():
return False
owner_norm = owner.strip()
identity = principal.identity
if hmac.compare_digest(owner_norm, identity):
return True
return owner_norm.lower() == identity.lower()
def can_read_project(project: str, token: str | None) -> bool:
if not settings.AUTH:
return True
if _owner_matches(project, token):
return True
return has_permission(Permission.READ, project, token=token)
def can_write_project(project: str, token: str | None) -> bool:
if not settings.AUTH:
return True
if _owner_matches(project, token):
return True
return has_permission(Permission.WRITE, project, token=token)
def can_read_branch(project: str, ref_name: str, token: str | None) -> bool:
if not settings.AUTH:
return True
if _owner_matches(project, token):
return True
identity = _principal_identity_for_permissions(token)
if identity is None:
return False
return has_branch_read_permission(auth_config.oauth_permissions, identity, project, ref_name)
def ensure_read_project(project: str, token: str | None) -> None:
if can_read_project(project, token):
return
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="No such project")
def ensure_write_project(project: str, token: str | None) -> None:
if not settings.AUTH:
return
if not is_auth_configured(auth_config):
raise HTTPException(
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
detail="Authentication enabled but auth.json is not configured",
)
if not token:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
if decode_access_token(token) is None:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
if can_write_project(project, token):
return
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Insufficient permissions",
)
def ensure_permission(
permission: Permission,
project: str | None = None,
*,
token: str | None,
) -> None:
ensure_active_user_if_auth_enabled(token)
if project is not None:
ensure_read_project(project, token)
if has_permission(permission, project, token=token):
return
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Insufficient permissions",
)
def require_permission(
permission: Permission,
*,
project_from_query: bool = False,
project_from_form: bool = False,
) -> object:
"""Return a FastAPI dependency that enforces ``permission`` when auth is enabled."""
if project_from_query:
def _dep_query_project(
token: Annotated[str | None, Depends(access_token_from_request)],
project: Annotated[str, Query()],
) -> None:
ensure_permission(permission, project, token=token)
return _dep_query_project
if project_from_form:
def _dep_form_project(
token: Annotated[str | None, Depends(access_token_from_request)],
project: Annotated[str, Form()],
) -> None:
ensure_permission(permission, project, token=token)
return _dep_form_project
def _dep(
token: Annotated[str | None, Depends(access_token_from_request)],
) -> None:
ensure_permission(permission, None, token=token)
return _dep
def get_local_user(username: str) -> User | None:
if not settings.AUTH or not is_local_auth_available(auth_config):
return None
for entry in auth_config.local_users:
if not entry.pass_hash and not entry.password:
continue
if hmac.compare_digest(entry.user, username):
return User(username=entry.user, email=entry.email)
return None
def authenticate_local_user(username: str, password: str) -> User | None:
if auth_config.auth_mode not in ("local", "both"):
return None
for entry in auth_config.local_users:
if not hmac.compare_digest(entry.user, username):
continue
if entry.pass_hash:
if not verify_password(password, entry.pass_hash, config_salt=auth_config.salt):
return None
return User(username=entry.user, email=entry.email)
if entry.password is not None and hmac.compare_digest(entry.password, password):
return User(username=entry.user, email=entry.email)
return None
return None
def decode_access_token(token: str) -> User | None:
if not settings.AUTH:
return None
rec = get_session(token)
if rec is None:
return None
return User(username=rec.username)
def safe_next_url(next_raw: str | None) -> str:
n = (next_raw or "/").strip()
if not n.startswith("/") or n.startswith("//"):
return "/"
return n
def access_token_from_request(
bearer: Annotated[str | None, Depends(oauth2_scheme)],
cookie_token: Annotated[str | None, Depends(_access_token_cookie)],
) -> str | None:
b = bearer.strip() if bearer else None
c = cookie_token.strip() if cookie_token else None
return b or c
def ensure_active_user_if_auth_enabled(token: str | None) -> None:
if not settings.AUTH:
return
if not is_auth_configured(auth_config):
raise HTTPException(
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
detail="Authentication enabled but auth.json is not configured",
)
if not token:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
if decode_access_token(token) is None:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
def require_active_user_if_auth_enabled(
token: Annotated[str | None, Depends(access_token_from_request)],
) -> None:
ensure_active_user_if_auth_enabled(token)
@auth_router.get(
"/login",
response_class=HTMLResponse,
tags=[TAG_AUTH],
summary="Sign-in page",
description="HTML sign-in page. Shows local and/or OAuth options depending on auth.json.",
)
async def login_page(
next: Annotated[str, Query()] = "/",
) -> HTMLResponse:
if not settings.AUTH:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Authentication is disabled")
next_safe = safe_next_url(next)
pre = PREAMBLE.render(title=f"{settings.SITE_NAME} - Sign in", site_name=settings.SITE_NAME)
body = env.get_template("login.html").render(
site_name=settings.SITE_NAME,
next=next_safe,
error=None,
local_available=is_local_auth_available(auth_config),
oauth_available=is_oauth_auth_available(auth_config),
oauth_provider=str(auth_config.oauth_provider).strip() or "OAuth",
)
return HTMLResponse(f"{pre}{body}{POSTAMBLE}")
@auth_router.post(
"/login",
response_model=None,
tags=[TAG_AUTH_LOCAL],
summary="Local sign-in (form)",
description="Browser form login. Sets the pygitweb_access_token session cookie on success.",
responses={303: {"description": "Redirect to next URL with session cookie set"}},
)
async def login_form_submit(
username: Annotated[str, Form()],
password: Annotated[str, Form()],
next: Annotated[str, Form()] = "/",
) -> HTMLResponse | RedirectResponse:
if not settings.AUTH:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Authentication is disabled")
if not is_local_auth_available(auth_config):
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Local sign-in is not enabled")
next_safe = safe_next_url(next)
user = authenticate_local_user(username.strip(), password)
if user is None:
pre = PREAMBLE.render(title=f"{settings.SITE_NAME} - Sign in", site_name=settings.SITE_NAME)
body = env.get_template("login.html").render(
site_name=settings.SITE_NAME,
next=next_safe,
error="Incorrect username or password.",
local_available=True,
oauth_available=is_oauth_auth_available(auth_config),
oauth_provider=str(auth_config.oauth_provider).strip() or "OAuth",
)
return HTMLResponse(f"{pre}{body}{POSTAMBLE}")
sid = create_session(user.username, email=user.email, auth_method="local")
resp = RedirectResponse(url=next_safe, status_code=303)
resp.set_cookie(
key=ACCESS_TOKEN_COOKIE_NAME,
value=sid,
httponly=True,
samesite="lax",
max_age=LOGIN_COOKIE_MAX_AGE,
path="/",
)
return resp
@auth_router.get(
"/logout",
tags=[TAG_AUTH],
summary="Sign out",
description="Revokes the current session (cookie or Bearer) and clears auth cookies.",
responses={303: {"description": "Redirect to next URL"}},
)
async def logout_page(
token: Annotated[str | None, Depends(access_token_from_request)],
next: Annotated[str, Query()] = "/",
) -> RedirectResponse:
revoke_session(token)
resp = RedirectResponse(url=safe_next_url(next), status_code=303)
resp.delete_cookie(key=ACCESS_TOKEN_COOKIE_NAME, path="/")
resp.delete_cookie(key=OAUTH_STATE_COOKIE_NAME, path="/")
return resp
@auth_router.post(
"/token",
tags=[TAG_AUTH_LOCAL],
summary="Obtain session token (local)",
description=(
"OAuth2 password flow for API clients. Returns an opaque session id as access_token; "
"use Authorization: Bearer on protected routes. Not an identity-provider JWT."
),
)
async def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]) -> dict[str, str]:
if not settings.AUTH:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Authentication is disabled")
if not is_local_auth_available(auth_config):
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Local sign-in is not enabled")
user = authenticate_local_user(form_data.username, form_data.password)
if user is None:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Incorrect username or password")
sid = create_session(user.username, email=user.email, auth_method="local")
return {"access_token": sid, "token_type": "bearer"}
@auth_router.get(
"/auth/status",
tags=[TAG_AUTH],
summary="Auth status (navbar)",
description="Lightweight JSON for the navbar script. Does not return 401 when anonymous.",
)
async def auth_status(
token: Annotated[str | None, Depends(access_token_from_request)],
) -> dict[str, bool | str | None]:
if not settings.AUTH:
return {"auth_enabled": False, "username": None, "gravatar_url": None}
if not token:
return {"auth_enabled": True, "username": None, "gravatar_url": None}
rec = get_session(token)
if rec is None:
return {"auth_enabled": True, "username": None, "gravatar_url": None}
avatar = gravatar_url(rec.email) if rec.email else None
return {"auth_enabled": True, "username": rec.username, "gravatar_url": avatar}
@auth_router.get(
"/user",
response_class=HTMLResponse,
response_model=None,
tags=[TAG_AUTH],
summary="Account page",
description="HTML account page for the signed-in user.",
)
async def user_account_page(
token: Annotated[str | None, Depends(access_token_from_request)],
) -> HTMLResponse | RedirectResponse:
if not settings.AUTH:
pre = PREAMBLE.render(title=f"{settings.SITE_NAME} - Account", site_name=settings.SITE_NAME)
body = '<p class="text-muted">Authentication is not enabled on this server.</p>'
return HTMLResponse(f"{pre}{body}{POSTAMBLE}")
if not is_auth_configured(auth_config):
raise HTTPException(
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
detail="Authentication is misconfigured",
)
u = decode_access_token(token or "") if token else None
if u is None:
return RedirectResponse(url="/login?next=/user", status_code=303)
pre = PREAMBLE.render(title=f"{settings.SITE_NAME} - Account", site_name=settings.SITE_NAME)
body = env.get_template("user_profile.html").render(username=u.username, site_name=settings.SITE_NAME)
return HTMLResponse(f"{pre}{body}{POSTAMBLE}")
@auth_router.get(
"/users/me",
response_model=User,
tags=[TAG_AUTH],
summary="Current user",
description="Returns the username for the current session (cookie or Bearer).",
)
async def read_users_me(
token: Annotated[str | None, Depends(access_token_from_request)],
) -> User:
if not settings.AUTH:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Authentication is disabled")
ensure_active_user_if_auth_enabled(token)
u = decode_access_token(token or "")
if u is None:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Not authenticated",
headers={"WWW-Authenticate": "Bearer"},
)
return u