1mod backoff;
6mod descriptor;
7mod reactor;
8mod reupload_timer;
9
10use crate::config::restricted_discovery::RestrictedDiscoveryKeys;
11use crate::internal_prelude::*;
12use crate::pow::PowManager;
13
14use backoff::{BackoffError, BackoffSchedule, RetriableError, Runner};
15use descriptor::{DescriptorStatus, VersionedDescriptor, build_sign};
16use reactor::Reactor;
17use reactor::read_blind_id_keypair;
18use reupload_timer::ReuploadTimer;
19
20use tor_config_path::CfgPathResolver;
21
22pub use reactor::UploadError;
23pub(crate) use reactor::{Mockable, OVERALL_UPLOAD_TIMEOUT, Real};
24
25#[must_use = "If you don't call launch() on the publisher, it won't publish any descriptors."]
31pub(crate) struct Publisher<R: Runtime, M: Mockable> {
32 runtime: R,
34 nickname: HsNickname,
36 dir_provider: Arc<dyn NetDirProvider>,
39 mockable: M,
43 config: Arc<OnionServiceConfig>,
45 ipt_watcher: IptsPublisherView,
47 config_rx: watch::Receiver<Arc<OnionServiceConfig>>,
49 keymgr: Arc<KeyMgr>,
51 status_tx: PublisherStatusSender,
53 path_resolver: Arc<CfgPathResolver>,
55 pow_manager: Arc<PowManager<R>>,
57 update_from_pow_manager_rx: mpsc::Receiver<TimePeriod>,
60}
61
62impl<R: Runtime, M: Mockable> Publisher<R, M> {
63 #[allow(clippy::too_many_arguments)]
70 pub(crate) fn new(
71 runtime: R,
72 nickname: HsNickname,
73 dir_provider: Arc<dyn NetDirProvider>,
74 mockable: impl Into<M>,
75 ipt_watcher: IptsPublisherView,
76 config_rx: watch::Receiver<Arc<OnionServiceConfig>>,
77 status_tx: PublisherStatusSender,
78 keymgr: Arc<KeyMgr>,
79 path_resolver: Arc<CfgPathResolver>,
80 pow_manager: Arc<PowManager<R>>,
81 update_from_pow_manager_rx: mpsc::Receiver<TimePeriod>,
82 ) -> Self {
83 let config = config_rx.borrow().clone();
84 Self {
85 runtime,
86 nickname,
87 dir_provider,
88 mockable: mockable.into(),
89 config,
90 ipt_watcher,
91 config_rx,
92 status_tx,
93 keymgr,
94 path_resolver,
95 pow_manager,
96 update_from_pow_manager_rx,
97 }
98 }
99
100 pub(crate) fn launch(self) -> Result<(), StartupError> {
102 let Publisher {
103 runtime,
104 nickname,
105 dir_provider,
106 mockable,
107 config,
108 ipt_watcher,
109 config_rx,
110 status_tx,
111 keymgr,
112 path_resolver,
113 pow_manager,
114 update_from_pow_manager_rx: publisher_update_rx,
115 } = self;
116
117 let reactor = Reactor::new(
118 runtime.clone(),
119 nickname,
120 dir_provider,
121 mockable,
122 &config,
123 ipt_watcher,
124 config_rx,
125 status_tx,
126 keymgr,
127 path_resolver,
128 pow_manager,
129 publisher_update_rx,
130 );
131
132 runtime
133 .spawn(async move {
134 match reactor.run().await {
135 Ok(()) => debug!("the publisher reactor has shut down"),
136 Err(e) => warn_report!(e, "the publisher reactor has shut down"),
137 }
138 })
139 .map_err(|e| StartupError::Spawn {
140 spawning: "publisher reactor task",
141 cause: e.into(),
142 })?;
143
144 Ok(())
145 }
146}
147
148#[cfg(test)]
149mod test {
150 #![allow(clippy::bool_assert_comparison)]
152 #![allow(clippy::clone_on_copy)]
153 #![allow(clippy::dbg_macro)]
154 #![allow(clippy::mixed_attributes_style)]
155 #![allow(clippy::print_stderr)]
156 #![allow(clippy::print_stdout)]
157 #![allow(clippy::single_char_pattern)]
158 #![allow(clippy::unwrap_used)]
159 #![allow(clippy::unchecked_time_subtraction)]
160 #![allow(clippy::useless_vec)]
161 #![allow(clippy::needless_pass_by_value)]
162 use super::*;
164
165 use std::collections::HashMap;
166 use std::io;
167 use std::path::Path;
168 use std::pin::Pin;
169 use std::sync::Mutex;
170 use std::sync::atomic::{AtomicUsize, Ordering};
171 use std::task::{Context, Poll};
172
173 use async_trait::async_trait;
174 use fs_mistrust::Mistrust;
175 use futures::{AsyncRead, AsyncWrite};
176 use tempfile::{TempDir, tempdir};
177 use test_temp_dir::test_temp_dir;
178
179 use tor_basic_utils::test_rng::{TestingRng, testing_rng};
180
181 use tor_hscrypto::pk::{HsBlindId, HsDescSigningKeypair, HsId, HsIdKey, HsIdKeypair};
182 use tor_key_forge::ToEncodableKey;
183 use tor_keymgr::{ArtiNativeKeystore, KeyMgrBuilder, KeySpecifier};
184 use tor_llcrypto::pk::{ed25519, rsa};
185 use tor_netdir::testprovider::TestNetDirProvider;
186 use tor_netdir::{NetDir, testnet};
187 use tor_netdoc::doc::hsdesc::test_data;
188 use tor_rtcompat::ToplevelBlockOn;
189 use tor_rtmock::MockRuntime;
190
191 use crate::HsNickname;
192 use crate::config::OnionServiceConfigBuilder;
193 use crate::ipt_set::{IptInSet, IptSet, ipts_channel};
194 use crate::pow::NewPowManager;
195 use crate::publish::reactor::MockableDirTunnel;
196 use crate::status::{OnionServiceStatus, StatusSender};
197 use crate::test::create_storage_handles;
198 use crate::{
199 BlindIdKeypairSpecifier, BlindIdPublicKeySpecifier, DescSigningKeypairSpecifier,
200 HsIdKeypairSpecifier, HsIdPublicKeySpecifier,
201 };
202
203 const TEST_SVC_NICKNAME: &str = "test-svc";
205
206 const OK_RESPONSE: &str = "HTTP/1.1 200 OK\r\n\r\n";
208
209 const ERR_RESPONSE: &str = "HTTP/1.1 500 UH_OH\r\n\r\n";
211
212 type PollReadResult<T> = Result<T, ()>;
217
218 trait PollReadIter:
220 Iterator<Item = PollReadResult<String>> + Send + Sync + Clone + Unpin + 'static
221 {
222 }
223
224 impl<I> PollReadIter for I where
225 I: Iterator<Item = PollReadResult<String>> + Send + Sync + Clone + Unpin + 'static
226 {
227 }
228
229 #[derive(Clone, Debug, Default)]
230 struct MockReactorState<I: PollReadIter> {
231 publish_count: Arc<AtomicUsize>,
233 poll_read_responses: I,
242 responses_for_hsdir: Arc<Mutex<HashMap<rsa::RsaIdentity, I>>>,
246 }
247
248 #[async_trait]
249 impl<I: PollReadIter> Mockable for MockReactorState<I> {
250 type Rng = TestingRng;
251 type Tunnel = MockClientCirc<I>;
252
253 fn thread_rng(&self) -> Self::Rng {
254 testing_rng()
255 }
256
257 async fn get_or_launch_hs_dir<T>(
258 &self,
259 _netdir: &tor_netdir::NetDir,
260 target: T,
261 ) -> Result<Self::Tunnel, tor_circmgr::Error>
262 where
263 T: tor_linkspec::CircTarget + Send + Sync,
264 {
265 let id = target.rsa_identity().unwrap();
267 let mut map = self.responses_for_hsdir.lock().unwrap();
268 let poll_read_responses = map
269 .entry(*id)
270 .or_insert_with(|| self.poll_read_responses.clone());
271
272 Ok(MockClientCirc {
273 publish_count: Arc::clone(&self.publish_count),
274 poll_read_responses: poll_read_responses.clone(),
275 })
276 }
277
278 fn estimate_upload_timeout(&self) -> Duration {
279 Duration::from_secs(30)
281 }
282 }
283
284 #[derive(Debug, Clone)]
285 struct MockClientCirc<I: PollReadIter> {
286 publish_count: Arc<AtomicUsize>,
288 poll_read_responses: I,
292 }
293
294 #[async_trait]
295 impl<I: PollReadIter> MockableDirTunnel for MockClientCirc<I> {
296 type DataStream = MockDataStream<I>;
297
298 async fn begin_dir_stream(&self) -> Result<Self::DataStream, tor_circmgr::Error> {
299 Ok(MockDataStream {
300 publish_count: Arc::clone(&self.publish_count),
301 poll_read_responses: self.poll_read_responses.clone(),
304 })
305 }
306
307 fn source_info(&self) -> tor_proto::Result<Option<tor_dirclient::SourceInfo>> {
308 Ok(None)
309 }
310 }
311
312 #[derive(Debug)]
313 struct MockDataStream<I: PollReadIter> {
314 publish_count: Arc<AtomicUsize>,
316 poll_read_responses: I,
320 }
321
322 impl<I: PollReadIter> AsyncRead for MockDataStream<I> {
323 fn poll_read(
324 mut self: Pin<&mut Self>,
325 _cx: &mut Context<'_>,
326 buf: &mut [u8],
327 ) -> Poll<io::Result<usize>> {
328 match self.as_mut().poll_read_responses.next() {
329 Some(res) => {
330 match res {
331 Ok(res) => {
332 buf[..res.len()].copy_from_slice(res.as_bytes());
333
334 Poll::Ready(Ok(res.len()))
335 }
336 Err(()) => {
337 Poll::Ready(Err(io::Error::other("test error")))
340 }
341 }
342 }
343 None => Poll::Ready(Ok(0)),
344 }
345 }
346 }
347
348 impl<I: PollReadIter> AsyncWrite for MockDataStream<I> {
349 fn poll_write(
350 self: Pin<&mut Self>,
351 _cx: &mut Context<'_>,
352 buf: &[u8],
353 ) -> Poll<io::Result<usize>> {
354 let request = std::str::from_utf8(buf).unwrap();
355
356 assert!(request.starts_with("POST /tor/hs/3/publish HTTP/1.0\r\n"));
357 let _prev = self.publish_count.fetch_add(1, Ordering::SeqCst);
358
359 Poll::Ready(Ok(request.len()))
360 }
361
362 fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
363 Poll::Ready(Ok(()))
364 }
365
366 fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
367 Poll::Ready(Ok(()))
368 }
369 }
370
371 fn insert_svc_key<K>(key: K, keymgr: &KeyMgr, svc_key_spec: &dyn KeySpecifier)
373 where
374 K: ToEncodableKey,
375 {
376 keymgr
377 .insert(
378 key,
379 svc_key_spec,
380 tor_keymgr::KeystoreSelector::Primary,
381 true,
382 )
383 .unwrap();
384 }
385
386 fn init_keymgr(
388 keystore_dir: &TempDir,
389 nickname: &HsNickname,
390 netdir: &NetDir,
391 ) -> (HsId, HsBlindId, Arc<KeyMgr>) {
392 let period = netdir.hs_time_period();
393
394 let mut rng = testing_rng();
395 let keypair = ed25519::Keypair::generate(&mut rng);
396 let id_pub = HsIdKey::from(keypair.verifying_key());
397 let id_keypair = HsIdKeypair::from(ed25519::ExpandedKeypair::from(&keypair));
398
399 let (hs_blind_id_key, hs_blind_id_kp, _subcredential) =
400 id_keypair.compute_blinded_key(period).unwrap();
401
402 let keystore = ArtiNativeKeystore::from_path_and_mistrust(
403 keystore_dir,
404 &Mistrust::new_dangerously_trust_everyone(),
405 )
406 .unwrap();
407
408 let keymgr = KeyMgrBuilder::default()
410 .primary_store(Box::new(keystore))
411 .build()
412 .unwrap();
413
414 insert_svc_key(
415 id_keypair,
416 &keymgr,
417 &HsIdKeypairSpecifier::new(nickname.clone()),
418 );
419
420 insert_svc_key(
421 id_pub.clone(),
422 &keymgr,
423 &HsIdPublicKeySpecifier::new(nickname.clone()),
424 );
425
426 insert_svc_key(
427 hs_blind_id_kp,
428 &keymgr,
429 &BlindIdKeypairSpecifier::new(nickname.clone(), period),
430 );
431
432 insert_svc_key(
433 hs_blind_id_key.clone(),
434 &keymgr,
435 &BlindIdPublicKeySpecifier::new(nickname.clone(), period),
436 );
437
438 insert_svc_key(
439 HsDescSigningKeypair::from(ed25519::Keypair::generate(&mut rng)),
440 &keymgr,
441 &DescSigningKeypairSpecifier::new(nickname.clone(), period),
442 );
443
444 let hs_id = id_pub.into();
445 (hs_id, hs_blind_id_key.into(), keymgr.into())
446 }
447
448 fn build_test_config(nickname: HsNickname) -> OnionServiceConfig {
449 OnionServiceConfigBuilder::default()
450 .nickname(nickname)
451 .rate_limit_at_intro(None)
452 .build()
453 .unwrap()
454 }
455
456 #[allow(clippy::too_many_arguments)]
457 fn run_test<I: PollReadIter>(
458 runtime: MockRuntime,
459 nickname: HsNickname,
460 keymgr: Arc<KeyMgr>,
461 pv: IptsPublisherView,
462 config_rx: watch::Receiver<Arc<OnionServiceConfig>>,
463 status_tx: StatusSender,
464 netdir: NetDir,
465 reactor_event: impl FnOnce(),
466 poll_read_responses: I,
467 expected_upload_count: usize,
468 republish_count: usize,
469 expect_errors: bool,
470 ) {
471 runtime.clone().block_on(async move {
472 let netdir_provider: Arc<dyn NetDirProvider> =
473 Arc::new(TestNetDirProvider::from(netdir));
474 let publish_count = Default::default();
475 let circpool = MockReactorState {
476 publish_count: Arc::clone(&publish_count),
477 poll_read_responses,
478 responses_for_hsdir: Arc::new(Mutex::new(Default::default())),
479 };
480
481 let temp_dir = test_temp_dir!();
482 let state_dir = temp_dir.subdir_untracked("state_dir");
483 let mistrust = fs_mistrust::Mistrust::new_dangerously_trust_everyone();
484 let state_dir = StateDirectory::new(state_dir, &mistrust).unwrap();
485 let state_handle = state_dir.acquire_instance(&nickname).unwrap();
486 let pow_nonce_dir = state_handle.raw_subdir("pow_nonces").unwrap();
487 let pow_manager_storage_handle = state_handle.storage_handle("pow_manager").unwrap();
488
489 let NewPowManager {
490 pow_manager,
491 rend_req_tx: _,
492 rend_req_rx: _,
493 publisher_update_rx: update_from_pow_manager_rx,
494 } = PowManager::new(
495 runtime.clone(),
496 nickname.clone(),
497 pow_nonce_dir,
498 keymgr.clone(),
499 pow_manager_storage_handle,
500 netdir_provider.clone(),
501 status_tx.clone().into(),
502 config_rx.clone(),
503 )
504 .unwrap();
505 let mut status_rx = status_tx.subscribe();
506 let publisher: Publisher<MockRuntime, MockReactorState<_>> = Publisher::new(
507 runtime.clone(),
508 nickname,
509 netdir_provider,
510 circpool,
511 pv,
512 config_rx,
513 status_tx.into(),
514 keymgr,
515 Arc::new(CfgPathResolver::default()),
516 pow_manager,
517 update_from_pow_manager_rx,
518 );
519
520 publisher.launch().unwrap();
521 runtime.progress_until_stalled().await;
522 let status = status_rx.next().await.unwrap().publisher_status();
523 assert_eq!(State::Shutdown, status.state());
524 assert!(status.current_problem().is_none());
525
526 assert_eq!(publish_count.load(Ordering::SeqCst), 0);
528
529 reactor_event();
530
531 runtime.progress_until_stalled().await;
532
533 runtime.advance_by(Duration::from_secs(1)).await;
537 runtime.progress_until_stalled().await;
538
539 let initial_publish_count = publish_count.load(Ordering::SeqCst);
540 assert_eq!(initial_publish_count, expected_upload_count);
541
542 let status = status_rx.next().await.unwrap().publisher_status();
543 if expect_errors {
544 assert_eq!(State::Bootstrapping, status.state());
546 } else {
547 assert_eq!(State::DegradedUnreachable, status.state());
550 }
551 assert!(status.current_problem().is_none());
552
553 if republish_count > 0 {
554 const MAX_TIMEOUT: Duration = Duration::from_secs(60 * 120);
556
557 runtime
559 .advance_by(MAX_TIMEOUT * (republish_count as u32))
560 .await;
561 runtime.progress_until_stalled().await;
562
563 let min_upload_count = expected_upload_count * republish_count;
564 let max_upload_count = 2 * min_upload_count;
567 let publish_count_now = publish_count.load(Ordering::SeqCst);
568 let actual_reupload_count = publish_count_now - initial_publish_count;
571
572 assert!((min_upload_count..=max_upload_count).contains(&actual_reupload_count));
573 }
574 });
575 }
576
577 fn publish_after_ipt_change<I: PollReadIter>(
587 temp_dir: &Path,
588 poll_read_responses: I,
589 multiplier: usize,
590 republish_count: usize,
591 expect_errors: bool,
592 ) {
593 let runtime = MockRuntime::new();
594 let nickname = HsNickname::try_from(TEST_SVC_NICKNAME.to_string()).unwrap();
595 let config = build_test_config(nickname.clone());
596 let (_config_tx, config_rx) = watch::channel_with(Arc::new(config));
597
598 let (mut mv, pv) = ipts_channel(&runtime, create_storage_handles(temp_dir).1).unwrap();
599 let update_ipts = || {
600 let ipts: Vec<IptInSet> = test_data::test_parsed_hsdesc()
601 .unwrap()
602 .intro_points()
603 .iter()
604 .enumerate()
605 .map(|(i, ipt)| IptInSet {
606 ipt: ipt.clone(),
607 lid: [i.try_into().unwrap(); 32].into(),
608 })
609 .collect();
610
611 mv.borrow_for_update(runtime.clone()).ipts = Some(IptSet {
612 ipts,
613 lifetime: Duration::from_secs(20),
614 });
615 };
616
617 let netdir = testnet::construct_netdir().unwrap_if_sufficient().unwrap();
618 let keystore_dir = tempdir().unwrap();
619
620 let (_hsid, blind_id, keymgr) = init_keymgr(&keystore_dir, &nickname, &netdir);
621
622 let hsdir_count = netdir
623 .hs_dirs_upload(blind_id, netdir.hs_time_period())
624 .unwrap()
625 .collect::<Vec<_>>()
626 .len();
627
628 assert!(hsdir_count > 0);
629
630 let expected_upload_count = hsdir_count * multiplier;
633 let status_tx = StatusSender::new(OnionServiceStatus::new_shutdown());
634
635 run_test(
636 runtime.clone(),
637 nickname,
638 keymgr,
639 pv,
640 config_rx,
641 status_tx,
642 netdir,
643 update_ipts,
644 poll_read_responses,
645 expected_upload_count,
646 republish_count,
647 expect_errors,
648 );
649 }
650
651 #[test]
652 fn publish_after_ipt_change_no_errors() {
653 let poll_reads = [Ok(OK_RESPONSE.into())].into_iter();
655
656 test_temp_dir!().used_by(|dir| publish_after_ipt_change(dir, poll_reads, 1, 0, false));
657 }
658
659 #[test]
660 fn publish_after_ipt_change_with_errors() {
661 let err_responses = vec![
662 Err(()),
664 Ok(ERR_RESPONSE.to_string()),
666 ];
667
668 for error_res in err_responses.into_iter() {
669 let poll_reads = vec![
670 error_res,
676 Ok(OK_RESPONSE.to_string()),
677 ]
678 .into_iter();
679
680 test_temp_dir!().used_by(|dir| publish_after_ipt_change(dir, poll_reads, 2, 0, true));
681 }
682 }
683
684 #[test]
685 fn reupload_after_publishing() {
686 let poll_reads = [Ok(OK_RESPONSE.into())].into_iter();
687 const REUPLOAD_COUNT: usize = 4;
689
690 test_temp_dir!()
691 .used_by(|dir| publish_after_ipt_change(dir, poll_reads, 1, REUPLOAD_COUNT, false));
692 }
693
694 }