Reformat everything with ruff (99863c4) - derivepassphrase.git

Reformat everything with ruff

Marco Ricci commited on 2024-07-21 10:09:10
Zeige 13 geänderte Dateien mit 1583 Einfügungen und 913 Löschungen.

pyproject.toml 3728ebe..b3086ae
src/derivepassphrase/__init__.py e3813b1..b06e1cb
src/derivepassphrase/__main__.py ef4fb01..a1a5127
src/derivepassphrase/cli.py 5f662fa..a4cf479
src/derivepassphrase/types.py 09afac4..0872df2
src/sequin/__init__.py a69a546..d756dd7
src/ssh_agent_client/__init__.py a419dde..e266926
tests/__init__.py 66cbc4d..9482ae7
tests/test_derivepassphrase.py 32c56de..babb4c4
tests/test_derivepassphrase_cli.py 66a1a5b..9e3786d
tests/test_derivepassphrase_typing.py 93f8d09..5afbe30
tests/test_sequin.py 749226e..d810fb9
tests/test_ssh_agent_client.py b48f1e5..348b2b7

pyproject.toml

@@ -122,6 +122,7 @@ extend = "ruff_defaults_v0.5.0.toml"
 
 [tool.ruff.format]
 quote-style = 'single'
+docstring-code-line-length = "dynamic"
 preview = true
 
 [tool.ruff.lint]

src/derivepassphrase/__init__.py

Zeige Datei @ 99863c4

@@ -2,9 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 
-"""Work-alike of vault(1) – a deterministic, stateless password manager
-
-"""  # noqa: RUF002
+"""Work-alike of vault(1) – a deterministic, stateless password manager"""  # noqa: RUF002
 
 from __future__ import annotations
 
@@ -19,8 +17,9 @@ from typing_extensions import assert_type
 import sequin
 import ssh_agent_client
 
-__author__ = "Marco Ricci <m@the13thletter.info>"
-__version__ = "0.1.1"
+__author__ = 'Marco Ricci <m@the13thletter.info>'
+__version__ = '0.1.1'
+
 
 class AmbiguousByteRepresentationError(ValueError):
     """The object has an ambiguous byte representation."""
@@ -40,8 +40,10 @@ _CHARSETS = collections.OrderedDict([
 ])
 _CHARSETS['alpha'] = _CHARSETS['lower'] + _CHARSETS['upper']
 _CHARSETS['alphanum'] = _CHARSETS['alpha'] + _CHARSETS['number']
-_CHARSETS['all'] = (_CHARSETS['alphanum'] + _CHARSETS['space']
-                    + _CHARSETS['symbol'])
+_CHARSETS['all'] = (
+    _CHARSETS['alphanum'] + _CHARSETS['space'] + _CHARSETS['symbol']
+)
+
 
 class Vault:
     """A work-alike of James Coglan's vault.
@@ -75,10 +78,16 @@ class Vault:
     """
 
     def __init__(
-        self, *, phrase: bytes | bytearray | str = b'',
-        length: int = 20, repeat: int = 0, lower: int | None = None,
-        upper: int | None = None, number: int | None = None,
-        space: int | None = None, dash: int | None = None,
+        self,
+        *,
+        phrase: bytes | bytearray | str = b'',
+        length: int = 20,
+        repeat: int = 0,
+        lower: int | None = None,
+        upper: int | None = None,
+        number: int | None = None,
+        space: int | None = None,
+        dash: int | None = None,
         symbol: int | None = None,
     ) -> None:
         """Initialize the Vault object.
@@ -177,7 +188,8 @@ class Vault:
         return math.fsum(math.log2(f) for f in factors)
 
     def _estimate_sufficient_hash_length(
-        self, safety_factor: float = 2.0,
+        self,
+        safety_factor: float = 2.0,
     ) -> int:
         """Estimate the sufficient hash length, given the current settings.
 
@@ -241,8 +253,11 @@ class Vault:
 
     @classmethod
     def create_hash(
-        cls, phrase: bytes | bytearray | str,
-        service: bytes | bytearray, *, length: int = 32,
+        cls,
+        phrase: bytes | bytearray | str,
+        service: bytes | bytearray,
+        *,
+        length: int = 32,
     ) -> bytes:
         r"""Create a pseudorandom byte stream from phrase and service.
 
@@ -302,11 +317,19 @@ class Vault:
         phrase = cls._get_binary_string(phrase)
         assert not isinstance(phrase, str)
         salt = bytes(service) + cls._UUID
-        return hashlib.pbkdf2_hmac(hash_name='sha1', password=phrase,
-                                   salt=salt, iterations=8, dklen=length)
+        return hashlib.pbkdf2_hmac(
+            hash_name='sha1',
+            password=phrase,
+            salt=salt,
+            iterations=8,
+            dklen=length,
+        )
 
     def generate(
-        self, service_name: str | bytes | bytearray, /, *,
+        self,
+        service_name: str | bytes | bytearray,
+        /,
+        *,
         phrase: bytes | bytearray | str = b'',
     ) -> bytes:
         r"""Generate a service passphrase.
@@ -358,8 +381,11 @@ class Vault:
         while True:
             try:
                 required = self._required[:]
-                seq = sequin.Sequin(self.create_hash(
-                    phrase=phrase, service=service_name, length=hash_length))
+                seq = sequin.Sequin(
+                    self.create_hash(
+                        phrase=phrase, service=service_name, length=hash_length
+                    )
+                )
                 result = bytearray()
                 while len(result) < self._length:
                     pos = seq.generate(len(required))
@@ -374,8 +400,9 @@ class Vault:
                     if self._repeat and result:
                         bad_suffix = bytes(result[-1:]) * (self._repeat - 1)
                         if result.endswith(bad_suffix):
-                            charset = self._subtract(bytes(result[-1:]),
-                                                     charset)
+                            charset = self._subtract(
+                                bytes(result[-1:]), charset
+                            )
                     pos = seq.generate(len(charset))
                     result.extend(charset[pos : pos + 1])
             except sequin.SequinExhaustedError:
@@ -399,19 +426,16 @@ class Vault:
 
         """
         deterministic_signature_types = {
-            'ssh-ed25519':
-                lambda k: k.startswith(b'\x00\x00\x00\x0bssh-ed25519'),
-            'ssh-ed448':
-                lambda k: k.startswith(b'\x00\x00\x00\x09ssh-ed448'),
-            'ssh-rsa':
-                lambda k: k.startswith(b'\x00\x00\x00\x07ssh-rsa'),
+            'ssh-ed25519': lambda k: k.startswith(
+                b'\x00\x00\x00\x0bssh-ed25519'
+            ),
+            'ssh-ed448': lambda k: k.startswith(b'\x00\x00\x00\x09ssh-ed448'),
+            'ssh-rsa': lambda k: k.startswith(b'\x00\x00\x00\x07ssh-rsa'),
         }
         return any(v(key) for v in deterministic_signature_types.values())
 
     @classmethod
-    def phrase_from_key(
-        cls, key: bytes | bytearray, /
-    ) -> bytes:
+    def phrase_from_key(cls, key: bytes | bytearray, /) -> bytes:
         """Obtain the master passphrase from a configured SSH key.
 
         vault allows the usage of certain SSH keys to derive a master
@@ -456,8 +480,10 @@ class Vault:
 
         """
         if not cls._is_suitable_ssh_key(key):
-            msg = ('unsuitable SSH key: bad key, or '
-                   'signature not deterministic')
+            msg = (
+                'unsuitable SSH key: bad key, or '
+                'signature not deterministic'
+            )
             raise ValueError(msg)
         with ssh_agent_client.SSHAgentClient() as client:
             raw_sig = client.sign(key, cls._UUID)
@@ -467,7 +493,8 @@ class Vault:
 
     @staticmethod
     def _subtract(
-        charset: bytes | bytearray, allowed: bytes | bytearray,
+        charset: bytes | bytearray,
+        allowed: bytes | bytearray,
     ) -> bytearray:
         """Remove the characters in charset from allowed.
 
@@ -489,8 +516,9 @@ class Vault:
                 `allowed` or `charset` contained duplicate characters.
 
         """
-        allowed = (allowed if isinstance(allowed, bytearray)
-                   else bytearray(allowed))
+        allowed = (
+            allowed if isinstance(allowed, bytearray) else bytearray(allowed)
+        )
         assert_type(allowed, bytearray)
         msg_dup_characters = 'duplicate characters in set'
         if len(frozenset(allowed)) != len(allowed):

src/derivepassphrase/__main__.py

Zeige Datei @ 99863c4

@@ -5,7 +5,7 @@
 
 import sys
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     from derivepassphrase.cli import derivepassphrase
 
     sys.exit(derivepassphrase())

src/derivepassphrase/cli.py

Zeige Datei @ 99863c4

@@ -2,9 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 
-"""Command-line interface for derivepassphrase.
-
-"""
+"""Command-line interface for derivepassphrase."""
 
 from __future__ import annotations
 
@@ -64,8 +62,9 @@ def _config_filename() -> str | bytes | pathlib.Path:
 
     """
     path: str | bytes | pathlib.Path
-    path = (os.getenv(PROG_NAME.upper() + '_PATH')
-            or click.get_app_dir(PROG_NAME, force_posix=True))
+    path = os.getenv(PROG_NAME.upper() + '_PATH') or click.get_app_dir(
+        PROG_NAME, force_posix=True
+    )
     return os.path.join(path, 'settings.json')
 
 
@@ -122,8 +121,7 @@ def _save_config(config: dpp_types.VaultConfig, /) -> None:
 
 
 def _get_suitable_ssh_keys(
-    conn: ssh_agent_client.SSHAgentClient | socket.socket | None = None,
-    /
+    conn: ssh_agent_client.SSHAgentClient | socket.socket | None = None, /
 ) -> Iterator[ssh_agent_client.types.KeyCommentPair]:
     """Yield all SSH keys suitable for passphrase derivation.
 
@@ -188,7 +186,8 @@ def _get_suitable_ssh_keys(
 
 
 def _prompt_for_selection(
-    items: Sequence[str | bytes], heading: str = 'Possible choices:',
+    items: Sequence[str | bytes],
+    heading: str = 'Possible choices:',
     single_choice_prompt: str = 'Confirm this choice?',
 ) -> int:
     """Prompt user for a choice among the given items.
@@ -229,26 +228,34 @@ def _prompt_for_selection(
         choices = click.Choice([''] + [str(i) for i in range(1, n + 1)])
         choice = click.prompt(
             f'Your selection? (1-{n}, leave empty to abort)',
-            err=True, type=choices, show_choices=False,
-            show_default=False, default='')
+            err=True,
+            type=choices,
+            show_choices=False,
+            show_default=False,
+            default='',
+        )
         if not choice:
             raise IndexError(_EMPTY_SELECTION)
         return int(choice) - 1
-    prompt_suffix = (' '
-                     if single_choice_prompt.endswith(tuple('?.!'))
-                     else ': ')
+    prompt_suffix = (
+        ' ' if single_choice_prompt.endswith(tuple('?.!')) else ': '
+    )
     try:
-        click.confirm(single_choice_prompt,
-                      prompt_suffix=prompt_suffix, err=True,
-                      abort=True, default=False, show_default=False)
+        click.confirm(
+            single_choice_prompt,
+            prompt_suffix=prompt_suffix,
+            err=True,
+            abort=True,
+            default=False,
+            show_default=False,
+        )
     except click.Abort:
         raise IndexError(_EMPTY_SELECTION) from None
     return 0
 
 
 def _select_ssh_key(
-    conn: ssh_agent_client.SSHAgentClient | socket.socket | None = None,
-    /
+    conn: ssh_agent_client.SSHAgentClient | socket.socket | None = None, /
 ) -> bytes | bytearray:
     """Interactively select an SSH key for passphrase derivation.
 
@@ -292,14 +299,18 @@ def _select_ssh_key(
     for key, comment in suitable_keys:
         keytype = unstring_prefix(key)[0].decode('ASCII')
         key_str = base64.standard_b64encode(key).decode('ASCII')
-        key_prefix = (key_str
+        key_prefix = (
+            key_str
             if len(key_str) < KEY_DISPLAY_LENGTH + len('...')
-                      else key_str[:KEY_DISPLAY_LENGTH] + '...')
+            else key_str[:KEY_DISPLAY_LENGTH] + '...'
+        )
         comment_str = comment.decode('UTF-8', errors='replace')
         key_listing.append(f'{keytype} {key_prefix} {comment_str}')
     choice = _prompt_for_selection(
-        key_listing, heading='Suitable SSH keys:',
-        single_choice_prompt='Use this key?')
+        key_listing,
+        heading='Suitable SSH keys:',
+        single_choice_prompt='Use this key?',
+    )
     return suitable_keys[choice].key
 
 
@@ -313,8 +324,9 @@ def _prompt_for_passphrase() -> str:
         The user input.
 
     """
-    return click.prompt('Passphrase', default='', hide_input=True,
-                        show_default=False, err=True)
+    return click.prompt(
+        'Passphrase', default='', hide_input=True, show_default=False, err=True
+    )
 
 
 class OptionGroupOption(click.Option):
@@ -353,7 +366,9 @@ class CommandWithHelpGroups(click.Command):
     """
 
     def format_options(
-        self, ctx: click.Context, formatter: click.HelpFormatter,
+        self,
+        ctx: click.Context,
+        formatter: click.HelpFormatter,
     ) -> None:
         r"""Format options on the help listing, grouped into sections.
 
@@ -398,8 +413,9 @@ class CommandWithHelpGroups(click.Command):
                     group_name = ''
                 help_records.setdefault(group_name, []).append(rec)
         default_group = help_records.pop('')
-        default_group_name = ('Other Options' if len(default_group) > 1
-                              else 'Options')
+        default_group_name = (
+            'Other Options' if len(default_group) > 1 else 'Options'
+        )
         help_records[default_group_name] = default_group
         for group_name, records in help_records.items():
             with formatter.section(group_name):
@@ -414,31 +430,37 @@ class CommandWithHelpGroups(click.Command):
 # Concrete option groups used by this command-line interface.
 class PasswordGenerationOption(OptionGroupOption):
     """Password generation options for the CLI."""
+
     option_group_name = 'Password generation'
-    epilog = '''
+    epilog = """
         Use NUMBER=0, e.g. "--symbol 0", to exclude a character type
         from the output.
-    '''
+    """
 
 
 class ConfigurationOption(OptionGroupOption):
     """Configuration options for the CLI."""
+
     option_group_name = 'Configuration'
-    epilog = '''
+    epilog = """
         Use $VISUAL or $EDITOR to configure the spawned editor.
-    '''
+    """
 
 
 class StorageManagementOption(OptionGroupOption):
     """Storage management options for the CLI."""
+
     option_group_name = 'Storage management'
-    epilog = '''
+    epilog = """
         Using "-" as PATH for standard input/standard output is
         supported.
-    '''
+    """
+
 
 def _validate_occurrence_constraint(
-    ctx: click.Context, param: click.Parameter, value: Any,
+    ctx: click.Context,
+    param: click.Parameter,
+    value: Any,
 ) -> int | None:
     """Check that the occurrence constraint is valid (int, 0 or larger)."""
     del ctx  # Unused.
