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

132) ## 0.2.0 (2024-09-12)
133) 

134) ### Added

135) 

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

138) 
139)     This feature requires the `cryptography` Python module, but is available

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

141) 
142) [#1]: https://github.com/the-13th-letter/derivepassphrase/1
143) 

144) ### Fixed
145) 
146)   - Deploy versioned documentation with [mike][].  Set up a "latest" tag and
147)     the "0.<var>x</var>" version of the documentation with the contents so
148)     far.
149) 
150) [mike]: https://pypi.org/project/mike
151) 
152) ### Changed
153) 
154)   - Changed `sequin` and `ssh_agent_client` to be submodules of
155)     `derivepassphrase`.  Further moved `derivepassphrase.Vault` and
156)     `derivepassphrase.AmbiguousByteRepresentation` into a new submodule
157)     `vault`, and renamed submodule `ssh_agent_client` to `ssh_agent`. ([#3])
158)   - Changed internal error handling and error messages, to better work in
159)     the context of a command-line tool. ([#4])
160)   - Combine and consolidate `derivepassphrase.types` and
161)     `derivepassphrase.ssh_agent.types` into a new submodule
162)     `derivepassphrase._types`.  Despite the name, the module is public.
163)     ([#7])
164)   - Warn the user when entering (directly, or via configuration
165)     editing/importing) a passphrase that is not in the configured Unicode
166)     normalization form. (But don't otherwise reject any textual master
167)     passphrases.) ([#9])
168)   - Move all existing functionality into a subcommand, in anticipation of
169)     other passphrase derivation schemes, with different settings.
170)     Automatically forward calls without a subcommand to the "vault"
171)     subcommand.

172) 
173)     Also store the settings in a file specific to the respective subsystem,

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

177) 

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

180) 
181) [#3]: https://github.com/the-13th-letter/derivepassphrase/3
182) [#4]: https://github.com/the-13th-letter/derivepassphrase/4
183) [#7]: https://github.com/the-13th-letter/derivepassphrase/7
184) [#9]: https://github.com/the-13th-letter/derivepassphrase/9
185) [#10]: https://github.com/the-13th-letter/derivepassphrase/10
186) [#11]: https://github.com/the-13th-letter/derivepassphrase/11
187) 

188) ### Deprecated

189) 

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

192) 
193) 

194) ## 0.1.3 (2024-07-28)
195) 

196) ### Fixed

197) 

198)   - Do not crash upon selecting a key on the command-line if there already
199)     is a key stored in the configuration. ([#5])
200)   - Create the configuration directory upon saving, if it does not yet
201)     exist.  ([#6])
202)   - Isolate the tests properly and consistently from the user's
203)     configuration, so that user configuration problems do not cause
204)     unrelated test failures. ([#8])
205)   - Add an alternate MkDocs configuration for building the documentation in
206)     offline mode.
207)   - Fix typing issues according to `mypy`'s strict mode.

208) 
209) [#5]: https://github.com/the-13th-letter/derivepassphrase/5
210) [#6]: https://github.com/the-13th-letter/derivepassphrase/6
211) [#8]: https://github.com/the-13th-letter/derivepassphrase/8
212) 
213) 

214) ## 0.1.2 (2024-07-22)
215) 

216) ### Fixed

217) 

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

221)   - Lint and reformat all code using [ruff](https://pypi.org/package/ruff/).
222)   - Mention
223)     [`mkdocstrings-python`](https://pypi.org/package/mkdocstrings-python/)

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

229) 
230) 

231) ## 0.1.1 (2024-07-14)
232) 

233) ### Fixed

234) 

235)   - Restore the `__version__` attribute in all top-level packages.
236)   - Declare compatibility with Python 3.10 in project metadata, and include
237)     necessary version-specific dependencies.
238)   - Publish the documentation online, and link to it in the repository
239)     metadata and the Python package metadata.

240) 
241) 
242) ## 0.1.0 (2024-07-14)
243) 

244) ### Added

245)