From 171fe379c84eeb2c50b6290b9da71bf39bf4a481 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sosth=C3=A8ne=20Gu=C3=A9don?= Date: Mon, 24 Apr 2023 11:23:00 +0200 Subject: [PATCH] Initial commit --- .github/workflows/ci.yml | 19 +++ .gitignore | 6 + Cargo.toml | 39 +++++ LICENSES/Apache-2.0.txt | 73 +++++++++ LICENSES/CC0-1.0.txt | 121 ++++++++++++++ LICENSES/MIT.txt | 9 ++ Makefile | 20 +++ README.md | 26 +++ src/lib.rs | 41 +++++ src/virt.rs | 121 ++++++++++++++ src/wrap_key_to_file/mod.rs | 313 ++++++++++++++++++++++++++++++++++++ tests/backend.rs | 153 ++++++++++++++++++ 12 files changed, 941 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSES/Apache-2.0.txt create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 Makefile create mode 100644 README.md create mode 100644 src/lib.rs create mode 100644 src/virt.rs create mode 100644 src/wrap_key_to_file/mod.rs create mode 100644 tests/backend.rs diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..58569d5 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +# Copyright (C) Nitrokey GmbH +# SPDX-License-Identifier: CC0-1.0 + +name: CI + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@master + - name: Install rust + run: rustup show + - name: Install reuse + run: sudo apt-get install --yes reuse + - name: Execute checks + run: make ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c60dd0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# Copyright (C) Nitrokey GmbH +# SPDX-License-Identifier: CC0-1.0 + +/target +Cargo.lock +*.swp diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..d9a2d08 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,39 @@ +# Copyright (C) Nitrokey GmbH +# SPDX-License-Identifier: CC0-1.0 + +[package] +name = "trussed-staging" +version = "0.1.0" +authors = ["Nitrokey GmbH "] +edition = "2021" +repository = "https://github.com/trussed-dev/trussed-staging" +license = "Apache-2.0 OR MIT" +description = "Work in progress trussed features" + +[dependencies] +trussed = { version = "0.1.0", features = ["serde-extensions"] } +chacha20poly1305 = { version = "0.10", default-features = false, features = ["heapless", "reduced-round"], optional = true } +serde = { version = "1.0.160", default-features = false, features = ["derive"] } +rand_core = { version = "0.6.4", default-features = false } +delog = "0.1.6" + +[dev-dependencies] +trussed = { version = "0.1.0", default-features = false, features = ["serde-extensions", "virt"] } + +[features] +default = ["chacha20poly1305", "virt"] +wrap-key-to-file = ["chacha20poly1305"] + +virt = ["std", "trussed/virt"] +std = [] + +# used for delog +log-all = [] +log-none = [] +log-info = [] +log-debug = [] +log-warn = [] +log-error = [] + +[patch.crates-io] +trussed = { git = "https://github.com/trussed-dev/trussed.git", rev = "55ea391367fce4bf5093ff2d3c79041d7aef0485" } diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 0000000..137069b --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,73 @@ +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/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..2071b23 --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +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/Makefile b/Makefile new file mode 100644 index 0000000..4291166 --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Copyright (C) Nitrokey GmbH +# SPDX-License-Identifier: CC0-1.0 + +.PHONY: check +check: + RUSTLFAGS='-Dwarnings' cargo check --all-features --all-targets + +.PHONY: lint +lint: + cargo clippy --all-features --all-targets -- --deny warnings + cargo fmt -- --check + RUSTDOCFLAGS='-Dwarnings' cargo doc --no-deps + reuse lint + +.PHONY: test +test: + cargo test --all-features + +.PHONY: ci +ci: check lint test diff --git a/README.md b/README.md new file mode 100644 index 0000000..865780f --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ + + +# trussed-staging + +`trussed-staging` is a custom backend for [Trussed][] that provides functionnality that is not yet merged upstream. I serves as a staging ground for new APIs + +[Trussed]: https://github.com/trussed-dev/trussed + +## License + +This project is dual-licensed under the [Apache-2.0][] and [MIT][] licenses. +Configuration files and examples are licensed under the [CC0 1.0 +license][CC0-1.0]. For more information, see the license header in each file. +You can find a copy of the license texts in the [`LICENSES`](./LICENSES) +directory. + +[Apache-2.0]: https://opensource.org/licenses/Apache-2.0 +[MIT]: https://opensource.org/licenses/MIT +[CC0-1.0]: https://creativecommons.org/publicdomain/zero/1.0/ + +This project complies with [version 3.0 of the REUSE specification][reuse]. + +[reuse]: https://reuse.software/practices/3.0/ diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..34249f6 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,41 @@ +// Copyright (C) Nitrokey GmbH +// SPDX-License-Identifier: Apache-2.0 or MIT + +#![cfg_attr(not(any(test, feature = "std")), no_std)] +#![warn( + missing_debug_implementations, + // missing_docs, + non_ascii_idents, + trivial_casts, + unused, + unused_qualifications +)] +#![deny(unsafe_code)] + +delog::generate_macros!(); + +use trussed::backend::Backend; + +#[cfg(feature = "virt")] +pub mod virt; + +#[cfg(feature = "chacha20poly1305")] +pub mod wrap_key_to_file; + +#[derive(Clone, Debug, Default)] +#[non_exhaustive] +pub struct StagingBackend {} + +impl StagingBackend { + pub fn new() -> Self { + Self {} + } +} + +#[derive(Default, Debug)] +#[non_exhaustive] +pub struct StagingContext {} + +impl Backend for StagingBackend { + type Context = StagingContext; +} diff --git a/src/virt.rs b/src/virt.rs new file mode 100644 index 0000000..3e6a833 --- /dev/null +++ b/src/virt.rs @@ -0,0 +1,121 @@ +// Copyright (C) Nitrokey GmbH +// SPDX-License-Identifier: Apache-2.0 or MIT + +//! Wrapper around [`trussed::virt`][] that provides clients with both the core backend and the [`SoftwareRsa`](crate::SoftwareRsa) backend. + +use crate::{wrap_key_to_file::WrapKeyToFileExtension, StagingBackend, StagingContext}; + +#[derive(Default, Debug)] +pub struct Dispatcher { + backend: StagingBackend, +} + +#[derive(Debug)] +pub enum BackendIds { + StagingBackend, +} + +#[derive(Debug)] +pub enum ExtensionIds { + WrapKeyToFile, +} + +impl ExtensionId for Dispatcher { + type Id = ExtensionIds; + const ID: ExtensionIds = ExtensionIds::WrapKeyToFile; +} + +impl From for u8 { + fn from(value: ExtensionIds) -> Self { + match value { + ExtensionIds::WrapKeyToFile => 0, + } + } +} + +impl TryFrom for ExtensionIds { + type Error = Error; + fn try_from(value: u8) -> Result { + match value { + 0 => Ok(Self::WrapKeyToFile), + _ => Err(Error::FunctionNotSupported), + } + } +} + +impl ExtensionDispatch for Dispatcher { + type BackendId = BackendIds; + type Context = StagingContext; + type ExtensionId = ExtensionIds; + fn core_request( + &mut self, + _backend: &Self::BackendId, + ctx: &mut trussed::types::Context, + request: &trussed::api::Request, + resources: &mut trussed::service::ServiceResources