@@ -460,7 +482,9 @@ def _validate_occurrence_constraint(
 
 
 def _validate_length(
-    ctx: click.Context, param: click.Parameter, value: Any,
+    ctx: click.Context,
+    param: click.Parameter,
+    value: Any,
 ) -> int | None:
     """Check that the length is valid (int, 1 or larger)."""
     del ctx  # Unused.
@@ -480,7 +504,8 @@ def _validate_length(
         raise click.BadParameter(msg)
     return int_value
 
-DEFAULT_NOTES_TEMPLATE = '''\
+
+DEFAULT_NOTES_TEMPLATE = """\
 # Enter notes below the line with the cut mark (ASCII scissors and
 # dashes).  Lines above the cut mark (such as this one) will be ignored.
 #
@@ -490,14 +515,14 @@ DEFAULT_NOTES_TEMPLATE = '''\
 # retained.
 #
 # - - - - - >8 - - - - - >8 - - - - - >8 - - - - - >8 - - - - -
-'''
+"""
 DEFAULT_NOTES_MARKER = '# - - - - - >8 - - - - -'
 
 
 @click.command(
-    context_settings={"help_option_names": ["-h", "--help"]},
+    context_settings={'help_option_names': ['-h', '--help']},
     cls=CommandWithHelpGroups,
-    epilog=r'''
+    epilog=r"""
         WARNING: There is NO WAY to retrieve the generated passphrases
         if the master passphrase, the SSH key, or the exact passphrase
         settings are lost, short of trying out all possible
@@ -510,74 +535,145 @@ DEFAULT_NOTES_MARKER = '# - - - - - >8 - - - - -'
         `C:\Users\<user>\AppData\Roaming\Derivepassphrase` on Windows.
         The configuration is NOT encrypted, and you are STRONGLY
         discouraged from using a stored passphrase.
-    ''',
+    """,
 )
-@click.option('-p', '--phrase', 'use_phrase', is_flag=True,
+@click.option(
+    '-p',
+    '--phrase',
+    'use_phrase',
+    is_flag=True,
     help='prompts you for your passphrase',
-              cls=PasswordGenerationOption)
-@click.option('-k', '--key', 'use_key', is_flag=True,
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '-k',
+    '--key',
+    'use_key',
+    is_flag=True,
     help='uses your SSH private key to generate passwords',
-              cls=PasswordGenerationOption)
-@click.option('-l', '--length', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '-l',
+    '--length',
+    metavar='NUMBER',
     callback=_validate_length,
     help='emits password of length NUMBER',
-              cls=PasswordGenerationOption)
-@click.option('-r', '--repeat', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '-r',
+    '--repeat',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='allows maximum of NUMBER repeated adjacent chars',
-              cls=PasswordGenerationOption)
-@click.option('--lower', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--lower',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER lowercase letters',
-              cls=PasswordGenerationOption)
-@click.option('--upper', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--upper',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER uppercase letters',
-              cls=PasswordGenerationOption)
-@click.option('--number', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--number',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER digits',
-              cls=PasswordGenerationOption)
-@click.option('--space', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--space',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER spaces',
-              cls=PasswordGenerationOption)
-@click.option('--dash', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--dash',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER "-" or "_"',
-              cls=PasswordGenerationOption)
-@click.option('--symbol', metavar='NUMBER',
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '--symbol',
+    metavar='NUMBER',
     callback=_validate_occurrence_constraint,
     help='includes at least NUMBER symbol chars',
-              cls=PasswordGenerationOption)
-@click.option('-n', '--notes', 'edit_notes', is_flag=True,
+    cls=PasswordGenerationOption,
+)
+@click.option(
+    '-n',
+    '--notes',
+    'edit_notes',
+    is_flag=True,
     help='spawn an editor to edit notes for SERVICE',
-              cls=ConfigurationOption)
-@click.option('-c', '--config', 'store_config_only', is_flag=True,
+    cls=ConfigurationOption,
+)
+@click.option(
+    '-c',
+    '--config',
+    'store_config_only',
+    is_flag=True,
     help='saves the given settings for SERVICE or global',
-              cls=ConfigurationOption)
-@click.option('-x', '--delete', 'delete_service_settings', is_flag=True,
+    cls=ConfigurationOption,
+)
+@click.option(
+    '-x',
+    '--delete',
+    'delete_service_settings',
+    is_flag=True,
     help='deletes settings for SERVICE',
-              cls=ConfigurationOption)
-@click.option('--delete-globals', is_flag=True,
+    cls=ConfigurationOption,
+)
+@click.option(
+    '--delete-globals',
+    is_flag=True,
     help='deletes the global shared settings',
-              cls=ConfigurationOption)
-@click.option('-X', '--clear', 'clear_all_settings', is_flag=True,
+    cls=ConfigurationOption,
+)
+@click.option(
+    '-X',
+    '--clear',
+    'clear_all_settings',
+    is_flag=True,
     help='deletes all settings',
-              cls=ConfigurationOption)
-@click.option('-e', '--export', 'export_settings', metavar='PATH',
+    cls=ConfigurationOption,
+)
+@click.option(
+    '-e',
+    '--export',
+    'export_settings',
+    metavar='PATH',
     type=click.Path(file_okay=True, allow_dash=True, exists=False),
     help='export all saved settings into file PATH',
-              cls=StorageManagementOption)
-@click.option('-i', '--import', 'import_settings', metavar='PATH',
+    cls=StorageManagementOption,
+)
+@click.option(
+    '-i',
+    '--import',
+    'import_settings',
+    metavar='PATH',
     type=click.Path(file_okay=True, allow_dash=True, exists=False),
     help='import saved settings from file PATH',
-              cls=StorageManagementOption)
+    cls=StorageManagementOption,
+)
 @click.version_option(version=dpp.__version__, prog_name=PROG_NAME)
 @click.argument('service', required=False)
 @click.pass_context
 def derivepassphrase(
-    ctx: click.Context, /, *,
+    ctx: click.Context,
+    /,
+    *,
     service: str | None = None,
     use_phrase: bool = False,
     use_key: bool = False,
@@ -704,7 +800,8 @@ def derivepassphrase(
                     group = StorageManagementOption
                 case OptionGroupOption():
                     raise AssertionError(  # noqa: TRY003
-                        f'Unknown option group for {param!r}')  # noqa: EM102
+                        f'Unknown option group for {param!r}'  # noqa: EM102
+                    )
                 case _:
                     group = click.Option
             options_in_group.setdefault(group, []).append(param)
@@ -716,7 +813,8 @@ def derivepassphrase(
         return bool(ctx.params.get(param.human_readable_name))
 
     def check_incompatible_options(
-        param: click.Parameter | str, *incompatible: click.Parameter | str,
+        param: click.Parameter | str,
+        *incompatible: click.Parameter | str,
     ) -> None:
         if isinstance(param, str):
             param = params_by_str[param]
@@ -731,7 +829,8 @@ def derivepassphrase(
                 opt_str = param.opts[0]
                 other_str = other.opts[0]
                 raise click.BadOptionUsage(
-                    opt_str, f'mutually exclusive with {other_str}', ctx=ctx)
+                    opt_str, f'mutually exclusive with {other_str}', ctx=ctx
+                )
 
     def get_config() -> dpp_types.VaultConfig:
         try:
@@ -748,15 +847,20 @@ def derivepassphrase(
         for opt in options_in_group[group]:
             if opt != params_by_str['--config']:
                 check_incompatible_options(
-                    opt, *options_in_group[PasswordGenerationOption])
+                    opt, *options_in_group[PasswordGenerationOption]
+                )
 
     for group in (ConfigurationOption, StorageManagementOption):
         for opt in options_in_group[group]:
             check_incompatible_options(
-                opt, *options_in_group[ConfigurationOption],
-                *options_in_group[StorageManagementOption])
-    sv_options = (options_in_group[PasswordGenerationOption] +
-                  [params_by_str['--notes'], params_by_str['--delete']])
+                opt,
+                *options_in_group[ConfigurationOption],
+                *options_in_group[StorageManagementOption],
+            )
+    sv_options = options_in_group[PasswordGenerationOption] + [
+        params_by_str['--notes'],
+        params_by_str['--delete'],
+    ]
     sv_options.remove(params_by_str['--key'])
     sv_options.remove(params_by_str['--phrase'])
     for param in sv_options:
@@ -765,16 +869,17 @@ def derivepassphrase(
             msg = f'{opt_str} requires a SERVICE'
             raise click.UsageError(msg)
     for param in [params_by_str['--key'], params_by_str['--phrase']]:
-        if (
-            is_param_set(param)
-            and not (service or is_param_set(params_by_str['--config']))
+        if is_param_set(param) and not (
+            service or is_param_set(params_by_str['--config'])
         ):
             opt_str = param.opts[0]
             msg = f'{opt_str} requires a SERVICE or --config'
             raise click.UsageError(msg)
-    no_sv_options = [params_by_str['--delete-globals'],
+    no_sv_options = [
+        params_by_str['--delete-globals'],
         params_by_str['--clear'],
-                     *options_in_group[StorageManagementOption]]
+        *options_in_group[StorageManagementOption],
+    ]
     for param in no_sv_options:
         if is_param_set(param) and service:
             opt_str = param.opts[0]
@@ -784,10 +889,9 @@ def derivepassphrase(
     if edit_notes:
         assert service is not None
         configuration = get_config()
-        text = (DEFAULT_NOTES_TEMPLATE +
-                configuration['services']
-                .get(service, cast(dpp_types.VaultConfigServicesSettings, {}))
-                .get('notes', ''))
+        text = DEFAULT_NOTES_TEMPLATE + configuration['services'].get(
+            service, cast(dpp_types.VaultConfigServicesSettings, {})
+        ).get('notes', '')
         notes_value = click.edit(text=text)
         if notes_value is not None:
             notes_lines = collections.deque(notes_value.splitlines(True))
@@ -800,7 +904,8 @@ def derivepassphrase(
                 if not notes_value.strip():
                     ctx.fail('not saving new notes: user aborted request')
             configuration['services'].setdefault(service, {})['notes'] = (
-                notes_value.strip('\n'))
+                notes_value.strip('\n')
+            )
             _save_config(configuration)
     elif delete_service_settings:
         assert service is not None
@@ -818,9 +923,11 @@ def derivepassphrase(
     elif import_settings:
         try:
             # TODO: keep track of auto-close; try os.dup if feasible
-            infile = (cast(TextIO, import_settings)
+            infile = (
+                cast(TextIO, import_settings)
                 if hasattr(import_settings, 'close')
-                      else click.open_file(os.fspath(import_settings), 'rt'))
+                else click.open_file(os.fspath(import_settings), 'rt')
+            )
             with infile:
                 maybe_config = json.load(infile)
         except json.JSONDecodeError as e:
@@ -835,9 +942,11 @@ def derivepassphrase(
         configuration = get_config()
         try:
             # TODO: keep track of auto-close; try os.dup if feasible
-            outfile = (cast(TextIO, export_settings)
+            outfile = (
+                cast(TextIO, export_settings)
                 if hasattr(export_settings, 'close')
-                       else click.open_file(os.fspath(export_settings), 'wt'))
+                else click.open_file(os.fspath(export_settings), 'wt')
+            )
             with outfile:
                 json.dump(configuration, outfile)
         except OSError as e:
@@ -849,20 +958,36 @@ def derivepassphrase(
         # have a type guarding function anyway, assert that we didn't
         # make any mistakes at the end instead.
         global_keys = {'key', 'phrase'}
-        service_keys = {'key', 'phrase', 'length', 'repeat', 'lower',
-                        'upper', 'number', 'space', 'dash', 'symbol'}
+        service_keys = {
+            'key',
+            'phrase',
+            'length',
+            'repeat',
+            'lower',
+            'upper',
+            'number',
+            'space',
+            'dash',
+            'symbol',
+        }
         settings: collections.ChainMap[str, Any] = collections.ChainMap(
-            {k: v for k, v in locals().items()
-             if k in service_keys and v is not None},
-            cast(dict[str, Any],
-                 configuration['services'].get(service or '', {})),
+            {
+                k: v
+                for k, v in locals().items()
+                if k in service_keys and v is not None
+            },
+            cast(
+                dict[str, Any],
+                configuration['services'].get(service or '', {}),
+            ),
             {},
-            cast(dict[str, Any], configuration.get('global', {}))
+            cast(dict[str, Any], configuration.get('global', {})),
         )
         if use_key:
             try:
-                key = base64.standard_b64encode(
-                    _select_ssh_key()).decode('ASCII')
+                key = base64.standard_b64encode(_select_ssh_key()).decode(
+                    'ASCII'
+                )
             except IndexError:
                 ctx.fail('no valid SSH key selected')
             except (LookupError, RuntimeError) as e:
@@ -875,8 +1000,11 @@ def derivepassphrase(
                 phrase = maybe_phrase
         if store_config_only:
             view: collections.ChainMap[str, Any]
-            view = (collections.ChainMap(*settings.maps[:2]) if service
-                    else settings.parents.parents)
+            view = (
+                collections.ChainMap(*settings.maps[:2])
+                if service
+                else settings.parents.parents
+            )
             if use_key:
                 view['key'] = key
                 for m in view.maps:
@@ -887,25 +1015,29 @@ def derivepassphrase(
                     m.pop('key', '')
             if not view.maps[0]:
                 settings_type = 'service' if service else 'global'
-                msg = (f'cannot update {settings_type} settings without '
-                       f'actual settings')
+                msg = (
+                    f'cannot update {settings_type} settings without '
+                    f'actual settings'
+                )
                 raise click.UsageError(msg)
             if service:
-                configuration['services'].setdefault(
-                    service, {}).update(view)  # type: ignore[typeddict-item]
+                configuration['services'].setdefault(service, {}).update(view)  # type: ignore[typeddict-item]
             else:
-                configuration.setdefault(
-                    'global', {}).update(view)  # type: ignore[typeddict-item]
-            assert dpp_types.is_vault_config(configuration), (
-                f'invalid vault configuration: {configuration!r}'
-            )
+                configuration.setdefault('global', {}).update(view)  # type: ignore[typeddict-item]
+            assert dpp_types.is_vault_config(
+                configuration
+            ), f'invalid vault configuration: {configuration!r}'
             _save_config(configuration)
         else:
             if not service:
                 msg = 'SERVICE is required'
                 raise click.UsageError(msg)
-            kwargs: dict[str, Any] = {k: v for k, v in settings.items()
-                                      if k in service_keys and v is not None}
+            kwargs: dict[str, Any] = {
+                k: v
+                for k, v in settings.items()
+                if k in service_keys and v is not None
+            }
+
             # If either --key or --phrase are given, use that setting.
             # Otherwise, if both key and phrase are set in the config,
             # one must be global (ignore it) and one must be
@@ -915,10 +1047,12 @@ def derivepassphrase(
             # derivepassphrase.Vault.phrase_from_key if a key is
             # given. Finally, if nothing is set, error out.
             def key_to_phrase(
-                key: str | bytes | bytearray
+                key: str | bytes | bytearray,
             ) -> bytes | bytearray:
                 return dpp.Vault.phrase_from_key(
-                    base64.standard_b64decode(key))
+                    base64.standard_b64decode(key)
+                )
+
             if use_key or use_phrase:
                 if use_key:
                     kwargs['phrase'] = key_to_phrase(key)
@@ -935,8 +1069,10 @@ def derivepassphrase(
             elif kwargs.get('phrase'):
                 pass
             else:
-                msg = ('no passphrase or key given on command-line '
-                       'or in configuration')
+                msg = (
+                    'no passphrase or key given on command-line '
+                    'or in configuration'
+                )
                 raise click.UsageError(msg)
             vault = dpp.Vault(**kwargs)
             result = vault.generate(service)

src/derivepassphrase/types.py

Zeige Datei @ 99863c4

@@ -2,9 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 
-"""Common typing declarations for the parent module.
-
-"""
+"""Common typing declarations for the parent module."""
 
 from __future__ import annotations
 
@@ -79,9 +80,13 @@ class VaultConfigServicesSettings(VaultConfigGlobalSettings, total=False):
     symbol: NotRequired[int]
 
 
-_VaultConfig = TypedDict('_VaultConfig',
+_VaultConfig = TypedDict(
+    '_VaultConfig',
     {'global': NotRequired[VaultConfigGlobalSettings]},
-                         total=False)
+    total=False,
+)
+
+
 class VaultConfig(TypedDict, _VaultConfig, total=False):
     r"""Configuration for vault.
 

src/sequin/__init__.py

Zeige Datei @ 99863c4

@@ -32,8 +32,9 @@ if TYPE_CHECKING:
     from collections.abc import Iterator, Sequence
 
 __all__ = ('Sequin', 'SequinExhaustedError')
-__author__ = "Marco Ricci <m@the13thletter.info>"
-__version__ = "0.1.1"
+__author__ = 'Marco Ricci <m@the13thletter.info>'
+__version__ = '0.1.1'
+
 
 class Sequin:
     """Generate pseudorandom non-negative numbers in different ranges.
@@ -60,7 +62,9 @@ class Sequin:
     def __init__(
         self,
         sequence: str | bytes | bytearray | Sequence[int],
-        /, *, is_bitstring: bool = False
+        /,
+        *,
+        is_bitstring: bool = False,
     ):
         """Initialize the Sequin.
 
@@ -126,8 +134,7 @@ class Sequin:
             sequences.
 
         Examples:
-            >>> seq = Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1],
-            ...              is_bitstring=True)
+            >>> seq = Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1], is_bitstring=True)
             >>> seq.bases
             {2: deque([1, 0, 1, 0, 0, 1, 0, 0, 0, 1])}
             >>> seq._all_or_nothing_shift(3)
@@ -163,9 +170,7 @@ class Sequin:
         return tuple(stash)
 
     @staticmethod
-    def _big_endian_number(
-        digits: Sequence[int], /, *, base: int = 2
-    ) -> int:
+    def _big_endian_number(digits: Sequence[int], /, *, base: int = 2) -> int:
         """Evaluate the given integer sequence as a big endian number.
 
         Args:
@@ -231,10 +236,14 @@ class Sequin:
                 The sequin is exhausted.
 
         Examples:
-            >>> seq = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-            ...              is_bitstring=True)
-            >>> seq2 = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-            ...               is_bitstring=True)
+            >>> seq = Sequin(
+            ...     [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
+            ...     is_bitstring=True,
+            ... )
+            >>> seq2 = Sequin(
+            ...     [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
+            ...     is_bitstring=True,
+            ... )
             >>> seq.generate(5)
             3
             >>> seq.generate(5)
@@ -266,9 +275,7 @@ class Sequin:
             raise SequinExhaustedError
         return value
 
-    def _generate_inner(
-        self, n: int, /, *, base: int = 2
-    ) -> int:
+    def _generate_inner(self, n: int, /, *, base: int = 2) -> int:
         """Recursive call to generate a base `n` non-negative integer.
 
         We first determine the correct exponent `k` to generate base `n`
@@ -298,10 +305,14 @@ class Sequin:
                 The range is empty.
 
         Examples:
-            >>> seq = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-            ...              is_bitstring=True)
-            >>> seq2 = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-            ...               is_bitstring=True)
+            >>> seq = Sequin(
+            ...     [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
+            ...     is_bitstring=True,
+            ... )
+            >>> seq2 = Sequin(
+            ...     [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
+            ...     is_bitstring=True,
+            ... )
             >>> seq._generate_inner(5)
             3
             >>> seq._generate_inner(5)

src/ssh_agent_client/__init__.py

Zeige Datei @ 99863c4

@@ -21,8 +21,8 @@ if TYPE_CHECKING:
     from collections.abc import Sequence
 
 __all__ = ('SSHAgentClient',)
-__author__ = "Marco Ricci <m@the13thletter.info>"
-__version__ = "0.1.1"
+__author__ = 'Marco Ricci <m@the13thletter.info>'
+__version__ = '0.1.1'
 
 # In SSH bytestrings, the "length" of the byte string is stored as
 # a 4-byte/32-bit unsigned integer at the beginning.
@@ -105,8 +110,7 @@ class SSHAgentClient:
     ) -> bool:
         """Close socket connection upon context manager completion."""
         return bool(
-            self._connection.__exit__(
-                exc_type, exc_val, exc_tb)  # type: ignore[func-returns-value]
+            self._connection.__exit__(exc_type, exc_val, exc_tb)  # type: ignore[func-returns-value]
         )
 
     @staticmethod
@@ -172,17 +176,16 @@ class SSHAgentClient:
         Examples:
             >>> bytes(SSHAgentClient.unstring(b'\x00\x00\x00\x07ssh-rsa'))
             b'ssh-rsa'
-            >>> bytes(SSHAgentClient.unstring(
-            ...     SSHAgentClient.string(b'ssh-ed25519')))
+            >>> bytes(
+            ...     SSHAgentClient.unstring(SSHAgentClient.string(b'ssh-ed25519'))
+            ... )
             b'ssh-ed25519'
 
-        """
+        """  # noqa: E501
         n = len(bytestring)
         msg = 'malformed SSH byte string'
-        if (
-            n < HEAD_LEN
-            or n != HEAD_LEN + int.from_bytes(bytestring[:HEAD_LEN], 'big',
-                                              signed=False)
+        if n < HEAD_LEN or n != HEAD_LEN + int.from_bytes(
+            bytestring[:HEAD_LEN], 'big', signed=False
         ):
             raise ValueError(msg)
         return bytestring[HEAD_LEN:]
@@ -209,11 +212,13 @@ class SSHAgentClient:
 
         Examples:
             >>> a, b = SSHAgentClient.unstring_prefix(
-            ...     b'\x00\x00\x00\x07ssh-rsa____trailing data')
+            ...     b'\x00\x00\x00\x07ssh-rsa____trailing data'
+            ... )
             >>> (bytes(a), bytes(b))
             (b'ssh-rsa', b'____trailing data')
             >>> a, b = SSHAgentClient.unstring_prefix(
-            ...     SSHAgentClient.string(b'ssh-ed25519'))
+            ...     SSHAgentClient.string(b'ssh-ed25519')
+            ... )
             >>> (bytes(a), bytes(b))
             (b'ssh-ed25519', b'')
 
@@ -225,7 +230,10 @@ class SSHAgentClient:
         m = int.from_bytes(bytestring[:HEAD_LEN], 'big', signed=False)
         if m + HEAD_LEN > n:
             raise ValueError(msg)
-        return (bytestring[HEAD_LEN:m + HEAD_LEN], bytestring[m + HEAD_LEN:])
+        return (
+            bytestring[HEAD_LEN : m + HEAD_LEN],
+            bytestring[m + HEAD_LEN :],
+        )
 
     def request(
         self, code: int, payload: bytes | bytearray, /
@@ -282,12 +290,16 @@ class SSHAgentClient:
 
         """
         response_code, response = self.request(
-            ssh_types.SSH_AGENTC.REQUEST_IDENTITIES.value, b'')
+            ssh_types.SSH_AGENTC.REQUEST_IDENTITIES.value, b''
+        )
         if response_code != ssh_types.SSH_AGENT.IDENTITIES_ANSWER.value:
-            msg = (f'error return from SSH agent: '
-                   f'{response_code = }, {response = }')
+            msg = (
+                f'error return from SSH agent: '
+                f'{response_code = }, {response = }'
+            )
             raise RuntimeError(msg)
         response_stream = collections.deque(response)
+
         def shift(num: int) -> bytes:
             buf = collections.deque(b'')
             for _ in range(num):
@@ -314,8 +327,13 @@ class SSHAgentClient:
         return keys
 
     def sign(
-        self, /, key: bytes | bytearray, payload: bytes | bytearray,
-        *, flags: int = 0, check_if_key_loaded: bool = False,
+        self,
+        /,
+        key: bytes | bytearray,
+        payload: bytes | bytearray,
+        *,
+        flags: int = 0,
+        check_if_key_loaded: bool = False,
     ) -> bytes | bytearray:
         """Request the SSH agent sign the payload with the key.
 
@@ -361,7 +379,8 @@ class SSHAgentClient:
         request_data.extend(self.string(payload))
         request_data.extend(self.uint32(flags))
         response_code, response = self.request(
-            ssh_types.SSH_AGENTC.SIGN_REQUEST.value, request_data)
+            ssh_types.SSH_AGENTC.SIGN_REQUEST.value, request_data
+        )
         if response_code != ssh_types.SSH_AGENT.SIGN_RESPONSE.value:
             msg = f'signing data failed: {response_code = }, {response = }'
             raise RuntimeError(msg)

tests/__init__.py

Zeige Datei @ 99863c4

@@ -33,38 +33,39 @@ if TYPE_CHECKING:
         expected_signature: bytes | None
         derived_passphrase: bytes | str | None
 
+
 SUPPORTED_KEYS: Mapping[str, SSHTestKey] = {
     'ed25519': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
 QyNTUxOQAAACCBeIFoJtYCSF8P/zJIb+TBMIncHGpFBgnpCQ/7whJpdgAAAKDweO7H8Hju
 xwAAAAtzc2gtZWQyNTUxOQAAACCBeIFoJtYCSF8P/zJIb+TBMIncHGpFBgnpCQ/7whJpdg
 AAAEAbM/A869nkWZbe2tp3Dm/L6gitvmpH/aRZt8sBII3ExYF4gWgm1gJIXw//Mkhv5MEw
 idwcakUGCekJD/vCEml2AAAAG3Rlc3Qga2V5IHdpdGhvdXQgcGFzc3BocmFzZQEC
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIF4gWgm1gJIXw//Mkhv5MEwidwcakUGCekJD/vCEml2 test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIF4gWgm1gJIXw//Mkhv5MEwidwcakUGCekJD/vCEml2 test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 0b 73 73 68 2d 65 64 32 35 35 31 39
             00 00 00 20
             81 78 81 68 26 d6 02 48 5f 0f ff 32 48 6f e4 c1
             30 89 dc 1c 6a 45 06 09 e9 09 0f fb c2 12 69 76
-'''),
-        'expected_signature': bytes.fromhex('''
+"""),
+        'expected_signature': bytes.fromhex("""
             00 00 00 0b 73 73 68 2d 65 64 32 35 35 31 39
             00 00 00 40
             f0 98 19 80 6c 1a 97 d5 26 03 6e cc e3 65 8f 86
             66 07 13 19 13 09 21 33 33 f9 e4 36 53 1d af fd
             0d 08 1f ec f8 73 9b 8c 5f 55 39 16 7c 53 54 2c
             1e 52 bb 30 ed 7f 89 e2 2f 69 51 55 d8 9e a6 02
-        '''),
+        """),
         'derived_passphrase': rb'8JgZgGwal9UmA27M42WPhmYHExkTCSEzM/nkNlMdr/0NCB/s+HObjF9VORZ8U1QsHlK7MO1/ieIvaVFV2J6mAg==',  # noqa: E501
     },
     # Currently only supported by PuTTY (which is deficient in other
     # niceties of the SSH agent and the agent's client).
     'ed448': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAASgAAAAlz
 c2gtZWQ0NDgAAAA54vZy009Wu8wExjvEb3hqtLz1GO/+d5vmGUbErWQ4AUO9mYLT
 zHJHc2m4s+yWzP29Cc3EcxizLG8AAAAA8BdhfCcXYXwnAAAACXNzaC1lZDQ0OAAA
@@ -74,19 +75,18 @@ ADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM
 GUbErWQ4AUO9mYLTzHJHc2m4s+yWzP29Cc3EcxizLG8AAAAAG3Rlc3Qga2V5IHdp
 dGhvdXQgcGFzc3BocmFzZQECAwQFBgcICQ==
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ssh-ed448 AAAACXNzaC1lZDQ0OAAAADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM/b0JzcRzGLMsbwA= test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ssh-ed448 AAAACXNzaC1lZDQ0OAAAADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM/b0JzcRzGLMsbwA= test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 09 73 73 68 2d 65 64 34 34 38
             00 00 00 39
             e2 f6 72 d3 4f 56 bb cc 04 c6 3b c4 6f 78 6a b4
             bc f5 18 ef fe 77 9b e6 19 46 c4 ad 64 38 01 43
             bd 99 82 d3 cc 72 47 73 69 b8 b3 ec 96 cc fd bd
             09 cd c4 73 18 b3 2c 6f 00
-        '''),
-
-        'expected_signature': bytes.fromhex('''
+        """),
+        'expected_signature': bytes.fromhex("""
             00 00 00 09 73 73 68 2d 65 64 34 34 38
             00 00 00 72 06 86
             f4 64 a4 a6 ba d9 c3 22 c4 93 49 99 fc 11 de 67
@@ -96,11 +96,11 @@ dGhvdXQgcGFzc3BocmFzZQECAwQFBgcICQ==
             db e5 89 f3 35 be 24 58 90 c6 ca 04 f0 db 88 80
             db bd 77 7c 80 20 7f 3a 48 61 f6 1f ae a9 5e 53
             7b e0 9d 93 1e ea dc eb b5 cd 56 4c ea 8f 08 00
-        '''),
+        """),
         'derived_passphrase': rb'Bob0ZKSmutnDIsSTSZn8Ed5nlwjy2Lc8LBPnxRwekqYO2C9tgQOCAONy5DJtctJtMoQ/zKkeVywAmrOZ3kXazi7R2+WJ8zW+JFiQxsoE8NuIgNu9d3yAIH86SGH2H66pXlN74J2THurc67XNVkzqjwgA',  # noqa: E501
     },
     'rsa': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
 NhAAAAAwEAAQAAAYEAsaHu6Xs4cVsuDSNJlMCqoPVgmDgEviI8TfXmHKqX3JkIqI3LsvV7
 Ijf8WCdTveEq7CkuZhImtsR52AOEVAoU8mDXDNr+nJ5wUPzf1UIaRjDe0lcXW4SlF01hQs
@@ -138,10 +138,10 @@ vC2EAD91xexdorIA5BgXU+qltBqzzBVzVtF7+jOZOjfzOlaTX9I5I5veyeTaTxZj1XXUzi
 btBNdMEJJp7ifucYmoYAAwE7K+VlWagDEK2y8Mte9y9E+N0uO2j+h85sQt/UIb2iE/vhcg
 Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCxoe7pezhxWy4NI0mUwKqg9WCYOAS+IjxN9eYcqpfcmQiojcuy9XsiN/xYJ1O94SrsKS5mEia2xHnYA4RUChTyYNcM2v6cnnBQ/N/VQhpGMN7SVxdbhKUXTWFCwbjBgO6rGyHB6WtoH8vd7TOEPt+NgcXwhsWyoaUUdYTA62V+GF9vEmxMaC4ubgDz+B0QkPnauSoNxmkhcIe0lsLNb1pClZyz88PDnKXCX/d0HuN/HJ+sbPg7dCvOyqFYSyKn3uY6bCXqoIdurxXzH3O7z0P8f5sbmKOrGGKNuNxVRbeVl/D/3uDL0nqsbfUc1qvkfwbJwtMXC4IV6kOZMSk2BAsqh7x48gQ+rhYeEVSi8F3CWs4HJQoqrGt7K9a3mCSlMBHP70u3w6ME7eumoryxlUofewTd17ZEkzdX08l2ZlKzZvwQUrc+xQZ2Uw8z2mfW6Ti4gi0pYGaig7Ke4PwuXpo/C5YAWfeXycsvJZ2uaYRjMdZeJGNAnHLUGLkBscw5aI8= test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCxoe7pezhxWy4NI0mUwKqg9WCYOAS+IjxN9eYcqpfcmQiojcuy9XsiN/xYJ1O94SrsKS5mEia2xHnYA4RUChTyYNcM2v6cnnBQ/N/VQhpGMN7SVxdbhKUXTWFCwbjBgO6rGyHB6WtoH8vd7TOEPt+NgcXwhsWyoaUUdYTA62V+GF9vEmxMaC4ubgDz+B0QkPnauSoNxmkhcIe0lsLNb1pClZyz88PDnKXCX/d0HuN/HJ+sbPg7dCvOyqFYSyKn3uY6bCXqoIdurxXzH3O7z0P8f5sbmKOrGGKNuNxVRbeVl/D/3uDL0nqsbfUc1qvkfwbJwtMXC4IV6kOZMSk2BAsqh7x48gQ+rhYeEVSi8F3CWs4HJQoqrGt7K9a3mCSlMBHP70u3w6ME7eumoryxlUofewTd17ZEkzdX08l2ZlKzZvwQUrc+xQZ2Uw8z2mfW6Ti4gi0pYGaig7Ke4PwuXpo/C5YAWfeXycsvJZ2uaYRjMdZeJGNAnHLUGLkBscw5aI8= test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 07 73 73 68 2d 72 73 61
             00 00 00 03 01 00 01
             00 00 01 81 00
@@ -169,8 +169,8 @@ Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
             b8 82 2d 29 60 66 a2 83 b2 9e e0 fc 2e 5e 9a 3f
             0b 96 00 59 f7 97 c9 cb 2f 25 9d ae 69 84 63 31
             d6 5e 24 63 40 9c 72 d4 18 b9 01 b1 cc 39 68 8f
-'''),
-        'expected_signature': bytes.fromhex('''
+"""),
+        'expected_signature': bytes.fromhex("""
             00 00 00 07 73 73 68 2d 72 73 61
             00 00 01 80
             a2 10 7c 2e f6 bb 53 a8 74 2a a1 19 99 ad 81 be
@@ -197,14 +197,14 @@ Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
             a4 1b bc d2 29 b8 78 61 2b 78 e6 b1 52 b0 d5 ec
             de 69 2c 48 62 d9 fd d1 9b 6b b0 49 db d3 ff 38
             e7 10 d9 2d ce 9f 0d 5e 09 7b 37 d2 7b c3 bf ce
-'''),
+"""),
         'derived_passphrase': rb'ohB8Lva7U6h0KqEZma2Bvnmc7dadCU5uxRhIM5B3mWj3ngNazU4Y64l9haLurkqS9m/Ouf6GfyprMdpuGv6ipYi4RH+hdnOz7HW10Ka5FZdlCRN9lCHR+10PiyMEd8LDVSKxoAmK9Tgq1n8bhymgJdMlb8tkYQeY3BTFhPiSJF5QEWtJ5fDMKcspqRnYp3EfkQsFsQFLwl8ApbYhv/gsnWebRzsKSWt5Lfwd7Ayw5Sci1an408P530ho6fvvPNwmv8/qKUMBpuPFUZX0Zm2KVeJH7OgwRUyuR+fJpCGLZLq2iPYh+HO5yxGheHWSxlrlZP7tQtmVmeYrbzwWPCh0pHIvDT8sM2eqNRmO57URL7P3asUC4m+jQuNiGZkD6qUg56HjvMgGo7V81nZd329gRoMqCADW09mkwUGM+GBWRYHaO6IWH55OdYMX2sNTwz4ZpBu80im4eGEreOaxUrDV7N5pLEhi2f3Rm2uwSdvT/zjnENktzp8NXgl7N9J7w7/O',  # noqa: E501
     },
 }
 
 UNSUITABLE_KEYS: Mapping[str, SSHTestKey] = {
     'dsa1024': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABsQAAAAdzc2gtZH
 NzAAAAgQC7KAZXqBGNVLBQPrcMYAoNW54BhD8aIhe7BDWYzJcsaMt72VKSkguZ8+XR7nRa
 0C/ZsBi+uJp0dpxy9ZMTOWX4u5YPMeQcXEdGExZIfimGqSOAsy6fCld2IfJZJZExcCmhe9
@@ -225,10 +225,10 @@ mMbWEYp/C8jC6ikZqmtEOVK7w3woYC4b7BvWEm/zKcOapvD4h0mn8IZGs/7Xt/vISqIKqH
 u7HfrQhdOiKSa+ZO9AAojbURqrLDRfBJa5dXn2AAAAFQDJHfenj4EJ9WkehpdJatPBlqCW
 0gAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UBAgMEBQYH
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ssh-dss AAAAB3NzaC1kc3MAAACBALsoBleoEY1UsFA+twxgCg1bngGEPxoiF7sENZjMlyxoy3vZUpKSC5nz5dHudFrQL9mwGL64mnR2nHL1kxM5Zfi7lg8x5BxcR0YTFkh+KYapI4CzLp8KV3Yh8lklkTFwKaF71KyOx3dhIA8lGW45cVBz3kxmhHmEzCUgMPxDOsTtAAAAFQD32c5k6B3tocxUahelQQFyfseiywAAAIAuvYCDeHEzesp3HNVTDx9fRVU9c77f4qvyEZ7Qpz/s3BVoFUvUZDx96cG5bKekBRsfTCjeHXCQH/yFfqn5Lxye7msgGVS5U3AvD9shiiEr3wt+pNgr9X6DooP7ybfjC8SJdmarLBjnifZuSxyHU2q+P+02kvMTFLH9dLSRIzVqKAAAAIBtA1E9xUS4YOsRx/7GDm2AB6M9cE9ev8myz4KGTriSbeaKsxiMBbJZi1VyBP7uE5jG1hGKfwvIwuopGaprRDlSu8N8KGAuG+wb1hJv8ynDmqbw+IdJp/CGRrP+17f7yEqiCqh7ux360IXToikmvmTvQAKI21Eaqyw0XwSWuXV59g== test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ssh-dss AAAAB3NzaC1kc3MAAACBALsoBleoEY1UsFA+twxgCg1bngGEPxoiF7sENZjMlyxoy3vZUpKSC5nz5dHudFrQL9mwGL64mnR2nHL1kxM5Zfi7lg8x5BxcR0YTFkh+KYapI4CzLp8KV3Yh8lklkTFwKaF71KyOx3dhIA8lGW45cVBz3kxmhHmEzCUgMPxDOsTtAAAAFQD32c5k6B3tocxUahelQQFyfseiywAAAIAuvYCDeHEzesp3HNVTDx9fRVU9c77f4qvyEZ7Qpz/s3BVoFUvUZDx96cG5bKekBRsfTCjeHXCQH/yFfqn5Lxye7msgGVS5U3AvD9shiiEr3wt+pNgr9X6DooP7ybfjC8SJdmarLBjnifZuSxyHU2q+P+02kvMTFLH9dLSRIzVqKAAAAIBtA1E9xUS4YOsRx/7GDm2AB6M9cE9ev8myz4KGTriSbeaKsxiMBbJZi1VyBP7uE5jG1hGKfwvIwuopGaprRDlSu8N8KGAuG+wb1hJv8ynDmqbw+IdJp/CGRrP+17f7yEqiCqh7ux360IXToikmvmTvQAKI21Eaqyw0XwSWuXV59g== test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 07 73 73 68 2d 64 73 73
             00 00 00 81 00
             bb 28 06 57 a8 11 8d 54 b0 50 3e b7 0c 60 0a 0d
@@ -259,12 +259,12 @@ u7HfrQhdOiKSa+ZO9AAojbURqrLDRfBJa5dXn2AAAAFQDJHfenj4EJ9WkehpdJatPBlqCW
             a6 f0 f8 87 49 a7 f0 86 46 b3 fe d7 b7 fb c8 4a
             a2 0a a8 7b bb 1d fa d0 85 d3 a2 29 26 be 64 ef
             40 02 88 db 51 1a ab 2c 34 5f 04 96 b9 75 79 f6
-'''),
+"""),
         'expected_signature': None,
         'derived_passphrase': None,
     },
     'ecdsa256': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAaAAAABNlY2RzYS
 1zaGEyLW5pc3RwMjU2AAAACG5pc3RwMjU2AAAAQQTLbU0zDwsk2Dvp+VYIrsNVf5gWwz2S
 3SZ8TbxiQRkpnGSVqyIoHJOJc+NQItAa7xlJ/8Z6gfz57Z3apUkaMJm6AAAAuKeY+YinmP
@@ -273,10 +273,10 @@ Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmb
 oAAAAhAKIl/3n0pKVIxpZkXTGtii782Qr4yIcvHdpxjO/QsIqKAAAAG3Rlc3Qga2V5IHdp
 dGhvdXQgcGFzc3BocmFzZQECAwQ=
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBMttTTMPCyTYO+n5Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmbo= test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBMttTTMPCyTYO+n5Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmbo= test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 13 65 63 64 73 61 2d 73 68 61 32 2d 6e
             69 73 74 70 32 35 36
             00 00 00 08 6e 69 73 74 70 32 35 36
@@ -285,12 +285,12 @@ dGhvdXQgcGFzc3BocmFzZQECAwQ=
             7f 98 16 c3 3d 92 dd 26 7c 4d bc 62 41 19 29 9c
             64 95 ab 22 28 1c 93 89 73 e3 50 22 d0 1a ef 19
             49 ff c6 7a 81 fc f9 ed 9d da a5 49 1a 30 99 ba
-'''),
+"""),
         'expected_signature': None,
         'derived_passphrase': None,
     },
     'ecdsa384': {
-        'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
+        'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAiAAAABNlY2RzYS
 1zaGEyLW5pc3RwMzg0AAAACG5pc3RwMzg0AAAAYQSgkOjkAvq7v5vHuj3KBL4/EAWcn5hZ
 DyKcbyV0eBMGFq7hKXQlZqIahLVqeMR0QqmkxNJ2rly2VHcXneq3vZ+9fIsWCOdYk5WP3N
@@ -300,10 +300,10 @@ au4Sl0JWaiGoS1anjEdEKppMTSdq5ctlR3F53qt72fvXyLFgjnWJOVj9zWT87/ddV5+8Gx
 JAu0J3Q+cypZuKQVAAAAMQD5sTy8p+B1cn/DhOmXquui1BcxvASqzzevkBlbQoBa73y04B
 2OdqVOVRkwZWRROz0AAAAbdGVzdCBrZXkgd2l0aG91dCBwYXNzcGhyYXNlAQIDBA==
 -----END OPENSSH PRIVATE KEY-----
-''',
-        'public_key': rb'''ecdsa-sha2-nistp384 AAAAE2VjZHNhLXNoYTItbmlzdHAzODQAAAAIbmlzdHAzODQAAABhBKCQ6OQC+ru/m8e6PcoEvj8QBZyfmFkPIpxvJXR4EwYWruEpdCVmohqEtWp4xHRCqaTE0nauXLZUdxed6re9n718ixYI51iTlY/c1k/O/3XVefvBsSQLtCd0PnMqWbikFQ== test key without passphrase
-''',  # noqa: E501
-        'public_key_data': bytes.fromhex('''
+""",
+        'public_key': rb"""ecdsa-sha2-nistp384 AAAAE2VjZHNhLXNoYTItbmlzdHAzODQAAAAIbmlzdHAzODQAAABhBKCQ6OQC+ru/m8e6PcoEvj8QBZyfmFkPIpxvJXR4EwYWruEpdCVmohqEtWp4xHRCqaTE0nauXLZUdxed6re9n718ixYI51iTlY/c1k/O/3XVefvBsSQLtCd0PnMqWbikFQ== test key without passphrase
+""",  # noqa: E501
+        'public_key_data': bytes.fromhex("""
             00 00 00 13
             65 63 64 73 61 2d 73 68 61 32 2d 6e 69 73 74 70
             33 38 34
@@ -315,7 +315,7 @@ JAu0J3Q+cypZuKQVAAAAMQD5sTy8p+B1cn/DhOmXquui1BcxvASqzzevkBlbQoBa73y04B
             a4 c4 d2 76 ae 5c b6 54 77 17 9d ea b7 bd 9f bd
             7c 8b 16 08 e7 58 93 95 8f dc d6 4f ce ff 75 d5
             79 fb c1 b1 24 0b b4 27 74 3e 73 2a 59 b8 a4 15
-'''),
+"""),
         'expected_signature': None,
         'derived_passphrase': None,
     },
@@ -327,8 +327,16 @@ DUMMY_KEY1 = SUPPORTED_KEYS['ed25519']['public_key_data']
 DUMMY_KEY1_B64 = base64.standard_b64encode(DUMMY_KEY1).decode('ASCII')
 DUMMY_KEY2 = SUPPORTED_KEYS['rsa']['public_key_data']
 DUMMY_KEY2_B64 = base64.standard_b64encode(DUMMY_KEY2).decode('ASCII')
-DUMMY_CONFIG_SETTINGS = {"length": 10, "upper": 1, "lower": 1, "repeat": 5,
-                         "number": 1, "space": 1, "dash": 1, "symbol": 1}
+DUMMY_CONFIG_SETTINGS = {
+    'length': 10,
+    'upper': 1,
+    'lower': 1,
+    'repeat': 5,
+    'number': 1,
+    'space': 1,
+    'dash': 1,
+    'symbol': 1,
+}
 DUMMY_RESULT_PASSPHRASE = b'.2V_QJkd o'
 DUMMY_RESULT_KEY1 = b'E<b<{ -7iG'
 DUMMY_PHRASE_FROM_KEY1_RAW = (
@@ -341,30 +349,40 @@ DUMMY_PHRASE_FROM_KEY1_RAW = (
 DUMMY_PHRASE_FROM_KEY1 = b'8JgZgGwal9UmA27M42WPhmYHExkTCSEzM/nkNlMdr/0NCB/s+HObjF9VORZ8U1QsHlK7MO1/ieIvaVFV2J6mAg=='  # noqa: E501
 
 skip_if_no_agent = pytest.mark.skipif(
-    not os.environ.get('SSH_AUTH_SOCK'), reason='running SSH agent required')
+    not os.environ.get('SSH_AUTH_SOCK'), reason='running SSH agent required'
+)
+
 
 def list_keys(
     self: Any = None,
 ) -> list[ssh_agent_client.types.KeyCommentPair]:
     del self  # Unused.
     Pair = ssh_agent_client.types.KeyCommentPair  # noqa: N806
-    list1 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
-             for key, value in SUPPORTED_KEYS.items()]
-    list2 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
-             for key, value in UNSUITABLE_KEYS.items()]
+    list1 = [
+        Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
+        for key, value in SUPPORTED_KEYS.items()
+    ]
+    list2 = [
+        Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
+        for key, value in UNSUITABLE_KEYS.items()
+    ]
     return list1 + list2
 
+
 def list_keys_singleton(
     self: Any = None,
 ) -> list[ssh_agent_client.types.KeyCommentPair]:
     del self  # Unused.
     Pair = ssh_agent_client.types.KeyCommentPair  # noqa: N806
-    list1 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
-             for key, value in SUPPORTED_KEYS.items()]
+    list1 = [
+        Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
+        for key, value in SUPPORTED_KEYS.items()
+    ]
     return list1[:1]
 
+
 def suitable_ssh_keys(
-    conn: Any
+    conn: Any,
 ) -> Iterator[ssh_agent_client.types.KeyCommentPair]:
     del conn  # Unused.
     yield from [
@@ -377,9 +396,12 @@ def phrase_from_key(key: bytes) -> bytes:
         return DUMMY_PHRASE_FROM_KEY1
     raise KeyError(key)  # pragma: no cover
 
+
 @contextlib.contextmanager
 def isolated_config(
-    monkeypatch: Any, runner: click.testing.CliRunner, config: Any,
+    monkeypatch: Any,
+    runner: click.testing.CliRunner,
+    config: Any,
 ):
     prog_name = derivepassphrase.cli.PROG_NAME
     env_name = prog_name.replace(' ', '_').upper() + '_PATH'
@@ -393,7 +415,8 @@ def isolated_config(
         )
         with open(
             derivepassphrase.cli._config_filename(),
-            'w', encoding='UTF-8',
+            'w',
+            encoding='UTF-8',
         ) as outfile:
             json.dump(config, outfile)
         yield

tests/test_derivepassphrase.py

Zeige Datei @ 99863c4

@@ -15,115 +15,149 @@ import derivepassphrase
 
 Vault = derivepassphrase.Vault
 
-class TestVault:
 
+class TestVault:
     phrase = b'She cells C shells bye the sea shoars'
     google_phrase = rb': 4TVH#5:aZl8LueOT\{'
     twitter_phrase = rb"[ (HN_N:lI&<ro=)3'g9"
 
-    @pytest.mark.parametrize(['service', 'expected'], [
+    @pytest.mark.parametrize(
+        ['service', 'expected'],
+        [
             (b'google', google_phrase),
             ('twitter', twitter_phrase),
-    ])
+        ],
+    )
     def test_200_basic_configuration(self, service, expected):
         assert Vault(phrase=self.phrase).generate(service) == expected
 
     def test_201_phrase_dependence(self):
         assert (
-            Vault(phrase=(self.phrase + b'X')).generate('google') ==
-            b'n+oIz6sL>K*lTEWYRO%7'
+            Vault(phrase=(self.phrase + b'X')).generate('google')
+            == b'n+oIz6sL>K*lTEWYRO%7'
         )
 
     def test_202_reproducibility_and_bytes_service_name(self):
-        assert (
-            Vault(phrase=self.phrase).generate(b'google') ==
-            Vault(phrase=self.phrase).generate('google')
-        )
+        assert Vault(phrase=self.phrase).generate(b'google') == Vault(
+            phrase=self.phrase
+        ).generate('google')
 
     def test_203_reproducibility_and_bytearray_service_name(self):
-        assert (
-            Vault(phrase=self.phrase).generate(b'google') ==
-            Vault(phrase=self.phrase).generate(bytearray(b'google'))
-        )
+        assert Vault(phrase=self.phrase).generate(b'google') == Vault(
+            phrase=self.phrase
+        ).generate(bytearray(b'google'))
 
     def test_210_nonstandard_length(self):
         assert (
-            Vault(phrase=self.phrase, length=4).generate('google')
-            == b'xDFu'
+            Vault(phrase=self.phrase, length=4).generate('google') == b'xDFu'
         )
 
     def test_211_repetition_limit(self):
         assert (
-            Vault(phrase=b'', length=24, symbol=0, number=0,
-                  repeat=1).generate('asd') ==
-            b'IVTDzACftqopUXqDHPkuCIhV'
+            Vault(
+                phrase=b'', length=24, symbol=0, number=0, repeat=1
+            ).generate('asd')
+            == b'IVTDzACftqopUXqDHPkuCIhV'
         )
 
     def test_212_without_symbols(self):
         assert (
-            Vault(phrase=self.phrase, symbol=0).generate('google') ==
-            b'XZ4wRe0bZCazbljCaMqR'
+            Vault(phrase=self.phrase, symbol=0).generate('google')
+            == b'XZ4wRe0bZCazbljCaMqR'
         )
 
     def test_213_no_numbers(self):
         assert (
-            Vault(phrase=self.phrase, number=0).generate('google') ==
-            b'_*$TVH.%^aZl(LUeOT?>'
+            Vault(phrase=self.phrase, number=0).generate('google')
+            == b'_*$TVH.%^aZl(LUeOT?>'
         )
 
     def test_214_no_lowercase_letters(self):
         assert (
-            Vault(phrase=self.phrase, lower=0).generate('google') ==
-            b':{?)+7~@OA:L]!0E$)(+'
+            Vault(phrase=self.phrase, lower=0).generate('google')
+            == b':{?)+7~@OA:L]!0E$)(+'
         )
 
     def test_215_at_least_5_digits(self):
         assert (
-            Vault(phrase=self.phrase, length=8, number=5)
-            .generate('songkick') == b'i0908.7['
+            Vault(phrase=self.phrase, length=8, number=5).generate('songkick')
+            == b'i0908.7['
         )
 
     def test_216_lots_of_spaces(self):
         assert (
-            Vault(phrase=self.phrase, space=12)
-            .generate('songkick') == b' c   6 Bq  % 5fR    '
+            Vault(phrase=self.phrase, space=12).generate('songkick')
+            == b' c   6 Bq  % 5fR    '
         )
 
     def test_217_all_character_classes(self):
         assert (
-            Vault(phrase=self.phrase, lower=2, upper=2, number=1,
-                  space=3, dash=2, symbol=1)
-            .generate('google') == b': : fv_wqt>a-4w1S  R'
+            Vault(
+                phrase=self.phrase,
+                lower=2,
+                upper=2,
+                number=1,
+                space=3,
+                dash=2,
+                symbol=1,
+            ).generate('google')
+            == b': : fv_wqt>a-4w1S  R'
         )
 
     def test_218_only_numbers_and_very_high_repetition_limit(self):
-        generated = Vault(phrase=b'', length=40, lower=0, upper=0, space=0,
-                          dash=0, symbol=0, repeat=4).generate('abcdef')
-        forbidden_substrings = {b'0000', b'1111', b'2222', b'3333', b'4444',
-                                b'5555', b'6666', b'7777', b'8888', b'9999'}
+        generated = Vault(
+            phrase=b'',
+            length=40,
+            lower=0,
+            upper=0,
+            space=0,
+            dash=0,
+            symbol=0,
+            repeat=4,
+        ).generate('abcdef')
+        forbidden_substrings = {
+            b'0000',
+            b'1111',
+            b'2222',
+            b'3333',
+            b'4444',
+            b'5555',
+            b'6666',
+            b'7777',
+            b'8888',
+            b'9999',
+        }
         for substring in forbidden_substrings:
             assert substring not in generated
 
     def test_219_very_limited_character_set(self):
-        generated = Vault(phrase=b'', length=24, lower=0, upper=0,
-                          space=0, symbol=0).generate('testing')
+        generated = Vault(
+            phrase=b'', length=24, lower=0, upper=0, space=0, symbol=0
+        ).generate('testing')
         assert generated == b'763252593304946694588866'
 
     def test_220_character_set_subtraction(self):
         assert Vault._subtract(b'be', b'abcdef') == bytearray(b'acdf')
 
-    @pytest.mark.parametrize(['length', 'settings', 'entropy'], [
+    @pytest.mark.parametrize(
+        ['length', 'settings', 'entropy'],
+        [
             (20, {}, math.log2(math.factorial(20)) + 20 * math.log2(94)),
             (
                 20,
                 {'upper': 0, 'number': 0, 'space': 0, 'symbol': 0},
-            math.log2(math.factorial(20)) + 20 * math.log2(26)
+                math.log2(math.factorial(20)) + 20 * math.log2(26),
             ),
             (0, {}, float('-inf')),
-        (0, {'lower': 0, 'number': 0, 'space': 0, 'symbol': 0}, float('-inf')),
+            (
+                0,
+                {'lower': 0, 'number': 0, 'space': 0, 'symbol': 0},
+                float('-inf'),
+            ),
             (1, {}, math.log2(94)),
             (1, {'upper': 0, 'lower': 0, 'number': 0, 'symbol': 0}, 0.0),
-    ])
+        ],
+    )
     def test_221_entropy(
         self, length: int, settings: dict[str, int], entropy: int
     ) -> None:
@@ -131,38 +165,54 @@ class TestVault:
         assert math.isclose(v._entropy(), entropy)
         assert v._estimate_sufficient_hash_length() > 0
         if math.isfinite(entropy) and entropy:
-            assert (
-                v._estimate_sufficient_hash_length(1.0) ==
-                math.ceil(entropy / 8)
+            assert v._estimate_sufficient_hash_length(1.0) == math.ceil(
+                entropy / 8
             )
         assert v._estimate_sufficient_hash_length(8.0) >= entropy
 
     def test_222_hash_length_estimation(self) -> None:
-        v = Vault(phrase=self.phrase, lower=0, upper=0, number=0,
-                   symbol=0, space=1, length=1)
+        v = Vault(
+            phrase=self.phrase,
+            lower=0,
+            upper=0,
+            number=0,
+            symbol=0,
+            space=1,
+            length=1,
+        )
         assert v._entropy() == 0.0
         assert v._estimate_sufficient_hash_length() > 0
 
-    @pytest.mark.parametrize(['service', 'expected'], [
+    @pytest.mark.parametrize(
+        ['service', 'expected'],
+        [
             (b'google', google_phrase),
             ('twitter', twitter_phrase),
-    ])
+        ],
+    )
     def test_223_hash_length_expansion(
         self, monkeypatch: Any, service: str | bytes, expected: bytes
     ) -> None:
         v = Vault(phrase=self.phrase)
-        monkeypatch.setattr(v,
+        monkeypatch.setattr(
+            v,
             '_estimate_sufficient_hash_length',
-                            lambda *args, **kwargs: 1)  # noqa: ARG005
+            lambda *args, **kwargs: 1,  # noqa: ARG005
+        )
         assert v._estimate_sufficient_hash_length() < len(self.phrase)
         assert v.generate(service) == expected
 
-    @pytest.mark.parametrize(['s', 'raises'], [
-        ('ñ', True), ('Düsseldorf', True),
-        ('liberté, egalité, fraternité', True), ('ASCII', False),
+    @pytest.mark.parametrize(
+        ['s', 'raises'],
+        [
+            ('ñ', True),
+            ('Düsseldorf', True),
+            ('liberté, egalité, fraternité', True),
+            ('ASCII', False),
             (b'D\xc3\xbcsseldorf', False),
             (bytearray([2, 3, 5, 7, 11, 13]), False),
-    ])
+        ],
+    )
     def test_224_binary_strings(
         self, s: str | bytes | bytearray, raises: bool
     ) -> None:
@@ -181,15 +231,22 @@ class TestVault:
             assert binstr(binstr(s)) == bytes(s)
 
     def test_310_too_many_symbols(self):
-        with pytest.raises(ValueError,
-                           match='requested passphrase length too short'):
+        with pytest.raises(
+            ValueError, match='requested passphrase length too short'
+        ):
             Vault(phrase=self.phrase, symbol=100)
 
     def test_311_no_viable_characters(self):
-        with pytest.raises(ValueError,
-                           match='no allowed characters left'):
-            Vault(phrase=self.phrase, lower=0, upper=0, number=0,
-                  space=0, dash=0, symbol=0)
+        with pytest.raises(ValueError, match='no allowed characters left'):
+            Vault(
+                phrase=self.phrase,
+                lower=0,
+                upper=0,
+                number=0,
+                space=0,
+                dash=0,
+                symbol=0,
+            )
 
     def test_320_character_set_subtraction_duplicate(self):
         with pytest.raises(ValueError, match='duplicate characters'):
@@ -199,9 +256,9 @@ class TestVault:
 
     def test_322_hash_length_estimation(self) -> None:
         v = Vault(phrase=self.phrase)
-        with pytest.raises(ValueError,
-                           match='invalid safety factor'):
+        with pytest.raises(ValueError, match='invalid safety factor'):
             assert v._estimate_sufficient_hash_length(-1.0)
-        with pytest.raises(TypeError,
-                           match='invalid safety factor: not a float'):
+        with pytest.raises(
+            TypeError, match='invalid safety factor: not a float'
+        ):
             assert v._estimate_sufficient_hash_length(None)  # type: ignore

tests/test_derivepassphrase_cli.py

Zeige Datei @ 99863c4

@@ -56,68 +58,91 @@ class OptionCombination(NamedTuple):
 
 
 PASSWORD_GENERATION_OPTIONS: list[tuple[str, ...]] = [
-    ('--phrase',), ('--key',), ('--length', '20'), ('--repeat', '20'),
-    ('--lower', '1'), ('--upper', '1'), ('--number', '1'),
-    ('--space', '1'), ('--dash', '1'), ('--symbol', '1')
+    ('--phrase',),
+    ('--key',),
+    ('--length', '20'),
+    ('--repeat', '20'),
+    ('--lower', '1'),
+    ('--upper', '1'),
+    ('--number', '1'),
+    ('--space', '1'),
+    ('--dash', '1'),
+    ('--symbol', '1'),
 ]
 CONFIGURATION_OPTIONS: list[tuple[str, ...]] = [
-    ('--notes',), ('--config',), ('--delete',), ('--delete-globals',),
-    ('--clear',)
+    ('--notes',),
+    ('--config',),
+    ('--delete',),
+    ('--delete-globals',),
+    ('--clear',),
 ]
 CONFIGURATION_COMMANDS: list[tuple[str, ...]] = [
-    ('--notes',), ('--delete',), ('--delete-globals',), ('--clear',)
-]
-STORAGE_OPTIONS: list[tuple[str, ...]] = [
-    ('--export', '-'), ('--import', '-')
+    ('--notes',),
+    ('--delete',),
+    ('--delete-globals',),
+    ('--clear',),
 ]
+STORAGE_OPTIONS: list[tuple[str, ...]] = [('--export', '-'), ('--import', '-')]
 INCOMPATIBLE: dict[tuple[str, ...], IncompatibleConfiguration] = {
     ('--phrase',): IncompatibleConfiguration(
         [('--key',), *CONFIGURATION_COMMANDS, *STORAGE_OPTIONS],
-        True, DUMMY_PASSPHRASE),
+        True,
+        DUMMY_PASSPHRASE,
+    ),
     ('--key',): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--length', '20'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--repeat', '20'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--lower', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--upper', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--number', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--space', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--dash', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--symbol', '1'): IncompatibleConfiguration(
-        CONFIGURATION_COMMANDS + STORAGE_OPTIONS,
-        True, DUMMY_PASSPHRASE),
+        CONFIGURATION_COMMANDS + STORAGE_OPTIONS, True, DUMMY_PASSPHRASE
+    ),
     ('--notes',): IncompatibleConfiguration(
-        [('--config',), ('--delete',), ('--delete-globals',),
-         ('--clear',), *STORAGE_OPTIONS],
-        True, None),
+        [
+            ('--config',),
+            ('--delete',),
+            ('--delete-globals',),
+            ('--clear',),
+            *STORAGE_OPTIONS,
+        ],
+        True,
+        None,
+    ),
     ('--config', '-p'): IncompatibleConfiguration(
-        [('--delete',), ('--delete-globals',),
-         ('--clear',), *STORAGE_OPTIONS],
-        None, DUMMY_PASSPHRASE),
+        [('--delete',), ('--delete-globals',), ('--clear',), *STORAGE_OPTIONS],
+        None,
+        DUMMY_PASSPHRASE,
+    ),
     ('--delete',): IncompatibleConfiguration(
-        [('--delete-globals',), ('--clear',), *STORAGE_OPTIONS], True, None),
+        [('--delete-globals',), ('--clear',), *STORAGE_OPTIONS], True, None
+    ),
     ('--delete-globals',): IncompatibleConfiguration(
-        [('--clear',), *STORAGE_OPTIONS], False, None),
+        [('--clear',), *STORAGE_OPTIONS], False, None
+    ),
     ('--clear',): IncompatibleConfiguration(STORAGE_OPTIONS, False, None),
     ('--export', '-'): IncompatibleConfiguration(
-        [('--import', '-')], False, None),
-    ('--import', '-'): IncompatibleConfiguration(
-        [], False, None),
+        [('--import', '-')], False, None
+    ),
+    ('--import', '-'): IncompatibleConfiguration([], False, None),
 }
 SINGLES: dict[tuple[str, ...], SingleConfiguration] = {
     ('--phrase',): SingleConfiguration(True, DUMMY_PASSPHRASE, True),
@@ -143,37 +168,50 @@ config: IncompatibleConfiguration | SingleConfiguration
 for opt, config in INCOMPATIBLE.items():
     for opt2 in config.other_options:
         INTERESTING_OPTION_COMBINATIONS.extend([
-            OptionCombination(options=list(opt + opt2), incompatible=True,
+            OptionCombination(
+                options=list(opt + opt2),
+                incompatible=True,
                 needs_service=config.needs_service,
-                              input=config.input, check_success=False),
-            OptionCombination(options=list(opt2 + opt), incompatible=True,
+                input=config.input,
+                check_success=False,
+            ),
+            OptionCombination(
+                options=list(opt2 + opt),
+                incompatible=True,
                 needs_service=config.needs_service,
-                              input=config.input, check_success=False)
+                input=config.input,
+                check_success=False,
+            ),
         ])
 for opt, config in SINGLES.items():
     INTERESTING_OPTION_COMBINATIONS.append(
-        OptionCombination(options=list(opt), incompatible=False,
+        OptionCombination(
+            options=list(opt),
+            incompatible=False,
             needs_service=config.needs_service,
             input=config.input,
-                          check_success=config.check_success))
+            check_success=config.check_success,
+        )
+    )
 
 
 class TestCLI:
     def test_200_help_output(self):
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase, ['--help'],
-                               catch_exceptions=False)
-        assert result.exit_code == 0
-        assert 'Password generation:\n' in result.output, (
-            'Option groups not respected in help text.'
-        )
-        assert 'Use NUMBER=0, e.g. "--symbol 0"' in result.output, (
-            'Option group epilog not printed.'
+        result = runner.invoke(
+            cli.derivepassphrase, ['--help'], catch_exceptions=False
         )
+        assert result.exit_code == 0
+        assert (
+            'Password generation:\n' in result.output
+        ), 'Option groups not respected in help text.'
+        assert (
+            'Use NUMBER=0, e.g. "--symbol 0"' in result.output
+        ), 'Option group epilog not printed.'
 
-    @pytest.mark.parametrize('charset_name',
-                             ['lower', 'upper', 'number', 'space',
-                              'dash', 'symbol'])
+    @pytest.mark.parametrize(
+        'charset_name', ['lower', 'upper', 'number', 'space', 'dash', 'symbol']
+    )
     def test_201_disable_character_set(
         self, monkeypatch: Any, charset_name: str
     ) -> None:
@@ -181,15 +219,18 @@ class TestCLI:
         option = f'--{charset_name}'
         charset = dpp.Vault._CHARSETS[charset_name].decode('ascii')
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase,
+        result = runner.invoke(
+            cli.derivepassphrase,
             [option, '0', '-p', DUMMY_SERVICE],
-                               input=DUMMY_PASSPHRASE, catch_exceptions=False)
-        assert result.exit_code == 0, (
-            f'program died unexpectedly with exit code {result.exit_code}'
-        )
-        assert not result.stderr_bytes, (
-            f'program barfed on stderr: {result.stderr_bytes!r}'
+            input=DUMMY_PASSPHRASE,
+            catch_exceptions=False,
         )
+        assert (
+            result.exit_code == 0
+        ), f'program died unexpectedly with exit code {result.exit_code}'
+        assert (
+            not result.stderr_bytes
+        ), f'program barfed on stderr: {result.stderr_bytes!r}'
         for c in charset:
             assert c not in result.stdout, (
                 f'derived password contains forbidden character {c!r}: '
@@ -199,15 +240,18 @@ class TestCLI:
     def test_202_disable_repetition(self, monkeypatch: Any) -> None:
         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase,
+        result = runner.invoke(
+            cli.derivepassphrase,
             ['--repeat', '0', '-p', DUMMY_SERVICE],
-                               input=DUMMY_PASSPHRASE, catch_exceptions=False)
-        assert result.exit_code == 0, (
-            f'program died unexpectedly with exit code {result.exit_code}'
-        )
-        assert not result.stderr_bytes, (
-            f'program barfed on stderr: {result.stderr_bytes!r}'
+            input=DUMMY_PASSPHRASE,
+            catch_exceptions=False,
         )
+        assert (
+            result.exit_code == 0
+        ), f'program died unexpectedly with exit code {result.exit_code}'
+        assert (
+            not result.stderr_bytes
+        ), f'program barfed on stderr: {result.stderr_bytes!r}'
         passphrase = result.stdout.rstrip('\r\n')
         for i in range(len(passphrase) - 1):
             assert passphrase[i : i + 1] != passphrase[i + 1 : i + 2], (
@@ -215,391 +259,497 @@ class TestCLI:
                 f'at position {i}: {result.stdout!r}'
             )
 
-    @pytest.mark.parametrize('config', [
-        pytest.param({'global': {'key': DUMMY_KEY1_B64},
-                      'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS}},
-                     id='global'),
-        pytest.param({'global': {'phrase': DUMMY_PASSPHRASE.rstrip(b'\n')
-                                           .decode('ASCII')},
-                      'services': {DUMMY_SERVICE: {'key': DUMMY_KEY1_B64,
-                                                   **DUMMY_CONFIG_SETTINGS}}},
-                     id='service'),
-    ])
+    @pytest.mark.parametrize(
+        'config',
+        [
+            pytest.param(
+                {
+                    'global': {'key': DUMMY_KEY1_B64},
+                    'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS},
+                },
+                id='global',
+            ),
+            pytest.param(
+                {
+                    'global': {
+                        'phrase': DUMMY_PASSPHRASE.rstrip(b'\n').decode(
+                            'ASCII'
+                        )
+                    },
+                    'services': {
+                        DUMMY_SERVICE: {
+                            'key': DUMMY_KEY1_B64,
+                            **DUMMY_CONFIG_SETTINGS,
+                        }
+                    },
+                },
+                id='service',
+            ),
+        ],
+    )
     def test_204a_key_from_config(
-        self, monkeypatch: Any, config: dpp.types.VaultConfig,
+        self,
+        monkeypatch: Any,
+        config: dpp.types.VaultConfig,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config=config):
-            monkeypatch.setattr(dpp.Vault, 'phrase_from_key',
-                                tests.phrase_from_key)
-            result = runner.invoke(cli.derivepassphrase, [DUMMY_SERVICE],
-                                   catch_exceptions=False)
-            assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                'program exited with failure'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config=config
+        ):
+            monkeypatch.setattr(
+                dpp.Vault, 'phrase_from_key', tests.phrase_from_key
+            )
+            result = runner.invoke(
+                cli.derivepassphrase, [DUMMY_SERVICE], catch_exceptions=False
             )
+            assert (result.exit_code, result.stderr_bytes) == (
+                0,
+                b'',
+            ), 'program exited with failure'
             assert (
                 result.stdout_bytes.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE
-            ), (
-                'program generated unexpected result (phrase instead of key)'
-            )
-            assert result.stdout_bytes.rstrip(b'\n') == DUMMY_RESULT_KEY1, (
-                'program generated unexpected result (wrong settings?)'
-            )
+            ), 'program generated unexpected result (phrase instead of key)'
+            assert (
+                result.stdout_bytes.rstrip(b'\n') == DUMMY_RESULT_KEY1
+            ), 'program generated unexpected result (wrong settings?)'
 
     def test_204b_key_from_command_line(self, monkeypatch: Any) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {DUMMY_SERVICE:
-                                               DUMMY_CONFIG_SETTINGS}}):
-            monkeypatch.setattr(cli, '_get_suitable_ssh_keys',
-                                tests.suitable_ssh_keys)
-            monkeypatch.setattr(dpp.Vault, 'phrase_from_key',
-                                tests.phrase_from_key)
-            result = runner.invoke(cli.derivepassphrase,
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'services': {DUMMY_SERVICE: DUMMY_CONFIG_SETTINGS}},
+        ):
+            monkeypatch.setattr(
+                cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
+            )
+            monkeypatch.setattr(
+                dpp.Vault, 'phrase_from_key', tests.phrase_from_key
+            )
+            result = runner.invoke(
+                cli.derivepassphrase,
                 ['-k', DUMMY_SERVICE],
-                                   input=b'1\n', catch_exceptions=False)
+                input=b'1\n',
+                catch_exceptions=False,
+            )
             assert result.exit_code == 0, 'program exited with failure'
             assert result.stdout_bytes, 'program output expected'
             last_line = result.stdout_bytes.splitlines(True)[-1]
-            assert last_line.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE, (
-                'program generated unexpected result (phrase instead of key)'
-            )
-            assert last_line.rstrip(b'\n') == DUMMY_RESULT_KEY1, (
-                'program generated unexpected result (wrong settings?)'
-            )
+            assert (
+                last_line.rstrip(b'\n') != DUMMY_RESULT_PASSPHRASE
+            ), 'program generated unexpected result (phrase instead of key)'
+            assert (
+                last_line.rstrip(b'\n') == DUMMY_RESULT_KEY1
+            ), 'program generated unexpected result (wrong settings?)'
 
     def test_205_service_phrase_if_key_in_global_config(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
         with tests.isolated_config(
-            monkeypatch=monkeypatch, runner=runner,
+            monkeypatch=monkeypatch,
+            runner=runner,
             config={
                 'global': {'key': DUMMY_KEY1_B64},
                 'services': {
                     DUMMY_SERVICE: {
-                        'phrase': DUMMY_PASSPHRASE.rstrip(b'\n')
-                                  .decode('ASCII'),
-                        **DUMMY_CONFIG_SETTINGS}}}
+                        'phrase': DUMMY_PASSPHRASE.rstrip(b'\n').decode(
+                            'ASCII'
+                        ),
+                        **DUMMY_CONFIG_SETTINGS,
+                    }
+                },
+            },
         ):
-            result = runner.invoke(cli.derivepassphrase, [DUMMY_SERVICE],
-                                   catch_exceptions=False)
+            result = runner.invoke(
+                cli.derivepassphrase, [DUMMY_SERVICE], catch_exceptions=False
+            )
             assert result.exit_code == 0, 'program exited with failure'
             assert result.stdout_bytes, 'program output expected'
             last_line = result.stdout_bytes.splitlines(True)[-1]
-            assert last_line.rstrip(b'\n') != DUMMY_RESULT_KEY1, (
-                'program generated unexpected result (key instead of phrase)'
-            )
-            assert last_line.rstrip(b'\n') == DUMMY_RESULT_PASSPHRASE, (
-                'program generated unexpected result (wrong settings?)'
-            )
+            assert (
+                last_line.rstrip(b'\n') != DUMMY_RESULT_KEY1
+            ), 'program generated unexpected result (key instead of phrase)'
+            assert (
+                last_line.rstrip(b'\n') == DUMMY_RESULT_PASSPHRASE
+            ), 'program generated unexpected result (wrong settings?)'
 
-    @pytest.mark.parametrize('option',
-                             ['--lower', '--upper', '--number',
-                              '--space', '--dash', '--symbol',
-                              '--repeat', '--length'])
+    @pytest.mark.parametrize(
+        'option',
+        [
+            '--lower',
+            '--upper',
+            '--number',
+            '--space',
+            '--dash',
+            '--symbol',
+            '--repeat',
+            '--length',
+        ],
+    )
     def test_210_invalid_argument_range(self, option: str) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
         value: str | int
         for value in '-42', 'invalid':
-            result = runner.invoke(cli.derivepassphrase,
-                                   [option, cast(str, value), '-p',
-                                    DUMMY_SERVICE],
+            result = runner.invoke(
+                cli.derivepassphrase,
+                [option, cast(str, value), '-p', DUMMY_SERVICE],
                 input=DUMMY_PASSPHRASE,
-                                   catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'Error: Invalid value' in result.stderr_bytes, (
-                'program did not print the expected error message'
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'Error: Invalid value' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     @pytest.mark.parametrize(
         ['options', 'service', 'input', 'check_success'],
-        [(o.options, o.needs_service, o.input, o.check_success)
-         for o in INTERESTING_OPTION_COMBINATIONS if not o.incompatible],
+        [
+            (o.options, o.needs_service, o.input, o.check_success)
+            for o in INTERESTING_OPTION_COMBINATIONS
+            if not o.incompatible
+        ],
     )
     def test_211_service_needed(
-        self, monkeypatch: Any, options: list[str],
-        service: bool | None, input: bytes | None, check_success: bool,
+        self,
+        monkeypatch: Any,
+        options: list[str],
+        service: bool | None,
+        input: bytes | None,
+        check_success: bool,
     ) -> None:
         monkeypatch.setattr(cli, '_prompt_for_passphrase', tests.auto_prompt)
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            result = runner.invoke(cli.derivepassphrase,
-                                   options if service
-                                   else [*options, DUMMY_SERVICE],
-                                   input=input, catch_exceptions=False)
-            if service is not None:
-                assert result.exit_code > 0, (
-                    'program unexpectedly succeeded'
-                )
-                assert result.stderr_bytes, (
-                    'program did not print any error message'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            result = runner.invoke(
+                cli.derivepassphrase,
+                options if service else [*options, DUMMY_SERVICE],
+                input=input,
+                catch_exceptions=False,
             )
-                err_msg = (b' requires a SERVICE' if service
-                           else b' does not take a SERVICE argument')
-                assert err_msg in result.stderr_bytes, (
-                    'program did not print the expected error message'
+            if service is not None:
+                assert result.exit_code > 0, 'program unexpectedly succeeded'
+                assert (
+                    result.stderr_bytes
+                ), 'program did not print any error message'
+                err_msg = (
+                    b' requires a SERVICE'
+                    if service
+                    else b' does not take a SERVICE argument'
                 )
+                assert (
+                    err_msg in result.stderr_bytes
+                ), 'program did not print the expected error message'
             else:
-                assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                    'program unexpectedly failed'
-                )
+                assert (result.exit_code, result.stderr_bytes) == (
+                    0,
+                    b'',
+                ), 'program unexpectedly failed'
         if check_success:
-            with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                       config={'global': {'phrase': 'abc'},
-                                               'services': {}}):
-                monkeypatch.setattr(cli, '_prompt_for_passphrase',
-                                    tests.auto_prompt)
-                result = runner.invoke(cli.derivepassphrase,
-                                       [*options, DUMMY_SERVICE]
-                                       if service else options,
-                                       input=input, catch_exceptions=False)
-                assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                    'program unexpectedly failed'
+            with tests.isolated_config(
+                monkeypatch=monkeypatch,
+                runner=runner,
+                config={'global': {'phrase': 'abc'}, 'services': {}},
+            ):
+                monkeypatch.setattr(
+                    cli, '_prompt_for_passphrase', tests.auto_prompt
+                )
+                result = runner.invoke(
+                    cli.derivepassphrase,
+                    [*options, DUMMY_SERVICE] if service else options,
+                    input=input,
+                    catch_exceptions=False,
                 )
+                assert (result.exit_code, result.stderr_bytes) == (
+                    0,
+                    b'',
+                ), 'program unexpectedly failed'
 
     @pytest.mark.parametrize(
         ['options', 'service'],
-        [(o.options, o.needs_service)
-         for o in INTERESTING_OPTION_COMBINATIONS if o.incompatible],
+        [
+            (o.options, o.needs_service)
+            for o in INTERESTING_OPTION_COMBINATIONS
+            if o.incompatible
+        ],
     )
     def test_212_incompatible_options(
-        self, options: list[str], service: bool | None,
+        self,
+        options: list[str],
+        service: bool | None,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase,
-                               [*options, DUMMY_SERVICE] if service
-                               else options,
-                               input=DUMMY_PASSPHRASE, catch_exceptions=False)
-        assert result.exit_code > 0, (
-            'program unexpectedly succeeded'
-        )
-        assert result.stderr_bytes, (
-            'program did not print any error message'
-        )
-        assert b'mutually exclusive with ' in result.stderr_bytes, (
-            'program did not print the expected error message'
+        result = runner.invoke(
+            cli.derivepassphrase,
+            [*options, DUMMY_SERVICE] if service else options,
+            input=DUMMY_PASSPHRASE,
+            catch_exceptions=False,
         )
+        assert result.exit_code > 0, 'program unexpectedly succeeded'
+        assert result.stderr_bytes, 'program did not print any error message'
+        assert (
+            b'mutually exclusive with ' in result.stderr_bytes
+        ), 'program did not print the expected error message'
 
     def test_213_import_bad_config_not_vault_config(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
-            result = runner.invoke(cli.derivepassphrase, ['--import', '-'],
-                                   input=b'null', catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'not a valid config' in result.stderr_bytes, (
-                'program did not print the expected error message'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
+            result = runner.invoke(
+                cli.derivepassphrase,
+                ['--import', '-'],
+                input=b'null',
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'not a valid config' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     def test_213a_import_bad_config_not_json_data(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
-            result = runner.invoke(cli.derivepassphrase, ['--import', '-'],
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
+            result = runner.invoke(
+                cli.derivepassphrase,
+                ['--import', '-'],
                 input=b'This string is not valid JSON.',
-                                   catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'cannot decode JSON' in result.stderr_bytes, (
-                'program did not print the expected error message'
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'cannot decode JSON' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     def test_213b_import_bad_config_not_a_file(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
         # `isolated_config` validates the configuration.  So, to pass an
         # actual broken configuration, we must open the configuration file
         # ourselves afterwards, inside the context.
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
-            with open(cli._config_filename(), 'w',
-                      encoding='UTF-8') as outfile:
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
+            with open(
+                cli._config_filename(), 'w', encoding='UTF-8'
+            ) as outfile:
                 print('This string is not valid JSON.', file=outfile)
             dname = os.path.dirname(cli._config_filename())
             result = runner.invoke(
                 cli.derivepassphrase,
                 ['--import', os.fsdecode(dname)],
-                catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
             # Don't test the actual error message, because it is subject to
             # locale settings.  TODO: find a way anyway.
 
     def test_214_export_settings_no_stored_settings(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
             with contextlib.suppress(FileNotFoundError):
                 os.remove(cli._config_filename())
-            result = runner.invoke(cli.derivepassphrase, ['--export', '-'],
-                                   catch_exceptions=False)
-            assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                'program exited with failure'
+            result = runner.invoke(
+                cli.derivepassphrase, ['--export', '-'], catch_exceptions=False
             )
+            assert (result.exit_code, result.stderr_bytes) == (
+                0,
+                b'',
+            ), 'program exited with failure'
 
     def test_214a_export_settings_bad_stored_config(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={}):
-            result = runner.invoke(cli.derivepassphrase, ['--export', '-'],
-                                   input=b'null', catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'cannot load config' in result.stderr_bytes, (
-                'program did not print the expected error message'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={}
+        ):
+            result = runner.invoke(
+                cli.derivepassphrase,
+                ['--export', '-'],
+                input=b'null',
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'cannot load config' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     def test_214b_export_settings_not_a_file(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
             with contextlib.suppress(FileNotFoundError):
                 os.remove(cli._config_filename())
             os.makedirs(cli._config_filename())
-            result = runner.invoke(cli.derivepassphrase, ['--export', '-'],
-                                   input=b'null', catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'cannot load config' in result.stderr_bytes, (
-                'program did not print the expected error message'
+            result = runner.invoke(
+                cli.derivepassphrase,
+                ['--export', '-'],
+                input=b'null',
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'cannot load config' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     def test_214c_export_settings_target_not_a_file(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'services': {}}):
+        with tests.isolated_config(
+            monkeypatch=monkeypatch, runner=runner, config={'services': {}}
+        ):
             dname = os.path.dirname(cli._config_filename())
-            result = runner.invoke(cli.derivepassphrase,
+            result = runner.invoke(
+                cli.derivepassphrase,
                 ['--export', os.fsdecode(dname)],
-                                   input=b'null', catch_exceptions=False)
-            assert result.exit_code > 0, (
-                'program unexpectedly succeeded'
-            )
-            assert result.stderr_bytes, (
-                'program did not print any error message'
-            )
-            assert b'cannot write config' in result.stderr_bytes, (
-                'program did not print the expected error message'
+                input=b'null',
+                catch_exceptions=False,
             )
+            assert result.exit_code > 0, 'program unexpectedly succeeded'
+            assert (
+                result.stderr_bytes
+            ), 'program did not print any error message'
+            assert (
+                b'cannot write config' in result.stderr_bytes
+            ), 'program did not print the expected error message'
 
     def test_220_edit_notes_successfully(self, monkeypatch: Any) -> None:
-        edit_result = '''
+        edit_result = """
 
 # - - - - - >8 - - - - - >8 - - - - - >8 - - - - - >8 - - - - -
 contents go here
-'''
+"""
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(click, 'edit',
-                                lambda *a, **kw: edit_result)  # noqa: ARG005
-            result = runner.invoke(cli.derivepassphrase, ['--notes', 'sv'],
-                                   catch_exceptions=False)
-            assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                'program exited with failure'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(click, 'edit', lambda *a, **kw: edit_result)  # noqa: ARG005
+            result = runner.invoke(
+                cli.derivepassphrase, ['--notes', 'sv'], catch_exceptions=False
             )
+            assert (result.exit_code, result.stderr_bytes) == (
+                0,
+                b'',
+            ), 'program exited with failure'
             with open(cli._config_filename(), encoding='UTF-8') as infile:
                 config = json.load(infile)
-            assert config == {'global': {'phrase': 'abc'},
-                              'services': {'sv': {'notes':
-                                                      'contents go here'}}}
+            assert config == {
+                'global': {'phrase': 'abc'},
+                'services': {'sv': {'notes': 'contents go here'}},
+            }
 
     def test_221_edit_notes_noop(self, monkeypatch: Any) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(click, 'edit',
-                                lambda *a, **kw: None)  # noqa: ARG005
-            result = runner.invoke(cli.derivepassphrase, ['--notes', 'sv'],
-                                   catch_exceptions=False)
-            assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                'program exited with failure'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(click, 'edit', lambda *a, **kw: None)  # noqa: ARG005
+            result = runner.invoke(
+                cli.derivepassphrase, ['--notes', 'sv'], catch_exceptions=False
             )
+            assert (result.exit_code, result.stderr_bytes) == (
+                0,
+                b'',
+            ), 'program exited with failure'
             with open(cli._config_filename(), encoding='UTF-8') as infile:
                 config = json.load(infile)
             assert config == {'global': {'phrase': 'abc'}, 'services': {}}
 
     def test_222_edit_notes_marker_removed(self, monkeypatch: Any) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(click, 'edit',
-                                lambda *a, **kw: 'long\ntext')  # noqa: ARG005
-            result = runner.invoke(cli.derivepassphrase, ['--notes', 'sv'],
-                                   catch_exceptions=False)
-            assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                'program exited with failure'
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(click, 'edit', lambda *a, **kw: 'long\ntext')  # noqa: ARG005
+            result = runner.invoke(
+                cli.derivepassphrase, ['--notes', 'sv'], catch_exceptions=False
             )
+            assert (result.exit_code, result.stderr_bytes) == (
+                0,
+                b'',
+            ), 'program exited with failure'
             with open(cli._config_filename(), encoding='UTF-8') as infile:
                 config = json.load(infile)
-            assert config == {'global': {'phrase': 'abc'},
-                              'services': {'sv': {'notes': 'long\ntext'}}}
+            assert config == {
+                'global': {'phrase': 'abc'},
+                'services': {'sv': {'notes': 'long\ntext'}},
+            }
 
     def test_223_edit_notes_abort(self, monkeypatch: Any) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(click, 'edit',
-                                lambda *a, **kw: '\n\n')  # noqa: ARG005
-            result = runner.invoke(cli.derivepassphrase, ['--notes', 'sv'],
-                                   catch_exceptions=False)
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(click, 'edit', lambda *a, **kw: '\n\n')  # noqa: ARG005
+            result = runner.invoke(
+                cli.derivepassphrase, ['--notes', 'sv'], catch_exceptions=False
+            )
             assert result.exit_code != 0, 'program unexpectedly succeeded'
             assert result.stderr_bytes is not None
-            assert b'user aborted request' in result.stderr_bytes, (
-                'expected error message missing'
-            )
+            assert (
+                b'user aborted request' in result.stderr_bytes
+            ), 'expected error message missing'
             with open(cli._config_filename(), encoding='UTF-8') as infile:
                 config = json.load(infile)
             assert config == {'global': {'phrase': 'abc'}, 'services': {}}
 
-    @pytest.mark.parametrize(['command_line', 'input', 'result_config'], [
+    @pytest.mark.parametrize(
+        ['command_line', 'input', 'result_config'],
+        [
             (
                 ['--phrase'],
                 b'my passphrase\n',
@@ -613,44 +763,66 @@ contents go here
             (
                 ['--phrase', 'sv'],
                 b'my passphrase\n',
-            {'global': {'phrase': 'abc'},
-             'services': {'sv': {'phrase': 'my passphrase'}}},
+                {
+                    'global': {'phrase': 'abc'},
+                    'services': {'sv': {'phrase': 'my passphrase'}},
+                },
             ),
             (
                 ['--key', 'sv'],
                 b'1\n',
-            {'global': {'phrase': 'abc'},
-             'services': {'sv': {'key': DUMMY_KEY1_B64}}},
+                {
+                    'global': {'phrase': 'abc'},
+                    'services': {'sv': {'key': DUMMY_KEY1_B64}},
+                },
             ),
             (
                 ['--key', '--length', '15', 'sv'],
                 b'1\n',
-            {'global': {'phrase': 'abc'},
-             'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}}},
+                {
+                    'global': {'phrase': 'abc'},
+                    'services': {'sv': {'key': DUMMY_KEY1_B64, 'length': 15}},
+                },
             ),
-    ])
+        ],
+    )
     def test_224_store_config_good(
-        self, monkeypatch: Any, command_line: list[str], input: bytes,
+        self,
+        monkeypatch: Any,
+        command_line: list[str],
+        input: bytes,
         result_config: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(cli, '_get_suitable_ssh_keys',
-                                tests.suitable_ssh_keys)
-            result = runner.invoke(cli.derivepassphrase,
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(
+                cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
+            )
+            result = runner.invoke(
+                cli.derivepassphrase,
                 ['--config', *command_line],
-                                   catch_exceptions=False, input=input)
+                catch_exceptions=False,
+                input=input,
+            )
             assert result.exit_code == 0, 'program exited with failure'
             with open(cli._config_filename(), encoding='UTF-8') as infile:
                 config = json.load(infile)
-            assert config == result_config, (
-                'stored config does not match expectation'
-            )
+            assert (
+                config == result_config
+            ), 'stored config does not match expectation'
 
-    @pytest.mark.parametrize(['command_line', 'input', 'err_text'], [
-        ([], b'', b'cannot update global settings without actual settings'),
+    @pytest.mark.parametrize(
+        ['command_line', 'input', 'err_text'],
+        [
+            (
+                [],
+                b'',
+                b'cannot update global settings without actual settings',
+            ),
             (
                 ['sv'],
                 b'',
@@ -658,65 +830,84 @@ contents go here
             ),
             (['--phrase', 'sv'], b'', b'no passphrase given'),
             (['--key'], b'', b'no valid SSH key selected'),
-    ])
+        ],
+    )
     def test_225_store_config_fail(
-        self, monkeypatch: Any, command_line: list[str],
-        input: bytes, err_text: bytes,
+        self,
+        monkeypatch: Any,
+        command_line: list[str],
+        input: bytes,
+        err_text: bytes,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
-            monkeypatch.setattr(cli, '_get_suitable_ssh_keys',
-                                tests.suitable_ssh_keys)
-            result = runner.invoke(cli.derivepassphrase,
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
+            monkeypatch.setattr(
+                cli, '_get_suitable_ssh_keys', tests.suitable_ssh_keys
+            )
+            result = runner.invoke(
+                cli.derivepassphrase,
                 ['--config', *command_line],
-                                   catch_exceptions=False, input=input)
+                catch_exceptions=False,
+                input=input,
+            )
             assert result.exit_code != 0, 'program unexpectedly succeeded?!'
             assert result.stderr_bytes is not None
-            assert err_text in result.stderr_bytes, (
-                'expected error message missing'
-            )
+            assert (
+                err_text in result.stderr_bytes
+            ), 'expected error message missing'
 
     def test_225a_store_config_fail_manual_no_ssh_key_selection(
-        self, monkeypatch: Any,
+        self,
+        monkeypatch: Any,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        with tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                   config={'global': {'phrase': 'abc'},
-                                           'services': {}}):
+        with tests.isolated_config(
+            monkeypatch=monkeypatch,
+            runner=runner,
+            config={'global': {'phrase': 'abc'}, 'services': {}},
+        ):
             custom_error = 'custom error message'
+
             def raiser():
                 raise RuntimeError(custom_error)
+
             monkeypatch.setattr(cli, '_select_ssh_key', raiser)
-            result = runner.invoke(cli.derivepassphrase,
+            result = runner.invoke(
+                cli.derivepassphrase,
                 ['--key', '--config'],
-                                   catch_exceptions=False)
+                catch_exceptions=False,
+            )
             assert result.exit_code != 0, 'program unexpectedly succeeded'
             assert result.stderr_bytes is not None
-            assert custom_error.encode() in result.stderr_bytes, (
-                'expected error message missing'
-            )
+            assert (
+                custom_error.encode() in result.stderr_bytes
+            ), 'expected error message missing'
 
     def test_226_no_arguments(self) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase, [],
-                               catch_exceptions=False)
+        result = runner.invoke(
+            cli.derivepassphrase, [], catch_exceptions=False
+        )
         assert result.exit_code != 0, 'program unexpectedly succeeded'
         assert result.stderr_bytes is not None
-        assert b'SERVICE is required' in result.stderr_bytes, (
-            'expected error message missing'
-        )
+        assert (
+            b'SERVICE is required' in result.stderr_bytes
+        ), 'expected error message missing'
 
     def test_226a_no_passphrase_or_key(self) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
-        result = runner.invoke(cli.derivepassphrase, [DUMMY_SERVICE],
-                               catch_exceptions=False)
+        result = runner.invoke(
+            cli.derivepassphrase, [DUMMY_SERVICE], catch_exceptions=False
+        )
         assert result.exit_code != 0, 'program unexpectedly succeeded'
         assert result.stderr_bytes is not None
-        assert b'no passphrase or key given' in result.stderr_bytes, (
-            'expected error message missing'
-        )
+        assert (
+            b'no passphrase or key given' in result.stderr_bytes
+        ), 'expected error message missing'
 
 
 class TestCLIUtils:
@@ -724,9 +914,10 @@ class TestCLIUtils:
     def test_100_save_bad_config(self, monkeypatch: Any) -> None:
         runner = click.testing.CliRunner()
         with (
-            tests.isolated_config(monkeypatch=monkeypatch, runner=runner,
-                                  config={}),
-            pytest.raises(ValueError, match='Invalid vault config')
+            tests.isolated_config(
+                monkeypatch=monkeypatch, runner=runner, config={}
+            ),
+            pytest.raises(ValueError, match='Invalid vault config'),
         ):
             cli._save_config(None)  # type: ignore
 
@@ -746,11 +936,15 @@ class TestCLIUtils:
                 'Spam, bacon, sausage and spam',
                 'Spam, egg, spam, spam, bacon and spam',
                 'Spam, spam, spam, egg and spam',
-                ('Spam, spam, spam, spam, spam, spam, baked beans, '
-                 'spam, spam, spam and spam'),
-                ('Lobster thermidor aux crevettes with a mornay sauce '
+                (
+                    'Spam, spam, spam, spam, spam, spam, baked beans, '
+                    'spam, spam, spam and spam'
+                ),
+                (
+                    'Lobster thermidor aux crevettes with a mornay sauce '
                     'garnished with truffle paté, brandy '
-                 'and a fried egg on top and spam'),
+                    'and a fried egg on top and spam'
+                ),
             ]
             index = cli._prompt_for_selection(items, heading=heading)
             click.echo('A fine choice: ', nl=False)
@@ -759,7 +954,9 @@ class TestCLIUtils:
         runner = click.testing.CliRunner(mix_stderr=True)
         result = runner.invoke(driver, [], input='9')
         assert result.exit_code == 0, 'driver program failed'
-        assert result.stdout == '''\
+        assert (
+            result.stdout
+            == """\
 Our menu:
 [1] Egg and bacon
 [2] Egg, sausage and bacon
@@ -774,11 +971,15 @@ Our menu:
 Your selection? (1-10, leave empty to abort): 9
 A fine choice: Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam and spam
 (Note: Vikings strictly optional.)
-''', 'driver program produced unexpected output'  # noqa: E501
-        result = runner.invoke(driver, ['--heading='], input='',
-                               catch_exceptions=True)
+"""  # noqa: E501
+        ), 'driver program produced unexpected output'
+        result = runner.invoke(
+            driver, ['--heading='], input='', catch_exceptions=True
+        )
         assert result.exit_code > 0, 'driver program succeeded?!'
-        assert result.stdout == '''\
+        assert (
+            result.stdout
+            == """\
 [1] Egg and bacon
 [2] Egg, sausage and bacon
 [3] Egg and spam
@@ -789,13 +990,12 @@ A fine choice: Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam
 [8] Spam, spam, spam, egg and spam
 [9] Spam, spam, spam, spam, spam, spam, baked beans, spam, spam, spam and spam
 [10] Lobster thermidor aux crevettes with a mornay sauce garnished with truffle paté, brandy and a fried egg on top and spam
-Your selection? (1-10, leave empty to abort): \n''', (  # noqa: E501
-            'driver program produced unexpected output'
-        )
-        assert isinstance(result.exception, IndexError), (
-            'driver program did not raise IndexError?!'
-        )
-
+Your selection? (1-10, leave empty to abort):\x20
+"""  # noqa: E501
+        ), 'driver program produced unexpected output'
+        assert isinstance(
+            result.exception, IndexError
+        ), 'driver program did not raise IndexError?!'
 
     def test_102_prompt_for_selection_single(self) -> None:
         @click.command()
@@ -803,42 +1003,52 @@ Your selection? (1-10, leave empty to abort): \n''', (  # noqa: E501
         @click.argument('prompt')
         def driver(item, prompt):
             try:
-                cli._prompt_for_selection([item], heading='',
-                                          single_choice_prompt=prompt)
+                cli._prompt_for_selection(
+                    [item], heading='', single_choice_prompt=prompt
+                )
             except IndexError:
                 click.echo('Boo.')
                 raise
             else:
                 click.echo('Great!')
+
         runner = click.testing.CliRunner(mix_stderr=True)
-        result = runner.invoke(driver,
-                               ['Will replace with spam. Confirm, y/n?'],
-                               input='y')
+        result = runner.invoke(
+            driver, ['Will replace with spam. Confirm, y/n?'], input='y'
+        )
         assert result.exit_code == 0, 'driver program failed'
-        assert result.stdout == '''\
+        assert (
+            result.stdout
+            == """\
 [1] baked beans
 Will replace with spam. Confirm, y/n? y
 Great!
-''', 'driver program produced unexpected output'
-        result = runner.invoke(driver,
-                               ['Will replace with spam, okay? '
-                                '(Please say "y" or "n".)'],
-                               input='')
+"""
+        ), 'driver program produced unexpected output'
+        result = runner.invoke(
+            driver,
+            ['Will replace with spam, okay? ' '(Please say "y" or "n".)'],
+            input='',
+        )
         assert result.exit_code > 0, 'driver program succeeded?!'
-        assert result.stdout == '''\
+        assert (
+            result.stdout
+            == """\
 [1] baked beans
 Will replace with spam, okay? (Please say "y" or "n".):\x20
 Boo.
-''', 'driver program produced unexpected output'
-        assert isinstance(result.exception, IndexError), (
-            'driver program did not raise IndexError?!'
-        )
-
+"""
+        ), 'driver program produced unexpected output'
+        assert isinstance(
+            result.exception, IndexError
+        ), 'driver program did not raise IndexError?!'
 
     def test_103_prompt_for_passphrase(self, monkeypatch: Any) -> None:
-        monkeypatch.setattr(click, 'prompt',
-                            lambda *a, **kw:
-                                json.dumps({'args': a, 'kwargs': kw}))
+        monkeypatch.setattr(
+            click,
+            'prompt',
+            lambda *a, **kw: json.dumps({'args': a, 'kwargs': kw}),
+        )
         res = json.loads(cli._prompt_for_passphrase())
         err_msg = 'missing arguments to passphrase prompt'
         assert 'args' in res, err_msg
@@ -849,48 +1059,70 @@ Boo.
         assert res['kwargs'].get('err'), err_msg
         assert res['kwargs'].get('hide_input'), err_msg
 
-
-    @pytest.mark.parametrize(['command_line', 'config', 'result_config'], [
-        (['--delete-globals'],
-         {'global': {'phrase': 'abc'}, 'services': {}}, {'services': {}}),
-        (['--delete', DUMMY_SERVICE],
-         {'global': {'phrase': 'abc'},
-          'services': {DUMMY_SERVICE: {'notes': '...'}}},
-         {'global': {'phrase': 'abc'}, 'services': {}}),
-        (['--clear'],
-         {'global': {'phrase': 'abc'},
-          'services': {DUMMY_SERVICE: {'notes': '...'}}},
-         {'services': {}}),
-    ])
+    @pytest.mark.parametrize(
+        ['command_line', 'config', 'result_config'],
+        [
+            (
+                ['--delete-globals'],
+                {'global': {'phrase': 'abc'}, 'services': {}},
+                {'services': {}},
+            ),
+            (
+                ['--delete', DUMMY_SERVICE],
+                {
+                    'global': {'phrase': 'abc'},
+                    'services': {DUMMY_SERVICE: {'notes': '...'}},
+                },
+                {'global': {'phrase': 'abc'}, 'services': {}},
+            ),
+            (
+                ['--clear'],
+                {
+                    'global': {'phrase': 'abc'},
+                    'services': {DUMMY_SERVICE: {'notes': '...'}},
+                },
+                {'services': {}},
+            ),
+        ],
+    )
     def test_203_repeated_config_deletion(
-        self, monkeypatch: Any, command_line: list[str],
-        config: dpp.types.VaultConfig, result_config: dpp.types.VaultConfig,
+        self,
+        monkeypatch: Any,
+        command_line: list[str],
+        config: dpp.types.VaultConfig,
+        result_config: dpp.types.VaultConfig,
     ) -> None:
         runner = click.testing.CliRunner(mix_stderr=False)
         for start_config in [config, result_config]:
-            with tests.isolated_config(monkeypatch=monkeypatch,
-                                       runner=runner, config=start_config):
-                result = runner.invoke(cli.derivepassphrase, command_line,
-                                       catch_exceptions=False)
-                assert (result.exit_code, result.stderr_bytes) == (0, b''), (
-                    'program exited with failure'
+            with tests.isolated_config(
+                monkeypatch=monkeypatch, runner=runner, config=start_config
+            ):
+                result = runner.invoke(
+                    cli.derivepassphrase, command_line, catch_exceptions=False
                 )
+                assert (result.exit_code, result.stderr_bytes) == (
+                    0,
+                    b'',
+                ), 'program exited with failure'
                 with open(cli._config_filename(), encoding='UTF-8') as infile:
                     config_readback = json.load(infile)
                 assert config_readback == result_config
 
-
     def test_204_phrase_from_key_manually(self) -> None:
         assert (
-            dpp.Vault(phrase=DUMMY_PHRASE_FROM_KEY1, **DUMMY_CONFIG_SETTINGS)
-            .generate(DUMMY_SERVICE) == DUMMY_RESULT_KEY1
+            dpp.Vault(
+                phrase=DUMMY_PHRASE_FROM_KEY1, **DUMMY_CONFIG_SETTINGS
+            ).generate(DUMMY_SERVICE)
+            == DUMMY_RESULT_KEY1
         )
 
-
-    @pytest.mark.parametrize(['vfunc', 'input'], [
+    @pytest.mark.parametrize(
+        ['vfunc', 'input'],
+        [
             (cli._validate_occurrence_constraint, 20),
             (cli._validate_length, 20),
-    ])
+        ],
+    )
     def test_210a_validate_constraints_manually(
         self,
         vfunc: Callable[[click.Context, click.Parameter, Any], int | None],
@@ -904,10 +1135,13 @@ Boo.
     @tests.skip_if_no_agent
     @pytest.mark.parametrize('conn_hint', ['none', 'socket', 'client'])
     def test_227_get_suitable_ssh_keys(
-        self, monkeypatch: Any, conn_hint: str,
+        self,
+        monkeypatch: Any,
+        conn_hint: str,
     ) -> None:
-        monkeypatch.setattr(ssh_agent_client.SSHAgentClient,
-                            'list_keys', tests.list_keys)
+        monkeypatch.setattr(
+            ssh_agent_client.SSHAgentClient, 'list_keys', tests.list_keys
+        )
         hint: ssh_agent_client.SSHAgentClient | socket.socket | None
         match conn_hint:
             case 'client':

tests/test_derivepassphrase_typing.py

Zeige Datei @ 99863c4

@@ -10,47 +10,88 @@ from typing_extensions import Any
 import derivepassphrase.types
 
 
-@pytest.mark.parametrize(['obj', 'comment'], [
+@pytest.mark.parametrize(
+    ['obj', 'comment'],
+    [
         (None, 'not a dict'),
         ({}, 'missing required keys'),
         ({'global': None, 'services': {}}, 'bad config value: global'),
-    ({'global': {'key': 123}, 'services': {}},
-     'bad config value: global.key'),
-    ({'global': {'phrase': 'abc', 'key': '...'}, 'services': {}},
-     'incompatible config values: global.key and global.phrase'),
+        (
+            {'global': {'key': 123}, 'services': {}},
+            'bad config value: global.key',
+        ),
+        (
+            {'global': {'phrase': 'abc', 'key': '...'}, 'services': {}},
+            'incompatible config values: global.key and global.phrase',
+        ),
         ({'services': None}, 'bad config value: services'),
         ({'services': {2: {}}}, 'bad config value: services."2"'),
         ({'services': {'2': 2}}, 'bad config value: services."2"'),
-    ({'services': {'sv': {'notes': False}}},
-     'bad config value: services.sv.notes'),
+        (
+            {'services': {'sv': {'notes': False}}},
+            'bad config value: services.sv.notes',
+        ),
         ({'services': {'sv': {'notes': 'blah blah blah'}}}, ''),
-    ({'services': {'sv': {'length': '200'}}},
-     'bad config value: services.sv.length'),
-    ({'services': {'sv': {'length': 0.5}}},
-     'bad config value: services.sv.length'),
-    ({'services': {'sv': {'length': -10}}},
-     'bad config value: services.sv.length'),
-    ({'services': {'sv': {'upper': -10}}},
-     'bad config value: services.sv.upper'),
-    ({'global': {'phrase': 'my secret phrase'},
-      'services': {'sv': {'length': 10}}},
-     ''),
+        (
+            {'services': {'sv': {'length': '200'}}},
+            'bad config value: services.sv.length',
+        ),
+        (
+            {'services': {'sv': {'length': 0.5}}},
+            'bad config value: services.sv.length',
+        ),
+        (
+            {'services': {'sv': {'length': -10}}},
+            'bad config value: services.sv.length',
+        ),
+        (
+            {'services': {'sv': {'upper': -10}}},
+            'bad config value: services.sv.upper',
+        ),
+        (
+            {
+                'global': {'phrase': 'my secret phrase'},
+                'services': {'sv': {'length': 10}},
+            },
+            '',
+        ),
         ({'services': {'sv': {'length': 10, 'phrase': '...'}}}, ''),
         ({'services': {'sv': {'length': 10, 'key': '...'}}}, ''),
         ({'services': {'sv': {'upper': 10, 'key': '...'}}}, ''),
-    ({'services': {'sv': {'phrase': 'abc', 'key': '...'}}},
-     'incompatible config values: services.sv.key and services.sv.phrase'),
-    ({'global': {'phrase': 'abc'},
-      'services': {'sv': {'phrase': 'abc', 'length': 10}}}, ''),
-    ({'global': {'key': '...'},
-      'services': {'sv': {'phrase': 'abc', 'length': 10}}}, ''),
-    ({'global': {'key': '...'},
-      'services': {'sv1': {'phrase': 'abc', 'length': 10, 'upper': 1},
-                   'sv2': {'length': 10, 'repeat': 1, 'lower': 1}}}, ''),
-])
+        (
+            {'services': {'sv': {'phrase': 'abc', 'key': '...'}}},
+            'incompatible config values: services.sv.key and services.sv.phrase',  # noqa: E501
+        ),
+        (
+            {
+                'global': {'phrase': 'abc'},
+                'services': {'sv': {'phrase': 'abc', 'length': 10}},
+            },
+            '',
+        ),
+        (
+            {
+                'global': {'key': '...'},
+                'services': {'sv': {'phrase': 'abc', 'length': 10}},
+            },
+            '',
+        ),
+        (
+            {
+                'global': {'key': '...'},
+                'services': {
+                    'sv1': {'phrase': 'abc', 'length': 10, 'upper': 1},
+                    'sv2': {'length': 10, 'repeat': 1, 'lower': 1},
+                },
+            },
+            '',
+        ),
+    ],
+)
 def test_200_is_vault_config(obj: Any, comment: str) -> None:
     is_vault_config = derivepassphrase.types.is_vault_config
     assert is_vault_config(obj) == (not comment), (
-        'failed to complain about: ' + comment if comment
+        'failed to complain about: ' + comment
+        if comment
         else 'failed on valid example'
     )

tests/test_sequin.py

Zeige Datei @ 99863c4

@@ -12,53 +12,107 @@ import sequin
 
 
 class TestStaticFunctionality:
-
-    @pytest.mark.parametrize(['sequence', 'base', 'expected'], [
+    @pytest.mark.parametrize(
+        ['sequence', 'base', 'expected'],
+        [
             ([1, 2, 3, 4, 5, 6], 10, 123456),
             ([1, 2, 3, 4, 5, 6], 100, 10203040506),
             ([0, 0, 1, 4, 9, 7], 10, 1497),
             ([1, 0, 0, 1, 0, 0, 0, 0], 2, 144),
             ([1, 7, 5, 5], 8, 0o1755),
-    ])
+        ],
+    )
     def test_200_big_endian_number(self, sequence, base, expected):
         assert (
             sequin.Sequin._big_endian_number(sequence, base=base)
         ) == expected
 
     @pytest.mark.parametrize(
-        ['exc_type', 'exc_pattern', 'sequence', 'base'], [
+        ['exc_type', 'exc_pattern', 'sequence', 'base'],
+        [
             (ValueError, 'invalid base 3 digit:', [-1], 3),
             (ValueError, 'invalid base:', [0], 1),
             (TypeError, 'not an integer:', [0.0, 1.0, 0.0, 1.0], 2),
-        ]
+        ],
     )
-    def test_300_big_endian_number_exceptions(self, exc_type, exc_pattern,
-                                              sequence, base):
+    def test_300_big_endian_number_exceptions(
+        self, exc_type, exc_pattern, sequence, base
+    ):
         with pytest.raises(exc_type, match=exc_pattern):
             sequin.Sequin._big_endian_number(sequence, base=base)
 
-class TestSequin:
 
-    @pytest.mark.parametrize(['sequence', 'is_bitstring', 'expected'], [
-        ([1, 0, 0, 1, 0, 1], False, [0, 0, 0, 0, 0, 0, 0, 1,
-                                     0, 0, 0, 0, 0, 0, 0, 0,
-                                     0, 0, 0, 0, 0, 0, 0, 0,
-                                     0, 0, 0, 0, 0, 0, 0, 1,
-                                     0, 0, 0, 0, 0, 0, 0, 0,
-                                     0, 0, 0, 0, 0, 0, 0, 1]),
+class TestSequin:
+    @pytest.mark.parametrize(
+        ['sequence', 'is_bitstring', 'expected'],
+        [
+            (
+                [1, 0, 0, 1, 0, 1],
+                False,
+                [
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    1,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    1,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    0,
+                    1,
+                ],
+            ),
             ([1, 0, 0, 1, 0, 1], True, [1, 0, 0, 1, 0, 1]),
-        (b'OK', False, [0, 1, 0, 0, 1, 1, 1, 1,
-                        0, 1, 0, 0, 1, 0, 1, 1]),
-        ('OK', False, [0, 1, 0, 0, 1, 1, 1, 1,
-                       0, 1, 0, 0, 1, 0, 1, 1]),
-    ])
+            (b'OK', False, [0, 1, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1, 0, 1, 1]),
+            ('OK', False, [0, 1, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1, 0, 1, 1]),
+        ],
+    )
     def test_200_constructor(self, sequence, is_bitstring, expected):
         seq = sequin.Sequin(sequence, is_bitstring=is_bitstring)
         assert seq.bases == {2: collections.deque(expected)}
 
     def test_201_generating(self):
-        seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-                            is_bitstring=True)
+        seq = sequin.Sequin(
+            [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
+        )
         assert seq.generate(1) == 0
         assert seq.generate(5) == 3
         assert seq.generate(5) == 3
@@ -67,21 +121,24 @@ class TestSequin:
             seq.generate(5)
         with pytest.raises(sequin.SequinExhaustedError):
             seq.generate(1)
-        seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-                            is_bitstring=True)
+        seq = sequin.Sequin(
+            [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
+        )
         with pytest.raises(ValueError, match='invalid target range'):
             seq.generate(0)
 
     def test_210_internal_generating(self):
-        seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-                            is_bitstring=True)
+        seq = sequin.Sequin(
+            [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
+        )
         assert seq._generate_inner(5) == 3
         assert seq._generate_inner(5) == 3
         assert seq._generate_inner(5) == 1
         assert seq._generate_inner(5) == 5
         assert seq._generate_inner(1) == 0
-        seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
-                            is_bitstring=True)
+        seq = sequin.Sequin(
+            [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
+        )
         assert seq._generate_inner(1) == 0
         with pytest.raises(ValueError, match='invalid target range'):
             seq._generate_inner(0)
@@ -90,8 +147,9 @@ class TestSequin:
 
     def test_211_shifting(self):
         seq = sequin.Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1], is_bitstring=True)
-        assert seq.bases == {2: collections.deque([
-            1, 0, 1, 0, 0, 1, 0, 0, 0, 1])}
+        assert seq.bases == {
+            2: collections.deque([1, 0, 1, 0, 0, 1, 0, 0, 0, 1])
+        }
 
         assert seq._all_or_nothing_shift(3) == (1, 0, 1)
         assert seq._all_or_nothing_shift(3) == (0, 0, 1)
@@ -106,13 +164,17 @@ class TestSequin:
     @pytest.mark.parametrize(
         ['sequence', 'is_bitstring', 'exc_type', 'exc_pattern'],
         [
-            ([0, 1, 2, 3, 4, 5, 6, 7], True,
-             ValueError, 'sequence item out of range'),
-            ('こんにちは。', False,
-             ValueError, 'sequence item out of range'),
-        ]
+            (
+                [0, 1, 2, 3, 4, 5, 6, 7],
+                True,
+                ValueError,
+                'sequence item out of range',
+            ),
+            ('こんにちは。', False, ValueError, 'sequence item out of range'),
+        ],
     )
-    def test_300_constructor_exceptions(self, sequence, is_bitstring,
-                                        exc_type, exc_pattern):
+    def test_300_constructor_exceptions(
+        self, sequence, is_bitstring, exc_type, exc_pattern
+    ):
         with pytest.raises(exc_type, match=exc_pattern):
             sequin.Sequin(sequence, is_bitstring=is_bitstring)

tests/test_ssh_agent_client.py

Zeige Datei @ 99863c4

@@ -24,10 +24,13 @@ import tests
 
 
 class TestStaticFunctionality:
-
-    @pytest.mark.parametrize(['public_key', 'public_key_data'],
-                             [(val['public_key'], val['public_key_data'])
-                              for val in tests.SUPPORTED_KEYS.values()])
+    @pytest.mark.parametrize(
+        ['public_key', 'public_key_data'],
+        [
+            (val['public_key'], val['public_key_data'])
+            for val in tests.SUPPORTED_KEYS.values()
+        ],
+    )
     def test_100_key_decoding(self, public_key, public_key_data):
         keydata = base64.b64decode(public_key.split(None, 2)[1])
         assert (
@@ -37,77 +40,101 @@ class TestStaticFunctionality:
     def test_200_constructor_no_running_agent(self, monkeypatch):
         monkeypatch.delenv('SSH_AUTH_SOCK', raising=False)
         sock = socket.socket(family=socket.AF_UNIX)
-        with pytest.raises(KeyError,
-                           match='SSH_AUTH_SOCK environment variable'):
+        with pytest.raises(
+            KeyError, match='SSH_AUTH_SOCK environment variable'
+        ):
             ssh_agent_client.SSHAgentClient(socket=sock)
 
-    @pytest.mark.parametrize(['input', 'expected'], [
+    @pytest.mark.parametrize(
+        ['input', 'expected'],
+        [
             (16777216, b'\x01\x00\x00\x00'),
-    ])
+        ],
+    )
     def test_210_uint32(self, input, expected):
         uint32 = ssh_agent_client.SSHAgentClient.uint32
         assert uint32(input) == expected
 
-    @pytest.mark.parametrize(['input', 'expected'], [
+    @pytest.mark.parametrize(
+        ['input', 'expected'],
+        [
             (b'ssh-rsa', b'\x00\x00\x00\x07ssh-rsa'),
             (b'ssh-ed25519', b'\x00\x00\x00\x0bssh-ed25519'),
             (
                 ssh_agent_client.SSHAgentClient.string(b'ssh-ed25519'),
                 b'\x00\x00\x00\x0f\x00\x00\x00\x0bssh-ed25519',
             ),
-    ])
+        ],
+    )
     def test_211_string(self, input, expected):
         string = ssh_agent_client.SSHAgentClient.string
         assert bytes(string(input)) == expected
 
-    @pytest.mark.parametrize(['input', 'expected'], [
+    @pytest.mark.parametrize(
+        ['input', 'expected'],
+        [
             (b'\x00\x00\x00\x07ssh-rsa', b'ssh-rsa'),
             (
                 ssh_agent_client.SSHAgentClient.string(b'ssh-ed25519'),
                 b'ssh-ed25519',
             ),
-    ])
+        ],
+    )
     def test_212_unstring(self, input, expected):
         unstring = ssh_agent_client.SSHAgentClient.unstring
         unstring_prefix = ssh_agent_client.SSHAgentClient.unstring_prefix
         assert bytes(unstring(input)) == expected
-        assert tuple(
-            bytes(x) for x in unstring_prefix(input)
-        ) == (expected, b'')
+        assert tuple(bytes(x) for x in unstring_prefix(input)) == (
+            expected,
+            b'',
+        )
 
-    @pytest.mark.parametrize(['value', 'exc_type', 'exc_pattern'], [
+    @pytest.mark.parametrize(
+        ['value', 'exc_type', 'exc_pattern'],
+        [
             (10000000000000000, OverflowError, 'int too big to convert'),
             (-1, OverflowError, "can't convert negative int to unsigned"),
-    ])
+        ],
+    )
     def test_310_uint32_exceptions(self, value, exc_type, exc_pattern):
         uint32 = ssh_agent_client.SSHAgentClient.uint32
         with pytest.raises(exc_type, match=exc_pattern):
             uint32(value)
 
-    @pytest.mark.parametrize(['input', 'exc_type', 'exc_pattern'], [
+    @pytest.mark.parametrize(
+        ['input', 'exc_type', 'exc_pattern'],
+        [
             ('some string', TypeError, 'invalid payload type'),
-    ])
+        ],
+    )
     def test_311_string_exceptions(self, input, exc_type, exc_pattern):
         string = ssh_agent_client.SSHAgentClient.string
         with pytest.raises(exc_type, match=exc_pattern):
             string(input)
 
     @pytest.mark.parametrize(
-        ['input', 'exc_type', 'exc_pattern', 'has_trailer', 'parts'], [
+        ['input', 'exc_type', 'exc_pattern', 'has_trailer', 'parts'],
+        [
             (b'ssh', ValueError, 'malformed SSH byte string', False, None),
             (
                 b'\x00\x00\x00\x08ssh-rsa',
-                ValueError, 'malformed SSH byte string',
-                False, None,
+                ValueError,
+                'malformed SSH byte string',
+                False,
+                None,
             ),
             (
                 b'\x00\x00\x00\x04XXX trailing text',
-                ValueError, 'malformed SSH byte string',
-                True, (b'XXX ', b'trailing text'),
+                ValueError,
+                'malformed SSH byte string',
+                True,
+                (b'XXX ', b'trailing text'),
             ),
-    ])
-    def test_312_unstring_exceptions(self, input, exc_type, exc_pattern,
-                                     has_trailer, parts):
+        ],
+    )
+    def test_312_unstring_exceptions(
+        self, input, exc_type, exc_pattern, has_trailer, parts
+    ):
         unstring = ssh_agent_client.SSHAgentClient.unstring
         unstring_prefix = ssh_agent_client.SSHAgentClient.unstring_prefix
         with pytest.raises(exc_type, match=exc_pattern):
@@ -118,22 +145,26 @@ class TestStaticFunctionality:
             with pytest.raises(exc_type, match=exc_pattern):
                 unstring_prefix(input)
 
+
 @tests.skip_if_no_agent
 class TestAgentInteraction:
-
-    @pytest.mark.parametrize(['keytype', 'data_dict'],
-                             list(tests.SUPPORTED_KEYS.items()))
+    @pytest.mark.parametrize(
+        ['keytype', 'data_dict'], list(tests.SUPPORTED_KEYS.items())
+    )
     def test_200_sign_data_via_agent(self, keytype, data_dict):
         del keytype  # Unused.
         private_key = data_dict['private_key']
         try:
-            _ = subprocess.run(['ssh-add', '-t', '30', '-q', '-'],
-                               input=private_key, check=True,
-                               capture_output=True)
+            _ = subprocess.run(
+                ['ssh-add', '-t', '30', '-q', '-'],
+                input=private_key,
+                check=True,
+                capture_output=True,
+            )
         except subprocess.CalledProcessError as e:
             pytest.skip(
-                f"uploading test key: {e!r}, stdout={e.stdout!r}, "
-                f"stderr={e.stderr!r}"
+                f'uploading test key: {e!r}, stdout={e.stdout!r}, '
+                f'stderr={e.stderr!r}'
             )
         else:
             try:
@@ -141,37 +172,48 @@ class TestAgentInteraction:
             except OSError:  # pragma: no cover
                 pytest.skip('communication error with the SSH agent')
         with client:
-            key_comment_pairs = {bytes(k): bytes(c)
-                                 for k, c in client.list_keys()}
+            key_comment_pairs = {
+                bytes(k): bytes(c) for k, c in client.list_keys()
+            }
             public_key_data = data_dict['public_key_data']
             expected_signature = data_dict['expected_signature']
             derived_passphrase = data_dict['derived_passphrase']
             if public_key_data not in key_comment_pairs:  # pragma: no cover
                 pytest.skip('prerequisite SSH key not loaded')
-            signature = bytes(client.sign(
-                payload=derivepassphrase.Vault._UUID, key=public_key_data))
+            signature = bytes(
+                client.sign(
+                    payload=derivepassphrase.Vault._UUID, key=public_key_data
+                )
+            )
             assert signature == expected_signature, 'SSH signature mismatch'
-            signature2 = bytes(client.sign(
-                payload=derivepassphrase.Vault._UUID, key=public_key_data))
+            signature2 = bytes(
+                client.sign(
+                    payload=derivepassphrase.Vault._UUID, key=public_key_data
+                )
+            )
             assert signature2 == expected_signature, 'SSH signature mismatch'
             assert (
-                derivepassphrase.Vault.phrase_from_key(public_key_data) ==
-                derived_passphrase
+                derivepassphrase.Vault.phrase_from_key(public_key_data)
+                == derived_passphrase
             ), 'SSH signature mismatch'
 
-    @pytest.mark.parametrize(['keytype', 'data_dict'],
-                             list(tests.UNSUITABLE_KEYS.items()))
+    @pytest.mark.parametrize(
+        ['keytype', 'data_dict'], list(tests.UNSUITABLE_KEYS.items())
+    )
     def test_201_sign_data_via_agent_unsupported(self, keytype, data_dict):
         del keytype  # Unused.
         private_key = data_dict['private_key']
         try:
-            _ = subprocess.run(['ssh-add', '-t', '30', '-q', '-'],
-                               input=private_key, check=True,
-                               capture_output=True)
+            _ = subprocess.run(
+                ['ssh-add', '-t', '30', '-q', '-'],
+                input=private_key,
+                check=True,
+                capture_output=True,
+            )
         except subprocess.CalledProcessError as e:  # pragma: no cover
             pytest.skip(
-                f"uploading test key: {e!r}, stdout={e.stdout!r}, "
-                f"stderr={e.stderr!r}"
+                f'uploading test key: {e!r}, stdout={e.stdout!r}, '
+                f'stderr={e.stderr!r}'
             )
         else:
             try:
@@ -179,16 +221,23 @@ class TestAgentInteraction:
             except OSError:  # pragma: no cover
                 pytest.skip('communication error with the SSH agent')
         with client:
-            key_comment_pairs = {bytes(k): bytes(c)
-                                 for k, c in client.list_keys()}
+            key_comment_pairs = {
+                bytes(k): bytes(c) for k, c in client.list_keys()
+            }
             public_key_data = data_dict['public_key_data']
             _ = data_dict['expected_signature']
             if public_key_data not in key_comment_pairs:  # pragma: no cover
                 pytest.skip('prerequisite SSH key not loaded')
-            signature = bytes(client.sign(
-                payload=derivepassphrase.Vault._UUID, key=public_key_data))
-            signature2 = bytes(client.sign(
-                payload=derivepassphrase.Vault._UUID, key=public_key_data))
+            signature = bytes(
+                client.sign(
+                    payload=derivepassphrase.Vault._UUID, key=public_key_data
+                )
+            )
+            signature2 = bytes(
+                client.sign(
+                    payload=derivepassphrase.Vault._UUID, key=public_key_data
+                )
+            )
             assert signature != signature2, 'SSH signature repeatable?!'
             with pytest.raises(ValueError, match='unsuitable SSH key'):
                 derivepassphrase.Vault.phrase_from_key(public_key_data)
@@ -207,20 +256,32 @@ class TestAgentInteraction:
     @pytest.mark.parametrize(['key', 'single'], list(_params()))
     def test_210_ssh_key_selector(self, monkeypatch, key, single):
         def key_is_suitable(key: bytes):
-            return key in {v['public_key_data']
-                           for v in tests.SUPPORTED_KEYS.values()}
+            return key in {
+                v['public_key_data'] for v in tests.SUPPORTED_KEYS.values()
+            }
+
         if single:
-            monkeypatch.setattr(ssh_agent_client.SSHAgentClient,
-                                'list_keys', tests.list_keys_singleton)
-            keys = [pair.key for pair in tests.list_keys_singleton()
-                    if key_is_suitable(pair.key)]
+            monkeypatch.setattr(
+                ssh_agent_client.SSHAgentClient,
+                'list_keys',
+                tests.list_keys_singleton,
+            )
+            keys = [
+                pair.key
+                for pair in tests.list_keys_singleton()
+                if key_is_suitable(pair.key)
+            ]
             index = '1'
             text = 'Use this key? yes\n'
         else:
-            monkeypatch.setattr(ssh_agent_client.SSHAgentClient,
-                                'list_keys', tests.list_keys)
-            keys = [pair.key for pair in tests.list_keys()
-                    if key_is_suitable(pair.key)]
+            monkeypatch.setattr(
+                ssh_agent_client.SSHAgentClient, 'list_keys', tests.list_keys
+            )
+            keys = [
+                pair.key
+                for pair in tests.list_keys()
+                if key_is_suitable(pair.key)
+            ]
             index = str(1 + keys.index(key))
             n = len(keys)
             text = f'Your selection? (1-{n}, leave empty to abort): {index}\n'
@@ -232,31 +293,36 @@ class TestAgentInteraction:
             click.echo(base64.standard_b64encode(key).decode('ASCII'))
 
         runner = click.testing.CliRunner(mix_stderr=True)
-        result = runner.invoke(driver, [],
+        result = runner.invoke(
+            driver,
+            [],
             input=('yes\n' if single else f'{index}\n'),
-                               catch_exceptions=True)
-        assert result.stdout.startswith('Suitable SSH keys:\n'), (
-            'missing expected output'
+            catch_exceptions=True,
         )
+        assert result.stdout.startswith(
+            'Suitable SSH keys:\n'
+        ), 'missing expected output'
         assert text in result.stdout, 'missing expected output'
-        assert (
-            result.stdout.endswith(f'\n{b64_key}\n')
+        assert result.stdout.endswith(
+            f'\n{b64_key}\n'
         ), 'missing expected output'
         assert result.exit_code == 0, 'driver program failed?!'
 
     del _params
 
     def test_300_constructor_bad_running_agent(self, monkeypatch):
-        monkeypatch.setenv('SSH_AUTH_SOCK',
-                           os.environ['SSH_AUTH_SOCK'] + '~')
+        monkeypatch.setenv('SSH_AUTH_SOCK', os.environ['SSH_AUTH_SOCK'] + '~')
         sock = socket.socket(family=socket.AF_UNIX)
         with pytest.raises(OSError):  # noqa: PT011
             ssh_agent_client.SSHAgentClient(socket=sock)
 
-    @pytest.mark.parametrize('response', [
+    @pytest.mark.parametrize(
+        'response',
+        [
             b'\x00\x00',
             b'\x00\x00\x00\x1f some bytes missing',
-    ])
+        ],
+    )
     def test_310_truncated_server_response(self, monkeypatch, response):
         client = ssh_agent_client.SSHAgentClient()
         response_stream = io.BytesIO(response)
@@ -282,13 +351,17 @@ class TestAgentInteraction:
                 ssh_agent_client.TrailingDataError,
                 'Overlong response',
             ),
-        ]
+        ],
     )
-    def test_320_list_keys_error_responses(self, monkeypatch, response_code,
-                                           response, exc_type, exc_pattern):
+    def test_320_list_keys_error_responses(
+        self, monkeypatch, response_code, response, exc_type, exc_pattern
+    ):
         client = ssh_agent_client.SSHAgentClient()
-        monkeypatch.setattr(client, 'request',
-                            lambda *a, **kw: (response_code, response))  # noqa: ARG005
+        monkeypatch.setattr(
+            client,
+            'request',
+            lambda *a, **kw: (response_code, response),  # noqa: ARG005
+        )
         with pytest.raises(exc_type, match=exc_pattern):
             client.list_keys()
 
@@ -309,16 +382,19 @@ class TestAgentInteraction:
                 (255, b''),
                 RuntimeError,
                 'signing data failed:',
+            ),
+        ],
     )
