diff --git a/.github/workflows/digest-io-async.yml b/.github/workflows/digest-io-async.yml new file mode 100644 index 00000000..5a7dab3d --- /dev/null +++ b/.github/workflows/digest-io-async.yml @@ -0,0 +1,48 @@ +name: digest-io-async + +on: + pull_request: + paths: + - "digest-io-async/**" + - "Cargo.*" + push: + branches: master + +permissions: + contents: read + +defaults: + run: + working-directory: digest-io-async + +env: + CARGO_INCREMENTAL: 0 + RUSTFLAGS: "-Dwarnings" + +# Cancels CI jobs when new commits are pushed to a PR branch +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + minimal-versions: + uses: RustCrypto/actions/.github/workflows/minimal-versions.yml@master + with: + working-directory: ${{ github.workflow }} + + test: + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - 1.85.0 # MSRV + - stable + steps: + - uses: actions/checkout@v7 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + - run: cargo test --no-default-features + - run: cargo test + - run: cargo test --all-features diff --git a/Cargo.lock b/Cargo.lock index 6870a26c..13a57b98 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -42,6 +42,15 @@ dependencies = [ "zeroize 1.9.0 (registry+https://github.com/rust-lang/crates.io-index)", ] +[[package]] +name = "block-buffer" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa" +dependencies = [ + "hybrid-array", +] + [[package]] name = "block-padding" version = "0.4.2" @@ -49,6 +58,12 @@ dependencies = [ "hybrid-array", ] +[[package]] +name = "bytes" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" + [[package]] name = "cfg-if" version = "1.0.4" @@ -62,6 +77,12 @@ dependencies = [ "proptest", ] +[[package]] +name = "const-oid" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6ef517f0926dd24a1582492c791b6a4818a4d94e789a334894aa15b0d12f55c" + [[package]] name = "cpubits" version = "0.1.1" @@ -82,6 +103,15 @@ dependencies = [ "libc", ] +[[package]] +name = "crypto-common" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453" +dependencies = [ + "hybrid-array", +] + [[package]] name = "ctutils" version = "0.4.2" @@ -98,6 +128,39 @@ dependencies = [ "hybrid-array", ] +[[package]] +name = "digest" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2" +dependencies = [ + "block-buffer 0.12.1 (registry+https://github.com/rust-lang/crates.io-index)", + "const-oid", + "crypto-common", +] + +[[package]] +name = "digest-io" +version = "0.1.0" +dependencies = [ + "digest", + "sha2", + "sha3", +] + +[[package]] +name = "digest-io-async" +version = "0.1.0" +dependencies = [ + "bytes", + "digest", + "futures", + "pin-project-lite", + "sha2", + "tokio", + "tokio-util", +] + [[package]] name = "errno" version = "0.3.14" @@ -120,6 +183,94 @@ version = "1.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" +[[package]] +name = "futures" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a31d2a3fbaaeb2af2368bbdd904aa8e812d3c04a1ee10d3171f52d556e5d0a3" +dependencies = [ + "futures-channel", + "futures-core", + "futures-executor", + "futures-io", + "futures-sink", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" + +[[package]] +name = "futures-executor" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "031b47cf1a3c6cc8bc2fc76cd437f521619387907d469316e7c0bc278f1f5432" +dependencies = [ + "futures-core", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + +[[package]] +name = "futures-macro" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fb9654ba8355388abeb8dcb4fc62f511300867002afc858860463bdd9fe0c44" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.3", +] + +[[package]] +name = "futures-sink" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1944426bf7d03f1d14f708785e4b33efd750b36d48a157b836b3efc15ede8e1d" + +[[package]] +name = "futures-task" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd" + +[[package]] +name = "futures-util" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-macro", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + [[package]] name = "getrandom" version = "0.3.4" @@ -225,6 +376,12 @@ version = "1.21.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + [[package]] name = "ppv-lite86" version = "0.2.21" @@ -385,7 +542,7 @@ checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 2.0.118", ] [[package]] @@ -401,6 +558,33 @@ dependencies = [ "zmij", ] +[[package]] +name = "sha2" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "446ba717509524cb3f22f17ecc096f10f4822d76ab5c0b9822c5f9c284e825f4" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)", + "digest", +] + +[[package]] +name = "sha3" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be176f1a57ce4e3d31c1a166222d9768de5954f811601fb7ca06fc8203905ce1" +dependencies = [ + "digest", + "keccak", +] + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + [[package]] name = "sponge-cursor" version = "0.1.0" @@ -426,6 +610,17 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "syn" +version = "3.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53e9bae58849f64dfa4f5d5ae372c8341f7305f82a3868709269343628b659a3" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + [[package]] name = "tempfile" version = "3.27.0" @@ -439,6 +634,41 @@ dependencies = [ "windows-sys", ] +[[package]] +name = "tokio" +version = "1.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "202caea871b69668250d242070849eb495be178ed697a3e98aebce5bc81a0bed" +dependencies = [ + "bytes", + "pin-project-lite", + "tokio-macros", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.3", +] + +[[package]] +name = "tokio-util" +version = "0.7.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "494815d09bf52b5548659851081238f0ca39ff638363907596da739561c62c52" +dependencies = [ + "bytes", + "futures-core", + "futures-sink", + "pin-project-lite", + "tokio", +] + [[package]] name = "typenum" version = "1.20.1" @@ -523,7 +753,7 @@ checksum = "1ae7f38b72ec2a254e2b87ef277cf2cd4fb97cbebf944faa6f33354da0867930" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 2.0.118", ] [[package]] @@ -546,7 +776,7 @@ version = "1.5.0" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 2.0.118", ] [[package]] diff --git a/Cargo.toml b/Cargo.toml index a674e416..65fea846 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,6 +9,8 @@ members = [ "ctutils", "cpufeatures", "dbl", + "digest-io", + "digest-io-async", "hex-literal", "inout", "sponge-cursor", diff --git a/digest-io-async/CHANGELOG.md b/digest-io-async/CHANGELOG.md new file mode 100644 index 00000000..fd27ebef --- /dev/null +++ b/digest-io-async/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog +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). + +## Unreleased +- Initial release diff --git a/digest-io-async/Cargo.toml b/digest-io-async/Cargo.toml new file mode 100644 index 00000000..8281b4ce --- /dev/null +++ b/digest-io-async/Cargo.toml @@ -0,0 +1,32 @@ +[package] +name = "digest-io-async" +version = "0.1.0" +authors = ["RustCrypto Developers"] +edition = "2024" +rust-version = "1.85" +documentation = "https://docs.rs/digest-io-async" +readme = "README.md" +repository = "https://github.com/RustCrypto/utils" +license = "MIT OR Apache-2.0" +keywords = ["crypto", "digest", "wrappers", "async", "tokio"] +categories = ["cryptography", "asynchronous"] +description = "Async I/O compatibility wrappers for traits defined in the digest crate" + +[dependencies] +digest = "0.11" +pin-project-lite = { version = "0.2", optional = true } +tokio = { version = "1", default-features = false, features = ["io-util"], optional = true } + +[dev-dependencies] +bytes = "1" +futures = "0.3" +sha2 = "0.11" +tokio = { version = "1", features = ["macros", "rt"] } +tokio-util = { version = "0.7", features = ["io"] } + +[features] +tokio = ["dep:tokio", "dep:pin-project-lite"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] diff --git a/digest-io-async/LICENSE-APACHE b/digest-io-async/LICENSE-APACHE new file mode 100644 index 00000000..78173fa2 --- /dev/null +++ b/digest-io-async/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/digest-io-async/LICENSE-MIT b/digest-io-async/LICENSE-MIT new file mode 100644 index 00000000..82a58781 --- /dev/null +++ b/digest-io-async/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2025 The RustCrypto Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/digest-io-async/README.md b/digest-io-async/README.md new file mode 100644 index 00000000..876d4291 --- /dev/null +++ b/digest-io-async/README.md @@ -0,0 +1,98 @@ +# [RustCrypto]: async `tokio::io`-compatibility wrappers for `digest` + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + +Async counterpart to [`digest-io`], providing `tokio::io`-compatible +wrappers for traits defined in the [`digest`] crate. + +All items are gated behind the `tokio` feature, which is currently the only +supported async runtime. + +## Examples + +Simultaneously reading and hashing file data asynchronously (requires the +`tokio` feature): +```rust,ignore +use digest_io_async::HashReader; +use sha2::Sha256; +use tokio::{fs::File, io}; + +#[tokio::main(flavor = "current_thread")] +async fn main() -> io::Result<()> { + // Create new hashing reader + let f = File::open("Cargo.toml").await?; + let mut reader = HashReader::::new(f); + + // Copy all data out of the file without buffering it up front + let mut sink = Vec::new(); + io::copy(&mut reader, &mut sink).await?; + + // Get the resulting hash over the read data + let hash = reader.finalize(); + println!("Hash: {hash:?}"); + Ok(()) +} +``` + +Simultaneously hashing data and writing it to file asynchronously (requires the +`tokio` feature): +```rust,ignore +use digest_io_async::HashWriter; +use sha2::{Digest, Sha256}; +use tokio::{fs::File, io::AsyncWriteExt}; + +#[tokio::main(flavor = "current_thread")] +async fn main() -> std::io::Result<()> { + // Create new hashing writer + let f = File::create("out.txt").await?; + let mut writer = HashWriter::::new(f); + + // Write data to the file + let data = b"Hello world!"; + writer.write_all(data).await?; + + // Get the resulting hash over written data + let hash = writer.finalize(); + println!("{hash:?}"); + assert_eq!(hash, Sha256::digest(data)); + tokio::fs::remove_file("out.txt").await?; + Ok(()) +} +``` + +## License + +Licensed under either of: + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://img.shields.io/crates/v/digest-io-async.svg +[crate-link]: https://crates.io/crates/digest-io-async +[docs-image]: https://docs.rs/digest-io-async/badge.svg +[docs-link]: https://docs.rs/digest-io-async/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils +[build-image]: https://github.com/RustCrypto/utils/actions/workflows/digest-io-async.yml/badge.svg?branch=master +[build-link]: https://github.com/RustCrypto/utils/actions/workflows/digest-io-async.yml?query=branch:master + +[//]: # (general links) + +[RustCrypto]: https://github.com/rustcrypto +[`digest-io`]: https://docs.rs/digest-io +[`digest`]: https://docs.rs/digest diff --git a/digest-io-async/src/lib.rs b/digest-io-async/src/lib.rs new file mode 100644 index 00000000..861caab5 --- /dev/null +++ b/digest-io-async/src/lib.rs @@ -0,0 +1,18 @@ +#![doc = include_str!("../README.md")] +#![cfg_attr(docsrs, feature(doc_cfg))] +#![forbid(unsafe_code)] +#![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_debug_implementations)] + +#[cfg(feature = "tokio")] +mod reader; +#[cfg(feature = "tokio")] +mod writer; + +#[cfg(feature = "tokio")] +pub use reader::HashReader; +#[cfg(feature = "tokio")] +pub use writer::HashWriter; diff --git a/digest-io-async/src/reader.rs b/digest-io-async/src/reader.rs new file mode 100644 index 00000000..429f682c --- /dev/null +++ b/digest-io-async/src/reader.rs @@ -0,0 +1,160 @@ +use digest::{Digest, FixedOutputReset, Output, Reset}; +use std::{ + io, + pin::Pin, + task::{Context, Poll}, +}; +use tokio::io::{AsyncRead, ReadBuf}; + +pin_project_lite::pin_project! { + /// Abstraction over an [`AsyncRead`] reader which hashes the data being read. + #[derive(Debug)] + pub struct HashReader { + #[pin] + reader: R, + hasher: D, + } +} + +impl HashReader { + /// Construct a new `HashReader` given an existing `reader` by value. + pub fn new(reader: R) -> Self { + Self::new_from_parts(D::new(), reader) + } + + /// Construct a new `HashReader` given an existing `hasher` and `reader` by value. + pub fn new_from_parts(hasher: D, reader: R) -> Self { + HashReader { reader, hasher } + } + + /// Replace the reader with another reader + pub fn replace_reader(&mut self, reader: R) { + self.reader = reader; + } + + /// Gets a reference to the underlying hasher + pub fn get_hasher(&self) -> &D { + &self.hasher + } + + /// Gets a reference to the underlying reader + pub fn get_reader(&self) -> &R { + &self.reader + } + + /// Gets a mutable reference to the underlying hasher + pub fn get_hasher_mut(&mut self) -> &mut D { + &mut self.hasher + } + + /// Gets a mutable reference to the underlying reader + /// Direct reads from the underlying reader are not hashed + pub fn get_reader_mut(&mut self) -> &mut R { + &mut self.reader + } + + /// Consume the HashReader and return its hasher + pub fn into_hasher(self) -> D { + self.hasher + } + + /// Consume the HashReader and return its internal reader + pub fn into_inner_reader(self) -> R { + self.reader + } + + /// Consume the HashReader and return its hasher and internal reader + pub fn into_parts(self) -> (D, R) { + (self.hasher, self.reader) + } + + /// Retrieve result and consume HashReader instance. + pub fn finalize(self) -> Output { + self.hasher.finalize() + } + + /// Write result into provided array and consume the HashReader instance. + pub fn finalize_into(self, out: &mut Output) { + self.hasher.finalize_into(out) + } + + /// Get output size of the hasher + pub fn output_size() -> usize { + ::output_size() + } +} + +impl Clone for HashReader { + fn clone(&self) -> HashReader { + HashReader { + reader: self.reader.clone(), + hasher: self.hasher.clone(), + } + } +} + +impl AsyncRead for HashReader { + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + let this = self.project(); + let filled_before = buf.filled().len(); + let result = this.reader.poll_read(cx, buf); + if let Poll::Ready(Ok(())) = result { + let filled_after = buf.filled().len(); + if filled_after > filled_before { + this.hasher + .update(&buf.filled()[filled_before..filled_after]); + } + } + result + } +} + +impl HashReader { + /// Retrieve result and reset hasher instance. + pub fn finalize_reset(&mut self) -> Output { + Digest::finalize_reset(&mut self.hasher) + } + + /// Write result into provided array and reset the hasher instance. + pub fn finalize_into_reset(&mut self, out: &mut Output) { + Digest::finalize_into_reset(&mut self.hasher, out) + } +} + +impl Reset for HashReader { + fn reset(&mut self) { + Digest::reset(&mut self.hasher) + } +} + +#[cfg(test)] +mod tests { + use super::HashReader; + use bytes::Bytes; + use digest::Digest; + use futures::stream; + use sha2::Sha256; + use tokio_util::io::StreamReader; + + #[tokio::test] + async fn test_async_read() { + let data = b"the quick brown fox jumps over the lazy dog".repeat(1000); + + // Feed the stream chunk by chunk with an odd sized buffer. + let chunks = stream::iter( + data.chunks(37) + .map(|c| Ok::<_, std::io::Error>(Bytes::copy_from_slice(c))) + .collect::>(), + ); + let mut reader = HashReader::::new(StreamReader::new(chunks)); + let mut sink = Vec::new(); + tokio::io::copy(&mut reader, &mut sink).await.unwrap(); + + assert_eq!(sink, data); + assert_eq!(reader.finalize(), Sha256::digest(&data)); + } +} diff --git a/digest-io-async/src/writer.rs b/digest-io-async/src/writer.rs new file mode 100644 index 00000000..3d762ac7 --- /dev/null +++ b/digest-io-async/src/writer.rs @@ -0,0 +1,170 @@ +use digest::{Digest, FixedOutputReset, Output, Reset}; +use std::{ + io, + pin::Pin, + task::{Context, Poll}, +}; +use tokio::io::AsyncWrite; + +pin_project_lite::pin_project! { + /// Abstraction over an [`AsyncWrite`] writer which hashes the data being written. + #[derive(Debug)] + pub struct HashWriter { + #[pin] + writer: W, + hasher: D, + } +} + +impl HashWriter { + /// Construct a new `HashWriter` given an existing `writer` by value. + pub fn new(writer: W) -> Self { + Self::new_from_parts(D::new(), writer) + } + + /// Construct a new `HashWriter` given an existing `hasher` and `writer` by value. + pub fn new_from_parts(hasher: D, writer: W) -> Self { + HashWriter { writer, hasher } + } + + /// Replace the writer with another writer + pub fn replace_writer(&mut self, writer: W) { + self.writer = writer; + } + + /// Gets a reference to the underlying hasher + pub fn get_hasher(&self) -> &D { + &self.hasher + } + + /// Gets a reference to the underlying writer + pub fn get_writer(&self) -> &W { + &self.writer + } + + /// Gets a mutable reference to the underlying hasher + /// Updates to the digest are not written to the underlying writer + pub fn get_hasher_mut(&mut self) -> &mut D { + &mut self.hasher + } + + /// Gets a mutable reference to the underlying writer + /// Direct writes to the underlying writer are not hashed + pub fn get_writer_mut(&mut self) -> &mut W { + &mut self.writer + } + + /// Consume the HashWriter and return its hasher + pub fn into_hasher(self) -> D { + self.hasher + } + + /// Consume the HashWriter and return its internal writer + pub fn into_inner_writer(self) -> W { + self.writer + } + + /// Consume the HashWriter and return its hasher and internal writer + pub fn into_parts(self) -> (D, W) { + (self.hasher, self.writer) + } + + /// Retrieve result and consume HashWriter instance. + pub fn finalize(self) -> Output { + self.hasher.finalize() + } + + /// Write result into provided array and consume the HashWriter instance. + pub fn finalize_into(self, out: &mut Output) { + self.hasher.finalize_into(out) + } + + /// Get output size of the hasher + pub fn output_size() -> usize { + ::output_size() + } +} + +impl Clone for HashWriter { + fn clone(&self) -> HashWriter { + HashWriter { + writer: self.writer.clone(), + hasher: self.hasher.clone(), + } + } +} + +impl AsyncWrite for HashWriter { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + let this = self.project(); + let result = this.writer.poll_write(cx, buf); + if let Poll::Ready(Ok(n)) = result { + if n > 0 { + this.hasher.update(&buf[..n]); + } + } + result + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + self.project().writer.poll_flush(cx) + } + + fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + self.project().writer.poll_shutdown(cx) + } +} + +impl HashWriter { + /// Retrieve result and reset hasher instance. + pub fn finalize_reset(&mut self) -> Output { + Digest::finalize_reset(&mut self.hasher) + } + + /// Write result into provided array and reset the hasher instance. + pub fn finalize_into_reset(&mut self, out: &mut Output) { + Digest::finalize_into_reset(&mut self.hasher, out) + } +} + +impl Reset for HashWriter { + fn reset(&mut self) { + Digest::reset(&mut self.hasher) + } +} + +#[cfg(test)] +mod tests { + use super::HashWriter; + use bytes::Bytes; + use digest::Digest; + use futures::stream; + use sha2::Sha256; + use tokio::io::AsyncWriteExt; + use tokio_util::io::StreamReader; + + #[tokio::test] + async fn test_async_write() { + let data = b"the quick brown fox jumps over the lazy dog".repeat(1000); + + // Feed the stream chunk by chunk with an odd sized buffer. + let chunks = stream::iter( + data.chunks(37) + .map(|c| Ok::<_, std::io::Error>(Bytes::copy_from_slice(c))) + .collect::>(), + ); + let mut source = StreamReader::new(chunks); + + let mut writer = HashWriter::::new(Vec::new()); + tokio::io::copy(&mut source, &mut writer).await.unwrap(); + writer.flush().await.unwrap(); + + let (hasher, sink) = writer.into_parts(); + assert_eq!(sink, data); + assert_eq!(hasher.finalize(), Sha256::digest(&data)); + } +}