1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
#![warn(missing_docs)]
//! Webcryptobox provides convenient wrappers around
//! [OpenSSL](https://docs.rs/openssl/latest/openssl/) to use
//! [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) compatible
//! cryptography.
//!
//! It works nicely together with the [JavaScript
//! Webcryptobox](https://github.com/jo/webcryptobox-js) and [Bash
//! Webcryptobox](https://github.com/jo/webcryptobox-sh).
//!
//! Webcryptobox helps with elliptic curve key generation, derivation, fingerprinting, import and
//! export as well as AES encryption and decryption.
//!
//! # Example:
//!
//! ```rust
//! // Alice creates a key and sends her public key pem to Bob
//! let alice = webcryptobox::generate_private_key().unwrap();
//! let alice_public_key = webcryptobox::get_public_key(&alice).unwrap();
//! let alice_public_key_pem = webcryptobox::export_public_key_pem(&alice_public_key).unwrap();
//!
//! // Bob also creates a key and sends his public key pem to Alice
//! let bob = webcryptobox::generate_private_key().unwrap();
//! let bobs_public_key = webcryptobox::get_public_key(&bob).unwrap();
//! let bob_public_key_pem = webcryptobox::export_public_key_pem(&bobs_public_key).unwrap();
//!
//! // Alice uses Bobs public key to derive a shared key
//! let bobs_key = webcryptobox::import_public_key_pem(&bob_public_key_pem).unwrap();
//! let alice_shared_key = webcryptobox::derive_key(alice, bobs_key).unwrap();
//!
//! // She now encrypts a message and sends the encrypted message and the iv to Bob
//! let data = (b"a secret message").to_vec();
//! let encrypted_message = webcryptobox::encrypt(&alice_shared_key, &data).unwrap();
//!
//! // Now Bob derives the same shared secret
//! let alice_key = webcryptobox::import_public_key_pem(&alice_public_key_pem).unwrap();
//! let bobs_shared_key = webcryptobox::derive_key(bob, alice_key).unwrap();
//!
//! // and decrypts the message
//! let message = webcryptobox::decrypt(&bobs_shared_key, &encrypted_message);
//! ```
use openssl::derive::Deriver;
use openssl::ec::EcGroup;
use openssl::error::ErrorStack;
use openssl::nid::Nid;
use openssl::pkey::PKey;
use openssl::rand::rand_bytes;
use openssl::sha;
use openssl::symm;
// re-exports
pub use openssl::ec::EcKey;
pub use openssl::pkey::{Private, Public};
// Cipher configuration
const CURVE: Nid = Nid::SECP521R1;
const CIPHER: fn() -> symm::Cipher = symm::Cipher::aes_256_cbc;
const KEY_LENGTH: usize = 32;
const IV_LENGTH: usize = 16;
const PASSPHRASE_LENGTH: usize = 32;
fn get_group() -> EcGroup {
EcGroup::from_curve_name(CURVE).unwrap()
}
fn get_cipher() -> symm::Cipher {
CIPHER()
}
/// Generate an EC private key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key();
/// ```
pub fn generate_private_key() -> Result<EcKey<Private>, ErrorStack> {
let group = get_group();
EcKey::generate(&group)
}
/// Given a private EC key, derives the public EC key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let public_key = webcryptobox::get_public_key(&key);
/// ```
pub fn get_public_key(private_key: &EcKey<Private>) -> Result<EcKey<Public>, ErrorStack> {
let group = get_group();
let key_point = private_key.public_key();
EcKey::from_public_key(&group, &key_point)
}
/// Export a private EC key in PEM format.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let pem = webcryptobox::export_private_key_pem(key);
/// ```
pub fn export_private_key_pem(private_key: EcKey<Private>) -> Result<Vec<u8>, ErrorStack> {
let key = PKey::from_ec_key(private_key).unwrap();
key.private_key_to_pem_pkcs8()
}
/// Import a private key PEM.
///
/// # Example:
///
/// ```rust
/// let pem = (b"-----BEGIN PRIVATE KEY-----
/// MIHuAgEAMBAGByqGSM49AgEGBSuBBAAjBIHWMIHTAgEBBEIBcf8zEjlssqn4aTEB
/// RR43ofwH/4BAXDAAd83Kz1Dyd+Ko0pit4ESgqSu/bJMdnDrpiGYuz0Klarwip8LD
/// rYd9mEahgYkDgYYABAF2Nu9XKPs2CVFocuqCfaX5FzDUt6/nT/3Evqq8jBhK/ziN
/// TrEs4wkZjuei5TS25aabX6iMex3etoN/GOw1KYpI4QBtIUnWudG8FT8N+USHSL9G
/// h9fi+Yofeq4Io9DxPU1ChCKPIoQ6ORAMWoOCk9bTdIy6yqx33+RIM04wub4QAgDo
/// LQ==
/// -----END PRIVATE KEY-----").to_vec();
/// let key = webcryptobox::import_private_key_pem(&pem);
/// ```
pub fn import_private_key_pem(pem: &[u8]) -> Result<EcKey<Private>, ErrorStack> {
EcKey::private_key_from_pem(pem)
}
/// Export a encrypted private EC key in PEM format.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let passphrase = b"secret passphrase";
/// let pem = webcryptobox::export_encrypted_private_key_pem(key, passphrase);
/// ```
pub fn export_encrypted_private_key_pem(
private_key: EcKey<Private>,
passphrase: &[u8],
) -> Result<Vec<u8>, ErrorStack> {
let cipher = get_cipher();
let key = PKey::from_ec_key(private_key).unwrap();
key.private_key_to_pem_pkcs8_passphrase(cipher, passphrase)
}
/// Import an encrypted private key PEM.
///
/// # Example:
///
/// ```rust
/// let pem = (b"-----BEGIN ENCRYPTED PRIVATE KEY-----
/// MIIBZjBgBgkqhkiG9w0BBQ0wUzAyBgkqhkiG9w0BBQwwJQQQOG0vrzwWTXnZGV40
/// QTUa7gIDAPoAMAwGCCqGSIb3DQIJBQAwHQYJYIZIAWUDBAEqBBChJ598h/deO6WH
/// YdP1lue+BIIBAE9tqarEYD51VXFCPsbIT/CVaF7RJ4emUNvk29Q35hNcf+2CRCki
/// K8T23KAPQ7GFkHBdmykV2uNvZ+CWCeKeOqj9AZU36mHK4gkIQz1bgADRjRp/lb2j
/// mBvg7Yzm3+H67zRmkr44jdqc8BJFCeqaMH6Fm6XQR0IPtUhmrR8YZyc1ka9L5+IB
/// Qk+SWDXF0brMnpLiwdKPABb4qCJ49qNwR0xVGlYyAv/XdT5PkyzzZxpwv2hLv7zw
/// y9KnnZ4qA0ceNo4RBYuWALlfqWANARl8lAvHLdSedN7cW9lU2PyXB+70twInt4Ty
/// lkyFWM+JH9SavLEAdG1mPHnYJB1INSMifS0=
/// -----END ENCRYPTED PRIVATE KEY-----").to_vec();
/// let passphrase = b"secret passphrase";
/// let key = webcryptobox::import_encrypted_private_key_pem(&pem, passphrase);
/// ```
pub fn import_encrypted_private_key_pem(
pem: &[u8],
passphrase: &[u8],
) -> Result<EcKey<Private>, ErrorStack> {
EcKey::private_key_from_pem_passphrase(pem, passphrase)
}
/// Export a encrypted private EC key in PEM format with key pair
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let alice_public_key = webcryptobox::get_public_key(&alice).unwrap();
/// webcryptobox::export_encrypted_private_key_pem_to(key, alice, alice_public_key).unwrap();
/// ```
pub fn export_encrypted_private_key_pem_to(
key: EcKey<Private>,
private_key: EcKey<Private>,
public_key: EcKey<Public>,
) -> Result<Vec<u8>, ErrorStack> {
let cipher = get_cipher();
let pkey = PKey::from_ec_key(key).unwrap();
let bits = derive_password(private_key, public_key, &PASSPHRASE_LENGTH).unwrap();
let passphrase = hex::encode(bits);
let passphrase_bits = passphrase.as_bytes();
pkey.private_key_to_pem_pkcs8_passphrase(cipher, &passphrase_bits)
}
/// Import an encrypted private key PEM from key pair.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let alice_public_key = webcryptobox::get_public_key(&alice).unwrap();
/// let bob = webcryptobox::generate_private_key().unwrap();
/// let bob_public_key = webcryptobox::get_public_key(&bob).unwrap();
/// let pem = webcryptobox::export_encrypted_private_key_pem_to(key, alice, bob_public_key).unwrap();
/// webcryptobox::import_encrypted_private_key_pem_from(&pem, bob, alice_public_key).unwrap();
/// ```
pub fn import_encrypted_private_key_pem_from(
pem: &[u8],
private_key: EcKey<Private>,
public_key: EcKey<Public>,
) -> Result<EcKey<Private>, ErrorStack> {
let bits = derive_password(private_key, public_key, &PASSPHRASE_LENGTH).unwrap();
let passphrase = hex::encode(bits);
let passphrase_bits = passphrase.as_bytes();
EcKey::private_key_from_pem_passphrase(pem, &passphrase_bits)
}
/// Export a public EC key in PEM format.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let public_key = webcryptobox::get_public_key(&key).unwrap();
/// let pem = webcryptobox::export_public_key_pem(&public_key);
/// ```
pub fn export_public_key_pem(public_key: &EcKey<Public>) -> Result<Vec<u8>, ErrorStack> {
public_key.public_key_to_pem()
}
/// Import a public key PEM.
///
/// # Example:
///
/// ```rust
/// let pem = (b"-----BEGIN PUBLIC KEY-----
/// MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBdjbvVyj7NglRaHLqgn2l+Rcw1Lev
/// 50/9xL6qvIwYSv84jU6xLOMJGY7nouU0tuWmm1+ojHsd3raDfxjsNSmKSOEAbSFJ
/// 1rnRvBU/DflEh0i/RofX4vmKH3quCKPQ8T1NQoQijyKEOjkQDFqDgpPW03SMusqs
/// d9/kSDNOMLm+EAIA6C0=
/// -----END PUBLIC KEY-----").to_vec();
/// let key = webcryptobox::import_public_key_pem(&pem);
/// ```
pub fn import_public_key_pem(pem: &[u8]) -> Result<EcKey<Public>, ErrorStack> {
EcKey::public_key_from_pem(pem)
}
/// Calculate a SHA-1 fingeprint from a private key.
///
/// This hashes the DER data of the public key part of the key. Note this does not create a
/// hash of the private key, but the public key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let fingerprint = webcryptobox::sha1_fingerprint_from_private_key(&key);
/// ```
pub fn sha1_fingerprint_from_private_key(key: &EcKey<Private>) -> Result<Vec<u8>, ErrorStack> {
let der = key.public_key_to_der().unwrap();
let mut hasher = sha::Sha1::new();
hasher.update(&der);
let hash = hasher.finish();
Ok(hash.to_vec())
}
/// Calculate a SHA-1 fingeprint of a public key.
///
/// This hashes the DER data of the key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let public_key = webcryptobox::get_public_key(&key).unwrap();
/// let fingerprint = webcryptobox::sha1_fingerprint_from_public_key(&public_key);
/// ```
pub fn sha1_fingerprint_from_public_key(key: &EcKey<Public>) -> Result<Vec<u8>, ErrorStack> {
let der = key.public_key_to_der().unwrap();
let mut hasher = sha::Sha1::new();
hasher.update(&der);
let hash = hasher.finish();
Ok(hash.to_vec())
}
/// Calculate a SHA-256 fingeprint from a private key.
///
/// This hashes the DER data of the public key part of the key. Note this does not create a
/// hash of the private key, but the public key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let fingerprint = webcryptobox::sha256_fingerprint_from_private_key(&key);
/// ```
pub fn sha256_fingerprint_from_private_key(key: &EcKey<Private>) -> Result<Vec<u8>, ErrorStack> {
let der = key.public_key_to_der().unwrap();
let mut hasher = sha::Sha256::new();
hasher.update(&der);
let hash = hasher.finish();
Ok(hash.to_vec())
}
/// Calculate a SHA-256 fingeprint of a public key.
///
/// This hashes the DER data of the key.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_private_key().unwrap();
/// let public_key = webcryptobox::get_public_key(&key).unwrap();
/// let fingerprint = webcryptobox::sha256_fingerprint_from_public_key(&public_key);
/// ```
pub fn sha256_fingerprint_from_public_key(key: &EcKey<Public>) -> Result<Vec<u8>, ErrorStack> {
let der = key.public_key_to_der().unwrap();
let mut hasher = sha::Sha256::new();
hasher.update(&der);
let hash = hasher.finish();
Ok(hash.to_vec())
}
/// Generate AES key material to be used with `encrypt` and `decrypt`.
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_key();
/// ```
pub fn generate_key() -> Result<Vec<u8>, ErrorStack> {
let mut key = vec![0; KEY_LENGTH];
rand_bytes(&mut key).unwrap();
Ok(key)
}
// Derives bits from given private and public key.
fn derive_bits(
private_key: EcKey<Private>,
public_key: EcKey<Public>,
length: usize,
) -> Result<Vec<u8>, ErrorStack> {
let private_key = PKey::from_ec_key(private_key).unwrap();
let public_key = PKey::from_ec_key(public_key).unwrap();
let mut deriver = Deriver::new(&private_key).unwrap();
deriver.set_peer(&public_key).unwrap();
let mut bits = vec![0; length];
deriver.derive(&mut bits).unwrap();
Ok(bits)
}
/// Derives AES key material to be used with `encrypt` and `decrypt` from given private and
/// public key.
///
/// # Example:
///
/// ```rust
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let bob = webcryptobox::generate_private_key().unwrap();
/// let bobs_public_key = webcryptobox::get_public_key(&bob).unwrap();
/// let key = webcryptobox::derive_key(alice, bobs_public_key);
/// ```
pub fn derive_key(
private_key: EcKey<Private>,
public_key: EcKey<Public>,
) -> Result<Vec<u8>, ErrorStack> {
derive_bits(private_key, public_key, KEY_LENGTH)
}
/// Derives password bits from given private and public key.
///
/// # Example:
///
/// ```rust
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let bob = webcryptobox::generate_private_key().unwrap();
/// let bobs_public_key = webcryptobox::get_public_key(&bob).unwrap();
/// let password = webcryptobox::derive_password(alice, bobs_public_key, &16);
/// ```
pub fn derive_password(
private_key: EcKey<Private>,
public_key: EcKey<Public>,
length: &usize,
) -> Result<Vec<u8>, ErrorStack> {
let bits = derive_bits(private_key, public_key, length + KEY_LENGTH).unwrap();
Ok(bits[KEY_LENGTH..].to_vec())
}
// Generate AES initialization vector to be used in `encrypt` and `decrypt`.
fn generate_iv() -> Result<Vec<u8>, ErrorStack> {
let mut iv = vec![0; IV_LENGTH];
rand_bytes(&mut iv).unwrap();
Ok(iv)
}
/// Encrypts data with aes-266-cbc
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_key().unwrap();
/// let data = (b"a secret message").to_vec();
/// let encrypted_message = webcryptobox::encrypt(&key, &data);
/// ```
pub fn encrypt(key: &[u8], data: &[u8]) -> Result<Vec<u8>, ErrorStack> {
let cipher = get_cipher();
let mut iv = generate_iv().unwrap();
let ciphertext = symm::encrypt(cipher, key, Some(&iv), data).unwrap();
iv.extend(ciphertext);
Ok(iv)
}
/// Decrypts aes encrypted data
///
/// # Example:
///
/// ```rust
/// let key = webcryptobox::generate_key().unwrap();
/// let data = (b"a secret message").to_vec();
/// let encrypted_message = webcryptobox::encrypt(&key, &data).unwrap();
///
/// let message = webcryptobox::decrypt(&key, &encrypted_message);
/// ```
pub fn decrypt(key: &[u8], data: &[u8]) -> Result<Vec<u8>, ErrorStack> {
let cipher = get_cipher();
let iv = &data[0..IV_LENGTH];
let d = &data[IV_LENGTH..];
symm::decrypt(cipher, key, Some(iv), &d)
}
/// Derives AES key from given private and public key and encrypts message.
///
/// # Example:
///
/// ```rust
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let bob = webcryptobox::generate_private_key().unwrap();
/// let bobs_public_key = webcryptobox::get_public_key(&bob).unwrap();
///
/// let data = (b"a secret message").to_vec();
/// let encrypted_message = webcryptobox::derive_and_encrypt(alice, bobs_public_key, &data);
/// ```
pub fn derive_and_encrypt(
private_key: EcKey<Private>,
public_key: EcKey<Public>,
data: &[u8],
) -> Result<Vec<u8>, ErrorStack> {
let key = derive_key(private_key, public_key).unwrap();
encrypt(&key, data)
}
/// Derives AES key from given private and public key and decrypts message.
///
/// # Example:
///
/// ```rust
/// let alice = webcryptobox::generate_private_key().unwrap();
/// let bob = webcryptobox::generate_private_key().unwrap();
/// let alice_public_key = webcryptobox::get_public_key(&alice).unwrap();
/// let bobs_public_key = webcryptobox::get_public_key(&bob).unwrap();
///
/// let data = (b"a secret message").to_vec();
/// let encrypted_message = webcryptobox::derive_and_encrypt(alice, bobs_public_key, &data).unwrap();
///
/// let message = webcryptobox::derive_and_decrypt(bob, alice_public_key, &encrypted_message);
/// ```
pub fn derive_and_decrypt(
private_key: EcKey<Private>,
public_key: EcKey<Public>,
data: &[u8],
) -> Result<Vec<u8>, ErrorStack> {
let key = derive_key(private_key, public_key).unwrap();
decrypt(&key, data)
}