derivepassphrase.git

@@ -283,6 +283,7 @@ class TestTestKeys:

         assert base64.standard_b64encode(key.public_key_data) == public_key_b64

         assert key.public_key_data.startswith(string(key_type_name))

+    # TODO(the-13th-letter): Put RSA key mangling into helper method.

     @Parametrize.TEST_KEYS

     def test_private_keys_are_consistent_with_public_keys(

         self,

@@ -531,7 +532,7 @@ class TestStubbedSSHAgentSocketProperOperations:

         del agent

     def test_closed_agents_cannot_be_interacted_with(self) -> None:

-        """The agent can be closed repeatedly."""

+        """The agent cannot be usefully used after close."""

         with machinery.StubbedSSHAgentSocket() as agent:

             pass

         query_request = (

@@ -1231,7 +1231,7 @@ class TestTempdir:

     # filenames.

     @hypothesis.given(

         env_var=strategies.sampled_from(["TMPDIR", "TEMP", "TMP"]),

-        suffix=strategies.builds(

+        subdir=strategies.builds(

             operator.add,

             strategies.text(

                 tuple(" 0123456789abcdefghijklmnopqrstuvwxyz"),

@@ -1245,13 +1245,13 @@ class TestTempdir:

             ),

         ),

     )

-    @hypothesis.example(env_var="", suffix=".").via(

+    @hypothesis.example(env_var="", subdir=".").via(

         "static example; branch coverage (test)"

     )

     def test_get_tempdir(

         self,

         env_var: str,

-        suffix: str,

+        subdir: str,

     ) -> None:

         """[`cli_helpers.get_tempdir`][] returns a temporary directory.

@@ -1290,7 +1290,7 @@ class TestTempdir:

             monkeypatch.delenv("TEMP", raising=False)

             monkeypatch.delenv("TMP", raising=False)

             monkeypatch.setattr(tempfile, "tempdir", None)

-            temp_path = pathlib.Path.cwd() / suffix

+            temp_path = pathlib.Path.cwd() / subdir

             if env_var:

                 monkeypatch.setenv(env_var, os.fsdecode(temp_path))

                 stack.enter_context(make_temporary_directory(temp_path))

@@ -130,12 +130,18 @@ class TestNotesPrinting:

                     "expected known stderr contents"

                 )

-    @hypothesis.given(notes=Strategies.notes().filter(str.strip))

+    @hypothesis.given(notes=Strategies.notes())

     def test_service_with_notes_actually_prints_notes(

         self,

         notes: str,

     ) -> None:

-        """Service notes are printed, if they exist."""

+        """Service notes are printed, if they contain content.

+

+        (Service notes are trimmed before printing, and thus result in

+        output if and only if they are non-empty after trimming leading

+        and trailing whitespace.)

+

+        """

         hypothesis.assume("Error:" not in notes)

         self._test(notes, notes_placement=None, placement_args=())

@@ -404,6 +410,8 @@ class TestNotesEditingValid(TestNotesEditing):

             notes_unchanged=notes_unchanged,

         )

+    # TODO(the-13th-letter): Investigate behavior with respect to

+    # whitespace-only notes and the legacy editor interface.

     @Parametrize.MODERN_EDITOR_INTERFACE

     @hypothesis.settings(

         suppress_health_check=[

@@ -392,6 +392,7 @@ class TestStoreroom:

                 == data.VAULT_STOREROOM_CONFIG_DATA

             )

+    # TODO(the-13th-letter): Rewrite as property-based test.

     @pytest_machinery.correctness_focused

     def test_decrypt_bucket_item_unknown_version(self) -> None:

         """Fail on unknown versions of the master keys file."""

@@ -406,6 +407,7 @@ class TestStoreroom:

         with pytest.raises(ValueError, match="Cannot handle version 255"):

             storeroom._decrypt_bucket_item(bucket_item, master_keys)

+    # TODO(the-13th-letter): Rewrite as property-based test.

     @pytest_machinery.correctness_focused

     @Parametrize.BAD_CONFIG

     def test_decrypt_bucket_file_bad_json_or_version(

@@ -430,6 +432,7 @@ class TestStoreroom:

             with pytest.raises(ValueError, match="Invalid bucket file: "):

                 list(storeroom._decrypt_bucket_file(p, master_keys))

+    # TODO(the-13th-letter): Rewrite as property-based test.

     @pytest_machinery.correctness_focused

     @Parametrize.BAD_MASTER_KEYS_DATA

     @Parametrize.STOREROOM_HANDLER

@@ -451,6 +454,7 @@ class TestStoreroom:

             with pytest.raises(RuntimeError, match=err_msg):

                 handler(format="storeroom")

+    # TODO(the-13th-letter): Rewrite as property-based test.

     @pytest_machinery.correctness_focused

     @Parametrize.BAD_STOREROOM_CONFIG_DATA

     @Parametrize.STOREROOM_HANDLER

@@ -481,6 +485,7 @@ class TestStoreroom:

             with pytest.raises(RuntimeError, match=error_text):

                 handler(format="storeroom")

+    # TODO(the-13th-letter): Rewrite as property-based test.

     @pytest_machinery.correctness_focused

     def test_decrypt_keys_wrong_data_length(self) -> None:

         """Fail on internal structural data of the wrong size.

@@ -533,6 +538,7 @@ class TestStoreroom:

                 ),

             )

+    # TODO(the-13th-letter): Generate key as well.

     @pytest_machinery.correctness_focused

     @hypothesis.given(

         data=strategies.binary(

@@ -328,6 +328,7 @@ class TestCLIUtilities:

                 == expected.expanduser().resolve()

             )

+    # TODO(the-13th-letter): Revise, or remove.

     def test_get_vault_path_without_home(self) -> None:

         """Fail to look up the vault path without `HOME`."""

@@ -465,6 +466,7 @@ class TestGenericVaultCLIErrors:

                 catch_exceptions=False,

             )

+    # TODO(the-13th-letter): Rewrite as property-based test.

     def test_invalid_format(self) -> None:

         """Reject invalid vault configuration format names."""

         result = self._call_cli(["-f", "INVALID", "VAULT_PATH"])

@@ -346,6 +346,8 @@ class TestSequin:

         steps: Sequence[tuple[int, int | type[sequin.SequinExhaustedError]]]

         """"""

+        # TODO(the-13th-letter): Add more known sequences. Derive those

+        # from sequin.js.

         @strategies.composite

         @staticmethod

         def strategy(draw: strategies.DrawFn) -> TestSequin.GenerationSequence:

@@ -466,6 +468,8 @@ class TestSequin:

         steps: Sequence[tuple[int, Sequence[int], Sequence[int]]]

         """"""

+        # TODO(the-13th-letter): Check feasibility of encoding

+        # unsatisfiable shifts.

         @strategies.composite

         @staticmethod

         def strategy(draw: strategies.DrawFn) -> TestSequin.ShiftSequence:

@@ -486,7 +490,8 @@ class TestSequin:

                     operator.add,

                     no_op_counts_strategy,

                     true_counts_strategy,

-                ).flatmap(strategies.permutations)

+                ).flatmap(strategies.permutations),

