Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return None if deref encouters a broken reference (fixes #384) #386

Merged
merged 2 commits into from
Apr 9, 2024
Merged

Return None if deref encouters a broken reference (fixes #384) #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
940c544
Return `None` if `deref` finds a broken reference
br-olf Mar 21, 2024
9f7b8df
update docstring
Evidlo Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pykeepass/pykeepass.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ def deref(self, value):
ref (str): KeePass reference string to another field

Returns:
str or uuid.UUID
str, uuid.UUID or None if no match found

[fieldref]: https://keepass.info/help/base/fieldrefs.html
"""
Expand All @@ -710,6 +710,8 @@ def deref(self, value):
if search_in == 'uuid':
search_value = uuid.UUID(search_value)
ref_entry = self.find_entries(first=True, **{search_in: search_value})
if ref_entry is None:
return None
value = value.replace(ref, getattr(ref_entry, wanted_field))
return self.deref(value)

Expand Down
14 changes: 14 additions & 0 deletions tests/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,20 @@ def test_references(self):
self.assertNotEqual(original_entry, clone1)
self.assertNotEqual(clone1, clone2)

def test_broken_reference(self):
# TODO: move the entry into test databases
broken_entry_title = 'broken reference'
self.kp.add_entry(
self.kp.root_group,
title=broken_entry_title,
username='{REF:U@I:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA}',
password='{REF:P@I:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA}',
)
broken_entry = self.kp.find_entries(title=broken_entry_title, first=True)
self.assertEqual(broken_entry.deref('username'), None)
self.assertEqual(broken_entry.deref('password'), None)
self.kp.delete_entry(broken_entry)

def test_set_and_get_fields(self):
time = datetime.now(timezone.utc).replace(microsecond=0)
changed_time = time + timedelta(hours=9)
Expand Down