cipher-0.4.4/.cargo_vcs_info.json0000644000000001440000000000100123120ustar { "git": { "sha1": "0af93f6076a76757c65cb2ef6f6abd9756440478" }, "path_in_vcs": "cipher" }cipher-0.4.4/CHANGELOG.md000064400000000000000000000067001046102023000127170ustar 00000000000000# 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). ## 0.4.4 (2022-03-09) ### Changed - Move `ParBlocks`/`ParBlocksSizeUser` to the `crypto-common` crate ([#1052]) ### Fixed - Unsoundness triggered by zero block size ([#1277]) [#1052]: https://github.com/RustCrypto/traits/pull/1052 [#1277]: https://github.com/RustCrypto/traits/pull/1277 ## 0.4.3 (2022-02-22) ### Fixed - Do not enable the `alloc` feature by default ([#953]) [#953]: https://github.com/RustCrypto/traits/pull/953 ## 0.4.2 (2022-02-16) [YANKED] ### Fixed - Rename `BlockDecryptMut::decrypt_padded_vec` to `decrypt_padded_vec_mut` for consistency with other methods ([#941]) [#941]: https://github.com/RustCrypto/traits/pull/941 ## 0.4.1 (2022-02-16) [YANKED] ### Added - Allocating padded encrypt/decrypt ([#936]) ### Fixed - Minimal versions build ([#940]) [#940]: https://github.com/RustCrypto/traits/pull/940 [#936]: https://github.com/RustCrypto/traits/pull/936 ## 0.4.0 (2022-02-10) ### Changed - Major rework of traits. Core functionality of block and stream ciphers is defined using rank-2 closures with convenience methods built on top of it. Expose block-level trait for stream ciphers and add generic wrapper around it. The async stream cipher trait is defined as sub-trait of mutable block cipher traits. ([#849]) ### Added - Re-export `rand_core` ([#683]) [#683]: https://github.com/RustCrypto/traits/pull/683 [#849]: https://github.com/RustCrypto/traits/pull/849 ## 0.3.0 (2021-04-28) ### Added - Encrypt/decrypt-only block cipher traits ([#352]) - Re-export `blobby` from root ([#435]) - Block cipher trait blanket impls for refs ([#441]) - `generate_key` method to `New*` trait ([#513]) ### Changed - Consolidate error types ([#373]) - Change `SeekNum` impls to fit with the new `BlockBuffer` ([#435]) - Reorganize modules ([#435]) - Renamed `new_var` to `new_from_slice(s)` ([#442]) [#352]: https://github.com/RustCrypto/traits/pull/352 [#373]: https://github.com/RustCrypto/traits/pull/373 [#435]: https://github.com/RustCrypto/traits/pull/435 [#441]: https://github.com/RustCrypto/traits/pull/441 [#442]: https://github.com/RustCrypto/traits/pull/442 [#513]: https://github.com/RustCrypto/traits/pull/513 ## 0.2.5 (2020-11-01) ### Fixed - Nested macros used old deprecated names ([#360]) [#360]: https://github.com/RustCrypto/traits/pull/360 ## 0.2.4 (2020-11-01) ### Fixed - Macro expansion error ([#358]) [#358]: https://github.com/RustCrypto/traits/pull/358 ## 0.2.3 (2020-11-01) [YANKED] ### Fixed - Legacy macro wrappers ([#356]) [#356]: https://github.com/RustCrypto/traits/pull/356 ## 0.2.2 (2020-11-01) [YANKED] ### Added - `BlockCipher::{encrypt_slice, decrypt_slice}` methods ([#351]) ### Changed - Revamp macro names ([#350]) [#351]: https://github.com/RustCrypto/traits/pull/351 [#350]: https://github.com/RustCrypto/traits/pull/350 ## 0.2.1 (2020-10-16) ### Added - Re-export `generic_array` from toplevel ([#343]) ### Fixed - `dev` macro imports ([#345]) [#343]: https://github.com/RustCrypto/traits/pull/343 [#345]: https://github.com/RustCrypto/traits/pull/345 ## 0.2.0 (2020-10-15) [YANKED] ### Changed - Unify `block-cipher` and `stream-cipher` into `cipher` ([#337]) [#337]: https://github.com/RustCrypto/traits/pull/337 ## 0.1.1 (2015-06-25) ## 0.1.0 (2015-06-24) - Initial release cipher-0.4.4/Cargo.toml0000644000000026340000000000100103160ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.56" name = "cipher" version = "0.4.4" authors = ["RustCrypto Developers"] description = "Traits for describing block ciphers and stream ciphers" documentation = "https://docs.rs/cipher" readme = "README.md" keywords = [ "crypto", "block-cipher", "stream-cipher", "trait", ] categories = [ "cryptography", "no-std", ] license = "MIT OR Apache-2.0" repository = "https://github.com/RustCrypto/traits" [package.metadata.docs.rs] all-features = true rustdoc-args = [ "--cfg", "docsrs", ] [dependencies.blobby] version = "0.3" optional = true [dependencies.crypto-common] version = "0.1.6" [dependencies.inout] version = "0.1" [dependencies.zeroize] version = "1.5" optional = true default-features = false [features] alloc = [] block-padding = ["inout/block-padding"] dev = ["blobby"] rand_core = ["crypto-common/rand_core"] std = [ "alloc", "crypto-common/std", "inout/std", ] cipher-0.4.4/Cargo.toml.orig000064400000000000000000000016471046102023000140020ustar 00000000000000[package] name = "cipher" description = "Traits for describing block ciphers and stream ciphers" version = "0.4.4" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" readme = "README.md" edition = "2021" rust-version = "1.56" documentation = "https://docs.rs/cipher" repository = "https://github.com/RustCrypto/traits" keywords = ["crypto", "block-cipher", "stream-cipher", "trait"] categories = ["cryptography", "no-std"] [dependencies] crypto-common = "0.1.6" inout = "0.1" # optional dependencies blobby = { version = "0.3", optional = true } zeroize = { version = "1.5", optional = true, default-features = false } [features] alloc = [] std = ["alloc", "crypto-common/std", "inout/std"] block-padding = ["inout/block-padding"] rand_core = ["crypto-common/rand_core"] # Enable random key and IV generation methods dev = ["blobby"] [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg", "docsrs"] cipher-0.4.4/LICENSE-APACHE000064400000000000000000000251411046102023000130320ustar 00000000000000 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. cipher-0.4.4/LICENSE-MIT000064400000000000000000000020561046102023000125420ustar 00000000000000Copyright (c) 2016-2020 RustCrypto 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. cipher-0.4.4/README.md000064400000000000000000000042211046102023000123610ustar 00000000000000# RustCrypto: Cipher Traits [![crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] ![Apache2/MIT licensed][license-image] ![Rust Version][rustc-image] [![Project Chat][chat-image]][chat-link] [![Build Status][build-image]][build-link] Traits which define the functionality of [block ciphers] and [stream ciphers]. See [RustCrypto/block-ciphers] and [RustCrypto/stream-ciphers] for algorithm implementations which use these traits. [Documentation][docs-link] ## Minimum Supported Rust Version Rust **1.56** or higher. Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump. ## SemVer Policy - All on-by-default features of this library are covered by SemVer - MSRV is considered exempt from SemVer as noted above ## 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/cipher.svg [crate-link]: https://crates.io/crates/cipher [docs-image]: https://docs.rs/cipher/badge.svg [docs-link]: https://docs.rs/cipher/ [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg [rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260050-traits [build-image]: https://github.com/RustCrypto/traits/workflows/cipher/badge.svg?branch=master&event=push [build-link]: https://github.com/RustCrypto/traits/actions?query=workflow:cipher [//]: # (general links) [block ciphers]: https://en.wikipedia.org/wiki/Block_cipher [stream ciphers]: https://en.wikipedia.org/wiki/Stream_cipher [RustCrypto/block-ciphers]: https://github.com/RustCrypto/block-ciphers [RustCrypto/stream-ciphers]: https://github.com/RustCrypto/stream-ciphers cipher-0.4.4/src/block.rs000064400000000000000000000631661046102023000133460ustar 00000000000000//! Traits used to define functionality of [block ciphers][1] and [modes of operation][2]. //! //! # About block ciphers //! //! Block ciphers are keyed, deterministic permutations of a fixed-sized input //! "block" providing a reversible transformation to/from an encrypted output. //! They are one of the fundamental structural components of [symmetric cryptography][3]. //! //! [1]: https://en.wikipedia.org/wiki/Block_cipher //! [2]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation //! [3]: https://en.wikipedia.org/wiki/Symmetric-key_algorithm use crate::{ParBlocks, ParBlocksSizeUser}; #[cfg(all(feature = "block-padding", feature = "alloc"))] use alloc::{vec, vec::Vec}; #[cfg(feature = "block-padding")] use inout::{ block_padding::{Padding, UnpadError}, InOutBufReserved, PadError, }; use inout::{InOut, InOutBuf, NotEqualError}; pub use crypto_common::{generic_array::ArrayLength, typenum::Unsigned, Block, BlockSizeUser}; /// Marker trait for block ciphers. pub trait BlockCipher: BlockSizeUser {} /// Trait implemented by block cipher encryption and decryption backends. pub trait BlockBackend: ParBlocksSizeUser { /// Process single inout block. fn proc_block(&mut self, block: InOut<'_, '_, Block>); /// Process inout blocks in parallel. #[inline(always)] fn proc_par_blocks(&mut self, mut blocks: InOut<'_, '_, ParBlocks>) { for i in 0..Self::ParBlocksSize::USIZE { self.proc_block(blocks.get(i)); } } /// Process buffer of inout blocks. Length of the buffer MUST be smaller /// than `Self::ParBlocksSize`. #[inline(always)] fn proc_tail_blocks(&mut self, blocks: InOutBuf<'_, '_, Block>) { assert!(blocks.len() < Self::ParBlocksSize::USIZE); for block in blocks { self.proc_block(block); } } /// Process single block in-place. #[inline(always)] fn proc_block_inplace(&mut self, block: &mut Block) { self.proc_block(block.into()); } /// Process blocks in parallel in-place. #[inline(always)] fn proc_par_blocks_inplace(&mut self, blocks: &mut ParBlocks) { self.proc_par_blocks(blocks.into()); } /// Process buffer of blocks in-place. Length of the buffer MUST be smaller /// than `Self::ParBlocksSize`. #[inline(always)] fn proc_tail_blocks_inplace(&mut self, blocks: &mut [Block]) { self.proc_tail_blocks(blocks.into()); } } /// Trait for [`BlockBackend`] users. /// /// This trait is used to define rank-2 closures. pub trait BlockClosure: BlockSizeUser { /// Execute closure with the provided block cipher backend. fn call>(self, backend: &mut B); } /// Encrypt-only functionality for block ciphers. pub trait BlockEncrypt: BlockSizeUser + Sized { /// Encrypt data using backend provided to the rank-2 closure. fn encrypt_with_backend(&self, f: impl BlockClosure); /// Encrypt single `inout` block. #[inline] fn encrypt_block_inout(&self, block: InOut<'_, '_, Block>) { self.encrypt_with_backend(BlockCtx { block }); } /// Encrypt `inout` blocks. #[inline] fn encrypt_blocks_inout(&self, blocks: InOutBuf<'_, '_, Block>) { self.encrypt_with_backend(BlocksCtx { blocks }); } /// Encrypt single block in-place. #[inline] fn encrypt_block(&self, block: &mut Block) { let block = block.into(); self.encrypt_with_backend(BlockCtx { block }); } /// Encrypt `in_block` and write result to `out_block`. #[inline] fn encrypt_block_b2b(&self, in_block: &Block, out_block: &mut Block) { let block = (in_block, out_block).into(); self.encrypt_with_backend(BlockCtx { block }); } /// Encrypt blocks in-place. #[inline] fn encrypt_blocks(&self, blocks: &mut [Block]) { let blocks = blocks.into(); self.encrypt_with_backend(BlocksCtx { blocks }); } /// Encrypt blocks buffer-to-buffer. /// /// Returns [`NotEqualError`] if provided `in_blocks` and `out_blocks` /// have different lengths. #[inline] fn encrypt_blocks_b2b( &self, in_blocks: &[Block], out_blocks: &mut [Block], ) -> Result<(), NotEqualError> { InOutBuf::new(in_blocks, out_blocks) .map(|blocks| self.encrypt_with_backend(BlocksCtx { blocks })) } /// Pad input and encrypt. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded_inout<'inp, 'out, P: Padding>( &self, data: InOutBufReserved<'inp, 'out, u8>, ) -> Result<&'out [u8], PadError> { let mut buf = data.into_padded_blocks::()?; self.encrypt_blocks_inout(buf.get_blocks()); if let Some(block) = buf.get_tail_block() { self.encrypt_block_inout(block); } Ok(buf.into_out()) } /// Pad input and encrypt in-place. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded<'a, P: Padding>( &self, buf: &'a mut [u8], msg_len: usize, ) -> Result<&'a [u8], PadError> { let buf = InOutBufReserved::from_mut_slice(buf, msg_len).map_err(|_| PadError)?; self.encrypt_padded_inout::

