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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
#![doc = include_str!("../README.md")]
// @@ begin lint list maintained by maint/add_warning @@
#![cfg_attr(not(ci_arti_stable), allow(renamed_and_removed_lints))]
#![cfg_attr(not(ci_arti_nightly), allow(unknown_lints))]
#![warn(missing_docs)]
#![warn(noop_method_call)]
#![warn(unreachable_pub)]
#![warn(clippy::all)]
#![deny(clippy::await_holding_lock)]
#![deny(clippy::cargo_common_metadata)]
#![deny(clippy::cast_lossless)]
#![deny(clippy::checked_conversions)]
#![warn(clippy::cognitive_complexity)]
#![deny(clippy::debug_assert_with_mut_call)]
#![deny(clippy::exhaustive_enums)]
#![deny(clippy::exhaustive_structs)]
#![deny(clippy::expl_impl_clone_on_copy)]
#![deny(clippy::fallible_impl_from)]
#![deny(clippy::implicit_clone)]
#![deny(clippy::large_stack_arrays)]
#![warn(clippy::manual_ok_or)]
#![deny(clippy::missing_docs_in_private_items)]
#![warn(clippy::needless_borrow)]
#![warn(clippy::needless_pass_by_value)]
#![warn(clippy::option_option)]
#![deny(clippy::print_stderr)]
#![deny(clippy::print_stdout)]
#![warn(clippy::rc_buffer)]
#![deny(clippy::ref_option_ref)]
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::trait_duplication_in_bounds)]
#![deny(clippy::unchecked_duration_subtraction)]
#![deny(clippy::unnecessary_wraps)]
#![warn(clippy::unseparated_literal_suffix)]
#![deny(clippy::unwrap_used)]
#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
#![allow(clippy::uninlined_format_args)]
#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
#![allow(clippy::result_large_err)] // temporary workaround for arti#587
#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
#[macro_use] // SerdeStringOrTransparent
mod time_store;
mod internal_prelude;
mod anon_level;
pub mod config;
mod err;
mod helpers;
mod ipt_establish;
mod ipt_lid;
mod ipt_mgr;
mod ipt_set;
mod keys;
mod netdir;
mod nickname;
mod publish;
mod rend_handshake;
mod replay;
mod req;
pub mod status;
mod timeout_track;
// rustdoc doctests can't use crate-public APIs, so are broken if provided for private items.
// So we export the whole module again under this name.
// Supports the Example in timeout_track.rs's module-level docs.
//
// Any out-of-crate user needs to write this ludicrous name in their code,
// so we don't need to put any warnings in the docs for the individual items.)
//
// (`#[doc(hidden)] pub mod timeout_track;` would work for the test but it would
// completely suppress the actual documentation, which is not what we want.)
#[doc(hidden)]
pub mod timeout_track_for_doctests_unstable_no_semver_guarantees {
pub use crate::timeout_track::*;
}
#[doc(hidden)]
pub mod time_store_for_doctests_unstable_no_semver_guarantees {
pub use crate::time_store::*;
}
use internal_prelude::*;
// ---------- public exports ----------
pub use crate::netdir::NetdirProviderShutdown;
pub use anon_level::Anonymity;
pub use config::OnionServiceConfig;
pub use err::{ClientError, EstablishSessionError, FatalError, IntroRequestError, StartupError};
pub use ipt_mgr::IptError;
pub use keys::{
BlindIdKeypairSpecifier, BlindIdPublicKeySpecifier, DescSigningKeypairSpecifier,
HsIdKeypairSpecifier, HsIdPublicKeySpecifier,
};
pub use nickname::{HsNickname, InvalidNickname};
pub use publish::UploadError as DescUploadError;
pub use req::{RendRequest, StreamRequest};
pub use helpers::handle_rend_requests;
//---------- top-level service implementation (types and methods) ----------
/// Convenience alias for link specifiers of an intro point
pub(crate) type LinkSpecs = Vec<tor_linkspec::EncodedLinkSpec>;
/// Convenient type alias for an ntor public key
// TODO (#1022) maybe this should be
// `tor_proto::crypto::handshake::ntor::NtorPublicKey`,
// or a unified OnionKey type.
pub(crate) type NtorPublicKey = curve25519::PublicKey;
/// A handle to a running instance of an onion service.
//
// TODO (#1228): Write more.
// TODO (#1247): Choose a better name for this struct
//
// (APIs should return Arc<OnionService>)
#[must_use = "a hidden service object will terminate the service when dropped"]
pub struct RunningOnionService {
/// The mutable implementation details of this onion service.
inner: Mutex<SvcInner>,
/// The current state.
state: OnionServiceState,
}
/// Implementation details for an onion service.
struct SvcInner {
/// Configuration information about this service.
config_tx: postage::watch::Sender<Arc<OnionServiceConfig>>,
/// A oneshot that will be dropped when this object is dropped.
_shutdown_tx: postage::broadcast::Sender<void::Void>,
/// Postage sender, used to tell subscribers about changes in the status of
/// this onion service.
status_tx: StatusSender,
/// Handles that we'll take ownership of when launching the service.
unlaunched: Option<(
mpsc::Receiver<RendRequest>,
Box<dyn Launchable + Send + Sync>,
)>,
}
/// Objects and handles needed to launch an onion service.
struct ForLaunch<R: Runtime> {
/// An unlaunched handle for the HsDesc publisher.
///
/// This publisher is responsible for determining when we need to upload a
/// new set of HsDescs, building them, and publishing them at the correct
/// HsDirs.
publisher: Publisher<R, publish::Real<R>>,
/// Our handler for the introduction point manager.
///
/// This manager is responsible for selecting introduction points,
/// maintaining our connections to them, and telling the publisher which ones
/// are publicly available.
ipt_mgr: IptManager<R, crate::ipt_mgr::Real<R>>,
/// A handle used by the ipt manager to send Ipts to the publisher.
///
///
ipt_mgr_view: IptsManagerView,
}
/// Private trait used to type-erase `ForLaunch<R>`, so that we don't need to
/// parameterize OnionService on `<R>`.
trait Launchable: Send + Sync {
/// Launch
fn launch(self: Box<Self>) -> Result<(), StartupError>;
}
impl<R: Runtime> Launchable for ForLaunch<R> {
fn launch(self: Box<Self>) -> Result<(), StartupError> {
self.ipt_mgr.launch_background_tasks(self.ipt_mgr_view)?;
self.publisher.launch()?;
Ok(())
}
}
/// Return value from one call to the main loop iteration
///
/// Used by the publisher reactor and by the [`IptManager`].
#[derive(PartialEq)]
#[must_use]
pub(crate) enum ShutdownStatus {
/// We should continue to operate this component
Continue,
/// We should shut down: the service, or maybe the whole process, is shutting down
Terminate,
}
impl From<oneshot::Canceled> for ShutdownStatus {
fn from(_: oneshot::Canceled) -> ShutdownStatus {
ShutdownStatus::Terminate
}
}
/// A handle to an instance of an onion service, which may or may not be running.
///
/// To construct an `OnionService`, call [`OnionService::new`].
/// It will not start handling requests until you call its
/// [``.launch()``](OnionService::launch) method.
//
// TODO (#1228): Write more.
// TODO (#1247): Choose a better name for this struct
//
pub struct OnionService {
/// The current configuration.
config: OnionServiceConfig,
/// The current state.
state: OnionServiceState,
}
/// The state of an instance of an onion service.
///
/// This type is shared between [`OnionService`] and [`RunningOnionService`],
/// and is used to
//
// TODO (#1228): Write more.
// TODO (#1247): Choose a better name for this struct
pub(crate) struct OnionServiceState {
/// The nickname of this service.
nickname: HsNickname,
/// The key manager, used for accessing the underlying key stores.
keymgr: Arc<KeyMgr>,
/// The location on disk where the persistent data is stored.
state_dir: StateDirectory,
}
impl OnionServiceState {
/// Return the onion address of this service.
///
/// Clients must know the service's onion address in order to discover or
/// connect to it.
///
/// Returns `None` if the HsId of the service could not be found in any of the configured
/// keystores.
//
// TODO: instead of duplicating RunningOnionService::onion_name, maybe we should make this a
// method on an ArtiHss type, and make both OnionService and RunningOnionService deref to
// ArtiHss.
fn onion_name(&self) -> Option<HsId> {
let hsid_spec = HsIdKeypairSpecifier::new(self.nickname.clone());
// TODO (#1194): This will need to be revisited when we implement offline hsid mode,
// (the HsId keypair won't be in the keystore)
self.keymgr
.get::<HsIdKeypair>(&hsid_spec)
.ok()?
.map(|hsid| HsIdKey::from(&hsid).id())
}
}
impl OnionService {
/// Create (but do not launch) a new onion service.
///
/// The onion service's behavior and local nickname will be determined by
/// the provided configuration.
///
/// The onion service's keys will be kept in `keymgr`.
/// Its non-key state information will be stored persistently in a location
/// and manner controlled by `state_dir`.
///
// TODO (#1228): document.
//
// TODO (#1228): Document how we handle the case where somebody tries to launch two
// onion services with the same nickname? They will conflict by trying to
// use the same state and the same keys. Do we stop it here, or in
// arti_client?
pub fn new(
config: OnionServiceConfig,
keymgr: Arc<KeyMgr>,
state_dir: &StateDirectory,
) -> Result<Self, StartupError> {
let nickname = config.nickname.clone();
// TODO (#1194): add a config option for specifying whether to expect the KS_hsid to be stored
// offline
//let offline_hsid = config.offline_hsid;
let offline_hsid = false;
maybe_generate_hsid(&keymgr, &nickname, offline_hsid)?;
Ok(OnionService {
config,
state: OnionServiceState {
nickname,
keymgr,
state_dir: state_dir.clone(),
},
})
}
/// Tell this onion service to begin running, and return a
/// [`RunningOnionService`] and its stream of rendezvous requests.
///
/// You can turn the resulting stream into a stream of [`StreamRequest`]
/// using the [`handle_rend_requests`] helper function.
///
/// Once the `RunningOnionService` is dropped, the onion service will stop
/// publishing, and stop accepting new introduction requests. Existing
/// streams and rendezvous circuits will remain open.
pub fn launch<R>(
self,
runtime: R,
netdir_provider: Arc<dyn NetDirProvider>,
circ_pool: Arc<HsCircPool<R>>,
) -> Result<(Arc<RunningOnionService>, impl Stream<Item = RendRequest>), StartupError>
where
R: Runtime,
{
let OnionService { config, state } = self;
let nickname = state.nickname.clone();
let state_handle = state
.state_dir
.acquire_instance(&nickname)
.map_err(StartupError::StateDirectoryInaccessible)?;
// We pass the "cooked" handle, with the storage key embedded, to ipt_set,
// since the ipt_set code doesn't otherwise have access to the HS nickname.
let iptpub_storage_handle = state_handle
.storage_handle("iptpub")
.map_err(StartupError::StateDirectoryInaccessible)?;
let (rend_req_tx, rend_req_rx) = mpsc::channel(32);
let (shutdown_tx, shutdown_rx) = broadcast::channel(0);
let (config_tx, config_rx) = postage::watch::channel_with(Arc::new(config));
let (ipt_mgr_view, publisher_view) =
crate::ipt_set::ipts_channel(&runtime, iptpub_storage_handle)?;
let status_tx = StatusSender::new(OnionServiceStatus::new_shutdown());
let ipt_mgr = IptManager::new(
runtime.clone(),
netdir_provider.clone(),
nickname.clone(),
config_rx.clone(),
rend_req_tx,
shutdown_rx.clone(),
&state_handle,
crate::ipt_mgr::Real {
circ_pool: circ_pool.clone(),
},
state.keymgr.clone(),
status_tx.clone().into(),
)?;
let publisher: Publisher<R, publish::Real<R>> = Publisher::new(
runtime,
nickname.clone(),
netdir_provider,
circ_pool,
publisher_view,
config_rx,
status_tx.clone().into(),
Arc::clone(&state.keymgr),
);
let svc = Arc::new(RunningOnionService {
state,
inner: Mutex::new(SvcInner {
config_tx,
_shutdown_tx: shutdown_tx,
status_tx,
unlaunched: Some((
rend_req_rx,
Box::new(ForLaunch {
publisher,
ipt_mgr,
ipt_mgr_view,
}),
)),
}),
});
let stream = svc.launch()?;
Ok((svc, stream))
}
/// Return the onion address of this service.
///
/// Clients must know the service's onion address in order to discover or
/// connect to it.
///
/// Returns `None` if the HsId of the service could not be found in any of the configured
/// keystores.
pub fn onion_name(&self) -> Option<HsId> {
self.state.onion_name()
}
}
impl RunningOnionService {
/// Change the configuration of this onion service.
///
/// (Not everything can be changed here. At the very least we'll need to say
/// that the identity of a service is fixed. We might want to make the
/// storage backing this, and the anonymity status, unchangeable.)
pub fn reconfigure(
&self,
new_config: OnionServiceConfig,
how: Reconfigure,
) -> Result<(), ReconfigureError> {
let mut inner = self.inner.lock().expect("lock poisoned");
inner.config_tx.try_maybe_send(|cur_config| {
let new_config = cur_config.for_transition_to(new_config, how)?;
Ok(match how {
// We're only checking, so return the current configuration.
tor_config::Reconfigure::CheckAllOrNothing => Arc::clone(cur_config),
// We're replacing the configuration, and we didn't get an error.
_ => Arc::new(new_config),
})
})
// TODO (#1153, #1209): We need to make sure that the various tasks listening on
// config_rx actually enforce the configuration, not only on new
// connections, but existing ones.
}
/*
/// Tell this onion service about some new short-term keys it can use.
pub fn add_keys(&self, keys: ()) -> Result<(), Bug> {
todo!() // TODO #1194
}
*/
/// Return the current status of this onion service.
pub fn status(&self) -> OnionServiceStatus {
self.inner.lock().expect("poisoned lock").status_tx.get()
}
/// Return a stream of events that will receive notifications of changes in
/// this onion service's status.
pub fn status_events(&self) -> OnionServiceStatusStream {
self.inner
.lock()
.expect("poisoned lock")
.status_tx
.subscribe()
}
/// Tell this onion service to begin running, and return a
/// stream of rendezvous requests on the service.
///
/// You can turn the resulting stream into a stream of [`StreamRequest`]
/// using the [`handle_rend_requests`] helper function.
fn launch(self: &Arc<Self>) -> Result<impl Stream<Item = RendRequest>, StartupError> {
let (rend_req_rx, launch) = {
let mut inner = self.inner.lock().expect("poisoned lock");
inner
.unlaunched
.take()
.ok_or(StartupError::AlreadyLaunched)?
};
match launch.launch() {
Ok(()) => {}
Err(e) => {
return Err(e);
}
}
// This needs to launch at least the following tasks:
//
// TODO (#1194) If we decide to use separate disk-based key
// provisioning, we need a task to monitor our keys directory.
Ok(rend_req_rx)
}
/*
/// Tell this onion service to stop running.
///
/// It can be restarted with launch().
///
/// You can also shut down an onion service completely by dropping the last
/// Clone of it.
pub fn pause(&self) {
todo!() // TODO (#1231)
}
*/
/// Return the onion address of this service.
///
/// Clients must know the service's onion address in order to discover or
/// connect to it.
///
/// Returns `None` if the HsId of the service could not be found in any of the configured
/// keystores.
pub fn onion_name(&self) -> Option<HsId> {
self.state.onion_name()
}
}
/// Generate the identity key of the service, unless it already exists or `offline_hsid` is `true`.
//
// TODO (#1194): we don't support offline_hsid yet.
fn maybe_generate_hsid(
keymgr: &Arc<KeyMgr>,
nickname: &HsNickname,
offline_hsid: bool,
) -> Result<(), StartupError> {
if offline_hsid {
unimplemented!("offline hsid mode");
}
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let kp = keymgr
.get::<HsIdKeypair>(&hsid_spec)
.map_err(|cause| StartupError::Keystore {
action: "read",
cause,
})?;
// TODO (#1106): make this configurable
let selector = KeystoreSelector::Default;
let mut rng = rand::thread_rng();
let (keypair, generated) = match kp {
Some(kp) => (kp, false),
None => {
// Note: there is a race here. If the HsId is generated through some other means
// (e.g. via the CLI) at some point between the time we looked up the keypair and
// now, we will return an error.
let kp = keymgr
.generate::<HsIdKeypair>(&hsid_spec, selector, &mut rng, false /* overwrite */)
.map_err(|cause| StartupError::Keystore {
action: "generate",
cause,
})?;
(kp, true)
}
};
let hsid: HsId = HsIdKey::from(&keypair).id();
if generated {
info!(
"Generated a new identity for service {nickname}: {}",
sensitive(hsid)
);
} else {
// TODO: We may want to downgrade this to trace once we have a CLI
// for extracting it.
info!(
"Using existing identity for service {nickname}: {}",
sensitive(hsid)
);
}
Ok(())
}
#[cfg(test)]
pub(crate) mod test {
// @@ 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 super::*;
use std::fmt::Display;
use std::path::Path;
use fs_mistrust::Mistrust;
use test_temp_dir::{test_temp_dir, TestTempDir, TestTempDirGuard};
use tor_basic_utils::test_rng::testing_rng;
use tor_keymgr::{ArtiNativeKeystore, KeyMgrBuilder};
use tor_llcrypto::pk::ed25519;
use tor_persist::state_dir::InstanceStateHandle;
use crate::config::OnionServiceConfigBuilder;
use crate::ipt_set::IptSetStorageHandle;
use crate::{HsIdKeypairSpecifier, HsIdPublicKeySpecifier};
/// The nickname of the test service.
const TEST_SVC_NICKNAME: &str = "test-svc";
/// Make a fresh `KeyMgr` (containing no keys) using files in `temp_dir`
pub(crate) fn create_keymgr(temp_dir: &TestTempDir) -> TestTempDirGuard<Arc<KeyMgr>> {
temp_dir.subdir_used_by("keystore", |keystore_dir| {
let keystore = ArtiNativeKeystore::from_path_and_mistrust(
keystore_dir,
&Mistrust::new_dangerously_trust_everyone(),
)
.unwrap();
Arc::new(
KeyMgrBuilder::default()
.default_store(Box::new(keystore))
.build()
.unwrap(),
)
})
}
#[allow(clippy::let_and_return)] // clearer and more regular
pub(crate) fn mk_state_instance(dir: &Path, nick: impl Display) -> InstanceStateHandle {
let nick = HsNickname::new(nick.to_string()).unwrap();
let mistrust = fs_mistrust::Mistrust::new_dangerously_trust_everyone();
let state_dir = StateDirectory::new(dir, &mistrust).unwrap();
let instance = state_dir.acquire_instance(&nick).unwrap();
instance
}
pub(crate) fn create_storage_handles(
dir: &Path,
) -> (
tor_persist::state_dir::InstanceStateHandle,
IptSetStorageHandle,
) {
let nick = HsNickname::try_from("allium".to_owned()).unwrap();
create_storage_handles_from_state_dir(dir, &nick)
}
pub(crate) fn create_storage_handles_from_state_dir(
state_dir: &Path,
nick: &HsNickname,
) -> (
tor_persist::state_dir::InstanceStateHandle,
IptSetStorageHandle,
) {
let instance = mk_state_instance(state_dir, nick);
let iptpub_state_handle = instance.storage_handle("iptpub").unwrap();
(instance, iptpub_state_handle)
}
macro_rules! maybe_generate_hsid {
($keymgr:expr, $offline_hsid:expr) => {{
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let pub_hsid_spec = HsIdPublicKeySpecifier::new(nickname.clone());
assert!($keymgr.get::<HsIdKey>(&pub_hsid_spec).unwrap().is_none());
assert!($keymgr.get::<HsIdKeypair>(&hsid_spec).unwrap().is_none());
maybe_generate_hsid(&$keymgr, &nickname, $offline_hsid).unwrap();
}};
}
/// Create a test hsid keypair.
fn create_hsid() -> (HsIdKeypair, HsIdKey) {
let mut rng = testing_rng();
let keypair = ed25519::Keypair::generate(&mut rng);
let id_pub = HsIdKey::from(keypair.verifying_key());
let id_keypair = HsIdKeypair::from(ed25519::ExpandedKeypair::from(&keypair));
(id_keypair, id_pub)
}
#[test]
fn generate_hsid() {
let temp_dir = test_temp_dir!();
let keymgr = create_keymgr(&temp_dir);
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
assert!(keymgr.get::<HsIdKeypair>(&hsid_spec).unwrap().is_none());
maybe_generate_hsid!(keymgr, false /* offline_hsid */);
assert!(keymgr.get::<HsIdKeypair>(&hsid_spec).unwrap().is_some());
}
#[test]
fn hsid_keypair_already_exists() {
let temp_dir = test_temp_dir!();
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let keymgr = create_keymgr(&temp_dir);
// Insert the preexisting hsid keypair.
let (existing_hsid_keypair, existing_hsid_public) = create_hsid();
let existing_keypair: ed25519::ExpandedKeypair = existing_hsid_keypair.into();
let existing_hsid_keypair = HsIdKeypair::from(existing_keypair);
keymgr
.insert(existing_hsid_keypair, &hsid_spec, KeystoreSelector::Default)
.unwrap();
maybe_generate_hsid(&keymgr, &nickname, false /* offline_hsid */).unwrap();
let keypair = keymgr.get::<HsIdKeypair>(&hsid_spec).unwrap().unwrap();
let pk: HsIdKey = (&keypair).into();
assert_eq!(pk.as_ref(), existing_hsid_public.as_ref());
}
#[test]
#[ignore] // TODO (#1194): Revisit when we add support for offline hsid mode
fn generate_hsid_offline_hsid() {
let temp_dir = test_temp_dir!();
let keymgr = create_keymgr(&temp_dir);
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let pub_hsid_spec = HsIdPublicKeySpecifier::new(nickname.clone());
maybe_generate_hsid!(keymgr, true /* offline_hsid */);
assert!(keymgr.get::<HsIdKey>(&pub_hsid_spec).unwrap().is_none());
assert!(keymgr.get::<HsIdKeypair>(&hsid_spec).unwrap().is_none());
}
#[test]
#[ignore] // TODO (#1194): Revisit when we add support for offline hsid mode
fn generate_hsid_corrupt_keystore() {
let temp_dir = test_temp_dir!();
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let pub_hsid_spec = HsIdPublicKeySpecifier::new(nickname.clone());
let keymgr = create_keymgr(&temp_dir);
let (hsid_keypair, _hsid_public) = create_hsid();
let (_hsid_keypair, hsid_public) = create_hsid();
keymgr
.insert(hsid_keypair, &hsid_spec, KeystoreSelector::Default)
.unwrap();
// Insert a mismatched public key
keymgr
.insert(hsid_public, &pub_hsid_spec, KeystoreSelector::Default)
.unwrap();
assert!(maybe_generate_hsid(&keymgr, &nickname, false /* offline_hsid */).is_err());
}
#[test]
fn onion_name() {
let temp_dir = test_temp_dir!();
let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
let hsid_spec = HsIdKeypairSpecifier::new(nickname.clone());
let keymgr = create_keymgr(&temp_dir);
let (hsid_keypair, hsid_public) = create_hsid();
// Insert the hsid into the keystore
keymgr
.insert(hsid_keypair, &hsid_spec, KeystoreSelector::Default)
.unwrap();
let config = OnionServiceConfigBuilder::default()
.nickname(nickname)
.build()
.unwrap();
let state_dir = StateDirectory::new(
temp_dir.as_path_untracked(),
&fs_mistrust::Mistrust::new_dangerously_trust_everyone(),
)
.unwrap();
let service = OnionService::new(config, Arc::clone(&*keymgr), &state_dir).unwrap();
let hsid = HsId::from(hsid_public);
assert_eq!(service.onion_name().unwrap(), hsid);
drop(temp_dir); // prove that this is still live
}
}