-        ]
-    )
-    def test_330_sign_error_responses(self, monkeypatch, key, check,
-                                      response, exc_type, exc_pattern):
+    def test_330_sign_error_responses(
+        self, monkeypatch, key, check, response, exc_type, exc_pattern
+    ):
         client = ssh_agent_client.SSHAgentClient()
         monkeypatch.setattr(client, 'request', lambda a, b: response)  # noqa: ARG005
         KeyCommentPair = ssh_agent_client.types.KeyCommentPair  # noqa: N806
-        loaded_keys = [KeyCommentPair(v['public_key_data'], b'no comment')
-                       for v in tests.SUPPORTED_KEYS.values()]
+        loaded_keys = [
+            KeyCommentPair(v['public_key_data'], b'no comment')
+            for v in tests.SUPPORTED_KEYS.values()
+        ]
         monkeypatch.setattr(client, 'list_keys', lambda: loaded_keys)
         with pytest.raises(exc_type, match=exc_pattern):
             client.sign(key, b'abc', check_if_key_loaded=check)


...	...	@@ -122,6 +122,7 @@ extend = "ruff_defaults_v0.5.0.toml"
122	122
123	123	[tool.ruff.format]
124	124	quote-style = 'single'
	125	+docstring-code-line-length = "dynamic"
