Lines
87.5 %
Functions
61.29 %
Branches
100 %
//! ArtiEphemeralKeystore implementation (in-memory ephemeral key storage)
pub(crate) mod err;
use std::collections::HashMap;
use std::result::Result as StdResult;
use std::sync::{Arc, Mutex};
use tor_error::internal;
use tor_key_forge::{EncodableItem, ErasedKey, KeystoreItem, KeystoreItemType};
use crate::keystore::ephemeral::err::ArtiEphemeralKeystoreError;
use crate::raw::RawEntryId;
use crate::{ArtiPath, Error, KeySpecifier, Keystore, KeystoreEntry, KeystoreId, Result};
use super::KeystoreEntryResult;
/// The identifier of a key stored in the `ArtiEphemeralKeystore`.
type KeyIdent = (ArtiPath, KeystoreItemType);
/// The Ephemeral Arti key store
///
/// This is a purely in-memory key store. Keys written to this store
/// are never written to disk, and are stored in-memory as [`KeystoreItem`]s.
/// Keys saved in this Keystore do not persist between restarts!
/// While Arti never writes the keys for this key store to disk, the operating
/// system may do so for reasons outside of this library's control. Some
/// examples are swapping RAM to disk, generating core dumps, invoking
/// suspend-to-disk power management, etc. This key store does not attempt to
/// prevent this operating system behaviour.
pub struct ArtiEphemeralKeystore {
/// Identifier hard-coded to 'ephemeral'
id: KeystoreId,
/// Keys stored as [`KeystoreItem`].
key_dictionary: Arc<Mutex<HashMap<KeyIdent, KeystoreItem>>>,
}
impl ArtiEphemeralKeystore {
/// Create a new [`ArtiEphemeralKeystore`]
pub fn new(id: String) -> Self {
Self {
id: KeystoreId(id),
key_dictionary: Default::default(),
impl Keystore for ArtiEphemeralKeystore {
fn id(&self) -> &KeystoreId {
&self.id
fn contains(
&self,
key_spec: &dyn KeySpecifier,
item_type: &KeystoreItemType,
) -> StdResult<bool, Error> {
let arti_path = key_spec
.arti_path()
.map_err(ArtiEphemeralKeystoreError::ArtiPathUnavailableError)?;
let key_dictionary = self.key_dictionary.lock().expect("lock poisoned");
let contains_key = key_dictionary.contains_key(&(arti_path, item_type.clone()));
Ok(contains_key)
fn get(
) -> StdResult<Option<ErasedKey>, Error> {
match key_dictionary.get(&(arti_path.clone(), item_type.clone())) {
Some(key) if key.item_type()? != *item_type => {
// This should only happen if some external factor alters the
// process memory or if there's a bug in our implementation of
// Keystore::insert().
Err(internal!(
"the specified KeystoreItemType does not match key type of the fetched key?!"
)
.into())
Some(key) => {
let key: KeystoreItem = key.clone();
let key: ErasedKey = key.into_erased()?;
Ok(Some(key))
None => Ok(None),
#[cfg(feature = "onion-service-cli-extra")]
fn raw_entry_id(&self, _raw_id: &str) -> Result<RawEntryId> {
Err(ArtiEphemeralKeystoreError::NotSupported {
action: "raw_entry_id",
fn insert(&self, key: &dyn EncodableItem, key_spec: &dyn KeySpecifier) -> StdResult<(), Error> {
let key_data = key.as_keystore_item()?;
let item_type = key_data.item_type()?;
// save to dictionary
let mut key_dictionary = self.key_dictionary.lock().expect("lock poisoned");
let _ = key_dictionary.insert((arti_path, item_type), key_data);
Ok(())
fn remove(
) -> StdResult<Option<()>, Error> {
match key_dictionary.remove(&(arti_path, item_type.clone())) {
"the specified KeystoreItemType does not match key type of the removed key?!"
Some(_) => Ok(Some(())),
fn remove_unchecked(&self, _entry_id: &RawEntryId) -> Result<()> {
// TODO: further discussion is needed for this implementation
action: "remove_uncheked",
fn list(&self) -> Result<Vec<KeystoreEntryResult<KeystoreEntry>>> {
Ok(key_dictionary
.keys()
.map(|(arti_path, item_type)| {
let raw_id = RawEntryId::Ephemeral((arti_path.clone(), item_type.clone()));
Ok(KeystoreEntry::new(
arti_path.clone().into(),
item_type.clone(),
self.id(),
raw_id,
))
})
.collect())
#[cfg(test)]
mod tests {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_duration_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use tor_basic_utils::test_rng::{testing_rng, TestingRng};
use tor_error::{ErrorKind, HasKind};
use tor_key_forge::{KeyType, Keygen};
use tor_llcrypto::pk::{curve25519, ed25519};
use tor_llcrypto::rng::FakeEntropicRng;
use super::*;
use crate::test_utils::TestSpecifier;
// some helper methods
fn key() -> Box<dyn EncodableItem> {
let mut rng = testing_rng();
let keypair = ed25519::Keypair::generate(&mut rng);
Box::new(keypair)
fn key_type() -> KeystoreItemType {
KeyType::Ed25519Keypair.into()
fn key_bad() -> Box<dyn EncodableItem> {
let mut rng = FakeEntropicRng::<TestingRng>(testing_rng());
let keypair = curve25519::StaticKeypair::generate(&mut rng).unwrap();
fn key_type_bad() -> KeystoreItemType {
KeyType::X25519StaticKeypair.into()
fn key_spec() -> Box<dyn KeySpecifier> {
Box::<TestSpecifier>::default()
// tests!
#[test]
fn id() {
let key_store = ArtiEphemeralKeystore::new("test-ephemeral".to_string());
assert_eq!(&KeystoreId("test-ephemeral".to_string()), key_store.id());
fn contains() {
// verify no key in store
assert!(!key_store
.contains(key_spec().as_ref(), &key_type())
.unwrap());
// insert key and verify in store
assert!(key_store
.insert(key().as_ref(), key_spec().as_ref())
.is_ok());
fn get() {
// verify no result to get
.get(key_spec().as_ref(), &key_type())
.unwrap()
.is_none());
// insert and verify get is a result
let key = key_store
.unwrap();
// Ensure the returned key is of the right type
assert!(key.downcast::<ed25519::Keypair>().is_ok());
// verify receiving a key of a different type results in the appropriate error
key_store.remove(key_spec().as_ref(), &key_type()).unwrap();
{
let mut key_dictionary = key_store.key_dictionary.lock().unwrap();
let _ = key_dictionary.insert(
(key_spec().arti_path().unwrap(), key_type()),
key_bad().as_keystore_item().unwrap(),
);
assert!(matches!(
key_store
.err()
.kind(),
ErrorKind::Internal
));
fn insert() {
.contains(key_spec().as_ref(), &key_type_bad())
.get(key_spec().as_ref(), &key_type_bad())
assert!(key_store.list().unwrap().is_empty());
// verify inserting a key succeeds
// further ensure correct side effects
.is_some());
assert_eq!(key_store.list().unwrap().len(), 1);
fn remove() {
// verify removing from an empty store returns None
.remove(key_spec().as_ref(), &key_type())
// verify inserting and removing results in Some(())
// verify mismatched key type on removal results in the appropriate error
fn list() {
// verify empty by default
// verify size 1 after inserting a key