Skip to content

Commit 4d19187

Browse files
committed
chore(release): Update CHANGELOG.md
Signed-off-by: Nicola Tuveri <[email protected]> Change-Id: I6a6a69643ac4ce3747deff1643c0567c2488d33a
1 parent 2f36fd2 commit 4d19187

File tree

1 file changed

+57
-28
lines changed

1 file changed

+57
-28
lines changed

CHANGELOG.md

Lines changed: 57 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.8.5] - 2025-09-24
9+
10+
### Documentation changes
11+
12+
- Add examples for `OSSLParam` enum variants
13+
- Add example and more description for `OSSLParamData`
14+
- Add more description for `TypedOSSLParamData`
15+
- Add detailed description for `OSSLParamSetter` & `OSSLParamGetter`
16+
- Add example and more description for `get_c_struct_mut()`
17+
- Add example for `modified()`
18+
- Add examples and document return values for `get_data_type()`
19+
- Add doc example for OSSLParam set method
20+
- Document OSSLParam Types
21+
22+
### Added
23+
24+
- Add crates.io metadata to `Cargo.toml`
25+
26+
### Changed
27+
28+
- Bump to 0.8.5
29+
- Take non-mut `&self` in `modified()`
30+
- Handle null cases in `OSSLParam::get_data_type`
31+
32+
### Fixed
33+
34+
- Check that the int and uint setters actually set the value
35+
836
## [0.8.4] - 2025-08-27
937

1038
### Changed
@@ -51,7 +79,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5179
- Add TLS Signature Algorithm support
5280
- Add TLS and DTLS version enums
5381
- Add TLS group support
54-
- Add missing docs for CONST_OSSL_PARAM and OSSLParam types
82+
- Add missing docs for `CONST_OSSL_PARAM` and `OSSLParam` types
5583
- Add setup function to all test cases
5684

5785
### Changed
@@ -70,7 +98,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7098

7199
- Fix punctuation in documentation
72100
- Handle null pointers in data getters
73-
- Use log::trace instead of log::debug
101+
- Use `log::trace` instead of `log::debug`
74102

75103
## [0.8.0] - 2025-03-08
76104

@@ -81,7 +109,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
81109
- Add workflow similar to the gitlab one
82110
- Add .gitignore to exclude /target directory
83111
- Add initial GitLab CI configuration
84-
- Add unit tests for OSSLParam::variant_name()
112+
- Add unit tests for `OSSLParam::variant_name()`
85113
- Add missing newlines in osslparams module
86114

87115
### Changed
@@ -97,23 +125,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
97125
- Revise LICENSE to fully conform to Apache-2.0
98126
- Improve compatibility with rustdoc inclusion
99127
- Include readme at crate level
100-
- Move OSSL_PARAM_UNMODIFIED constant
128+
- Move `OSSL_PARAM_UNMODIFIED` constant
101129
- Re-export FFI bindings for better usability
102130
- Edit pass on stale documentation
103-
- Remove stale allow(dead_code) annotation
131+
- Remove stale `allow(dead_code)` annotation
104132
- Add examples for OSSLParamIterator and IntoIterator
105133
- Make traits public again
106134
- `new_const_*()` associated functions now take an Option as value
107135
- Add missing docs
108-
- Remove ossl_param_locate_raw
136+
- Remove `ossl_param_locate_raw`
109137

110138
### Fixed
111139

112140
- Fix most failing doctests (Examples)
113141

114142
### Removed
115143

116-
- Remove OSSLParam::inner_data()
144+
- Remove `OSSLParam::inner_data()`
117145

118146
## [0.7.1] - 2025-02-21
119147

@@ -138,46 +166,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
138166

139167
### Added
140168

141-
- Add new OSSLParam methods
169+
- Add new `OSSLParam` methods
142170
- Add iterator support for OSSLParam
143171
- Add pkg-config dependency and update build.rs
144172
- Add debug and selection support for key management
145-
- Add OSSLParam::try_new_vec() to convert a C param array pointer to a Vec<OSSLParam>
173+
- Add `OSSLParam::try_new_vec()` to convert a C param array pointer to a `Vec<OSSLParam>`
146174
- Add octet string param type
147175
- Add gen_set_params and gen_settable_params for libcrux X25519MLKEM768 adapter
148176
- Add UTF8 string param type in combined module with UTF8 pointer param type
149177
- Added Unit Tests
150-
- Add OSSLParam implementation in modules
151-
- Add OSSL_PARAM implementation using marker traits
178+
- Add `OSSLParam` implementation in modules
179+
- Add `OSSL_PARAM` implementation using marker traits
152180