125	126	preview = true
126	127
127	128	[tool.ruff.lint]

...	...	@@ -2,9 +2,7 @@
2	2	#
3	3	# SPDX-License-Identifier: MIT
4	4
5		-"""Work-alike of vault(1) – a deterministic, stateless password manager
6		-
7		-""" # noqa: RUF002
	5	+"""Work-alike of vault(1) – a deterministic, stateless password manager""" # noqa: RUF002
8	6
9	7	from __future__ import annotations
10	8
...	...	@@ -19,8 +17,9 @@ from typing_extensions import assert_type
19	17	import sequin
20	18	import ssh_agent_client
21	19
22		-__author__ = "Marco Ricci <m@the13thletter.info>"
23		-__version__ = "0.1.1"
	20	+__author__ = 'Marco Ricci <m@the13thletter.info>'
	21	+__version__ = '0.1.1'
	22	+
24	23
25	24	class AmbiguousByteRepresentationError(ValueError):
26	25	"""The object has an ambiguous byte representation."""
...	...	@@ -40,8 +40,10 @@ _CHARSETS = collections.OrderedDict([
40	40	])
41	41	_CHARSETS['alpha'] = _CHARSETS['lower'] + _CHARSETS['upper']
42	42	_CHARSETS['alphanum'] = _CHARSETS['alpha'] + _CHARSETS['number']
43		-_CHARSETS['all'] = (_CHARSETS['alphanum'] + _CHARSETS['space']
44		- + _CHARSETS['symbol'])
	43	+_CHARSETS['all'] = (
	44	+ _CHARSETS['alphanum'] + _CHARSETS['space'] + _CHARSETS['symbol']
	45	+)
	46	+
