#![cfg_attr(docsrs, feature(doc_cfg))]

#![doc = include_str!("../README.md")]

// @@ begin lint list maintained by maint/add_warning @@

#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)

#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)

#![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)]

#![allow(clippy::cognitive_complexity)] // See arti#2556

#![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_time_subtraction)]

#![deny(clippy::unnecessary_wraps)]

#![warn(clippy::unseparated_literal_suffix)]

#![deny(clippy::unwrap_used)]

#![deny(clippy::mod_module_files)]

#![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

#![allow(clippy::needless_lifetimes)] // See arti#1765

#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060

#![allow(clippy::collapsible_if)] // See arti#2342

#![deny(clippy::unused_async)]

#![deny(clippy::string_slice)] // See arti#2571

#![allow(recursion_depth_exceeding_limit)] // arti#2715, rust/issues/159228

//! <!-- @@ end lint list maintained by maint/add_warning @@ -->

#![allow(clippy::redundant_field_names)] // TODO beta clippy bug, rust-clippy/issues/17525

mod caps;

mod connect;

mod err;

mod isol_map;

mod keys;

mod pow;

mod proto_oneshot;

mod relay_info;

mod state;

use std::future::Future;

use std::sync::{Arc, Mutex, MutexGuard};

use futures::StreamExt as _;

use futures::stream::BoxStream;

use tor_rtcompat::SpawnExt as _;

use educe::Educe;

use tracing::{debug, instrument};

use tor_circmgr::ClientOnionServiceDataTunnel;

use tor_circmgr::hspool::HsCircPool;

use tor_circmgr::isolation::StreamIsolation;

use tor_error::{Bug, internal};

use tor_hscrypto::pk::HsId;

use tor_netdir::NetDir;

use tor_rtcompat::Runtime;

pub use err::FailedAttemptError;

pub use err::{ConnError, DescriptorError, DescriptorErrorDetail, StartupError};

pub use keys::{HsClientDescEncKeypairSpecifier, HsClientSecretKeys, HsClientSecretKeysBuilder};

pub use relay_info::InvalidTarget;

pub use state::HsClientConnectorConfig;

use err::{IntroPtIndex, rend_pt_identity_for_error};

use state::{Config, MockableConnectorData, Services};

/// An object that negotiates connections with onion services

///

/// This can be used by multiple requests on behalf of different clients,

/// with potentially different HS service discovery keys (`KS_hsc_*`)

/// and potentially different circuit isolation.

///

/// The principal entrypoint is

/// [`get_or_launch_tunnel()`](HsClientConnector::get_or_launch_tunnel).

///

/// This object is handle-like: it is fairly cheap to clone,

///  and contains `Arc`s internally.

#[derive(Educe)]

#[educe(Clone)]

pub struct HsClientConnector<R: Runtime, D: state::MockableConnectorData = connect::Data> {

    /// The runtime

    runtime: R,

    /// A [`HsCircPool`] that we use to build circuits to HsDirs, introduction

    /// points, and rendezvous points.

    circpool: Arc<HsCircPool<R>>,

    /// Information we are remembering about different onion services.

    services: Arc<Mutex<state::Services<D>>>,

    /// For mocking in tests of `state.rs`

    mock_for_state: D::MockGlobalState,

}

impl<R: Runtime> HsClientConnector<R, connect::Data> {

    /// Create a new `HsClientConnector`

    ///

    /// `housekeeping_prompt` should yield "occasionally",

    /// perhaps every few hours or maybe daily.

    ///

    /// In Arti we arrange for this to happen when we have a new consensus.

    ///

    /// Housekeeping events shouldn't arrive while we're dormant,

    /// since the housekeeping might involve processing that ought to be deferred.

    // This ^ is why we don't have a separate "launch background tasks" method.

    // It is fine for this background task to be launched pre-bootstrap, since it willp

    // do nothing until it gets events.

    /// Connect to a hidden service

    ///

    /// On success, this function will return an open

    /// rendezvous circuit with an authenticated connection to the onion service

    /// whose identity is `hs_id`.  If such a circuit already exists, and its isolation

    /// is compatible with `isolation`, that circuit may be returned; otherwise,

    /// a new circuit will be created.

    ///

    /// Once a circuit is returned, the caller can use it to open new streams to the

    /// onion service. To do so, call [`ClientOnionServiceDataTunnel::begin_stream`] on it.

    ///

    /// Each HS connection request must provide the appropriate

    /// service discovery keys to use -

    /// or [`default`](HsClientSecretKeys::default)

    /// if the hidden service is not running in restricted discovery mode.

    //

    // This returns an explicit `impl Future` so that we can write the `Send` bound.

    // Without this, it is possible for `Services::get_or_launch_connection`

    // to not return a `Send` future.

    // https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1034#note_2881718

    #[instrument(skip_all, level = "trace")]

    {

        // As in tor-circmgr,  we take `StreamIsolation`, to ensure that callers in

        // arti-client pass us the final overall isolation,

        // including the per-TorClient isolation.

        // But internally we need a Box<dyn Isolation> since we need .join().

}

impl<R: Runtime, D: MockableConnectorData> HsClientConnector<R, D> {

    /// Lock the `Services` table and return the guard

    ///

    /// Convenience method

    /// Spawn a task which watches `prompt` and calls [`Services::run_housekeeping`]

                        };

                        // (Currently) this is "expire old data".

                    }

            })

                spawning: "housekeeping task",

}

/// Return a list of the protocols [supported](tor_protover::doc_supported) by this crate,

/// running as a hidden service client.

    use tor_protover::named::*;

    // WARNING: REMOVING ELEMENTS FROM THIS LIST CAN BE DANGEROUS!

    // SEE [`tor_protover::doc_changing`]

#[cfg(test)]

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_time_subtraction)]

    #![allow(clippy::useless_vec)]

    #![allow(clippy::needless_pass_by_value)]

    #![allow(clippy::string_slice)] // See arti#2571

    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->

    use super::*;

    #[test]

    fn protocols() {

        let pr = supported_hsclient_protocols();

        let expected = "HSIntro=4-5 HSRend=2 HSDir=2".parse().unwrap();

        assert_eq!(pr, expected);

    }

}