(buf) } /// Pad input and encrypt buffer-to-buffer. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded_b2b<'a, P: Padding>( &self, msg: &[u8], out_buf: &'a mut [u8], ) -> Result<&'a [u8], PadError> { let buf = InOutBufReserved::from_slices(msg, out_buf).map_err(|_| PadError)?; self.encrypt_padded_inout::

(buf) } /// Pad input and encrypt into a newly allocated Vec. Returns resulting ciphertext Vec. #[cfg(all(feature = "block-padding", feature = "alloc"))] #[cfg_attr(docsrs, doc(cfg(all(feature = "block-padding", feature = "alloc"))))] #[inline] fn encrypt_padded_vec>(&self, msg: &[u8]) -> Vec { let mut out = allocate_out_vec::(msg.len()); let len = self .encrypt_padded_b2b::

(msg, &mut out) .expect("enough space for encrypting is allocated") .len(); out.truncate(len); out } } /// Decrypt-only functionality for block ciphers. pub trait BlockDecrypt: BlockSizeUser { /// Decrypt data using backend provided to the rank-2 closure. fn decrypt_with_backend(&self, f: impl BlockClosure); /// Decrypt single `inout` block. #[inline] fn decrypt_block_inout(&self, block: InOut<'_, '_, Block>) { self.decrypt_with_backend(BlockCtx { block }); } /// Decrypt `inout` blocks. #[inline] fn decrypt_blocks_inout(&self, blocks: InOutBuf<'_, '_, Block>) { self.decrypt_with_backend(BlocksCtx { blocks }); } /// Decrypt single block in-place. #[inline] fn decrypt_block(&self, block: &mut Block) { let block = block.into(); self.decrypt_with_backend(BlockCtx { block }); } /// Decrypt `in_block` and write result to `out_block`. #[inline] fn decrypt_block_b2b(&self, in_block: &Block, out_block: &mut Block) { let block = (in_block, out_block).into(); self.decrypt_with_backend(BlockCtx { block }); } /// Decrypt blocks in-place. #[inline] fn decrypt_blocks(&self, blocks: &mut [Block]) { let blocks = blocks.into(); self.decrypt_with_backend(BlocksCtx { blocks }); } /// Decrypt blocks buffer-to-buffer. /// /// Returns [`NotEqualError`] if provided `in_blocks` and `out_blocks` /// have different lengths. #[inline] fn decrypt_blocks_b2b( &self, in_blocks: &[Block], out_blocks: &mut [Block], ) -> Result<(), NotEqualError> { InOutBuf::new(in_blocks, out_blocks) .map(|blocks| self.decrypt_with_backend(BlocksCtx { blocks })) } /// Decrypt input and unpad it. Returns resulting ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded_inout<'inp, 'out, P: Padding>( &self, data: InOutBuf<'inp, 'out, u8>, ) -> Result<&'out [u8], UnpadError> { let (mut blocks, tail) = data.into_chunks(); if !tail.is_empty() { return Err(UnpadError); } self.decrypt_blocks_inout(blocks.reborrow()); P::unpad_blocks(blocks.into_out()) } /// Decrypt input and unpad it in-place. Returns resulting ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded<'a, P: Padding>( &self, buf: &'a mut [u8], ) -> Result<&'a [u8], UnpadError> { self.decrypt_padded_inout::

(buf.into()) } /// Decrypt input and unpad it buffer-to-buffer. Returns resulting /// ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded_b2b<'a, P: Padding>( &self, in_buf: &[u8], out_buf: &'a mut [u8], ) -> Result<&'a [u8], UnpadError> { if out_buf.len() < in_buf.len() { return Err(UnpadError); } let n = in_buf.len(); // note: `new` always returns `Ok` here let buf = InOutBuf::new(in_buf, &mut out_buf[..n]).map_err(|_| UnpadError)?; self.decrypt_padded_inout::

