Re-export crypto_common as common (#2237)

Or rather, this imports `crypto-common` as `common` using the `package =
crypto-common` syntax in Cargo.toml, then re-exports it, which should
hopefully make for better diagnostics.

This is shorter and more convenient for imports.

Where crates were previously exporting `crypto_common`, this adds an
alias with a deprecation. Adding such an alias to `digest` was necessary
to even get anything to compile.

Author: tarcieri

aead/CHANGELOG.md

@@ -6,6 +6,9 @@ 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).
 
 ## Unreleased
+### Added
+- Re-export `crypto_common` as `common` ([#2237])
+
 ### Fixed
 - Minor documentation error in `AeadCore::TagSize` ([#1351])
 - Fixup `hybrid-array` migration ([#1531])
@@ -43,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#1531]: https://github.com/RustCrypto/traits/pull/1531
 [#1759]: https://github.com/RustCrypto/traits/pull/1759
 [#1999]: https://github.com/RustCrypto/traits/pull/1999
+[#2237]: https://github.com/RustCrypto/traits/pull/2237
 
 ## 0.5.2 (2023-04-02)
 ### Added

aead/Cargo.toml

@@ -16,7 +16,7 @@ such as AES-GCM as ChaCha20Poly1305, which provide a high-level API
 """
 
 [dependencies]
-crypto-common = "0.2.0-rc.13"
+common = { version = "0.2.0-rc.13", package = "crypto-common" }
 inout = "0.2.2"
 
 # optional dependencies
@@ -28,8 +28,8 @@ bytes = { version = "1", optional = true, default-features = false }
 default = ["rand_core"]
 alloc = []
 dev = ["blobby", "alloc"]
-getrandom = ["crypto-common/getrandom"]
-rand_core = ["crypto-common/rand_core"]
+getrandom = ["common/getrandom"]
+rand_core = ["common/rand_core"]
 
 [package.metadata.docs.rs]
 all-features = true

aead/src/dev.rs

@@ -3,7 +3,7 @@ use crate::{
     Aead, AeadInOut, Payload, Tag, TagPosition, array::typenum::Unsigned, inout::InOutBuf,
 };
 pub use blobby;
-use crypto_common::KeyInit;
+use common::KeyInit;
 
 /// AEAD test vector
 #[derive(Debug, Clone, Copy)]

aead/src/lib.rs

@@ -19,8 +19,8 @@ extern crate alloc;
 #[cfg(feature = "dev")]
 pub mod dev;
 
-pub use crypto_common::{
-    Key, KeyInit, KeySizeUser,
+pub use common::{
+    self, Key, KeyInit, KeySizeUser,
     array::{self, typenum::consts},
 };
 
@@ -29,11 +29,11 @@ pub use arrayvec;
 #[cfg(feature = "bytes")]
 pub use bytes;
 #[cfg(feature = "rand_core")]
-pub use crypto_common::{Generate, rand_core};
+pub use common::{Generate, rand_core};
 pub use inout;
 
+use common::array::{Array, ArraySize, typenum::Unsigned};
 use core::fmt;
-use crypto_common::array::{Array, ArraySize, typenum::Unsigned};
 use inout::InOutBuf;
 
 #[cfg(feature = "alloc")]

cipher/CHANGELOG.md

@@ -8,12 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## 0.5.0 (UNRELEASED)
 ### Changed
 - Edition changed to 2024 and MSRV bumped to 1.85 ([#1759])
+- Re-export of `crypto-common` moved to `cipher::common` ([#2237])
 
 ### Fixed
 - Seeking implementation in the stream cipher wrapper ([#2052])
 
 [#1759]: https://github.com/RustCrypto/traits/pull/1759
 [#2052]: https://github.com/RustCrypto/traits/pull/2052
+[#2237]: https://github.com/RustCrypto/traits/pull/2237
 
 ## 0.4.4 (2022-03-09)
 ### Changed

cipher/Cargo.toml

@@ -13,7 +13,7 @@ categories = ["cryptography", "no-std"]
 description = "Traits for describing block ciphers and stream ciphers"
 
 [dependencies]
-crypto-common = "0.2.0-rc.13"
+common = { version = "0.2.0-rc.13", package = "crypto-common" }
 inout = "0.2.2"
 
 # optional dependencies
@@ -29,10 +29,10 @@ alloc = []
 block-padding = ["inout/block-padding"]
 stream-wrapper = ["block-buffer"]
 # Enable random key and IV generation methods
-getrandom = ["crypto-common/getrandom"]
-rand_core = ["crypto-common/rand_core"]
+getrandom = ["common/getrandom"]
+rand_core = ["common/rand_core"]
 dev = ["blobby"]
-zeroize = ["dep:zeroize", "crypto-common/zeroize", "block-buffer?/zeroize"]
+zeroize = ["dep:zeroize", "common/zeroize", "block-buffer?/zeroize"]
 
 [package.metadata.docs.rs]
 all-features = true

cipher/src/block.rs

@@ -12,7 +12,7 @@
 
 #[cfg(all(feature = "block-padding", feature = "alloc"))]
 use alloc::{vec, vec::Vec};
-use crypto_common::{Block, BlockSizeUser};
+use common::{Block, BlockSizeUser};
 use inout::{InOut, InOutBuf, NotEqualError};
 #[cfg(feature = "block-padding")]
 use inout::{
@@ -136,8 +136,8 @@ pub trait BlockCipherEncrypt: BlockSizeUser + Sized {
     #[inline]
     fn encrypt_padded_vec<P: Padding>(&self, msg: &[u8]) -> Vec<u8> {
         use block_padding::{NoPadding, ZeroPadding};
+        use common::typenum::Unsigned;
         use core::any::TypeId;
-        use crypto_common::typenum::Unsigned;
 
         let bs = Self::BlockSize::USIZE;
         let msg_len = msg.len();
@@ -404,8 +404,8 @@ pub trait BlockModeEncrypt: BlockSizeUser + Sized {
     #[inline]
     fn encrypt_padded_vec<P: Padding>(self, msg: &[u8]) -> Vec<u8> {
         use block_padding::{NoPadding, ZeroPadding};
+        use common::typenum::Unsigned;
         use core::any::TypeId;
-        use crypto_common::typenum::Unsigned;
 
         let bs = Self::BlockSize::USIZE;
         let msg_len = msg.len();

cipher/src/block/backends.rs

@@ -1,4 +1,4 @@
-use crypto_common::{Block, BlockSizeUser, ParBlocks, ParBlocksSizeUser, typenum::Unsigned};
+use common::{Block, BlockSizeUser, ParBlocks, ParBlocksSizeUser, typenum::Unsigned};
 use inout::{InOut, InOutBuf};
 
 /// Trait implemented by block cipher mode encryption backends.

cipher/src/block/ctx.rs

@@ -1,4 +1,4 @@
-use crypto_common::{Block, BlockSizeUser, BlockSizes, typenum::Unsigned};
+use common::{Block, BlockSizeUser, BlockSizes, typenum::Unsigned};
 use inout::{InOut, InOutBuf};
 
 use super::{

cipher/src/lib.rs

@@ -24,9 +24,9 @@ extern crate alloc;
 
 #[cfg(feature = "dev")]
 pub use blobby;
-pub use crypto_common;
+pub use common;
 #[cfg(feature = "rand_core")]
-pub use crypto_common::rand_core;
+pub use common::rand_core;
 pub use inout;
 #[cfg(feature = "block-padding")]
 pub use inout::block_padding;
@@ -43,10 +43,13 @@ pub use block::*;
 pub use stream::*;
 pub use tweak::*;
 
-pub use crypto_common::{
+pub use common::{
     AlgorithmName, Block, BlockSizeUser, InnerIvInit, InvalidLength, Iv, IvSizeUser, IvState, Key,
     KeyInit, KeyIvInit, KeySizeUser, ParBlocks, ParBlocksSizeUser,
     array::{self, Array},
     typenum::{self, consts},
 };
 pub use inout::{InOut, InOutBuf};
+
+#[deprecated(since = "0.5.0", note = "use `cipher::common` instead")]
+pub use common as crypto_common;