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
//! D-Bus standard interfaces. //! //! The D-Bus specification defines the message bus messages and some standard interfaces that may //! be useful across various D-Bus applications. This module provides their proxy. use enumflags2::BitFlags; use serde::{Deserialize, Serialize}; use serde_repr::{Deserialize_repr, Serialize_repr}; use std::collections::HashMap; use zvariant::{derive::Type, OwnedValue, Value}; use crate::{dbus_proxy, DBusError}; /// Proxy for the `org.freedesktop.DBus.Introspectable` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.Introspectable", default_path = "/")] trait Introspectable { /// Returns an XML description of the object, including its interfaces (with signals and /// methods), objects below it in the object path tree, and its properties. fn introspect(&self) -> Result<String>; } /// Proxy for the `org.freedesktop.DBus.Properties` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.Properties")] trait Properties { /// Get a property value. fn get(&self, interface_name: &str, property_name: &str) -> Result<OwnedValue>; /// Set a property value. fn set(&self, interface_name: &str, property_name: &str, value: &Value) -> Result<()>; /// Get all properties. fn get_all(&self, interface_name: &str) -> Result<HashMap<String, OwnedValue>>; } type ManagedObjects = HashMap<String, HashMap<String, HashMap<String, OwnedValue>>>; /// Proxy for the `org.freedesktop.DBus.ObjectManager` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.ObjectManager")] trait ObjectManager { /// The return value of this method is a dict whose keys are object paths. All returned object /// paths are children of the object path implementing this interface, i.e. their object paths /// start with the ObjectManager's object path plus '/'. /// /// Each value is a dict whose keys are interfaces names. Each value in this inner dict is the /// same dict that would be returned by the org.freedesktop.DBus.Properties.GetAll() method for /// that combination of object path and interface. If an interface has no properties, the empty /// dict is returned. fn get_managed_objects(&self) -> Result<ManagedObjects>; } /// Proxy for the `org.freedesktop.DBus.Peer` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.Peer")] trait Peer { /// On receipt, an application should do nothing other than reply as usual. It does not matter /// which object path a ping is sent to. fn ping(&self) -> Result<()>; /// An application should reply the containing a hex-encoded UUID representing the identity of /// the machine the process is running on. This UUID must be the same for all processes on a /// single system at least until that system next reboots. It should be the same across reboots /// if possible, but this is not always possible to implement and is not guaranteed. It does not /// matter which object path a GetMachineId is sent to. fn get_machine_id(&self) -> Result<String>; } /// Proxy for the `org.freedesktop.DBus.Monitoring` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.Monitoring")] trait Monitoring { /// Converts the connection into a monitor connection which can be used as a /// debugging/monitoring tool. fn become_monitor(&self, n1: &[&str], n2: u32) -> Result<()>; } /// Proxy for the `org.freedesktop.DBus.Stats` interface. #[dbus_proxy(interface = "org.freedesktop.DBus.Debug.Stats")] trait Stats { /// GetStats (undocumented) fn get_stats(&self) -> Result<Vec<HashMap<String, OwnedValue>>>; /// GetConnectionStats (undocumented) fn get_connection_stats(&self, n1: &str) -> Result<Vec<HashMap<String, OwnedValue>>>; /// GetAllMatchRules (undocumented) fn get_all_match_rules(&self) -> Result<Vec<HashMap<String, Vec<String>>>>; } /// The flags used by the bus [`request_name`] method. /// /// [`request_name`]: struct.DBusProxy.html#method.request_name #[repr(u32)] #[derive(Type, BitFlags, Debug, PartialEq, Copy, Clone, Serialize, Deserialize)] pub enum RequestNameFlags { /// If an application A specifies this flag and succeeds in becoming the owner of the name, and /// another application B later calls [`request_name`] with the [`ReplaceExisting`] flag, then /// application A will lose ownership and receive a `org.freedesktop.DBus.NameLost` signal, and /// application B will become the new owner. If [`AllowReplacement`] is not specified by /// application A, or [`ReplaceExisting`] is not specified by application B, then application B /// will not replace application A as the owner. /// /// [`ReplaceExisting`]: enum.RequestNameFlags.html#variant.ReplaceExisting /// [`AllowReplacement`]: enum.RequestNameFlags.html#variant.AllowReplacement /// [`request_name`]: struct.DBusProxy.html#method.request_name AllowReplacement = 0x01, /// Try to replace the current owner if there is one. If this flag is not set the application /// will only become the owner of the name if there is no current owner. If this flag is set, /// the application will replace the current owner if the current owner specified /// [`AllowReplacement`]. /// /// [`AllowReplacement`]: enum.RequestNameFlags.html#variant.AllowReplacement ReplaceExisting = 0x02, /// Without this flag, if an application requests a name that is already owned, the application /// will be placed in a queue to own the name when the current owner gives it up. If this flag /// is given, the application will not be placed in the queue, the request for the name will /// simply fail. This flag also affects behavior when an application is replaced as name owner; /// by default the application moves back into the waiting queue, unless this flag was provided /// when the application became the name owner. DoNotQueue = 0x04, } /// The return code of the [`request_name`] method. /// /// [`request_name`]: struct.DBusProxy.html#method.request_name #[repr(u32)] #[derive(Deserialize_repr, Serialize_repr, Type, Debug, PartialEq)] pub enum RequestNameReply { /// The caller is now the primary owner of the name, replacing any previous owner. Either the /// name had no owner before, or the caller specified [`ReplaceExisting`] and the current owner /// specified [`AllowReplacement`]. /// /// [`ReplaceExisting`]: enum.RequestNameFlags.html#variant.ReplaceExisting /// [`AllowReplacement`]: enum.RequestNameFlags.html#variant.AllowReplacement PrimaryOwner = 0x01, /// The name already had an owner, [`DoNotQueue`] was not specified, and either the current /// owner did not specify [`AllowReplacement`] or the requesting application did not specify /// [`ReplaceExisting`]. /// /// [`DoNotQueue`]: enum.RequestNameFlags.html#variant.DoNotQueue /// [`ReplaceExisting`]: enum.RequestNameFlags.html#variant.ReplaceExisting /// [`AllowReplacement`]: enum.RequestNameFlags.html#variant.AllowReplacement InQueue = 0x02, /// The name already has an owner, [`DoNotQueue`] was specified, and either [`AllowReplacement`] /// was not specified by the current owner, or [`ReplaceExisting`] was not specified by the /// requesting application. /// /// [`DoNotQueue`]: enum.RequestNameFlags.html#variant.DoNotQueue /// [`ReplaceExisting`]: enum.RequestNameFlags.html#variant.ReplaceExisting /// [`AllowReplacement`]: enum.RequestNameFlags.html#variant.AllowReplacement Exists = 0x03, /// The application trying to request ownership of a name is already the owner of it. AlreadyOwner = 0x04, } /// Proxy for the `org.freedesktop.DBus` interface. #[dbus_proxy] trait DBus { /// Adds a match rule to match messages going through the message bus fn add_match(&self, rule: &str) -> Result<()>; /// Returns auditing data used by Solaris ADT, in an unspecified binary format. fn get_adt_audit_session_data(&self, bus_name: &str) -> Result<Vec<u8>>; /// Returns as many credentials as possible for the process connected to the server. fn get_connection_credentials(&self, bus_name: &str) -> Result<HashMap<String, OwnedValue>>; /// Returns the security context used by SELinux, in an unspecified format. #[dbus_proxy(name = "GetConnectionSELinuxSecurityContext")] fn get_connection_selinux_security_context(&self, bus_name: &str) -> Result<Vec<u8>>; /// Returns the Unix process ID of the process connected to the server. fn get_connection_unix_process_id(&self, bus_name: &str) -> Result<u32>; /// Returns the Unix user ID of the process connected to the server. fn get_connection_unix_user(&self, bus_name: &str) -> Result<u32>; /// Gets the unique ID of the bus. fn get_id(&self) -> Result<String>; /// Returns the unique connection name of the primary owner of the name given. fn get_name_owner(&self, name: &str) -> Result<String>; /// Returns the unique name assigned to the connection. fn hello(&self) -> Result<String>; /// Returns a list of all names that can be activated on the bus. fn list_activatable_names(&self) -> Result<Vec<String>>; /// Returns a list of all currently-owned names on the bus. fn list_names(&self) -> Result<Vec<String>>; /// List the connections currently queued for a bus name. fn list_queued_owners(&self, name: &str) -> Result<Vec<String>>; /// Checks if the specified name exists (currently has an owner). fn name_has_owner(&self, name: &str) -> Result<bool>; /// Ask the message bus to release the method caller's claim to the given name. fn release_name(&self, name: &str) -> Result<()>; /// Reload server configuration. fn reload_config(&self) -> Result<()>; /// Removes the first rule that matches. fn remove_match(&self, rule: &str) -> Result<()>; /// Ask the message bus to assign the given name to the method caller. fn request_name( &self, name: &str, flags: BitFlags<RequestNameFlags>, ) -> Result<RequestNameReply>; /// Tries to launch the executable associated with a name (service /// activation), as an explicit request. fn start_service_by_name(&self, name: &str, flags: u32) -> Result<u32>; /// This method adds to or modifies that environment when activating services. fn update_activation_environment(&self, environment: HashMap<&str, &str>) -> Result<()>; /// This signal indicates that the owner of a name has /// changed. It's also the signal to use to detect the appearance /// of new names on the bus. //#[dbus_proxy(signal)] //fn name_owner_changed(&self, name: &str, old_owner: &str, new_owner: &str); /// This signal is sent to a specific application when it loses ownership of a name. //#[dbus_proxy(signal)] //fn name_lost(&self, name: &str); /// This signal is sent to a specific application when it gains ownership of a name. //#[dbus_proxy(signal)] //fn name_acquired(&self, name: &str); /// This property lists abstract “features” provided by the message bus, and can be used by /// clients to detect the capabilities of the message bus with which they are communicating. #[dbus_proxy(property)] fn features(&self) -> Result<Vec<String>>; /// This property lists interfaces provided by the `/org/freedesktop/DBus` object, and can be /// used by clients to detect the capabilities of the message bus with which they are /// communicating. Unlike the standard Introspectable interface, querying this property does ot /// require parsing XML. This property was added in version 1.11.x of the reference /// implementation of the message bus. /// /// The standard `org.freedesktop.DBus` and `org.freedesktop.DBus.Properties` interfaces are not /// included in the value of this property, because their presence can be inferred from the fact /// that a method call on `org.freedesktop.DBus.Properties` asking for properties of /// `org.freedesktop.DBus` was successful. The standard `org.freedesktop.DBus.Peer` and /// `org.freedesktop.DBus.Introspectable` interfaces are not included in the value of this /// property either, because they do not indicate features of the message bus implementation. #[dbus_proxy(property)] fn interfaces(&self) -> Result<Vec<String>>; } /// Errors from https://gitlab.freedesktop.org/dbus/dbus/-/blob/master/dbus/dbus-protocol.h #[derive(Debug, DBusError, PartialEq)] #[dbus_error(prefix = "org.freedesktop.DBus.Error")] pub enum Error { /// Unknown or fall-through ZBus error. ZBus(zbus::Error), /// A generic error; "something went wrong" - see the error message for more. Failed(String), /// There was not enough memory to complete an operation. NoMemory(String), /// The bus doesn't know how to launch a service to supply the bus name you wanted. ServiceUnknown(String), /// The bus name you referenced doesn't exist (i.e. no application owns it). NameHasNoOwner(String), /// No reply to a message expecting one, usually means a timeout occurred. NoReply(String), /// Something went wrong reading or writing to a socket, for example. IOError(String), /// A D-Bus bus address was malformed. BadAddress(String), /// Requested operation isn't supported (like ENOSYS on UNIX). NotSupported(String), /// Some limited resource is exhausted. LimitsExceeded(String), /// Security restrictions don't allow doing what you're trying to do. AccessDenied(String), /// Authentication didn't work. AuthFailed(String), /// Unable to connect to server (probably caused by ECONNREFUSED on a socket). NoServer(String), /// Certain timeout errors, possibly ETIMEDOUT on a socket. /// Note that `TimedOut` is used for message reply timeouts. Timeout(String), /// No network access (probably ENETUNREACH on a socket). NoNetwork(String), /// Can't bind a socket since its address is in use (i.e. EADDRINUSE). AddressInUse(String), /// The connection is disconnected and you're trying to use it. Disconnected(String), /// Invalid arguments passed to a method call. InvalidArgs(String), /// Missing file. FileNotFound(String), /// Existing file and the operation you're using does not silently overwrite. FileExists(String), /// Method name you invoked isn't known by the object you invoked it on. UnknownMethod(String), /// Object you invoked a method on isn't known. UnknownObject(String), /// Interface you invoked a method on isn't known by the object. UnknownInterface(String), /// Property you tried to access isn't known by the object. UnknownProperty(String), /// Property you tried to set is read-only. PropertyReadOnly(String), /// Certain timeout errors, e.g. while starting a service. TimedOut(String), /// Tried to remove or modify a match rule that didn't exist. MatchRuleNotFound(String), /// The match rule isn't syntactically valid. MatchRuleInvalid(String), /// While starting a new process, the exec() call failed. #[dbus_error(name = "Spawn.ExecFailed")] SpawnExecFailed(String), /// While starting a new process, the fork() call failed. #[dbus_error(name = "Spawn.ForkFailed")] SpawnForkFailed(String), /// While starting a new process, the child exited with a status code. #[dbus_error(name = "Spawn.ChildExited")] SpawnChildExited(String), /// While starting a new process, the child exited on a signal. #[dbus_error(name = "Spawn.ChildSignaled")] SpawnChildSignaled(String), /// While starting a new process, something went wrong. #[dbus_error(name = "Spawn.Failed")] SpawnFailed(String), /// We failed to setup the environment correctly. #[dbus_error(name = "Spawn.FailedToSetup")] SpawnFailedToSetup(String), /// We failed to setup the config parser correctly. #[dbus_error(name = "Spawn.ConfigInvalid")] SpawnConfigInvalid(String), /// Bus name was not valid. #[dbus_error(name = "Spawn.ServiceNotValid")] SpawnServiceNotValid(String), /// Service file not found in system-services directory. #[dbus_error(name = "Spawn.ServiceNotFound")] SpawnServiceNotFound(String), /// Permissions are incorrect on the setuid helper. #[dbus_error(name = "Spawn.PermissionsInvalid")] SpawnPermissionsInvalid(String), /// Service file invalid (Name, User or Exec missing). #[dbus_error(name = "Spawn.FileInvalid")] SpawnFileInvalid(String), /// There was not enough memory to complete the operation. #[dbus_error(name = "Spawn.NoMemory")] SpawnNoMemory(String), /// Tried to get a UNIX process ID and it wasn't available. UnixProcessIdUnknown(String), /// A type signature is not valid. InvalidSignature(String), /// A file contains invalid syntax or is otherwise broken. InvalidFileContent(String), /// Asked for SELinux security context and it wasn't available. SELinuxSecurityContextUnknown(String), /// Asked for ADT audit data and it wasn't available. AdtAuditDataUnknown(String), /// There's already an object with the requested object path. ObjectPathInUse(String), /// The message meta data does not match the payload. e.g. expected number of file descriptors /// were not sent over the socket this message was received on. InconsistentMessage(String), /// The message is not allowed without performing interactive authorization, but could have /// succeeded if an interactive authorization step was allowed. InteractiveAuthorizationRequired(String), /// The connection is not from a container, or the specified container instance does not exist. NotContainer(String), } /// Alias for a `Result` with the error type [`zbus::fdo::Error`]. /// /// [`zbus::fdo::Error`]: enum.Error.html pub type Result<T> = std::result::Result<T, Error>; impl From<zbus::MessageError> for Error { fn from(val: zbus::MessageError) -> Self { match val { zbus::MessageError::InsufficientData => { Self::InconsistentMessage("insufficient data".to_string()) } zbus::MessageError::ExcessData => Self::InconsistentMessage("excess data".to_string()), zbus::MessageError::IncorrectEndian => { Self::InconsistentMessage("incorrect endian".to_string()) } zbus::MessageError::Io(e) => Self::IOError(e.to_string()), zbus::MessageError::UnmatchedBodySignature => { Self::InvalidArgs("incorrect body signature".to_string()) } zbus::MessageError::NoBodySignature => { Self::InvalidSignature("missing body signature".to_string()) } zbus::MessageError::InvalidField => { Self::InconsistentMessage("invalid message field".to_string()) } zbus::MessageError::Variant(e) => Self::InconsistentMessage(e.to_string()), } } } #[cfg(test)] mod tests { use crate::fdo; use crate::{Error, Message}; use std::convert::TryInto; #[test] fn error_from_zerror() { let m = Message::method(Some(":1.2"), None, "/", None, "foo", &()).unwrap(); let m = Message::method_error( None, &m, "org.freedesktop.DBus.Error.TimedOut", &("so long"), ) .unwrap(); let e: Error = m.into(); let e: fdo::Error = e.try_into().unwrap(); assert_eq!(e, fdo::Error::TimedOut("so long".to_string())); } }