derivepassphrase.git

1) # Changelog for `derivepassphrase`
2) 
3) [![Keeping a changelog][CHANGELOG_BADGE]][KEEP_A_CHANGELOG]
4) [![Using Semantic Versioning][SEMVER_BADGE]][SEMANTIC_VERSIONING]
5) 
6)   [CHANGELOG_BADGE]: Keep_a_changelog-E05735.svg
7)   [SEMVER_BADGE]: SemVer-3F4551.svg
8)   [KEEP_A_CHANGELOG]: https://keepachangelog.com/en/1.1.0/ 'Keeping a changelog'
9)   [SEMANTIC_VERSIONING]: https://semver.org/ 'Using Semantic Versioning'
10) 
11) <aside markdown><small>
12) (All entries are from the perspective of a user, not a developer.
13) The <q>public API</q>, as defined by Semantic Versioning, is outlined in the
14) [Reference section][REFERENCE]: the set of documented modules, classes,
15) methods and functions, and the documented behavior, options and arguments of
16) the command-line tools.
17) As per the Semantic Versioning and the Keep a Changelog terminology,
18) <q>Fixed</q> entries justify a <q>patch</q> release,
19) <q>Added</q> and <q>Deprecated</q> entries a <q>minor</q> release,
20) and <q>Changed</q> and <q>Removed</q> entries a <q>major</q> release.
21) <q>Security</q> can justify any type of release;
22) if <q>major</q> or <q>minor</q>, these are accompanied by corresponding
23) entries of the respective types above.
24) Again as per Semantic Versioning, at major version zero, the above
25) justification is not yet binding, and <em>any</em> new release may
26) effectively constitute a new <q>major</q> release.)
27) </small></aside>
28) 

29)   [REFERENCE]: reference/index.md

30) 

31) <!-- scriv changelog start -->

32) 

33) ## 0.3.2 (2024-10-21)
34) 
35) ### Fixed
36) 
37)   - _*Actually* actually_ remove the `derivepassphrase_export` program, which was
38)     turned into a subcommand in v0.2.0 and supposed to have been removed in
39)     v0.3.1 already.  Removed on disk is not the same as removed in
40)     version control.
41) 

42) ## 0.3.1 (2024-10-21)
43) 
44) ### Fixed
45) 
46)   - Fix PyPI classification: Python 3.9 is supported.
47)   - *Actually* remove the `derivepassphrase_export` program, which was
48)     turned into a subcommand in v0.2.0.
49) 