153181
### Changed
154182

155183
- Update Cargo.toml version to 0.7.0
156184
- Move to top directory after splitting `openssl-provider-forge-rs` from monorepo
157-
- Alias CONST_OSSL_PARAM in bindings module
185+
- Alias `CONST_OSSL_PARAM` in bindings module
158186
- Rename `osslcb` as `ossl_callback`
159-
- Introduce OSSLCallback for cleaner handling
160-
- Feat(osslparams): introduce CONST_OSSL_PARAM
161-
- Implement custom Debug for IntData and UIntData
162-
- Implement custom Debug for Utf8StringData
187+
- Introduce `OSSLCallback` for cleaner handling
188+
- Feat(osslparams): introduce `CONST_OSSL_PARAM`
189+
- Implement custom `Debug` for `IntData` and `UIntData`
190+
- Implement custom `Debug` for `Utf8StringData`
163191
- Implement new constructors
164-
- Improve clarity for `get_inner` for OSSLParam::Utf8Ptr
165-
- Implement `get_inner` for OSSLParam::Utf8String
192+
- Improve clarity for `get_inner` for `OSSLParam::Utf8Ptr`
193+
- Implement `get_inner` for `OSSLParam::Utf8String`
166194
- Rename rust-openssl-core-provider to openssl_provider_forge
167-
- Implement an Iterator that gives OSSLParam structs from a OSSL_PARAM pointer
168-
- Clean up a few more old uses of ossl_param_st
169-
- Use &mut instead of \*mut to store the OSSL_PARAM reference
170-
- Use OSSL_PARAM instead of ossl_param_st everywhere
171-
- Use $crate in dispatch_table_entry macro
195+
- Implement an `Iterator` that gives `OSSLParam` structs from a `OSSL_PARAM` pointer
196+
- Clean up a few more old uses of `ossl_param_st`
197+
- Use `&mut` instead of `*mut` to store the `OSSL_PARAM` reference
198+
- Use `OSSL_PARAM` instead of `ossl_param_st` everywhere
199+
- Use `$crate` in dispatch_table_entry macro
172200
- Apply `cargo fmt`
173201
- Replace OSSLParam::try_new_vec() with an impl From<&mut ossl_param_st> for Vec<OSSLParam>
174202
- Iterate directly over C params array with `ossl_param_locate_raw`
175203
- Update setter for octet string param to more closely match OSSL C implementation
176204
- Update setter for UTF-8 string param to more closely match OSSL C implementation
177-
- Use $crate in impl_setter macro definition
178-
- Use u32 for UInt params in TLS group params
205+
- Use `$crate` in impl_setter macro definition
206+
- Use `u32` for `UInt` params in TLS group params
179207
- Allocate memory and set data_size when creating new empty params
180-
- Create mutable reference instead of copying param in Int and UInt types
208+
- Create mutable reference instead of copying param in `Int` and `UInt` types
181209
- Disable function type check
182210
- [aurora/src/adapters/libcrux] Refactor structure
183211
- Bug Fix: Dereference & create mutable reference
@@ -187,19 +215,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
187215
- Refactor project structure
188216
- Restructure osslparams module
189217
- [aurora/src] Remove requirement on nightly experimental features
190-
- Start importing OSSL_PARAM work
218+
- Start importing `OSSL_PARAM` work
191219
- Initial commit
192220
- Initial commit with README and LICENSE
193221

194222
### Fixed
195223

196-
- Fmt::Debug must be infallible
224+
- `fmt::Debug` must be infallible
197225
- Use `$crate` in macro to ensure proper resolution of `OSSL_DISPATCH`
198226

199227
### Removed
200228

201229
- Remove all naked `unwrap()`
202230

231+
[0.8.5]: https://github.com///compare/v0.8.4..v0.8.5
203232
[0.8.4]: https://github.com///compare/v0.8.3..v0.8.4
204233
[0.8.3]: https://github.com///compare/v0.8.1..v0.8.3
205234
[0.8.1]: https://github.com///compare/v0.8.0..v0.8.1

0 commit comments

Comments
 (0)