45	47
46	48	class Vault:
47	49	"""A work-alike of James Coglan's vault.
...	...	@@ -75,10 +78,16 @@ class Vault:
75	78	"""
76	79
77	80	def __init__(
78		- self, *, phrase: bytes \| bytearray \| str = b'',
79		- length: int = 20, repeat: int = 0, lower: int \| None = None,
80		- upper: int \| None = None, number: int \| None = None,
81		- space: int \| None = None, dash: int \| None = None,
	81	+ self,
	82	+ *,
	83	+ phrase: bytes \| bytearray \| str = b'',
	84	+ length: int = 20,
	85	+ repeat: int = 0,
	86	+ lower: int \| None = None,
	87	+ upper: int \| None = None,
	88	+ number: int \| None = None,
	89	+ space: int \| None = None,
	90	+ dash: int \| None = None,
82	91	symbol: int \| None = None,
83	92	) -> None:
84	93	"""Initialize the Vault object.
...	...	@@ -177,7 +188,8 @@ class Vault:
177	188	return math.fsum(math.log2(f) for f in factors)
178	189
179	190	def _estimate_sufficient_hash_length(
180		- self, safety_factor: float = 2.0,
	191	+ self,
	192	+ safety_factor: float = 2.0,
181	193	) -> int:
182	194	"""Estimate the sufficient hash length, given the current settings.
183	195
...	...	@@ -241,8 +253,11 @@ class Vault:
241	253
242	254	@classmethod
243	255	def create_hash(
244		- cls, phrase: bytes \| bytearray \| str,
245		- service: bytes \| bytearray, *, length: int = 32,
	256	+ cls,
	257	+ phrase: bytes \| bytearray \| str,
	258	+ service: bytes \| bytearray,
	259	+ *,
	260	+ length: int = 32,
246	261	) -> bytes:
247	262	r"""Create a pseudorandom byte stream from phrase and service.
248	263
...	...	@@ -302,11 +317,19 @@ class Vault:
302	317	phrase = cls._get_binary_string(phrase)
303	318	assert not isinstance(phrase, str)
304	319	salt = bytes(service) + cls._UUID
305		- return hashlib.pbkdf2_hmac(hash_name='sha1', password=phrase,
306		- salt=salt, iterations=8, dklen=length)
	320	+ return hashlib.pbkdf2_hmac(
	321	+ hash_name='sha1',
	322	+ password=phrase,
	323	+ salt=salt,
	324	+ iterations=8,
	325	+ dklen=length,
	326	+ )
307	327
308	328	def generate(
309		- self, service_name: str \| bytes \| bytearray, /, *,
	329	+ self,
	330	+ service_name: str \| bytes \| bytearray,
	331	+ /,
	332	+ *,
310	333	phrase: bytes \| bytearray \| str = b'',
311	334	) -> bytes:
312	335	r"""Generate a service passphrase.
...	...	@@ -358,8 +381,11 @@ class Vault:
358	381	while True:
359	382	try:
360	383	required = self._required[:]
361		- seq = sequin.Sequin(self.create_hash(
362		- phrase=phrase, service=service_name, length=hash_length))
	384	+ seq = sequin.Sequin(
	385	+ self.create_hash(
	386	+ phrase=phrase, service=service_name, length=hash_length
	387	+ )
	388	+ )
