inout-0.1.3/.cargo_vcs_info.json0000644000000001430000000000100121710ustar { "git": { "sha1": "81ef0b0620e22381d5e0b78472dcf80c3125b32b" }, "path_in_vcs": "inout" }inout-0.1.3/CHANGELOG.md000064400000000000000000000015050072674642500126250ustar 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.1.3 (2022-03-31) ### Fixed - MIRI error in `From` impl for `InOutBuf` ([#755]) [#755]: https://github.com/RustCrypto/utils/pull/755 ## 0.1.2 (2022-02-10) ### Changed - Use borrow instead of consuming in `InOutBufReserved::get_*_len()` methods ([#734]) [#734]: https://github.com/RustCrypto/utils/pull/734 ## 0.1.1 (2022-02-10) ### Fixed - Fix doc build on docs.rs by optionally enabling the `doc_cfg` feature ([#733]) [#733]: https://github.com/RustCrypto/utils/pull/733 ## 0.1.0 (2022-02-10) - Initial release ([#675]) [#675]: https://github.com/RustCrypto/utils/pull/675 inout-0.1.3/Cargo.toml0000644000000021230000000000100101670ustar # 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 = "inout" version = "0.1.3" authors = ["RustCrypto Developers"] description = "Custom reference types for code generic over in-place and buffer-to-buffer modes of operation." documentation = "https://docs.rs/inout" keywords = ["custom-reference"] license = "MIT OR Apache-2.0" repository = "https://github.com/RustCrypto/utils" resolver = "2" [package.metadata.docs.rs] all-features = true rustdoc-args = [ "--cfg", "docsrs", ] [dependencies.block-padding] version = "0.3" optional = true [dependencies.generic-array] version = "0.14" [features] std = ["block-padding/std"] inout-0.1.3/Cargo.toml.orig000064400000000000000000000014100072674642500136760ustar 00000000000000[package] name = "inout" version = "0.1.3" # Also update html_root_url in lib.rs when bumping this description = "Custom reference types for code generic over in-place and buffer-to-buffer modes of operation." authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" edition = "2021" rust-version = "1.56" documentation = "https://docs.rs/inout" repository = "https://github.com/RustCrypto/utils" keywords = ["custom-reference"] # Hack to allow this crate to coexist with pre-2021 edition crates [workspace] members = ["."] [dependencies] generic-array = "0.14" block-padding = { version = "0.3", path = "../block-padding", optional = true } [features] std = ["block-padding/std"] [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg", "docsrs"] inout-0.1.3/LICENSE-APACHE000064400000000000000000000251410072674642500127420ustar 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. inout-0.1.3/LICENSE-MIT000064400000000000000000000021260072674642500124500ustar 00000000000000Copyright (c) 2022 The RustCrypto Project Developers Copyright (c) 2022 Artyom Pavlov 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. inout-0.1.3/src/errors.rs000064400000000000000000000035440072674642500134720ustar 00000000000000use core::fmt; /// The error returned when slice can not be converted into array. #[derive(Copy, Clone, Debug)] pub struct IntoArrayError; impl fmt::Display for IntoArrayError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Failed to convert into array.") } } #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for IntoArrayError {} /// The error returned when input and output slices have different length /// and thus can not be converted to `InOutBuf`. #[derive(Copy, Clone, Debug)] pub struct NotEqualError; impl fmt::Display for NotEqualError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Length of input slices is not equal to each other") } } #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for NotEqualError {} /// Padding error. Usually emitted when size of output buffer is insufficient. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[derive(Clone, Copy, Debug)] pub struct PadError; #[cfg(feature = "block-padding")] impl fmt::Display for PadError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Padding error") } } #[cfg(feature = "block-padding")] #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for PadError {} /// Output buffer is smaller than input buffer. #[derive(Clone, Copy, Debug)] pub struct OutIsTooSmallError; impl fmt::Display for OutIsTooSmallError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { f.write_str("Output buffer is smaller than input") } } #[cfg(feature = "std")] #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl std::error::Error for OutIsTooSmallError {} inout-0.1.3/src/inout.rs000064400000000000000000000131110072674642500133030ustar 00000000000000use crate::InOutBuf; use core::{marker::PhantomData, ptr}; use generic_array::{ArrayLength, GenericArray}; /// Custom pointer type which contains one immutable (input) and one mutable /// (output) pointer, which are either equal or non-overlapping. pub struct InOut<'inp, 'out, T> { pub(crate) in_ptr: *const T, pub(crate) out_ptr: *mut T, pub(crate) _pd: PhantomData<(&'inp T, &'out mut T)>, } impl<'inp, 'out, T> InOut<'inp, 'out, T> { /// Reborrow `self`. #[inline(always)] pub fn reborrow<'a>(&'a mut self) -> InOut<'a, 'a, T> { Self { in_ptr: self.in_ptr, out_ptr: self.out_ptr, _pd: PhantomData, } } /// Get immutable reference to the input value. #[inline(always)] pub fn get_in<'a>(&'a self) -> &'a T { unsafe { &*self.in_ptr } } /// Get mutable reference to the output value. #[inline(always)] pub fn get_out<'a>(&'a mut self) -> &'a mut T { unsafe { &mut *self.out_ptr } } /// Convert `self` to a pair of raw input and output pointers. #[inline(always)] pub fn into_raw(self) -> (*const T, *mut T) { (self.in_ptr, self.out_ptr) } /// Create `InOut` from raw input and output pointers. /// /// # Safety /// Behavior is undefined if any of the following conditions are violated: /// - `in_ptr` must point to a properly initialized value of type `T` and /// must be valid for reads. /// - `out_ptr` must point to a properly initialized value of type `T` and /// must be valid for both reads and writes. /// - `in_ptr` and `out_ptr` must be either equal or non-overlapping. /// - If `in_ptr` and `out_ptr` are equal, then the memory referenced by /// them must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime 'a. Both read and write /// accesses are forbidden. /// - If `in_ptr` and `out_ptr` are not equal, then the memory referenced by /// `out_ptr` must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime `'a`. Both read and write /// accesses are forbidden. The memory referenced by `in_ptr` must not be /// mutated for the duration of lifetime `'a`, except inside an `UnsafeCell`. #[inline(always)] pub unsafe fn from_raw(in_ptr: *const T, out_ptr: *mut T) -> InOut<'inp, 'out, T> { Self { in_ptr, out_ptr, _pd: PhantomData, } } } impl<'inp, 'out, T: Clone> InOut<'inp, 'out, T> { /// Clone input value and return it. #[inline(always)] pub fn clone_in(&self) -> T { unsafe { (&*self.in_ptr).clone() } } } impl<'a, T> From<&'a mut T> for InOut<'a, 'a, T> { #[inline(always)] fn from(val: &'a mut T) -> Self { let p = val as *mut T; Self { in_ptr: p, out_ptr: p, _pd: PhantomData, } } } impl<'inp, 'out, T> From<(&'inp T, &'out mut T)> for InOut<'inp, 'out, T> { #[inline(always)] fn from((in_val, out_val): (&'inp T, &'out mut T)) -> Self { Self { in_ptr: in_val as *const T, out_ptr: out_val as *mut T, _pd: Default::default(), } } } impl<'inp, 'out, T, N: ArrayLength> InOut<'inp, 'out, GenericArray> { /// Returns `InOut` for the given position. /// /// # Panics /// If `pos` greater or equal to array length. #[inline(always)] pub fn get<'a>(&'a mut self, pos: usize) -> InOut<'a, 'a, T> { assert!(pos < N::USIZE); unsafe { InOut { in_ptr: (self.in_ptr as *const T).add(pos), out_ptr: (self.out_ptr as *mut T).add(pos), _pd: PhantomData, } } } /// Convert `InOut` array to `InOutBuf`. #[inline(always)] pub fn into_buf(self) -> InOutBuf<'inp, 'out, T> { InOutBuf { in_ptr: self.in_ptr as *const T, out_ptr: self.out_ptr as *mut T, len: N::USIZE, _pd: PhantomData, } } } impl<'inp, 'out, N: ArrayLength> InOut<'inp, 'out, GenericArray> { /// XOR `data` with values behind the input slice and write /// result to the output slice. /// /// # Panics /// If `data` length is not equal to the buffer length. #[inline(always)] #[allow(clippy::needless_range_loop)] pub fn xor_in2out(&mut self, data: &GenericArray) { unsafe { let input = ptr::read(self.in_ptr); let mut temp = GenericArray::::default(); for i in 0..N::USIZE { temp[i] = input[i] ^ data[i]; } ptr::write(self.out_ptr, temp); } } } impl<'inp, 'out, N, M> InOut<'inp, 'out, GenericArray, M>> where N: ArrayLength, M: ArrayLength>, { /// XOR `data` with values behind the input slice and write /// result to the output slice. /// /// # Panics /// If `data` length is not equal to the buffer length. #[inline(always)] #[allow(clippy::needless_range_loop)] pub fn xor_in2out(&mut self, data: &GenericArray, M>) { unsafe { let input = ptr::read(self.in_ptr); let mut temp = GenericArray::, M>::default(); for i in 0..M::USIZE { for j in 0..N::USIZE { temp[i][j] = input[i][j] ^ data[i][j]; } } ptr::write(self.out_ptr, temp); } } } inout-0.1.3/src/inout_buf.rs000064400000000000000000000221720072674642500141460ustar 00000000000000use crate::{ errors::{IntoArrayError, NotEqualError}, InOut, }; use core::{marker::PhantomData, slice}; use generic_array::{ArrayLength, GenericArray}; /// Custom slice type which references one immutable (input) slice and one /// mutable (output) slice of equal length. Input and output slices are /// either the same or do not overlap. pub struct InOutBuf<'inp, 'out, T> { pub(crate) in_ptr: *const T, pub(crate) out_ptr: *mut T, pub(crate) len: usize, pub(crate) _pd: PhantomData<(&'inp T, &'out mut T)>, } impl<'a, T> From<&'a mut [T]> for InOutBuf<'a, 'a, T> { #[inline(always)] fn from(buf: &'a mut [T]) -> Self { let p = buf.as_mut_ptr(); Self { in_ptr: p, out_ptr: p, len: buf.len(), _pd: PhantomData, } } } impl<'a, T> InOutBuf<'a, 'a, T> { /// Create `InOutBuf` from a single mutable reference. #[inline(always)] pub fn from_mut(val: &'a mut T) -> InOutBuf<'a, 'a, T> { let p = val as *mut T; Self { in_ptr: p, out_ptr: p, len: 1, _pd: PhantomData, } } } impl<'inp, 'out, T> IntoIterator for InOutBuf<'inp, 'out, T> { type Item = InOut<'inp, 'out, T>; type IntoIter = InOutBufIter<'inp, 'out, T>; #[inline(always)] fn into_iter(self) -> Self::IntoIter { InOutBufIter { buf: self, pos: 0 } } } impl<'inp, 'out, T> InOutBuf<'inp, 'out, T> { /// Create `InOutBuf` from a pair of immutable and mutable references. #[inline(always)] pub fn from_ref_mut(in_val: &'inp T, out_val: &'out mut T) -> Self { Self { in_ptr: in_val as *const T, out_ptr: out_val as *mut T, len: 1, _pd: PhantomData, } } /// Create `InOutBuf` from immutable and mutable slices. /// /// Returns an error if length of slices is not equal to each other. #[inline(always)] pub fn new(in_buf: &'inp [T], out_buf: &'out mut [T]) -> Result { if in_buf.len() != out_buf.len() { Err(NotEqualError) } else { Ok(Self { in_ptr: in_buf.as_ptr(), out_ptr: out_buf.as_mut_ptr(), len: in_buf.len(), _pd: Default::default(), }) } } /// Get length of the inner buffers. #[inline(always)] pub fn len(&self) -> usize { self.len } /// Returns `true` if the buffer has a length of 0. #[inline(always)] pub fn is_empty(&self) -> bool { self.len == 0 } /// Returns `InOut` for given position. /// /// # Panics /// If `pos` greater or equal to buffer length. #[inline(always)] pub fn get<'a>(&'a mut self, pos: usize) -> InOut<'a, 'a, T> { assert!(pos < self.len); unsafe { InOut { in_ptr: self.in_ptr.add(pos), out_ptr: self.out_ptr.add(pos), _pd: PhantomData, } } } /// Get input slice. #[inline(always)] pub fn get_in<'a>(&'a self) -> &'a [T] { unsafe { slice::from_raw_parts(self.in_ptr, self.len) } } /// Get output slice. #[inline(always)] pub fn get_out<'a>(&'a mut self) -> &'a mut [T] { unsafe { slice::from_raw_parts_mut(self.out_ptr, self.len) } } /// Consume self and return output slice with lifetime `'a`. #[inline(always)] pub fn into_out(self) -> &'out mut [T] { unsafe { slice::from_raw_parts_mut(self.out_ptr, self.len) } } /// Get raw input and output pointers. #[inline(always)] pub fn into_raw(self) -> (*const T, *mut T) { (self.in_ptr, self.out_ptr) } /// Reborrow `self`. #[inline(always)] pub fn reborrow<'a>(&'a mut self) -> InOutBuf<'a, 'a, T> { Self { in_ptr: self.in_ptr, out_ptr: self.out_ptr, len: self.len, _pd: PhantomData, } } /// Create [`InOutBuf`] from raw input and output pointers. /// /// # Safety /// Behavior is undefined if any of the following conditions are violated: /// - `in_ptr` must point to a properly initialized value of type `T` and /// must be valid for reads for `len * mem::size_of::()` many bytes. /// - `out_ptr` must point to a properly initialized value of type `T` and /// must be valid for both reads and writes for `len * mem::size_of::()` /// many bytes. /// - `in_ptr` and `out_ptr` must be either equal or non-overlapping. /// - If `in_ptr` and `out_ptr` are equal, then the memory referenced by /// them must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime 'a. Both read and write /// accesses are forbidden. /// - If `in_ptr` and `out_ptr` are not equal, then the memory referenced by /// `out_ptr` must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime 'a. Both read and write /// accesses are forbidden. The memory referenced by `in_ptr` must not be /// mutated for the duration of lifetime `'a`, except inside an `UnsafeCell`. /// - The total size `len * mem::size_of::()` must be no larger than `isize::MAX`. #[inline(always)] pub unsafe fn from_raw( in_ptr: *const T, out_ptr: *mut T, len: usize, ) -> InOutBuf<'inp, 'out, T> { Self { in_ptr, out_ptr, len, _pd: PhantomData, } } /// Divides one buffer into two at `mid` index. /// /// The first will contain all indices from `[0, mid)` (excluding /// the index `mid` itself) and the second will contain all /// indices from `[mid, len)` (excluding the index `len` itself). /// /// # Panics /// /// Panics if `mid > len`. #[inline(always)] pub fn split_at(self, mid: usize) -> (InOutBuf<'inp, 'out, T>, InOutBuf<'inp, 'out, T>) { assert!(mid <= self.len); let (tail_in_ptr, tail_out_ptr) = unsafe { (self.in_ptr.add(mid), self.out_ptr.add(mid)) }; ( InOutBuf { in_ptr: self.in_ptr, out_ptr: self.out_ptr, len: mid, _pd: PhantomData, }, InOutBuf { in_ptr: tail_in_ptr, out_ptr: tail_out_ptr, len: self.len() - mid, _pd: PhantomData, }, ) } /// Partition buffer into 2 parts: buffer of arrays and tail. #[inline(always)] pub fn into_chunks>( self, ) -> ( InOutBuf<'inp, 'out, GenericArray>, InOutBuf<'inp, 'out, T>, ) { let chunks = self.len() / N::USIZE; let tail_pos = N::USIZE * chunks; let tail_len = self.len() - tail_pos; unsafe { let chunks = InOutBuf { in_ptr: self.in_ptr as *const GenericArray, out_ptr: self.out_ptr as *mut GenericArray, len: chunks, _pd: PhantomData, }; let tail = InOutBuf { in_ptr: self.in_ptr.add(tail_pos), out_ptr: self.out_ptr.add(tail_pos), len: tail_len, _pd: PhantomData, }; (chunks, tail) } } } impl<'inp, 'out> InOutBuf<'inp, 'out, u8> { /// XORs `data` with values behind the input slice and write /// result to the output slice. /// /// # Panics /// If `data` length is not equal to the buffer length. #[inline(always)] #[allow(clippy::needless_range_loop)] pub fn xor_in2out(&mut self, data: &[u8]) { assert_eq!(self.len(), data.len()); unsafe { for i in 0..data.len() { let in_ptr = self.in_ptr.add(i); let out_ptr = self.out_ptr.add(i); *out_ptr = *in_ptr ^ data[i]; } } } } impl<'inp, 'out, T, N> TryInto>> for InOutBuf<'inp, 'out, T> where N: ArrayLength, { type Error = IntoArrayError; #[inline(always)] fn try_into(self) -> Result>, Self::Error> { if self.len() == N::USIZE { Ok(InOut { in_ptr: self.in_ptr as *const _, out_ptr: self.out_ptr as *mut _, _pd: PhantomData, }) } else { Err(IntoArrayError) } } } /// Iterator over [`InOutBuf`]. pub struct InOutBufIter<'inp, 'out, T> { buf: InOutBuf<'inp, 'out, T>, pos: usize, } impl<'inp, 'out, T> Iterator for InOutBufIter<'inp, 'out, T> { type Item = InOut<'inp, 'out, T>; #[inline(always)] fn next(&mut self) -> Option { if self.buf.len() == self.pos { return None; } let res = unsafe { InOut { in_ptr: self.buf.in_ptr.add(self.pos), out_ptr: self.buf.out_ptr.add(self.pos), _pd: PhantomData, } }; self.pos += 1; Some(res) } } inout-0.1.3/src/lib.rs000064400000000000000000000014040072674642500127150ustar 00000000000000//! Collection of custom reference types for code generic over in-place and //! buffer-to-buffer modes of operation. #![no_std] #![doc( html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg", html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg", html_root_url = "https://docs.rs/inout/0.1.3" )] #![allow(clippy::needless_lifetimes)] #![cfg_attr(docsrs, feature(doc_cfg))] #![warn(missing_docs, rust_2018_idioms)] #[cfg(feature = "std")] extern crate std; #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] pub use block_padding; mod errors; mod inout; mod inout_buf; mod reserved; pub use crate::{errors::*, inout::*, inout_buf::*, reserved::*}; inout-0.1.3/src/reserved.rs000064400000000000000000000176070072674642500140020ustar 00000000000000use crate::errors::OutIsTooSmallError; use core::{marker::PhantomData, slice}; #[cfg(feature = "block-padding")] use crate::errors::PadError; #[cfg(feature = "block-padding")] use crate::{InOut, InOutBuf}; #[cfg(feature = "block-padding")] use block_padding::{PadType, Padding}; #[cfg(feature = "block-padding")] use generic_array::{ArrayLength, GenericArray}; /// Custom slice type which references one immutable (input) slice and one /// mutable (output) slice. Input and output slices are either the same or /// do not overlap. Length of the output slice is always equal or bigger than /// length of the input slice. pub struct InOutBufReserved<'inp, 'out, T> { in_ptr: *const T, out_ptr: *mut T, in_len: usize, out_len: usize, _pd: PhantomData<(&'inp T, &'out mut T)>, } impl<'a, T> InOutBufReserved<'a, 'a, T> { /// Crate [`InOutBufReserved`] from a single mutable slice. pub fn from_mut_slice(buf: &'a mut [T], msg_len: usize) -> Result { if msg_len > buf.len() { return Err(OutIsTooSmallError); } let p = buf.as_mut_ptr(); let out_len = buf.len(); Ok(Self { in_ptr: p, out_ptr: p, in_len: msg_len, out_len, _pd: PhantomData, }) } /// Create [`InOutBufReserved`] from raw input and output pointers. /// /// # Safety /// Behavior is undefined if any of the following conditions are violated: /// - `in_ptr` must point to a properly initialized value of type `T` and /// must be valid for reads for `in_len * mem::size_of::()` many bytes. /// - `out_ptr` must point to a properly initialized value of type `T` and /// must be valid for both reads and writes for `out_len * mem::size_of::()` /// many bytes. /// - `in_ptr` and `out_ptr` must be either equal or non-overlapping. /// - If `in_ptr` and `out_ptr` are equal, then the memory referenced by /// them must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime 'a. Both read and write /// accesses are forbidden. /// - If `in_ptr` and `out_ptr` are not equal, then the memory referenced by /// `out_ptr` must not be accessed through any other pointer (not derived from /// the return value) for the duration of lifetime 'a. Both read and write /// accesses are forbidden. The memory referenced by `in_ptr` must not be /// mutated for the duration of lifetime `'a`, except inside an `UnsafeCell`. /// - The total size `in_len * mem::size_of::()` and /// `out_len * mem::size_of::()` must be no larger than `isize::MAX`. #[inline(always)] pub unsafe fn from_raw( in_ptr: *const T, in_len: usize, out_ptr: *mut T, out_len: usize, ) -> Self { Self { in_ptr, out_ptr, in_len, out_len, _pd: PhantomData, } } /// Get raw input and output pointers. #[inline(always)] pub fn into_raw(self) -> (*const T, *mut T) { (self.in_ptr, self.out_ptr) } /// Get input buffer length. #[inline(always)] pub fn get_in_len(&self) -> usize { self.in_len } /// Get output buffer length. #[inline(always)] pub fn get_out_len(&self) -> usize { self.in_len } } impl<'inp, 'out, T> InOutBufReserved<'inp, 'out, T> { /// Crate [`InOutBufReserved`] from two separate slices. pub fn from_slices( in_buf: &'inp [T], out_buf: &'out mut [T], ) -> Result { if in_buf.len() > out_buf.len() { return Err(OutIsTooSmallError); } Ok(Self { in_ptr: in_buf.as_ptr(), out_ptr: out_buf.as_mut_ptr(), in_len: in_buf.len(), out_len: out_buf.len(), _pd: PhantomData, }) } /// Get input slice. #[inline(always)] pub fn get_in<'a>(&'a self) -> &'a [T] { unsafe { slice::from_raw_parts(self.in_ptr, self.in_len) } } /// Get output slice. #[inline(always)] pub fn get_out<'a>(&'a mut self) -> &'a mut [T] { unsafe { slice::from_raw_parts_mut(self.out_ptr, self.out_len) } } } impl<'inp, 'out> InOutBufReserved<'inp, 'out, u8> { /// Transform buffer into [`PaddedInOutBuf`] using padding algorithm `P`. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] #[inline(always)] pub fn into_padded_blocks(self) -> Result, PadError> where P: Padding, BS: ArrayLength, { let bs = BS::USIZE; let blocks_len = self.in_len / bs; let tail_len = self.in_len - bs * blocks_len; let blocks = unsafe { InOutBuf::from_raw( self.in_ptr as *const GenericArray, self.out_ptr as *mut GenericArray, blocks_len, ) }; let mut tail_in = GenericArray::::default(); let tail_out = match P::TYPE { PadType::NoPadding | PadType::Ambiguous if tail_len == 0 => None, PadType::NoPadding => return Err(PadError), PadType::Reversible | PadType::Ambiguous => { let blen = bs * blocks_len; let res_len = blen + bs; if res_len > self.out_len { return Err(PadError); } // SAFETY: `in_ptr + blen..in_ptr + blen + tail_len` // is valid region for reads and `tail_len` is smaller than `BS`. // we have verified that `blen + bs <= out_len`, in other words, // `out_ptr + blen..out_ptr + blen + bs` is valid region // for writes. let out_block = unsafe { core::ptr::copy_nonoverlapping( self.in_ptr.add(blen), tail_in.as_mut_ptr(), tail_len, ); &mut *(self.out_ptr.add(blen) as *mut GenericArray) }; P::pad(&mut tail_in, tail_len); Some(out_block) } }; Ok(PaddedInOutBuf { blocks, tail_in, tail_out, }) } } /// Variant of [`InOutBuf`] with optional padded tail block. #[cfg(feature = "block-padding")] #[cfg_attr(docsrs, doc(cfg(feature = "block-padding")))] pub struct PaddedInOutBuf<'inp, 'out, BS: ArrayLength> { blocks: InOutBuf<'inp, 'out, GenericArray>, tail_in: GenericArray, tail_out: Option<&'out mut GenericArray>, } #[cfg(feature = "block-padding")] impl<'inp, 'out, BS: ArrayLength> PaddedInOutBuf<'inp, 'out, BS> { /// Get full blocks. #[inline(always)] pub fn get_blocks<'a>(&'a mut self) -> InOutBuf<'a, 'a, GenericArray> { self.blocks.reborrow() } /// Get padded tail block. /// /// For paddings with `P::TYPE = PadType::Reversible` it always returns `Some`. #[inline(always)] pub fn get_tail_block<'a>(&'a mut self) -> Option>> { match self.tail_out.as_deref_mut() { Some(out_block) => Some((&self.tail_in, out_block).into()), None => None, } } /// Convert buffer into output slice. #[inline(always)] pub fn into_out(self) -> &'out [u8] { let total_blocks = if self.tail_out.is_some() { self.blocks.len() + 1 } else { self.blocks.len() }; let res_len = BS::USIZE * total_blocks; let (_, out_ptr) = self.blocks.into_raw(); // SAFETY: `res_len` is always valid for the output buffer since // it's checked during type construction unsafe { slice::from_raw_parts(out_ptr as *const u8, res_len) } } }