+                label="sequence of bit shift sizes",

             )

             bit_sequence: list[int] = []

             steps: list[tuple[int, Sequence[int], list[int]]] = []

@@ -494,7 +499,8 @@ class TestSequin:

                 shift_result = draw(

                     strategies.lists(

                         bits_strategy, min_size=count, max_size=count

-                    )

+                    ),

+                    label=f"shift result #{i}",

                 )

                 for step in steps[:i]:

                     step[2].extend(shift_result)

@@ -627,10 +627,17 @@ class TestSSHProtocolDatatypes(TestStaticFunctionality):

         [DECODE_ENCODE]: https://hypothesis.works/articles/canonical-serialization/

         """

+        # Both canonicalization functions are built with slightly

+        # different primitives.  However, because SSH string encoding is

+        # a bijective encoding, their result should be the same.

         canonical_functions = [self.canonicalize1, self.canonicalize2]

+        # Test encoding equivalence.

         for canon1 in canonical_functions:

             for canon2 in canonical_functions:

                 assert canon1(encoded) == canon2(encoded)

+        # Test idempotence.

+        for canon1 in canonical_functions:

+            for canon2 in canonical_functions:

                 assert canon1(canon2(encoded)) == canon1(encoded)

     @Parametrize.UINT32_EXCEPTIONS

@@ -40,6 +40,20 @@ TWITTER_PHRASE = rb"[ (HN_N:lI&<ro=)3'g9"

 The standard derived passphrase for the "twitter" service, from

 <i>vault</i>(1)'s test suite.

 """

