stove/rougail-user-data-bitwarden
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: black

Browse source
This commit is contained in:
egarette@silique.fr 2025-05-11 19:11:17 +02:00
parent d30680cbed
commit 72980ca358
4 changed files with 149 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
locale/rougail_user_data_bitwarden.pot
View file

@ -5,7 +5,7 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-04-29 23:02+0200\n" "POT-Creation-Date: 2025-05-11 19:10+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -15,63 +15,63 @@ msgstr ""
"Generated-By: pygettext.py 1.5\n" "Generated-By: pygettext.py 1.5\n"
#: src/rougail/user_data_bitwarden/data.py:52 #: src/rougail/user_data_bitwarden/data.py:54
msgid "\"bitwarden\" is not set in step.user_data" msgid "\"bitwarden\" is not set in step.user_data"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:74 #: src/rougail/user_data_bitwarden/data.py:76
msgid "\"rbw\" or \"bw\"" msgid "\"rbw\" or \"bw\""
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:76 #: src/rougail/user_data_bitwarden/data.py:78
msgid "\"{0}\"" msgid "\"{0}\""
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:78 #: src/rougail/user_data_bitwarden/data.py:81
msgid "please unlock Bitwarden password database with {0}" msgid "please unlock Bitwarden password database with {0}"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:79 #: src/rougail/user_data_bitwarden/data.py:86
msgid "cannot find Bitwarden command {0} please install it" msgid "cannot find Bitwarden command {0} please install it"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:153 #: src/rougail/user_data_bitwarden/data.py:175
msgid "the value for \"{0}\" at index {1} is already set while it should be filled in by Bitwarden" msgid "the value for \"{0}\" at index {1} is already set while it should be filled in by Bitwarden"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:155 #: src/rougail/user_data_bitwarden/data.py:181
msgid "the value for \"{0}\" is already set while it should be filled in by Bitwarden" msgid "the value for \"{0}\" is already set while it should be filled in by Bitwarden"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:185 #: src/rougail/user_data_bitwarden/data.py:219
msgid "the default value for \"{0}\" must be the Bitwarden item name" msgid "the default value for \"{0}\" must be the Bitwarden item name"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:198 #: src/rougail/user_data_bitwarden/data.py:236
msgid "cannot execute the \"{0}\" commandline from Bitwarden for \"{1}\": {2}" msgid "cannot execute the \"{0}\" commandline from Bitwarden for \"{1}\": {2}"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:201 #: src/rougail/user_data_bitwarden/data.py:243
msgid "item \"{0}\" in Bitwarden is not found for \"{1}\"" msgid "item \"{0}\" in Bitwarden is not found for \"{1}\""
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:208 #: src/rougail/user_data_bitwarden/data.py:256
msgid "several items found with name \"{0}\" in Bitwarden for \"{1}\": \"{2}\"" msgid "several items found with name \"{0}\" in Bitwarden for \"{1}\": \"{2}\""
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:219 #: src/rougail/user_data_bitwarden/data.py:271
msgid "unexpected datas \"{0}\" from Bitwarden for \"{1}\": {2}" msgid "unexpected datas \"{0}\" from Bitwarden for \"{1}\": {2}"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:224 #: src/rougail/user_data_bitwarden/data.py:279
msgid "password" msgid "password"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:226 #: src/rougail/user_data_bitwarden/data.py:281
msgid "username" msgid "username"
msgstr "" msgstr ""
#: src/rougail/user_data_bitwarden/data.py:227 #: src/rougail/user_data_bitwarden/data.py:283
msgid "item \"{0}\" in Bitwarden has no {1} for \"{2}\"" msgid "item \"{0}\" in Bitwarden has no {1} for \"{2}\""
msgstr "" msgstr ""

2
src/rougail/user_data_bitwarden/__init__.py
View file

@ -24,4 +24,4 @@ from .__version__ import __version__
RougailUserData = RougailUserDataBitwarden RougailUserData = RougailUserDataBitwarden
__all__ = ('RougailUserDataBitwarden',) __all__ = ("RougailUserDataBitwarden",)

20
src/rougail/user_data_bitwarden/config.py
View file

