yggdrasil/rsa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

OAEP example now uses sha2 re-export (#381)

Browse Source 
People were missing that the example required the `sha2` crate as a
dependency. See #340.

This changes it to use the re-exported `sha2` crate and notes that the
`sha2` feature must be enabled.
This commit is contained in:
Tony Arcieri 2023-11-11 12:29:55 -07:00 committed by GitHub
parent b513ee3998
commit 341f06f449
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib.rs
View File

@ -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();
//!
@ -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[..]);
//! ```