// Copyright 2017 Parity Technologies (UK) Ltd. // This file is part of Polkadot. // Polkadot is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // Polkadot is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with Polkadot. If not, see . //! Keystore (and session key management) for polkadot. extern crate ethcrypto as crypto; extern crate subtle; extern crate ed25519; extern crate rand; extern crate serde_json; extern crate serde; extern crate hex; #[macro_use] extern crate serde_derive; #[macro_use] extern crate error_chain; #[cfg(test)] extern crate tempdir; use std::path::PathBuf; use std::fs::{self, File}; use std::io::{self, Write}; use crypto::Keccak256; use ed25519::{Pair, Public, PKCS_LEN}; pub use crypto::KEY_ITERATIONS; error_chain! { foreign_links { Io(io::Error); Json(serde_json::Error); } errors { InvalidPassword { description("Invalid password"), display("Invalid password"), } InvalidPKCS8 { description("Invalid PKCS#8 data"), display("Invalid PKCS#8 data"), } } } #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct InvalidPassword; #[derive(Serialize, Deserialize)] struct EncryptedKey { mac: [u8; 32], salt: [u8; 32], ciphertext: Vec, // TODO: switch to fixed-size when serde supports iv: [u8; 16], iterations: u32, } impl EncryptedKey { fn encrypt(plain: &[u8; PKCS_LEN], password: &str, iterations: u32) -> Self { use rand::{Rng, OsRng}; let mut rng = OsRng::new().expect("OS Randomness available on all supported platforms; qed"); let salt: [u8; 32] = rng.gen(); let iv: [u8; 16] = rng.gen(); // two parts of derived key // DK = [ DK[0..15] DK[16..31] ] = [derived_left_bits, derived_right_bits] let (derived_left_bits, derived_right_bits) = crypto::derive_key_iterations(password, &salt, iterations); // preallocated (on-stack in case of `Secret`) buffer to hold cipher // length = length(plain) as we are using CTR-approach let mut ciphertext = vec![0; PKCS_LEN]; // aes-128-ctr with initial vector of iv crypto::aes::encrypt(&derived_left_bits, &iv, plain, &mut *ciphertext); // KECCAK(DK[16..31] ++ ), where DK[16..31] - derived_right_bits let mac = crypto::derive_mac(&derived_right_bits, &*ciphertext).keccak256(); EncryptedKey { salt, iv, mac, iterations, ciphertext, } } fn decrypt(&self, password: &str) -> Result<[u8; PKCS_LEN]> { let (derived_left_bits, derived_right_bits) = crypto::derive_key_iterations(password, &self.salt, self.iterations); let mac = crypto::derive_mac(&derived_right_bits, &self.ciphertext).keccak256(); if subtle::slices_equal(&mac[..], &self.mac[..]) != 1 { return Err(ErrorKind::InvalidPassword.into()); } let mut plain = [0; PKCS_LEN]; crypto::aes::decrypt(&derived_left_bits, &self.iv, &self.ciphertext, &mut plain[..]); Ok(plain) } } /// Key store. pub struct Store { path: PathBuf, } impl Store { /// Create a new store at the given path. pub fn open(path: PathBuf) -> Result { fs::create_dir_all(&path)?; Ok(Store { path }) } /// Generate a new key, placing it into the store. pub fn generate(&self, password: &str) -> Result { let (pair, pkcs_bytes) = Pair::generate_with_pkcs8(); let key_file = EncryptedKey::encrypt(&pkcs_bytes, password, KEY_ITERATIONS as u32); let mut file = File::create(self.key_file_path(&pair.public()))?; ::serde_json::to_writer(&file, &key_file)?; file.flush()?; Ok(pair) } /// Load a key file with given public key. pub fn load(&self, public: &Public, password: &str) -> Result { let path = self.key_file_path(public); let file = File::open(path)?; let encrypted_key: EncryptedKey = ::serde_json::from_reader(&file)?; let pkcs_bytes = encrypted_key.decrypt(password)?; Pair::from_pkcs8(&pkcs_bytes[..]).map_err(|_| ErrorKind::InvalidPKCS8.into()) } /// Get public keys of all stored keys. pub fn contents(&self) -> Result> { let mut public_keys = Vec::new(); for entry in fs::read_dir(&self.path)? { let entry = entry?; let path = entry.path(); // skip directories and non-unicode file names (hex is unicode) if let Some(name) = path.file_name().and_then(|n| n.to_str()) { if name.len() != 64 { continue } match hex::decode(name) { Ok(ref hex) if hex.len() == 32 => { let mut buf = [0; 32]; buf.copy_from_slice(&hex[..]); public_keys.push(Public(buf)); } _ => continue, } } } Ok(public_keys) } fn key_file_path(&self, public: &Public) -> PathBuf { let mut buf = self.path.clone(); buf.push(hex::encode(public.as_slice())); buf } } #[cfg(test)] mod tests { use super::*; use tempdir::TempDir; #[test] fn encrypt_and_decrypt() { let plain = [1; PKCS_LEN]; let encrypted_key = EncryptedKey::encrypt(&plain, "thepassword", KEY_ITERATIONS as u32); let decrypted_key = encrypted_key.decrypt("thepassword").unwrap(); assert_eq!(&plain[..], &decrypted_key[..]); } #[test] fn decrypt_wrong_password_fails() { let plain = [1; PKCS_LEN]; let encrypted_key = EncryptedKey::encrypt(&plain, "thepassword", KEY_ITERATIONS as u32); assert!(encrypted_key.decrypt("thepassword2").is_err()); } #[test] fn decrypt_wrong_iterations_fails() { let plain = [1; PKCS_LEN]; let mut encrypted_key = EncryptedKey::encrypt(&plain, "thepassword", KEY_ITERATIONS as u32); encrypted_key.iterations -= 64; assert!(encrypted_key.decrypt("thepassword").is_err()); } #[test] fn basic_store() { let temp_dir = TempDir::new("keystore").unwrap(); let store = Store::open(temp_dir.path().to_owned()).unwrap(); assert!(store.contents().unwrap().is_empty()); let key = store.generate("thepassword").unwrap(); let key2 = store.load(&key.public(), "thepassword").unwrap(); assert!(store.load(&key.public(), "notthepassword").is_err()); assert_eq!(key.public(), key2.public()); assert_eq!(store.contents().unwrap()[0], key.public()); } }