commit 274234432cee1b65ba00a1c25dd9c9d335fc06c4 Author: Olivier 'reivilibre Date: Sun May 7 22:18:07 2023 +0100 Initial commit diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..e3fecb3 --- /dev/null +++ b/.envrc @@ -0,0 +1,2 @@ +use flake + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b344c0d --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/target +/Cargo.lock + +.direnv +.idea \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..29d5281 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "byte_lamination" +version = "0.1.0" +edition = "2021" +authors = ["Olivier 'reivilibre'"] +repository = "https://git.emunest.net/reivilibre/byte_lamination.git" +license = "MIT OR Apache-2.0" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +zstd = { version = "0.12.3", optional = true } + +serde = { version = "1.0.162", optional = true } +serde_cbor = { version = "0.11.2", optional = true } +serde_bare = { version = "0.5.0", optional = true } + +[features] +# zstd: implicit by optional dep +cbor = ["serde_cbor", "serde"] +bare = ["serde_bare", "serde"] + +all = ["zstd", "cbor", "bare"] diff --git a/LICENCE.Apache2 b/LICENCE.Apache2 new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENCE.Apache2 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENCE.MIT b/LICENCE.MIT new file mode 100644 index 0000000..7666b82 --- /dev/null +++ b/LICENCE.MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Olivier 'reivilibre' + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..884ba5b --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# `byte_lamination` + +A Rust library ('crate') providing type-readable byte transformation wrappers. + +## Licence + +Licensed under either of + + * Apache Licence, Version 2.0 + ([LICENSE.Apache2](LICENSE.Apache2) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT Licence + ([LICENSE.MIT](LICENSE.MIT) or 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 licence, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..7405617 --- /dev/null +++ b/flake.lock @@ -0,0 +1,58 @@ +{ + "nodes": { + "nixpkgs": { + "locked": { + "lastModified": 1677075010, + "narHash": "sha256-X+UmR1AkdR//lPVcShmLy8p1n857IGf7y+cyCArp8bU=", + "path": "/nix/store/b1vy558z7lxph5mbg7n50b5njp393ia9-source", + "rev": "c95bf18beba4290af25c60cbaaceea1110d0f727", + "type": "path" + }, + "original": { + "id": "nixpkgs", + "type": "indirect" + } + }, + "root": { + "inputs": { + "nixpkgs": "nixpkgs", + "utils": "utils" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + }, + "utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1681202837, + "narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "cfacdce06f30d2b68473a46042957675eebb3401", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..6fecd5a --- /dev/null +++ b/flake.nix @@ -0,0 +1,26 @@ +{ + description = "byte_lamination"; + + inputs = { + utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, utils }: + utils.lib.eachDefaultSystem (system: let + pkgs = nixpkgs.legacyPackages."${system}"; + in rec { + # `nix develop` + devShell = pkgs.mkShell { + nativeBuildInputs = + let + rust-toolchain = pkgs.symlinkJoin { + name = "rust-toolchain"; + paths = with pkgs; [rustc cargo rustfmt rustPlatform.rustcSrc]; + }; + in + [ + rust-toolchain + ]; + }; + }); +} diff --git a/src/compression.rs b/src/compression.rs new file mode 100644 index 0000000..d8eb345 --- /dev/null +++ b/src/compression.rs @@ -0,0 +1,4 @@ + +#[cfg(feature = "zstd")] +pub mod zstd; + diff --git a/src/compression/zstd.rs b/src/compression/zstd.rs new file mode 100644 index 0000000..5847b80 --- /dev/null +++ b/src/compression/zstd.rs @@ -0,0 +1,66 @@ +use std::borrow::Cow; +use std::cmp::max; +use std::error::Error; +use std::marker::PhantomData; +use crate::{AutoDelaminate, AutoLaminate, ByteLamination}; + +pub struct Zstd<'a, T> { + bytes: Cow<'a, [u8]>, + _marker: PhantomData, +} + +impl<'a, T> From> for Zstd<'a, T> { + fn from(bytes: Cow<'a, [u8]>) -> Self { + Self { + bytes, + _marker: PhantomData::default(), + } + } +} + +impl<'a, T> Into> for Zstd<'a, T> { + fn into(self) -> Cow<'a, [u8]> { + self.bytes + } +} + +impl<'a, T> ByteLamination<'a> for Zstd<'a, T> {} + +/// Default Zstd compression level used for the AutoLaminate helper. +pub const DEFAULT_ZSTD_LEVEL: i32 = 12; + +/// Default memory limit for Zstd decompression used for the AutoDelaminate helper (multiplier of +/// input size). +pub const DEFAULT_MEMORY_LIMIT_MULTIPLIER: usize = 16; +/// Default minimum memory limit for Zstd decompression used for the AutoDelaminate helper. +pub const DEFAULT_MEMORY_LIMIT_MINIMUM: usize = 1024 * 1024 * 1024; + +impl Zstd<'static, T> { + pub fn compress(bytes: &[u8], level: i32) -> Result> { + let compresed_vec = zstd::bulk::compress(bytes, level)?; + Ok(Self::from(Cow::Owned(compresed_vec))) + } +} + +impl<'a, T> Zstd<'a, T> { + pub fn decompress(&self, memory_limit: usize) -> Result, Box> { + let decompressed_vec = zstd::bulk::decompress(&self.bytes, memory_limit)?; + Ok(decompressed_vec) + } +} + + +impl<'a, T: AutoLaminate + ByteLamination<'a>, U> AutoLaminate for Zstd<'a, T> { + fn laminate(item: U) -> Result> { + let bytes: Cow<'a, [u8]> = T::laminate(item)?.into(); + Zstd::compress(&bytes, DEFAULT_ZSTD_LEVEL) + } +} + +impl<'a, T: AutoDelaminate + ByteLamination<'a>, U> AutoDelaminate for Zstd<'a, T> { + fn delaminate(self) -> Result> { + let memory_limit = max(DEFAULT_MEMORY_LIMIT_MINIMUM, DEFAULT_MEMORY_LIMIT_MULTIPLIER * self.bytes.len()); + let bytes = self.decompress(memory_limit)?; + T::from(Cow::Owned(bytes)).delaminate() + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..7bf9fc9 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,47 @@ +//! A framework for 'layered' wrappers for byte transformations. +//! +//! This crate provides a framework for writing nested wrappers that operate on bytes, performing +//! operations like en/decryption, (de)compression and (de)serialisation. +//! +//! The end result might allows you to write something like e.g. `SymLockBox>`. +//! +//! The crate comes built in with a few wrappers, enableable using Cargo features: +//! - `zstd`: [Zstd compression](compression::zstd) +//! - `cbor`: [CBOR serialisation](serialisation::cbor), compatible with serde. +//! - `bare`: [BARE serialisation](serialisation::bare), compatible with serde. +//! +//! No encryption wrappers have been included yet because it would be irresponsible to include +//! unaudited cryptographic tools. + +use std::borrow::Cow; +use std::error::Error; + +pub mod compression; +pub mod serialisation; + + +/// Helper trait for when it's possible to construct a lamination without any extra inputs at any +/// steps. +pub trait AutoLaminate: Sized { + fn laminate(item: T) -> Result>; +} + +/// Helper trait for when it's possible to deconstruct a lamination without any extra inputs at any +/// steps. +pub trait AutoDelaminate { + fn delaminate(self) -> Result>; +} + +/// Helper trait for when it's possible to deconstruct a lamination without any extra inputs at any +/// steps. +/// This variant only borrows the input. +/// +/// **EXPERIMENTAL** — may be removed in the future if this does not turn out to be ergonomic. +pub trait AutoDelaminateBorrowed<'a, T> { + fn delaminate(&'a self) -> Result>; +} + + +pub trait ByteLamination<'a>: From> + Into> { + +} diff --git a/src/serialisation.rs b/src/serialisation.rs new file mode 100644 index 0000000..f0698e3 --- /dev/null +++ b/src/serialisation.rs @@ -0,0 +1,6 @@ + +#[cfg(feature = "cbor")] +pub mod cbor; + +#[cfg(feature = "bare")] +pub mod bare; diff --git a/src/serialisation/bare.rs b/src/serialisation/bare.rs new file mode 100644 index 0000000..91fc97a --- /dev/null +++ b/src/serialisation/bare.rs @@ -0,0 +1,62 @@ +use std::borrow::Cow; +use std::error::Error; +use std::marker::PhantomData; +use serde::Serialize; +use serde::de::DeserializeOwned; +use crate::{AutoDelaminate, AutoLaminate, ByteLamination}; + +/// Wrapper that uses serde to perform BARE serialisation on an arbitrary type. +pub struct SerdeBare<'a, T> { + bytes: Cow<'a, [u8]>, + _marker: PhantomData, +} + +impl<'a, T> From> for SerdeBare<'a, T> { + fn from(bytes: Cow<'a, [u8]>) -> Self { + Self { + bytes, + _marker: PhantomData::default(), + } + } +} + +impl<'a, T> Into> for SerdeBare<'a, T> { + fn into(self) -> Cow<'a, [u8]> { + self.bytes + } +} + +impl<'a, T> ByteLamination<'a> for SerdeBare<'a, T> {} + +impl<'a, T: Serialize> SerdeBare<'a, T> { + pub fn serialise<'inp>(inner: &'inp T) -> Result> { + let cbor_bytes = serde_bare::to_vec(inner)?; + Ok(Self::from(Cow::Owned(cbor_bytes))) + } +} + +impl<'a, T: DeserializeOwned> SerdeBare<'a, T> { + pub fn deserialise(&'a self) -> Result> { + let deser_t = serde_bare::from_slice(&self.bytes)?; + Ok(deser_t) + } +} + + +impl<'a, T: Serialize> AutoLaminate for SerdeBare<'a, T> { + fn laminate(item: T) -> Result> { + Self::serialise(&item) + } +} + +impl<'a, T: Serialize> AutoLaminate<&T> for SerdeBare<'a, T> { + fn laminate(item: &T) -> Result> { + Self::serialise(item) + } +} + +impl<'a, T: DeserializeOwned> AutoDelaminate for SerdeBare<'a, T> { + fn delaminate(self) -> Result> { + self.deserialise() + } +} diff --git a/src/serialisation/cbor.rs b/src/serialisation/cbor.rs new file mode 100644 index 0000000..e3c0525 --- /dev/null +++ b/src/serialisation/cbor.rs @@ -0,0 +1,68 @@ +use std::borrow::Cow; +use std::error::Error; +use std::marker::PhantomData; +use serde::{Deserialize, Serialize}; +use serde::de::DeserializeOwned; +use crate::{AutoDelaminate, AutoDelaminateBorrowed, AutoLaminate, ByteLamination}; + +/// Wrapper that uses serde to perform CBOR serialisation on an arbitrary type. +pub struct SerdeCbor<'a, T> { + bytes: Cow<'a, [u8]>, + _marker: PhantomData, +} + +impl<'a, T> From> for SerdeCbor<'a, T> { + fn from(bytes: Cow<'a, [u8]>) -> Self { + Self { + bytes, + _marker: PhantomData::default(), + } + } +} + +impl<'a, T> Into> for SerdeCbor<'a, T> { + fn into(self) -> Cow<'a, [u8]> { + self.bytes + } +} + +impl<'a, T> ByteLamination<'a> for SerdeCbor<'a, T> {} + +impl<'a, T: Serialize> SerdeCbor<'a, T> { + pub fn serialise<'inp>(inner: &'inp T) -> Result> { + let cbor_bytes = serde_cbor::to_vec(inner)?; + Ok(Self::from(Cow::Owned(cbor_bytes))) + } +} + +impl<'a, T: Deserialize<'a>> SerdeCbor<'a, T> { + pub fn deserialise(&'a self) -> Result> { + let deser_t = serde_cbor::from_slice(&self.bytes)?; + Ok(deser_t) + } +} + + +impl<'a, T: Serialize> AutoLaminate for SerdeCbor<'a, T> { + fn laminate(item: T) -> Result> { + Self::serialise(&item) + } +} + +impl<'a, T: Serialize> AutoLaminate<&T> for SerdeCbor<'a, T> { + fn laminate(item: &T) -> Result> { + Self::serialise(item) + } +} + +impl<'a, T: DeserializeOwned> AutoDelaminate for SerdeCbor<'a, T> { + fn delaminate(self) -> Result> { + self.deserialise() + } +} + +impl<'a, T: Deserialize<'a>> AutoDelaminateBorrowed<'a, T> for SerdeCbor<'a, T> { + fn delaminate(&'a self) -> Result> { + self.deserialise() + } +}