From f03175e6cbf87fad5806ed9af5c9d5facf84f81a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Ho=C5=A1ek?= Date: Sun, 22 Sep 2024 13:35:10 +0200 Subject: [PATCH] implement retail-mac (ISO/IEC 9797-1 MAC Algorithm 3) --- .github/workflows/retail-mac.yml | 61 ++++++++ Cargo.lock | 11 ++ Cargo.toml | 2 +- README.md | 17 ++- retail-mac/CHANGELOG.md | 11 ++ retail-mac/Cargo.toml | 31 ++++ retail-mac/LICENSE-APACHE | 201 +++++++++++++++++++++++++ retail-mac/LICENSE-MIT | 25 ++++ retail-mac/README.md | 57 +++++++ retail-mac/benches/mod.rs | 23 +++ retail-mac/src/lib.rs | 245 +++++++++++++++++++++++++++++++ 11 files changed, 676 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/retail-mac.yml create mode 100644 retail-mac/CHANGELOG.md create mode 100644 retail-mac/Cargo.toml create mode 100644 retail-mac/LICENSE-APACHE create mode 100644 retail-mac/LICENSE-MIT create mode 100644 retail-mac/README.md create mode 100644 retail-mac/benches/mod.rs create mode 100644 retail-mac/src/lib.rs diff --git a/.github/workflows/retail-mac.yml b/.github/workflows/retail-mac.yml new file mode 100644 index 0000000..aba89e5 --- /dev/null +++ b/.github/workflows/retail-mac.yml @@ -0,0 +1,61 @@ +name: retail-mac + +on: + pull_request: + paths: + - ".github/workflows/retail-mac.yml" + - "retail-mac/**" + - "Cargo.*" + push: + branches: master + +defaults: + run: + working-directory: retail-mac + +env: + CARGO_INCREMENTAL: 0 + RUSTFLAGS: "-Dwarnings" + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - 1.71.0 # MSRV + - stable + target: + - thumbv7em-none-eabi + - wasm32-unknown-unknown + steps: + - uses: actions/checkout@v4 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + targets: ${{ matrix.target }} + - run: cargo build --no-default-features --release --target ${{ matrix.target }} + + minimal-versions: + # disabled until belt-block gets published + if: false + uses: RustCrypto/actions/.github/workflows/minimal-versions.yml@master + with: + working-directory: ${{ github.workflow }} + + test: + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - 1.72.0 # MSRV + - stable + steps: + - uses: actions/checkout@v4 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + - run: cargo test --release --no-default-features + - run: cargo test --release diff --git a/Cargo.lock b/Cargo.lock index d906585..36ba3ae 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -240,6 +240,17 @@ dependencies = [ "getrandom", ] +[[package]] +name = "retail-mac" +version = "0.2.0-pre.2" +dependencies = [ + "aes", + "cipher", + "des", + "digest", + "hex-literal", +] + [[package]] name = "sha1" version = "0.11.0-pre.4" diff --git a/Cargo.toml b/Cargo.toml index eec9b9d..4e023fa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [workspace] resolver = "2" -members = ["belt-mac", "cbc-mac", "cmac", "hmac", "pmac"] +members = ["belt-mac", "cbc-mac", "cmac", "hmac", "pmac", "retail-mac"] [profile.dev] opt-level = 2 diff --git a/README.md b/README.md index de7f30b..9f2ddce 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,14 @@ Collection of [Message Authentication Code][1] (MAC) algorithms written in pure ## Supported Algorithms -| Algorithm | Crate | Crates.io | Documentation | MSRV | -|------------|--------------|:---------:|:-------------:|:----:| -| [BelT MAC] | [`belt-mac`] | [![crates.io](https://img.shields.io/crates/v/belt-mac.svg)](https://crates.io/crates/belt-mac) | [![Documentation](https://docs.rs/belt-mac/badge.svg)](https://docs.rs/belt-mac) | ![MSRV 1.57][msrv-1.57] | -| [CBC-MAC] | [`cbc-mac`] | [![crates.io](https://img.shields.io/crates/v/cbc-mac.svg)](https://crates.io/crates/cbc-mac) | [![Documentation](https://docs.rs/cbc-mac/badge.svg)](https://docs.rs/cbc-mac) | ![MSRV 1.56][msrv-1.56] | -| [CMAC] | [`cmac`] | [![crates.io](https://img.shields.io/crates/v/cmac.svg)](https://crates.io/crates/cmac) | [![Documentation](https://docs.rs/cmac/badge.svg)](https://docs.rs/cmac) | ![MSRV 1.56][msrv-1.56] | -| [HMAC] | [`hmac`] | [![crates.io](https://img.shields.io/crates/v/hmac.svg)](https://crates.io/crates/hmac) | [![Documentation](https://docs.rs/hmac/badge.svg)](https://docs.rs/hmac) | ![MSRV 1.41][msrv-1.41] | -| [PMAC] | [`pmac`] | [![crates.io](https://img.shields.io/crates/v/pmac.svg)](https://crates.io/crates/pmac) | [![Documentation](https://docs.rs/pmac/badge.svg)](https://docs.rs/pmac) | ![MSRV 1.56][msrv-1.56] | +| Algorithm | Crate | Crates.io | Documentation | MSRV | +|--------------|----------------|:---------:|:-------------:|:----:| +| [BelT MAC] | [`belt-mac`] | [![crates.io](https://img.shields.io/crates/v/belt-mac.svg)](https://crates.io/crates/belt-mac) | [![Documentation](https://docs.rs/belt-mac/badge.svg)](https://docs.rs/belt-mac) | ![MSRV 1.57][msrv-1.57] | +| [CBC-MAC] | [`cbc-mac`] | [![crates.io](https://img.shields.io/crates/v/cbc-mac.svg)](https://crates.io/crates/cbc-mac) | [![Documentation](https://docs.rs/cbc-mac/badge.svg)](https://docs.rs/cbc-mac) | ![MSRV 1.56][msrv-1.56] | +| [CMAC] | [`cmac`] | [![crates.io](https://img.shields.io/crates/v/cmac.svg)](https://crates.io/crates/cmac) | [![Documentation](https://docs.rs/cmac/badge.svg)](https://docs.rs/cmac) | ![MSRV 1.56][msrv-1.56] | +| [HMAC] | [`hmac`] | [![crates.io](https://img.shields.io/crates/v/hmac.svg)](https://crates.io/crates/hmac) | [![Documentation](https://docs.rs/hmac/badge.svg)](https://docs.rs/hmac) | ![MSRV 1.41][msrv-1.41] | +| [PMAC] | [`pmac`] | [![crates.io](https://img.shields.io/crates/v/pmac.svg)](https://crates.io/crates/pmac) | [![Documentation](https://docs.rs/pmac/badge.svg)](https://docs.rs/pmac) | ![MSRV 1.56][msrv-1.56] | +| [Retail MAC] | [`retail-mac`] | [![crates.io](https://img.shields.io/crates/v/retail-mac.svg)](https://crates.io/crates/retail-mac) | [![Documentation](https://docs.rs/retail-mac/badge.svg)](https://docs.rs/retail-mac) | ![MSRV 1.56][msrv-1.56] | ### Minimum Supported Rust Version (MSRV) Policy @@ -51,6 +52,7 @@ Unless you explicitly state otherwise, any contribution intentionally submitted [`cmac`]: ./cmac [`hmac`]: ./hmac [`pmac`]: ./pmac +[`retail-mac`]: ./retail-mac [//]: # (footnotes) @@ -63,3 +65,4 @@ Unless you explicitly state otherwise, any contribution intentionally submitted [CMAC]: https://en.wikipedia.org/wiki/One-key_MAC [HMAC]: https://en.wikipedia.org/wiki/HMAC [PMAC]: https://en.wikipedia.org/wiki/PMAC_(cryptography) +[Retail MAC]: https://en.wikipedia.org/wiki/ISO/IEC_9797-1#MAC_algorithm_3 diff --git a/retail-mac/CHANGELOG.md b/retail-mac/CHANGELOG.md new file mode 100644 index 0000000..dae238b --- /dev/null +++ b/retail-mac/CHANGELOG.md @@ -0,0 +1,11 @@ +# 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.0 (2024-??-??) +- Initial release ([#170]) + +[#170]: https://github.com/RustCrypto/MACs/pull/170 diff --git a/retail-mac/Cargo.toml b/retail-mac/Cargo.toml new file mode 100644 index 0000000..670f4cc --- /dev/null +++ b/retail-mac/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "retail-mac" +version = "0.1.0" +description = "Implementation of Retail Message Authentication Code (Retail MAC)" +authors = ["RustCrypto Developers"] +license = "MIT OR Apache-2.0" +edition = "2021" +rust-version = "1.71" +readme = "README.md" +documentation = "https://docs.rs/retail-mac" +repository = "https://github.com/RustCrypto/MACs" +keywords = ["crypto", "mac"] + +[dependencies] +cipher = "=0.5.0-pre.7" +digest = { version = "=0.11.0-pre.9", features = ["mac"] } + +[dev-dependencies] +digest = { version = "=0.11.0-pre.9", features = ["dev"] } +hex-literal = "0.4" + +aes = "0.9.0-pre.2" +des = "0.9.0-pre.2" + +[features] +std = ["digest/std"] +zeroize = ["cipher/zeroize"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] diff --git a/retail-mac/LICENSE-APACHE b/retail-mac/LICENSE-APACHE new file mode 100644 index 0000000..78173fa --- /dev/null +++ b/retail-mac/LICENSE-APACHE @@ -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/retail-mac/LICENSE-MIT b/retail-mac/LICENSE-MIT new file mode 100644 index 0000000..f5b157a --- /dev/null +++ b/retail-mac/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2018 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. diff --git a/retail-mac/README.md b/retail-mac/README.md new file mode 100644 index 0000000..775e593 --- /dev/null +++ b/retail-mac/README.md @@ -0,0 +1,57 @@ +# RustCrypto: Retail MAC + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] +[![Build Status][build-image]][build-link] + +Pure Rust implementation of the [Retail Message Authentication Code][Retail MAC], +also known as ISO/IEC 9797-1 MAC algorithm 3. + +[Documentation][docs-link] + +## Minimum Supported Rust Version + +Rust **1.56** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## SemVer Policy + +- All on-by-default features of this library are covered by SemVer +- MSRV is considered exempt from SemVer as noted above + +## License + +Licensed under either of: + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://img.shields.io/crates/v/retail-mac.svg +[crate-link]: https://crates.io/crates/retail-mac +[docs-image]: https://docs.rs/retail-mac/badge.svg +[docs-link]: https://docs.rs/retail-mac/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260044-MACs +[build-image]: https://github.com/RustCrypto/MACs/workflows/retail-mac/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/MACs/actions?query=workflow%3Aretail-mac + +[//]: # (general links) + +[Retail MAC]: https://en.wikipedia.org/wiki/ISO/IEC_9797-1#MAC_algorithm_3 diff --git a/retail-mac/benches/mod.rs b/retail-mac/benches/mod.rs new file mode 100644 index 0000000..adf8ee5 --- /dev/null +++ b/retail-mac/benches/mod.rs @@ -0,0 +1,23 @@ +#![feature(test)] +extern crate test; + +use aes::Aes128; +use des::Des; +use retail_mac::{KeyInit, RetailMac}; +use test::Bencher; + +digest::bench_update!( + RetailMac::::new(&Default::default()); + retail_mac_aes128_10 10; + retail_mac_aes128_100 100; + retail_mac_aes128_1000 1000; + retail_mac_aes128_10000 10000; +); + +digest::bench_update!( + RetailMac::::new(&Default::default()); + retail_mac_des_10 10; + retail_mac_des_100 100; + retail_mac_des_1000 1000; + retail_mac_des_10000 10000; +); diff --git a/retail-mac/src/lib.rs b/retail-mac/src/lib.rs new file mode 100644 index 0000000..0958008 --- /dev/null +++ b/retail-mac/src/lib.rs @@ -0,0 +1,245 @@ +//! [Retail Message Authentication Code (Retail MAC)][Retail MAC] +//! implemented in pure Rust and generic over block cipher. +//! +//! **WARNING!** The algorithm has known weaknesses in case of variable-length +//! messages. See the Wikipedia article for (CBC-MAC)[CBC-MAC] for more information. +//! +//! # Examples +//! +//! ``` +//! use retail_mac::{digest::KeyInit, RetailMac, Mac}; +//! use des::Des; +//! use hex_literal::hex; +//! +//! type RetailMacDes = RetailMac; +//! +//! // test from ISO/IEC 9797-1:2011 section B.4 +//! // K and K' are concatenated: +//! let key = hex!("0123456789ABCDEFFEDCBA9876543210"); +//! +//! let mut mac = RetailMacDes::new_from_slice(&key).unwrap(); +//! mac.update(b"Now is the time for all "); +//! let correct = hex!("A1C72E74EA3FA9B6"); +//! mac.verify_slice(&correct).unwrap(); +//! +//! let mut mac2 = RetailMacDes::new_from_slice(&key).unwrap(); +//! mac2.update(b"Now is the time for it"); +//! let correct2 = hex!("2E2B1428CC78254F"); +//! mac2.verify_slice(&correct2).unwrap(); +//! ``` +//! +//! [Retail MAC]: https://en.wikipedia.org/wiki/ISO/IEC_9797-1#MAC_algorithm_3 +//! [CBC-MAC]: https://en.wikipedia.org/wiki/CBC-MAC#Security_with_fixed_and_variable-length_messages + +#![no_std] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/26acc39f/logo.svg", + html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/26acc39f/logo.svg" +)] +#![deny(unsafe_code)] +#![cfg_attr(docsrs, feature(doc_cfg))] +#![warn(missing_docs, rust_2018_idioms)] + +pub use digest::{self, Key, KeyInit, Mac}; + +use cipher::{ + BlockCipherDecrypt, BlockCipherEncBackend, BlockCipherEncClosure, BlockCipherEncrypt, + InvalidLength, KeySizeUser, +}; +use core::fmt; +use digest::{ + array::{ + typenum::{IsLess, Le, NonZero, U2, U256}, + Array, ArraySize, + }, + block_buffer::Eager, + core_api::{ + AlgorithmName, Block, BlockSizeUser, Buffer, BufferKindUser, CoreWrapper, FixedOutputCore, + UpdateCore, + }, + crypto_common::BlockSizes, + MacMarker, Output, OutputSizeUser, Reset, +}; + +#[cfg(feature = "zeroize")] +use cipher::zeroize::{Zeroize, ZeroizeOnDrop}; + +/// Generic Retail MAC instance. +pub type RetailMac = CoreWrapper>; + +/// Generic core Retail MAC instance, which operates over blocks. +#[derive(Clone)] +pub struct RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + cipher: C, + cipher_prime: C, + state: Block, +} + +impl BlockSizeUser for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + type BlockSize = C::BlockSize; +} + +impl OutputSizeUser for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + type OutputSize = C::BlockSize; +} + +impl KeySizeUser for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, + ::BlockSize: core::ops::Mul, + <::BlockSize as core::ops::Mul>::Output: ArraySize, +{ + type KeySize = <::BlockSize as core::ops::Mul>::Output; +} + +impl MacMarker for RetailMacCore where C: BlockCipherEncrypt + BlockCipherDecrypt + Clone {} + +impl BufferKindUser for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + type BufferKind = Eager; +} + +impl KeyInit for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone + KeyInit, + ::BlockSize: core::ops::Mul, + <::BlockSize as core::ops::Mul>::Output: ArraySize, +{ + #[inline(always)] + fn new(key: &Key) -> Self { + Self::new_from_slice(key.as_slice()).unwrap() + } + + #[inline(always)] + fn new_from_slice(key: &[u8]) -> Result { + let cipher = C::new_from_slice(&key[..key.len() / 2])?; + let cipher_prime = C::new_from_slice(&key[key.len() / 2..])?; + Ok(Self { + cipher, + cipher_prime, + state: Block::::default(), + }) + } +} + +impl UpdateCore for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + #[inline] + fn update_blocks(&mut self, blocks: &[Block]) { + struct Closure<'a, N: BlockSizes> { + state: &'a mut Block, + blocks: &'a [Block], + } + + impl<'a, N: BlockSizes> BlockSizeUser for Closure<'a, N> { + type BlockSize = N; + } + + impl<'a, N: BlockSizes> BlockCipherEncClosure for Closure<'a, N> { + #[inline(always)] + fn call>(self, backend: &B) { + for block in self.blocks { + xor(self.state, block); + backend.encrypt_block((self.state).into()); + } + } + } + + let Self { cipher, state, .. } = self; + cipher.encrypt_with_backend(Closure { state, blocks }) + } +} + +impl Reset for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + #[inline(always)] + fn reset(&mut self) { + self.state = Default::default(); + } +} + +impl FixedOutputCore for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, + C::BlockSize: IsLess, + Le: NonZero, +{ + #[inline] + fn finalize_fixed_core(&mut self, buffer: &mut Buffer, out: &mut Output) { + let Self { + state, + cipher, + cipher_prime, + } = self; + let pos = buffer.get_pos(); + if pos != 0 { + xor(state, &buffer.pad_with_zeros()); + cipher.encrypt_block(state); + } + cipher_prime.decrypt_block(state); + cipher.encrypt_block(state); + out.copy_from_slice(state); + } +} + +impl AlgorithmName for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone + AlgorithmName, +{ + fn write_alg_name(f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str("RetailMac<")?; + ::write_alg_name(f)?; + f.write_str(">") + } +} + +impl fmt::Debug for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone + AlgorithmName, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str("RetailMacCore<")?; + ::write_alg_name(f)?; + f.write_str("> { ... }") + } +} + +#[cfg(feature = "zeroize")] +#[cfg_attr(docsrs, doc(cfg(feature = "zeroize")))] +impl Drop for RetailMacCore +where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone, +{ + fn drop(&mut self) { + self.state.zeroize(); + } +} + +#[cfg(feature = "zeroize")] +#[cfg_attr(docsrs, doc(cfg(feature = "zeroize")))] +impl ZeroizeOnDrop for RetailMacCore where + C: BlockCipherEncrypt + BlockCipherDecrypt + Clone + ZeroizeOnDrop +{ +} + +#[inline(always)] +fn xor(buf: &mut Array, data: &Array) { + for i in 0..N::USIZE { + buf[i] ^= data[i]; + } +}