├── .github ├── dependabot.yml └── workflows │ └── check.yml ├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── foo.file └── src ├── async_digest.rs ├── lib.rs ├── openssl_sha256.rs └── tests.rs /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "cargo" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "weekly" 12 | -------------------------------------------------------------------------------- /.github/workflows/check.yml: -------------------------------------------------------------------------------- 1 | name: check 2 | on: 3 | push: 4 | branches: 5 | - "*" 6 | tags: 7 | - "*" 8 | pull_request: 9 | branches: 10 | - "*" 11 | 12 | jobs: 13 | build: 14 | strategy: 15 | matrix: 16 | os: 17 | - ubuntu-latest 18 | - macos-latest 19 | runs-on: ${{ matrix.os }} 20 | steps: 21 | - name: Checkout 22 | uses: actions/checkout@v2 23 | with: 24 | submodules: true 25 | - uses: actions-rs/toolchain@v1 26 | with: 27 | toolchain: stable 28 | override: true 29 | components: clippy, rustfmt 30 | - name: Check format 31 | run: cargo fmt --all 32 | - name: Check fix 33 | run: cargo fix && cargo fix 34 | - name: Check with clippy 35 | run: cargo clippy --all -- -D warnings 36 | - name: Build Release 37 | run: cargo build --release --all-features 38 | - name: Run tests 39 | run: cargo test --all-features --all 40 | 41 | # build on nightly 42 | - uses: actions-rs/toolchain@v1 43 | with: 44 | toolchain: nightly 45 | override: true 46 | - name: Build on nightly 47 | run: cargo build --release --all-features 48 | windows-vcpkg: 49 | name: windows-vcpkg 50 | runs-on: windows-latest 51 | needs: [ build ] 52 | steps: 53 | - uses: actions/checkout@v3 54 | - uses: sfackler/actions/rustup@master 55 | - run: echo "version=$(rustc --version)" >> $GITHUB_OUTPUT 56 | id: rust-version 57 | - run: echo "VCPKG_ROOT=$env:VCPKG_INSTALLATION_ROOT" | Out-File -FilePath $env:GITHUB_ENV -Append 58 | - run: vcpkg install openssl:x64-windows-static-md 59 | - uses: actions-rs/toolchain@v1 60 | with: 61 | toolchain: stable 62 | override: true 63 | components: clippy, rustfmt 64 | - name: Check format 65 | run: cargo fmt --all 66 | - name: Check fix 67 | run: cargo fix && cargo fix 68 | - name: Check with clippy 69 | run: cargo clippy --all -- -D warnings 70 | - name: Build Release 71 | run: cargo build --release 72 | - name: Run tests 73 | run: cargo test --all-features --all 74 | - uses: actions-rs/toolchain@v1 75 | with: 76 | toolchain: nightly 77 | override: true 78 | - name: Build on nightly 79 | run: cargo build --release 80 | 81 | publish-crate: 82 | if: startsWith(github.ref, 'refs/tags/v') 83 | runs-on: ubuntu-latest 84 | needs: [ windows-vcpkg ] 85 | steps: 86 | - name: Set up Rust 87 | uses: hecrj/setup-rust-action@v2 88 | - uses: actions/checkout@v4 89 | - name: Publish 90 | shell: bash 91 | run: | 92 | cargo publish --token ${{ secrets.CRATES_GITHUB_TOKEN }} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | .idea/ 3 | Cargo.lock -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "sha256" 3 | version = "1.6.0" 4 | authors = ["baoyachi "] 5 | edition = "2018" 6 | description = "sha256 crypto digest" 7 | keywords = ["sha256", "hash", "digest"] 8 | readme = "README.md" 9 | categories = ["cryptography"] 10 | repository = "https://github.com/baoyachi/sha256-rs" 11 | license = "MIT OR Apache-2.0" 12 | 13 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 14 | 15 | [dependencies] 16 | hex = "0.4.2" 17 | sha2 = { version = "0.10.6", default-features = false } 18 | openssl = { version = "0.10.54", optional = true, default-features = false } 19 | async-trait = "0.1.68" 20 | tokio = { version = "1.28.2", optional = true, features = ["io-util", "fs"] } 21 | bytes = "1.4.0" 22 | 23 | [features] 24 | default = ["async"] 25 | native_openssl = ["openssl"] 26 | async = ["tokio"] 27 | 28 | [dev-dependencies] 29 | tokio = { version = "1.28.2", features = ["full"] } 30 | tokio-test = "0.4.2" 31 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2022] [baoyachi of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2021-present baoyachi and others 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be included 12 | in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 17 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 18 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 19 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 20 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sha256 crypto digest 2 | 3 | [docsrs]: https://docs.rs/sha256 4 | 5 | [![GitHub Actions](https://github.com/baoyachi/sha256-rs/workflows/check/badge.svg)](https://github.com/baoyachi/sha256-rs/actions?query=workflow%3Abuild) 6 | [![Crates.io](https://img.shields.io/crates/v/sha256.svg)](https://crates.io/crates/sha256) 7 | [![Docs.rs](https://docs.rs/sha256/badge.svg)](https://docs.rs/sha256) 8 | [![Download](https://img.shields.io/crates/d/sha256)](https://crates.io/crates/sha256) 9 | 10 | 11 | ## Examples 12 | 13 | #### sha256 digest function 14 | 15 | ```rust 16 | use sha256::digest; 17 | 18 | fn main() { 19 | let input = String::from("hello"); 20 | let val = digest(input); 21 | assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 22 | 23 | //sha256 digest &str 24 | let input = "hello"; 25 | let val = digest(input); 26 | assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 27 | 28 | //sha256 digest &mut &str 29 | let mut input = "hello"; 30 | let val = digest(&mut input); 31 | assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 32 | 33 | //sha256 digest char 34 | let mut input = 'π'; 35 | let val = digest(input); 36 | assert_eq!(val,"2617fcb92baa83a96341de050f07a3186657090881eae6b833f66a035600f35a"); 37 | 38 | 39 | let input = b"hello"; 40 | let val = digest(input); 41 | assert_eq!(val, "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 42 | } 43 | ``` 44 | 45 | #### sha256 try_digest function 46 | 47 | ```rust 48 | use sha256::try_digest; 49 | use std::path::Path; 50 | 51 | fn main() { 52 | let input = Path::new("./foo.file"); 53 | let val = try_digest(input).unwrap(); 54 | assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1"); 55 | } 56 | ``` 57 | 58 | -------------------------------------------------------------------------------- /foo.file: -------------------------------------------------------------------------------- 1 | hello sha256 -------------------------------------------------------------------------------- /src/async_digest.rs: -------------------------------------------------------------------------------- 1 | use crate::{CalculatorSelector, TrySha256Digest}; 2 | use bytes::BytesMut; 3 | use std::io; 4 | 5 | /// sha256 digest file 6 | /// 7 | /// # Examples 8 | /// 9 | /// ```rust 10 | /// use sha256::{try_async_digest}; 11 | /// use std::path::Path; 12 | /// let input = Path::new("./foo.file"); 13 | /// tokio_test::block_on(async{ 14 | /// let val = try_async_digest(input).await.unwrap(); 15 | /// assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1") 16 | /// }); 17 | /// 18 | /// ``` 19 | pub async fn try_async_digest(input: D) -> Result { 20 | input.async_digest().await 21 | } 22 | 23 | /// sha256 digest file 24 | /// 25 | /// # Examples 26 | /// 27 | /// ```rust 28 | /// use sha256::{try_async_openssl_digest}; 29 | /// use std::path::Path; 30 | /// let input = Path::new("./foo.file"); 31 | /// tokio_test::block_on(async{ 32 | /// let val = try_async_openssl_digest(input).await.unwrap(); 33 | /// assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1") 34 | /// }); 35 | /// ``` 36 | #[cfg(feature = "native_openssl")] 37 | pub async fn try_async_openssl_digest(input: D) -> Result { 38 | input.async_openssl_digest().await 39 | } 40 | 41 | #[async_trait::async_trait] 42 | pub trait AsyncCalculatorInput { 43 | async fn read_inner(&mut self, buf: &mut BytesMut) -> io::Result; 44 | } 45 | 46 | pub async fn async_calc(mut input: I, mut selector: S) -> io::Result 47 | where 48 | I: AsyncCalculatorInput, 49 | S: CalculatorSelector, 50 | { 51 | let mut buf = BytesMut::with_capacity(1024); 52 | loop { 53 | buf.clear(); 54 | let len = input.read_inner(&mut buf).await?; 55 | if len == 0 { 56 | break; 57 | } 58 | selector.update_inner(&buf[0..len]); 59 | } 60 | let hash = selector.finish_inner(); 61 | Ok(hex::encode(hash)) 62 | } 63 | 64 | #[async_trait::async_trait] 65 | impl AsyncCalculatorInput for tokio::io::BufReader 66 | where 67 | R: tokio::io::AsyncRead + Unpin + Send, 68 | { 69 | async fn read_inner(&mut self, buf: &mut BytesMut) -> io::Result { 70 | use tokio::io::AsyncReadExt; 71 | 72 | self.read_buf(buf).await 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! sha256 crypto digest util 2 | //! 3 | //! ```rust 4 | //! 5 | //! use sha256::{digest, try_digest}; 6 | //! 7 | //! //sha256 digest String 8 | //! let input = String::from("hello"); 9 | //! let val = digest(input); 10 | //! assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 11 | //! 12 | //! //sha256 digest &str 13 | //! let input = "hello"; 14 | //! let val = digest(input); 15 | //! assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 16 | //! 17 | //! //sha256 digest &mut &str 18 | //! let mut input = "hello"; 19 | //! let val = digest(&mut input); 20 | //! assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 21 | //! 22 | //! //sha256 digest char 23 | //! let mut input = 'π'; 24 | //! let val = digest(input); 25 | //! assert_eq!(val,"2617fcb92baa83a96341de050f07a3186657090881eae6b833f66a035600f35a"); 26 | //! 27 | //! //sha256 digest bytes 28 | //! let input = b"hello"; 29 | //! let val = digest(input); 30 | //! assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"); 31 | //! 32 | //! //sha256 digest file 33 | //! use std::path::Path; 34 | //! let input = Path::new("./foo.file"); 35 | //! let val = try_digest(input).unwrap(); 36 | //! assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1"); 37 | //! 38 | //! ``` 39 | 40 | #[cfg(feature = "async")] 41 | pub mod async_digest; 42 | #[cfg(feature = "native_openssl")] 43 | mod openssl_sha256; 44 | 45 | #[cfg(feature = "native_openssl")] 46 | use crate::openssl_sha256::OpenSslSha256; 47 | 48 | #[cfg(feature = "async")] 49 | pub use async_digest::*; 50 | 51 | use sha2::digest::Output; 52 | use sha2::{Digest, Sha256}; 53 | use std::fmt::Debug; 54 | use std::fs; 55 | use std::io; 56 | use std::io::{BufReader, Read}; 57 | use std::path::Path; 58 | 59 | #[cfg(test)] 60 | mod tests; 61 | 62 | /// sha256 digest string 63 | /// 64 | /// # Examples 65 | /// 66 | /// ```rust 67 | /// use sha256::digest; 68 | /// let input = "hello"; 69 | /// let val = digest(input); 70 | /// assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824") 71 | /// ``` 72 | /// 73 | pub fn digest(input: D) -> String { 74 | input.digest() 75 | } 76 | 77 | /// sha256 digest file 78 | /// 79 | /// # Examples 80 | /// 81 | /// ```rust 82 | /// use sha256::try_digest; 83 | /// use std::path::Path; 84 | /// let input = Path::new("./foo.file"); 85 | /// let val = try_digest(input).unwrap(); 86 | /// assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1") 87 | /// ``` 88 | pub fn try_digest(input: D) -> Result { 89 | input.digest() 90 | } 91 | 92 | /// sha256 digest bytes 93 | /// 94 | /// # Examples 95 | /// 96 | /// ```rust 97 | /// use sha256::digest_bytes; 98 | /// let input = b"hello"; 99 | /// let val = digest_bytes(input); 100 | /// assert_eq!(val,"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824") 101 | /// ``` 102 | /// 103 | #[deprecated(since = "1.1.0", note = "Use new function `digest()` instead")] 104 | pub fn digest_bytes(input: &[u8]) -> String { 105 | __digest__(input) 106 | } 107 | 108 | /// sha256 digest file 109 | /// 110 | /// # Examples 111 | /// 112 | /// ```rust 113 | /// use sha256::digest_file; 114 | /// use std::path::Path; 115 | /// let input = Path::new("./foo.file"); 116 | /// let val = digest_file(input).unwrap(); 117 | /// assert_eq!(val,"433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1") 118 | /// ``` 119 | #[deprecated(since = "1.1.0", note = "Use new function `try_digest()` instead")] 120 | pub fn digest_file>(path: P) -> Result { 121 | let bytes = fs::read(path)?; 122 | Ok(__digest__(&bytes)) 123 | } 124 | 125 | pub trait Sha256Digest { 126 | fn digest(self) -> String; 127 | } 128 | 129 | #[async_trait::async_trait] 130 | pub trait TrySha256Digest { 131 | type Error: Debug; 132 | 133 | fn digest(self) -> Result; 134 | 135 | #[cfg(feature = "async")] 136 | async fn async_digest(self) -> Result; 137 | 138 | #[cfg(feature = "native_openssl")] 139 | async fn async_openssl_digest(self) -> Result; 140 | } 141 | 142 | impl Sha256Digest for &[u8; N] { 143 | fn digest(self) -> String { 144 | __digest__(self) 145 | } 146 | } 147 | 148 | impl Sha256Digest for &[u8] { 149 | fn digest(self) -> String { 150 | __digest__(self) 151 | } 152 | } 153 | 154 | impl Sha256Digest for &Vec { 155 | fn digest(self) -> String { 156 | __digest__(self) 157 | } 158 | } 159 | 160 | impl Sha256Digest for Vec { 161 | fn digest(self) -> String { 162 | __digest__(&self) 163 | } 164 | } 165 | 166 | impl Sha256Digest for String { 167 | fn digest(self) -> String { 168 | __digest__(self.as_bytes()) 169 | } 170 | } 171 | 172 | impl Sha256Digest for &str { 173 | fn digest(self) -> String { 174 | __digest__(self.as_bytes()) 175 | } 176 | } 177 | 178 | impl Sha256Digest for char { 179 | fn digest(self) -> String { 180 | __digest__(self.encode_utf8(&mut [0; 4]).as_bytes()) 181 | } 182 | } 183 | 184 | impl Sha256Digest for &mut &str { 185 | fn digest(self) -> String { 186 | __digest__(self.as_bytes()) 187 | } 188 | } 189 | 190 | impl Sha256Digest for &String { 191 | fn digest(self) -> String { 192 | __digest__(self.as_bytes()) 193 | } 194 | } 195 | 196 | #[async_trait::async_trait] 197 | impl

