chore: Release v0.6.0-rc.1

wireapp · Dec 15, 2022 · 9bd97c7 · 9bd97c7
1 parent f44abd4
commit 9bd97c7
Show file tree

Hide file tree

Showing 11 changed files with 174 additions and 247 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,50 @@ Platform support legends:
     * Note: the papercuts will majorly be with the build process. Things might be very rough to integrate as no polish at all has been given yet.
 * ❌ = tier 3 support. It doesn't work just yet, but we plan to make it work.
 
+## [0.6.0-rc.1] - 2022-12-14
+
+<details>
+    <summary>git-conventional changelog</summary>
+
+### Bug Fixes
+
+- Broken Proteus implementation
+- Prevent application messages signed by expired KeyPackages
+- Fix cryptobox import on WASM [CL-119]
+- Incorrect TS return types [CL-118]
+
+### Features
+
+- Expose a 'WrongEpoch' error whenever one attempts to decrypt a message in the wrong epoch
+- Add 'restore_from_disk' to enable using multiple MlsCentral instances in iOS extensions
+- Add specialized error when trying to break forward secrecy
+- Add 'out_of_order_tolerance' & 'maximum_forward_distance' to configuration without exposing them and verify they are actually applied
+- [**breaking**] Change 'client_id' in CoreCrypto constructor from a String to a byte array to remain consistent across the API
+- Expose proteus prekey fingerprint - CL-107
+
+### Miscellaneous Tasks
+
+- Use NDK 21 for android artifacts - CL-111
+
+### Testing
+
+- Ensure we are immune to duplicate commits and out of order commit/proposal
+
+</details>
+
+* Fixed a compilation issue related to the `sha1` crate's ASM
+* Added a `restore_from_disk` API to enable using CoreCrypto from various instances
+* Various internal improvements to testing to increase resistance to uncommon scenarios
+* Proteus:
+    * Expose proteus prekey fingerprint
+    * Fixed the TypeScript exposed types
+    * Fixed Cryptobox import
+    * Fixed broken Proteus implementation that led to decryption errors after key import
+* MLS:
+    * Expose a `WrongEpoch` error
+    * Added an error when trying to break PFS
+    * **BREAKING**: Tweaked the configuration format, removed and added some options
+
 ## [0.6.0-pre.5] - 2022-11-10
 
 <details>
@@ -23,6 +67,12 @@ Platform support legends:
 
 </details>
 
+* chore: Get rid of the C-FFI
+* feature: Added support for deferred MLS initialization
+* Proteus:
+    * Expose Proteus session Fingerprints (local & remote)
+
+
 ## [0.6.0-pre.4] - 2022-11-07
 
 <details>
@@ -50,6 +100,18 @@ Platform support legends:
 
 </details>
 
+* fix: Publication of swift packages [CL-49] by @augustocdias in https://github.com/wireapp/core-crypto/pull/165
+* fix: Make tags have semantic versioning names and downgrading to swift 5.5 - CL-49 by @augustocdias in https://github.com/wireapp/core-crypto/pull/166
+* feat: Expose session exists through the ffi - CL-101 by @augustocdias in https://github.com/wireapp/core-crypto/pull/167
+* chore: fix new clippy warnings in 1.65 by @beltram in https://github.com/wireapp/core-crypto/pull/170
+* fix: consistent commits by @beltram in https://github.com/wireapp/core-crypto/pull/169
+* fix!: Incorrect handling of enums across WASM FFI [CL-104] by @OtaK in https://github.com/wireapp/core-crypto/pull/168
+* test: pure ciphertext by @beltram in https://github.com/wireapp/core-crypto/pull/160
+* Release 0.6.0-pre.4 by @augustocdias in https://github.com/wireapp/core-crypto/pull/171
+
+
+**Full Changelog**: https://github.com/wireapp/core-crypto/blob/develop/CHANGELOG.md
+
 ## [0.6.0-pre.3] - 2022-11-01
 
 <details>
@@ -124,240 +186,19 @@ Platform support legends:
 - Fix rcgen failing on WASM due to some unsupported elliptic curve methods invoked at compile time
 - Ensure external commit are retriable
 
+</details>
 
