# Changelog

This project follows semantic versioning.

Possible log types:

- `[added]` for new features.
- `[changed]` for changes in existing functionality.
- `[deprecated]` for once-stable features removed in upcoming releases.
- `[removed]` for deprecated features removed in this release.
- `[fixed]` for any bug fixes.
- `[security]` to invite users to upgrade in case of vulnerabilities.

### Unreleased

### v0.18.0 (2024-07-13)

- [changed] Upgrade `reqwest` dependency from 0.11 to 0.12, and thus indirectly
  hyper from 0.x to 1.x

### v0.17.0 (2024-03-18)

This release replaces the use of the (now deprecated)
[sodiumoxide](https://github.com/sodiumoxide/sodiumoxide) library with
pure-Rust implementations by [RustCrypto](https://github.com/RustCrypto). This
might entail some breaking changes with regards to key and nonce types.

- [changed] Replace `sodiumoxide` with `crypto_box` and `crypto_secretbox` (#72)
- [changed] Replace re-exports of `PublicKey`, `SecretKey` and `Key`, re-export
  `crypto_secretbox::Nonce`
- [changed] Use dedicated `Nonce` type instead of `&[u8; 24]`
- [changed] Return result in `encrypt_*` functions
- [changed] Use `hmac` and `sha2` crates for calculating MAC
- [changed] The `RecipientKey` type now implements `Debug` and a few other traits
- [changed] The `lookup_pubkey` function now returns a `RecipientKey` wrapper around `PublicKey`
- [changed] The `decrypt_incoming_message` function now accepts a `RecipientKey`, not a `PublicKey`
- [changed] Request errors no longer include the URL, as it may contain sensitive information (#74)

### v0.16.0 (2023-09-04)

- [added] Expose encryption functions: `encrypt` and `encrypt_raw` (#59)
- [added] Support downloading of blobs (#65)
- [added] New `decrypt_file_data` helper function (#67)
- [changed] Remove `mime` dependency in favor of plain strings (#64)
- [changed] The API of `encrypt_file_data` has changed (#67)
- [changed] Add `MessageType::Other(u8)` variant (#58)

### v0.15.1 (2021-12-06)

- [added] send_e2e_file example: Allow setting rendering type and caption (#52)
- [changed] Set timeout of 10s on default HTTP client (#56)
- [changed] Add some more logging

### v0.15.0 (2021-04-02)

This release adds initial support for incoming messages. See #49 for details.

- [added] New `IncomingMessage` type for parsing and decrypting incoming messages
- [added] New methods `decode_incoming_message` and `decrypt_incoming_message` on `E2eApi`
- [added] Validate MAC for incoming messages
- [added] Derive `PartialEq` and `Clone` for most error types
- [added] New `to_hex_string` method on `RecipientKey`
- [removed] Removed `Into<String>` impl for `RecipientKey`, use `to_hex_string` method instead
- [changed] The `lookup_pubkey` function now returns a `PublicKey`, not a `String`
- [changed] `CryptoError` type has three new error variants: `BadNonce`, `BadPadding` and
  `DecryptionFailed`
- [changed] `ApiError` type has one new error variant: `InvalidMac`

### v0.14.1 (2021-03-27)

- [added] New helper function `encrypt_file_data` for encrypting the data and
  thumbnail that is sent inside a file message (#48)

### v0.14.0 (2021-03-27)

This release changes the entire API from blocking to async. This makes it much
easier to integrate the library into asynchronous applications.

If you prefer blocking APIs, simply wrap the async function calls in a
`block_on`-function provided by an async executor like tokio, async-std or
smol.

Additionally, the library no longer depends on OpenSSL, making building much
easier (including static builds).

The last new feature is mainly interesting if you're doing a lot of API calls
from a long-running process: The HTTP client used internally is re-used and you
can even pass in your own client instance. Previously, a new client instance
was created for every request, which prevents connection re-use.

- [added] The internal HTTP client is now being re-used for consecutive requests (#46)
- [added] Allow passing in a custom reqwest `Client` (#46)
- [changed] The API is now fully async (#46)
- [changed] Upgraded to reqwest 0.11 (#44)
- [changed] This library now uses rustls instead of native-tls, this means that
  OpenSSL is no longer required (#44)
- [changed] Replaced quick-error to thiserror
- [changed] Remove warning when using custom endpoint with http (#38)

### v0.13.0 (2020-06-10)

- [added] Allow specifying `RenderingType` for file messages
- [added] Allow specifying media metadata for file messages
- [added] Allow disabling delivery receipts for e2e messages
- [changed] The API for `E2eApi::encrypt_file_msg` has changed
- [changed] The thumbnail media type must now be specified
- [changed] You now need to import `std::str::FromStr` to directly access
  `BlobId::from_str` or `RecipientKey::from_str`

### v0.12.1 (2019-10-22)

- Maintenance release

### v0.12.0 (2019-09-19)

- [added] Blob upload: Add support for `persist` flag (#25)
- [fixed] Fix documentation for BlobId

### v0.11.0 (2019-09-12)

- [added] Re-export `mime::Mime`
- [added] Re-export `sodiumoxide::crypto::secretbox::Key`
- [added] Re-export `sodiumoxide::crypto::box_::{PublicKey, SecretKey}`

### v0.10.0 (2019-08-05)

- [changed] Upgrade docopt to 1.1
- [changed] Stop tracking a certain minimal supported Rust version

### v0.9.1 (2019-04-08)

- [fixed] Pinned docopt to 1.0.x

### v0.9.0 (2019-01-01)

- [changed] Upgrade sodiumoxide to 0.2
- [changed] Upgrade reqwest to 0.9
- [changed] Require Rust 1.31+ (Rust 2018)

### v0.8.0 (2018-04-23)

- [added] Add `ApiBuilder::with_custom_endpoint` method
- [changed] Require Rust 1.21+
- [changed] Constructors of `SimpleApi` and `E2eApi` are now private, use the
  `ApiBuilder` instead
- [changed] Upgrade sodiumoxide dependency to 0.0.16
- [changed] Upgrade reqwest dependency to 0.8
- [changed] Upgrade log dependency to 0.4
- [changed] Upgrade data-encoding dependency to 2.1

### v0.7.1 (2017-08-28)

- [changed] Upgrade data-encoding dependency to 2.0.0-rc.2
- [changed] Upgrade mime_guess dependency to 2.0.0-alpha.2

### v0.7.0 (2017-07-17)

- [changed] Update reqwest dependency to 0.7
- [changed] Update mime dependency to 0.3
- [changed] Require Rust 1.18+

### v0.6.0 (2017-05-29)

- [changed] Upgrade serde to 1.0.0

### v0.5.0 (2017-04-20)

- [changed] Require Rust 1.15+
- [added] Implement `lookup_credits` (#8)
- [added] Implement `lookup_capabilities` (#9)
- [added] Implement blob uploading (#11)
- [added] Implement encrypting of e2e text, image and file messages (#11)

### v0.4.1 (2017-04-12)

- [added] Add `as_bytes` and `Into<String>` to `RecipientKey` (#7)

### v0.4.0 (2017-04-10)

- [changed] Revamped and simplified entire API, it now uses a more
  object-oriented approach (#6)

### v0.3.2 (2017-04-06)

- [fixed] Fix bad API URL
- [changed] Update reqwest dependency to 0.5

### v0.3.1 (2017-04-04)

- [added] Add debug logging to lookups

### v0.3.0 (2017-03-22)

- [changed] Upgrade some dependencies
- [changed] Move from hyper to reqwest
- [changed] Require Rust 1.13+

### v0.2.0 (2016-12-15)

- [added] Implement Threema ID lookups

### v0.1.0 (2016-12-15)

- Initial release