50) ## 0.3.0 (2024-10-15)
51) 
52) ### Added
53) 
54)   - Convert changelog management from towncrier to [scriv][].
55)   - Add SSH agent spawning support to the test suite.  Use this support to
56)     test the agent functionality on all known major SSH agent
57)     implementations automatically. ([#12])
58)   - Add [hypothesis][]-based tests to the test suite.
59)   - Update README to add explanations for virtual environments and package
60)     extras.
61)   - Update README to demonstrate configuration storing and SSH agent use.
62)     Include comments on Windows support for SSH agents.
63)   - Use cross-references in the documentation of function signatures.
64)   - Add proper support for Buffer types in the SSH agent client.  Any
65)     Python object supporting the buffer protocol can be used as input to
66)     a function of the client, and any output from the client is returned
67)     as bytes objects.  Because of the zero-copy semantics of the
68)     underlying data/memory block, this should stay relatively time- and
69)     space-efficient.
70)   - Add [hypothesis][]-based tests for serialization to and
71)     deserialization from the SSH agent wire format.
72)   - Support Python 3.9 and 3.13.
73) 
74) [#12]: https://github.com/the-13th-letter/derivepassphrase/issues/12
75) [hypothesis]: https://pypi.org/project/hypothesis/
76) [scriv]: https://pypi.org/project/scriv
77) 
78) ### Changed
79) 
80)   - Change links to point to public project repositories, if possible.  For
81)     legal reasons.
82) 
83)   - Use the same filename/URL convention for API reference as the Python
84)     standard library does.
85) 
86)   - Rewrite functionality for checking for valid vault(1) configurations:
87)     include an actual validation function which throws errors upon
88)     encountering format violations, and which allows specifying which types
89)     of extensions (unknown settings, `derivepassphrase`-only settings) to
90)     tolerate during validation.
91) 
92)     This is a **breaking API change** because the function return annotation
93)     changed, from [`typing.TypeGuard`][] to [`typing_extensions.TypeIs`][].
94)     These were the originally intended semantics, but when
95)     `derivepassphrase` was first designed, the Python type system did not
96)     support this kind of partial type narrowing.
97) 
98)   - Fail earlier, and more gracefully/specifically, when we cannot talk to
99)     the SSH agent because Python does not support UNIX domain sockets on
100)     this system.  In particular, this is the current situation on Windows.
101) 
102)     This adds another failure case to the `SSHAgentClient` constructor, and
103)     therefore constitutes a **breaking API change**.
104) 
105)   - In `derivepassphrase vault`, accept `key` and `phrase` entries just like
106)     vault(1) does: `key` always overrides `phrase` in the configuration, no
107)     matter the level.
108) 
109)     This is a command-line only change.
110) 
111)   - In `derivepassphrase vault`, when importing settings, accept falsy values
112)     everywhere `vault` does, with a warning.  Depending on the setting, they
113)     are equivalent to zero, the empty string, or "not set".  ([#17])
114) 
115)     This is a command-line only change, and only affects importing.  The API
116)     provides a new function to normalize falsy settings, but still otherwise
117)     requires settings to be of the correct type.  Storing a malformed
118)     configuration with such falsy values will still generate errors when
119)     `derivepassphrase vault` loads the settings from disk.
120) 
121)   - In `derivepassphrase vault`, when importing configurations,
122)     correctly merge them with the existing one, same as vault(1): keep
123)     all named services and their settings (and the global settings if
124)     applicable) that are not mentioned in the imported configuration.
125)     The import procedure is thus more akin to a section-wise import of
126)     the configurations, instead of a "full" import, and the resulting
127)     configuration generally is a merge of both inputs.  ([#16])
128) 
129)   - The following operations or configuration settings now raise
130)     warnings:
131) 
132)       * in imported configurations: using falsy values of the wrong type
133)       * in imported configurations: using falsy values with no practical
134)         effect
135)       * setting a passphrase in the configuration if a key is already
136)         set
137)       * using an empty service name on the command-line or in an
138)         imported configuration
139) 
140) [#16]: https://github.com/the-13th-letter/derivepassphrase/issues/16
141) [#17]: https://github.com/the-13th-letter/derivepassphrase/issues/17
142) 
143) ### Fixed
144) 
145)   - Fixed the textual description of the return value for
146)     [`SSHAgentClient.request`][derivepassphrase.ssh_agent.SSHAgentClient.request],
147)     which didn't match the declared type annotation.
148) 

149) ## 0.2.0 (2024-09-12)
150) 

151) ### Added

152) 

153)   - Support configuration data export from `vault` in v0.2, v0.3 and
154)     storeroom formats.

155) 
156)     This feature requires the `cryptography` Python module, but is available

157)     even if `vault` is not installed. ([#1])

158) 
159) [#1]: https://github.com/the-13th-letter/derivepassphrase/1
160) 