+INTERCHANGABLE_PHRASE1 = (

+    b"plnlrtfpijpuhqylxbgqiiyipieyxvfsavzgxbbcfusqkozwpngsyejqlmjsytrmd"

+)

+"""

+One of two [interchangable passphrases][INTERCHANGABLE_PASSPHRASES],

+based on [Wikipedia's page on PBKDF2 (HMAC collisions)][HMAC_COL].

+

+[INTERCHANGABLE_PASSPHRASES]: https://the13thletter.info/derivepassphrase/0.x/explanation/faq-vault-interchangable-passphrases/ 'What are "interchangable passphrases" in `vault`, and what does that mean in practice?'

+[HMAC_COL]: https://en.wikipedia.org/w/index.php?title=PBKDF2&oldid=1264881215#HMAC_collisions

+"""

+INTERCHANGABLE_PHRASE2 = b"eBkXQTfuBqp'cTcar&g*"

+"""

+Same purpose as [`INTERCHANGABLE_PHRASE1`][INTERCHANGABLE_PHRASE1].

+"""

 buffer_types: dict[str, Callable[..., Buffer]] = {

     "bytes": bytes,

@@ -79,8 +93,9 @@ class Parametrize(types.SimpleNamespace):

         [

             "ñ",

             "Düsseldorf",

-            "liberté, egalité, fraternité",

+            "Liberté, égalité, fraternité",

             "ASCII",

+            "こんにちは。",

             b"D\xc3\xbcsseldorf",

             bytearray([2, 3, 5, 7, 11, 13]),

         ],

@@ -352,22 +367,9 @@ class TestPhraseDependence:

         service=Strategies.text_strategy(),

     )

     @hypothesis.example(

-        phrases=[

-            (

-                b"plnlrtfpijpuhqylxbgqiiyipieyxvfs"

-                b"avzgxbbcfusqkozwpngsyejqlmjsytrmd"

-            ),

-            b"eBkXQTfuBqp'cTcar&g*",

-        ],

+        phrases=[INTERCHANGABLE_PHRASE1, INTERCHANGABLE_PHRASE2],

         service="any service name here",

-    ).xfail(

-        reason=(

-            "phrases are interchangable (Wikipedia example:"

-            "https://en.wikipedia.org/w/index.php?title=PBKDF2&oldid=1264881215#HMAC_collisions"

-            ")"

-        ),

-        raises=AssertionError,

-    )

+    ).xfail(reason="phrases are interchangable", raises=AssertionError)

     def test_mixed(self, phrases: Sequence[bytes], service: str) -> None:

         """The internal hash is dependent on the master passphrase.

@@ -625,7 +627,7 @@ class TestConstraintSatisfactionFromUpstream(TestVault):

         assert generated == b"763252593304946694588866"

-class TestConstraintSatisfactionThoroughness(TestVault):

+class TestConstraintSatisfactionThoroughness:

     """Test passphrase derivation with the "vault" scheme: constraint satisfaction."""

     @hypothesis.given(

@@ -690,7 +692,7 @@ class TestConstraintSatisfactionThoroughness(TestVault):

             assert count <= repeat

-class TestConstraintSatisfactionHeavyDuty(TestVault):

+class TestConstraintSatisfactionHeavyDuty:

     """Test passphrase derivation with the "vault" scheme: constraint satisfaction."""

     @hypothesis.given(

@@ -819,6 +821,8 @@ class TestUtilities(TestVault):

             )

         assert v._estimate_sufficient_hash_length(8.0) >= entropy

+    # TODO(the-13th-letter): Either fold this version into test_entropy,

+    # or remove degenerate cases from Parametrize.ENTROPY_RESULTS.

     def test_hash_length_estimation(self) -> None:

         """

         Estimating the entropy and hash length for degenerate cases works.