@ -20,9 +20,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
""" """
def get_rougail_config(*, def get_rougail_config(
backward_compatibility=True, *,
) -> dict: backward_compatibility=True,
) -> dict:
options = """ options = """
step: step:
@ -47,11 +48,12 @@ bitwarden:
- bw - bw
mandatory: false mandatory: false
""" """
return {'name': 'bitwarden', return {
'process': 'user data', "name": "bitwarden",
"options": options, "process": "user data",
'level': 90, "options": options,
} "level": 90,
}
__all__ = ('get_rougail_config',) __all__ = ("get_rougail_config",)

183
src/rougail/user_data_bitwarden/data.py
View file

@ -32,23 +32,25 @@ from .i18n import _
class RougailUserDataBitwarden: class RougailUserDataBitwarden:
force_apply_user_data = True force_apply_user_data = True
def __init__(self, def __init__(
config: 'Config', self,
*, config: "Config",
rougailconfig: "RougailConfig"=None, *,
): rougailconfig: "RougailConfig" = None,
):
# this is the tiramisu config object # this is the tiramisu config object
self.config = config self.config = config
if rougailconfig is None: if rougailconfig is None:
from rougail.config import RougailConfig from rougail.config import RougailConfig
rougailconfig = RougailConfig rougailconfig = RougailConfig
user_data = rougailconfig['step.user_data'] user_data = rougailconfig["step.user_data"]
if 'bitwarden' not in user_data: if "bitwarden" not in user_data:
user_data.append('bitwarden') user_data.append("bitwarden")
rougailconfig['step.user_data'] = user_data rougailconfig["step.user_data"] = user_data
user_data = rougailconfig['step.user_data'] user_data = rougailconfig["step.user_data"]
self.rougailconfig = rougailconfig self.rougailconfig = rougailconfig
if 'bitwarden' not in user_data: if "bitwarden" not in user_data:
raise ExtentionError(_('"bitwarden" is not set in step.user_data')) raise ExtentionError(_('"bitwarden" is not set in step.user_data'))
self.errors = [] self.errors = []
self.warnings = [] self.warnings = []
@ -56,14 +58,14 @@ class RougailUserDataBitwarden:
self.bitwarden_command_line = self.get_command(rougailconfig) self.bitwarden_command_line = self.get_command(rougailconfig)
def get_command(self, rougailconfig): def get_command(self, rougailconfig):
if 'ROUGAIL_BITWARDEN_MOCK_ENABLE' in environ: if "ROUGAIL_BITWARDEN_MOCK_ENABLE" in environ:
return None return None
one_is_find = False one_is_find = False
force_command = rougailconfig["bitwarden.command"] force_command = rougailconfig["bitwarden.command"]
if force_command: if force_command:
commands = [force_command] commands = [force_command]
else: else:
commands = ['rbw', 'bw'] commands = ["rbw", "bw"]
for command in commands: for command in commands:
status = self.test_command(command) status = self.test_command(command)
if status is False: if status is False:
@ -75,26 +77,34 @@ class RougailUserDataBitwarden:
else: else:
command_string = _('"{0}"').format(force_command) command_string = _('"{0}"').format(force_command)
if one_is_find: if one_is_find:
raise ExtentionError(_('please unlock Bitwarden password database with {0}').format(command_string)) raise ExtentionError(
raise ExtentionError(_('cannot find Bitwarden command {0} please install it').format(command_string)) _("please unlock Bitwarden password database with {0}").format(
command_string
)
)
raise ExtentionError(
_("cannot find Bitwarden command {0} please install it").format(
command_string
)
)
def test_command(self, command): def test_command(self, command):
if not which(command): if not which(command):
return None return None
if command == 'rbw': if command == "rbw":
cmd = ['rbw', 'unlocked'] cmd = ["rbw", "unlocked"]
else: else:
cmd = ['bw', 'status'] cmd = ["bw", "status"]
try: try:
cpe = run(cmd, capture_output=True) cpe = run(cmd, capture_output=True)
except Exception as exc: except Exception as exc:
return False return False
if cpe.returncode != 0: if cpe.returncode != 0:
return False return False
if command == 'rbw': if command == "rbw":
return True return True
try: try:
data = loads(cpe.stdout.decode('utf8')) data = loads(cpe.stdout.decode("utf8"))
if data["status"] == "unlocked": if data["status"] == "unlocked":
return True return True
except: except:
@ -103,64 +113,85 @@ class RougailUserDataBitwarden:
def run(self): def run(self):
self.set_passwords(self.config.forcepermissive) self.set_passwords(self.config.forcepermissive)
return {'errors': self.errors, return {
'warnings': self.warnings, "errors": self.errors,
} "warnings": self.warnings,
}
def run_commandline(self, cmd) -> str: def run_commandline(self, cmd) -> str:
cpe = run(cmd, capture_output=True) cpe = run(cmd, capture_output=True)
err = cpe.stderr.decode('utf8') err = cpe.stderr.decode("utf8")
if cpe.returncode != 0 or err: if cpe.returncode != 0 or err:
raise Exception('{0} ({1})'.format(err, cpe.returncode)) raise Exception("{0} ({1})".format(err, cpe.returncode))
return cpe.stdout.decode('utf8') return cpe.stdout.decode("utf8")
def get_key_from_commandline(self, key_bitwarden: str, allow_multiple: bool) -> list[str]: def get_key_from_commandline(
if self.bitwarden_command_line == 'rbw': self, key_bitwarden: str, allow_multiple: bool
) -> list[str]:
if self.bitwarden_command_line == "rbw":
keys = [] keys = []
items = self.run_commandline(["rbw", "search", key_bitwarden]).strip() items = self.run_commandline(["rbw", "search", key_bitwarden]).strip()
if items: if items:
items = items.split('\n') items = items.split("\n")
else: else:
items = [] items = []
for item in items: for item in items:
#if item.count('@') != 1: # if item.count('@') != 1:
# continue # continue
if "@" in item: if "@" in item:
keys.append(item.split('@', 1)[-1]) keys.append(item.split("@", 1)[-1])
else: else:
keys.append(item.rsplit('/', 1)[-1]) keys.append(item.rsplit("/", 1)[-1])
if not allow_multiple: if not allow_multiple:
if not items: if not items:
return [] return []
if len(items) > 1: if len(items) > 1:
return [{'name': key} for key in keys] return [{"name": key} for key in keys]
keys = [key_bitwarden] keys = [key_bitwarden]
datas = [] datas = []
for key in keys: for key in keys:
data = loads(self.run_commandline(["rbw", "get", key, '--raw', '--ignorecase']).strip()) data = loads(
datas.append({'name': key, 'login': data["data"]}) self.run_commandline(
["rbw", "get", key, "--raw", "--ignorecase"]
).strip()
)
datas.append({"name": key, "login": data["data"]})
return datas return datas
return loads(self.run_commandline(["bw", "list", "items", "--search", key_bitwarden, '--nointeraction'])) return loads(
self.run_commandline(
["bw", "list", "items", "--search", key_bitwarden, "--nointeraction"]
)
)
def set_passwords(self, optiondescription): def set_passwords(self, optiondescription):
for option in optiondescription: for option in optiondescription:
if option.isoptiondescription(): if option.isoptiondescription():
self.set_passwords(option) self.set_passwords(option)
elif option.information.get('bitwarden', False): elif option.information.get("bitwarden", False):
path = option.path() path = option.path()
if not option.owner.isdefault(): if not option.owner.isdefault():
if option.isfollower(): if option.isfollower():
self.errors.append(_('the value for "{0}" at index {1} is already set while it should be filled in by Bitwarden').format(path, option.index())) self.errors.append(
_(
'the value for "{0}" at index {1} is already set while it should be filled in by Bitwarden'
).format(path, option.index())
)
else: else:
self.errors.append(_('the value for "{0}" is already set while it should be filled in by Bitwarden').format(path)) self.errors.append(
_(
'the value for "{0}" is already set while it should be filled in by Bitwarden'
).format(path)
)
continue continue
type_ = option.information.get('type') type_ = option.information.get("type")
if option.isleader(): if option.isleader():
leader_values = [] leader_values = []
self.leader_informations[path] = [] self.leader_informations[path] = []
values = option.value.get() values = option.value.get()
for val in values: for val in values:
names, values = self.get_values(path, type_, val, allow_multiple=True) names, values = self.get_values(
path, type_, val, allow_multiple=True
)
if isinstance(values, list): if isinstance(values, list):
leader_values.extend(values) leader_values.extend(values)
self.leader_informations[path].extend(names) self.leader_informations[path].extend(names)
@ -170,59 +201,87 @@ class RougailUserDataBitwarden:
option.value.set(leader_values) option.value.set(leader_values)
else: else:
if option.isfollower(): if option.isfollower():
leader_path = optiondescription.leader().path() leader_path = optiondescription.leader().path()
if leader_path in self.leader_informations: if leader_path in self.leader_informations:
key_bitwarden = self.leader_informations[leader_path][option.index()] key_bitwarden = self.leader_informations[leader_path][
option.index()
]
else: else:
key_bitwarden = option.value.get() key_bitwarden = option.value.get()
else: else:
key_bitwarden = option.value.get() key_bitwarden = option.value.get()
option.value.set(self.get_values(path, type_, key_bitwarden)[1]) option.value.set(self.get_values(path, type_, key_bitwarden)[1])
option.permissive.add('novalidator') option.permissive.add("novalidator")
def get_values(self, path, type_, key_bitwarden, *, allow_multiple=False): def get_values(self, path, type_, key_bitwarden, *, allow_multiple=False):
if not isinstance(key_bitwarden, str): if not isinstance(key_bitwarden, str):
self.errors.append(_('the default value for "{0}" must be the Bitwarden item name').format(path)) self.errors.append(
_('the default value for "{0}" must be the Bitwarden item name').format(
path
)
)
return None, None return None, None
if 'ROUGAIL_BITWARDEN_MOCK_ENABLE' in environ: if "ROUGAIL_BITWARDEN_MOCK_ENABLE" in environ:
if type_ == 'secret': if type_ == "secret":
value = 'Ex4mpL3_P4ssw0rD' value = "Ex4mpL3_P4ssw0rD"
else: else:
value = 'example_login' value = "example_login"
if allow_multiple: if allow_multiple:
return [key_bitwarden], [value] return [key_bitwarden], [value]
return key_bitwarden, value return key_bitwarden, value
try: try:
data = self.get_key_from_commandline(key_bitwarden, allow_multiple) data = self.get_key_from_commandline(key_bitwarden, allow_multiple)
except Exception as exc: except Exception as exc:
self.errors.append(_('cannot execute the "{0}" commandline from Bitwarden for "{1}": {2}').format(self.bitwarden_command_line, path, exc)) self.errors.append(
_(
'cannot execute the "{0}" commandline from Bitwarden for "{1}": {2}'
).format(self.bitwarden_command_line, path, exc)
)
return None, None return None, None
if not data: if not data:
self.errors.append(_('item "{0}" in Bitwarden is not found for "{1}"').format(key_bitwarden, path)) self.errors.append(
_('item "{0}" in Bitwarden is not found for "{1}"').format(
key_bitwarden, path
)
)
return None, None return None, None
if len(data) != 1: if len(data) != 1:
names = [d["name"] for d in data] names = [d["name"] for d in data]
if allow_multiple: if allow_multiple:
ret = [] ret = []
return names, [self.get_value(key_bitwarden, path, type_, d) for d in data] return names, [
self.errors.append(_('several items found with name "{0}" in Bitwarden for "{1}": "{2}"').format(key_bitwarden, path, "\", \"".join(names))) self.get_value(key_bitwarden, path, type_, d) for d in data
]
self.errors.append(
_(
'several items found with name "{0}" in Bitwarden for "{1}": "{2}"'
).format(key_bitwarden, path, '", "'.join(names))
)
return None, None return None, None
return data[0]['name'], self.get_value(key_bitwarden, path, type_, data[0]) return data[0]["name"], self.get_value(key_bitwarden, path, type_, data[0])
def get_value(self, key_bitwarden: str, path: str, type_: str, data: dict) -> str: def get_value(self, key_bitwarden: str, path: str, type_: str, data: dict) -> str:
try: try:
if type_ == 'secret': if type_ == "secret":
value = data['login']['password'] value = data["login"]["password"]
else: else:
value = data['login']['username'] value = data["login"]["username"]
except Exception as exc: except Exception as exc:
self.errors.append(_('unexpected datas "{0}" from Bitwarden for "{1}": {2}').format(key_bitwarden, path, exc)) self.errors.append(
_('unexpected datas "{0}" from Bitwarden for "{1}": {2}').format(
key_bitwarden, path, exc
)
)
value = None value = None
else: else:
if value is None: if value is None:
if type_ == 'secret': if type_ == "secret":
bw_type = _('password') bw_type = _("password")
else: else:
bw_type = _('username') bw_type = _("username")
self.errors.append(_('item "{0}" in Bitwarden has no {1} for "{2}"').format(key_bitwarden, bw_type, path)) self.errors.append(
_('item "{0}" in Bitwarden has no {1} for "{2}"').format(
key_bitwarden, bw_type, path
)
)
return value return value