(buf) } /// Decrypt input and unpad it in a newly allocated Vec. Returns resulting /// ciphertext Vec. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(all(feature = "block-padding", feature = "alloc"))] #[cfg_attr(docsrs, doc(cfg(all(feature = "block-padding", feature = "alloc"))))] #[inline] fn decrypt_padded_vec>( &self, buf: &[u8], ) -> Result, UnpadError> { let mut out = vec![0; buf.len()]; let len = self.decrypt_padded_b2b::

(buf, &mut out)?.len(); out.truncate(len); Ok(out) } } /// Encrypt-only functionality for block ciphers and modes with mutable access to `self`. /// /// The main use case for this trait is blocks modes, but it also can be used /// for hardware cryptographic engines which require `&mut self` access to an /// underlying hardware peripheral. pub trait BlockEncryptMut: BlockSizeUser + Sized { /// Encrypt data using backend provided to the rank-2 closure. fn encrypt_with_backend_mut(&mut self, f: impl BlockClosure); /// Encrypt single `inout` block. #[inline] fn encrypt_block_inout_mut(&mut self, block: InOut<'_, '_, Block>) { self.encrypt_with_backend_mut(BlockCtx { block }); } /// Encrypt `inout` blocks. #[inline] fn encrypt_blocks_inout_mut(&mut self, blocks: InOutBuf<'_, '_, Block>) { self.encrypt_with_backend_mut(BlocksCtx { blocks }); } /// Encrypt single block in-place. #[inline] fn encrypt_block_mut(&mut self, block: &mut Block) { let block = block.into(); self.encrypt_with_backend_mut(BlockCtx { block }); } /// Encrypt `in_block` and write result to `out_block`. #[inline] fn encrypt_block_b2b_mut(&mut self, in_block: &Block, out_block: &mut Block) { let block = (in_block, out_block).into(); self.encrypt_with_backend_mut(BlockCtx { block }); } /// Encrypt blocks in-place. #[inline] fn encrypt_blocks_mut(&mut self, blocks: &mut [Block]) { let blocks = blocks.into(); self.encrypt_with_backend_mut(BlocksCtx { blocks }); } /// Encrypt blocks buffer-to-buffer. /// /// Returns [`NotEqualError`] if provided `in_blocks` and `out_blocks` /// have different lengths. #[inline] fn encrypt_blocks_b2b_mut( &mut self, in_blocks: &[Block], out_blocks: &mut [Block], ) -> Result<(), NotEqualError> { InOutBuf::new(in_blocks, out_blocks) .map(|blocks| self.encrypt_with_backend_mut(BlocksCtx { blocks })) } /// Pad input and encrypt. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded_inout_mut<'inp, 'out, P: Padding>( mut self, data: InOutBufReserved<'inp, 'out, u8>, ) -> Result<&'out [u8], PadError> { let mut buf = data.into_padded_blocks::()?; self.encrypt_blocks_inout_mut(buf.get_blocks()); if let Some(block) = buf.get_tail_block() { self.encrypt_block_inout_mut(block); } Ok(buf.into_out()) } /// Pad input and encrypt in-place. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded_mut>( self, buf: &mut [u8], msg_len: usize, ) -> Result<&[u8], PadError> { let buf = InOutBufReserved::from_mut_slice(buf, msg_len).map_err(|_| PadError)?; self.encrypt_padded_inout_mut::

(buf) } /// Pad input and encrypt buffer-to-buffer. Returns resulting ciphertext slice. /// /// Returns [`PadError`] if length of output buffer is not sufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn encrypt_padded_b2b_mut<'a, P: Padding>( self, msg: &[u8], out_buf: &'a mut [u8], ) -> Result<&'a [u8], PadError> { let buf = InOutBufReserved::from_slices(msg, out_buf).map_err(|_| PadError)?; self.encrypt_padded_inout_mut::

(buf) } /// Pad input and encrypt into a newly allocated Vec. Returns resulting ciphertext Vec. #[cfg(all(feature = "block-padding", feature = "alloc"))] #[cfg_attr(docsrs, doc(cfg(all(feature = "block-padding", feature = "alloc"))))] #[inline] fn encrypt_padded_vec_mut>(self, msg: &[u8]) -> Vec { let mut out = allocate_out_vec::(msg.len()); let len = self .encrypt_padded_b2b_mut::

(msg, &mut out) .expect("enough space for encrypting is allocated") .len(); out.truncate(len); out } } /// Decrypt-only functionality for block ciphers and modes with mutable access to `self`. /// /// The main use case for this trait is blocks modes, but it also can be used /// for hardware cryptographic engines which require `&mut self` access to an /// underlying hardware peripheral. pub trait BlockDecryptMut: BlockSizeUser + Sized { /// Decrypt data using backend provided to the rank-2 closure. fn decrypt_with_backend_mut(&mut self, f: impl BlockClosure); /// Decrypt single `inout` block. #[inline] fn decrypt_block_inout_mut(&mut self, block: InOut<'_, '_, Block>) { self.decrypt_with_backend_mut(BlockCtx { block }); } /// Decrypt `inout` blocks. #[inline] fn decrypt_blocks_inout_mut(&mut self, blocks: InOutBuf<'_, '_, Block>) { self.decrypt_with_backend_mut(BlocksCtx { blocks }); } /// Decrypt single block in-place. #[inline] fn decrypt_block_mut(&mut self, block: &mut Block) { let block = block.into(); self.decrypt_with_backend_mut(BlockCtx { block }); } /// Decrypt `in_block` and write result to `out_block`. #[inline] fn decrypt_block_b2b_mut(&mut self, in_block: &Block, out_block: &mut Block) { let block = (in_block, out_block).into(); self.decrypt_with_backend_mut(BlockCtx { block }); } /// Decrypt blocks in-place. #[inline] fn decrypt_blocks_mut(&mut self, blocks: &mut [Block]) { let blocks = blocks.into(); self.decrypt_with_backend_mut(BlocksCtx { blocks }); } /// Decrypt blocks buffer-to-buffer. /// /// Returns [`NotEqualError`] if provided `in_blocks` and `out_blocks` /// have different lengths. #[inline] fn decrypt_blocks_b2b_mut( &mut self, in_blocks: &[Block], out_blocks: &mut [Block], ) -> Result<(), NotEqualError> { InOutBuf::new(in_blocks, out_blocks) .map(|blocks| self.decrypt_with_backend_mut(BlocksCtx { blocks })) } /// Decrypt input and unpad it. Returns resulting ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded_inout_mut<'inp, 'out, P: Padding>( mut self, data: InOutBuf<'inp, 'out, u8>, ) -> Result<&'out [u8], UnpadError> { let (mut blocks, tail) = data.into_chunks(); if !tail.is_empty() { return Err(UnpadError); } self.decrypt_blocks_inout_mut(blocks.reborrow()); P::unpad_blocks(blocks.into_out()) } /// Decrypt input and unpad it in-place. Returns resulting ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded_mut>( self, buf: &mut [u8], ) -> Result<&[u8], UnpadError> { self.decrypt_padded_inout_mut::

(buf.into()) } /// Decrypt input and unpad it buffer-to-buffer. Returns resulting /// ciphertext slice. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline] fn decrypt_padded_b2b_mut<'a, P: Padding>( self, in_buf: &[u8], out_buf: &'a mut [u8], ) -> Result<&'a [u8], UnpadError> { if out_buf.len() < in_buf.len() { return Err(UnpadError); } let n = in_buf.len(); // note: `new` always returns `Ok` here let buf = InOutBuf::new(in_buf, &mut out_buf[..n]).map_err(|_| UnpadError)?; self.decrypt_padded_inout_mut::

(buf) } /// Decrypt input and unpad it in a newly allocated Vec. Returns resulting /// ciphertext Vec. /// /// Returns [`UnpadError`] if padding is malformed or if input length is /// not multiple of `Self::BlockSize`. #[cfg(all(feature = "block-padding", feature = "alloc"))] #[cfg_attr(docsrs, doc(cfg(all(feature = "block-padding", feature = "alloc"))))] #[inline] fn decrypt_padded_vec_mut>( self, buf: &[u8], ) -> Result, UnpadError> { let mut out = vec![0; buf.len()]; let len = self.decrypt_padded_b2b_mut::