363	389	result = bytearray()
364	390	while len(result) < self._length:
365	391	pos = seq.generate(len(required))
...	...	@@ -374,8 +400,9 @@ class Vault:
374	400	if self._repeat and result:
375	401	bad_suffix = bytes(result[-1:]) * (self._repeat - 1)
376	402	if result.endswith(bad_suffix):
377		- charset = self._subtract(bytes(result[-1:]),
378		- charset)
	403	+ charset = self._subtract(
	404	+ bytes(result[-1:]), charset
	405	+ )
379	406	pos = seq.generate(len(charset))
380	407	result.extend(charset[pos : pos + 1])
381	408	except sequin.SequinExhaustedError:
...	...	@@ -399,19 +426,16 @@ class Vault:
399	426
400	427	"""
401	428	deterministic_signature_types = {
402		- 'ssh-ed25519':
403		- lambda k: k.startswith(b'\x00\x00\x00\x0bssh-ed25519'),
404		- 'ssh-ed448':
405		- lambda k: k.startswith(b'\x00\x00\x00\x09ssh-ed448'),
406		- 'ssh-rsa':
407		- lambda k: k.startswith(b'\x00\x00\x00\x07ssh-rsa'),
	429	+ 'ssh-ed25519': lambda k: k.startswith(
	430	+ b'\x00\x00\x00\x0bssh-ed25519'
	431	+ ),
	432	+ 'ssh-ed448': lambda k: k.startswith(b'\x00\x00\x00\x09ssh-ed448'),
	433	+ 'ssh-rsa': lambda k: k.startswith(b'\x00\x00\x00\x07ssh-rsa'),
408	434	}
409	435	return any(v(key) for v in deterministic_signature_types.values())
410	436
411	437	@classmethod
412		- def phrase_from_key(
413		- cls, key: bytes \| bytearray, /
414		- ) -> bytes:
	438	+ def phrase_from_key(cls, key: bytes \| bytearray, /) -> bytes:
415	439	"""Obtain the master passphrase from a configured SSH key.
416	440
417	441	vault allows the usage of certain SSH keys to derive a master
...	...	@@ -456,8 +480,10 @@ class Vault:
456	480
457	481	"""
458	482	if not cls._is_suitable_ssh_key(key):
459		- msg = ('unsuitable SSH key: bad key, or '
460		- 'signature not deterministic')
	483	+ msg = (
	484	+ 'unsuitable SSH key: bad key, or '
	485	+ 'signature not deterministic'
	486	+ )
461	487	raise ValueError(msg)
462	488	with ssh_agent_client.SSHAgentClient() as client:
463	489	raw_sig = client.sign(key, cls._UUID)
...	...	@@ -467,7 +493,8 @@ class Vault:
467	493
468	494	@staticmethod
469	495	def _subtract(
470		- charset: bytes \| bytearray, allowed: bytes \| bytearray,
	496	+ charset: bytes \| bytearray,
	497	+ allowed: bytes \| bytearray,
471	498	) -> bytearray:
472	499	"""Remove the characters in charset from allowed.
473	500
...	...	@@ -489,8 +516,9 @@ class Vault:
489	516	`allowed` or `charset` contained duplicate characters.
490	517
491	518	"""
492		- allowed = (allowed if isinstance(allowed, bytearray)
493		- else bytearray(allowed))
	519	+ allowed = (
	520	+ allowed if isinstance(allowed, bytearray) else bytearray(allowed)
	521	+ )
494	522	assert_type(allowed, bytearray)
495	523	msg_dup_characters = 'duplicate characters in set'
496	524	if len(frozenset(allowed)) != len(allowed):

...	...	@@ -5,7 +5,7 @@
5	5
6	6	import sys
7	7
8		-if __name__ == "__main__":
	8	+if __name__ == '__main__':
9	9	from derivepassphrase.cli import derivepassphrase
10	10
11	11	sys.exit(derivepassphrase())

...	...	@@ -2,9 +2,7 @@
2	2	#
3	3	# SPDX-License-Identifier: MIT
4	4
5		-"""Common typing declarations for the parent module.
6		-
7		-"""
	5	+"""Common typing declarations for the parent module."""
8	6
9	7	from __future__ import annotations
10	8
...	...	@@ -79,9 +80,13 @@ class VaultConfigServicesSettings(VaultConfigGlobalSettings, total=False):
79	80	symbol: NotRequired[int]
80	81
81	82
82		-_VaultConfig = TypedDict('_VaultConfig',
	83	+_VaultConfig = TypedDict(
	84	+ '_VaultConfig',
83	85	{'global': NotRequired[VaultConfigGlobalSettings]},
84		- total=False)
	86	+ total=False,
	87	+)
	88	+
	89	+
85	90	class VaultConfig(TypedDict, _VaultConfig, total=False):
86	91	r"""Configuration for vault.
87	92

...	...	@@ -32,8 +32,9 @@ if TYPE_CHECKING:
32	32	from collections.abc import Iterator, Sequence
33	33
34	34	__all__ = ('Sequin', 'SequinExhaustedError')
35		-__author__ = "Marco Ricci <m@the13thletter.info>"
36		-__version__ = "0.1.1"
	35	+__author__ = 'Marco Ricci <m@the13thletter.info>'
	36	+__version__ = '0.1.1'
	37	+
37	38
38	39	class Sequin:
39	40	"""Generate pseudorandom non-negative numbers in different ranges.
...	...	@@ -60,7 +62,9 @@ class Sequin:
60	62	def __init__(
61	63	self,
62	64	sequence: str \| bytes \| bytearray \| Sequence[int],
63		- /, *, is_bitstring: bool = False
	65	+ /,
	66	+ *,
	67	+ is_bitstring: bool = False,
64	68	):
65	69	"""Initialize the Sequin.
66	70
...	...	@@ -126,8 +134,7 @@ class Sequin:
126	134	sequences.
127	135
128	136	Examples:
129		- >>> seq = Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1],
130		- ... is_bitstring=True)
	137	+ >>> seq = Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1], is_bitstring=True)
131	138	>>> seq.bases
132	139	{2: deque([1, 0, 1, 0, 0, 1, 0, 0, 0, 1])}
133	140	>>> seq._all_or_nothing_shift(3)
...	...	@@ -163,9 +170,7 @@ class Sequin:
163	170	return tuple(stash)
164	171
165	172	@staticmethod
166		- def _big_endian_number(
167		- digits: Sequence[int], /, *, base: int = 2
168		- ) -> int:
	173	+ def _big_endian_number(digits: Sequence[int], /, *, base: int = 2) -> int:
169	174	"""Evaluate the given integer sequence as a big endian number.
170	175
171	176	Args:
...	...	@@ -231,10 +236,14 @@ class Sequin:
231	236	The sequin is exhausted.
232	237
233	238	Examples:
234		- >>> seq = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
235		- ... is_bitstring=True)
236		- >>> seq2 = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
237		- ... is_bitstring=True)
	239	+ >>> seq = Sequin(
	240	+ ... [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
	241	+ ... is_bitstring=True,
	242	+ ... )
	243	+ >>> seq2 = Sequin(
	244	+ ... [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
	245	+ ... is_bitstring=True,
	246	+ ... )
238	247	>>> seq.generate(5)
239	248	3
240	249	>>> seq.generate(5)
...	...	@@ -266,9 +275,7 @@ class Sequin:
266	275	raise SequinExhaustedError
267	276	return value
268	277
269		- def _generate_inner(
270		- self, n: int, /, *, base: int = 2
271		- ) -> int:
	278	+ def _generate_inner(self, n: int, /, *, base: int = 2) -> int:
272	279	"""Recursive call to generate a base `n` non-negative integer.
273	280
274	281	We first determine the correct exponent `k` to generate base `n`
...	...	@@ -298,10 +305,14 @@ class Sequin:
298	305	The range is empty.
299	306
300	307	Examples:
301		- >>> seq = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
302		- ... is_bitstring=True)
303		- >>> seq2 = Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
304		- ... is_bitstring=True)
	308	+ >>> seq = Sequin(
	309	+ ... [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
	310	+ ... is_bitstring=True,
	311	+ ... )
	312	+ >>> seq2 = Sequin(
	313	+ ... [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
	314	+ ... is_bitstring=True,
	315	+ ... )
305	316	>>> seq._generate_inner(5)
306	317	3
307	318	>>> seq._generate_inner(5)

...	...	@@ -21,8 +21,8 @@ if TYPE_CHECKING:
21	21	from collections.abc import Sequence
22	22
23	23	__all__ = ('SSHAgentClient',)
24		-__author__ = "Marco Ricci <m@the13thletter.info>"
25		-__version__ = "0.1.1"
	24	+__author__ = 'Marco Ricci <m@the13thletter.info>'
	25	+__version__ = '0.1.1'
26	26
27	27	# In SSH bytestrings, the "length" of the byte string is stored as
28	28	# a 4-byte/32-bit unsigned integer at the beginning.
...	...	@@ -105,8 +110,7 @@ class SSHAgentClient:
105	110	) -> bool:
106	111	"""Close socket connection upon context manager completion."""
107	112	return bool(
108		- self._connection.__exit__(
109		- exc_type, exc_val, exc_tb) # type: ignore[func-returns-value]
	113	+ self._connection.__exit__(exc_type, exc_val, exc_tb) # type: ignore[func-returns-value]
110	114	)
111	115
112	116	@staticmethod
...	...	@@ -172,17 +176,16 @@ class SSHAgentClient:
172	176	Examples:
173	177	>>> bytes(SSHAgentClient.unstring(b'\x00\x00\x00\x07ssh-rsa'))
174	178	b'ssh-rsa'
175		- >>> bytes(SSHAgentClient.unstring(
176		- ... SSHAgentClient.string(b'ssh-ed25519')))
	179	+ >>> bytes(
	180	+ ... SSHAgentClient.unstring(SSHAgentClient.string(b'ssh-ed25519'))
	181	+ ... )
177	182	b'ssh-ed25519'
178	183
179		- """
	184	+ """ # noqa: E501
180	185	n = len(bytestring)
181	186	msg = 'malformed SSH byte string'
182		- if (
183		- n < HEAD_LEN
184		- or n != HEAD_LEN + int.from_bytes(bytestring[:HEAD_LEN], 'big',
185		- signed=False)
	187	+ if n < HEAD_LEN or n != HEAD_LEN + int.from_bytes(
	188	+ bytestring[:HEAD_LEN], 'big', signed=False
186	189	):
187	190	raise ValueError(msg)
188	191	return bytestring[HEAD_LEN:]
...	...	@@ -209,11 +212,13 @@ class SSHAgentClient:
209	212
210	213	Examples:
211	214	>>> a, b = SSHAgentClient.unstring_prefix(
212		- ... b'\x00\x00\x00\x07ssh-rsa____trailing data')
	215	+ ... b'\x00\x00\x00\x07ssh-rsa____trailing data'
	216	+ ... )
213	217	>>> (bytes(a), bytes(b))
214	218	(b'ssh-rsa', b'____trailing data')
215	219	>>> a, b = SSHAgentClient.unstring_prefix(
216		- ... SSHAgentClient.string(b'ssh-ed25519'))
	220	+ ... SSHAgentClient.string(b'ssh-ed25519')
	221	+ ... )
217	222	>>> (bytes(a), bytes(b))
218	223	(b'ssh-ed25519', b'')
219	224
...	...	@@ -225,7 +230,10 @@ class SSHAgentClient:
225	230	m = int.from_bytes(bytestring[:HEAD_LEN], 'big', signed=False)
226	231	if m + HEAD_LEN > n:
227	232	raise ValueError(msg)
228		- return (bytestring[HEAD_LEN:m + HEAD_LEN], bytestring[m + HEAD_LEN:])
	233	+ return (
	234	+ bytestring[HEAD_LEN : m + HEAD_LEN],
	235	+ bytestring[m + HEAD_LEN :],
	236	+ )
229	237
230	238	def request(
231	239	self, code: int, payload: bytes \| bytearray, /
...	...	@@ -282,12 +290,16 @@ class SSHAgentClient:
282	290
283	291	"""
284	292	response_code, response = self.request(
285		- ssh_types.SSH_AGENTC.REQUEST_IDENTITIES.value, b'')
	293	+ ssh_types.SSH_AGENTC.REQUEST_IDENTITIES.value, b''
	294	+ )
286	295	if response_code != ssh_types.SSH_AGENT.IDENTITIES_ANSWER.value:
287		- msg = (f'error return from SSH agent: '
288		- f'{response_code = }, {response = }')
	296	+ msg = (
	297	+ f'error return from SSH agent: '
	298	+ f'{response_code = }, {response = }'
	299	+ )
289	300	raise RuntimeError(msg)
290	301	response_stream = collections.deque(response)
	302	+
291	303	def shift(num: int) -> bytes:
292	304	buf = collections.deque(b'')
293	305	for _ in range(num):
...	...	@@ -314,8 +327,13 @@ class SSHAgentClient:
314	327	return keys
315	328
316	329	def sign(
317		- self, /, key: bytes \| bytearray, payload: bytes \| bytearray,
318		- *, flags: int = 0, check_if_key_loaded: bool = False,
	330	+ self,
	331	+ /,
	332	+ key: bytes \| bytearray,
	333	+ payload: bytes \| bytearray,
	334	+ *,
	335	+ flags: int = 0,
	336	+ check_if_key_loaded: bool = False,
319	337	) -> bytes \| bytearray:
320	338	"""Request the SSH agent sign the payload with the key.
321	339
...	...	@@ -361,7 +379,8 @@ class SSHAgentClient:
361	379	request_data.extend(self.string(payload))
362	380	request_data.extend(self.uint32(flags))
363	381	response_code, response = self.request(
364		- ssh_types.SSH_AGENTC.SIGN_REQUEST.value, request_data)
	382	+ ssh_types.SSH_AGENTC.SIGN_REQUEST.value, request_data
	383	+ )
365	384	if response_code != ssh_types.SSH_AGENT.SIGN_RESPONSE.value:
366	385	msg = f'signing data failed: {response_code = }, {response = }'
367	386	raise RuntimeError(msg)

...	...	@@ -33,38 +33,39 @@ if TYPE_CHECKING:
33	33	expected_signature: bytes \| None
34	34	derived_passphrase: bytes \| str \| None
35	35
	36	+
36	37	SUPPORTED_KEYS: Mapping[str, SSHTestKey] = {
37	38	'ed25519': {
38		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	39	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
39	40	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
40	41	QyNTUxOQAAACCBeIFoJtYCSF8P/zJIb+TBMIncHGpFBgnpCQ/7whJpdgAAAKDweO7H8Hju
41	42	xwAAAAtzc2gtZWQyNTUxOQAAACCBeIFoJtYCSF8P/zJIb+TBMIncHGpFBgnpCQ/7whJpdg
42	43	AAAEAbM/A869nkWZbe2tp3Dm/L6gitvmpH/aRZt8sBII3ExYF4gWgm1gJIXw//Mkhv5MEw
43	44	idwcakUGCekJD/vCEml2AAAAG3Rlc3Qga2V5IHdpdGhvdXQgcGFzc3BocmFzZQEC
44	45	-----END OPENSSH PRIVATE KEY-----
45		-''',
46		- 'public_key': rb'''ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIF4gWgm1gJIXw//Mkhv5MEwidwcakUGCekJD/vCEml2 test key without passphrase
47		-''', # noqa: E501
48		- 'public_key_data': bytes.fromhex('''
	46	+""",
	47	+ 'public_key': rb"""ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIF4gWgm1gJIXw//Mkhv5MEwidwcakUGCekJD/vCEml2 test key without passphrase
	48	+""", # noqa: E501
	49	+ 'public_key_data': bytes.fromhex("""
49	50	00 00 00 0b 73 73 68 2d 65 64 32 35 35 31 39
50	51	00 00 00 20
51	52	81 78 81 68 26 d6 02 48 5f 0f ff 32 48 6f e4 c1
52	53	30 89 dc 1c 6a 45 06 09 e9 09 0f fb c2 12 69 76
53		-'''),
54		- 'expected_signature': bytes.fromhex('''
	54	+"""),
	55	+ 'expected_signature': bytes.fromhex("""
55	56	00 00 00 0b 73 73 68 2d 65 64 32 35 35 31 39
56	57	00 00 00 40
57	58	f0 98 19 80 6c 1a 97 d5 26 03 6e cc e3 65 8f 86
58	59	66 07 13 19 13 09 21 33 33 f9 e4 36 53 1d af fd
59	60	0d 08 1f ec f8 73 9b 8c 5f 55 39 16 7c 53 54 2c
60	61	1e 52 bb 30 ed 7f 89 e2 2f 69 51 55 d8 9e a6 02
61		- '''),
	62	+ """),
62	63	'derived_passphrase': rb'8JgZgGwal9UmA27M42WPhmYHExkTCSEzM/nkNlMdr/0NCB/s+HObjF9VORZ8U1QsHlK7MO1/ieIvaVFV2J6mAg==', # noqa: E501
63	64	},
64	65	# Currently only supported by PuTTY (which is deficient in other
65	66	# niceties of the SSH agent and the agent's client).
66	67	'ed448': {
67		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	68	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
68	69	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAASgAAAAlz
69	70	c2gtZWQ0NDgAAAA54vZy009Wu8wExjvEb3hqtLz1GO/+d5vmGUbErWQ4AUO9mYLT
70	71	zHJHc2m4s+yWzP29Cc3EcxizLG8AAAAA8BdhfCcXYXwnAAAACXNzaC1lZDQ0OAAA
...	...	@@ -74,19 +75,18 @@ ADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM
74	75	GUbErWQ4AUO9mYLTzHJHc2m4s+yWzP29Cc3EcxizLG8AAAAAG3Rlc3Qga2V5IHdp
75	76	dGhvdXQgcGFzc3BocmFzZQECAwQFBgcICQ==
76	77	-----END OPENSSH PRIVATE KEY-----
77		-''',
78		- 'public_key': rb'''ssh-ed448 AAAACXNzaC1lZDQ0OAAAADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM/b0JzcRzGLMsbwA= test key without passphrase
79		-''', # noqa: E501
80		- 'public_key_data': bytes.fromhex('''
	78	+""",
	79	+ 'public_key': rb"""ssh-ed448 AAAACXNzaC1lZDQ0OAAAADni9nLTT1a7zATGO8RveGq0vPUY7/53m+YZRsStZDgBQ72ZgtPMckdzabiz7JbM/b0JzcRzGLMsbwA= test key without passphrase
	80	+""", # noqa: E501
	81	+ 'public_key_data': bytes.fromhex("""
81	82	00 00 00 09 73 73 68 2d 65 64 34 34 38
82	83	00 00 00 39
83	84	e2 f6 72 d3 4f 56 bb cc 04 c6 3b c4 6f 78 6a b4
84	85	bc f5 18 ef fe 77 9b e6 19 46 c4 ad 64 38 01 43
85	86	bd 99 82 d3 cc 72 47 73 69 b8 b3 ec 96 cc fd bd
86	87	09 cd c4 73 18 b3 2c 6f 00
87		- '''),
88		-
89		- 'expected_signature': bytes.fromhex('''
	88	+ """),
	89	+ 'expected_signature': bytes.fromhex("""
90	90	00 00 00 09 73 73 68 2d 65 64 34 34 38
91	91	00 00 00 72 06 86
92	92	f4 64 a4 a6 ba d9 c3 22 c4 93 49 99 fc 11 de 67
...	...	@@ -96,11 +96,11 @@ dGhvdXQgcGFzc3BocmFzZQECAwQFBgcICQ==
96	96	db e5 89 f3 35 be 24 58 90 c6 ca 04 f0 db 88 80
97	97	db bd 77 7c 80 20 7f 3a 48 61 f6 1f ae a9 5e 53
98	98	7b e0 9d 93 1e ea dc eb b5 cd 56 4c ea 8f 08 00
99		- '''),
	99	+ """),
100	100	'derived_passphrase': rb'Bob0ZKSmutnDIsSTSZn8Ed5nlwjy2Lc8LBPnxRwekqYO2C9tgQOCAONy5DJtctJtMoQ/zKkeVywAmrOZ3kXazi7R2+WJ8zW+JFiQxsoE8NuIgNu9d3yAIH86SGH2H66pXlN74J2THurc67XNVkzqjwgA', # noqa: E501
101	101	},
102	102	'rsa': {
103		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	103	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
104	104	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
105	105	NhAAAAAwEAAQAAAYEAsaHu6Xs4cVsuDSNJlMCqoPVgmDgEviI8TfXmHKqX3JkIqI3LsvV7
106	106	Ijf8WCdTveEq7CkuZhImtsR52AOEVAoU8mDXDNr+nJ5wUPzf1UIaRjDe0lcXW4SlF01hQs
...	...	@@ -138,10 +138,10 @@ vC2EAD91xexdorIA5BgXU+qltBqzzBVzVtF7+jOZOjfzOlaTX9I5I5veyeTaTxZj1XXUzi
138	138	btBNdMEJJp7ifucYmoYAAwE7K+VlWagDEK2y8Mte9y9E+N0uO2j+h85sQt/UIb2iE/vhcg
139	139	Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
140	140	-----END OPENSSH PRIVATE KEY-----
141		-''',
142		- 'public_key': rb'''ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCxoe7pezhxWy4NI0mUwKqg9WCYOAS+IjxN9eYcqpfcmQiojcuy9XsiN/xYJ1O94SrsKS5mEia2xHnYA4RUChTyYNcM2v6cnnBQ/N/VQhpGMN7SVxdbhKUXTWFCwbjBgO6rGyHB6WtoH8vd7TOEPt+NgcXwhsWyoaUUdYTA62V+GF9vEmxMaC4ubgDz+B0QkPnauSoNxmkhcIe0lsLNb1pClZyz88PDnKXCX/d0HuN/HJ+sbPg7dCvOyqFYSyKn3uY6bCXqoIdurxXzH3O7z0P8f5sbmKOrGGKNuNxVRbeVl/D/3uDL0nqsbfUc1qvkfwbJwtMXC4IV6kOZMSk2BAsqh7x48gQ+rhYeEVSi8F3CWs4HJQoqrGt7K9a3mCSlMBHP70u3w6ME7eumoryxlUofewTd17ZEkzdX08l2ZlKzZvwQUrc+xQZ2Uw8z2mfW6Ti4gi0pYGaig7Ke4PwuXpo/C5YAWfeXycsvJZ2uaYRjMdZeJGNAnHLUGLkBscw5aI8= test key without passphrase
143		-''', # noqa: E501
144		- 'public_key_data': bytes.fromhex('''
	141	+""",
	142	+ 'public_key': rb"""ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCxoe7pezhxWy4NI0mUwKqg9WCYOAS+IjxN9eYcqpfcmQiojcuy9XsiN/xYJ1O94SrsKS5mEia2xHnYA4RUChTyYNcM2v6cnnBQ/N/VQhpGMN7SVxdbhKUXTWFCwbjBgO6rGyHB6WtoH8vd7TOEPt+NgcXwhsWyoaUUdYTA62V+GF9vEmxMaC4ubgDz+B0QkPnauSoNxmkhcIe0lsLNb1pClZyz88PDnKXCX/d0HuN/HJ+sbPg7dCvOyqFYSyKn3uY6bCXqoIdurxXzH3O7z0P8f5sbmKOrGGKNuNxVRbeVl/D/3uDL0nqsbfUc1qvkfwbJwtMXC4IV6kOZMSk2BAsqh7x48gQ+rhYeEVSi8F3CWs4HJQoqrGt7K9a3mCSlMBHP70u3w6ME7eumoryxlUofewTd17ZEkzdX08l2ZlKzZvwQUrc+xQZ2Uw8z2mfW6Ti4gi0pYGaig7Ke4PwuXpo/C5YAWfeXycsvJZ2uaYRjMdZeJGNAnHLUGLkBscw5aI8= test key without passphrase
	143	+""", # noqa: E501
	144	+ 'public_key_data': bytes.fromhex("""
145	145	00 00 00 07 73 73 68 2d 72 73 61
146	146	00 00 00 03 01 00 01
147	147	00 00 01 81 00
...	...	@@ -169,8 +169,8 @@ Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
169	169	b8 82 2d 29 60 66 a2 83 b2 9e e0 fc 2e 5e 9a 3f
170	170	0b 96 00 59 f7 97 c9 cb 2f 25 9d ae 69 84 63 31
171	171	d6 5e 24 63 40 9c 72 d4 18 b9 01 b1 cc 39 68 8f
172		-'''),
173		- 'expected_signature': bytes.fromhex('''
	172	+"""),
	173	+ 'expected_signature': bytes.fromhex("""
174	174	00 00 00 07 73 73 68 2d 72 73 61
175	175	00 00 01 80
176	176	a2 10 7c 2e f6 bb 53 a8 74 2a a1 19 99 ad 81 be
...	...	@@ -197,14 +197,14 @@ Bgp6142WnSCQAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UB
197	197	a4 1b bc d2 29 b8 78 61 2b 78 e6 b1 52 b0 d5 ec
198	198	de 69 2c 48 62 d9 fd d1 9b 6b b0 49 db d3 ff 38
199	199	e7 10 d9 2d ce 9f 0d 5e 09 7b 37 d2 7b c3 bf ce
200		-'''),
	200	+"""),
201	201	'derived_passphrase': rb'ohB8Lva7U6h0KqEZma2Bvnmc7dadCU5uxRhIM5B3mWj3ngNazU4Y64l9haLurkqS9m/Ouf6GfyprMdpuGv6ipYi4RH+hdnOz7HW10Ka5FZdlCRN9lCHR+10PiyMEd8LDVSKxoAmK9Tgq1n8bhymgJdMlb8tkYQeY3BTFhPiSJF5QEWtJ5fDMKcspqRnYp3EfkQsFsQFLwl8ApbYhv/gsnWebRzsKSWt5Lfwd7Ayw5Sci1an408P530ho6fvvPNwmv8/qKUMBpuPFUZX0Zm2KVeJH7OgwRUyuR+fJpCGLZLq2iPYh+HO5yxGheHWSxlrlZP7tQtmVmeYrbzwWPCh0pHIvDT8sM2eqNRmO57URL7P3asUC4m+jQuNiGZkD6qUg56HjvMgGo7V81nZd329gRoMqCADW09mkwUGM+GBWRYHaO6IWH55OdYMX2sNTwz4ZpBu80im4eGEreOaxUrDV7N5pLEhi2f3Rm2uwSdvT/zjnENktzp8NXgl7N9J7w7/O', # noqa: E501
202	202	},
203	203	}
204	204
205	205	UNSUITABLE_KEYS: Mapping[str, SSHTestKey] = {
206	206	'dsa1024': {
207		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	207	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
208	208	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABsQAAAAdzc2gtZH
209	209	NzAAAAgQC7KAZXqBGNVLBQPrcMYAoNW54BhD8aIhe7BDWYzJcsaMt72VKSkguZ8+XR7nRa
210	210	0C/ZsBi+uJp0dpxy9ZMTOWX4u5YPMeQcXEdGExZIfimGqSOAsy6fCld2IfJZJZExcCmhe9
...	...	@@ -225,10 +225,10 @@ mMbWEYp/C8jC6ikZqmtEOVK7w3woYC4b7BvWEm/zKcOapvD4h0mn8IZGs/7Xt/vISqIKqH
225	225	u7HfrQhdOiKSa+ZO9AAojbURqrLDRfBJa5dXn2AAAAFQDJHfenj4EJ9WkehpdJatPBlqCW
226	226	0gAAABt0ZXN0IGtleSB3aXRob3V0IHBhc3NwaHJhc2UBAgMEBQYH
227	227	-----END OPENSSH PRIVATE KEY-----
228		-''',
229		- 'public_key': rb'''ssh-dss AAAAB3NzaC1kc3MAAACBALsoBleoEY1UsFA+twxgCg1bngGEPxoiF7sENZjMlyxoy3vZUpKSC5nz5dHudFrQL9mwGL64mnR2nHL1kxM5Zfi7lg8x5BxcR0YTFkh+KYapI4CzLp8KV3Yh8lklkTFwKaF71KyOx3dhIA8lGW45cVBz3kxmhHmEzCUgMPxDOsTtAAAAFQD32c5k6B3tocxUahelQQFyfseiywAAAIAuvYCDeHEzesp3HNVTDx9fRVU9c77f4qvyEZ7Qpz/s3BVoFUvUZDx96cG5bKekBRsfTCjeHXCQH/yFfqn5Lxye7msgGVS5U3AvD9shiiEr3wt+pNgr9X6DooP7ybfjC8SJdmarLBjnifZuSxyHU2q+P+02kvMTFLH9dLSRIzVqKAAAAIBtA1E9xUS4YOsRx/7GDm2AB6M9cE9ev8myz4KGTriSbeaKsxiMBbJZi1VyBP7uE5jG1hGKfwvIwuopGaprRDlSu8N8KGAuG+wb1hJv8ynDmqbw+IdJp/CGRrP+17f7yEqiCqh7ux360IXToikmvmTvQAKI21Eaqyw0XwSWuXV59g== test key without passphrase
230		-''', # noqa: E501
231		- 'public_key_data': bytes.fromhex('''
	228	+""",
	229	+ 'public_key': rb"""ssh-dss AAAAB3NzaC1kc3MAAACBALsoBleoEY1UsFA+twxgCg1bngGEPxoiF7sENZjMlyxoy3vZUpKSC5nz5dHudFrQL9mwGL64mnR2nHL1kxM5Zfi7lg8x5BxcR0YTFkh+KYapI4CzLp8KV3Yh8lklkTFwKaF71KyOx3dhIA8lGW45cVBz3kxmhHmEzCUgMPxDOsTtAAAAFQD32c5k6B3tocxUahelQQFyfseiywAAAIAuvYCDeHEzesp3HNVTDx9fRVU9c77f4qvyEZ7Qpz/s3BVoFUvUZDx96cG5bKekBRsfTCjeHXCQH/yFfqn5Lxye7msgGVS5U3AvD9shiiEr3wt+pNgr9X6DooP7ybfjC8SJdmarLBjnifZuSxyHU2q+P+02kvMTFLH9dLSRIzVqKAAAAIBtA1E9xUS4YOsRx/7GDm2AB6M9cE9ev8myz4KGTriSbeaKsxiMBbJZi1VyBP7uE5jG1hGKfwvIwuopGaprRDlSu8N8KGAuG+wb1hJv8ynDmqbw+IdJp/CGRrP+17f7yEqiCqh7ux360IXToikmvmTvQAKI21Eaqyw0XwSWuXV59g== test key without passphrase
	230	+""", # noqa: E501
	231	+ 'public_key_data': bytes.fromhex("""
232	232	00 00 00 07 73 73 68 2d 64 73 73
233	233	00 00 00 81 00
234	234	bb 28 06 57 a8 11 8d 54 b0 50 3e b7 0c 60 0a 0d
...	...	@@ -259,12 +259,12 @@ u7HfrQhdOiKSa+ZO9AAojbURqrLDRfBJa5dXn2AAAAFQDJHfenj4EJ9WkehpdJatPBlqCW
259	259	a6 f0 f8 87 49 a7 f0 86 46 b3 fe d7 b7 fb c8 4a
260	260	a2 0a a8 7b bb 1d fa d0 85 d3 a2 29 26 be 64 ef
261	261	40 02 88 db 51 1a ab 2c 34 5f 04 96 b9 75 79 f6
262		-'''),
	262	+"""),
263	263	'expected_signature': None,
264	264	'derived_passphrase': None,
265	265	},
266	266	'ecdsa256': {
267		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	267	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
268	268	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAaAAAABNlY2RzYS
269	269	1zaGEyLW5pc3RwMjU2AAAACG5pc3RwMjU2AAAAQQTLbU0zDwsk2Dvp+VYIrsNVf5gWwz2S
270	270	3SZ8TbxiQRkpnGSVqyIoHJOJc+NQItAa7xlJ/8Z6gfz57Z3apUkaMJm6AAAAuKeY+YinmP
...	...	@@ -273,10 +273,10 @@ Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmb
273	273	oAAAAhAKIl/3n0pKVIxpZkXTGtii782Qr4yIcvHdpxjO/QsIqKAAAAG3Rlc3Qga2V5IHdp
274	274	dGhvdXQgcGFzc3BocmFzZQECAwQ=
275	275	-----END OPENSSH PRIVATE KEY-----
276		-''',
277		- 'public_key': rb'''ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBMttTTMPCyTYO+n5Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmbo= test key without passphrase
278		-''', # noqa: E501
279		- 'public_key_data': bytes.fromhex('''
	276	+""",
	277	+ 'public_key': rb"""ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBMttTTMPCyTYO+n5Vgiuw1V/mBbDPZLdJnxNvGJBGSmcZJWrIigck4lz41Ai0BrvGUn/xnqB/PntndqlSRowmbo= test key without passphrase
	278	+""", # noqa: E501
	279	+ 'public_key_data': bytes.fromhex("""
280	280	00 00 00 13 65 63 64 73 61 2d 73 68 61 32 2d 6e
281	281	69 73 74 70 32 35 36
282	282	00 00 00 08 6e 69 73 74 70 32 35 36
...	...	@@ -285,12 +285,12 @@ dGhvdXQgcGFzc3BocmFzZQECAwQ=
285	285	7f 98 16 c3 3d 92 dd 26 7c 4d bc 62 41 19 29 9c
286	286	64 95 ab 22 28 1c 93 89 73 e3 50 22 d0 1a ef 19
287	287	49 ff c6 7a 81 fc f9 ed 9d da a5 49 1a 30 99 ba
288		-'''),
	288	+"""),
289	289	'expected_signature': None,
290	290	'derived_passphrase': None,
291	291	},
292	292	'ecdsa384': {
293		- 'private_key': rb'''-----BEGIN OPENSSH PRIVATE KEY-----
	293	+ 'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----
294	294	b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAiAAAABNlY2RzYS
295	295	1zaGEyLW5pc3RwMzg0AAAACG5pc3RwMzg0AAAAYQSgkOjkAvq7v5vHuj3KBL4/EAWcn5hZ
296	296	DyKcbyV0eBMGFq7hKXQlZqIahLVqeMR0QqmkxNJ2rly2VHcXneq3vZ+9fIsWCOdYk5WP3N
...	...	@@ -300,10 +300,10 @@ au4Sl0JWaiGoS1anjEdEKppMTSdq5ctlR3F53qt72fvXyLFgjnWJOVj9zWT87/ddV5+8Gx
300	300	JAu0J3Q+cypZuKQVAAAAMQD5sTy8p+B1cn/DhOmXquui1BcxvASqzzevkBlbQoBa73y04B
301	301	2OdqVOVRkwZWRROz0AAAAbdGVzdCBrZXkgd2l0aG91dCBwYXNzcGhyYXNlAQIDBA==
302	302	-----END OPENSSH PRIVATE KEY-----
303		-''',
304		- 'public_key': rb'''ecdsa-sha2-nistp384 AAAAE2VjZHNhLXNoYTItbmlzdHAzODQAAAAIbmlzdHAzODQAAABhBKCQ6OQC+ru/m8e6PcoEvj8QBZyfmFkPIpxvJXR4EwYWruEpdCVmohqEtWp4xHRCqaTE0nauXLZUdxed6re9n718ixYI51iTlY/c1k/O/3XVefvBsSQLtCd0PnMqWbikFQ== test key without passphrase
305		-''', # noqa: E501
306		- 'public_key_data': bytes.fromhex('''
	303	+""",
	304	+ 'public_key': rb"""ecdsa-sha2-nistp384 AAAAE2VjZHNhLXNoYTItbmlzdHAzODQAAAAIbmlzdHAzODQAAABhBKCQ6OQC+ru/m8e6PcoEvj8QBZyfmFkPIpxvJXR4EwYWruEpdCVmohqEtWp4xHRCqaTE0nauXLZUdxed6re9n718ixYI51iTlY/c1k/O/3XVefvBsSQLtCd0PnMqWbikFQ== test key without passphrase
	305	+""", # noqa: E501
	306	+ 'public_key_data': bytes.fromhex("""
307	307	00 00 00 13
308	308	65 63 64 73 61 2d 73 68 61 32 2d 6e 69 73 74 70
309	309	33 38 34
...	...	@@ -315,7 +315,7 @@ JAu0J3Q+cypZuKQVAAAAMQD5sTy8p+B1cn/DhOmXquui1BcxvASqzzevkBlbQoBa73y04B
315	315	a4 c4 d2 76 ae 5c b6 54 77 17 9d ea b7 bd 9f bd
316	316	7c 8b 16 08 e7 58 93 95 8f dc d6 4f ce ff 75 d5
317	317	79 fb c1 b1 24 0b b4 27 74 3e 73 2a 59 b8 a4 15
318		-'''),
	318	+"""),
319	319	'expected_signature': None,
320	320	'derived_passphrase': None,
321	321	},
...	...	@@ -327,8 +327,16 @@ DUMMY_KEY1 = SUPPORTED_KEYS['ed25519']['public_key_data']
327	327	DUMMY_KEY1_B64 = base64.standard_b64encode(DUMMY_KEY1).decode('ASCII')
328	328	DUMMY_KEY2 = SUPPORTED_KEYS['rsa']['public_key_data']
329	329	DUMMY_KEY2_B64 = base64.standard_b64encode(DUMMY_KEY2).decode('ASCII')
330		-DUMMY_CONFIG_SETTINGS = {"length": 10, "upper": 1, "lower": 1, "repeat": 5,
331		- "number": 1, "space": 1, "dash": 1, "symbol": 1}
	330	+DUMMY_CONFIG_SETTINGS = {
	331	+ 'length': 10,
	332	+ 'upper': 1,
	333	+ 'lower': 1,
	334	+ 'repeat': 5,
	335	+ 'number': 1,
	336	+ 'space': 1,
	337	+ 'dash': 1,
	338	+ 'symbol': 1,
	339	+}
332	340	DUMMY_RESULT_PASSPHRASE = b'.2V_QJkd o'
333	341	DUMMY_RESULT_KEY1 = b'E<b<{ -7iG'
334	342	DUMMY_PHRASE_FROM_KEY1_RAW = (
...	...	@@ -341,30 +349,40 @@ DUMMY_PHRASE_FROM_KEY1_RAW = (
341	349	DUMMY_PHRASE_FROM_KEY1 = b'8JgZgGwal9UmA27M42WPhmYHExkTCSEzM/nkNlMdr/0NCB/s+HObjF9VORZ8U1QsHlK7MO1/ieIvaVFV2J6mAg==' # noqa: E501
342	350
343	351	skip_if_no_agent = pytest.mark.skipif(
344		- not os.environ.get('SSH_AUTH_SOCK'), reason='running SSH agent required')
	352	+ not os.environ.get('SSH_AUTH_SOCK'), reason='running SSH agent required'
	353	+)
	354	+
345	355
346	356	def list_keys(
347	357	self: Any = None,
348	358	) -> list[ssh_agent_client.types.KeyCommentPair]:
349	359	del self # Unused.
350	360	Pair = ssh_agent_client.types.KeyCommentPair # noqa: N806
351		- list1 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
352		- for key, value in SUPPORTED_KEYS.items()]
353		- list2 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
354		- for key, value in UNSUITABLE_KEYS.items()]
	361	+ list1 = [
	362	+ Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
	363	+ for key, value in SUPPORTED_KEYS.items()
	364	+ ]
	365	+ list2 = [
	366	+ Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
	367	+ for key, value in UNSUITABLE_KEYS.items()
	368	+ ]