TrySha256Digest for P 198 | where 199 | P: AsRef + Send, 200 | { 201 | type Error = io::Error; 202 | 203 | fn digest(self) -> Result { 204 | let f = fs::File::open(self)?; 205 | let reader = BufReader::new(f); 206 | let sha = Sha256::new(); 207 | calc(reader, sha) 208 | } 209 | 210 | #[cfg(feature = "async")] 211 | async fn async_digest(self) -> Result { 212 | let f = tokio::fs::File::open(self).await?; 213 | let reader = tokio::io::BufReader::new(f); 214 | let sha = Sha256::new(); 215 | async_calc(reader, sha).await 216 | } 217 | 218 | #[cfg(all(feature = "async", feature = "native_openssl"))] 219 | async fn async_openssl_digest(self) -> Result { 220 | let f = tokio::fs::File::open(self).await?; 221 | let reader = tokio::io::BufReader::new(f); 222 | let sha = OpenSslSha256::new(); 223 | async_calc(reader, sha).await 224 | } 225 | } 226 | 227 | fn __digest__(data: &[u8]) -> String { 228 | hex::encode(Sha256::digest(data)) 229 | } 230 | 231 | trait CalculatorInput { 232 | fn read_inner(&mut self, buf: &mut [u8]) -> std::io::Result; 233 | } 234 | 235 | impl CalculatorInput for T 236 | where 237 | T: Read, 238 | { 239 | fn read_inner(&mut self, buf: &mut [u8]) -> io::Result { 240 | self.read(buf) 241 | } 242 | } 243 | 244 | pub trait CalculatorSelector { 245 | type FinishType: AsRef<[u8]>; 246 | fn update_inner(&mut self, data: &[u8]); 247 | fn finish_inner(self) -> Self::FinishType; 248 | } 249 | 250 | impl CalculatorSelector for Sha256 { 251 | type FinishType = Output; 252 | 253 | fn update_inner(&mut self, data: &[u8]) { 254 | self.update(data) 255 | } 256 | 257 | fn finish_inner(self) -> Self::FinishType { 258 | self.finalize() 259 | } 260 | } 261 | 262 | fn calc(mut input: I, mut selector: S) -> io::Result 263 | where 264 | I: CalculatorInput, 265 | S: CalculatorSelector, 266 | { 267 | let mut buf = [0u8; 1024]; 268 | loop { 269 | let len = input.read_inner(&mut buf)?; 270 | if len == 0 { 271 | break; 272 | } 273 | selector.update_inner(&buf[0..len]); 274 | } 275 | let hash = selector.finish_inner(); 276 | Ok(hex::encode(hash)) 277 | } 278 | -------------------------------------------------------------------------------- /src/openssl_sha256.rs: -------------------------------------------------------------------------------- 1 | use crate::CalculatorSelector; 2 | 3 | pub type OpenSslSha256 = openssl::sha::Sha256; 4 | 5 | impl CalculatorSelector for OpenSslSha256 { 6 | type FinishType = [u8; 32]; 7 | 8 | fn update_inner(&mut self, data: &[u8]) { 9 | self.update(data) 10 | } 11 | 12 | fn finish_inner(self) -> Self::FinishType { 13 | self.finish() 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/tests.rs: -------------------------------------------------------------------------------- 1 | use super::*; 2 | 3 | #[cfg(feature = "native_openssl")] 4 | #[test] 5 | fn test_openssl() { 6 | let input = Path::new("./foo.file"); 7 | let f = fs::File::open(input).unwrap(); 8 | let reader = BufReader::new(f); 9 | let sha = openssl::sha::Sha256::new(); 10 | assert_eq!( 11 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 12 | calc(reader, sha).unwrap() 13 | ); 14 | } 15 | 16 | #[test] 17 | fn test_sha256() { 18 | let input = Path::new("./foo.file"); 19 | let f = fs::File::open(input).unwrap(); 20 | let reader = BufReader::new(f); 21 | let sha = Sha256::new(); 22 | assert_eq!( 23 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 24 | calc(reader, sha).unwrap() 25 | ); 26 | } 27 | 28 | #[cfg(all(feature = "async", feature = "native_openssl"))] 29 | #[tokio::test] 30 | async fn test_async_openssl() { 31 | let input = Path::new("./foo.file"); 32 | let f = tokio::fs::File::open(input).await.unwrap(); 33 | let reader = tokio::io::BufReader::new(f); 34 | let sha = openssl::sha::Sha256::new(); 35 | assert_eq!( 36 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 37 | async_calc(reader, sha).await.unwrap() 38 | ); 39 | } 40 | 41 | #[cfg(feature = "async")] 42 | #[tokio::test] 43 | async fn test_async() { 44 | let input = Path::new("./foo.file"); 45 | let f = tokio::fs::File::open(input).await.unwrap(); 46 | let reader = tokio::io::BufReader::new(f); 47 | let sha = Sha256::new(); 48 | assert_eq!( 49 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 50 | async_calc(reader, sha).await.unwrap() 51 | ); 52 | } 53 | 54 | #[cfg(all(feature = "async", feature = "native_openssl"))] 55 | #[tokio::test] 56 | async fn test_try_async_openssl_digest() { 57 | let hash = try_async_openssl_digest("./foo.file").await.unwrap(); 58 | assert_eq!( 59 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 60 | hash 61 | ); 62 | } 63 | 64 | #[cfg(feature = "async")] 65 | #[tokio::test] 66 | async fn test_try_async_digest() { 67 | let hash = try_async_digest("./foo.file").await.unwrap(); 68 | assert_eq!( 69 | "433855b7d2b96c23a6f60e70c655eb4305e8806b682a9596a200642f947259b1", 70 | hash 71 | ); 72 | } 73 | 74 | #[cfg(feature = "async")] 75 | #[tokio::test] 76 | async fn test_async_parity() { 77 | let bytes = (0..0x1000).map(|v| (v % 256) as u8).collect::>(); 78 | let val = digest(&bytes); 79 | 80 | let async_res = { 81 | let bytes = &bytes; 82 | // We want to force Poll::Pending on reads during async_calc, which may break parity 83 | // between sync and async hashing. 84 | let (client, mut server) = tokio::io::duplex(64); 85 | let reader = tokio::io::BufReader::new(client); 86 | let sha = Sha256::new(); 87 | 88 | use tokio::io::AsyncWriteExt; 89 | tokio::join! { 90 | async_calc(reader, sha), 91 | async move { 92 | server.write_all(&bytes[..]).await.unwrap(); 93 | core::mem::drop(server); 94 | } 95 | } 96 | .0 97 | .unwrap() 98 | }; 99 | 100 | let sync_res = { 101 | let reader = BufReader::new(&*bytes); 102 | let sha = Sha256::new(); 103 | calc(reader, sha).unwrap() 104 | }; 105 | assert_eq!(val, async_res); 106 | assert_eq!(async_res, sync_res); 107 | } 108 | 109 | #[cfg(all(feature = "async", feature = "native_openssl"))] 110 | #[tokio::test] 111 | async fn test_async_parity_openssl() { 112 | let bytes = (0..0x1000).map(|v| (v % 256) as u8).collect::>(); 113 | let val = digest(&bytes); 114 | 115 | let async_res = { 116 | let bytes = &bytes; 117 | // We want to force Poll::Pending on reads during async_calc, which may break parity 118 | // between sync and async hashing. 119 | let (client, mut server) = tokio::io::duplex(64); 120 | let reader = tokio::io::BufReader::new(client); 121 | let sha = OpenSslSha256::new(); 122 | 123 | use tokio::io::AsyncWriteExt; 124 | tokio::join! { 125 | async_calc(reader, sha), 126 | async move { 127 | server.write_all(&bytes[..]).await.unwrap(); 128 | core::mem::drop(server); 129 | } 130 | } 131 | .0 132 | .unwrap() 133 | }; 134 | 135 | let sync_res = { 136 | let reader = BufReader::new(&*bytes); 137 | let sha = OpenSslSha256::new(); 138 | calc(reader, sha).unwrap() 139 | }; 140 | assert_eq!(val, async_res); 141 | assert_eq!(async_res, sync_res); 142 | } 143 | --------------------------------------------------------------------------------