class GroupTests(unittest.TestCase):
# get some things ready before testing
def setUp(self):
self.kp = PyKeePass(os.path.join(base_dir, 'test.kdbx'),
password='******',
keyfile=os.path.join(base_dir, 'test.key'))
def test_fields(self):
self.assertEqual(
self.kp.find_groups(name='subgroup2', first=True).path,
'foobar_group/subgroup/subgroup2')
class AlteraKeePass:
def __init__(self, arquivo_kdbx, senha):
self.kp = PyKeePass(arquivo_kdbx, password=senha)
def cria_entrada(self, grupo, nome, usuario, senha, url, icone, ip, porta):
self.group = self.kp.find_groups(name=grupo, first=True)
self.kp.add_entry(self.group,
nome,
usuario,
senha,
url=url,
icon=icone)
self.entry = self.kp.find_entries(title=nome, first=True)
self.entry.set_custom_property('IP', ip)
self.entry.set_custom_property('PORT', porta)
self.kp.save()
def keepassxc_new_ssh_key(db_name,
db_password,
passphrase="",
title="",
username=""):
kp = PyKeePass(db_name, password=db_password)
keyname = title.replace(" ", "-")
ssh_group = kp.find_groups(name="SSH", first=True)
if not ssh_group:
ssh_group = kp.add_group(kp.root_group, "SSH")
entry = kp.add_entry(ssh_group,
title=title,
username=username,
password=passphrase)
pub, priv = generate_keys(passphrase)
entry_ssh_settings = f"""\
<?xml version="1.0" encoding="UTF-16"?>
<EntrySettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AllowUseOfSshKey>true</AllowUseOfSshKey>
<AddAtDatabaseOpen>true</AddAtDatabaseOpen>
<RemoveAtDatabaseClose>true</RemoveAtDatabaseClose>
<UseConfirmConstraintWhenAdding>false</UseConfirmConstraintWhenAdding>
<UseLifetimeConstraintWhenAdding>true</UseLifetimeConstraintWhenAdding>
<LifetimeConstraintDuration>600</LifetimeConstraintDuration>
<Location>
<SelectedType>attachment</SelectedType>
<AttachmentName>{keyname}</AttachmentName>
<SaveAttachmentToTempFile>false</SaveAttachmentToTempFile>
</Location>
</EntrySettings>"""
attach(kp,
entry,
"KeeAgent.settings",
entry_ssh_settings,
encoding="utf-16")
attach(kp, entry, keyname, priv)
attach(kp, entry, f"{keyname}.pub", pub)
kp.save()
class KeePass():
def __init__(self, password, cfgfile='pass.yml'):
keyfile = None
with open(cfgfile, 'r') as ymlfile:
cfg = yaml.safe_load(ymlfile)['keepass']
dbfile = cfg['dbfile']
group = cfg['group']
newentry = cfg['newentry']
oldentry = cfg['oldentry']
if 'keyfile' in cfg:
keyfile = cfg['keyfile']
self.keepass = PyKeePass(dbfile, password=password, keyfile=keyfile)
self.group = self.keepass.find_groups(name=group, first=True)
self.oldentry = self.keepass.find_entries(
title=oldentry, group=self.group, first=True)
self.newentry = self.keepass.find_entries(
title=newentry, group=self.group, first=True)
def get_hosts(self):
hosts = self.oldentry.url
ret = []
for host in re.split(r'\s+', hosts):
ret.append(Host(
host, self.newentry.username, self.oldentry.password,
self.newentry.password))
return ret
def add_to_url(self, host):
if self.newentry.url is not None:
self.newentry.url = self.newentry.url + ' ' + host
else:
self.newentry.url = host
self.keepass.save()
def add_to_notes(self, msg):
if self.newentry.notes is not None:
self.newentry.notes = self.newentry.notes + '\n' + msg
else:
self.newentry.notes = msg
self.keepass.save()
class KeePassContainer:
def __init__(self, name, config):
self.name = name
self.keepass = PyKeePass(config['db_path'], password=config['db_password'])
def resolve(self, path, context):
keepass_path = KeePassEntryPath.parse(path)
group = self.keepass.find_groups(path=keepass_path.group_path) if keepass_path.group_path else None
entries = self.keepass.find_entries(title=keepass_path.title, group=group)
if entries and keepass_path.index < len(entries):
entry = entries[keepass_path.index]
return self.resolve_attribute(entry, keepass_path.attribute)
else:
return None
def resolve_attribute(self, entry, entry_attribute):
if (hasattr(entry, entry_attribute)):
return getattr(entry, entry_attribute)
else:
raise Exception('Could not resolve unknown property \'%s\'' % (entry_attribute,))
class EntryFunctionTests(unittest.TestCase):
# get some things ready before testing
def setUp(self):
self.kp = PyKeePass(os.path.join(base_dir, 'test.kdbx'),
password='******',
keyfile=os.path.join(base_dir, 'test.key'))
#---------- Finding entries -----------
def test_find_entries_by_title(self):
results = self.kp.find_entries_by_title('root_entry')
self.assertEqual(len(results), 1)
results = self.kp.find_entries_by_title('Root_entry',
regex=True,
flags='i',
first=True)
self.assertEqual('root_entry', results.title)
def test_find_entries_by_username(self):
results = self.kp.find_entries_by_username('foobar_user')
self.assertEqual(len(results), 2)
results = self.kp.find_entries_by_username('Foobar_user',
regex=True,
flags='i',
first=True)
self.assertEqual('foobar_user', results.username)
def test_find_entries_by_password(self):
results = self.kp.find_entries_by_password('passw0rd')
self.assertEqual(len(results), 2)
results = self.kp.find_entries_by_password('Passw0rd',
regex=True,
flags='i',
first=True)
self.assertEqual('passw0rd', results.password)
def test_find_entries_by_url(self):
results = self.kp.find_entries_by_url('http://example.com')
self.assertEqual(len(results), 2)
results = self.kp.find_entries_by_url('http://example.com', first=True)
self.assertEqual('http://example.com', results.url)
def test_find_entries_by_notes(self):
results = self.kp.find_entries_by_notes('entry notes')
self.assertEqual(len(results), 1)
results = self.kp.find_entries_by_notes('entry notes', regex=True)
self.assertEqual(len(results), 2)
results = self.kp.find_entries_by_notes('Entry notes',
regex=True,
flags='i',
first=True)
self.assertEqual('root entry notes', results.notes)
def test_find_entries_by_path(self):
results = self.kp.find_entries_by_path('foobar_group/group_entry')
self.assertEqual(len(results), 1)
results = self.kp.find_entries_by_path('foobar_group/Group_entry',
regex=True,
flags='i',
first=True)
self.assertIsInstance(results, Entry)
self.assertEqual('group_entry', results.title)
def test_find_entries_by_uuid(self):
results = self.kp.find_entries_by_uuid('zF9+zSoASMqWIcIio0ewuw==')[0]
self.assertIsInstance(results, Entry)
self.assertEqual('zF9+zSoASMqWIcIio0ewuw==', results.uuid)
self.assertEqual('foobar_user', results.username)
def test_find_entries_by_string(self):
results = self.kp.find_entries_by_string(
{'custom_field': 'custom field value'})[0]
self.assertIsInstance(results, Entry)
self.assertEqual('custom field value',
results.get_custom_property('custom_field'))
self.assertEqual('HnN4bHSVjEybPf8nOq1bVA==', results.uuid)
def test_find_entries(self):
results = self.kp.find_entries(title='Root_entry', regex=True)
self.assertEqual(len(results), 0)
results = self.kp.find_entries(title='Root_entry',
regex=True,
flags='i',
first=True)
self.assertEqual('root_entry', results.title)
results = self.kp.find_entries(url="http://example.com")
self.assertEqual(len(results), 2)
results = self.kp.find_entries(notes="entry notes",
url="http://example.com")
self.assertEqual(len(results), 1)
self.assertTrue(
self.kp.find_entries(title='group_entry', first=True) in results)
# test `group` argument
results = self.kp.find_entries(title='foobar_entry', group=None)
self.assertEqual(len(results), 3)
group = self.kp.find_groups(name='foobar_group', first=True)
results = self.kp.find_entries(title='foobar_entry', group=group)
self.assertEqual(len(results), 2)
#---------- Adding/Deleting entries -----------
def test_add_delete_move_entry(self):
unique_str = 'test_add_entry_'
expiry_time = datetime.now()
entry = self.kp.add_entry(self.kp.root_group,
unique_str + 'title',
unique_str + 'user',
unique_str + 'pass',
url=unique_str + 'url',
notes=unique_str + 'notes',
tags=unique_str + 'tags',
expiry_time=expiry_time,
icon=icons.KEY)
results = self.kp.find_entries_by_title(unique_str + 'title')
self.assertEqual(len(results), 1)
results = self.kp.find_entries_by_title(unique_str + 'title',
first=True)
self.assertEqual(results.title, unique_str + 'title')
self.assertEqual(results.username, unique_str + 'user')
self.assertEqual(results.password, unique_str + 'pass')
self.assertEqual(results.url, unique_str + 'url')
self.assertEqual(results.notes, unique_str + 'notes')
self.assertEqual(results.tags, [unique_str + 'tags'])
# convert naive datetime to utc
expiry_time_utc = expiry_time.replace(tzinfo=tz.gettz()).astimezone(
tz.gettz('UTC'))
self.assertEqual(results.icon, icons.KEY)
sub_group = self.kp.add_group(self.kp.root_group, 'sub_group')
self.kp.move_entry(entry, sub_group)
results = self.kp.find_entries(path='sub_group/' +
'test_add_entry_title',
first=True)
self.assertEqual(results.title, entry.title)
self.kp.delete_entry(entry)
results = self.kp.find_entries_by_title(unique_str + 'title',
first=True)
self.assertIsNone(results)
# test adding entry which exists in another group
subgroup = self.kp.find_groups(name='subgroup2', first=True)
self.kp.add_entry(subgroup,
title='foobar_entry',
username='******',
password='******')
# test adding entry to root which exists in subgroup
self.kp.add_entry(subgroup,
title='foobar_entry2',
username='******',
password='******')
self.kp.add_entry(self.kp.root_group,
title='foobar_entry2',
username='******',
password='******')
#---------- Entries name collision exception -----------
def test_raise_exception_entry(self):
unique_str = 'test_add_entry_'
entry = self.kp.add_entry(self.kp.root_group,
unique_str + 'title',
unique_str + 'user',
unique_str + 'pass',
url=unique_str + 'url',
notes=unique_str + 'notes',
tags=unique_str + 'tags',
icon=icons.KEY)
self.assertRaises(Exception, entry)
# ---------- Entries representation -----------
def test_print_entries(self):
self.assertIsInstance(self.kp.entries.__repr__(), str)
class GroupFunctionTests(unittest.TestCase):
# get some things ready before testing
def setUp(self):
self.kp = PyKeePass(os.path.join(base_dir, 'test.kdbx'),
password='******',
keyfile=os.path.join(base_dir, 'test.key'))
#---------- Finding groups -----------
def test_find_groups_by_name(self):
results = self.kp.find_groups_by_name('subgroup')
self.assertEqual(len(results), 1)
results = self.kp.find_groups_by_name('subgroup', first=True)
self.assertEqual(results.name, 'subgroup')
g = self.kp.find_groups(name='foobar_group', first=True)
results = self.kp.find_groups(group=g, name='.*group.*', regex=True)
self.assertEqual(len(results), 2)
results = self.kp.find_groups(group=g,
name='.*group.*',
regex=True,
recursive=False)
self.assertEqual(len(results), 1)
def test_find_groups_by_path(self):
results = self.kp.find_groups_by_path('/foobar_group/subgroup/')
self.assertIsInstance(results[0], Group)
results = self.kp.find_groups_by_path('/foobar_group/subgroup/',
first=True)
self.assertEqual(results.name, 'subgroup')
def test_find_groups_by_uuid(self):
results = self.kp.find_groups_by_uuid('lRVaMlMXoQ/U5NDCAwJktg==',
first=True)
self.assertIsInstance(results, Group)
results = self.kp.find_groups(uuid='^lRVaMlMX|^kwTZdSoU', regex=True)
self.assertEqual(len(results), 2)
def test_find_groups_by_notes(self):
results = self.kp.find_groups(notes='group notes')
self.assertEqual(len(results), 1)
self.assertEqual(results[0].uuid, 'lRVaMlMXoQ/U5NDCAwJktg==')
def test_find_groups(self):
results = self.kp.find_groups(path='/foobar_group/subgroup/')
self.assertIsInstance(results[0], Group)
results = self.kp.find_groups_by_path('/foobar_group/subgroup/',
first=True)
self.assertEqual(results.name, 'subgroup')
def test_groups(self):
results = self.kp.groups
self.assertEqual(len(results), 6)
#---------- Adding/Deleting Groups -----------
def test_add_delete_move_group(self):
notes_text = "this is a note for a group!"
base_group = self.kp.add_group(self.kp.root_group,
'base_group',
notes=notes_text)
sub_group = self.kp.add_group(base_group, 'sub_group')
sub_group2 = self.kp.add_group(base_group, 'sub_group2')
self.assertEqual(base_group.notes, notes_text)
base_group.notes = ''
self.assertEqual(base_group.notes, '')
results = self.kp.find_groups_by_path('base_group/sub_group/',
first=True)
self.assertIsInstance(results, Group)
self.assertEqual(results.name, sub_group.name)
self.kp.move_group(sub_group2, sub_group)
results = self.kp.find_groups(path='base_group/sub_group/sub_group2/',
first=True)
self.assertEqual(results.name, sub_group2.name)
self.kp.delete_group(sub_group)
results = self.kp.find_groups_by_path('base_group/sub_group/',
first=True)
self.assertIsNone(results)
# ---------- Groups representation -----------
def test_print_groups(self):
self.assertIsInstance(self.kp.groups.__repr__(), str)
tempfile = os.environ['TEMPFILE']
dbfile = os.environ['DBFILE']
path = pathlib.Path(tempfile)
if not path.is_file():
print("Datei fehlt: " + tempfile)
sys.exit()
path = pathlib.Path(dbfile)
if not path.is_file():
print("Datei fehlt: " + dbfile)
sys.exit()
# load database
kp = PyKeePass(dbfile, password=os.environ['PASSWORD'])
group = kp.find_groups(name=groupname, first=True)
count = 1
with open(tempfile, "r") as rd:
# Read lines in loop
for line in rd:
# All lines (besides the last) will include newline, so strip it
data = line.strip()
data = data.split(';;;')
if len(data) != 4:
print("Fehlerhafte Eingabe! Zeile: " + str(count))
print(data)
sys.exit()
# Variablen setzen
action="append")
# do the parsing
args = parser.parse_args()
password = args.password
try:
# get password from stdin
if password is None:
password = getpass.getpass(prompt="Database password: "******"Group \"" + args.group + "\" not found in database.")
# get entries
entries = []
# -> get all if no specific secret name(s) given
if args.secret is None:
entries = group.entries
# -> get all from specified secret name(s)
else:
for secret in args.secret:
result = kp.find_entries(title=secret, group=group, first=True)
entries.append(result) if result is not None else []
# now get values from the entries and print to stdout
class KeepassCredstore(Credstore):
def __init__(self, filename=None):
super().__init__()
self.filename = filename
self.log = self.log.bind(cls=__class__.__name__,
filename=self.filename)
self.db = None
@property
def name(self):
return self.filename
def unlock(self, unlock_secret=None):
self.log.msg('unlocking')
try:
from pykeepass import PyKeePass
if unlock_secret is None:
unlock_secret = getpass.getpass(
"Enter password to unlock Keepass database '{}': ".format(
self.filename))
self.db = PyKeePass(self.filename, password=unlock_secret)
self.log.msg('loaded keepass file',
entry_count=len(self.db.entries))
return True
except ImportError as err:
self.log.msg('keepass load error, pykeepass module missing')
return False
except Exception as e:
self.log.msg('keepass error, password is likely wrong', exc=e)
self.db = None
return False
def get_identity(self, url):
log = self.log.bind(url=url)
log.msg('looking for identity')
entries = self.db.find_entries(url=url,
group=self.db.find_groups(name='Root',
first=True))
if len(entries) > 1:
log.msg("multiple entries found, please specify identity manually",
paths=[e.path for e in entries])
return None
elif len(entries) == 0:
log.msg('no matching entries found')
return None
else:
entry = next(iter(entries))
log.msg('found entry', uuid=entry.uuid, path=entry.path)
return entry.username
return None
def get_credentials(self, url, identity):
log = self.log.bind(url=url, identity=identity)
log.msg('looking for credentials')
entry = self.db.find_entries(url=url, username=identity, first=True)
if entry:
log.msg('entry found', uuid=entry.uuid, path=entry.path)
return dict(identity=entry.username,
password=entry.password,
custom_properties=entry.custom_properties)
else:
log.msg('no entry found')
password = getpass.getpass(
"Enter password for login '{}' used to access URL '{}': ".
format(identity, url))
return dict(identity=entry.username,
password=password,
custom_properties={})
return None
if arg == '--create':
CREATE = True
if arg == '--title':
KEEPASSTITEL = sys.argv[idx+1]
if arg == '--username':
KEEPASSUSERNAME = sys.argv[idx+1]
if arg == "--count":
if (len(sys.argv) > idx+1):
pwdlength = sys.argv[idx+1]
else:
print(f"ERROR: count value is missing using default value: {pwdlength}")
if (CREATE):
password = password_generator(int(pwdlength))
if (DISPLAYPWD):
print(password)
clipboard.copy(password)
if (KEEPASSWRITE):
group = kp.find_groups(name=KEEPASSDEFAULTGRP, first=True)
kp.add_entry(group, str(KEEPASSTITEL), str(KEEPASSUSERNAME), str(password))
kp.save()
if (config['DEFAULT']['VAULTENABLE']== 'Y'):
client.write(str(config['DEFAULT']['VAULTKV'] + KEEPASSTITEL),
username = KEEPASSUSERNAME,
password = password,
)
class P2KP2:
"""Convert a Pass db into a Keepass2 one."""
db: PyKeePass
def __init__(self,
password: str,
destination: str = None,
overwrite: bool = False):
"""Constructor for P2KP2
:param password: the password for the new Keepass db
:param destination: the final db path
:param overwrite: force writing over existing database
"""
if destination is None:
destination = "pass.kdbx"
if not os.path.exists(destination) or overwrite:
copyfile(empty_db_path, destination)
else:
raise DbAlreadyExistsException()
self.db = PyKeePass(destination)
self.db.password = password
self.db.save()
self.event_stream = Subject()
def populate_db(self, pass_reader: PassReader):
"""Populate the keepass db with data from the PassReader."""
i = 0
for pass_entry in pass_reader.entries:
self.add_entry(pass_entry)
i = i + 1
self.event_stream.on_next(i)
self.db.save()
def add_entry(self, pass_entry: PassEntry) -> Entry:
"""Add a keepass entry to the db containing all data from the relative pass entry. Create the group if needed.
:param pass_entry: the original pass entry
:return: the newly added keepass entry
"""
# find the correct group for the entry. If not there, create it
entry_group = self.db.root_group # start from the root group
if len(pass_entry.groups) > 0:
for group_name in pass_entry.groups:
# since pass folder names are unique, the possible first result is also the only one
group = self.db.find_groups(name=group_name,
recursive=False,
group=entry_group,
first=True)
if group is None:
# the group is not already there, let's create it
group = self.db.add_group(destination_group=entry_group,
group_name=group_name)
entry_group = group
# create the entry, setting group, title, user and pass
entry = self.db.add_entry(entry_group, pass_entry.title,
pass_entry.user, pass_entry.password)
# set the url and the notes
entry.url = pass_entry.url
entry.notes = pass_entry.notes
# add all custom fields
for pass_entry, value in pass_entry.custom_properties.items():
entry.set_custom_property(pass_entry, value)
return entry
from pykeepass import PyKeePass
kp = PyKeePass('Passwords.kdbx', password='')
group = kp.find_groups(name='почты', first=True)
def get_entry(dolboeb):
entry = kp.find_entries(title=dolboeb, regex=True, first=True)
output2 = 'Title: ' + entry.title + '\n' + \
'Url: ' + entry.url + '\n' + \
'Username: '******'\n' + \
'Password: '******'введите имя записи ')
print(get_entry(find))
class DatabaseManager:
logging_manager = NotImplemented
db = NotImplemented
database_path = ""
password_try = ""
password_check = ""
password = ""
keyfile_hash = NotImplemented
changes = False
save_running = False
scheduled_saves = 0
database_file_descriptor = NotImplemented
def __init__(self,
database_path,
password=None,
keyfile=None,
logging_manager=None):
self.logging_manager = logging_manager
self.db = PyKeePass(database_path, password, keyfile)
self.database_path = database_path
self.database_file_descriptor = Gio.File.new_for_path(database_path)
self.password = password
#
# Group Transformation Methods
#
# Return the parent group object from the child group uuid
def get_group_parent_group_from_uuid(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
return group.parentgroup
# Return the parent group object from the child group object
def get_group_parent_group_from_object(self, group):
return group.parentgroup
# Return the belonging group object for a group uuid
def get_group_object_from_uuid(self, uuid):
return self.db.find_groups(uuid=uuid, first=True)
# Return the belonging group name for a group uuid
def get_group_name_from_uuid(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
return self.get_group_name_from_group_object(group)
# Return the path for a group object
def get_group_path_from_group_object(self, group):
return group.path
# Return the belonging group uuid for a group object
def get_group_uuid_from_group_object(self, group):
return group.uuid
# Return the belonging name for a group object
def get_group_name_from_group_object(self, group):
if group.name is None:
return ""
else:
return group.name
# Return the belonging notes for a group object
def get_group_notes_from_group_object(self, group):
if group.notes is None:
return ""
else:
return group.notes
# Return the belonging icon for a group object
def get_group_icon_from_group_object(self, group):
return group.icon
# Return the belonging notes for a group uuid
def get_group_notes_from_group_uuid(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
return self.get_group_notes_from_group_object(group)
# Return path for group uuid
def get_group_path_from_group_uuid(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
return group.path
#
# Entry Transformation Methods
#
# Return the belonging entry object for a entry uuid
def get_entry_object_from_uuid(self, uuid):
return self.db.find_entries(uuid=uuid, first=True)
# Return entry uuid from entry object
def get_entry_uuid_from_entry_object(self, entry):
return entry.uuid
# Return parent group from entry uuid
def get_entry_parent_group_from_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.parentgroup
# Return parent group from entry object
def get_entry_parent_group_from_entry_object(self, entry):
return entry.parentgroup
# Return the belonging name for an entry object
def get_entry_name_from_entry_object(self, entry):
if entry.title is None:
return ""
else:
return entry.title
# Return entry name from entry uuid
def get_entry_name_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return self.get_entry_name_from_entry_object(entry)
# Return the belonging icon for an entry object
def get_entry_icon_from_entry_object(self, entry):
return entry.icon
# Return entry icon from entry uuid
def get_entry_icon_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.icon
# Return the belonging username for an entry object
def get_entry_username_from_entry_object(self, entry):
if entry.username is None:
return ""
else:
return entry.username
# Return the belonging username for an entry uuid
def get_entry_username_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return self.get_entry_username_from_entry_object(entry)
# Return the belonging password for an entry object
def get_entry_password_from_entry_object(self, entry):
if entry.password is None:
return ""
else:
return entry.password
# Return the belonging password for an entry uuid
def get_entry_password_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return self.get_entry_password_from_entry_object(entry)
# Return the belonging url for an entry uuid
def get_entry_url_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return self.get_entry_url_from_entry_object(entry)
# Return the belonging url for an entry object
def get_entry_url_from_entry_object(self, entry):
if entry.url is None:
return ""
else:
return entry.url
# Return the belonging notes for an entry uuid
def get_entry_notes_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.notes
# Return the belonging notes for an entry object
def get_entry_notes_from_entry_object(self, entry):
if entry.notes is None:
return ""
else:
return entry.notes
# Return the beloging expiry date for an entry uuid
def get_entry_expiry_date_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.expiry_time
# Return the beloging expiry date for an entry object
def get_entry_expiry_date_from_entry_object(self, entry):
return entry.expiry_time
# Return the belonging color for an entry uuid
def get_entry_color_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.get_custom_property("color_prop_LcljUMJZ9X") is None:
return "NoneColorButton"
else:
return entry.get_custom_property("color_prop_LcljUMJZ9X")
# Return the belonging value for an attribute
def get_entry_attribute_value_from_entry_uuid(self, uuid, key):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.get_custom_property(key) is None:
return ""
else:
return entry.get_custom_property(key)
# Return all attributes for an entry uuid
def get_entry_attributes_from_entry_uuid(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.custom_properties
# Return all attributes for an entry object
def get_entry_attributes_from_entry_object(self, entry):
return entry.custom_properties
#
# Entry Checks
#
def has_entry_name(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.title is None:
return False
else:
return True
def has_entry_username(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.username is None:
return False
else:
return True
def has_entry_password(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.password is None:
return False
else:
return True
def has_entry_url(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.url is None:
return False
else:
return True
def has_entry_notes(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.notes is None:
return False
else:
return True
def has_entry_icon(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.icon is None:
return False
else:
return True
def has_entry_expiry_date(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
return entry.expires
def has_entry_expired(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.expired is False:
return False
else:
return True
def has_entry_color(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.get_custom_property(
"color_prop_LcljUMJZ9X") is None or entry.get_custom_property(
"color_prop_LcljUMJZ9X") == "NoneColorButton":
return False
else:
return True
def has_entry_attributes(self, uuid):
entry = self.db.find_entries(uuid=uuid, first=True)
if len(entry.custom_properties) == 0:
return False
else:
return True
def has_entry_attribute(self, uuid, key):
entry = self.db.find_entries(uuid=uuid, first=True)
if entry.get_custom_property(key) is None:
return False
else:
return True
#
# Group Checks
#
def has_group_name(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
if group.name is None:
return False
else:
return True
def has_group_notes(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
if group.notes is None:
return False
else:
return True
def has_group_icon(self, uuid):
group = self.db.find_groups(uuid=uuid, first=True)
if group.icon is None:
return False
else:
return True
#
# Database Modifications
#
# Add new group to database
def add_group_to_database(self, name, icon, notes, parent_group):
group = self.db.add_group(parent_group, name, icon=icon, notes=notes)
self.changes = True
self.set_element_mtime(parent_group)
return group
# Delete a group
def delete_group_from_database(self, group):
self.db.delete_group(group)
self.changes = True
if group.parentgroup is not None:
self.set_element_mtime(group.parentgroup)
# Add new entry to database
def add_entry_to_database(self, name, username, password, url, notes, icon,
group_uuid):
destination_group = self.get_group_object_from_uuid(group_uuid)
entry = self.db.add_entry(
destination_group,
name,
username,
password,
url=url,
notes=notes,
expiry_time=None,
tags=None,
icon=icon,
force_creation=self.check_entry_in_group_exists(
"", destination_group))
self.changes = True
self.set_element_mtime(destination_group)
return entry
# Delete an entry
def delete_entry_from_database(self, entry):
self.db.delete_entry(entry)
self.changes = True
if entry.parentgroup is not None:
self.set_element_mtime(entry.parentgroup)
# Duplicate an entry
def duplicate_entry(self, entry):
title = entry.title
if title is None:
title = ""
username = entry.username
if username is None:
username = ""
password = entry.password
if password is None:
password = ""
# NOTE: With clone is meant a duplicated object, not the process of cloning/duplication; "the" clone
clone_entry = self.db.add_entry(entry.parentgroup,
title + " - " + _("Clone"),
username,
password,
url=entry.url,
notes=entry.notes,
expiry_time=entry.expiry_time,
tags=entry.tags,
icon=entry.icon,
force_creation=True)
# Add custom properties
for key in entry.custom_properties:
value = entry.custom_properties[key]
if value is None:
value = ""
clone_entry.set_custom_property(key, value)
self.changes = True
if entry.parentgroup is not None:
self.set_element_mtime(entry.parentgroup)
# Write all changes to database
def save_database(self):
if self.save_running is False and self.changes is True:
self.save_running = True
kdbx = KDBX.build(self.db.kdbx,
password=self.db.password,
keyfile=self.db.keyfile)
try:
output_stream = self.database_file_descriptor.replace(
None, False, Gio.FileCreateFlags.REPLACE_DESTINATION
| Gio.FileCreateFlags.PRIVATE, None)
output_stream.write_all(kdbx)
output_stream.close()
self.logging_manager.debug("Saved database")
self.changes = False
except Exception:
self.logging_manager.error(
"Error occured while saving database")
# Workaround
# Fix created and proposed: https://github.com/pschmitt/pykeepass/pull/102
self.db.kdbx = KDBX.parse_file(self.db.filename,
password=self.db.password,
keyfile=self.db.keyfile)
self.save_running = False
# Set database password
def set_database_password(self, new_password):
self.db.password = new_password
self.changes = True
# Set database keyfile
def set_database_keyfile(self, new_keyfile):
self.db.keyfile = new_keyfile
self.changes = True
#
# Entry Modifications
#
def set_entry_name(self, uuid, name):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.title = name
self.changes = True
self.set_element_mtime(entry)
def set_entry_username(self, uuid, username):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.username = username
self.changes = True
self.set_element_mtime(entry)
def set_entry_password(self, uuid, password):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.password = password
self.changes = True
self.set_element_mtime(entry)
def set_entry_url(self, uuid, url):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.url = url
self.changes = True
self.set_element_mtime(entry)
def set_entry_notes(self, uuid, notes):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.notes = notes
self.changes = True
self.set_element_mtime(entry)
def set_entry_icon(self, uuid, icon):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.icon = icon
self.changes = True
self.set_element_mtime(entry)
def set_entry_expiry_date(self, uuid, date):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.expiry_time = date
entry.expires
self.changes = True
self.set_element_mtime(entry)
def set_entry_color(self, uuid, color):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.set_custom_property("color_prop_LcljUMJZ9X", color)
self.changes = True
self.set_element_mtime(entry)
def set_entry_attribute(self, uuid, key, value):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.set_custom_property(key, value)
self.changes = True
self.set_element_mtime(entry)
def delete_entry_attribute(self, uuid, key):
entry = self.db.find_entries(uuid=uuid, first=True)
entry.delete_custom_property(key)
self.changes = True
self.set_element_mtime(entry)
# Move an entry to another group
def move_entry(self, uuid, destination_group_object):
entry = self.db.find_entries(uuid=uuid, first=True)
self.db.move_entry(entry, destination_group_object)
if entry.parentgroup is not None:
self.set_element_mtime(entry.parentgroup)
self.set_element_mtime(destination_group_object)
def set_element_ctime(self, element):
element.ctime = datetime.utcnow()
def set_element_atime(self, element):
element.atime = datetime.utcnow()
def set_element_mtime(self, element):
element.mtime = datetime.utcnow()
#
# Group Modifications
#
def set_group_name(self, uuid, name):
group = self.db.find_groups(uuid=uuid, first=True)
group.name = name
self.changes = True
self.set_element_mtime(group)
def set_group_notes(self, uuid, notes):
group = self.db.find_groups(uuid=uuid, first=True)
group.notes = notes
self.set_element_mtime(group)
def set_group_icon(self, uuid, icon):
group = self.db.find_groups(uuid=uuid, first=True)
group.icon = icon
self.set_element_mtime(group)
# Move an group
def move_group(self, uuid, destination_group_object):
group = self.db.find_groups(uuid=uuid, first=True)
self.db.move_group(group, destination_group_object)
if group.parentgroup is not None:
self.set_element_mtime(group.parentgroup)
self.set_element_mtime(destination_group_object)
#
# Read Database
#
def get_groups_in_root(self):
return self.db.root_group.subgroups
# Return list of all groups in folder
def get_groups_in_folder(self, uuid):
folder = self.get_group_object_from_uuid(uuid)
return folder.subgroups
# Return list of all entries in folder
def get_entries_in_folder(self, uuid):
parent_group = self.get_group_object_from_uuid(uuid)
return parent_group.entries
# Return the database filesystem path
def get_database(self):
return self.database_path
# Return the root group of the database instance
def get_root_group(self):
return self.db.root_group
# Check if root group
def check_is_root_group(self, group):
if group.is_root_group:
return True
else:
return False
# Check if entry with title in group exists
def check_entry_in_group_exists(self, title, group):
entry = self.db.find_entries(title=title,
group=group,
recursive=False,
history=False,
first=True)
if entry is None:
return False
else:
return True
# Search for an entry or a group
def search(self, string, fulltext, global_search=True, path=None):
uuid_list = []
if fulltext is False:
for group in self.db.find_groups(name="(?i)" +
string.replace(" ", ".*"),
recursive=global_search,
path=path,
regex=True):
if group.is_root_group is False:
uuid_list.append(group.uuid)
else:
for group in self.db.groups:
if group.is_root_group is False and group.uuid not in uuid_list:
if string.lower(
) in self.get_group_notes_from_group_object(group):
uuid_list.append(group.uuid)
if fulltext is False:
for entry in self.db.find_entries(title="(?i)" +
string.replace(" ", ".*"),
recursive=global_search,
path=path,
regex=True):
uuid_list.append(entry.uuid)
else:
for entry in self.db.entries:
if entry.uuid not in uuid_list:
if string.lower(
) in self.get_entry_username_from_entry_object(entry):
uuid_list.append(entry.uuid)
elif string.lower(
) in self.get_entry_notes_from_entry_object(entry):
uuid_list.append(entry.uuid)
return uuid_list
# Check if object is group
def check_is_group(self, uuid):
if self.get_group_object_from_uuid(uuid) is None:
return False
else:
return True
def check_is_group_object(self, group):
return hasattr(group, "name")
#
# Properties
#
def get_element_creation_date(self, element):
if element.ctime is not None:
local_timestamp = element.ctime.astimezone(tz.tzlocal())
timestamp = GLib.DateTime.new_local(
int(datetime.strftime(local_timestamp, "%Y")),
int(datetime.strftime(local_timestamp, "%m")),
int(datetime.strftime(local_timestamp, "%d")),
int(datetime.strftime(local_timestamp, "%H")),
int(datetime.strftime(local_timestamp, "%M")),
float(datetime.strftime(local_timestamp, "%S")))
return timestamp.format("%c")
else:
return "-"
def get_element_acessed_date(self, element):
if element.atime is not None:
local_timestamp = element.atime.astimezone(tz.tzlocal())
timestamp = GLib.DateTime.new_local(
int(datetime.strftime(local_timestamp, "%Y")),
int(datetime.strftime(local_timestamp, "%m")),
int(datetime.strftime(local_timestamp, "%d")),
int(datetime.strftime(local_timestamp, "%H")),
int(datetime.strftime(local_timestamp, "%M")),
float(datetime.strftime(local_timestamp, "%S")))
return timestamp.format("%c")
else:
return "-"
def get_element_modified_date(self, element):
if element.mtime is not None:
local_timestamp = element.mtime.astimezone(tz.tzlocal())
timestamp = GLib.DateTime.new_local(
int(datetime.strftime(local_timestamp, "%Y")),
int(datetime.strftime(local_timestamp, "%m")),
int(datetime.strftime(local_timestamp, "%d")),
int(datetime.strftime(local_timestamp, "%H")),
int(datetime.strftime(local_timestamp, "%M")),
float(datetime.strftime(local_timestamp, "%S")))
return timestamp.format("%c")
else:
return "-"
#
# Database creation methods
#
# Set the first password entered by the user (for comparing reasons)
def set_password_try(self, password):
self.password_try = password
# Set the second password entered by the user (for comparing reasons)
def set_password_check(self, password):
self.password_check = password
# Compare the first password entered by the user with the second one
def compare_passwords(self):
if self.password_try == self.password_check:
if self.password_try == "" and self.password_check == "":
return False
else:
return True
else:
return False
# Create keyfile hash
def create_keyfile_hash(self, keyfile_path):
hasher = hashlib.sha512()
with open(keyfile_path, 'rb') as file:
buffer = 0
while buffer != b'':
buffer = file.read(1024)
hasher.update(buffer)
return hasher.hexdigest()
# Set keyfile hash
def set_keyfile_hash(self, keyfile_path):
self.keyfile_hash = self.create_keyfile_hash(keyfile_path)
# Get changes
def made_database_changes(self):
return self.changes
def parent_checker(self, current_group, moved_group):
if current_group.is_root_group:
return False
elif current_group.uuid == moved_group.uuid:
return True
else:
return self.parent_checker(current_group.parentgroup, moved_group)
def get_database_encryption(self):
return self.db.encryption_algorithm
def get_database_derivation(self):
return self.db.version
def write_token_data(entry_name,
kps_group,
token_data,
kps_pswd,
history_group=None):
try:
kp = PyKeePass(kps_file, password=kps_pswd)
entry = kp.find_entries(title=entry_name, first=True)
if entry is not None:
notes = entry._get_string_field('Notes')
updated_notes = ''
current_envs = dict()
for env in notes.split('\n'):
try:
splitted = env.split(':')
current_envs.update({splitted[0]: splitted[1]})
except:
pass
for updated_environment in token_data.keys():
if history_group:
if updated_environment == history_group:
entry.notes = updated_notes
entry.expiry_time = datetime.now() + timedelta(
days=365)
entry.expires = True
else:
entry.notes = updated_notes
entry.expiry_time = datetime.now() + timedelta(days=365)
entry.expires = True
for current_env_name, current_env_token in current_envs.items():
if current_env_name not in token_data.keys():
token_data.update({current_env_name: current_env_token})
for env_name, env_token in token_data.items():
updated_notes += env_name + ': ' + env_token + '\n'
else:
group = kp.find_groups(name=kps_group, first=True)
entry = kp.add_entry(group, entry_name, '', '')
notes = ''
for env_name, env_token in token_data.items():
notes += env_name + ': ' + env_token + '\n'
entry.notes = notes
entry.expiry_time = datetime.now() + timedelta(days=365)
entry.expires = True
kp.save()
return True
except Exception as e:
print('[ERRO] - Erro ao gravar dados no Keepass %s:\n%s' %
(kps_file, str(e)),
file=sys.stderr)
pass
