From 17bf657591879764e1f49062efc02169045d25a1 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Fri, 29 Dec 2023 19:16:11 -0700 Subject: [PATCH] dbl v0.4.0-pre.1 (#1001) --- Cargo.lock | 2 +- dbl/Cargo.toml | 5 +++-- dbl/README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 3 deletions(-) create mode 100644 dbl/README.md diff --git a/Cargo.lock b/Cargo.lock index 97ee0abf..67a1acd9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -51,7 +51,7 @@ dependencies = [ [[package]] name = "dbl" -version = "0.4.0-pre" +version = "0.4.0-pre.1" dependencies = [ "hybrid-array 0.2.0-pre.6 (registry+https://github.com/rust-lang/crates.io-index)", ] diff --git a/dbl/Cargo.toml b/dbl/Cargo.toml index d3784fc3..937b15c8 100644 --- a/dbl/Cargo.toml +++ b/dbl/Cargo.toml @@ -1,14 +1,15 @@ [package] name = "dbl" -version = "0.4.0-pre" +version = "0.4.0-pre.1" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" -description = "Double operation in Galois Field (GF)" +description = "Double operation in Galois Field GF(2^128) as used by e.g. CMAC/PMAC" documentation = "https://docs.rs/dbl" repository = "https://github.com/RustCrypto/utils" keywords = ["crypto", "dbl", "gf", "galois"] edition = "2021" rust-version = "1.65" +readme = "README.md" [dependencies] hybrid-array = "=0.2.0-pre.6" diff --git a/dbl/README.md b/dbl/README.md new file mode 100644 index 00000000..bd1b1bfe --- /dev/null +++ b/dbl/README.md @@ -0,0 +1,43 @@ +# [RustCrypto]: GF(2^128) "dbl" operation + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + +Double operation in Galois Field GF(2^128) as used by e.g. CMAC/PMAC. + +Also known as "multiply-by-x", the operation is performed in the finite field +represented using the primitive polynomial x^128 + x^7 + x^2 + x + 1. + +## 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/dbl.svg +[crate-link]: https://crates.io/crates/dbl +[docs-image]: https://docs.rs/dbl/badge.svg +[docs-link]: https://docs.rs/dbl/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils +[build-image]: https://github.com/RustCrypto/utils/workflows/dbl/badge.svg?branch=master&event=push +[build-link]: https://github.com/RustCrypto/utils/actions/workflows/dbl.yml + +[//]: # (general links) + +[RustCrypto]: https://github.com/rustcrypto