      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

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity 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.

    // Parity 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 Parity.  If not, see <http://www.gnu.org/licenses/>.

    use std::{fs, io};
    use std::path::{PathBuf, Path};
    use std::collections::HashMap;
    use time;
    use {json, SafeAccount, Error};
    use json::Uuid;
    use super::{KeyDirectory, VaultKeyDirectory, VaultKeyDirectoryProvider, VaultKey};
    use super::vault::VaultDiskDirectory;

    const IGNORED_FILES: &'static [&'static str] = &[
    	"thumbs.db",
    	"address_book.json",
    	"dapps_policy.json",
    	"dapps_accounts.json",
    	"dapps_history.json",
    	"vault.json",
    ];

    #[cfg(not(windows))]
    fn restrict_permissions_to_owner(file_path: &Path) -> Result<(), i32>  {
    	use std::ffi;
    	use libc;

    	let cstr = ffi::CString::new(&*file_path.to_string_lossy())
    		.map_err(|_| -1)?;
    	match unsafe { libc::chmod(cstr.as_ptr(), libc::S_IWUSR | libc::S_IRUSR) } {
    		0 => Ok(()),
    		x => Err(x),
    	}
    }

    #[cfg(windows)]
    fn restrict_permissions_to_owner(_file_path: &Path) -> Result<(), i32> {
    	Ok(())
    }

    /// Root keys directory implementation
    pub type RootDiskDirectory = DiskDirectory<DiskKeyFileManager>;

    /// Disk directory key file manager
    pub trait KeyFileManager: Send + Sync {
    	/// Read `SafeAccount` from given key file stream
    	fn read<T>(&self, filename: Option<String>, reader: T) -> Result<SafeAccount, Error> where T: io::Read;
    	/// Write `SafeAccount` to given key file stream
    	fn write<T>(&self, account: SafeAccount, writer: &mut T) -> Result<(), Error> where T: io::Write;
    }

    /// Disk-based keys directory implementation
    pub struct DiskDirectory<T> where T: KeyFileManager {
    	path: PathBuf,
    	key_manager: T,
    }

    /// Keys file manager for root keys directory
    pub struct DiskKeyFileManager;

    impl RootDiskDirectory {
    	pub fn create<P>(path: P) -> Result<Self, Error> where P: AsRef<Path> {
    		fs::create_dir_all(&path)?;
    		Ok(Self::at(path))
    	}

    	pub fn at<P>(path: P) -> Self where P: AsRef<Path> {
    		DiskDirectory::new(path, DiskKeyFileManager)
    	}
    }

    impl<T> DiskDirectory<T> where T: KeyFileManager {
    	/// Create new disk directory instance
    	pub fn new<P>(path: P, key_manager: T) -> Self where P: AsRef<Path> {
    		DiskDirectory {
    			path: path.as_ref().to_path_buf(),
    			key_manager: key_manager,
    		}
    	}

    	/// all accounts found in keys directory
    	fn files(&self) -> Result<HashMap<PathBuf, SafeAccount>, Error> {
    		// it's not done using one iterator cause
    		// there is an issue with rustc and it takes tooo much time to compile
    		let paths = fs::read_dir(&self.path)?
    			.flat_map(Result::ok)
    			.filter(|entry| {
    				let metadata = entry.metadata().ok();
    				let file_name = entry.file_name();
    				let name = file_name.to_string_lossy();
    				// filter directories
    				metadata.map_or(false, |m| !m.is_dir()) &&
    				// hidden files
    				!name.starts_with(".") &&
    				// other ignored files
    				!IGNORED_FILES.contains(&&*name)
    			})
    			.map(|entry| entry.path())
    			.collect::<Vec<PathBuf>>();

    		Ok(paths
    			.into_iter()
    			.filter_map(|path| {
    				let filename = Some(path.file_name().and_then(|n| n.to_str()).expect("Keys have valid UTF8 names only.").to_owned());
    				fs::File::open(path.clone())
    					.map_err(Into::into)
    					.and_then(|file| self.key_manager.read(filename, file))
    					.map_err(|err| {
    						warn!("Invalid key file: {:?} ({})", path, err);
    						err
    					})
    					.map(|account| (path, account))
    					.ok()
    			})
    			.collect()
    		)
    	}

    	/// insert account with given file name
    	pub fn insert_with_filename(&self, account: SafeAccount, filename: String) -> Result<SafeAccount, Error> {
    		// update account filename
    		let original_account = account.clone();
    		let mut account = account;
    		account.filename = Some(filename.clone());

    		{
    			// Path to keyfile
    			let mut keyfile_path = self.path.clone();
    			keyfile_path.push(filename.as_str());

    			// save the file
    			let mut file = fs::File::create(&keyfile_path)?;
    			if let Err(err) = self.key_manager.write(original_account, &mut file).map_err(|e| Error::Custom(format!("{:?}", e))) {
    				drop(file);
    				fs::remove_file(keyfile_path).expect("Expected to remove recently created file");
    				return Err(err);
    			}

    			if let Err(_) = restrict_permissions_to_owner(keyfile_path.as_path()) {
    				drop(file);
    				fs::remove_file(keyfile_path).expect("Expected to remove recently created file");
    				return Err(Error::Io(io::Error::last_os_error()));
    			}
    		}

    		Ok(account)
    	}

    	/// Get key file manager
    	pub fn key_manager(&self) -> &T {
    		&self.key_manager
    	}
    }

    impl<T> KeyDirectory for DiskDirectory<T> where T: KeyFileManager {
    	fn load(&self) -> Result<Vec<SafeAccount>, Error> {
    		let accounts = self.files()?
    			.into_iter()
    			.map(|(_, account)| account)
    			.collect();
    		Ok(accounts)
    	}

    	fn update(&self, account: SafeAccount) -> Result<SafeAccount, Error> {
    		// Disk store handles updates correctly iff filename is the same
    		self.insert(account)
    	}

    	fn insert(&self, account: SafeAccount) -> Result<SafeAccount, Error> {
    		// build file path
    		let filename = account.filename.as_ref().cloned().unwrap_or_else(|| {
    			let timestamp = time::strftime("%Y-%m-%dT%H-%M-%S", &time::now_utc()).expect("Time-format string is valid.");
    			format!("UTC--{}Z--{}", timestamp, Uuid::from(account.id))
    		});

    		self.insert_with_filename(account, filename)
    	}

    	fn remove(&self, account: &SafeAccount) -> Result<(), Error> {
    		// enumerate all entries in keystore
    		// and find entry with given address
    		let to_remove = self.files()?
    			.into_iter()
    			.find(|&(_, ref acc)| acc == account);

    		// remove it
    		match to_remove {
    			None => Err(Error::InvalidAccount),
    			Some((path, _)) => fs::remove_file(path).map_err(From::from)
    		}
    	}

    	fn path(&self) -> Option<&PathBuf> { Some(&self.path) }

    	fn as_vault_provider(&self) -> Option<&VaultKeyDirectoryProvider> {
    		Some(self)
    	}
    }

    impl<T> VaultKeyDirectoryProvider for DiskDirectory<T> where T: KeyFileManager {
    	fn create(&self, name: &str, key: VaultKey) -> Result<Box<VaultKeyDirectory>, Error> {
    		let vault_dir = VaultDiskDirectory::create(&self.path, name, key)?;
    		Ok(Box::new(vault_dir))
    	}

    	fn open(&self, name: &str, key: VaultKey) -> Result<Box<VaultKeyDirectory>, Error> {
    		let vault_dir = VaultDiskDirectory::at(&self.path, name, key)?;
    		Ok(Box::new(vault_dir))
    	}
    }

    impl KeyFileManager for DiskKeyFileManager {
    	fn read<T>(&self, filename: Option<String>, reader: T) -> Result<SafeAccount, Error> where T: io::Read {
    		let key_file = json::KeyFile::load(reader).map_err(|e| Error::Custom(format!("{:?}", e)))?;
    		Ok(SafeAccount::from_file(key_file, filename))
    	}

    	fn write<T>(&self, account: SafeAccount, writer: &mut T) -> Result<(), Error> where T: io::Write {
    		let key_file: json::KeyFile = account.into();
    		key_file.write(writer).map_err(|e| Error::Custom(format!("{:?}", e)))
    	}
    }

    #[cfg(test)]
    mod test {
    	use std::{env, fs};
    	use super::RootDiskDirectory;
    	use dir::{KeyDirectory, VaultKey};
    	use account::SafeAccount;
    	use ethkey::{Random, Generator};

    	#[test]
    	fn should_create_new_account() {
    		// given
    		let mut dir = env::temp_dir();
    		dir.push("ethstore_should_create_new_account");
    		let keypair = Random.generate().unwrap();
    		let password = "hello world";
    		let directory = RootDiskDirectory::create(dir.clone()).unwrap();

    		// when
    		let account = SafeAccount::create(&keypair, [0u8; 16], password, 1024, "Test".to_owned(), "{}".to_owned());
    		let res = directory.insert(account);

    		// then
    		assert!(res.is_ok(), "Should save account succesfuly.");
    		assert!(res.unwrap().filename.is_some(), "Filename has been assigned.");

    		// cleanup
    		let _ = fs::remove_dir_all(dir);
    	}

    	#[test]
    	fn should_manage_vaults() {
    		// given
    		let mut dir = env::temp_dir();
    		dir.push("should_create_new_vault");
    		let directory = RootDiskDirectory::create(dir.clone()).unwrap();
    		let vault_name = "vault";
    		let password = "password";

    		// then
    		assert!(directory.as_vault_provider().is_some());

    		// and when
    		let before_root_items_count = fs::read_dir(&dir).unwrap().count();
    		let vault = directory.as_vault_provider().unwrap().create(vault_name, VaultKey::new(password, 1024));

    		// then
    		assert!(vault.is_ok());
    		let after_root_items_count = fs::read_dir(&dir).unwrap().count();
    		assert!(after_root_items_count > before_root_items_count);

    		// and when
    		let vault = directory.as_vault_provider().unwrap().open(vault_name, VaultKey::new(password, 1024));

    		// then
    		assert!(vault.is_ok());
    		let after_root_items_count2 = fs::read_dir(&dir).unwrap().count();
    		assert!(after_root_items_count == after_root_items_count2);

    		// cleanup
    		let _ = fs::remove_dir_all(dir);
    	}
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)