355	369	return list1 + list2
356	370
	371	+
357	372	def list_keys_singleton(
358	373	self: Any = None,
359	374	) -> list[ssh_agent_client.types.KeyCommentPair]:
360	375	del self # Unused.
361	376	Pair = ssh_agent_client.types.KeyCommentPair # noqa: N806
362		- list1 = [Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
363		- for key, value in SUPPORTED_KEYS.items()]
	377	+ list1 = [
	378	+ Pair(value['public_key_data'], f'{key} test key'.encode('ASCII'))
	379	+ for key, value in SUPPORTED_KEYS.items()
	380	+ ]
364	381	return list1[:1]
365	382
	383	+
366	384	def suitable_ssh_keys(
367		- conn: Any
	385	+ conn: Any,
368	386	) -> Iterator[ssh_agent_client.types.KeyCommentPair]:
369	387	del conn # Unused.
370	388	yield from [
...	...	@@ -377,9 +396,12 @@ def phrase_from_key(key: bytes) -> bytes:
377	396	return DUMMY_PHRASE_FROM_KEY1
378	397	raise KeyError(key) # pragma: no cover
379	398
	399	+
380	400	@contextlib.contextmanager
381	401	def isolated_config(
382		- monkeypatch: Any, runner: click.testing.CliRunner, config: Any,
	402	+ monkeypatch: Any,
	403	+ runner: click.testing.CliRunner,
	404	+ config: Any,
383	405	):
384	406	prog_name = derivepassphrase.cli.PROG_NAME
385	407	env_name = prog_name.replace(' ', '_').upper() + '_PATH'
...	...	@@ -393,7 +415,8 @@ def isolated_config(
393	415	)
394	416	with open(
395	417	derivepassphrase.cli._config_filename(),
396		- 'w', encoding='UTF-8',
	418	+ 'w',
	419	+ encoding='UTF-8',
397	420	) as outfile:
398	421	json.dump(config, outfile)
399	422	yield

...	...	@@ -15,115 +15,149 @@ import derivepassphrase
15	15
16	16	Vault = derivepassphrase.Vault
17	17
18		-class TestVault:
19	18
	19	+class TestVault:
20	20	phrase = b'She cells C shells bye the sea shoars'
21	21	google_phrase = rb': 4TVH#5:aZl8LueOT\{'
22	22	twitter_phrase = rb"[ (HN_N:lI&<ro=)3'g9"
23	23
24		- @pytest.mark.parametrize(['service', 'expected'], [
	24	+ @pytest.mark.parametrize(
	25	+ ['service', 'expected'],
	26	+ [
25	27	(b'google', google_phrase),
26	28	('twitter', twitter_phrase),
27		- ])
	29	+ ],
	30	+ )
28	31	def test_200_basic_configuration(self, service, expected):
29	32	assert Vault(phrase=self.phrase).generate(service) == expected
30	33
31	34	def test_201_phrase_dependence(self):
32	35	assert (
33		- Vault(phrase=(self.phrase + b'X')).generate('google') ==
34		- b'n+oIz6sL>K*lTEWYRO%7'
	36	+ Vault(phrase=(self.phrase + b'X')).generate('google')
	37	+ == b'n+oIz6sL>K*lTEWYRO%7'
35	38	)
36	39
37	40	def test_202_reproducibility_and_bytes_service_name(self):
38		- assert (
39		- Vault(phrase=self.phrase).generate(b'google') ==
40		- Vault(phrase=self.phrase).generate('google')
41		- )
	41	+ assert Vault(phrase=self.phrase).generate(b'google') == Vault(
	42	+ phrase=self.phrase
	43	+ ).generate('google')
42	44
43	45	def test_203_reproducibility_and_bytearray_service_name(self):
44		- assert (
45		- Vault(phrase=self.phrase).generate(b'google') ==
46		- Vault(phrase=self.phrase).generate(bytearray(b'google'))
47		- )
	46	+ assert Vault(phrase=self.phrase).generate(b'google') == Vault(
	47	+ phrase=self.phrase
	48	+ ).generate(bytearray(b'google'))
48	49
49	50	def test_210_nonstandard_length(self):
50	51	assert (
51		- Vault(phrase=self.phrase, length=4).generate('google')
52		- == b'xDFu'
	52	+ Vault(phrase=self.phrase, length=4).generate('google') == b'xDFu'
53	53	)
54	54
55	55	def test_211_repetition_limit(self):
56	56	assert (
57		- Vault(phrase=b'', length=24, symbol=0, number=0,
58		- repeat=1).generate('asd') ==
59		- b'IVTDzACftqopUXqDHPkuCIhV'
	57	+ Vault(
	58	+ phrase=b'', length=24, symbol=0, number=0, repeat=1
	59	+ ).generate('asd')
	60	+ == b'IVTDzACftqopUXqDHPkuCIhV'
60	61	)
61	62
62	63	def test_212_without_symbols(self):
63	64	assert (
64		- Vault(phrase=self.phrase, symbol=0).generate('google') ==
65		- b'XZ4wRe0bZCazbljCaMqR'
	65	+ Vault(phrase=self.phrase, symbol=0).generate('google')
	66	+ == b'XZ4wRe0bZCazbljCaMqR'
66	67	)
67	68
68	69	def test_213_no_numbers(self):
69	70	assert (
70		- Vault(phrase=self.phrase, number=0).generate('google') ==
71		- b'_*$TVH.%^aZl(LUeOT?>'
	71	+ Vault(phrase=self.phrase, number=0).generate('google')
	72	+ == b'_*$TVH.%^aZl(LUeOT?>'
72	73	)
73	74
74	75	def test_214_no_lowercase_letters(self):
75	76	assert (
76		- Vault(phrase=self.phrase, lower=0).generate('google') ==
77		- b':{?)+7~@OA:L]!0E$)(+'
	77	+ Vault(phrase=self.phrase, lower=0).generate('google')
	78	+ == b':{?)+7~@OA:L]!0E$)(+'
78	79	)
79	80
80	81	def test_215_at_least_5_digits(self):
81	82	assert (
82		- Vault(phrase=self.phrase, length=8, number=5)
83		- .generate('songkick') == b'i0908.7['
	83	+ Vault(phrase=self.phrase, length=8, number=5).generate('songkick')
	84	+ == b'i0908.7['
84	85	)
85	86
86	87	def test_216_lots_of_spaces(self):
87	88	assert (
88		- Vault(phrase=self.phrase, space=12)
89		- .generate('songkick') == b' c 6 Bq % 5fR '
	89	+ Vault(phrase=self.phrase, space=12).generate('songkick')
	90	+ == b' c 6 Bq % 5fR '
90	91	)
91	92
92	93	def test_217_all_character_classes(self):
93	94	assert (
94		- Vault(phrase=self.phrase, lower=2, upper=2, number=1,
95		- space=3, dash=2, symbol=1)
96		- .generate('google') == b': : fv_wqt>a-4w1S R'
	95	+ Vault(
	96	+ phrase=self.phrase,
	97	+ lower=2,
	98	+ upper=2,
	99	+ number=1,
	100	+ space=3,
	101	+ dash=2,
	102	+ symbol=1,
	103	+ ).generate('google')
	104	+ == b': : fv_wqt>a-4w1S R'
97	105	)
98	106
99	107	def test_218_only_numbers_and_very_high_repetition_limit(self):
100		- generated = Vault(phrase=b'', length=40, lower=0, upper=0, space=0,
101		- dash=0, symbol=0, repeat=4).generate('abcdef')
102		- forbidden_substrings = {b'0000', b'1111', b'2222', b'3333', b'4444',
103		- b'5555', b'6666', b'7777', b'8888', b'9999'}
	108	+ generated = Vault(
	109	+ phrase=b'',
	110	+ length=40,
	111	+ lower=0,
	112	+ upper=0,
	113	+ space=0,
	114	+ dash=0,
	115	+ symbol=0,
	116	+ repeat=4,
	117	+ ).generate('abcdef')
	118	+ forbidden_substrings = {
	119	+ b'0000',
	120	+ b'1111',
	121	+ b'2222',
	122	+ b'3333',
	123	+ b'4444',
	124	+ b'5555',
	125	+ b'6666',
	126	+ b'7777',
	127	+ b'8888',
	128	+ b'9999',
	129	+ }
104	130	for substring in forbidden_substrings:
105	131	assert substring not in generated
106	132
107	133	def test_219_very_limited_character_set(self):
108		- generated = Vault(phrase=b'', length=24, lower=0, upper=0,
109		- space=0, symbol=0).generate('testing')
	134	+ generated = Vault(
	135	+ phrase=b'', length=24, lower=0, upper=0, space=0, symbol=0
	136	+ ).generate('testing')
110	137	assert generated == b'763252593304946694588866'
111	138
112	139	def test_220_character_set_subtraction(self):
113	140	assert Vault._subtract(b'be', b'abcdef') == bytearray(b'acdf')
114	141
115		- @pytest.mark.parametrize(['length', 'settings', 'entropy'], [
	142	+ @pytest.mark.parametrize(
	143	+ ['length', 'settings', 'entropy'],
	144	+ [
116	145	(20, {}, math.log2(math.factorial(20)) + 20 * math.log2(94)),
117	146	(
118	147	20,
119	148	{'upper': 0, 'number': 0, 'space': 0, 'symbol': 0},
120		- math.log2(math.factorial(20)) + 20 * math.log2(26)
	149	+ math.log2(math.factorial(20)) + 20 * math.log2(26),
121	150	),
122	151	(0, {}, float('-inf')),
123		- (0, {'lower': 0, 'number': 0, 'space': 0, 'symbol': 0}, float('-inf')),
	152	+ (
	153	+ 0,
	154	+ {'lower': 0, 'number': 0, 'space': 0, 'symbol': 0},
	155	+ float('-inf'),
	156	+ ),
124	157	(1, {}, math.log2(94)),
125	158	(1, {'upper': 0, 'lower': 0, 'number': 0, 'symbol': 0}, 0.0),
126		- ])
	159	+ ],
	160	+ )
127	161	def test_221_entropy(
128	162	self, length: int, settings: dict[str, int], entropy: int
129	163	) -> None:
...	...	@@ -131,38 +165,54 @@ class TestVault:
131	165	assert math.isclose(v._entropy(), entropy)
132	166	assert v._estimate_sufficient_hash_length() > 0
133	167	if math.isfinite(entropy) and entropy:
134		- assert (
135		- v._estimate_sufficient_hash_length(1.0) ==
136		- math.ceil(entropy / 8)
	168	+ assert v._estimate_sufficient_hash_length(1.0) == math.ceil(
	169	+ entropy / 8
137	170	)
138	171	assert v._estimate_sufficient_hash_length(8.0) >= entropy
139	172
140	173	def test_222_hash_length_estimation(self) -> None:
141		- v = Vault(phrase=self.phrase, lower=0, upper=0, number=0,
142		- symbol=0, space=1, length=1)
	174	+ v = Vault(
	175	+ phrase=self.phrase,
	176	+ lower=0,
	177	+ upper=0,
	178	+ number=0,
	179	+ symbol=0,
	180	+ space=1,
	181	+ length=1,
	182	+ )
143	183	assert v._entropy() == 0.0
144	184	assert v._estimate_sufficient_hash_length() > 0
145	185
146		- @pytest.mark.parametrize(['service', 'expected'], [
	186	+ @pytest.mark.parametrize(
	187	+ ['service', 'expected'],
	188	+ [
147	189	(b'google', google_phrase),
148	190	('twitter', twitter_phrase),
149		- ])
	191	+ ],
	192	+ )
150	193	def test_223_hash_length_expansion(
151	194	self, monkeypatch: Any, service: str \| bytes, expected: bytes
152	195	) -> None:
153	196	v = Vault(phrase=self.phrase)
154		- monkeypatch.setattr(v,
	197	+ monkeypatch.setattr(
	198	+ v,
155	199	'_estimate_sufficient_hash_length',
156		- lambda args, *kwargs: 1) # noqa: ARG005
	200	+ lambda args, *kwargs: 1, # noqa: ARG005
	201	+ )
157	202	assert v._estimate_sufficient_hash_length() < len(self.phrase)
158	203	assert v.generate(service) == expected
159	204
160		- @pytest.mark.parametrize(['s', 'raises'], [
161		- ('ñ', True), ('Düsseldorf', True),
162		- ('liberté, egalité, fraternité', True), ('ASCII', False),
	205	+ @pytest.mark.parametrize(
	206	+ ['s', 'raises'],
	207	+ [
	208	+ ('ñ', True),
	209	+ ('Düsseldorf', True),
	210	+ ('liberté, egalité, fraternité', True),
	211	+ ('ASCII', False),
163	212	(b'D\xc3\xbcsseldorf', False),
164	213	(bytearray([2, 3, 5, 7, 11, 13]), False),
165		- ])
	214	+ ],
	215	+ )
166	216	def test_224_binary_strings(
167	217	self, s: str \| bytes \| bytearray, raises: bool
168	218	) -> None:
...	...	@@ -181,15 +231,22 @@ class TestVault:
181	231	assert binstr(binstr(s)) == bytes(s)
182	232
183	233	def test_310_too_many_symbols(self):
184		- with pytest.raises(ValueError,
185		- match='requested passphrase length too short'):
	234	+ with pytest.raises(
	235	+ ValueError, match='requested passphrase length too short'
	236	+ ):
186	237	Vault(phrase=self.phrase, symbol=100)
187	238
188	239	def test_311_no_viable_characters(self):
189		- with pytest.raises(ValueError,
190		- match='no allowed characters left'):
191		- Vault(phrase=self.phrase, lower=0, upper=0, number=0,
192		- space=0, dash=0, symbol=0)
	240	+ with pytest.raises(ValueError, match='no allowed characters left'):
	241	+ Vault(
	242	+ phrase=self.phrase,
	243	+ lower=0,
	244	+ upper=0,
	245	+ number=0,
	246	+ space=0,
	247	+ dash=0,
	248	+ symbol=0,
	249	+ )
193	250
194	251	def test_320_character_set_subtraction_duplicate(self):
195	252	with pytest.raises(ValueError, match='duplicate characters'):
...	...	@@ -199,9 +256,9 @@ class TestVault:
199	256
200	257	def test_322_hash_length_estimation(self) -> None:
201	258	v = Vault(phrase=self.phrase)
202		- with pytest.raises(ValueError,
203		- match='invalid safety factor'):
	259	+ with pytest.raises(ValueError, match='invalid safety factor'):
204	260	assert v._estimate_sufficient_hash_length(-1.0)
205		- with pytest.raises(TypeError,
206		- match='invalid safety factor: not a float'):
	261	+ with pytest.raises(
	262	+ TypeError, match='invalid safety factor: not a float'
	263	+ ):
207	264	assert v._estimate_sufficient_hash_length(None) # type: ignore

...	...	@@ -10,47 +10,88 @@ from typing_extensions import Any
10	10	import derivepassphrase.types
11	11
12	12
13		-@pytest.mark.parametrize(['obj', 'comment'], [
	13	+@pytest.mark.parametrize(
	14	+ ['obj', 'comment'],
	15	+ [
14	16	(None, 'not a dict'),
15	17	({}, 'missing required keys'),
16	18	({'global': None, 'services': {}}, 'bad config value: global'),
17		- ({'global': {'key': 123}, 'services': {}},
18		- 'bad config value: global.key'),
19		- ({'global': {'phrase': 'abc', 'key': '...'}, 'services': {}},
20		- 'incompatible config values: global.key and global.phrase'),
	19	+ (
	20	+ {'global': {'key': 123}, 'services': {}},
	21	+ 'bad config value: global.key',
	22	+ ),
	23	+ (
	24	+ {'global': {'phrase': 'abc', 'key': '...'}, 'services': {}},
	25	+ 'incompatible config values: global.key and global.phrase',
	26	+ ),
21	27	({'services': None}, 'bad config value: services'),
22	28	({'services': {2: {}}}, 'bad config value: services."2"'),
23	29	({'services': {'2': 2}}, 'bad config value: services."2"'),
24		- ({'services': {'sv': {'notes': False}}},
25		- 'bad config value: services.sv.notes'),
	30	+ (
	31	+ {'services': {'sv': {'notes': False}}},
	32	+ 'bad config value: services.sv.notes',
	33	+ ),
26	34	({'services': {'sv': {'notes': 'blah blah blah'}}}, ''),
27		- ({'services': {'sv': {'length': '200'}}},
28		- 'bad config value: services.sv.length'),
29		- ({'services': {'sv': {'length': 0.5}}},
30		- 'bad config value: services.sv.length'),
31		- ({'services': {'sv': {'length': -10}}},
32		- 'bad config value: services.sv.length'),
33		- ({'services': {'sv': {'upper': -10}}},
34		- 'bad config value: services.sv.upper'),
35		- ({'global': {'phrase': 'my secret phrase'},
36		- 'services': {'sv': {'length': 10}}},
37		- ''),
	35	+ (
	36	+ {'services': {'sv': {'length': '200'}}},
	37	+ 'bad config value: services.sv.length',
	38	+ ),
	39	+ (
	40	+ {'services': {'sv': {'length': 0.5}}},
	41	+ 'bad config value: services.sv.length',
	42	+ ),
	43	+ (
	44	+ {'services': {'sv': {'length': -10}}},
	45	+ 'bad config value: services.sv.length',
	46	+ ),
	47	+ (
	48	+ {'services': {'sv': {'upper': -10}}},
	49	+ 'bad config value: services.sv.upper',
	50	+ ),
	51	+ (
	52	+ {
	53	+ 'global': {'phrase': 'my secret phrase'},
	54	+ 'services': {'sv': {'length': 10}},
	55	+ },
	56	+ '',
	57	+ ),
38	58	({'services': {'sv': {'length': 10, 'phrase': '...'}}}, ''),
39	59	({'services': {'sv': {'length': 10, 'key': '...'}}}, ''),
40	60	({'services': {'sv': {'upper': 10, 'key': '...'}}}, ''),
41		- ({'services': {'sv': {'phrase': 'abc', 'key': '...'}}},
42		- 'incompatible config values: services.sv.key and services.sv.phrase'),
43		- ({'global': {'phrase': 'abc'},
44		- 'services': {'sv': {'phrase': 'abc', 'length': 10}}}, ''),
45		- ({'global': {'key': '...'},
46		- 'services': {'sv': {'phrase': 'abc', 'length': 10}}}, ''),
47		- ({'global': {'key': '...'},
48		- 'services': {'sv1': {'phrase': 'abc', 'length': 10, 'upper': 1},
49		- 'sv2': {'length': 10, 'repeat': 1, 'lower': 1}}}, ''),
50		-])
	61	+ (
	62	+ {'services': {'sv': {'phrase': 'abc', 'key': '...'}}},
	63	+ 'incompatible config values: services.sv.key and services.sv.phrase', # noqa: E501
	64	+ ),
	65	+ (
	66	+ {
	67	+ 'global': {'phrase': 'abc'},
	68	+ 'services': {'sv': {'phrase': 'abc', 'length': 10}},
	69	+ },
	70	+ '',
	71	+ ),
	72	+ (
	73	+ {
	74	+ 'global': {'key': '...'},
	75	+ 'services': {'sv': {'phrase': 'abc', 'length': 10}},
	76	+ },
	77	+ '',
	78	+ ),
	79	+ (
	80	+ {
	81	+ 'global': {'key': '...'},
	82	+ 'services': {
	83	+ 'sv1': {'phrase': 'abc', 'length': 10, 'upper': 1},
	84	+ 'sv2': {'length': 10, 'repeat': 1, 'lower': 1},
	85	+ },
	86	+ },
	87	+ '',
	88	+ ),
	89	+ ],
	90	+)
51	91	def test_200_is_vault_config(obj: Any, comment: str) -> None:
52	92	is_vault_config = derivepassphrase.types.is_vault_config
53	93	assert is_vault_config(obj) == (not comment), (
54		- 'failed to complain about: ' + comment if comment
	94	+ 'failed to complain about: ' + comment
	95	+ if comment
55	96	else 'failed on valid example'
56	97	)

...	...	@@ -12,53 +12,107 @@ import sequin
12	12
13	13
14	14	class TestStaticFunctionality:
15		-
16		- @pytest.mark.parametrize(['sequence', 'base', 'expected'], [
	15	+ @pytest.mark.parametrize(
	16	+ ['sequence', 'base', 'expected'],
	17	+ [
17	18	([1, 2, 3, 4, 5, 6], 10, 123456),
18	19	([1, 2, 3, 4, 5, 6], 100, 10203040506),
19	20	([0, 0, 1, 4, 9, 7], 10, 1497),
20	21	([1, 0, 0, 1, 0, 0, 0, 0], 2, 144),
21	22	([1, 7, 5, 5], 8, 0o1755),
22		- ])
	23	+ ],
	24	+ )
23	25	def test_200_big_endian_number(self, sequence, base, expected):
24	26	assert (
25	27	sequin.Sequin._big_endian_number(sequence, base=base)
26	28	) == expected
27	29
28	30	@pytest.mark.parametrize(
29		- ['exc_type', 'exc_pattern', 'sequence', 'base'], [
	31	+ ['exc_type', 'exc_pattern', 'sequence', 'base'],
	32	+ [
30	33	(ValueError, 'invalid base 3 digit:', [-1], 3),
31	34	(ValueError, 'invalid base:', [0], 1),
32	35	(TypeError, 'not an integer:', [0.0, 1.0, 0.0, 1.0], 2),
33		- ]
	36	+ ],
34	37	)
35		- def test_300_big_endian_number_exceptions(self, exc_type, exc_pattern,
36		- sequence, base):
	38	+ def test_300_big_endian_number_exceptions(
	39	+ self, exc_type, exc_pattern, sequence, base
	40	+ ):
37	41	with pytest.raises(exc_type, match=exc_pattern):
38	42	sequin.Sequin._big_endian_number(sequence, base=base)
39	43
40		-class TestSequin:
41	44
42		- @pytest.mark.parametrize(['sequence', 'is_bitstring', 'expected'], [
43		- ([1, 0, 0, 1, 0, 1], False, [0, 0, 0, 0, 0, 0, 0, 1,
44		- 0, 0, 0, 0, 0, 0, 0, 0,
45		- 0, 0, 0, 0, 0, 0, 0, 0,
46		- 0, 0, 0, 0, 0, 0, 0, 1,
47		- 0, 0, 0, 0, 0, 0, 0, 0,
48		- 0, 0, 0, 0, 0, 0, 0, 1]),
	45	+class TestSequin:
	46	+ @pytest.mark.parametrize(
	47	+ ['sequence', 'is_bitstring', 'expected'],
	48	+ [
	49	+ (
	50	+ [1, 0, 0, 1, 0, 1],
	51	+ False,
	52	+ [
	53	+ 0,
	54	+ 0,
	55	+ 0,
	56	+ 0,
	57	+ 0,
	58	+ 0,
	59	+ 0,
	60	+ 1,
	61	+ 0,
	62	+ 0,
	63	+ 0,
	64	+ 0,
	65	+ 0,
	66	+ 0,
	67	+ 0,
	68	+ 0,
	69	+ 0,
	70	+ 0,
	71	+ 0,
	72	+ 0,
	73	+ 0,
	74	+ 0,
	75	+ 0,
	76	+ 0,
	77	+ 0,
	78	+ 0,
	79	+ 0,
	80	+ 0,
	81	+ 0,
	82	+ 0,
	83	+ 0,
	84	+ 1,
	85	+ 0,
	86	+ 0,
	87	+ 0,
	88	+ 0,
	89	+ 0,
	90	+ 0,
	91	+ 0,
	92	+ 0,
	93	+ 0,
	94	+ 0,
	95	+ 0,
	96	+ 0,
	97	+ 0,
	98	+ 0,
	99	+ 0,
	100	+ 1,
	101	+ ],
	102	+ ),
49	103	([1, 0, 0, 1, 0, 1], True, [1, 0, 0, 1, 0, 1]),
50		- (b'OK', False, [0, 1, 0, 0, 1, 1, 1, 1,
51		- 0, 1, 0, 0, 1, 0, 1, 1]),
52		- ('OK', False, [0, 1, 0, 0, 1, 1, 1, 1,
53		- 0, 1, 0, 0, 1, 0, 1, 1]),
54		- ])
	104	+ (b'OK', False, [0, 1, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1, 0, 1, 1]),
	105	+ ('OK', False, [0, 1, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1, 0, 1, 1]),
	106	+ ],
	107	+ )
55	108	def test_200_constructor(self, sequence, is_bitstring, expected):
56	109	seq = sequin.Sequin(sequence, is_bitstring=is_bitstring)
57	110	assert seq.bases == {2: collections.deque(expected)}
58	111
59	112	def test_201_generating(self):
60		- seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
61		- is_bitstring=True)
	113	+ seq = sequin.Sequin(
	114	+ [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
	115	+ )
62	116	assert seq.generate(1) == 0
63	117	assert seq.generate(5) == 3
64	118	assert seq.generate(5) == 3
...	...	@@ -67,21 +121,24 @@ class TestSequin:
67	121	seq.generate(5)
68	122	with pytest.raises(sequin.SequinExhaustedError):
69	123	seq.generate(1)
70		- seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
71		- is_bitstring=True)
	124	+ seq = sequin.Sequin(
	125	+ [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
	126	+ )
72	127	with pytest.raises(ValueError, match='invalid target range'):
73	128	seq.generate(0)
74	129
75	130	def test_210_internal_generating(self):
76		- seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
77		- is_bitstring=True)
	131	+ seq = sequin.Sequin(
	132	+ [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
	133	+ )
78	134	assert seq._generate_inner(5) == 3
79	135	assert seq._generate_inner(5) == 3
80	136	assert seq._generate_inner(5) == 1
81	137	assert seq._generate_inner(5) == 5
82	138	assert seq._generate_inner(1) == 0
83		- seq = sequin.Sequin([1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1],
84		- is_bitstring=True)
	139	+ seq = sequin.Sequin(
	140	+ [1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1], is_bitstring=True
	141	+ )
85	142	assert seq._generate_inner(1) == 0
86	143	with pytest.raises(ValueError, match='invalid target range'):
87	144	seq._generate_inner(0)
...	...	@@ -90,8 +147,9 @@ class TestSequin:
90	147
91	148	def test_211_shifting(self):
92	149	seq = sequin.Sequin([1, 0, 1, 0, 0, 1, 0, 0, 0, 1], is_bitstring=True)
93		- assert seq.bases == {2: collections.deque([
94		- 1, 0, 1, 0, 0, 1, 0, 0, 0, 1])}
	150	+ assert seq.bases == {
	151	+ 2: collections.deque([1, 0, 1, 0, 0, 1, 0, 0, 0, 1])
	152	+ }
95	153
96	154	assert seq._all_or_nothing_shift(3) == (1, 0, 1)
97	155	assert seq._all_or_nothing_shift(3) == (0, 0, 1)
...	...	@@ -106,13 +164,17 @@ class TestSequin:
106	164	@pytest.mark.parametrize(
107	165	['sequence', 'is_bitstring', 'exc_type', 'exc_pattern'],
108	166	[
109		- ([0, 1, 2, 3, 4, 5, 6, 7], True,
110		- ValueError, 'sequence item out of range'),
111		- ('こんにちは。', False,
112		- ValueError, 'sequence item out of range'),
113		- ]
	167	+ (
	168	+ [0, 1, 2, 3, 4, 5, 6, 7],
	169	+ True,
	170	+ ValueError,
	171	+ 'sequence item out of range',
	172	+ ),
	173	+ ('こんにちは。', False, ValueError, 'sequence item out of range'),
	174	+ ],
114	175	)
115		- def test_300_constructor_exceptions(self, sequence, is_bitstring,
116		- exc_type, exc_pattern):
	176	+ def test_300_constructor_exceptions(
	177	+ self, sequence, is_bitstring, exc_type, exc_pattern
	178	+ ):
117	179	with pytest.raises(exc_type, match=exc_pattern):
118	180	sequin.Sequin(sequence, is_bitstring=is_bitstring)

...	...	@@ -24,10 +24,13 @@ import tests
24	24
25	25
26	26	class TestStaticFunctionality:
27		-
28		- @pytest.mark.parametrize(['public_key', 'public_key_data'],
29		- [(val['public_key'], val['public_key_data'])
30		- for val in tests.SUPPORTED_KEYS.values()])
	27	+ @pytest.mark.parametrize(
	28	+ ['public_key', 'public_key_data'],
	29	+ [
	30	+ (val['public_key'], val['public_key_data'])
	31	+ for val in tests.SUPPORTED_KEYS.values()
	32	+ ],
	33	+ )
31	34	def test_100_key_decoding(self, public_key, public_key_data):
32	35	keydata = base64.b64decode(public_key.split(None, 2)[1])
33	36	assert (
...	...	@@ -37,77 +40,101 @@ class TestStaticFunctionality:
37	40	def test_200_constructor_no_running_agent(self, monkeypatch):
38	41	monkeypatch.delenv('SSH_AUTH_SOCK', raising=False)
39	42	sock = socket.socket(family=socket.AF_UNIX)
40		- with pytest.raises(KeyError,
41		- match='SSH_AUTH_SOCK environment variable'):
	43	+ with pytest.raises(
	44	+ KeyError, match='SSH_AUTH_SOCK environment variable'
	45	+ ):
42	46	ssh_agent_client.SSHAgentClient(socket=sock)
43	47
44		- @pytest.mark.parametrize(['input', 'expected'], [
	48	+ @pytest.mark.parametrize(
	49	+ ['input', 'expected'],
	50	+ [
45	51	(16777216, b'\x01\x00\x00\x00'),
46		- ])
	52	+ ],
	53	+ )
47	54	def test_210_uint32(self, input, expected):
48	55	uint32 = ssh_agent_client.SSHAgentClient.uint32
49	56	assert uint32(input) == expected
50	57
51		- @pytest.mark.parametrize(['input', 'expected'], [
	58	+ @pytest.mark.parametrize(
	59	+ ['input', 'expected'],
	60	+ [
52	61	(b'ssh-rsa', b'\x00\x00\x00\x07ssh-rsa'),
53	62	(b'ssh-ed25519', b'\x00\x00\x00\x0bssh-ed25519'),
54	63	(
55	64	ssh_agent_client.SSHAgentClient.string(b'ssh-ed25519'),
56	65	b'\x00\x00\x00\x0f\x00\x00\x00\x0bssh-ed25519',
57	66	),
58		- ])
	67	+ ],
	68	+ )
59	69	def test_211_string(self, input, expected):
60	70	string = ssh_agent_client.SSHAgentClient.string
61	71	assert bytes(string(input)) == expected
62	72
63		- @pytest.mark.parametrize(['input', 'expected'], [
	73	+ @pytest.mark.parametrize(
	74	+ ['input', 'expected'],
	75	+ [
64	76	(b'\x00\x00\x00\x07ssh-rsa', b'ssh-rsa'),
65	77	(
66	78	ssh_agent_client.SSHAgentClient.string(b'ssh-ed25519'),
67	79	b'ssh-ed25519',
68	80	),
69		- ])
	81	+ ],
	82	+ )
70	83	def test_212_unstring(self, input, expected):
71	84	unstring = ssh_agent_client.SSHAgentClient.unstring
72	85	unstring_prefix = ssh_agent_client.SSHAgentClient.unstring_prefix
73	86	assert bytes(unstring(input)) == expected
74		- assert tuple(
75		- bytes(x) for x in unstring_prefix(input)
76		- ) == (expected, b'')
	87	+ assert tuple(bytes(x) for x in unstring_prefix(input)) == (
	88	+ expected,
	89	+ b'',
	90	+ )
77	91
78		- @pytest.mark.parametrize(['value', 'exc_type', 'exc_pattern'], [
	92	+ @pytest.mark.parametrize(
	93	+ ['value', 'exc_type', 'exc_pattern'],
	94	+ [
79	95	(10000000000000000, OverflowError, 'int too big to convert'),
80	96	(-1, OverflowError, "can't convert negative int to unsigned"),
81		- ])
	97	+ ],
	98	+ )
82	99	def test_310_uint32_exceptions(self, value, exc_type, exc_pattern):
83	100	uint32 = ssh_agent_client.SSHAgentClient.uint32
84	101	with pytest.raises(exc_type, match=exc_pattern):
85	102	uint32(value)
86	103
87		- @pytest.mark.parametrize(['input', 'exc_type', 'exc_pattern'], [
	104	+ @pytest.mark.parametrize(
	105	+ ['input', 'exc_type', 'exc_pattern'],
	106	+ [
88	107	('some string', TypeError, 'invalid payload type'),
89		- ])
	108	+ ],
	109	+ )
90	110	def test_311_string_exceptions(self, input, exc_type, exc_pattern):
91	111	string = ssh_agent_client.SSHAgentClient.string
92	112	with pytest.raises(exc_type, match=exc_pattern):
93	113	string(input)
94	114
95	115	@pytest.mark.parametrize(
96		- ['input', 'exc_type', 'exc_pattern', 'has_trailer', 'parts'], [
	116	+ ['input', 'exc_type', 'exc_pattern', 'has_trailer', 'parts'],
	117	+ [
97	118	(b'ssh', ValueError, 'malformed SSH byte string', False, None),
98	119	(
99	120	b'\x00\x00\x00\x08ssh-rsa',
100		- ValueError, 'malformed SSH byte string',
101		- False, None,
	121	+ ValueError,
	122	+ 'malformed SSH byte string',
	123	+ False,
	124	+ None,
102	125	),
103	126	(
104	127	b'\x00\x00\x00\x04XXX trailing text',
105		- ValueError, 'malformed SSH byte string',
106		- True, (b'XXX ', b'trailing text'),
	128	+ ValueError,
	129	+ 'malformed SSH byte string',
	130	+ True,
	131	+ (b'XXX ', b'trailing text'),
107	132	),
108		- ])
109		- def test_312_unstring_exceptions(self, input, exc_type, exc_pattern,
110		- has_trailer, parts):
	133	+ ],
	134	+ )
	135	+ def test_312_unstring_exceptions(
	136	+ self, input, exc_type, exc_pattern, has_trailer, parts
	137	+ ):
111	138	unstring = ssh_agent_client.SSHAgentClient.unstring
112	139	unstring_prefix = ssh_agent_client.SSHAgentClient.unstring_prefix
113	140	with pytest.raises(exc_type, match=exc_pattern):
...	...	@@ -118,22 +145,26 @@ class TestStaticFunctionality:
118	145	with pytest.raises(exc_type, match=exc_pattern):
119	146	unstring_prefix(input)
120	147
	148	+
121	149	@tests.skip_if_no_agent
122	150	class TestAgentInteraction:
123		-
124		- @pytest.mark.parametrize(['keytype', 'data_dict'],
125		- list(tests.SUPPORTED_KEYS.items()))
	151	+ @pytest.mark.parametrize(
	152	+ ['keytype', 'data_dict'], list(tests.SUPPORTED_KEYS.items())
	153	+ )
126	154	def test_200_sign_data_via_agent(self, keytype, data_dict):
127	155	del keytype # Unused.
128	156	private_key = data_dict['private_key']
129	157	try:
130		- _ = subprocess.run(['ssh-add', '-t', '30', '-q', '-'],
131		- input=private_key, check=True,
132		- capture_output=True)
	158	+ _ = subprocess.run(
	159	+ ['ssh-add', '-t', '30', '-q', '-'],
	160	+ input=private_key,
	161	+ check=True,
	162	+ capture_output=True,
	163	+ )
133	164	except subprocess.CalledProcessError as e:
134	165	pytest.skip(
135		- f"uploading test key: {e!r}, stdout={e.stdout!r}, "
136		- f"stderr={e.stderr!r}"
	166	+ f'uploading test key: {e!r}, stdout={e.stdout!r}, '
	167	+ f'stderr={e.stderr!r}'
137	168	)
138	169	else:
139	170	try:
...	...	@@ -141,37 +172,48 @@ class TestAgentInteraction:
141	172	except OSError: # pragma: no cover
142	173	pytest.skip('communication error with the SSH agent')
143	174	with client:
144		- key_comment_pairs = {bytes(k): bytes(c)
145		- for k, c in client.list_keys()}
	175	+ key_comment_pairs = {
	176	+ bytes(k): bytes(c) for k, c in client.list_keys()
	177	+ }
146	178	public_key_data = data_dict['public_key_data']
147	179	expected_signature = data_dict['expected_signature']
148	180	derived_passphrase = data_dict['derived_passphrase']
149	181	if public_key_data not in key_comment_pairs: # pragma: no cover
150	182	pytest.skip('prerequisite SSH key not loaded')
151		- signature = bytes(client.sign(
152		- payload=derivepassphrase.Vault._UUID, key=public_key_data))
	183	+ signature = bytes(
	184	+ client.sign(
	185	+ payload=derivepassphrase.Vault._UUID, key=public_key_data
	186	+ )
	187	+ )
153	188	assert signature == expected_signature, 'SSH signature mismatch'
154		- signature2 = bytes(client.sign(
155		- payload=derivepassphrase.Vault._UUID, key=public_key_data))
	189	+ signature2 = bytes(
	190	+ client.sign(
	191	+ payload=derivepassphrase.Vault._UUID, key=public_key_data
	192	+ )
	193	+ )
156	194	assert signature2 == expected_signature, 'SSH signature mismatch'
157	195	assert (
158		- derivepassphrase.Vault.phrase_from_key(public_key_data) ==
159		- derived_passphrase
	196	+ derivepassphrase.Vault.phrase_from_key(public_key_data)
	197	+ == derived_passphrase
160	198	), 'SSH signature mismatch'
161	199
162		- @pytest.mark.parametrize(['keytype', 'data_dict'],
163		- list(tests.UNSUITABLE_KEYS.items()))
	200	+ @pytest.mark.parametrize(
	201	+ ['keytype', 'data_dict'], list(tests.UNSUITABLE_KEYS.items())
	202	+ )
164	203	def test_201_sign_data_via_agent_unsupported(self, keytype, data_dict):
165	204	del keytype # Unused.
166	205	private_key = data_dict['private_key']
167	206	try:
168		- _ = subprocess.run(['ssh-add', '-t', '30', '-q', '-'],
169		- input=private_key, check=True,
170		- capture_output=True)
	207	+ _ = subprocess.run(
	208	+ ['ssh-add', '-t', '30', '-q', '-'],
	209	+ input=private_key,
	210	+ check=True,
	211	+ capture_output=True,
	212	+ )
171	213	except subprocess.CalledProcessError as e: # pragma: no cover
172	214	pytest.skip(
173		- f"uploading test key: {e!r}, stdout={e.stdout!r}, "
174		- f"stderr={e.stderr!r}"
	215	+ f'uploading test key: {e!r}, stdout={e.stdout!r}, '
	216	+ f'stderr={e.stderr!r}'
175	217	)
176	218	else:
177	219	try:
...	...	@@ -179,16 +221,23 @@ class TestAgentInteraction:
179	221	except OSError: # pragma: no cover
180	222	pytest.skip('communication error with the SSH agent')
181	223	with client:
182		- key_comment_pairs = {bytes(k): bytes(c)
183		- for k, c in client.list_keys()}
	224	+ key_comment_pairs = {
	225	+ bytes(k): bytes(c) for k, c in client.list_keys()
	226	+ }
184	227	public_key_data = data_dict['public_key_data']
185	228	_ = data_dict['expected_signature']
186	229	if public_key_data not in key_comment_pairs: # pragma: no cover
187	230	pytest.skip('prerequisite SSH key not loaded')
188		- signature = bytes(client.sign(
189		- payload=derivepassphrase.Vault._UUID, key=public_key_data))
190		- signature2 = bytes(client.sign(
191		- payload=derivepassphrase.Vault._UUID, key=public_key_data))
	231	+ signature = bytes(
	232	+ client.sign(
	233	+ payload=derivepassphrase.Vault._UUID, key=public_key_data
	234	+ )
	235	+ )
	236	+ signature2 = bytes(
	237	+ client.sign(
	238	+ payload=derivepassphrase.Vault._UUID, key=public_key_data
	239	+ )
	240	+ )
192	241	assert signature != signature2, 'SSH signature repeatable?!'
193	242	with pytest.raises(ValueError, match='unsuitable SSH key'):
194	243	derivepassphrase.Vault.phrase_from_key(public_key_data)
...	...	@@ -207,20 +256,32 @@ class TestAgentInteraction:
207	256	@pytest.mark.parametrize(['key', 'single'], list(_params()))
208	257	def test_210_ssh_key_selector(self, monkeypatch, key, single):
209	258	def key_is_suitable(key: bytes):
210		- return key in {v['public_key_data']
211		- for v in tests.SUPPORTED_KEYS.values()}
	259	+ return key in {
	260	+ v['public_key_data'] for v in tests.SUPPORTED_KEYS.values()
	261	+ }
	262	+
212	263	if single:
213		- monkeypatch.setattr(ssh_agent_client.SSHAgentClient,
214		- 'list_keys', tests.list_keys_singleton)
215		- keys = [pair.key for pair in tests.list_keys_singleton()
216		- if key_is_suitable(pair.key)]
	264	+ monkeypatch.setattr(
	265	+ ssh_agent_client.SSHAgentClient,
	266	+ 'list_keys',
	267	+ tests.list_keys_singleton,
	268	+ )
	269	+ keys = [
	270	+ pair.key
	271	+ for pair in tests.list_keys_singleton()
	272	+ if key_is_suitable(pair.key)
	273	+ ]
217	274	index = '1'
218	275	text = 'Use this key? yes\n'
219	276	else:
220		- monkeypatch.setattr(ssh_agent_client.SSHAgentClient,
221		- 'list_keys', tests.list_keys)
222		- keys = [pair.key for pair in tests.list_keys()
223		- if key_is_suitable(pair.key)]
	277	+ monkeypatch.setattr(
	278	+ ssh_agent_client.SSHAgentClient, 'list_keys', tests.list_keys
	279	+ )
	280	+ keys = [
	281	+ pair.key
	282	+ for pair in tests.list_keys()
	283	+ if key_is_suitable(pair.key)
	284	+ ]
224	285	index = str(1 + keys.index(key))
225	286	n = len(keys)
226	287	text = f'Your selection? (1-{n}, leave empty to abort): {index}\n'
...	...	@@ -232,31 +293,36 @@ class TestAgentInteraction:
232	293	click.echo(base64.standard_b64encode(key).decode('ASCII'))
233	294
234	295	runner = click.testing.CliRunner(mix_stderr=True)
235		- result = runner.invoke(driver, [],
	296	+ result = runner.invoke(
	297	+ driver,
	298	+ [],
236	299	input=('yes\n' if single else f'{index}\n'),
237		- catch_exceptions=True)
238		- assert result.stdout.startswith('Suitable SSH keys:\n'), (
239		- 'missing expected output'
	300	+ catch_exceptions=True,
240	301	)
	302	+ assert result.stdout.startswith(
	303	+ 'Suitable SSH keys:\n'
	304	+ ), 'missing expected output'
241	305	assert text in result.stdout, 'missing expected output'
242		- assert (
243		- result.stdout.endswith(f'\n{b64_key}\n')
	306	+ assert result.stdout.endswith(
	307	+ f'\n{b64_key}\n'
244	308	), 'missing expected output'
245	309	assert result.exit_code == 0, 'driver program failed?!'
246	310
247	311	del _params
248	312
249	313	def test_300_constructor_bad_running_agent(self, monkeypatch):
250		- monkeypatch.setenv('SSH_AUTH_SOCK',
251		- os.environ['SSH_AUTH_SOCK'] + '~')
	314	+ monkeypatch.setenv('SSH_AUTH_SOCK', os.environ['SSH_AUTH_SOCK'] + '~')
252	315	sock = socket.socket(family=socket.AF_UNIX)
253	316	with pytest.raises(OSError): # noqa: PT011
254	317	ssh_agent_client.SSHAgentClient(socket=sock)
255	318
256		- @pytest.mark.parametrize('response', [
	319	+ @pytest.mark.parametrize(
	320	+ 'response',
	321	+ [
257	322	b'\x00\x00',
258	323	b'\x00\x00\x00\x1f some bytes missing',
259		- ])
	324	+ ],
	325	+ )
260	326	def test_310_truncated_server_response(self, monkeypatch, response):
261	327	client = ssh_agent_client.SSHAgentClient()
262	328	response_stream = io.BytesIO(response)
...	...	@@ -282,13 +351,17 @@ class TestAgentInteraction:
282	351	ssh_agent_client.TrailingDataError,
283	352	'Overlong response',
284	353	),
285		- ]
	354	+ ],
