Skip to content

crypto v0.5.0 #1303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2023
Merged

crypto v0.5.0 #1303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crypto/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ 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.5.0 (2023-04-17)
### Changed
- Bump `signature` to v2 ([#1211])
- Bump `password-hash` to v0.5 ([#1271])
- Bump `elliptic-curve` to v0.13; MSRV 1.65 ([#1302])

[#1211]: https://github.com/RustCrypto/traits/pull/1211
[#1271]: https://github.com/RustCrypto/traits/pull/1271
[#1302]: https://github.com/RustCrypto/traits/pull/1302

## 0.4.0 (2022-08-09)
### Added
- Re-export `crypto-common` as `common` ([#1076])
Expand Down
2 changes: 1 addition & 1 deletion crypto/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions crypto/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[package]
name = "crypto"
version = "0.5.0-pre" # Also update html_root_url in lib.rs when bumping this
description = """
Resources for building cryptosystems in Rust using the RustCrypto project's ecosystem.
"""
version = "0.5.0"
description = "Facade crate for all of the RustCrypto traits (e.g. `aead`, `cipher`, `digest`)"
authors = ["The RustCrypto Project Developers"]
license = "Apache-2.0 OR MIT"
documentation = "https://docs.rs/crypto"
Expand Down Expand Up @@ -41,3 +39,4 @@ rand_core = ["crypto-common/rand_core"]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
38 changes: 38 additions & 0 deletions crypto/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,44 @@ access compatible versions of all traits from the Rust Crypto project.

[Documentation][docs-link]

## About

Facade crate for [RustCrypto Traits][1], providing a single place to
access compatible versions of all traits from the Rust Crypto project.

# About

The [RustCrypto Project][2] publishes and maintains independently versioned
crates containing traits for many different kinds of cryptographic
algorithms.

However, these algorithms are often interdependent (e.g. many depend on digest
algorithms), which requires figuring out which versions of the trait crates
are compatible with each other.

This crate will automatically pull in compatible versions of these crates,
with each one gated under a cargo feature, providing a single place to both
import and upgrade these crates while ensuring they remain compatible.

# Traits

The following traits are available as re-exports of RustCrypto crates through
this crate's facade. To access a particular re-export you (or a crate you
depend on) must enable the associated Cargo feature named below.

| Re-export | Cargo feature | Description |
|-----------|---------------|-------------|
| [`aead`](https://docs.rs/aead) | `aead` | Authenticated Encryption with Associated Data (i.e. high-level symmetric encryption) |
| [`cipher`](https://docs.rs/cipher) | `cipher` | Block and stream ciphers (i.e. low-level symmetric encryption) |
| [`digest`](https://docs.rs/digest) | `digest` | Cryptographic hash functions |
| [`elliptic_curve`](https://docs.rs/elliptic-curve) | `elliptic-curve` | Elliptic curve cryptography |
| [`password_hash`](https://docs.rs/password-hash) | `password-hash` | Password hashing functions |
| [`signature`](https://docs.rs/signature) | `signature` | Digital signatures (i.e. public key-based message authentication) |
| [`universal_hash`](https://docs.rs/universal-hash) | `universal‑hash` | Universal Hash Functions (used to build MACs) |

[1]: https://github.com/RustCrypto/traits
[2]: https://github.com/RustCrypto

## Minimum Supported Rust Version

Rust **1.65** or higher.
Expand Down
41 changes: 3 additions & 38 deletions crypto/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,13 @@
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![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",
html_root_url = "https://docs.rs/crypto/0.4.0-pre"
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg"
)]
#![forbid(unsafe_code)]
#![warn(rust_2018_idioms)]

//! Facade crate for [RustCrypto Traits][1], providing a single place to
//! access compatible versions of all traits from the Rust Crypto project.
//!
//! # About
//!
//! The [RustCrypto Project][2] publishes and maintains independently versioned
//! crates containing traits for many different kinds of cryptographic
//! algorithms.
//!
//! However, these algorithms are often interdependent (e.g. many depend on digest
//! algorithms), which requires figuring out which versions of the trait crates
//! are compatible with each other.
//!
//! This crate will automatically pull in compatible versions of these crates,
//! with each one gated under a cargo feature, providing a single place to both
//! import and upgrade these crates while ensuring they remain compatible.
//!
//! # Traits
//!
//! The following traits are available as re-exports of RustCrypto crates through
//! this crate's facade. To access a particular re-export you (or a crate you
//! depend on) must enable the associated Cargo feature named below.
//!
//! | Re-export | Cargo feature | Description |
//! |-----------|---------------|-------------|
//! | [`aead`](https://docs.rs/aead) | `aead` | Authenticated Encryption with Associated Data (i.e. high-level symmetric encryption) |
//! | [`cipher`](https://docs.rs/cipher) | `cipher` | Block and stream ciphers (i.e. low-level symmetric encryption) |
//! | [`digest`](https://docs.rs/digest) | `digest` | Cryptographic hash functions |
//! | [`elliptic_curve`](https://docs.rs/elliptic-curve) | `elliptic-curve` | Elliptic curve cryptography |
//! | [`password_hash`](https://docs.rs/password-hash) | `password-hash` | Password hashing functions |
//! | [`signature`](https://docs.rs/signature) | `signature` | Digital signatures (i.e. public key-based message authentication) |
//! | [`universal_hash`](https://docs.rs/universal-hash) | `universal‑hash` | Universal Hash Functions (used to build MACs) |
//!
//! [1]: https://github.com/RustCrypto/traits
//! [2]: https://github.com/RustCrypto

pub use crypto_common as common;

#[cfg(feature = "aead")]
Expand Down