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
use kitsune_p2p_types::config::{tuning_params_struct, KitsuneP2pTuningParams};
use kitsune_p2p_types::tx2::tx2_adapter::AdapterFactory;
use kitsune_p2p_types::tx2::tx2_utils::*;
use kitsune_p2p_types::*;
use url2::Url2;
// TODO - FIXME - holochain bootstrap should not be encoded in kitsune
/// The default production bootstrap service url.
pub const BOOTSTRAP_SERVICE_DEFAULT: &str = "https://bootstrap-staging.holo.host";
// TODO - FIXME - holochain bootstrap should not be encoded in kitsune
/// The default development bootstrap service url.
pub const BOOTSTRAP_SERVICE_DEV: &str = "https://bootstrap-dev.holohost.workers.dev";
pub(crate) enum KitsuneP2pTx2Backend {
#[allow(dead_code)]
#[cfg(feature = "tx2")]
Mem,
//#[cfg(feature = "tx2")]
//Quic { bind_to: TxUrl },
#[allow(dead_code)]
#[cfg(feature = "tx2")]
Mock { mock_network: AdapterFactory },
}
#[cfg(feature = "tx2")]
pub(crate) enum KitsuneP2pTx2ProxyConfig {
NoProxy,
#[allow(dead_code)]
Specific(TxUrl),
#[allow(dead_code)]
Bootstrap {
#[allow(dead_code)]
bootstrap_url: TxUrl,
fallback_proxy_url: Option<TxUrl>,
},
}
#[cfg(feature = "tx2")]
pub(crate) struct KitsuneP2pTx2Config {
pub(crate) backend: KitsuneP2pTx2Backend,
pub(crate) use_proxy: KitsuneP2pTx2ProxyConfig,
}
/// Configure the kitsune actor.
#[non_exhaustive]
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
pub struct KitsuneP2pConfig {
/// List of sub-transports to be included in this pool
pub transport_pool: Vec<TransportConfig>,
/// The service used for peers to discover each before they are peers.
pub bootstrap_service: Option<Url2>,
/// Network tuning parameters. These are managed loosely,
/// as they are subject to change. If you specify a tuning parameter
/// that no longer exists, or a value that does not parse,
/// a warning will be printed in the tracing log.
#[serde(default)]
pub tuning_params: KitsuneP2pTuningParams,
/// The network used for connecting to other peers
pub network_type: NetworkType,
/// All tracing logs from kitsune tasks will be instrumented to contain this string,
/// so that logs from multiple instances in the same process can be disambiguated.
#[serde(default)]
pub tracing_scope: Option<String>,
}
impl Default for KitsuneP2pConfig {
fn default() -> Self {
Self {
transport_pool: Vec::new(),
bootstrap_service: None,
tuning_params: KitsuneP2pTuningParams::default(),
network_type: NetworkType::QuicBootstrap,
tracing_scope: None,
}
}
}
#[allow(dead_code)]
fn cnv_bind_to(bind_to: &Option<url2::Url2>) -> TxUrl {
match bind_to {
Some(bind_to) => bind_to.clone().into(),
None => "kitsune-quic://0.0.0.0:0".into(),
}
}
impl KitsuneP2pConfig {
/// This config is making use of tx2 transport
#[allow(dead_code)] // because of feature flipping
pub fn is_tx2(&self) -> bool {
#[cfg(feature = "tx2")]
{
#[cfg(feature = "tx5")]
{
if let Some(t) = self.transport_pool.first() {
!matches!(t, TransportConfig::WebRTC { .. })
} else {
true
}
}
#[cfg(not(feature = "tx5"))]
{
true
}
}
#[cfg(not(feature = "tx2"))]
{
false
}
}
/// This config is making use of tx5 transport
#[allow(dead_code)] // because of feature flipping
pub fn is_tx5(&self) -> bool {
#[cfg(feature = "tx5")]
{
if let Some(t) = self.transport_pool.first() {
return matches!(t, TransportConfig::WebRTC { .. });
}
}
false
}
/// `tx2` is currently designed to use exactly one proxy wrapped transport,
/// so convert a bunch of the options from the previous transport
/// paradigm into that pattern.
#[cfg(feature = "tx2")]
pub(crate) fn to_tx2(&self) -> KitsuneResult<KitsuneP2pTx2Config> {
use KitsuneP2pTx2ProxyConfig::*;
match self.transport_pool.first() {
Some(TransportConfig::Mock { mock_network }) => Ok(KitsuneP2pTx2Config {
backend: KitsuneP2pTx2Backend::Mock {
mock_network: mock_network.0.clone(),
},
use_proxy: NoProxy,
}),
#[cfg(feature = "tx5")]
Some(TransportConfig::WebRTC { .. }) => {
Err("Cannot convert tx5 config into tx2".into())
}
None | Some(TransportConfig::Mem {}) => Ok(KitsuneP2pTx2Config {
backend: KitsuneP2pTx2Backend::Mem,
use_proxy: NoProxy,
}),
}
}
/// Return a copy with the tuning params altered
pub fn tune(
mut self,
f: impl Fn(
tuning_params_struct::KitsuneP2pTuningParams,
) -> tuning_params_struct::KitsuneP2pTuningParams,
) -> Self {
let tp = (*self.tuning_params).clone();
self.tuning_params = std::sync::Arc::new(f(tp));
self
}
}
/// Configure the network bindings for underlying kitsune transports.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum TransportConfig {
/// A transport that uses the local memory transport protocol
/// (this is mainly for testing)
#[cfg(feature = "tx2")]
Mem {},
/// A mock network for testing
#[cfg(feature = "tx2")]
#[serde(skip)]
Mock {
/// The adaptor for mocking the network
mock_network: AdapterFactoryMock,
},
/// Configure to use Tx5 WebRTC for kitsune networking.
#[cfg(feature = "tx5")]
#[serde(rename = "webrtc", alias = "web_r_t_c", alias = "web_rtc")]
WebRTC {
/// The url of the signal server to connect to for addressability.
signal_url: String,
},
}
#[cfg(feature = "tx2")]
#[derive(Clone)]
/// A simple wrapper around the [`AdaptorFactory`](tx2::tx2_adapter::AdapterFactory)
/// to allow implementing Debug and PartialEq.
pub struct AdapterFactoryMock(pub AdapterFactory);
#[cfg(feature = "tx2")]
impl std::fmt::Debug for AdapterFactoryMock {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple("AdapterFactoryMock").finish()
}
}
#[cfg(feature = "tx2")]
impl std::cmp::PartialEq for AdapterFactoryMock {
fn eq(&self, _: &Self) -> bool {
unimplemented!()
}
}
#[cfg(feature = "tx2")]
impl From<AdapterFactory> for AdapterFactoryMock {
fn from(adaptor_factory: AdapterFactory) -> Self {
Self(adaptor_factory)
}
}
/// Proxy configuration options
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
#[serde(tag = "type", rename_all = "snake_case")]
#[cfg(feature = "tx2")]
pub enum ProxyConfig {
/// We want to be hosted at a remote proxy location.
RemoteProxyClient {
/// The remote proxy url to be hosted at
proxy_url: Url2,
},
/// We want to be hosted at a remote proxy location.
/// We'd like to fetch a proxy list from a bootstrap server,
/// with an optional fallback to a specific proxy.
RemoteProxyClientFromBootstrap {
/// The bootstrap server from which to fetch the proxy_list
bootstrap_url: Url2,
/// The optional fallback specific proxy server
fallback_proxy_url: Option<Url2>,
},
/// We want to be a proxy server for others.
/// (We can also deny all proxy requests for something in-between.)
LocalProxyServer {
/// Accept proxy request options
/// Default: None = reject all proxy requests
proxy_accept_config: Option<ProxyAcceptConfig>,
},
}
/// Whether we are willing to proxy on behalf of others
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
#[cfg(feature = "tx2")]
pub enum ProxyAcceptConfig {
/// We will accept all requests to proxy for remotes
AcceptAll,
/// We will reject all requests to proxy for remotes
RejectAll,
}
/// Method for connecting to other peers and broadcasting our AgentInfo
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum NetworkType {
/// Via bootstrap server to the WAN
// MAYBE: Remove the "Quic" from this?
QuicBootstrap,
/// Via MDNS to the LAN
// MAYBE: Remove the "Quic" from this?
QuicMdns,
}