From 365f1a8d6aeccc3be27693f9cd36be1dda4606cb Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Mon, 2 Jun 2025 16:30:46 -0600 Subject: [PATCH] async-signature: replace code with deprecation notice We've merged the relevant functionality into the `signature` crate proper --- .github/workflows/async-signature.yml | 67 --------- Cargo.lock | 7 - Cargo.toml | 1 - async-signature/CHANGELOG.md | 79 ---------- async-signature/Cargo.toml | 24 --- async-signature/LICENSE-APACHE | 201 -------------------------- async-signature/LICENSE-MIT | 25 ---- async-signature/README.md | 41 +----- async-signature/src/hazmat.rs | 20 --- async-signature/src/lib.rs | 35 ----- async-signature/tests/mock_impl.rs | 40 ----- 11 files changed, 4 insertions(+), 536 deletions(-) delete mode 100644 .github/workflows/async-signature.yml delete mode 100644 async-signature/CHANGELOG.md delete mode 100644 async-signature/Cargo.toml delete mode 100644 async-signature/LICENSE-APACHE delete mode 100644 async-signature/LICENSE-MIT delete mode 100644 async-signature/src/hazmat.rs delete mode 100644 async-signature/src/lib.rs delete mode 100644 async-signature/tests/mock_impl.rs diff --git a/.github/workflows/async-signature.yml b/.github/workflows/async-signature.yml deleted file mode 100644 index ba351c4ef..000000000 --- a/.github/workflows/async-signature.yml +++ /dev/null @@ -1,67 +0,0 @@ -name: async-signature - -on: - pull_request: - paths: - - "async-signature/**" - - "signature/**" - - "Cargo.*" - push: - branches: master - -defaults: - run: - working-directory: async-signature - -env: - CARGO_INCREMENTAL: 0 - RUSTFLAGS: "-Dwarnings" - -jobs: - no_std: - runs-on: ubuntu-latest - strategy: - matrix: - rust: - - 1.85.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 --target ${{ matrix.target }} --release --no-default-features - - test: - runs-on: ubuntu-latest - strategy: - matrix: - rust: - - 1.85.0 # Minimum Rust version the tests pass on - - 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 - - run: cargo test --all-features --release - - minimal-versions: - if: false # Temporarily disabled until signature v2.3.0 is published - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: RustCrypto/actions/cargo-cache@master - - uses: dtolnay/rust-toolchain@nightly - - run: cargo update -Z minimal-versions - - uses: dtolnay/rust-toolchain@stable - - uses: RustCrypto/actions/cargo-hack-install@master - - run: rm ../Cargo.toml - - run: cargo hack test --release --feature-powerset diff --git a/Cargo.lock b/Cargo.lock index 6fd5180be..3dd307246 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -31,13 +31,6 @@ version = "0.7.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50" -[[package]] -name = "async-signature" -version = "0.6.0-pre.4" -dependencies = [ - "signature", -] - [[package]] name = "autocfg" version = "1.4.0" diff --git a/Cargo.toml b/Cargo.toml index 51544176c..f89b4edce 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,6 @@ resolver = "3" members = [ "aead", - "async-signature", "cipher", "crypto", "crypto-common", diff --git a/async-signature/CHANGELOG.md b/async-signature/CHANGELOG.md deleted file mode 100644 index bef58c09a..000000000 --- a/async-signature/CHANGELOG.md +++ /dev/null @@ -1,79 +0,0 @@ -# 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.6.0 (UNRELEASED) -### Changed -- Edition changed to 2024 and MSRV bumped to 1.85 ([#1759]) - -[#1759]: https://github.com/RustCrypto/traits/pull/1759 - -## 0.5.1 (2024-04-02) -### Added -- `no_std` support ([#1544]) - -[#1544]: https://github.com/RustCrypto/traits/pull/1544 - -## 0.5.0 (2024-01-02) -### Added -- Debug impls ([#1407]) - -### Changed -- Move to AFIT; MSRV 1.75 ([#1428]) - -### Removed -- `'static` bounds ([#1430]) - -[#1407]: https://github.com/RustCrypto/traits/pull/1407 -[#1428]: https://github.com/RustCrypto/traits/pull/1428 -[#1430]: https://github.com/RustCrypto/traits/pull/1430 - -## 0.4.0 (2023-11-12) -### Changed -- MSRV 1.60 ([#1387]) - -### Removed -- Mandatory `Send` + `Sync` bounds ([#1375]) - -[#1375]: https://github.com/RustCrypto/traits/pull/1375 -[#1387]: https://github.com/RustCrypto/traits/pull/1387 - -## 0.3.0 (2023-01-15) -### Changed -- Bump `signature` to v2 ([#1141], [#1211]) - -### Removed -- `AsyncKeypair` is no longer needed due to `signature` v2 bounds changes ([#1141]) - -[#1141]: https://github.com/RustCrypto/traits/pull/1141 -[#1211]: https://github.com/RustCrypto/traits/pull/1211 - -## 0.2.1 (2022-09-15) -### Changed -- Relax `AsyncKeypair` bounds ([#1107]) -- Deprecate `AsyncKeypair` ([#1112]) - -[#1107]: https://github.com/RustCrypto/traits/pull/1107 -[#1112]: https://github.com/RustCrypto/traits/pull/1112 - -## 0.2.0 (2022-08-14) [YANKED] -### Added -- `AsyncKeypair` trait ([#1085]) - -### Changed -- Bump minimum `signature` requirement to v1.6 ([#1084]) - -[#1084]: https://github.com/RustCrypto/traits/pull/1084 -[#1085]: https://github.com/RustCrypto/traits/pull/1085 - -## 0.1.0 (2022-01-04) -### Changed -- Bump `signature` crate dependency to v1.5 ([#850], [#867]) - -[#850]: https://github.com/RustCrypto/traits/pull/850 -[#867]: https://github.com/RustCrypto/traits/pull/867 - -## 0.0.1 (2020-10-06) -- Initial release diff --git a/async-signature/Cargo.toml b/async-signature/Cargo.toml deleted file mode 100644 index a8515e233..000000000 --- a/async-signature/Cargo.toml +++ /dev/null @@ -1,24 +0,0 @@ -[package] -name = "async-signature" -version = "0.6.0-pre.4" -authors = ["RustCrypto Developers"] -edition = "2024" -rust-version = "1.85" -documentation = "https://docs.rs/async-signature" -readme = "README.md" -repository = "https://github.com/RustCrypto/traits" -license = "Apache-2.0 OR MIT" -keywords = ["crypto", "ecdsa", "ed25519", "signature", "signing"] -categories = ["cryptography", "no-std"] -description = "Traits for cryptographic signature algorithms (e.g. ECDSA, Ed25519)" - -[dependencies] -signature = "3.0.0-rc.0" - -[features] -digest = ["signature/digest"] -std = [] -rand_core = ["signature/rand_core"] - -[package.metadata.docs.rs] -all-features = true diff --git a/async-signature/LICENSE-APACHE b/async-signature/LICENSE-APACHE deleted file mode 100644 index 78173fa2e..000000000 --- a/async-signature/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - 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/async-signature/LICENSE-MIT b/async-signature/LICENSE-MIT deleted file mode 100644 index b723e3eee..000000000 --- a/async-signature/LICENSE-MIT +++ /dev/null @@ -1,25 +0,0 @@ -Copyright (c) 2020-2025 RustCrypto Developers - -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/async-signature/README.md b/async-signature/README.md index 13fbf3c13..5011c81d7 100644 --- a/async-signature/README.md +++ b/async-signature/README.md @@ -1,41 +1,8 @@ -# RustCrypto: `async-signature` +## 🚨 DEPRECATED! 🚨 -[![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] +The `async-signature` crate is deprecated and will not receive further releases. -## Deprecated +The relevant functionality has been merged into the `signature` crate: -This crate is now deprecated, all the types are available in [`signature`][signature-crate] + -## 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/async-signature.svg -[crate-link]: https://crates.io/crates/async-signature -[docs-image]: https://docs.rs/async-signature/badge.svg -[docs-link]: https://docs.rs/async-signature/ -[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg -[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg -[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg -[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260048-signatures -[build-image]: https://github.com/RustCrypto/traits/actions/workflows/async-signature.yml/badge.svg?branch=master -[build-link]: https://github.com/RustCrypto/traits/actions/workflows/async-signature.yml?query=branch:master -[signature-crate]: https://crates.io/crates/signature diff --git a/async-signature/src/hazmat.rs b/async-signature/src/hazmat.rs deleted file mode 100644 index 5fbdda362..000000000 --- a/async-signature/src/hazmat.rs +++ /dev/null @@ -1,20 +0,0 @@ -//! Hazardous Materials: low-level APIs which can be insecure if misused. -//! -//! The traits in this module are not generally recommended, and should only be -//! used in special cases where they are specifically needed. -//! -//! Using them incorrectly can introduce security vulnerabilities. Please -//! carefully read the documentation before attempting to use them. - -#[deprecated( - since = "0.6.0", - note = "use `signature::hazmat::AsyncPrehashSigner` instead" -)] -pub use signature::hazmat::AsyncPrehashSigner; - -#[cfg(feature = "rand_core")] -#[deprecated( - since = "0.6.0", - note = "use `signature::hazmat::AsyncRandomizedPrehashSigner` instead" -)] -pub use signature::hazmat::AsyncRandomizedPrehashSigner; diff --git a/async-signature/src/lib.rs b/async-signature/src/lib.rs deleted file mode 100644 index 74fbee82b..000000000 --- a/async-signature/src/lib.rs +++ /dev/null @@ -1,35 +0,0 @@ -#![no_std] -#![doc = include_str!("../README.md")] -#![doc( - html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg", - html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg" -)] -#![cfg_attr(docsrs, feature(doc_auto_cfg))] -#![forbid(unsafe_code)] -#![warn( - missing_docs, - rust_2018_idioms, - unused_qualifications, - missing_debug_implementations -)] - -pub mod hazmat; - -pub use signature::{self, Error}; - -#[cfg(feature = "digest")] -pub use signature::digest::{self, Digest}; - -#[deprecated(since = "0.6.0", note = "use `signature::AsyncSigner` instead")] -pub use signature::AsyncSigner; - -#[cfg(feature = "digest")] -#[deprecated(since = "0.6.0", note = "use `signature::AsyncDigestSigner` instead")] -pub use signature::AsyncDigestSigner; - -#[cfg(feature = "rand_core")] -#[deprecated( - since = "0.6.0", - note = "use `signature::AsyncRandomizedSigner` instead" -)] -pub use signature::AsyncRandomizedSigner; diff --git a/async-signature/tests/mock_impl.rs b/async-signature/tests/mock_impl.rs deleted file mode 100644 index d8e17ea45..000000000 --- a/async-signature/tests/mock_impl.rs +++ /dev/null @@ -1,40 +0,0 @@ -#![allow(dead_code)] -//! Check compilation of the various traits exposed by async_signature. -//! -//! This is intended to make sure we can implement those traits without conflict from a blanket -//! implementation. - -use async_signature::{AsyncSigner, Error}; - -struct Signature; - -struct MockSigner; - -impl AsyncSigner for MockSigner { - async fn sign_async(&self, _msg: &[u8]) -> Result { - unimplemented!("just meant to check compilation") - } -} - -#[cfg(feature = "digest")] -impl async_signature::AsyncDigestSigner for MockSigner -where - D: async_signature::Digest, -{ - async fn sign_digest_async(&self, _digest: D) -> Result { - unimplemented!("just meant to check compilation") - } -} - -#[cfg(feature = "rand_core")] -impl async_signature::AsyncRandomizedSigner for MockSigner { - async fn try_sign_with_rng_async< - R: async_signature::signature::rand_core::TryCryptoRng + ?Sized, - >( - &self, - _rng: &mut R, - _msg: &[u8], - ) -> Result { - unimplemented!("just meant to check compilation") - } -}