Self hosted FLOSS fitness/workout, nutrition and weight tracker
Consolidate JWT Keys
Roland Geider556c43d0ad26
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex bffe0bd01..c1d74860d 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -1,5 +1,8 @@# Changelog for the next release+> [!IMPORTANT]+> This release comes with several breaking changes. Please read carefully.+## Upgrade steps* Set the `PS_DATABASE_URI` with the wger db password in the usual format@@ -26,11 +29,20 @@ to UUID. This was made to allow for clients to generate IDs locally and affectsMake sure you have set the values for `SITE_URL`.+**Unified JWT signing keys.** The `SIGNING_KEY` environment variable is gone:+replace it with `JWT_PRIVATE_KEY` and `JWT_PUBLIC_KEY` generated by+`docker compose exec web ./manage.py generate-jwt-keys`. Note that existing+tokens will become invalid and logged-in users will need to login again.**`/api/v2/login/` endpoint removed.** This endpoint returned a permanent tokenIf you want to generate a new token, visit the "API key" page in the user settingsand paste it into scripts.+**`/api/v2/token` endpoint removed.** Exchanging username + password for a JWT+pair via this endpoint bypassed 2FA. To get tokens, either use+`/_allauth/app/v1/auth/login` (which respects the MFA challenge flow) or mint+a long-lived refresh token from the "API key" page in the user settings.+## Othersdiff --git a/settings/ci.py b/settings/ci.pyindex 04423b09c..f5849e70c 100644--- a/settings/ci.py+++ b/settings/ci.py@@ -68,9 +68,53 @@ RECAPTCHA_PUBLIC_KEY = ''RECAPTCHA_PRIVATE_KEY = ''USE_RECAPTCHA = False+# Test-only RSA keypair for JWT, safe to commit.+JWT_PRIVATE_KEY = (+ 'eyJhbGciOiAiUlMyNTYiLCAia3R5IjogIlJTQSIsICJuIjogIjlSbXdqZDJadG9DUzg4N0hNY2JpNFpK'+ 'RE5WS3dBWG1QSURSby1vejdaWWl1SFpUSzRXNkJYUHpIWnJJd1g5ZXFEOWJBSmNUZzd5NGFKbHRPZ1JY'+ 'aFFwdDFZbWo2THRTbkV6NEdRQnM4MjVUS2liS3NIRVpHV2Y5cENWazFleTB3XzNEQTNFSEhQdWNwdEto'+ 'cHhzNFFXRERSTEFGamh6WHJVZjQ5X3R2S25aWVcyZ295NEpLVEFsdGFZLUJfemVYYTZZZUx2d1JBbTJU'+ 'eVgtV0o5aGVVNjFVRTZ1R2toaTg2Y240WjdlSmsxYmtpNUlxNGRBMC1nVElrNGNzR3VZV2FNU0hfLThP'+ 'b1NGU0FjcTFMRGVfdlYwSFhmUHZMMmpSeEhsTkQ1cE12dUlZRU8tNU8yeHVzZU5JU2lJN1YzVDJaWGJG'+ 'UWdESHZ2YXlCV0lhQ3V0Z0x5dyIsICJlIjogIkFRQUIiLCAiZCI6ICJJUVFBNEZ0RlpXd1VYM3N2SWVs'+ 'a2puWWhUNEZfNl9MdjhLcWVxWUZzSzlVcGZ4cVg2WjMxRncyRjNyT0tDSjhJYlhIRUdGSlk2bDhQYnJO'+ 'RjgtVjZubnBLYWFNeWNEUjhfUDZSNFBqS1RkblJIcE5PMDlBemtkUHgxaXlLSTdtR3JDSUlHS05UcjRs'+ 'Ny1MWG02YnpBUHVEMGpEVHpyemI0Si1kVGVvMG8wZWt1VnMxTmFHRjBKOUgxeXJyUUt3d1ZtejJEZWoz'+ 'OVBERFFWbmVCNk5VNDhzQnRqaFc1YnpBNXF1bWlwSm8tQm9MY0stQ3lBVWl2YVJoYU5IT2U0SDFXYzVT'+ 'RlA2czZyeGZ3Z1lNbHlLQVZZU1lvYUVvYThRUTh6akFxN0c3Z3FLQ1dHems5ZkZQUGZjbFVvcGtWWHVJ'+ 'elNZdXROV1NDUzQ5eVpJZExENk1JWVEiLCAicCI6ICItb2FHdzNpZElzbVNSNnkxZWNVVlkxYk51QnNG'+ 'Q2tFWURWcHNJQjg1YUlJS1NQR1dqTEFjM3hXU1hBZWktekxWY3pQTDVWRVFYQ09Fell2TGV3NWI1MUd0'+ 'SXM5MEp5ekxDVGh6SEl4NGlUdnVURUN0U09oMEoxUkxQcDdFbkxKREZsZUItN0txbjFDUWNNREQwV0Vi'+ 'SWJZd29XTmNDR1N3dzFEVWZ6RXhfRDAiLCAicSI6ICItblRRY3hHeEdoM3Q2YUluenNSZXhnRkxVaktn'+ 'c1NDMUtJMFRqeTRCUktlb040MFhYNXhDSHlfUnRzSkRneUljR1F6UjZNVXZxM0xwTnZNNzRkbHdRUTQ3'+ 'YkRCYlJIMjFVc05YeDl0c2phQUpuRGMtX1pONHFyQzNYMFpjM2pRTERuNEUxazFvQWxMTmM0QXNyNVB0'+ 'REFUSzF6YzdoaVJqSng4eGdQVjJnS2MiLCAiZHAiOiAiMXpGUzlQalgwUmZnSk56X2pUZHpKYjljT2Za'+ 'TG9BRkdEY0pMLWxPWDFtTk5QbGIyZ0thT1JqbWJYSjNhcTNlQXpkSUNKRm83ZVVteE8zWUhOUTZpZHRJ'+ 'N3JCa1Nwc3ZkSTNCdndHZ1E2YUNuRXF6RHJFcXY2MUNHeWFWTE1XWVdKa3pJaEZGMktoN2owMVpoWGFy'+ 'UnlXVmI1R1VhbXNNUzZ0SzFsUVBHOGVrIiwgImRxIjogImwtaWVQZ3p2QkU0LTdVUWpMUEJDSTRySmFw'+ 'TzJqM2l0S0dsWkFiRF9wLXFneHdEV3VuRUdVZkFwSE5aN0tHQlo5bi1tR2E3d0dPZGJ1SzZURll0UzRN'+ 'S0hIRG5BUWF5VmZCdHJkSmNNSW1KOU1iajRoY2thbVQwU0c4R0x0bUtPaWoyNUpWcFJ5WWI3Z2lDdC1k'+ 'aVpJSDhQb0xXcGJ0VkhKb1Z1LXk3bXIyVSIsICJxaSI6ICJub1QxRnVfMURfUFVxVEY2NlVJWXpNYVZB'+ 'bHN5ZU5WMFAydmMycFRZQ1lpb29lam4xNkEwc3FMMHZ3VmstM2Mzc2dtU0oyejc4SklWTXoxMlFtTHl1'+ 'aGlMa01HZEpzeUJUYTdnWGI2RXcxQnFHTmxoVHFXX0p6RGJEclNmSEJpMnA5dFZPUFVTSW5ZaURxbXRy'+ 'bkFMWnVDZ3ZqUFItVzlPaF9rTUlNbUJQUmMiLCAia2lkIjogImNpLXRlc3QifQ=='+)+JWT_PUBLIC_KEY = (+ 'eyJrdHkiOiAiUlNBIiwgIm4iOiAiOVJtd2pkMlp0b0NTODg3SE1jYmk0WkpETlZLd0FYbVBJRFJvLW96'+ 'N1pZaXVIWlRLNFc2QlhQekhackl3WDllcUQ5YkFKY1RnN3k0YUpsdE9nUlhoUXB0MVltajZMdFNuRXo0'+ 'R1FCczgyNVRLaWJLc0hFWkdXZjlwQ1ZrMWV5MHdfM0RBM0VISFB1Y3B0S2hweHM0UVdERFJMQUZqaHpY'+ 'clVmNDlfdHZLblpZVzJnb3k0SktUQWx0YVktQl96ZVhhNlllTHZ3UkFtMlR5WC1XSjloZVU2MVVFNnVH'+ 'a2hpODZjbjRaN2VKazFia2k1SXE0ZEEwLWdUSWs0Y3NHdVlXYU1TSF8tOE9vU0ZTQWNxMUxEZV92VjBI'+ 'WGZQdkwyalJ4SGxORDVwTXZ1SVlFTy01TzJ4dXNlTklTaUk3VjNUMlpYYkZRZ0RIdnZheUJXSWFDdXRn'+ 'THl3IiwgImUiOiAiQVFBQiIsICJhbGciOiAiUlMyNTYiLCAia2lkIjogImNpLXRlc3QifQ=='+)+SIMPLE_JWT['SIGNING_KEY'] = jwk_b64_to_pem(JWT_PRIVATE_KEY)+SIMPLE_JWT['VERIFYING_KEY'] = jwk_b64_to_pem(JWT_PUBLIC_KEY)+HEADLESS_JWT_PRIVATE_KEY = SIMPLE_JWT['SIGNING_KEY']+SITE_URL = 'http://localhost:8000'-MEDIA_ROOT = env.str('DJANGO_MEDIA_ROOT', '/tmp/')+MEDIA_ROOT = '/tmp/'MEDIA_URL = '/media/'ALLOWED_HOSTS = [diff --git a/settings/main.py b/settings/main.pyindex b437c6972..900f528c9 100644--- a/settings/main.py+++ b/settings/main.py@@ -45,9 +45,9 @@ _DEFAULT_KEYS = {'wger-docker-secret-jwtkey-1234567890!@#$%^&*(-_=+)',}-# SHA256 of the PowerSync JWKS keys shipped as defaults in docker/config/prod.env.+# SHA256 of the JWT keys shipped as defaults in docker/config/prod.env.# Using hashes instead of inlining the ~1KB base64 JWKs-_DEFAULT_POWERSYNC_KEY_HASHES = {+_DEFAULT_JWT_KEY_HASHES = {'993583b530ed307419c1fd54eef8c7010ac29fa9ee6ddfa3ed0e5204e2b5e99a', # public'964a4ebdb0d1b9f7ac461711a8861d74bd887a955b0e10d79b93c532f1e13d98', # private}@@ -101,19 +101,26 @@ if not SECRET_KEY or (SECRET_KEY in _DEFAULT_KEYS and not DEBUG):stacklevel=1,)-# PowerSync-POWERSYNC_JWKS_PUBLIC_KEY = env.str('POWERSYNC_JWKS_PUBLIC_KEY', '')-POWERSYNC_JWKS_PRIVATE_KEY = env.str('POWERSYNC_JWKS_PRIVATE_KEY', '')+# JWT keypair (RS256)+JWT_PUBLIC_KEY = env.str('JWT_PUBLIC_KEY', '')+JWT_PRIVATE_KEY = env.str('JWT_PRIVATE_KEY', '')POWERSYNC_URL_PATH = env.str('POWERSYNC_URL_PATH', 'ps')POWERSYNC_URL = env.str('POWERSYNC_URL', '')if not DEBUG and any(- key and hashlib.sha256(key.encode()).hexdigest() in _DEFAULT_POWERSYNC_KEY_HASHES- for key in (POWERSYNC_JWKS_PUBLIC_KEY, POWERSYNC_JWKS_PRIVATE_KEY)+ key and hashlib.sha256(key.encode()).hexdigest() in _DEFAULT_JWT_KEY_HASHES+ for key in (JWT_PUBLIC_KEY, JWT_PRIVATE_KEY)):warnings.warn(- 'POWERSYNC_JWKS_PUBLIC_KEY / POWERSYNC_JWKS_PRIVATE_KEY are set to the '- 'shipped default values, this is a security risk! Please generate a fresh keypair '- 'with `./manage.py generate-powersync-keys`',+ 'JWT_PUBLIC_KEY / JWT_PRIVATE_KEY are set to the shipped default values, '+ 'this is a security risk! Please generate a fresh keypair with '+ '`./manage.py generate-jwt-keys`',+ stacklevel=1,+ )+if not DEBUG and not (JWT_PRIVATE_KEY and JWT_PUBLIC_KEY):+ warnings.warn(+ 'JWT_PRIVATE_KEY / JWT_PUBLIC_KEY are not set. JWT authentication '+ 'will not work until you run `./manage.py generate-jwt-keys` and '+ 'add the output to your environment.',stacklevel=1,)@@ -266,38 +273,19 @@ WGER_SOCIAL_PROVIDERS = env.list('WGER_SOCIAL_PROVIDERS', default=[])# allauth.socialaccount itself is always installed (see settings_global.py) so# its models stay importable. Only the per-provider apps are env-gated.if WGER_SOCIAL_PROVIDERS:- INSTALLED_APPS += [- f'allauth.socialaccount.providers.{p}' for p in WGER_SOCIAL_PROVIDERS- ]+ INSTALLED_APPS += [f'allauth.socialaccount.providers.{p}' for p in WGER_SOCIAL_PROVIDERS]#-# Django Rest Framework SimpleJWT-#+# Django Rest Framework SimpleJWT + allauth.headless JWT+REFRESH_TOKEN_LIFETIME_HOURS = env.int('REFRESH_TOKEN_LIFETIME', 24 * 30 * 4)SIMPLE_JWT['ACCESS_TOKEN_LIFETIME'] = timedelta(minutes=env.int('ACCESS_TOKEN_LIFETIME', 15))-SIMPLE_JWT['REFRESH_TOKEN_LIFETIME'] = timedelta(- hours=env.int('REFRESH_TOKEN_LIFETIME', 24 * 30 * 4)-)-_SIGNING_KEY = env.str('SIGNING_KEY', '')-# In DEBUG mode, keep a known default so JWTs minted before a restart still-# verify after it. Outside DEBUG, replace + warn.-if not _SIGNING_KEY or (_SIGNING_KEY in _DEFAULT_KEYS and not DEBUG):- _SIGNING_KEY = secrets.token_urlsafe(50)- if not DEBUG:- warnings.warn(- 'SIGNING_KEY is not set or uses the default value so '- 'a random key was generated, sessions will not persist across restarts. '- 'Set SIGNING_KEY in your environment for production use.',- stacklevel=1,- )-SIMPLE_JWT['SIGNING_KEY'] = _SIGNING_KEY--# allauth.headless JWT signs with the same secret during the sunset window-# where both surfaces coexist. HS256 is configured in settings_global.py.-HEADLESS_JWT_PRIVATE_KEY = _SIGNING_KEY-# Refresh-token lifetime in seconds. Mirrors the legacy REFRESH_TOKEN_LIFETIME-# env var (hours) used for SimpleJWT, so the long-lived-refresh-token page on-# the web matches the rest of the headless surface.-HEADLESS_JWT_REFRESH_TOKEN_EXPIRES_IN = env.int('REFRESH_TOKEN_LIFETIME', 24 * 30 * 4) * 3600+SIMPLE_JWT['REFRESH_TOKEN_LIFETIME'] = timedelta(hours=REFRESH_TOKEN_LIFETIME_HOURS)+_JWT_PRIVATE_PEM = jwk_b64_to_pem(JWT_PRIVATE_KEY)+_JWT_PUBLIC_PEM = jwk_b64_to_pem(JWT_PUBLIC_KEY)+SIMPLE_JWT['SIGNING_KEY'] = _JWT_PRIVATE_PEM+SIMPLE_JWT['VERIFYING_KEY'] = _JWT_PUBLIC_PEM+HEADLESS_JWT_PRIVATE_KEY = _JWT_PRIVATE_PEM+HEADLESS_JWT_REFRESH_TOKEN_EXPIRES_IN = REFRESH_TOKEN_LIFETIME_HOURS * 3600## https://docs.djangoproject.com/en/4.1/ref/csrf/diff --git a/settings/settings_global.py b/settings/settings_global.pyindex 18f882d9a..fe9faed00 100644--- a/settings/settings_global.py+++ b/settings/settings_global.py@@ -14,12 +14,17 @@# Standard Libraryimport datetime+import jsonimport osimport reimport sys+from base64 import urlsafe_b64decodefrom datetime import timedeltafrom pathlib import Path+# Third Party+from jose import jwk as jose_jwk+# wgerfrom wger.utils.constants import DOWNLOAD_INGREDIENT_WGERfrom wger.version import get_version@@ -277,13 +282,23 @@ SOCIALACCOUNT_LOGIN_ON_GET = True#HEADLESS_CLIENTS = ('app',)HEADLESS_TOKEN_STRATEGY = 'allauth.headless.tokens.strategies.jwt.strategy.JWTTokenStrategy'-# HS256 with SECRET_KEY by default; main.py mirrors SIMPLE_JWT['SIGNING_KEY']-# into HEADLESS_JWT_PRIVATE_KEY so both surfaces share the same secret.-HEADLESS_JWT_ALGORITHM = 'HS256'-# 120 days, parity with the legacy SIMPLE_JWT REFRESH_TOKEN_LIFETIME default.-# main.py overrides via the REFRESH_TOKEN_LIFETIME env var (hours).+HEADLESS_JWT_ALGORITHM = 'RS256'HEADLESS_JWT_REFRESH_TOKEN_EXPIRES_IN = 120 * 24 * 3600++def jwk_b64_to_pem(b64_jwk_str: str):+ """+ Decode a base64-wrapped JWK (as written by generate-jwt-keys) into a PEM+ string suitable for SimpleJWT and allauth.headless.+ """++ if not b64_jwk_str:+ return ''++ jwk_dict = json.loads(urlsafe_b64decode(b64_jwk_str))+ pem = jose_jwk.construct(jwk_dict).to_pem()+ return pem.decode() if isinstance(pem, bytes) else pem+## Login#@@ -500,6 +515,7 @@ SIMPLE_JWT = {'ROTATE_REFRESH_TOKENS': True,'BLACKLIST_AFTER_ROTATION': True,'UPDATE_LAST_LOGIN': False,+ 'ALGORITHM': 'RS256',}#diff --git a/wger/core/api/powersync.py b/wger/core/api/powersync.pyindex 300914ae0..724a0eeec 100644--- a/wger/core/api/powersync.py+++ b/wger/core/api/powersync.py@@ -30,12 +30,12 @@ from jose.jwt import encode@lru_cache(maxsize=1)def _private_jwk():- return json.loads(urlsafe_b64decode(settings.POWERSYNC_JWKS_PRIVATE_KEY))+ return json.loads(urlsafe_b64decode(settings.JWT_PRIVATE_KEY))@lru_cache(maxsize=1)def public_jwk():- return json.loads(urlsafe_b64decode(settings.POWERSYNC_JWKS_PUBLIC_KEY))+ return json.loads(urlsafe_b64decode(settings.JWT_PUBLIC_KEY))def create_token(user_id):diff --git a/wger/core/management/commands/generate-powersync-keys.py b/wger/core/management/commands/generate-jwt-keys.pysimilarity index 80%rename from wger/core/management/commands/generate-powersync-keys.pyrename to wger/core/management/commands/generate-jwt-keys.pyindex e5f845690..b05dce777 100644--- a/wger/core/management/commands/generate-powersync-keys.py+++ b/wger/core/management/commands/generate-jwt-keys.py@@ -32,19 +32,23 @@ from jose import jwkclass Command(BaseCommand):"""- Generates a fresh RS256 keypair for PowerSync JWT signing.+ Generates a fresh RS256 keypair for JWT signing.++ The same key is used by SimpleJWT, allauth.headless, and the PowerSync+ token endpoint; the JWT 'aud' claim separates the use cases."""help = (- 'Generate a fresh RS256 keypair for PowerSync JWT signing/verification. '- 'The output can be pasted into the docker compose env file.'+ 'Generate a fresh RS256 keypair for JWT signing/verification (SimpleJWT, '+ 'allauth.headless, PowerSync). The output can be pasted into the docker '+ 'compose env file.')def add_arguments(self, parser):parser.add_argument('--kid',- default='powersync',- help='Key ID written into the JWK and the JWT header (default: powersync).',+ default='wger',+ help='Key ID written into the JWK and the JWT header (default: wger).',)parser.add_argument('--key-size',@@ -83,9 +87,9 @@ class Command(BaseCommand):self.stdout.write(self.style.WARNING('# Paste these into your environment file (e.g. docker/config/prod.env).\n'- '# Keep POWERSYNC_JWKS_PRIVATE_KEY secret — never commit it to a public repo.'+ '# Keep JWT_PRIVATE_KEY secret, never commit it to a public repo.'))self.stdout.write('')- self.stdout.write(f'POWERSYNC_JWKS_PRIVATE_KEY={b64_jwk(priv_jwk)}')- self.stdout.write(f'POWERSYNC_JWKS_PUBLIC_KEY={b64_jwk(pub_jwk)}')+ self.stdout.write(f'JWT_PRIVATE_KEY={b64_jwk(priv_jwk)}')+ self.stdout.write(f'JWT_PUBLIC_KEY={b64_jwk(pub_jwk)}')