diff --git a/locale/rougail_user_data_bitwarden.pot b/locale/rougail_user_data_bitwarden.pot index b6b656c..7da48e2 100644 --- a/locale/rougail_user_data_bitwarden.pot +++ b/locale/rougail_user_data_bitwarden.pot @@ -5,7 +5,7 @@ msgid "" msgstr "" "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" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -15,63 +15,63 @@ msgstr "" "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" msgstr "" -#: src/rougail/user_data_bitwarden/data.py:74 +#: src/rougail/user_data_bitwarden/data.py:76 msgid "\"rbw\" or \"bw\"" msgstr "" -#: src/rougail/user_data_bitwarden/data.py:76 +#: src/rougail/user_data_bitwarden/data.py:78 msgid "\"{0}\"" 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}" 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" 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" 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" 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" 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}" 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}\"" 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}\"" 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}" msgstr "" -#: src/rougail/user_data_bitwarden/data.py:224 +#: src/rougail/user_data_bitwarden/data.py:279 msgid "password" msgstr "" -#: src/rougail/user_data_bitwarden/data.py:226 +#: src/rougail/user_data_bitwarden/data.py:281 msgid "username" 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}\"" msgstr "" diff --git a/src/rougail/user_data_bitwarden/__init__.py b/src/rougail/user_data_bitwarden/__init__.py index 10914d4..c982884 100644 --- a/src/rougail/user_data_bitwarden/__init__.py +++ b/src/rougail/user_data_bitwarden/__init__.py @@ -24,4 +24,4 @@ from .__version__ import __version__ RougailUserData = RougailUserDataBitwarden -__all__ = ('RougailUserDataBitwarden',) +__all__ = ("RougailUserDataBitwarden",) diff --git a/src/rougail/user_data_bitwarden/config.py b/src/rougail/user_data_bitwarden/config.py index b7b3c60..3ef8bf8 100644 --- a/src/rougail/user_data_bitwarden/config.py +++ b/src/rougail/user_data_bitwarden/config.py @@ -20,9 +20,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -def get_rougail_config(*, - backward_compatibility=True, - ) -> dict: +def get_rougail_config( + *, + backward_compatibility=True, +) -> dict: options = """ step: @@ -47,11 +48,12 @@ bitwarden: - bw mandatory: false """ - return {'name': 'bitwarden', - 'process': 'user data', - "options": options, - 'level': 90, - } + return { + "name": "bitwarden", + "process": "user data", + "options": options, + "level": 90, + } -__all__ = ('get_rougail_config',) +__all__ = ("get_rougail_config",) diff --git a/src/rougail/user_data_bitwarden/data.py b/src/rougail/user_data_bitwarden/data.py index 1110c6f..3b8f0d8 100644 --- a/src/rougail/user_data_bitwarden/data.py +++ b/src/rougail/user_data_bitwarden/data.py @@ -32,23 +32,25 @@ from .i18n import _ class RougailUserDataBitwarden: force_apply_user_data = True - def __init__(self, - config: 'Config', - *, - rougailconfig: "RougailConfig"=None, - ): + def __init__( + self, + config: "Config", + *, + rougailconfig: "RougailConfig" = None, + ): # this is the tiramisu config object self.config = config if rougailconfig is None: from rougail.config import RougailConfig + rougailconfig = RougailConfig - user_data = rougailconfig['step.user_data'] - if 'bitwarden' not in user_data: - user_data.append('bitwarden') - rougailconfig['step.user_data'] = user_data - user_data = rougailconfig['step.user_data'] + user_data = rougailconfig["step.user_data"] + if "bitwarden" not in user_data: + user_data.append("bitwarden") + rougailconfig["step.user_data"] = user_data + user_data = rougailconfig["step.user_data"] 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')) self.errors = [] self.warnings = [] @@ -56,14 +58,14 @@ class RougailUserDataBitwarden: self.bitwarden_command_line = self.get_command(rougailconfig) def get_command(self, rougailconfig): - if 'ROUGAIL_BITWARDEN_MOCK_ENABLE' in environ: + if "ROUGAIL_BITWARDEN_MOCK_ENABLE" in environ: return None one_is_find = False force_command = rougailconfig["bitwarden.command"] if force_command: commands = [force_command] else: - commands = ['rbw', 'bw'] + commands = ["rbw", "bw"] for command in commands: status = self.test_command(command) if status is False: @@ -75,26 +77,34 @@ class RougailUserDataBitwarden: else: command_string = _('"{0}"').format(force_command) if one_is_find: - raise ExtentionError(_('please unlock Bitwarden password database with {0}').format(command_string)) - raise ExtentionError(_('cannot find Bitwarden command {0} please install it').format(command_string)) + raise ExtentionError( + _("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): if not which(command): return None - if command == 'rbw': - cmd = ['rbw', 'unlocked'] + if command == "rbw": + cmd = ["rbw", "unlocked"] else: - cmd = ['bw', 'status'] + cmd = ["bw", "status"] try: cpe = run(cmd, capture_output=True) except Exception as exc: return False if cpe.returncode != 0: return False - if command == 'rbw': + if command == "rbw": return True try: - data = loads(cpe.stdout.decode('utf8')) + data = loads(cpe.stdout.decode("utf8")) if data["status"] == "unlocked": return True except: @@ -103,64 +113,85 @@ class RougailUserDataBitwarden: def run(self): self.set_passwords(self.config.forcepermissive) - return {'errors': self.errors, - 'warnings': self.warnings, - } + return { + "errors": self.errors, + "warnings": self.warnings, + } def run_commandline(self, cmd) -> str: cpe = run(cmd, capture_output=True) - err = cpe.stderr.decode('utf8') + err = cpe.stderr.decode("utf8") if cpe.returncode != 0 or err: - raise Exception('{0} ({1})'.format(err, cpe.returncode)) - return cpe.stdout.decode('utf8') + raise Exception("{0} ({1})".format(err, cpe.returncode)) + return cpe.stdout.decode("utf8") - def get_key_from_commandline(self, key_bitwarden: str, allow_multiple: bool) -> list[str]: - if self.bitwarden_command_line == 'rbw': + def get_key_from_commandline( + self, key_bitwarden: str, allow_multiple: bool + ) -> list[str]: + if self.bitwarden_command_line == "rbw": keys = [] items = self.run_commandline(["rbw", "search", key_bitwarden]).strip() if items: - items = items.split('\n') + items = items.split("\n") else: items = [] for item in items: - #if item.count('@') != 1: + # if item.count('@') != 1: # continue if "@" in item: - keys.append(item.split('@', 1)[-1]) + keys.append(item.split("@", 1)[-1]) else: - keys.append(item.rsplit('/', 1)[-1]) + keys.append(item.rsplit("/", 1)[-1]) if not allow_multiple: if not items: return [] if len(items) > 1: - return [{'name': key} for key in keys] + return [{"name": key} for key in keys] keys = [key_bitwarden] datas = [] for key in keys: - data = loads(self.run_commandline(["rbw", "get", key, '--raw', '--ignorecase']).strip()) - datas.append({'name': key, 'login': data["data"]}) + data = loads( + self.run_commandline( + ["rbw", "get", key, "--raw", "--ignorecase"] + ).strip() + ) + datas.append({"name": key, "login": data["data"]}) 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): for option in optiondescription: if option.isoptiondescription(): self.set_passwords(option) - elif option.information.get('bitwarden', False): + elif option.information.get("bitwarden", False): path = option.path() if not option.owner.isdefault(): 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: - 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 - type_ = option.information.get('type') + type_ = option.information.get("type") if option.isleader(): leader_values = [] self.leader_informations[path] = [] values = option.value.get() 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): leader_values.extend(values) self.leader_informations[path].extend(names) @@ -170,59 +201,87 @@ class RougailUserDataBitwarden: option.value.set(leader_values) else: if option.isfollower(): - leader_path = optiondescription.leader().path() + leader_path = optiondescription.leader().path() 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: key_bitwarden = option.value.get() else: key_bitwarden = option.value.get() 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): 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 - if 'ROUGAIL_BITWARDEN_MOCK_ENABLE' in environ: - if type_ == 'secret': - value = 'Ex4mpL3_P4ssw0rD' + if "ROUGAIL_BITWARDEN_MOCK_ENABLE" in environ: + if type_ == "secret": + value = "Ex4mpL3_P4ssw0rD" else: - value = 'example_login' + value = "example_login" if allow_multiple: return [key_bitwarden], [value] return key_bitwarden, value try: data = self.get_key_from_commandline(key_bitwarden, allow_multiple) 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 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 if len(data) != 1: names = [d["name"] for d in data] if allow_multiple: ret = [] - return 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 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 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: try: - if type_ == 'secret': - value = data['login']['password'] + if type_ == "secret": + value = data["login"]["password"] else: - value = data['login']['username'] + value = data["login"]["username"] 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 else: if value is None: - if type_ == 'secret': - bw_type = _('password') + if type_ == "secret": + bw_type = _("password") else: - bw_type = _('username') - self.errors.append(_('item "{0}" in Bitwarden has no {1} for "{2}"').format(key_bitwarden, bw_type, path)) + bw_type = _("username") + self.errors.append( + _('item "{0}" in Bitwarden has no {1} for "{2}"').format( + key_bitwarden, bw_type, path + ) + ) return value