161) ### Fixed
162) 
163)   - Deploy versioned documentation with [mike][].  Set up a "latest" tag and
164)     the "0.<var>x</var>" version of the documentation with the contents so
165)     far.
166) 
167) [mike]: https://pypi.org/project/mike
168) 
169) ### Changed
170) 
171)   - Changed `sequin` and `ssh_agent_client` to be submodules of
172)     `derivepassphrase`.  Further moved `derivepassphrase.Vault` and
173)     `derivepassphrase.AmbiguousByteRepresentation` into a new submodule
174)     `vault`, and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])
175)   - Changed internal error handling and error messages, to better work in
176)     the context of a command-line tool. ([#4])
177)   - Combine and consolidate `derivepassphrase.types` and
178)     `derivepassphrase.ssh_agent.types` into a new submodule
179)     `derivepassphrase._types`.  Despite the name, the module is public.
180)     ([#7])
181)   - Warn the user when entering (directly, or via configuration
182)     editing/importing) a passphrase that is not in the configured Unicode
183)     normalization form. (But don't otherwise reject any textual master
184)     passphrases.) ([#9])
185)   - Move all existing functionality into a subcommand, in anticipation of
186)     other passphrase derivation schemes, with different settings.
187)     Automatically forward calls without a subcommand to the "vault"
188)     subcommand.

189) 
190)     Also store the settings in a file specific to the respective subsystem,

191)     instead of globally.  Automatically fall back to, and migrate, the old
192)     global settings file if no subsystem-specific configuration was found.
193)     ([#10])

194) 

195)   - Make `derivepassphrase_export` a subcommand: `derivepassphrase export`.
196)     ([#11])

197) 
198) [#3]: https://github.com/the-13th-letter/derivepassphrase/3
199) [#4]: https://github.com/the-13th-letter/derivepassphrase/4
200) [#7]: https://github.com/the-13th-letter/derivepassphrase/7
201) [#9]: https://github.com/the-13th-letter/derivepassphrase/9
202) [#10]: https://github.com/the-13th-letter/derivepassphrase/10
203) [#11]: https://github.com/the-13th-letter/derivepassphrase/11
204) 

205) ### Deprecated

206) 

207)   - Using the implied subcommand or the implied global configuration file is
208)     deprecated, and will be removed in v1.0.

209) 
210) 

211) ## 0.1.3 (2024-07-28)
212) 

213) ### Fixed

214) 

215)   - Do not crash upon selecting a key on the command-line if there already
216)     is a key stored in the configuration. ([#5])
217)   - Create the configuration directory upon saving, if it does not yet
218)     exist.  ([#6])
219)   - Isolate the tests properly and consistently from the user's
220)     configuration, so that user configuration problems do not cause
221)     unrelated test failures. ([#8])
222)   - Add an alternate MkDocs configuration for building the documentation in
223)     offline mode.
224)   - Fix typing issues according to `mypy`'s strict mode.

225) 
226) [#5]: https://github.com/the-13th-letter/derivepassphrase/5
227) [#6]: https://github.com/the-13th-letter/derivepassphrase/6
228) [#8]: https://github.com/the-13th-letter/derivepassphrase/8
229) 
230) 

231) ## 0.1.2 (2024-07-22)
232) 

233) ### Fixed

234) 

235)   - Include and exclude the correct files in the `sdist` and `wheel`
236)     distributions.  (Previously, `sdist` contained VCS artifacts, and
237)     `wheel` was missing some paths.)

238)   - Lint and reformat all code using [ruff](https://pypi.org/package/ruff/).
239)   - Mention
240)     [`mkdocstrings-python`](https://pypi.org/package/mkdocstrings-python/)

241)     in the documentation's page footer.
242)   - Remove JavaScript and external font loading from documentation website,
243)     so that the site works even in restricted browser settings.
244)   - Set up a changelog, using
245)     [towncrier](https://pypi.org/package/towncrier).

246) 
247) 

248) ## 0.1.1 (2024-07-14)
249) 

250) ### Fixed

251) 

252)   - Restore the `__version__` attribute in all top-level packages.
253)   - Declare compatibility with Python 3.10 in project metadata, and include
254)     necessary version-specific dependencies.
255)   - Publish the documentation online, and link to it in the repository
256)     metadata and the Python package metadata.

257) 
258) 
259) ## 0.1.0 (2024-07-14)
260) 

261) ### Added

262)