, + ) -> Result { + self.backend + .request(&mut ctx.core, &mut ctx.backends, request, resources) + } + + fn extension_request( + &mut self, + _backend: &Self::BackendId, + extension: &Self::ExtensionId, + ctx: &mut trussed::types::Context, + request: &trussed::api::request::SerdeExtension, + resources: &mut trussed::service::ServiceResources

, + ) -> Result { + match extension { + ExtensionIds::WrapKeyToFile => self.backend.extension_request_serialized( + &mut ctx.core, + &mut ctx.backends, + request, + resources, + ), + } + } +} + +use std::path::PathBuf; +use trussed::{ + backend::{Backend, BackendId, Dispatch}, + serde_extensions::{ExtensionDispatch, ExtensionId, ExtensionImpl}, + virt::{self, Filesystem, Ram, StoreProvider}, + Error, Platform, +}; + +pub type Client = virt::Client; + +pub fn with_client(store: S, client_id: &str, f: F) -> R +where + F: FnOnce(Client) -> R, + S: StoreProvider, +{ + virt::with_platform(store, |platform| { + platform.run_client_with_backends( + client_id, + Dispatcher::default(), + &[ + BackendId::Custom(BackendIds::StagingBackend), + BackendId::Core, + ], + f, + ) + }) +} + +pub fn with_fs_client(internal: P, client_id: &str, f: F) -> R +where + F: FnOnce(Client) -> R, + P: Into, +{ + with_client(Filesystem::new(internal), client_id, f) +} + +pub fn with_ram_client(client_id: &str, f: F) -> R +where + F: FnOnce(Client) -> R, +{ + with_client(Ram::default(), client_id, f) +} diff --git a/src/wrap_key_to_file/mod.rs b/src/wrap_key_to_file/mod.rs new file mode 100644 index 0000000..bd28bf8 --- /dev/null +++ b/src/wrap_key_to_file/mod.rs @@ -0,0 +1,313 @@ +use serde::{Deserialize, Serialize}; +use trussed::{ + client::{ClientError, ClientResult}, + config::MAX_SERIALIZED_KEY_LENGTH, + key::{self, Kind, Secrecy}, + serde_extensions::{Extension, ExtensionClient, ExtensionImpl, ExtensionResult}, + service::{Filestore, Keystore, ServiceResources}, + types::{Bytes, CoreContext, GenericArray, KeyId, Location, Mechanism, PathBuf}, + Error, +}; + +const NONCE_LEN: usize = 12; +const KEY_LEN: usize = 32; +const TAG_LEN: usize = 16; +const KIND: Kind = Kind::Symmetric(KEY_LEN); +const WRAPPED_TO_FILE_LEN: usize = MAX_SERIALIZED_KEY_LENGTH + NONCE_LEN + TAG_LEN; + +#[derive(Debug, Default)] +pub struct WrapKeyToFileExtension; + +#[derive(Debug, Deserialize, Serialize)] +#[allow(missing_docs)] +pub enum WrapKeyToFileRequest { + WrapKeyToFile(request::WrapKeyToFile), + UnwrapKeyFromFile(request::UnwrapKeyFromFile), +} + +mod request { + use super::*; + use serde::{Deserialize, Serialize}; + use trussed::types::{KeyId, Location, Mechanism, Message, PathBuf}; + use trussed::Error; + + #[derive(Debug, Deserialize, Serialize)] + pub struct WrapKeyToFile { + pub mechanism: Mechanism, + pub wrapping_key: KeyId, + pub key: KeyId, + pub path: PathBuf, + pub location: Location, + pub associated_data: Message, + } + + impl TryFrom for WrapKeyToFile { + type Error = Error; + fn try_from(request: WrapKeyToFileRequest) -> Result { + match request { + WrapKeyToFileRequest::WrapKeyToFile(request) => Ok(request), + _ => Err(Error::InternalError), + } + } + } + + impl From for WrapKeyToFileRequest { + fn from(request: WrapKeyToFile) -> Self { + Self::WrapKeyToFile(request) + } + } + + #[derive(Debug, Deserialize, Serialize)] + pub struct UnwrapKeyFromFile { + pub mechanism: Mechanism, + pub key: KeyId, + pub path: PathBuf, + pub file_location: Location, + pub key_location: Location, + pub associated_data: Message, + } + + impl TryFrom for UnwrapKeyFromFile { + type Error = Error; + fn try_from(request: WrapKeyToFileRequest) -> Result { + match request { + WrapKeyToFileRequest::UnwrapKeyFromFile(request) => Ok(request), + _ => Err(Error::InternalError), + } + } + } + + impl From for WrapKeyToFileRequest { + fn from(request: UnwrapKeyFromFile) -> Self { + Self::UnwrapKeyFromFile(request) + } + } +} + +#[derive(Debug, Deserialize, Serialize)] +#[allow(missing_docs)] +pub enum WrapKeyToFileReply { + WrapKeyToFile(reply::WrapKeyToFile), + UnwrapKeyFromFile(reply::UnwrapKeyFromFile), +} + +mod reply { + use serde::{Deserialize, Serialize}; + use trussed::{types::KeyId, Error}; + + use super::*; + + #[derive(Debug, Deserialize, Serialize)] + #[non_exhaustive] + pub struct WrapKeyToFile {} + + impl TryFrom for WrapKeyToFile { + type Error = Error; + fn try_from(reply: WrapKeyToFileReply) -> Result { + match reply { + WrapKeyToFileReply::WrapKeyToFile(reply) => Ok(reply), + _ => Err(Error::InternalError), + } + } + } + + impl From for WrapKeyToFileReply { + fn from(reply: WrapKeyToFile) -> Self { + Self::WrapKeyToFile(reply) + } + } + + #[derive(Debug, Deserialize, Serialize)] + pub struct UnwrapKeyFromFile { + pub key: Option, + } + + impl TryFrom for UnwrapKeyFromFile { + type Error = Error; + fn try_from(reply: WrapKeyToFileReply) -> Result { + match reply { + WrapKeyToFileReply::UnwrapKeyFromFile(reply) => Ok(reply), + _ => Err(Error::InternalError), + } + } + } + + impl From for WrapKeyToFileReply { + fn from(reply: UnwrapKeyFromFile) -> Self { + Self::UnwrapKeyFromFile(reply) + } + } +} + +impl Extension for WrapKeyToFileExtension { + type Request = WrapKeyToFileRequest; + type Reply = WrapKeyToFileReply; +} + +pub fn wrap_key_to_file( + keystore: &mut impl Keystore, + filestore: &mut impl Filestore, + request: &request::WrapKeyToFile, +) -> Result { + if !matches!( + request.mechanism, + trussed::types::Mechanism::Chacha8Poly1305 + ) { + return Err(Error::MechanismInvalid); + } + + use chacha20poly1305::aead::{AeadMutInPlace, KeyInit}; + use chacha20poly1305::ChaCha8Poly1305; + use rand_core::RngCore as _; + + let serialized_key = keystore.load_key(Secrecy::Secret, None, &request.key)?; + + let mut data = Bytes::::from_slice(&serialized_key.serialize()).unwrap(); + let material_len = data.len(); + data.resize_default(material_len + NONCE_LEN).unwrap(); + let (material, nonce) = data.split_at_mut(material_len); + keystore.rng().fill_bytes(nonce); + let nonce = (&*nonce).try_into().unwrap(); + + let key = keystore.load_key(Secrecy::Secret, Some(KIND), &request.wrapping_key)?; + let chachakey: [u8; KEY_LEN] = (&*key.material).try_into().unwrap(); + let mut aead = ChaCha8Poly1305::new(&GenericArray::clone_from_slice(&chachakey)); + let tag = aead + .encrypt_in_place_detached( + <&GenericArray<_, _> as From<&[u8; NONCE_LEN]>>::from(nonce), + &request.associated_data, + material, + ) + .unwrap(); + data.extend_from_slice(&tag).unwrap(); + filestore.write(&request.path, request.location, &data)?; + Ok(reply::WrapKeyToFile {}) +} + +pub fn unwrap_key_from_file( + keystore: &mut impl Keystore, + filestore: &mut impl Filestore, + request: &request::UnwrapKeyFromFile, +) -> Result { + if !matches!( + request.mechanism, + trussed::types::Mechanism::Chacha8Poly1305 + ) { + return Err(Error::MechanismInvalid); + } + + use chacha20poly1305::aead::{AeadMutInPlace, KeyInit}; + use chacha20poly1305::ChaCha8Poly1305; + let mut data: Bytes = + filestore.read(&request.path, request.file_location)?; + + let data_len = data.len(); + if data_len < TAG_LEN + NONCE_LEN { + error!("Attempt to unwrap file that doesn't contain a key"); + return Err(Error::InvalidSerializedKey); + } + let (tmp, tag) = data.split_at_mut(data_len - TAG_LEN); + let tmp_len = tmp.len(); + let (material, nonce) = tmp.split_at_mut(tmp_len - NONCE_LEN); + + // Coerce to array + let nonce = (&*nonce).try_into().unwrap(); + let tag = (&*tag).try_into().unwrap(); + + let key = keystore.load_key(key::Secrecy::Secret, Some(KIND), &request.key)?; + let chachakey: [u8; KEY_LEN] = (&*key.material).try_into().unwrap(); + let mut aead = ChaCha8Poly1305::new(&GenericArray::clone_from_slice(&chachakey)); + if aead + .decrypt_in_place_detached( + <&GenericArray<_, _> as From<&[u8; NONCE_LEN]>>::from(nonce), + &request.associated_data, + material, + <&GenericArray<_, _> as From<&[u8; TAG_LEN]>>::from(tag), + ) + .is_err() + { + return Ok(reply::UnwrapKeyFromFile { key: None }); + } + let key = key::Key::try_deserialize(material)?; + let info = key::Info { + flags: key.flags, + kind: key.kind, + }; + let key = keystore.store_key(request.key_location, Secrecy::Secret, info, &key.material)?; + Ok(reply::UnwrapKeyFromFile { key: Some(key) }) +} + +impl ExtensionImpl for super::StagingBackend { + fn extension_request( + &mut self, + core_ctx: &mut CoreContext, + _backend_ctx: &mut Self::Context, + request: &WrapKeyToFileRequest, + resources: &mut ServiceResources