-### Bug Fixes
-
-- Wire-server sends a base64 encoded ed25519 key afterall. Consumers are in charge of base64 decoding it and pass it to core-crypto
-- TS Ciphersuite enum not correctly exported
-
-### Documentation
-
-- Add installation instructions for e2e runner on macos
-
-### Miscellaneous Tasks
-
-- Release v0.5.2
-
-
-### Bug Fixes
-
-- Incorrect null handing in Typescript wrapper for 'commitPendingProposals'
-- External_senders public key was not TLS deserialized causing rejection of external remove proposals
-
-### Documentation
-
-- Better explanation of what DecryptedMessage#proposals contains
-
-### Miscellaneous Tasks
-
-- Release v0.5.1
-- Added E2E interop testing tool
-
-
-### Bug Fixes
-
-- NPM publish workflow missing npm ci + wrong method names in TS bindings
-- NPM publish workflow missing npm i
-- Rollback openmls & chrono in order to release 0.5.0
-- Pin openmls without vulnerable chrono
-- Wee_alloc memory leak + NPM publish issue
-- Unreachable pub struct breaks docgen
-- Fixed iOS SQLCipher salt handling within keychain
-- [**breaking**] Changed misleading callback API and docs
-- [**breaking**] Added missing TS API to set CoreCrypto callbacks
-- Force software implementation for sha2 on target architectures not supporting hardware implementation (i686 & armv7 in our case)
-
-### Documentation
-
-- Add forgotten 0.4.0 changelog
-
-### Features
-
-- [**breaking**] 'commit_pending_proposals' now returns an optional CommitBundle when there is no pending proposals to commit
-
-### Miscellaneous Tasks
-
-- Release v0.5.0 Redux
-- Update UniFFI to 0.20
-- Release v0.5.0
-- Update node version from 12 to 16 LTS
-- Update dependencies
-- Remove es2020-specific operators and target es2020 only
-- Updated changelog
-
-
-### Bug Fixes
-
-- Uniffi breaking changes in patch release and ffi error due to unused `TlsMemberAddedMessages`
-
-
-### Bug Fixes
-
-- Ensure durable methods are well tested and actually durable
-
-### Features
-
-- Commits and group creation return a TLS serialized CommitBundle. The latter also contains a PublicGroupStateBundle to prepare future evolutions
-- [**breaking**] 'decrypt_message' returns the sender client id
-- Use 128 bytes of padding when encrypting messages instead of 16 previously
-- Add function to return current epoch of a group [CL-80] ([#96](https://github.com/wireapp/core-crypto/issues/96))
-- Adding a wrapper for the swift API and initial docs [CL-62] ([#89](https://github.com/wireapp/core-crypto/issues/89))
-- Add '#[durable]' macro to verify the method is tolerant to crashes and persists the MLS group in keystore
-- Expose 'clear_pending_commit' method
-- Allow rollbacking a proposal
-- [**breaking**] Expose 'clear_pending_commit' method
-- [**breaking**] Allow rollbacking a proposal
-
-### Miscellaneous Tasks
-
-- Migrate benchmarks to async and write some for core crypto operations
-- Fixed WASM E2E tests
-
-### Testing
-
-- Add reminder for x509 certificate tests
-
-
-### Miscellaneous Tasks
-
-- Release v0.3.1
-
-
-### Bug Fixes
-
-- Clippy fix impl eq
-- Libgcc swizzling for android was removed
-- Cleaned up FFI names for clearer intent
-- Caught up WASM api with the internal API changes
-- Doctests were failing because included markdown snippets were parsed and compiled
-- Defer validation that a callback has to be set for validating external add proposal after incoming proposal identified as such
-- Updated RustCrypto dependencies to match hpke-rs requirements
-- Group was not persisted after decrypting an application message
-- UniFFI wrong type defs
-- Aes_gcm compilation issue
-- WASM persistence & CoreCrypto Async edition
-- 'client_keypackages' does not require mutable access on 'mls_client'
-- Add_member/remove_member IoError
-- Incorrect number of keypackages returned
-- Added support for MLS Group persistence [CL-5]
-
-### Documentation
-
-- Added bindings docs where appropriate + generated gh-pages
-- Fix Client struct documentation
-- Improving docs of Core-Crypto - [CL-50] ([#60](https://github.com/wireapp/core-crypto/issues/60))
-
-### Features
-
-- Review external add proposal validation and remove 'InvalidProposalType' error
-- Remove required KeyPackage when creating an external add proposal
-- Remove commits auto-merge behaviour
-- Expose GroupInfo after commit operation
-- Use draft-16 implementation of external sender. Expose a correct type through ffi for remove key
-- Add API to wipe specific group from core crypto [CL-55] ([#81](https://github.com/wireapp/core-crypto/issues/81))
-- Adding validation to external proposal [CL-51] ([#71](https://github.com/wireapp/core-crypto/issues/71))
-- Decrypting a commit now also return a delay when there are pending proposals
-- Decrypting a commit now also return a delay when there are pending proposals
-- 'commit_delay' now uses openmls provided leaf index instead of computing it ourselves. It is also now infallible.
-- Ensure consistent state
-- [**breaking**] Add commit delay when a message with prending proposals is processed [CL-52] ([#67](https://github.com/wireapp/core-crypto/issues/67))
-- Added KeyPackage Pruning
-- Added support for external entropy seed
-- Join by external commit support - CL-47 ([#57](https://github.com/wireapp/core-crypto/issues/57))
-- Added Entity testing to keystore
-- External remove proposal support
-- Supports and validates x509 certificates as credential
-- Expose function to self update the key package to FFI and Wasm #CL-17 ([#48](https://github.com/wireapp/core-crypto/issues/48))
-- Added support for wasm32-unknown-unknown target
-- Support external add proposal
-- Added method to leave a conversation
-- Enforce (simple) invariants on MlsCentralConfiguration
-- Expose add/update/remove proposal
-
-### Miscellaneous Tasks
-
-- Bump WASM bundle version to 0.3.0
-- Added Changelog generator
-- Fix nits on CHANGELOG-HUMAN.md
-- Add changelog generator configuration + human changelog
-- Disable crate publishing + UniFFI catchup
-- Rename 'group_info' into 'public_group_state' to remain consistent with draft-12
-- Remove 'SelfKeypackageNotFound' error which is not used
-- Fix some clippy lints
-- Remove 'group()' test helper and inlined it
-- Fix cli compilation and update it a bit
-- Removed CryptoError variant `CentralConfigurationError`
-- Avoid cloning credential
-- Use shorthand for not using generics in conversation
-- Factorize group accessors in conversation.rs
-- Fix some clippy warnings
-- Remove .idea in sample anroid app
-- Remove unnecessary path prefixes imports
-- Remove useless mutable borrow in Client methods
-- Add Intellij files to gitignore
-- Bump jvm and android version
-- Add jvm linux support
-
-### Performance
-
-- Avoid cloning conversation extra members when creating the former
-
-### Refactor
-
-- Moved run_with_* test utils in a test_utils mod
-- Use shorthand for generics in Central
-- Factorize keystore update when group state change from a conversation pov
-
-### Testing
-
-- Add tests for 'commit_pending_proposals'
-- Verify that commit operation are returning a valid welcome if any
-- Use Index trait to access conversation from Central instead of duplicate accessor
-- Use central instead of conversation
-- Fix minor clippy lints in tests
-- Apply clippy suggestions on test sources
-- Reorganize tests in conversation.rs
-- Nest conversation tests in dedicated modules
-- Verify adding a keypackage to a ConversationMember
-
-
-### Bug Fixes
-
-- Set correct path to toolchain depending on platform & copy bindings
-- Fix broken tests
-- Tests fix
-- Fixed iOS WAL behavior for SQLite-backed stores
-- Fix Keystore trait having update method removed
-- Clippy + fmt pass on core-crypto
-- Fmt + clippy pass
-- Migrations were incorrectly defined
-
-### Features
-
-- Add android project
-- Add tasks for building and copying jvm resources
-- Add jvm project
-- WIP hand-written ts bindings
-- Generate Swift & Kotlin bindings 🎉
-- Updated deps
-- Added salt in keychain management instead of flat AES-encrypted file
-- Added WIP DS mockup based on QUIC
-- Added ability to create conversations (!!!)
-- Added api support for in-memory keystore
-- Added in-memory faculties for keystore
-- Added benches for the MLS key management
-- Added benches & fixed performance issues
-- Added integration tests + fixes
-- Implemented LRU cache for keystore
-- Added support for Proteus PreKeys
-- Progress + fix store compilation to WASM
-
-### Miscellaneous Tasks
-
-- Configure wire maven repository
-- Clean up gradle files
+* Add Apple M1 support for the JVM bindings
+* Rename callback `client_id_belongs_to_one_of`
+* Added Proteus compatibility layer support
+* Added API to export secret key derived from the group and client ids from the members
+* Change CommitBundle signature
+    * The `decrypt` API now returns if the decrypted message changed the epoch
+* Members can now rejoin group by external commits
+    * Validate received external commits
+    * Added `clear_pending_group_from_external_commit`
+    * External commit returns a bundle containing the PGS
 
-</details>
 
 ## [0.5.2] - 2022-27-09
 
@@ -745,6 +586,42 @@ Note: all the platforms marked with (⚠️) above will get a round of polish fo
 <details>
     <summary>git-conventional changelog</summary>
 
+### Bug Fixes
+
+- Set correct path to toolchain depending on platform & copy bindings
+- Fix broken tests
+- Tests fix
+- Fixed iOS WAL behavior for SQLite-backed stores
+- Fix Keystore trait having update method removed
+- Clippy + fmt pass on core-crypto
+- Fmt + clippy pass
+- Migrations were incorrectly defined
+
+### Features
+
+- Add android project
+- Add tasks for building and copying jvm resources
+- Add jvm project
+- WIP hand-written ts bindings
+- Generate Swift & Kotlin bindings 🎉
+- Updated deps
+- Added salt in keychain management instead of flat AES-encrypted file
+- Added WIP DS mockup based on QUIC
+- Added ability to create conversations (!!!)
+- Added api support for in-memory keystore
+- Added in-memory faculties for keystore
+- Added benches for the MLS key management
+- Added benches & fixed performance issues
+- Added integration tests + fixes
+- Implemented LRU cache for keystore
+- Added support for Proteus PreKeys
+- Progress + fix store compilation to WASM
+
+### Miscellaneous Tasks
+
+- Configure wire maven repository
+- Clean up gradle files
+
 </details>
 
 Initial stable release with a reduced featureset