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
|
# Copyright (C) 2006 Gustavo J. A. M. Carneiro <gjcarneiro AT gmail.com>
# Nikos Kouremenos <kourem AT gmail.com>
# Copyright (C) 2006-2014 Yann Leboulanger <asterix AT lagaule.org>
# Copyright (C) 2007 Jean-Marie Traissard <jim AT lapin.org>
# Julien Pivotto <roidelapluie AT gmail.com>
# Copyright (C) 2008 Stephan Erb <steve-e AT h3c.de>
# Copyright (c) 2009 Thorsten Glaser <t.glaser AT tarent.de>
#
# This file is part of Gajim.
#
# Gajim is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# Gajim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Gajim. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import cast
import logging
import keyring
from gajim.common import app
from gajim.common.helpers import package_version
__all__ = [
'init',
'is_keyring_available',
'get_password',
'save_password',
'delete_password'
]
log = logging.getLogger('gajim.c.passwords')
class Interface:
def __init__(self):
self.backend = cast(keyring.backend.KeyringBackend, None)
self._is_keyring_available = False
@property
def is_keyring_available(self):
return self._is_keyring_available
def init(self) -> None:
backends = keyring.backend.get_all_keyring()
for backend in backends:
log.info('Found keyring backend: %s', backend)
if (app.settings.get('enable_keepassxc_integration') and
package_version('keyring>=23.8.1')):
_keyring = keyring.get_keyring()
self.backend = _keyring.with_properties(scheme='KeePassXC')
else:
self.backend = keyring.get_keyring()
log.info('Select %s backend', self.backend)
self._is_keyring_available = keyring.core.recommended(self.backend)
class SecretPasswordStorage:
'''
Store password using Keyring
'''
@staticmethod
def save_password(account_name: str, password: str) -> bool:
if not is_keyring_available():
log.warning('No recommended keyring backend available.'
'Passwords cannot be stored.')
return True
try:
log.info('Save password to keyring')
_interface.backend.set_password('gajim', account_name, password)
return True
except Exception:
log.exception('Save password failed')
return False
@staticmethod
def get_password(account_name: str) -> str | None:
if not is_keyring_available():
return
log.info('Request password from keyring')
try:
# For security reasons remove clear-text password
ConfigPasswordStorage.delete_password(account_name)
return _interface.backend.get_password('gajim', account_name)
except Exception:
log.exception('Request password failed')
return
@staticmethod
def delete_password(account_name: str) -> None:
if not is_keyring_available():
return
log.info('Remove password from keyring')
try:
return _interface.backend.delete_password('gajim', account_name)
except keyring.errors.PasswordDeleteError as error:
log.warning('Removing password failed: %s', error)
except Exception:
log.exception('Removing password failed')
class ConfigPasswordStorage:
'''
Store password directly in Gajim's config
'''
@staticmethod
def get_password(account_name: str) -> str:
return app.settings.get_account_setting(account_name, 'password')
@staticmethod
def save_password(account_name: str, password: str) -> bool:
app.settings.set_account_setting(account_name, 'password', password)
return True
@staticmethod
def delete_password(account_name: str) -> None:
app.settings.set_account_setting(account_name, 'password', '')
class MemoryPasswordStorage:
'''
Store password in memory
'''
_passwords: dict[str, str] = {}
def get_password(self, account_name: str) -> str:
return self._passwords.get(account_name, '')
def save_password(self, account_name: str, password: str) -> bool:
self._passwords[account_name] = password
return True
def delete_password(self, account_name: str) -> None:
self._passwords[account_name] = ''
def init() -> None:
_interface.init()
def is_keyring_available() -> bool:
return _interface.is_keyring_available
def get_password(account_name: str) -> str | None:
if not app.settings.get_account_setting(account_name, 'savepass'):
return MemoryPasswordStorage().get_password(account_name)
if app.settings.get('use_keyring'):
return SecretPasswordStorage.get_password(account_name)
return ConfigPasswordStorage.get_password(account_name)
def save_password(account_name: str, password: str) -> bool:
if not app.settings.get_account_setting(account_name, 'savepass'):
return MemoryPasswordStorage().save_password(account_name, password)
if app.settings.get('use_keyring'):
return SecretPasswordStorage.save_password(account_name, password)
return ConfigPasswordStorage.save_password(account_name, password)
def delete_password(account_name: str) -> None:
if app.settings.get('use_keyring'):
return SecretPasswordStorage.delete_password(account_name)
return ConfigPasswordStorage.delete_password(account_name)
_interface = Interface()
|