, + ) -> Result { + let keystore = &mut resources.keystore(core_ctx)?; + let filestore = &mut resources.filestore(core_ctx); + match request { + WrapKeyToFileRequest::WrapKeyToFile(request) => { + wrap_key_to_file(keystore, filestore, request).map(Into::into) + } + WrapKeyToFileRequest::UnwrapKeyFromFile(request) => { + unwrap_key_from_file(keystore, filestore, request).map(Into::into) + } + } + } +} + +type WrapKeyToFileResult<'a, R, C> = ExtensionResult<'a, WrapKeyToFileExtension, R, C>; + +pub trait WrapKeyToFileClient: ExtensionClient { + /// Wrap a key to a file + /// This enables wrapping keys that don't fit in the buffers used by + /// [`write_file`](FilesystemClient::write_file) and [`read_file`](FilesystemClient::read_file) + fn wrap_key_to_file( + &mut self, + mechanism: Mechanism, + wrapping_key: KeyId, + key: KeyId, + path: PathBuf, + location: Location, + associated_data: &[u8], + ) -> WrapKeyToFileResult<'_, reply::WrapKeyToFile, Self> { + let associated_data = + Bytes::from_slice(associated_data).map_err(|_| ClientError::DataTooLarge)?; + self.extension(request::WrapKeyToFile { + mechanism, + wrapping_key, + key, + path, + location, + associated_data, + }) + } + + /// Wrap a key to a file + /// This enables wrapping keys that don't fit in the buffers used by + /// [`write_file`](FilesystemClient::write_file) and [`read_file`](FilesystemClient::read_file) + fn unwrap_key_from_file( + &mut self, + mechanism: Mechanism, + key: KeyId, + path: PathBuf, + file_location: Location, + key_location: Location, + associated_data: &[u8], + ) -> WrapKeyToFileResult<'_, reply::UnwrapKeyFromFile, Self> { + let associated_data = + Bytes::from_slice(associated_data).map_err(|_| ClientError::DataTooLarge)?; + self.extension(request::UnwrapKeyFromFile { + mechanism, + key, + path, + file_location, + key_location, + associated_data, + }) + } +} + +impl> WrapKeyToFileClient for C {} diff --git a/tests/backend.rs b/tests/backend.rs new file mode 100644 index 0000000..bc69bfc --- /dev/null +++ b/tests/backend.rs @@ -0,0 +1,153 @@ +#![cfg(feature = "virt")] + +use trussed::client::CryptoClient; +use trussed::syscall; +use trussed::types::{ + KeyId, KeySerialization, Location::*, Mechanism, PathBuf, SignatureSerialization, + StorageAttributes, +}; + +use trussed_staging::virt::with_ram_client; +use trussed_staging::wrap_key_to_file::WrapKeyToFileClient; + +fn assert_key_eq(key1: KeyId, key2: KeyId, client: &mut impl trussed::Client) { + let derivative1 = syscall!(client.sign( + Mechanism::HmacSha256, + key1, + &[], + SignatureSerialization::Raw + )) + .signature; + let derivative2 = syscall!(client.sign( + Mechanism::HmacSha256, + key2, + &[], + SignatureSerialization::Raw + )) + .signature; + assert_eq!(derivative1, derivative2); +} + +#[test] +fn chacha_wrapkey() { + with_ram_client("staging-tests", |mut client| { + let client = &mut client; + // Way to get a compatible Symmetric32 key + let key = syscall!(client.unsafe_inject_key( + Mechanism::Aes256Cbc, + b"12345678123456781234567812345678", + Volatile, + KeySerialization::Raw + )) + .key; + + let key2 = syscall!(client.generate_secret_key(32, Volatile)).key; + + let wrapped = + syscall!(client.wrap_key(Mechanism::Chacha8Poly1305, key, key2, &[])).wrapped_key; + let unwrapped = syscall!(client.unwrap_key( + Mechanism::Chacha8Poly1305, + key, + wrapped, + &[], + StorageAttributes::new() + )) + .key + .unwrap(); + assert_key_eq(key2, unwrapped, client); + + let wrapped_ad = + syscall!(client.wrap_key(Mechanism::Chacha8Poly1305, key, key2, b"abc")).wrapped_key; + assert!(syscall!(client.unwrap_key( + Mechanism::Chacha8Poly1305, + key, + wrapped_ad.clone(), + &[], + StorageAttributes::new() + )) + .key + .is_none()); + let unwrapped2 = syscall!(client.unwrap_key( + Mechanism::Chacha8Poly1305, + key, + wrapped_ad, + b"abc", + StorageAttributes::new() + )) + .key + .unwrap(); + assert_key_eq(key2, unwrapped2, client); + }); +} + +#[test] +fn chacha_wraptofile() { + with_ram_client("staging-tests", |mut client| { + let client = &mut client; + // Way to get a compatible Symmetric32 key + let key = syscall!(client.unsafe_inject_key( + Mechanism::Aes256Cbc, + b"12345678123456781234567812345678", + Volatile, + KeySerialization::Raw + )) + .key; + + let path = PathBuf::from("test_file"); + + let key2 = syscall!(client.generate_secret_key(32, Volatile)).key; + + syscall!(client.wrap_key_to_file( + Mechanism::Chacha8Poly1305, + key, + key2, + path.clone(), + Volatile, + &[], + )); + + let unwrapped = syscall!(client.unwrap_key_from_file( + Mechanism::Chacha8Poly1305, + key, + path.clone(), + Volatile, + Volatile, + &[], + )) + .key + .unwrap(); + assert_key_eq(key2, unwrapped, client); + + syscall!(client.wrap_key_to_file( + Mechanism::Chacha8Poly1305, + key, + key2, + path.clone(), + Volatile, + b"some ad", + )); + + assert!(syscall!(client.unwrap_key_from_file( + Mechanism::Chacha8Poly1305, + key, + path.clone(), + Volatile, + Volatile, + &[], + )) + .key + .is_none()); + + let unwrapped = syscall!(client.unwrap_key_from_file( + Mechanism::Chacha8Poly1305, + key, + path, + Volatile, + Volatile, + b"some ad", + )) + .key + .unwrap(); + assert_key_eq(key2, unwrapped, client); + }); +}