Skip to content

Commit

Permalink
OAEP example now uses sha2 re-export (RustCrypto#381)
Browse files Browse the repository at this point in the history
People were missing that the example required the `sha2` crate as a
dependency. See RustCrypto#340.

This changes it to use the re-exported `sha2` crate and notes that the
`sha2` feature must be enabled.
  • Loading branch information
tarcieri authored Nov 11, 2023
1 parent b513ee3 commit 341f06f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@
//! # Usage
//!
//! ## OAEP encryption
//! ```
//! use rsa::{RsaPrivateKey, RsaPublicKey, Oaep};
//!
//! Note: requires `sha2` feature of `rsa` crate is enabled.
//!
#![cfg_attr(feature = "sha2", doc = "```")]
#![cfg_attr(not(feature = "sha2"), doc = "```ignore")]
//! use rsa::{RsaPrivateKey, RsaPublicKey, Oaep, sha2::Sha256};
//!
//! let mut rng = rand::thread_rng();
//!
Expand All @@ -29,12 +33,12 @@
//!
//! // Encrypt
//! let data = b"hello world";
//! let padding = Oaep::new::<sha2::Sha256>();
//! let padding = Oaep::new::<Sha256>();
//! let enc_data = public_key.encrypt(&mut rng, padding, &data[..]).expect("failed to encrypt");
//! assert_ne!(&data[..], &enc_data[..]);
//!
//! // Decrypt
//! let padding = Oaep::new::<sha2::Sha256>();
//! let padding = Oaep::new::<Sha256>();
//! let dec_data = private_key.decrypt(padding, &enc_data).expect("failed to decrypt");
//! assert_eq!(&data[..], &dec_data[..]);
//! ```
Expand Down

0 comments on commit 341f06f

Please sign in to comment.