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
#[cfg(not(feature = "tokio"))]
use async_io::Async;
use event_listener::Event;
use static_assertions::assert_impl_all;
#[cfg(not(feature = "tokio"))]
use std::net::TcpStream;
#[cfg(all(unix, not(feature = "tokio")))]
use std::os::unix::net::UnixStream;
use std::{
collections::{HashMap, HashSet, VecDeque},
convert::TryInto,
sync::Arc,
};
#[cfg(feature = "tokio")]
use tokio::net::TcpStream;
#[cfg(all(unix, feature = "tokio"))]
use tokio::net::UnixStream;
#[cfg(feature = "tokio-vsock")]
use tokio_vsock::VsockStream;
#[cfg(windows)]
use uds_windows::UnixStream;
#[cfg(all(feature = "vsock", not(feature = "tokio")))]
use vsock::VsockStream;
use zvariant::{ObjectPath, Str};
use crate::{
address::{self, Address},
async_lock::RwLock,
handshake,
names::{InterfaceName, UniqueName, WellKnownName},
raw::Socket,
AuthMechanism, Authenticated, Connection, Error, Executor, Guid, Interface, Result,
};
const DEFAULT_MAX_QUEUED: usize = 64;
#[derive(Debug)]
enum Target {
UnixStream(UnixStream),
TcpStream(TcpStream),
#[cfg(any(
all(feature = "vsock", not(feature = "tokio")),
feature = "tokio-vsock"
))]
VsockStream(VsockStream),
Address(Address),
Socket(Box<dyn Socket>),
}
type Interfaces<'a> =
HashMap<ObjectPath<'a>, HashMap<InterfaceName<'static>, Arc<RwLock<dyn Interface>>>>;
/// A builder for [`zbus::Connection`].
#[derive(derivative::Derivative)]
#[derivative(Debug)]
#[must_use]
pub struct ConnectionBuilder<'a> {
target: Target,
max_queued: Option<usize>,
guid: Option<&'a Guid>,
p2p: bool,
internal_executor: bool,
#[derivative(Debug = "ignore")]
interfaces: Interfaces<'a>,
names: HashSet<WellKnownName<'a>>,
auth_mechanisms: Option<VecDeque<AuthMechanism>>,
unique_name: Option<UniqueName<'a>>,
cookie_context: Option<handshake::CookieContext<'a>>,
cookie_id: Option<usize>,
}
assert_impl_all!(ConnectionBuilder<'_>: Send, Sync, Unpin);
impl<'a> ConnectionBuilder<'a> {
/// Create a builder for the session/user message bus connection.
pub fn session() -> Result<Self> {
Ok(Self::new(Target::Address(Address::session()?)))
}
/// Create a builder for the system-wide message bus connection.
pub fn system() -> Result<Self> {
Ok(Self::new(Target::Address(Address::system()?)))
}
/// Create a builder for connection that will use the given [D-Bus bus address].
///
/// # Example
///
/// Here is an example of connecting to an IBus service:
///
/// ```no_run
/// # use std::error::Error;
/// # use zbus::ConnectionBuilder;
/// # use zbus::block_on;
/// #
/// # block_on(async {
/// let addr = "unix:\
/// path=/home/zeenix/.cache/ibus/dbus-ET0Xzrk9,\
/// guid=fdd08e811a6c7ebe1fef0d9e647230da";
/// let conn = ConnectionBuilder::address(addr)?
/// .build()
/// .await?;
///
/// // Do something useful with `conn`..
/// # drop(conn);
/// # Ok::<(), zbus::Error>(())
/// # }).unwrap();
/// #
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
///
/// **Note:** The IBus address is different for each session. You can find the address for your
/// current session using `ibus address` command.
///
/// [D-Bus bus address]: https://dbus.freedesktop.org/doc/dbus-specification.html#addresses
pub fn address<A>(address: A) -> Result<Self>
where
A: TryInto<Address>,
A::Error: Into<Error>,
{
Ok(Self::new(Target::Address(
address.try_into().map_err(Into::into)?,
)))
}
/// Create a builder for connection that will use the given unix stream.
///
/// If the default `async-io` feature is disabled, this method will expect
/// [`tokio::net::UnixStream`](https://docs.rs/tokio/latest/tokio/net/struct.UnixStream.html)
/// argument.
pub fn unix_stream(stream: UnixStream) -> Self {
Self::new(Target::UnixStream(stream))
}
/// Create a builder for connection that will use the given TCP stream.
///
/// If the default `async-io` feature is disabled, this method will expect
/// [`tokio::net::TcpStream`](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html)
/// argument.
pub fn tcp_stream(stream: TcpStream) -> Self {
Self::new(Target::TcpStream(stream))
}
/// Create a builder for connection that will use the given VSOCK stream.
///
/// This method is only available when either `vsock` or `tokio-vsock` feature is enabled. The
/// type of `stream` is `vsock::VsockStream` with `vsock` feature and `tokio_vsock::VsockStream`
/// with `tokio-vsock` feature.
#[cfg(any(
all(feature = "vsock", not(feature = "tokio")),
feature = "tokio-vsock"
))]
pub fn vsock_stream(stream: VsockStream) -> Self {
Self::new(Target::VsockStream(stream))
}
/// Create a builder for connection that will use the given socket.
pub fn socket<S: Socket + 'static>(socket: S) -> Self {
Self::new(Target::Socket(Box::new(socket)))
}
/// Specify the mechanisms to use during authentication.
pub fn auth_mechanisms(mut self, auth_mechanisms: &[AuthMechanism]) -> Self {
self.auth_mechanisms = Some(VecDeque::from(auth_mechanisms.to_vec()));
self
}
/// The cookie context to use during authentication.
///
/// This is only used when the `cookie` authentication mechanism is enabled and only valid for
/// server connection.
///
/// If not specified, the default cookie context of `org_freedesktop_general` will be used.
///
/// # Errors
///
/// If the given string is not a valid cookie context.
pub fn cookie_context<C>(mut self, context: C) -> Result<Self>
where
C: Into<Str<'a>>,
{
self.cookie_context = Some(context.into().try_into()?);
Ok(self)
}
/// The ID of the cookie to use during authentication.
///
/// This is only used when the `cookie` authentication mechanism is enabled and only valid for
/// server connection.
///
/// If not specified, the first cookie found in the cookie context file will be used.
pub fn cookie_id(mut self, id: usize) -> Self {
self.cookie_id = Some(id);
self
}
/// The to-be-created connection will be a peer-to-peer connection.
pub fn p2p(mut self) -> Self {
self.p2p = true;
self
}
/// The to-be-created connection will be a server using the given GUID.
///
/// The to-be-created connection will wait for incoming client authentication handshake and
/// negotiation messages, for peer-to-peer communications after successful creation.
pub fn server(mut self, guid: &'a Guid) -> Self {
self.guid = Some(guid);
self
}
/// Set the capacity of the main (unfiltered) queue.
///
/// Since typically you'd want to set this at instantiation time, you can set it through the
/// builder.
///
/// # Example
///
/// ```
/// # use std::error::Error;
/// # use zbus::ConnectionBuilder;
/// # use zbus::block_on;
/// #
/// # block_on(async {
/// let conn = ConnectionBuilder::session()?
/// .max_queued(30)
/// .build()
/// .await?;
/// assert_eq!(conn.max_queued(), 30);
///
/// # Ok::<(), zbus::Error>(())
/// # }).unwrap();
/// #
/// // Do something useful with `conn`..
/// # Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
pub fn max_queued(mut self, max: usize) -> Self {
self.max_queued = Some(max);
self
}
/// Enable or disable the internal executor thread.
///
/// The thread is enabled by default.
///
/// See [Connection::executor] for more details.
pub fn internal_executor(mut self, enabled: bool) -> Self {
self.internal_executor = enabled;
self
}
/// Register a D-Bus [`Interface`] to be served at a given path.
///
/// This is similar to [`zbus::ObjectServer::at`], except that it allows you to have your
/// interfaces available immediately after the connection is established. Typically, this is
/// exactly what you'd want. Also in contrast to [`zbus::ObjectServer::at`], this method will
/// replace any previously added interface with the same name at the same path.
pub fn serve_at<P, I>(mut self, path: P, iface: I) -> Result<Self>
where
I: Interface,
P: TryInto<ObjectPath<'a>>,
P::Error: Into<Error>,
{
let path = path.try_into().map_err(Into::into)?;
let entry = self.interfaces.entry(path).or_default();
entry.insert(I::name(), Arc::new(RwLock::new(iface)));
Ok(self)
}
/// Register a well-known name for this connection on the bus.
///
/// This is similar to [`zbus::Connection::request_name`], except the name is requested as part
/// of the connection setup ([`ConnectionBuilder::build`]), immediately after interfaces
/// registered (through [`ConnectionBuilder::serve_at`]) are advertised. Typically this is
/// exactly what you want.
pub fn name<W>(mut self, well_known_name: W) -> Result<Self>
where
W: TryInto<WellKnownName<'a>>,
W::Error: Into<Error>,
{
let well_known_name = well_known_name.try_into().map_err(Into::into)?;
self.names.insert(well_known_name);
Ok(self)
}
/// Sets the unique name of the connection.
///
/// # Panics
///
/// This method panics if the to-be-created connection is not a peer-to-peer connection.
/// It will always panic if the connection is to a message bus as it's the bus that assigns
/// peers their unique names. This is mainly provided for bus implementations. All other users
/// should not need to use this method.
pub fn unique_name<U>(mut self, unique_name: U) -> Result<Self>
where
U: TryInto<UniqueName<'a>>,
U::Error: Into<Error>,
{
if !self.p2p {
panic!("unique name can only be set for peer-to-peer connections");
}
let name = unique_name.try_into().map_err(Into::into)?;
self.unique_name = Some(name);
Ok(self)
}
/// Build the connection, consuming the builder.
///
/// # Errors
///
/// Until server-side bus connection is supported, attempting to build such a connection will
/// result in [`Error::Unsupported`] error.
pub async fn build(self) -> Result<Connection> {
let executor = Executor::new();
#[cfg(not(feature = "tokio"))]
let internal_executor = self.internal_executor;
// Box the future as it's large and can cause stack overflow.
let conn = Box::pin(executor.run(self.build_(executor.clone()))).await?;
#[cfg(not(feature = "tokio"))]
start_internal_executor(&executor, internal_executor)?;
Ok(conn)
}
async fn build_(self, executor: Executor<'static>) -> Result<Connection> {
let stream = match self.target {
#[cfg(not(feature = "tokio"))]
Target::UnixStream(stream) => Box::new(Async::new(stream)?) as Box<dyn Socket>,
#[cfg(all(unix, feature = "tokio"))]
Target::UnixStream(stream) => Box::new(stream) as Box<dyn Socket>,
#[cfg(all(not(unix), feature = "tokio"))]
Target::UnixStream(_) => return Err(Error::Unsupported),
#[cfg(not(feature = "tokio"))]
Target::TcpStream(stream) => Box::new(Async::new(stream)?) as Box<dyn Socket>,
#[cfg(feature = "tokio")]
Target::TcpStream(stream) => Box::new(stream) as Box<dyn Socket>,
#[cfg(all(feature = "vsock", not(feature = "tokio")))]
Target::VsockStream(stream) => Box::new(Async::new(stream)?) as Box<dyn Socket>,
#[cfg(feature = "tokio-vsock")]
Target::VsockStream(stream) => Box::new(stream) as Box<dyn Socket>,
Target::Address(address) => match address.connect().await? {
#[cfg(any(unix, not(feature = "tokio")))]
address::Stream::Unix(stream) => Box::new(stream) as Box<dyn Socket>,
address::Stream::Tcp(stream) => Box::new(stream) as Box<dyn Socket>,
#[cfg(any(
all(feature = "vsock", not(feature = "tokio")),
feature = "tokio-vsock"
))]
address::Stream::Vsock(stream) => Box::new(stream) as Box<dyn Socket>,
},
Target::Socket(stream) => stream,
};
let auth = match self.guid {
None => {
// SASL Handshake
Authenticated::client(stream, self.auth_mechanisms).await?
}
Some(guid) => {
if !self.p2p {
return Err(Error::Unsupported);
}
#[cfg(unix)]
let client_uid = stream.uid()?;
#[cfg(windows)]
let client_sid = stream.peer_sid();
Authenticated::server(
stream,
guid.clone(),
#[cfg(unix)]
client_uid,
#[cfg(windows)]
client_sid,
self.auth_mechanisms,
self.cookie_id,
self.cookie_context.unwrap_or_default(),
)
.await?
}
};
let mut conn = Connection::new(auth, !self.p2p, executor).await?;
conn.set_max_queued(self.max_queued.unwrap_or(DEFAULT_MAX_QUEUED));
if let Some(unique_name) = self.unique_name {
conn.set_unique_name(unique_name)?;
}
if !self.interfaces.is_empty() {
let object_server = conn.sync_object_server(false, None);
for (path, interfaces) in self.interfaces {
for (name, iface) in interfaces {
let future = object_server.at_ready(path.to_owned(), name, || iface);
let added = future.await?;
// Duplicates shouldn't happen.
assert!(added);
}
}
let started_event = Event::new();
let listener = started_event.listen();
conn.start_object_server(Some(started_event));
listener.await;
}
// Start the socket reader task.
conn.init_socket_reader();
if !self.p2p {
// Now that the server has approved us, we must send the bus Hello, as per specs
conn.hello_bus().await?;
}
for name in self.names {
conn.request_name(name).await?;
}
Ok(conn)
}
fn new(target: Target) -> Self {
Self {
target,
p2p: false,
max_queued: None,
guid: None,
internal_executor: true,
interfaces: HashMap::new(),
names: HashSet::new(),
auth_mechanisms: None,
unique_name: None,
cookie_id: None,
cookie_context: None,
}
}
}
/// Start the internal executor thread.
///
/// Returns a dummy task that keep the executor ticking thread from exiting due to absence of any
/// tasks until socket reader task kicks in.
#[cfg(not(feature = "tokio"))]
fn start_internal_executor(executor: &Executor<'static>, internal_executor: bool) -> Result<()> {
if internal_executor {
let executor = executor.clone();
std::thread::Builder::new()
.name("zbus::Connection executor".into())
.spawn(move || {
crate::utils::block_on(async move {
// Run as long as there is a task to run.
while !executor.is_empty() {
executor.tick().await;
}
})
})?;
}
Ok(())
}