(buf, &mut out)?.len(); out.truncate(len); Ok(out) } } impl BlockEncryptMut for Alg { fn encrypt_with_backend_mut(&mut self, f: impl BlockClosure) { self.encrypt_with_backend(f); } } impl BlockDecryptMut for Alg { fn decrypt_with_backend_mut(&mut self, f: impl BlockClosure) { self.decrypt_with_backend(f); } } impl BlockCipher for &Alg {} impl BlockEncrypt for &Alg { fn encrypt_with_backend(&self, f: impl BlockClosure) { Alg::encrypt_with_backend(self, f); } } impl BlockDecrypt for &Alg { fn decrypt_with_backend(&self, f: impl BlockClosure) { Alg::decrypt_with_backend(self, f); } } /// Closure used in methods which operate over separate blocks. struct BlockCtx<'inp, 'out, BS: ArrayLength> { block: InOut<'inp, 'out, Block>, } impl<'inp, 'out, BS: ArrayLength> BlockSizeUser for BlockCtx<'inp, 'out, BS> { type BlockSize = BS; } impl<'inp, 'out, BS: ArrayLength> BlockClosure for BlockCtx<'inp, 'out, BS> { #[inline(always)] fn call>(self, backend: &mut B) { backend.proc_block(self.block); } } /// Closure used in methods which operate over slice of blocks. struct BlocksCtx<'inp, 'out, BS: ArrayLength> { blocks: InOutBuf<'inp, 'out, Block>, } impl<'inp, 'out, BS: ArrayLength> BlockSizeUser for BlocksCtx<'inp, 'out, BS> { type BlockSize = BS; } impl<'inp, 'out, BS: ArrayLength> BlockClosure for BlocksCtx<'inp, 'out, BS> { #[inline(always)] fn call>(self, backend: &mut B) { if B::ParBlocksSize::USIZE > 1 { let (chunks, tail) = self.blocks.into_chunks(); for chunk in chunks { backend.proc_par_blocks(chunk); } backend.proc_tail_blocks(tail); } else { for block in self.blocks { backend.proc_block(block); } } } } #[cfg(all(feature = "block-padding", feature = "alloc"))] fn allocate_out_vec(len: usize) -> Vec { let bs = BS::BlockSize::USIZE; vec![0; bs * (len / bs + 1)] } /// Implement simple block backend #[macro_export] macro_rules! impl_simple_block_encdec { ( <$($N:ident$(:$b0:ident$(+$b:ident)*)?),*> $cipher:ident, $block_size:ty, $state:ident, $block:ident, encrypt: $enc_block:block decrypt: $dec_block:block ) => { impl<$($N$(:$b0$(+$b)*)?),*> $crate::BlockSizeUser for $cipher<$($N),*> { type BlockSize = $block_size; } impl<$($N$(:$b0$(+$b)*)?),*> $crate::BlockEncrypt for $cipher<$($N),*> { fn encrypt_with_backend(&self, f: impl $crate::BlockClosure) { struct EncBack<'a, $($N$(:$b0$(+$b)*)?),* >(&'a $cipher<$($N),*>); impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::BlockSizeUser for EncBack<'a, $($N),*> { type BlockSize = $block_size; } impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::ParBlocksSizeUser for EncBack<'a, $($N),*> { type ParBlocksSize = $crate::consts::U1; } impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::BlockBackend for EncBack<'a, $($N),*> { #[inline(always)] fn proc_block( &mut self, mut $block: $crate::inout::InOut<'_, '_, $crate::Block> ) { let $state: &$cipher<$($N),*> = self.0; $enc_block } } f.call(&mut EncBack(self)) } } impl<$($N$(:$b0$(+$b)*)?),*> $crate::BlockDecrypt for $cipher<$($N),*> { fn decrypt_with_backend(&self, f: impl $crate::BlockClosure) { struct DecBack<'a, $($N$(:$b0$(+$b)*)?),* >(&'a $cipher<$($N),*>); impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::BlockSizeUser for DecBack<'a, $($N),*> { type BlockSize = $block_size; } impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::ParBlocksSizeUser for DecBack<'a, $($N),*> { type ParBlocksSize = $crate::consts::U1; } impl<'a, $($N$(:$b0$(+$b)*)?),* > $crate::BlockBackend for DecBack<'a, $($N),*> { #[inline(always)] fn proc_block( &mut self, mut $block: $crate::inout::InOut<'_, '_, $crate::Block> ) { let $state: &$cipher<$($N),*> = self.0; $dec_block } } f.call(&mut DecBack(self)) } } }; ( $cipher:ident, $block_size:ty, $state:ident, $block:ident, encrypt: $enc_block:block decrypt: $dec_block:block ) => { $crate::impl_simple_block_encdec!( <> $cipher, $block_size, $state, $block, encrypt: $enc_block decrypt: $dec_block ); }; } cipher-0.4.4/src/dev/block.rs000064400000000000000000000322111046102023000141070ustar 00000000000000//! Development-related functionality pub use blobby; /// Define block cipher test #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! block_cipher_test { ($name:ident, $test_name:expr, $cipher:ty $(,)?) => { #[test] fn $name() { use cipher::{ blobby::Blob3Iterator, generic_array::GenericArray, typenum::Unsigned, BlockDecryptMut, BlockEncryptMut, BlockSizeUser, KeyInit, }; fn run_test(key: &[u8], pt: &[u8], ct: &[u8]) -> bool { let mut state = <$cipher as KeyInit>::new_from_slice(key).unwrap(); let mut block = GenericArray::clone_from_slice(pt); state.encrypt_block_mut(&mut block); if ct != block.as_slice() { return false; } state.decrypt_block_mut(&mut block); if pt != block.as_slice() { return false; } true } fn run_par_test(key: &[u8], pt: &[u8]) -> bool { type Block = cipher::Block<$cipher>; let mut state = <$cipher as KeyInit>::new_from_slice(key).unwrap(); let block = Block::clone_from_slice(pt); let mut blocks1 = vec![block; 101]; for (i, b) in blocks1.iter_mut().enumerate() { *b = block; b[0] = b[0].wrapping_add(i as u8); } let mut blocks2 = blocks1.clone(); // check that `encrypt_blocks` and `encrypt_block` // result in the same ciphertext state.encrypt_blocks_mut(&mut blocks1); for b in blocks2.iter_mut() { state.encrypt_block_mut(b); } if blocks1 != blocks2 { return false; } // check that `encrypt_blocks` and `encrypt_block` // result in the same plaintext state.decrypt_blocks_mut(&mut blocks1); for b in blocks2.iter_mut() { state.decrypt_block_mut(b); } if blocks1 != blocks2 { return false; } true } let data = include_bytes!(concat!("data/", $test_name, ".blb")); for (i, row) in Blob3Iterator::new(data).unwrap().enumerate() { let [key, pt, ct] = row.unwrap(); if !run_test(key, pt, ct) { panic!( "\n\ Failed test №{}\n\ key:\t{:?}\n\ plaintext:\t{:?}\n\ ciphertext:\t{:?}\n", i, key, pt, ct, ); } // test parallel blocks encryption/decryption if !run_par_test(key, pt) { panic!( "\n\ Failed parallel test №{}\n\ key:\t{:?}\n\ plaintext:\t{:?}\n\ ciphertext:\t{:?}\n", i, key, pt, ct, ); } } } }; } /// Define block mode encryption test #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! block_mode_enc_test { ($name:ident, $test_name:expr, $cipher:ty $(,)?) => { #[test] fn $name() { use cipher::{ blobby::Blob4Iterator, generic_array::GenericArray, inout::InOutBuf, typenum::Unsigned, BlockEncryptMut, BlockSizeUser, KeyIvInit, }; fn run_test(key: &[u8], iv: &[u8], pt: &[u8], ct: &[u8]) -> bool { assert_eq!(pt.len(), ct.len()); // test block-by-block processing let mut state = <$cipher as KeyIvInit>::new_from_slices(key, iv).unwrap(); let mut out = vec![0u8; ct.len()]; let mut buf = InOutBuf::new(pt, &mut out).unwrap(); let (blocks, tail) = buf.reborrow().into_chunks(); assert_eq!(tail.len(), 0); for block in blocks { state.encrypt_block_inout_mut(block); } if buf.get_out() != ct { return false; } // test multi-block processing let mut state = <$cipher as KeyIvInit>::new_from_slices(key, iv).unwrap(); buf.get_out().iter_mut().for_each(|b| *b = 0); let (blocks, _) = buf.reborrow().into_chunks(); state.encrypt_blocks_inout_mut(blocks); if buf.get_out() != ct { return false; } true } let data = include_bytes!(concat!("data/", $test_name, ".blb")); for (i, row) in Blob4Iterator::new(data).unwrap().enumerate() { let [key, iv, pt, ct] = row.unwrap(); if !run_test(key, iv, pt, ct) { panic!( "\n\ Failed test №{}\n\ key:\t{:?}\n\ iv:\t{:?}\n\ plaintext:\t{:?}\n\ ciphertext:\t{:?}\n", i, key, iv, pt, ct, ); } } } }; } /// Define block mode decryption test #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! block_mode_dec_test { ($name:ident, $test_name:expr, $cipher:ty $(,)?) => { #[test] fn $name() { use cipher::{ blobby::Blob4Iterator, generic_array::GenericArray, inout::InOutBuf, typenum::Unsigned, BlockDecryptMut, BlockSizeUser, KeyIvInit, }; fn run_test(key: &[u8], iv: &[u8], pt: &[u8], ct: &[u8]) -> bool { assert_eq!(pt.len(), ct.len()); // test block-by-block processing let mut state = <$cipher as KeyIvInit>::new_from_slices(key, iv).unwrap(); let mut out = vec![0u8; pt.len()]; let mut buf = InOutBuf::new(ct, &mut out).unwrap(); let (blocks, tail) = buf.reborrow().into_chunks(); assert_eq!(tail.len(), 0); for block in blocks { state.decrypt_block_inout_mut(block); } if buf.get_out() != pt { return false; } // test multi-block processing let mut state = <$cipher as KeyIvInit>::new_from_slices(key, iv).unwrap(); buf.get_out().iter_mut().for_each(|b| *b = 0); let (blocks, _) = buf.reborrow().into_chunks(); state.decrypt_blocks_inout_mut(blocks); if buf.get_out() != pt { return false; } true } let data = include_bytes!(concat!("data/", $test_name, ".blb")); for (i, row) in Blob4Iterator::new(data).unwrap().enumerate() { let [key, iv, pt, ct] = row.unwrap(); if !run_test(key, iv, pt, ct) { panic!( "\n\ Failed test №{}\n\ key:\t{:?}\n\ iv:\t{:?}\n\ plaintext:\t{:?}\n\ ciphertext:\t{:?}\n", i, key, iv, pt, ct, ); } } } }; } /// Define `IvState` test #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! iv_state_test { ($name:ident, $cipher:ty, encrypt $(,)?) => { $crate::iv_state_test!($name, $cipher, encrypt_blocks_mut); }; ($name:ident, $cipher:ty, decrypt $(,)?) => { $crate::iv_state_test!($name, $cipher, decrypt_blocks_mut); }; ($name:ident, $cipher:ty, apply_ks $(,)?) => { $crate::iv_state_test!($name, $cipher, apply_keystream_blocks); }; ($name:ident, $cipher:ty, $method:ident $(,)?) => { #[test] fn $name() { use cipher::*; let mut blocks = [Block::<$cipher>::default(); 32]; for (i, block) in blocks.iter_mut().enumerate() { for (j, b) in block.iter_mut().enumerate() { *b = (i + j) as u8; } } let mut key = Key::<$cipher>::default(); let mut iv = Iv::<$cipher>::default(); key.iter_mut().for_each(|b| *b = 0x42); iv.iter_mut().for_each(|b| *b = 0x24); let mut cipher = <$cipher>::new(&key, &iv); let mut target = blocks.clone(); cipher.$method(&mut target); for i in 0..32 { let mut blocks = blocks.clone(); let (b1, b2) = blocks.split_at_mut(i); let mut cipher1 = <$cipher>::new(&key, &iv); cipher1.$method(b1); let temp_iv = cipher1.iv_state(); let mut cipher2 = <$cipher>::new(&key, &temp_iv); cipher2.$method(b2); assert_eq!(blocks, target); } } }; } /// Define block encryptor benchmark #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! block_encryptor_bench { (Key: $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { $crate::block_encryptor_bench!( { use $crate::KeyInit; let key = test::black_box(Default::default()); <$cipher>::new(&key) }, $cipher, $block_name, $blocks_name, ); }; (KeyIv: $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { $crate::block_encryptor_bench!( { use $crate::KeyIvInit; let key = test::black_box(Default::default()); let iv = test::black_box(Default::default()); <$cipher>::new(&key, &iv) }, $cipher, $block_name, $blocks_name, ); }; ($init:block, $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { #[bench] pub fn $block_name(bh: &mut test::Bencher) { use cipher::BlockEncryptMut; let mut cipher = $init; let mut blocks = vec![Default::default(); 1024]; bh.iter(|| { for block in blocks.iter_mut() { cipher.encrypt_block_mut(block); } test::black_box(&blocks); }); bh.bytes = (blocks.len() * blocks[0].len()) as u64; } #[bench] pub fn $blocks_name(bh: &mut test::Bencher) { use cipher::BlockEncryptMut; let mut cipher = $init; let mut blocks = vec![Default::default(); 1024]; bh.iter(|| { cipher.encrypt_blocks_mut(&mut blocks); test::black_box(&blocks); }); bh.bytes = (blocks.len() * blocks[0].len()) as u64; } }; } /// Define block decryptor benchmark #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! block_decryptor_bench { (Key: $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { $crate::block_decryptor_bench!( { use $crate::KeyInit; let key = test::black_box(Default::default()); <$cipher>::new(&key) }, $cipher, $block_name, $blocks_name, ); }; (KeyIv: $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { $crate::block_decryptor_bench!( { use $crate::KeyIvInit; let key = test::black_box(Default::default()); let iv = test::black_box(Default::default()); <$cipher>::new(&key, &iv) }, $cipher, $block_name, $blocks_name, ); }; ($init:block, $cipher:ty, $block_name:ident, $blocks_name:ident $(,)? ) => { #[bench] pub fn $block_name(bh: &mut test::Bencher) { use cipher::BlockDecryptMut; let mut cipher = $init; let mut blocks = vec![Default::default(); 1024]; bh.iter(|| { for block in blocks.iter_mut() { cipher.decrypt_block_mut(block); } test::black_box(&blocks); }); bh.bytes = (blocks.len() * blocks[0].len()) as u64; } #[bench] pub fn $blocks_name(bh: &mut test::Bencher) { use cipher::BlockDecryptMut; let mut cipher = $init; let mut blocks = vec![Default::default(); 1024]; bh.iter(|| { cipher.decrypt_blocks_mut(&mut blocks); test::black_box(&blocks); }); bh.bytes = (blocks.len() * blocks[0].len()) as u64; } }; } cipher-0.4.4/src/dev/stream.rs000064400000000000000000000111301046102023000143050ustar 00000000000000//! Development-related functionality /// Test core functionality of synchronous stream cipher #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! stream_cipher_test { ($name:ident, $test_name:expr, $cipher:ty $(,)?) => { #[test] fn $name() { use cipher::generic_array::GenericArray; use cipher::{blobby::Blob4Iterator, KeyIvInit, StreamCipher}; let data = include_bytes!(concat!("data/", $test_name, ".blb")); for (i, row) in Blob4Iterator::new(data).unwrap().enumerate() { let [key, iv, pt, ct] = row.unwrap(); for chunk_n in 1..256 { let mut mode = <$cipher>::new_from_slices(key, iv).unwrap(); let mut pt = pt.to_vec(); for chunk in pt.chunks_mut(chunk_n) { mode.apply_keystream(chunk); } if pt != &ct[..] { panic!( "Failed main test №{}, chunk size: {}\n\ key:\t{:?}\n\ iv:\t{:?}\n\ plaintext:\t{:?}\n\ ciphertext:\t{:?}\n", i, chunk_n, key, iv, pt, ct, ); } } } } }; } /// Test stream synchronous stream cipher seeking capabilities #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! stream_cipher_seek_test { ($name:ident, $cipher:ty) => { #[test] fn $name() { use cipher::generic_array::GenericArray; use cipher::{KeyIvInit, StreamCipher, StreamCipherSeek}; fn get_cipher() -> $cipher { <$cipher>::new(&Default::default(), &Default::default()) } const MAX_SEEK: usize = 512; let mut ct = [0u8; MAX_SEEK]; get_cipher().apply_keystream(&mut ct[..]); for n in 0..MAX_SEEK { let mut cipher = get_cipher(); assert_eq!(cipher.current_pos::(), 0); cipher.seek(n); assert_eq!(cipher.current_pos::(), n); let mut buf = [0u8; MAX_SEEK]; cipher.apply_keystream(&mut buf[n..]); assert_eq!(cipher.current_pos::(), MAX_SEEK); assert_eq!(&buf[n..], &ct[n..]); } const MAX_CHUNK: usize = 128; const MAX_LEN: usize = 1024; let mut buf = [0u8; MAX_CHUNK]; let mut cipher = get_cipher(); assert_eq!(cipher.current_pos::(), 0); cipher.apply_keystream(&mut []); assert_eq!(cipher.current_pos::(), 0); for n in 1..MAX_CHUNK { assert_eq!(cipher.current_pos::(), 0); for m in 1.. { cipher.apply_keystream(&mut buf[..n]); assert_eq!(cipher.current_pos::(), n * m); if n * m > MAX_LEN { break; } } cipher.seek(0); } } }; } /// Create stream cipher benchmarks #[macro_export] #[cfg_attr(docsrs, doc(cfg(feature = "dev")))] macro_rules! stream_cipher_bench { ( $cipher:ty; $($name:ident $bs:expr;)* ) => { $crate::stream_cipher_bench!( Init: { use $crate::KeyIvInit; let key = test::black_box(Default::default()); let iv = test::black_box(Default::default()); <$cipher>::new(&key, &iv) }; $($name $bs;)* ); }; ( Key: $cipher:ty; $($name:ident $bs:expr;)* ) => { $crate::stream_cipher_bench!( Init: { use $crate::KeyInit; let key = test::black_box(Default::default()); let iv = test::black_box(Default::default()); <$cipher>::new(&key, &iv) }; $($name $bs;)* ); }; ( Init: $init:expr; $($name:ident $bs:expr;)* ) => { $( #[bench] fn $name(b: &mut test::Bencher) { use $crate::StreamCipher; let mut cipher = $init; let mut buf = vec![0; $bs]; b.iter(|| { cipher.apply_keystream(&mut buf); test::black_box(&buf); }); b.bytes = $bs; } )* }; } cipher-0.4.4/src/dev.rs000064400000000000000000000000271046102023000130150ustar 00000000000000mod block; mod stream; cipher-0.4.4/src/errors.rs000064400000000000000000000023101046102023000135500ustar 00000000000000//! Error types. use core::fmt; /// This error is returned by the [`StreamCipher`][crate::stream::StreamCipher] /// trait methods. /// /// Usually it's used in cases when stream cipher has reached the end /// of a keystream, but also can be used if lengths of provided input /// and output buffers are not equal. #[derive(Copy, Clone, Debug)] pub struct StreamCipherError; impl fmt::Display for StreamCipherError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Loop Error") } } #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for StreamCipherError {} /// The error type returned when a cipher position can not be represented /// by the requested type. #[derive(Copy, Clone, Debug)] pub struct OverflowError; impl fmt::Display for OverflowError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Overflow Error") } } impl From for StreamCipherError { fn from(_: OverflowError) -> StreamCipherError { StreamCipherError } } #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for OverflowError {} cipher-0.4.4/src/lib.rs000064400000000000000000000032471046102023000130140ustar 00000000000000//! This crate defines a set of traits which describe the functionality of //! [block ciphers][1], [block modes][2], and [stream ciphers][3]. //! //! [1]: https://en.wikipedia.org/wiki/Block_cipher //! [2]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation //! [3]: https://en.wikipedia.org/wiki/Stream_cipher #![no_std] #![cfg_attr(docsrs, feature(doc_cfg))] #![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)] pub use crypto_common; pub use inout; #[cfg(all(feature = "block-padding", feature = "alloc"))] extern crate alloc; #[cfg(feature = "std")] extern crate std; #[cfg(feature = "rand_core")] #[cfg_attr(docsrs, doc(cfg(feature = "rand_core")))] pub use crypto_common::rand_core; #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] pub use inout::block_padding; #[cfg(feature = "zeroize")] #[cfg_attr(docsrs, doc(cfg(feature = "zeroize")))] pub use zeroize; #[cfg(feature = "dev")] pub use blobby; mod block; #[cfg(feature = "dev")] mod dev; mod errors; mod stream; mod stream_core; mod stream_wrapper; pub use crate::{block::*, errors::*, stream::*, stream_core::*, stream_wrapper::*}; pub use crypto_common::{ generic_array, typenum::{self, consts}, AlgorithmName, Block, InnerIvInit, InvalidLength, Iv, IvSizeUser, Key, KeyInit, KeyIvInit, KeySizeUser, ParBlocks, ParBlocksSizeUser, }; /// Trait for loading current IV state. pub trait IvState: IvSizeUser { /// Returns current IV state. fn iv_state(&self) -> Iv; } cipher-0.4.4/src/stream.rs000064400000000000000000000170641046102023000135430ustar 00000000000000//! Traits which define functionality of stream ciphers. //! //! See [RustCrypto/stream-ciphers](https://github.com/RustCrypto/stream-ciphers) //! for ciphers implementation. use crate::errors::{OverflowError, StreamCipherError}; use crate::stream_core::Counter; use crate::{Block, BlockDecryptMut, BlockEncryptMut}; use inout::{InOutBuf, NotEqualError}; /// Marker trait for block-level asynchronous stream ciphers pub trait AsyncStreamCipher: Sized { /// Encrypt data using `InOutBuf`. fn encrypt_inout(mut self, data: InOutBuf<'_, '_, u8>) where Self: BlockEncryptMut, { let (blocks, mut tail) = data.into_chunks(); self.encrypt_blocks_inout_mut(blocks); let n = tail.len(); if n != 0 { let mut block = Block::::default(); block[..n].copy_from_slice(tail.get_in()); self.encrypt_block_mut(&mut block); tail.get_out().copy_from_slice(&block[..n]); } } /// Decrypt data using `InOutBuf`. fn decrypt_inout(mut self, data: InOutBuf<'_, '_, u8>) where Self: BlockDecryptMut, { let (blocks, mut tail) = data.into_chunks(); self.decrypt_blocks_inout_mut(blocks); let n = tail.len(); if n != 0 { let mut block = Block::::default(); block[..n].copy_from_slice(tail.get_in()); self.decrypt_block_mut(&mut block); tail.get_out().copy_from_slice(&block[..n]); } } /// Encrypt data in place. fn encrypt(self, buf: &mut [u8]) where Self: BlockEncryptMut, { self.encrypt_inout(buf.into()); } /// Decrypt data in place. fn decrypt(self, buf: &mut [u8]) where Self: BlockDecryptMut, { self.decrypt_inout(buf.into()); } /// Encrypt data from buffer to buffer. fn encrypt_b2b(self, in_buf: &[u8], out_buf: &mut [u8]) -> Result<(), NotEqualError> where Self: BlockEncryptMut, { InOutBuf::new(in_buf, out_buf).map(|b| self.encrypt_inout(b)) } /// Decrypt data from buffer to buffer. fn decrypt_b2b(self, in_buf: &[u8], out_buf: &mut [u8]) -> Result<(), NotEqualError> where Self: BlockDecryptMut, { InOutBuf::new(in_buf, out_buf).map(|b| self.decrypt_inout(b)) } } /// Synchronous stream cipher core trait. pub trait StreamCipher { /// Apply keystream to `inout` data. /// /// If end of the keystream will be achieved with the given data length, /// method will return [`StreamCipherError`] without modifying provided `data`. fn try_apply_keystream_inout( &mut self, buf: InOutBuf<'_, '_, u8>, ) -> Result<(), StreamCipherError>; /// Apply keystream to data behind `buf`. /// /// If end of the keystream will be achieved with the given data length, /// method will return [`StreamCipherError`] without modifying provided `data`. #[inline] fn try_apply_keystream(&mut self, buf: &mut [u8]) -> Result<(), StreamCipherError> { self.try_apply_keystream_inout(buf.into()) } /// Apply keystream to `inout` data. /// /// It will XOR generated keystream with the data behind `in` pointer /// and will write result to `out` pointer. /// /// # Panics /// If end of the keystream will be reached with the given data length, /// method will panic without modifying the provided `data`. #[inline] fn apply_keystream_inout(&mut self, buf: InOutBuf<'_, '_, u8>) { self.try_apply_keystream_inout(buf).unwrap(); } /// Apply keystream to data in-place. /// /// It will XOR generated keystream with `data` and will write result /// to the same buffer. /// /// # Panics /// If end of the keystream will be reached with the given data length, /// method will panic without modifying the provided `data`. #[inline] fn apply_keystream(&mut self, buf: &mut [u8]) { self.try_apply_keystream(buf).unwrap(); } /// Apply keystream to data buffer-to-buffer. /// /// It will XOR generated keystream with data from the `input` buffer /// and will write result to the `output` buffer. /// /// Returns [`StreamCipherError`] if provided `in_blocks` and `out_blocks` /// have different lengths or if end of the keystream will be reached with /// the given input data length. #[inline] fn apply_keystream_b2b( &mut self, input: &[u8], output: &mut [u8], ) -> Result<(), StreamCipherError> { InOutBuf::new(input, output) .map_err(|_| StreamCipherError) .and_then(|buf| self.try_apply_keystream_inout(buf)) } } /// Trait for seekable stream ciphers. /// /// Methods of this trait are generic over the [`SeekNum`] trait, which is /// implemented for primitive numeric types, i.e.: `i32`, `u32`, `u64`, /// `u128`, and `usize`. pub trait StreamCipherSeek { /// Try to get current keystream position /// /// Returns [`OverflowError`] if position can not be represented by type `T` fn try_current_pos(&self) -> Result; /// Try to seek to the given position /// /// Returns [`StreamCipherError`] if provided position value is bigger than /// keystream length. fn try_seek(&mut self, pos: T) -> Result<(), StreamCipherError>; /// Get current keystream position /// /// # Panics /// If position can not be represented by type `T` fn current_pos(&self) -> T { self.try_current_pos().unwrap() } /// Seek to the given position /// /// # Panics /// If provided position value is bigger than keystream length fn seek(&mut self, pos: T) { self.try_seek(pos).unwrap() } } impl StreamCipher for &mut C { #[inline] fn try_apply_keystream_inout( &mut self, buf: InOutBuf<'_, '_, u8>, ) -> Result<(), StreamCipherError> { C::try_apply_keystream_inout(self, buf) } } /// Trait implemented for numeric types which can be used with the /// [`StreamCipherSeek`] trait. /// /// This trait is implemented for `i32`, `u32`, `u64`, `u128`, and `usize`. /// It is not intended to be implemented in third-party crates. pub trait SeekNum: Sized { /// Try to get position for block number `block`, byte position inside /// block `byte`, and block size `bs`. fn from_block_byte(block: T, byte: u8, bs: u8) -> Result; /// Try to get block number and bytes position for given block size `bs`. fn into_block_byte(self, bs: u8) -> Result<(T, u8), OverflowError>; } macro_rules! impl_seek_num { {$($t:ty )*} => { $( impl SeekNum for $t { fn from_block_byte(block: T, byte: u8, bs: u8) -> Result { debug_assert!(byte < bs); let mut block: Self = block.try_into().map_err(|_| OverflowError)?; if byte != 0 { block -= 1; } let pos = block.checked_mul(bs as Self).ok_or(OverflowError)? + (byte as Self); Ok(pos) } fn into_block_byte(self, bs: u8) -> Result<(T, u8), OverflowError> { let bs = bs as Self; let byte = self % bs; let block = T::try_from(self/bs).map_err(|_| OverflowError)?; Ok((block, byte as u8)) } } )* }; } impl_seek_num! { i32 u32 u64 u128 usize } cipher-0.4.4/src/stream_core.rs000064400000000000000000000231031046102023000145420ustar 00000000000000use crate::{ParBlocks, ParBlocksSizeUser, StreamCipherError}; use crypto_common::{ generic_array::{ArrayLength, GenericArray}, typenum::Unsigned, Block, BlockSizeUser, }; use inout::{InOut, InOutBuf}; /// Trait implemented by stream cipher backends. pub trait StreamBackend: ParBlocksSizeUser { /// Generate keystream block. fn gen_ks_block(&mut self, block: &mut Block); /// Generate keystream blocks in parallel. #[inline(always)] fn gen_par_ks_blocks(&mut self, blocks: &mut ParBlocks) { for block in blocks { self.gen_ks_block(block); } } /// Generate keystream blocks. Length of the buffer MUST be smaller /// than `Self::ParBlocksSize`. #[inline(always)] fn gen_tail_blocks(&mut self, blocks: &mut [Block]) { assert!(blocks.len() < Self::ParBlocksSize::USIZE); for block in blocks { self.gen_ks_block(block); } } } /// Trait for [`StreamBackend`] users. /// /// This trait is used to define rank-2 closures. pub trait StreamClosure: BlockSizeUser { /// Execute closure with the provided stream cipher backend. fn call>(self, backend: &mut B); } /// Block-level synchronous stream ciphers. pub trait StreamCipherCore: BlockSizeUser + Sized { /// Return number of remaining blocks before cipher wraps around. /// /// Returns `None` if number of remaining blocks can not be computed /// (e.g. in ciphers based on the sponge construction) or it's too big /// to fit into `usize`. fn remaining_blocks(&self) -> Option; /// Process data using backend provided to the rank-2 closure. fn process_with_backend(&mut self, f: impl StreamClosure); /// Write keystream block. /// /// WARNING: this method does not check number of remaining blocks! #[inline] fn write_keystream_block(&mut self, block: &mut Block) { self.process_with_backend(WriteBlockCtx { block }); } /// Write keystream blocks. /// /// WARNING: this method does not check number of remaining blocks! #[inline] fn write_keystream_blocks(&mut self, blocks: &mut [Block]) { self.process_with_backend(WriteBlocksCtx { blocks }); } /// Apply keystream block. /// /// WARNING: this method does not check number of remaining blocks! #[inline] fn apply_keystream_block_inout(&mut self, block: InOut<'_, '_, Block>) { self.process_with_backend(ApplyBlockCtx { block }); } /// Apply keystream blocks. /// /// WARNING: this method does not check number of remaining blocks! #[inline] fn apply_keystream_blocks(&mut self, blocks: &mut [Block]) { self.process_with_backend(ApplyBlocksCtx { blocks: blocks.into(), }); } /// Apply keystream blocks. /// /// WARNING: this method does not check number of remaining blocks! #[inline] fn apply_keystream_blocks_inout(&mut self, blocks: InOutBuf<'_, '_, Block>) { self.process_with_backend(ApplyBlocksCtx { blocks }); } /// Try to apply keystream to data not divided into blocks. /// /// Consumes cipher since it may consume final keystream block only /// partially. /// /// Returns an error if number of remaining blocks is not sufficient /// for processing the input data. #[inline] fn try_apply_keystream_partial( mut self, mut buf: InOutBuf<'_, '_, u8>, ) -> Result<(), StreamCipherError> { if let Some(rem) = self.remaining_blocks() { let blocks = if buf.len() % Self::BlockSize::USIZE == 0 { buf.len() % Self::BlockSize::USIZE } else { buf.len() % Self::BlockSize::USIZE + 1 }; if blocks > rem { return Err(StreamCipherError); } } if buf.len() > Self::BlockSize::USIZE { let (blocks, tail) = buf.into_chunks(); self.apply_keystream_blocks_inout(blocks); buf = tail; } let n = buf.len(); if n == 0 { return Ok(()); } let mut block = Block::::default(); block[..n].copy_from_slice(buf.get_in()); let t = InOutBuf::from_mut(&mut block); self.apply_keystream_blocks_inout(t); buf.get_out().copy_from_slice(&block[..n]); Ok(()) } /// Try to apply keystream to data not divided into blocks. /// /// Consumes cipher since it may consume final keystream block only /// partially. /// /// # Panics /// If number of remaining blocks is not sufficient for processing the /// input data. #[inline] fn apply_keystream_partial(self, buf: InOutBuf<'_, '_, u8>) { self.try_apply_keystream_partial(buf).unwrap() } } // note: unfortunately, currently we can not write blanket impls of // `BlockEncryptMut` and `BlockDecryptMut` for `T: StreamCipherCore` // since it requires mutually exclusive traits, see: // https://github.com/rust-lang/rfcs/issues/1053 /// Counter type usable with [`StreamCipherCore`]. /// /// This trait is implemented for `i32`, `u32`, `u64`, `u128`, and `usize`. /// It's not intended to be implemented in third-party crates, but doing so /// is not forbidden. pub trait Counter: TryFrom + TryFrom + TryFrom + TryFrom + TryFrom + TryInto + TryInto + TryInto + TryInto + TryInto { } /// Block-level seeking trait for stream ciphers. pub trait StreamCipherSeekCore: StreamCipherCore { /// Counter type used inside stream cipher. type Counter: Counter; /// Get current block position. fn get_block_pos(&self) -> Self::Counter; /// Set block position. fn set_block_pos(&mut self, pos: Self::Counter); } macro_rules! impl_counter { {$($t:ty )*} => { $( impl Counter for $t { } )* }; } impl_counter! { u32 u64 u128 } /// Partition buffer into 2 parts: buffer of arrays and tail. /// /// In case if `N` is less or equal to 1, buffer of arrays has length /// of zero and tail is equal to `self`. #[inline] fn into_chunks>(buf: &mut [T]) -> (&mut [GenericArray], &mut [T]) { use core::slice; if N::USIZE <= 1 { return (&mut [], buf); } let chunks_len = buf.len() / N::USIZE; let tail_pos = N::USIZE * chunks_len; let tail_len = buf.len() - tail_pos; unsafe { let ptr = buf.as_mut_ptr(); let chunks = slice::from_raw_parts_mut(ptr as *mut GenericArray, chunks_len); let tail = slice::from_raw_parts_mut(ptr.add(tail_pos), tail_len); (chunks, tail) } } struct WriteBlockCtx<'a, BS: ArrayLength> { block: &'a mut Block, } impl<'a, BS: ArrayLength> BlockSizeUser for WriteBlockCtx<'a, BS> { type BlockSize = BS; } impl<'a, BS: ArrayLength> StreamClosure for WriteBlockCtx<'a, BS> { #[inline(always)] fn call>(self, backend: &mut B) { backend.gen_ks_block(self.block); } } struct WriteBlocksCtx<'a, BS: ArrayLength> { blocks: &'a mut [Block], } impl<'a, BS: ArrayLength> BlockSizeUser for WriteBlocksCtx<'a, BS> { type BlockSize = BS; } impl<'a, BS: ArrayLength> StreamClosure for WriteBlocksCtx<'a, BS> { #[inline(always)] fn call>(self, backend: &mut B) { if B::ParBlocksSize::USIZE > 1 { let (chunks, tail) = into_chunks::<_, B::ParBlocksSize>(self.blocks); for chunk in chunks { backend.gen_par_ks_blocks(chunk); } backend.gen_tail_blocks(tail); } else { for block in self.blocks { backend.gen_ks_block(block); } } } } struct ApplyBlockCtx<'inp, 'out, BS: ArrayLength> { block: InOut<'inp, 'out, Block>, } impl<'inp, 'out, BS: ArrayLength> BlockSizeUser for ApplyBlockCtx<'inp, 'out, BS> { type BlockSize = BS; } impl<'inp, 'out, BS: ArrayLength> StreamClosure for ApplyBlockCtx<'inp, 'out, BS> { #[inline(always)] fn call>(mut self, backend: &mut B) { let mut t = Default::default(); backend.gen_ks_block(&mut t); self.block.xor_in2out(&t); } } struct ApplyBlocksCtx<'inp, 'out, BS: ArrayLength> { blocks: InOutBuf<'inp, 'out, Block>, } impl<'inp, 'out, BS: ArrayLength> BlockSizeUser for ApplyBlocksCtx<'inp, 'out, BS> { type BlockSize = BS; } impl<'inp, 'out, BS: ArrayLength> StreamClosure for ApplyBlocksCtx<'inp, 'out, BS> { #[inline(always)] #[allow(clippy::needless_range_loop)] fn call>(self, backend: &mut B) { if B::ParBlocksSize::USIZE > 1 { let (chunks, mut tail) = self.blocks.into_chunks::(); for mut chunk in chunks { let mut tmp = Default::default(); backend.gen_par_ks_blocks(&mut tmp); chunk.xor_in2out(&tmp); } let n = tail.len(); let mut buf = GenericArray::<_, B::ParBlocksSize>::default(); let ks = &mut buf[..n]; backend.gen_tail_blocks(ks); for i in 0..n { tail.get(i).xor_in2out(&ks[i]); } } else { for mut block in self.blocks { let mut t = Default::default(); backend.gen_ks_block(&mut t); block.xor_in2out(&t); } } } } cipher-0.4.4/src/stream_wrapper.rs000064400000000000000000000144721046102023000153030ustar 00000000000000use crate::{ errors::StreamCipherError, Block, OverflowError, SeekNum, StreamCipher, StreamCipherCore, StreamCipherSeek, StreamCipherSeekCore, }; use crypto_common::{ typenum::{IsLess, Le, NonZero, Unsigned, U256}, BlockSizeUser, Iv, IvSizeUser, Key, KeyInit, KeyIvInit, KeySizeUser, }; use inout::InOutBuf; #[cfg(feature = "zeroize")] use zeroize::{Zeroize, ZeroizeOnDrop}; /// Wrapper around [`StreamCipherCore`] implementations. /// /// It handles data buffering and implements the slice-based traits. #[derive(Clone, Default)] pub struct StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { core: T, buffer: Block, pos: u8, } impl StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { /// Return reference to the core type. pub fn get_core(&self) -> &T { &self.core } /// Return reference to the core type. pub fn from_core(core: T) -> Self { Self { core, buffer: Default::default(), pos: 0, } } /// Return current cursor position. #[inline] fn get_pos(&self) -> usize { let pos = self.pos as usize; if T::BlockSize::USIZE == 0 { panic!("Block size can not be equal to zero"); } if pos >= T::BlockSize::USIZE { debug_assert!(false); // SAFETY: `pos` is set only to values smaller than block size unsafe { core::hint::unreachable_unchecked() } } self.pos as usize } /// Return size of the internal buffer in bytes. #[inline] fn size(&self) -> usize { T::BlockSize::USIZE } #[inline] fn set_pos_unchecked(&mut self, pos: usize) { debug_assert!(pos < T::BlockSize::USIZE); self.pos = pos as u8; } /// Return number of remaining bytes in the internal buffer. #[inline] fn remaining(&self) -> usize { self.size() - self.get_pos() } fn check_remaining(&self, dlen: usize) -> Result<(), StreamCipherError> { let rem_blocks = match self.core.remaining_blocks() { Some(v) => v, None => return Ok(()), }; let bytes = if self.pos == 0 { dlen } else { let rem = self.remaining(); if dlen > rem { dlen - rem } else { return Ok(()); } }; let bs = T::BlockSize::USIZE; let blocks = if bytes % bs == 0 { bytes / bs } else { bytes / bs + 1 }; if blocks > rem_blocks { Err(StreamCipherError) } else { Ok(()) } } } impl StreamCipher for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { #[inline] fn try_apply_keystream_inout( &mut self, mut data: InOutBuf<'_, '_, u8>, ) -> Result<(), StreamCipherError> { self.check_remaining(data.len())?; let pos = self.get_pos(); if pos != 0 { let rem = &self.buffer[pos..]; let n = data.len(); if n < rem.len() { data.xor_in2out(&rem[..n]); self.set_pos_unchecked(pos + n); return Ok(()); } let (mut left, right) = data.split_at(rem.len()); data = right; left.xor_in2out(rem); } let (blocks, mut leftover) = data.into_chunks(); self.core.apply_keystream_blocks_inout(blocks); let n = leftover.len(); if n != 0 { self.core.write_keystream_block(&mut self.buffer); leftover.xor_in2out(&self.buffer[..n]); } self.set_pos_unchecked(n); Ok(()) } } impl StreamCipherSeek for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { fn try_current_pos(&self) -> Result { let Self { core, pos, .. } = self; SN::from_block_byte(core.get_block_pos(), *pos, T::BlockSize::U8) } fn try_seek(&mut self, new_pos: SN) -> Result<(), StreamCipherError> { let Self { core, buffer, pos } = self; let (block_pos, byte_pos) = new_pos.into_block_byte(T::BlockSize::U8)?; core.set_block_pos(block_pos); if byte_pos != 0 { self.core.write_keystream_block(buffer); } *pos = byte_pos; Ok(()) } } // Note: ideally we would only implement the InitInner trait and everything // else would be handled by blanket impls, but unfortunately it will // not work properly without mutually exclusive traits, see: // https://github.com/rust-lang/rfcs/issues/1053 impl KeySizeUser for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { type KeySize = T::KeySize; } impl IvSizeUser for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { type IvSize = T::IvSize; } impl KeyIvInit for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { #[inline] fn new(key: &Key, iv: &Iv) -> Self { Self { core: T::new(key, iv), buffer: Default::default(), pos: 0, } } } impl KeyInit for StreamCipherCoreWrapper where T::BlockSize: IsLess, Le: NonZero, { #[inline] fn new(key: &Key) -> Self { Self { core: T::new(key), buffer: Default::default(), pos: 0, } } } #[cfg(feature = "zeroize")] impl Drop for StreamCipherCoreWrapper where T: BlockSizeUser, T::BlockSize: IsLess, Le: NonZero, { fn drop(&mut self) { self.buffer.zeroize(); self.pos.zeroize(); } } #[cfg(feature = "zeroize")] impl ZeroizeOnDrop for StreamCipherCoreWrapper where T: BlockSizeUser + ZeroizeOnDrop, T::BlockSize: IsLess, Le: NonZero, { }