286	355	)
287		- def test_320_list_keys_error_responses(self, monkeypatch, response_code,
288		- response, exc_type, exc_pattern):
	356	+ def test_320_list_keys_error_responses(
	357	+ self, monkeypatch, response_code, response, exc_type, exc_pattern
	358	+ ):
289	359	client = ssh_agent_client.SSHAgentClient()
290		- monkeypatch.setattr(client, 'request',
291		- lambda a, *kw: (response_code, response)) # noqa: ARG005
	360	+ monkeypatch.setattr(
	361	+ client,
	362	+ 'request',
	363	+ lambda a, *kw: (response_code, response), # noqa: ARG005
	364	+ )
292	365	with pytest.raises(exc_type, match=exc_pattern):
293	366	client.list_keys()
294	367
...	...	@@ -309,16 +382,19 @@ class TestAgentInteraction:
309	382	(255, b''),
310	383	RuntimeError,
311	384	'signing data failed:',
	385	+ ),
	386	+ ],
312	387	)
313		- ]
314		- )
315		- def test_330_sign_error_responses(self, monkeypatch, key, check,
316		- response, exc_type, exc_pattern):
	388	+ def test_330_sign_error_responses(
	389	+ self, monkeypatch, key, check, response, exc_type, exc_pattern
	390	+ ):
317	391	client = ssh_agent_client.SSHAgentClient()
318	392	monkeypatch.setattr(client, 'request', lambda a, b: response) # noqa: ARG005
319	393	KeyCommentPair = ssh_agent_client.types.KeyCommentPair # noqa: N806
320		- loaded_keys = [KeyCommentPair(v['public_key_data'], b'no comment')
321		- for v in tests.SUPPORTED_KEYS.values()]
	394	+ loaded_keys = [
	395	+ KeyCommentPair(v['public_key_data'], b'no comment')
	396	+ for v in tests.SUPPORTED_KEYS.values()
	397	+ ]
322	398	monkeypatch.setattr(client, 'list_keys', lambda: loaded_keys)
323	399	with pytest.raises(exc_type, match=exc_pattern):
324	400	client.sign(key, b'abc', check_if_key_loaded=check)
325	401