Merge pull request #517 from PR0M3TH3AN/codex/update-encryptionmanager-for-decryption-fallback

Add Fernet fallback for invalid V2 header
This commit is contained in:
thePR0M3TH3AN
2025-07-13 20:09:32 -04:00
committed by GitHub
2 changed files with 46 additions and 54 deletions

View File

@@ -8,9 +8,7 @@ try:
JSONDecodeError = orjson.JSONDecodeError JSONDecodeError = orjson.JSONDecodeError
USE_ORJSON = True USE_ORJSON = True
except ( except Exception: # pragma: no cover - fallback for environments without orjson
Exception
): # pragma: no cover - fallback for environments without orjson
import json as json_lib import json as json_lib
from json import JSONDecodeError from json import JSONDecodeError
@@ -60,9 +58,7 @@ class EncryptionManager:
self.key = base64.urlsafe_b64decode(self.key_b64) self.key = base64.urlsafe_b64decode(self.key_b64)
self.cipher = AESGCM(self.key) self.cipher = AESGCM(self.key)
logger.debug( logger.debug(f"EncryptionManager initialized for {self.fingerprint_dir}")
f"EncryptionManager initialized for {self.fingerprint_dir}"
)
except Exception as e: except Exception as e:
logger.error( logger.error(
f"Failed to initialize ciphers with provided encryption key: {e}", f"Failed to initialize ciphers with provided encryption key: {e}",
@@ -95,16 +91,19 @@ class EncryptionManager:
ciphertext = encrypted_data[15:] ciphertext = encrypted_data[15:]
return self.cipher.decrypt(nonce, ciphertext, None) return self.cipher.decrypt(nonce, ciphertext, None)
except InvalidTag as e: except InvalidTag as e:
logger.error( logger.error("AES-GCM decryption failed: Invalid authentication tag.")
"AES-GCM decryption failed: Invalid authentication tag." try:
) result = self.fernet.decrypt(encrypted_data[3:])
raise InvalidToken("AES-GCM decryption failed.") from e logger.warning(
"Legacy-format file had incorrect 'V2:' header; decrypted with Fernet"
)
return result
except InvalidToken:
raise InvalidToken("AES-GCM decryption failed.") from e
# If it's not V2, it must be the legacy Fernet format # If it's not V2, it must be the legacy Fernet format
else: else:
logger.warning( logger.warning("Data is in legacy Fernet format. Attempting migration.")
"Data is in legacy Fernet format. Attempting migration."
)
try: try:
return self.fernet.decrypt(encrypted_data) return self.fernet.decrypt(encrypted_data)
except InvalidToken as e: except InvalidToken as e:
@@ -126,9 +125,7 @@ class EncryptionManager:
fh.truncate() fh.truncate()
fh.write(encrypted_data) fh.write(encrypted_data)
os.chmod(self.parent_seed_file, 0o600) os.chmod(self.parent_seed_file, 0o600)
logger.info( logger.info(f"Parent seed encrypted and saved to '{self.parent_seed_file}'.")
f"Parent seed encrypted and saved to '{self.parent_seed_file}'."
)
def decrypt_parent_seed(self) -> str: def decrypt_parent_seed(self) -> str:
"""Decrypts and returns the parent seed, handling migration.""" """Decrypts and returns the parent seed, handling migration."""
@@ -140,9 +137,7 @@ class EncryptionManager:
decrypted_data = self.decrypt_data(encrypted_data) decrypted_data = self.decrypt_data(encrypted_data)
if is_legacy: if is_legacy:
logger.info( logger.info("Parent seed was in legacy format. Re-encrypting to V2 format.")
"Parent seed was in legacy format. Re-encrypting to V2 format."
)
self.encrypt_parent_seed(decrypted_data.decode("utf-8").strip()) self.encrypt_parent_seed(decrypted_data.decode("utf-8").strip())
return decrypted_data.decode("utf-8").strip() return decrypted_data.decode("utf-8").strip()
@@ -166,17 +161,13 @@ class EncryptionManager:
encrypted_data = fh.read() encrypted_data = fh.read()
return self.decrypt_data(encrypted_data) return self.decrypt_data(encrypted_data)
def save_json_data( def save_json_data(self, data: dict, relative_path: Optional[Path] = None) -> None:
self, data: dict, relative_path: Optional[Path] = None
) -> None:
if relative_path is None: if relative_path is None:
relative_path = Path("seedpass_entries_db.json.enc") relative_path = Path("seedpass_entries_db.json.enc")
if USE_ORJSON: if USE_ORJSON:
json_data = json_lib.dumps(data) json_data = json_lib.dumps(data)
else: else:
json_data = json_lib.dumps(data, separators=(",", ":")).encode( json_data = json_lib.dumps(data, separators=(",", ":")).encode("utf-8")
"utf-8"
)
self.encrypt_and_save_file(json_data, relative_path) self.encrypt_and_save_file(json_data, relative_path)
logger.debug(f"JSON data encrypted and saved to '{relative_path}'.") logger.debug(f"JSON data encrypted and saved to '{relative_path}'.")
@@ -207,9 +198,7 @@ class EncryptionManager:
# If it was a legacy file, re-save it in the new format now # If it was a legacy file, re-save it in the new format now
if is_legacy: if is_legacy:
logger.info( logger.info(f"Migrating and re-saving legacy vault file: {file_path}")
f"Migrating and re-saving legacy vault file: {file_path}"
)
self.save_json_data(data, relative_path) self.save_json_data(data, relative_path)
self.update_checksum(relative_path) self.update_checksum(relative_path)
@@ -244,16 +233,10 @@ class EncryptionManager:
data = json_lib.loads(decrypted_data) data = json_lib.loads(decrypted_data)
else: else:
data = json_lib.loads(decrypted_data.decode("utf-8")) data = json_lib.loads(decrypted_data.decode("utf-8"))
self.save_json_data( self.save_json_data(data, relative_path) # This always saves in V2 format
data, relative_path
) # This always saves in V2 format
self.update_checksum(relative_path) self.update_checksum(relative_path)
logger.info( logger.info("Index file from Nostr was processed and saved successfully.")
"Index file from Nostr was processed and saved successfully." print(colored("Index file updated from Nostr successfully.", "green"))
)
print(
colored("Index file updated from Nostr successfully.", "green")
)
except Exception as e: except Exception as e:
logger.error( logger.error(
f"Failed to decrypt and save data from Nostr: {e}", f"Failed to decrypt and save data from Nostr: {e}",
@@ -313,14 +296,10 @@ class EncryptionManager:
return True return True
except Exception as e: except Exception as e:
logging.error(f"Error validating seed phrase: {e}", exc_info=True) logging.error(f"Error validating seed phrase: {e}", exc_info=True)
print( print(colored(f"Error: Failed to validate seed phrase: {e}", "red"))
colored(f"Error: Failed to validate seed phrase: {e}", "red")
)
return False return False
def derive_seed_from_mnemonic( def derive_seed_from_mnemonic(self, mnemonic: str, passphrase: str = "") -> bytes:
self, mnemonic: str, passphrase: str = ""
) -> bytes:
try: try:
if not isinstance(mnemonic, str): if not isinstance(mnemonic, str):
if isinstance(mnemonic, list): if isinstance(mnemonic, list):
@@ -328,21 +307,13 @@ class EncryptionManager:
else: else:
mnemonic = str(mnemonic) mnemonic = str(mnemonic)
if not isinstance(mnemonic, str): if not isinstance(mnemonic, str):
raise TypeError( raise TypeError("Mnemonic must be a string after conversion")
"Mnemonic must be a string after conversion"
)
from bip_utils import Bip39SeedGenerator from bip_utils import Bip39SeedGenerator
seed = Bip39SeedGenerator(mnemonic).Generate(passphrase) seed = Bip39SeedGenerator(mnemonic).Generate(passphrase)
logger.debug("Seed derived successfully from mnemonic.") logger.debug("Seed derived successfully from mnemonic.")
return seed return seed
except Exception as e: except Exception as e:
logger.error( logger.error(f"Failed to derive seed from mnemonic: {e}", exc_info=True)
f"Failed to derive seed from mnemonic: {e}", exc_info=True print(colored(f"Error: Failed to derive seed from mnemonic: {e}", "red"))
)
print(
colored(
f"Error: Failed to derive seed from mnemonic: {e}", "red"
)
)
raise raise

View File

@@ -0,0 +1,21 @@
import logging
from pathlib import Path
from helpers import TEST_SEED
from utils.key_derivation import derive_index_key
from password_manager.encryption import EncryptionManager
def test_v2_prefix_fernet_fallback(tmp_path: Path, caplog) -> None:
key = derive_index_key(TEST_SEED)
manager = EncryptionManager(key, tmp_path)
original = b"legacy data"
token = manager.fernet.encrypt(original)
payload = b"V2:" + token
caplog.set_level(logging.WARNING, logger="password_manager.encryption")
decrypted = manager.decrypt_data(payload)
assert decrypted == original
assert "incorrect 'V2:' header" in caplog.text