Skip to content

Commit cda011a

Browse files
authored
ed448: drop -signature suffix from crate name (#990)
Crate name is now just `ed448`, like the Ed448 variant of EdDSA. The elliptic curve's name is Ed448-Goldilocks (or "edwards448")
1 parent 0da7d96 commit cda011a

File tree

9 files changed

+24
-24
lines changed

9 files changed

+24
-24
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ opt-level = 2
1919
# when pulling a member crate through git
2020
dsa = { path = "./dsa" }
2121
ecdsa = { path = "./ecdsa" }
22-
ed448-signature = { path = "./ed448" }
22+
ed448 = { path = "./ed448" }
2323
ed25519 = { path = "./ed25519" }
2424
lms-signature = { path = "./lms" }
2525
ml-dsa = { path = "./ml-dsa" }

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and can be easily used for bare-metal or lightweight WebAssembly programming.
1616
| [`dsa`] | [Digital Signature Algorithm](https://en.wikipedia.org/wiki/Digital_Signature_Algorithm) | [![crates.io](https://img.shields.io/crates/v/dsa.svg)](https://crates.io/crates/dsa) | [![Documentation](https://docs.rs/dsa/badge.svg)](https://docs.rs/dsa) | [![dsa build](https://github.com/RustCrypto/signatures/actions/workflows/dsa.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/dsa.yml)
1717
| [`ecdsa`] | [Elliptic Curve DSA](https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm) | [![crates.io](https://img.shields.io/crates/v/ecdsa.svg)](https://crates.io/crates/ecdsa) | [![Documentation](https://docs.rs/ecdsa/badge.svg)](https://docs.rs/ecdsa) | [![ecdsa build](https://github.com/RustCrypto/signatures/actions/workflows/ecdsa.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/ecdsa.yml) |
1818
| [`ed25519`] | [EdDSA for Curve25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) | [![crates.io](https://img.shields.io/crates/v/ed25519.svg)](https://crates.io/crates/ed25519) | [![Documentation](https://docs.rs/ed25519/badge.svg)](https://docs.rs/ed25519) | [![ed25519 build](https://github.com/RustCrypto/signatures/actions/workflows/ed25519.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/ed25519.yml)
19-
| [`ed448`] | [EdDSA for Curve448](https://en.wikipedia.org/wiki/EdDSA#Ed448) | [![crates.io](https://img.shields.io/crates/v/ed448-signature.svg)](https://crates.io/crates/ed448-signature) | [![Documentation](https://docs.rs/ed448-signature/badge.svg)](https://docs.rs/ed448-signature) | [![ed448 build](https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml)
19+
| [`ed448`] | [EdDSA for Curve448](https://en.wikipedia.org/wiki/EdDSA#Ed448) | [![crates.io](https://img.shields.io/crates/v/ed448.svg)](https://crates.io/crates/ed448) | [![Documentation](https://docs.rs/ed448/badge.svg)](https://docs.rs/ed448) | [![ed448 build](https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml)
2020
| [`lms`] | [Leighton-Micali Signature](https://datatracker.ietf.org/doc/html/rfc8554) | [![crates.io](https://img.shields.io/crates/v/lms-signature.svg)](https://crates.io/crates/lms-signature) | [![Documentation](https://docs.rs/lms-signature/badge.svg)](https://docs.rs/ed25519) | [![lms build](https://github.com/RustCrypto/signatures/actions/workflows/lms.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/lms.yml)
2121
| [`ml-dsa`] | [Module Lattice DSA](https://csrc.nist.gov/pubs/fips/204/final) | [![crates.io](https://img.shields.io/crates/v/ml-dsa.svg)](https://crates.io/crates/ml-dsa) | [![Documentation](https://docs.rs/ml-dsa/badge.svg)](https://docs.rs/ml-dsa) | [![lms build](https://github.com/RustCrypto/signatures/actions/workflows/ml-dsa.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/lms.yml)
2222
| [`rfc6979`] | [Deterministic (EC)DSA Signatures](https://datatracker.ietf.org/doc/html/rfc6979) | [![crates.io](https://img.shields.io/crates/v/rfc6979.svg)](https://crates.io/crates/rfc6979) | [![Documentation](https://docs.rs/rfc6979/badge.svg)](https://docs.rs/rfc6979) | [![rfc6979 build](https://github.com/RustCrypto/signatures/actions/workflows/rfc6979.yml/badge.svg)](https://github.com/RustCrypto/signatures/actions/workflows/rfc6979.yml)

ed448/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "ed448-signature"
2+
name = "ed448"
33
version = "0.0.0"
44
edition = "2024"
55
authors = ["RustCrypto Developers"]
@@ -9,7 +9,7 @@ Edwards Digital Signature Algorithm (EdDSA) over Curve448 (as specified in RFC 7
99
support library providing signature type definitions and PKCS#8 private key
1010
decoding/encoding support
1111
"""
12-
documentation = "https://docs.rs/ed448-signature"
12+
documentation = "https://docs.rs/ed448"
1313
homepage = "https://github.com/RustCrypto/signatures/tree/master/ed448"
1414
repository = "https://github.com/RustCrypto/signatures"
1515
readme = "README.md"

ed448/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ in [RFC 7748][2].
1515
## About
1616

1717
This crate doesn't contain an implementation of Ed448, but instead
18-
contains an [`ed448_signature::Signature`][3] type which other crates can use in
18+
contains an [`ed448::Signature`][3] type which other crates can use in
1919
conjunction with the [`signature::Signer`][4] and [`signature::Verifier`][5]
2020
traits.
2121

@@ -48,10 +48,10 @@ dual licensed as above, without any additional terms or conditions.
4848

4949
[//]: # (badges)
5050

51-
[crate-image]: https://img.shields.io/crates/v/ed448-signature
52-
[crate-link]: https://crates.io/crates/ed448-signature
53-
[docs-image]: https://docs.rs/ed448-signature/badge.svg
54-
[docs-link]: https://docs.rs/ed448-signature/
51+
[crate-image]: https://img.shields.io/crates/v/ed448
52+
[crate-link]: https://crates.io/crates/ed448
53+
[docs-image]: https://docs.rs/ed448/badge.svg
54+
[docs-link]: https://docs.rs/ed448/
5555
[build-image]: https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml/badge.svg
5656
[build-link]: https://github.com/RustCrypto/signatures/actions/workflows/ed448.yml
5757
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
@@ -67,6 +67,6 @@ dual licensed as above, without any additional terms or conditions.
6767

6868
[1]: https://en.wikipedia.org/wiki/EdDSA#Ed448
6969
[2]: https://tools.ietf.org/html/rfc7748
70-
[3]: https://docs.rs/ed448-signature/latest/ed448-signature/struct.Signature.html
70+
[3]: https://docs.rs/ed448/latest/ed448/struct.Signature.html
7171
[4]: https://docs.rs/signature/latest/signature/trait.Signer.html
7272
[5]: https://docs.rs/signature/latest/signature/trait.Verifier.html

ed448/src/lib.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
//! # Using Ed448 generically over algorithm implementations/providers
1616
//!
17-
//! By using the `ed448-signature` crate, you can write code which signs and verifies
17+
//! By using the `ed448` crate, you can write code which signs and verifies
1818
//! messages using the Ed448 signature algorithm generically over any
1919
//! supported Ed448 implementation (see the next section for available
2020
//! providers).
@@ -26,20 +26,20 @@
2626
//! ## Example
2727
//!
2828
//! ```
29-
//! use ed448_signature::signature::{Signer, Verifier};
29+
//! use ed448::signature::{Signer, Verifier};
3030
//!
3131
//! pub struct HelloSigner<S>
3232
//! where
33-
//! S: Signer<ed448_signature::Signature>
33+
//! S: Signer<ed448::Signature>
3434
//! {
3535
//! pub signing_key: S
3636
//! }
3737
//!
3838
//! impl<S> HelloSigner<S>
3939
//! where
40-
//! S: Signer<ed448_signature::Signature>
40+
//! S: Signer<ed448::Signature>
4141
//! {
42-
//! pub fn sign(&self, person: &str) -> ed448_signature::Signature {
42+
//! pub fn sign(&self, person: &str) -> ed448::Signature {
4343
//! // NOTE: use `try_sign` if you'd like to be able to handle
4444
//! // errors from external signing services/devices (e.g. HSM/KMS)
4545
//! // <https://docs.rs/signature/latest/signature/trait.Signer.html#tymethod.try_sign>
@@ -53,13 +53,13 @@
5353
//!
5454
//! impl<V> HelloVerifier<V>
5555
//! where
56-
//! V: Verifier<ed448_signature::Signature>
56+
//! V: Verifier<ed448::Signature>
5757
//! {
5858
//! pub fn verify(
5959
//! &self,
6060
//! person: &str,
61-
//! signature: &ed448_signature::Signature
62-
//! ) -> Result<(), ed448_signature::Error> {
61+
//! signature: &ed448::Signature
62+
//! ) -> Result<(), ed448::Error> {
6363
//! self.verifying_key.verify(format_message(person).as_bytes(), signature)
6464
//! }
6565
//! }
@@ -211,7 +211,7 @@ impl TryFrom<&[u8]> for Signature {
211211

212212
impl fmt::Debug for Signature {
213213
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
214-
f.debug_struct("ed448_signature::Signature")
214+
f.debug_struct("ed448::Signature")
215215
.field("R", self.r_bytes())
216216
.field("s", self.s_bytes())
217217
.finish()

ed448/tests/hex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Hexadecimal display/serialization tests.
22
3-
use ed448_signature::Signature;
3+
use ed448::Signature;
44
use hex_literal::hex;
55
use std::str::FromStr;
66

ed448/tests/pkcs8.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
//! PKCS#8 private key tests
22
33
#![cfg(feature = "pkcs8")]
4-
use ed448_signature::pkcs8::{DecodePrivateKey, DecodePublicKey, KeypairBytes, PublicKeyBytes};
4+
use ed448::pkcs8::{DecodePrivateKey, DecodePublicKey, KeypairBytes, PublicKeyBytes};
55
use hex_literal::hex;
66

77
#[cfg(feature = "alloc")]
8-
use ed448_signature::pkcs8::{EncodePrivateKey, EncodePublicKey};
8+
use ed448::pkcs8::{EncodePrivateKey, EncodePublicKey};
99

1010
/// Ed448 PKCS#8 v1 private key encoded as ASN.1 DER.
1111
const PKCS8_V1_DER: &[u8] = include_bytes!("examples/pkcs8-v1.der");

ed448/tests/serde.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
#![cfg(feature = "serde")]
44

5-
use ed448_signature::{Signature, SignatureBytes};
5+
use ed448::{Signature, SignatureBytes};
66
use hex_literal::hex;
77

88
const EXAMPLE_SIGNATURE: SignatureBytes = hex!(

0 commit comments

Comments
 (0)