crypto_secretstream v0.1.0 (#58)

Author: tarcieri

Cargo.lock

@@ -5,5 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.1.0 (2022-08-13)
+### Changed
+- Bump `chacha20` to v0.9 ([#50])
+- Bump `chacha20poly1305` to v0.10 ([#50])
+- Upgrade to Rust 2021 edition; MSRV 1.56 ([#42])
+
+[#42]: https://github.com/RustCrypto/nacl-compat/pull/42
+[#50]: https://github.com/RustCrypto/nacl-compat/pull/50
+
 ## 0.0.1 (2021-08-30)
 - Initial release

crypto_secretstream/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "crypto_secretstream"
-version = "0.1.0-pre" # Also update html_root_url in lib.rs when bumping this
+version = "0.1.0"
 description = """
 Pure Rust implementation of libsodium's crypto_secretstream secret-key using
 ChaCha20 and Poly1305

crypto_secretstream/Cargo.toml

@@ -14,6 +14,28 @@ It is tested against [sodiumoxide], a Rust [libsodium] bindings.
 
 [Documentation][docs-link]
 
+## About
+
+Imagine Alice wants to open a safe channel of communication with Bob,
+one that can't be read or modified by anyone else.
+
+One way she can do this is by first agreeing with Bob on a shared secret
+key (such as one generated via a key exchange protocol), then she opens a
+normal/unsafe channel of communication and sends her messages, encrypted
+under this shared key. Then, when Bob receives theses messages, he can
+decrypt each one and the mere knowledge of this shared key ensures that it
+was indeed sent by Alice.
+
+Under the hood, the first message is postfixed with a random number, called
+a nonce, generated by Alice, which is taken into account during encryption
+and decryption. It is then incremented for each new message.
+
+It also allows for additional data to be sent with each message.
+This data is not encrypted but used in the encryption process thus it is
+needed to be known in advance by the receiver.
+It can be useful for adding another layer of security, and is not of a
+fixed size as the key is.
+
 ## License
 
 Licensed under either of:

crypto_secretstream/README.md

@@ -1,30 +1,11 @@
-//! Pure Rust implementation of the [`crypto_secretstream`] AEAD
-//! from [NaCl]-family libraries (e.g. libsodium, TweetNaCl)
-//! which uses [ChaCha20] and [Poly1305].
-//!
-//! # Introduction
-//!
-//! Imagine Alice wants to open a safe channel of communication with Bob,
-//! one that can't be read or modified by anyone else.
-//!
-//! One way she can do this is by first agreeing with Bob on a shared secret
-//! key (such as one generated via a key exchange protocol), then she opens a
-//! normal/unsafe channel of communication and sends her messages, encrypted
-//! under this shared key. Then, when Bob receives theses messages, he can
-//! decrypt each one and the mere knowledge of this shared key ensures that it
-//! was indeed sent by Alice.
-//!
-//! Under the hood, the first message is postfixed with a random number, called
-//! a nonce, generated by Alice, which is taken into account during encryption
-//! and decryption. It is then incremented for each new message.
-//!
-//! It also allows for additional data to be sent with each message.
-//! This data is not encrypted but used in the encryption process thus it is
-//! needed to be known in advance by the receiver.
-//! It can be useful for adding another layer of security, and is not of a
-//! fixed size as the key is.
-//!
-//! # Usage
+#![no_std]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
+    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
+)]
+#![warn(missing_docs, rust_2018_idioms)]
+
+//! ## Usage
 //!
 //! ```rust
 //! use crypto_secretstream::*;
@@ -74,14 +55,6 @@
 //! [ChaCha20]: https://github.com/RustCrypto/stream-ciphers/tree/master/chacha20
 //! [Poly1305]: https://github.com/RustCrypto/universal-hashes/tree/master/poly1305
 
-#![no_std]
-#![doc(
-    html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
-    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
-    html_root_url = "https://docs.rs/crypto_secretstream/0.0.1"
-)]
-#![warn(missing_docs, rust_2018_idioms)]
-
 mod header;
 mod key;
 mod nonce;