Struct zbus_polkit::policykit1::AuthorityProxyBlocking

pub struct AuthorityProxyBlocking<'c>(_);

This D-Bus interface is implemented by the /org/freedesktop/PolicyKit1/Authority object on the well-known name org.freedesktop.PolicyKit1 on the system message bus.

Implementations

impl<'c> AuthorityProxyBlocking<'c>

pub fn new(conn: &Connection) -> Result<AuthorityProxyBlocking<'c>>

Creates a new proxy with the default service & path.

pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>

Returns a customizable builder for this proxy.

pub fn into_inner(self) -> Proxy<'c>

Consumes self, returning the underlying zbus::Proxy.

pub fn inner(&self) -> &Proxy<'c>

The reference to the underlying zbus::Proxy.

pub fn authentication_agent_response(
    &self,
    cookie: &str,
    identity: &Identity<'_>
) -> Result<()>

Method for authentication agents to invoke on successful authentication, intended only for use by a privileged helper process internal to polkit. This method will fail unless a sufficiently privileged +caller invokes it. Deprecated in favor of AuthenticationAgentResponse2().

pub fn authentication_agent_response2(
    &self,
    uid: u32,
    cookie: &str,
    identity: &Identity<'_>
) -> Result<()>

Method for authentication agents to invoke on successful authentication, intended only for use by a privileged helper process internal to polkit. This method will fail unless a sufficiently privileged caller invokes it. Note this method was introduced in 0.114 and should be preferred over AuthenticationAgentResponse() as it fixes a security issue.

pub fn cancel_check_authorization(&self, cancellation_id: &str) -> Result<()>

Cancels an authorization check.

Arguments

• cancellation_id - The cancellation_id passed to CheckAuthorization().

pub fn check_authorization(
    &self,
    subject: &Subject,
    action_id: &str,
    details: &HashMap<&str, &str>,
    flags: BitFlags<CheckAuthorizationFlags>,
    cancellation_id: &str
) -> Result<AuthorizationResult>

Checks if subject is authorized to perform the action with identifier action_id

If cancellation_id is non-empty and already in use for the caller, the org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique error is returned.

Note that CheckAuthorizationFlags::AllowUserInteraction SHOULD be passed ONLY if the event that triggered the authorization check is stemming from an user action, e.g. the user pressing a button or attaching a device.

Arguments

• subject - A Subject struct.

• action_id - Identifier for the action that subject is attempting to do.

• details - Details describing the action. Keys starting with polkit. can only be set if defined in this document.

Known keys include polkit.message and polkit.gettext_domain that can be used to override the message shown to the user. This latter is needed because the user could be running an authentication agent in another locale than the calling process.

The (translated version of) polkit.message may include references to other keys that are expanded with their respective values. For example if the key device_file has the value /dev/sda then the message “Authenticate to format $(device_file)” is expanded to “Authenticate to format /dev/sda”.

The key polkit.icon_name is used to override the icon shown in the authentication dialog.

If non-empty, then the request will fail with org.freedesktop.PolicyKit1.Error.Failed unless the process doing the check itself is sufficiently authorized (e.g. running as uid 0).

• flags - A set of CheckAuthorizationFlags.

• cancellation_id - A unique id used to cancel the the authentication check via CancelCheckAuthorization() or the empty string if cancellation is not needed.

Returns: An AuthorizationResult structure.

pub fn enumerate_actions(&self, locale: &str) -> Result<Vec<ActionDescription>>

Enumerates all registered PolicyKit actions.

Arguments:

• locale - The locale to get descriptions in or the blank string to use the system locale.

pub fn enumerate_temporary_authorizations(
    &self,
    subject: &Subject
) -> Result<Vec<TemporaryAuthorization>>

Retrieves all temporary authorizations that applies to subject.

pub fn register_authentication_agent(
    &self,
    subject: &Subject,
    locale: &str,
    object_path: &str
) -> Result<()>

Register an authentication agent.

Note that this should be called by same effective UID which will be passed to AuthenticationAgentResponse2().

Arguments

• subject - The subject to register the authentication agent for, typically a session subject.

• locale - The locale of the authentication agent.

• object_path - The object path of authentication agent object on the unique name of the caller.

pub fn register_authentication_agent_with_options(
    &self,
    subject: &Subject,
    locale: &str,
    object_path: &str,
    options: &HashMap<&str, Value<'_>>
) -> Result<()>

Like RegisterAuthenticationAgent but takes additional options. If the option fallback (of type Boolean) is TRUE, then the authentcation agent will only be used as a fallback, e.g. if another agent (without the fallback option set TRUE) is available, it will be used instead.

pub fn revoke_temporary_authorization_by_id(&self, id: &str) -> Result<()>

Revokes all temporary authorizations that applies to id.

pub fn revoke_temporary_authorizations(&self, subject: &Subject) -> Result<()>

Revokes all temporary authorizations that applies to subject.

pub fn unregister_authentication_agent(
    &self,
    subject: &Subject,
    object_path: &str
) -> Result<()>

Unregister an authentication agent.

Arguments

• subject - The subject passed to RegisterAuthenticationAgent().

• object_path - The object_path passed to RegisterAuthenticationAgent().

pub fn receive_changed(&self) -> Result<ChangedIterator<'c>>

Create a stream that receives Changed signals.

This a convenient wrapper around zbus::blocking::Proxy::receive_signal. This signal is emitted when actions and/or authorizations change

pub fn backend_features(&self) -> Result<AuthorityFeatures>

The features supported by the currently used Authority backend.

pub fn cached_backend_features(
    &self
) -> Result<Option<<Result<AuthorityFeatures> as ResultAdapter>::Ok>, <Result<AuthorityFeatures> as ResultAdapter>::Err>

Get the cached value of the BackendFeatures property, or None if the property is not cached.

pub fn receive_backend_features_changed(
    &self
) -> PropertyIterator<'c, <Result<AuthorityFeatures> as ResultAdapter>::Ok>

Create a stream for the BackendFeatures property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn backend_name(&self) -> Result<String>

The name of the currently used Authority backend.

pub fn cached_backend_name(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the BackendName property, or None if the property is not cached.

pub fn receive_backend_name_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the BackendName property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

pub fn backend_version(&self) -> Result<String>

The version of the currently used Authority backend.

pub fn cached_backend_version(
    &self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the BackendVersion property, or None if the property is not cached.

pub fn receive_backend_version_changed(
    &self
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the BackendVersion property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

Methods from Deref<Target = Proxy<'c>>

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &BusName<'_>

Get a reference to the destination service name.

pub fn path(&self) -> &ObjectPath<'_>

Get a reference to the object path.

pub fn interface(&self) -> &InterfaceName<'_>

Get a reference to the interface.

pub fn introspect(&self) -> Result<String, Error>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>, Error>where
    T: TryFrom<OwnedValue>,
    <T as TryFrom<OwnedValue>>::Error: Into<Error>,

Get the cached value of the property property_name.

This returns None if the property is not in the cache. This could be because the cache was invalidated by an update, because caching was disabled for this property or proxy, or because the cache has not yet been populated. Use get_property to fetch the value from the peer.

pub fn cached_property_raw(
    &'p self,
    property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>

Get the cached value of the property property_name.

Same as cached_property, but gives you access to the raw value stored in the cache. This is useful if you want to avoid allocations and cloning.

pub fn get_property<T>(&self, property_name: &str) -> Result<T, Error>where
    T: TryFrom<OwnedValue>,
    <T as TryFrom<OwnedValue>>::Error: Into<Error>,

Get the property property_name.

Get the property value from the cache or call the Get method of the org.freedesktop.DBus.Properties interface.

pub fn set_property<'t, T>(
    &self,
    property_name: &str,
    value: T
) -> Result<(), Error>where
    T: 't + Into<Value<'t>>,

Set the property property_name.

Effectively, call the Set method of the org.freedesktop.DBus.Properties interface.

pub fn call_method<'m, M, B>(
    &self,
    method_name: M,
    body: &B
) -> Result<Arc<Message>, Error>where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Call a method and return the reply.

Typically, you would want to use call method instead. Use this method if you need to deserialize the reply message manually (this way, you can avoid the memory allocation/copying, by deserializing the reply to an unowned type).

pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    R: DeserializeOwned + Type,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Call a method and return the reply body.

Use call_method instead if you need to deserialize the reply manually/separately.

pub fn call_noreply<'m, M, B>(
    &self,
    method_name: M,
    body: &B
) -> Result<(), Error>where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Call a method without expecting a reply

This sets the NoReplyExpected flag on the calling message and does not wait for a reply.

pub fn receive_signal<'m, M>(
    &self,
    signal_name: M
) -> Result<SignalIterator<'a>, Error>where
    'm: 'a,
    M: TryInto<MemberName<'m>>,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_all_signals(&self) -> Result<SignalIterator<'a>, Error>

Create a stream for all signals emitted by this service.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_property_changed<'name, T>(
    &self,
    name: &'name str
) -> PropertyIterator<'a, T>where
    'name: 'a,

Get an iterator to receive owner changed events.

If the proxy destination is a unique name, the stream will be notified of the peer disconnection from the bus (with a None value).

If the proxy destination is a well-known name, the stream will be notified whenever the name owner is changed, either by a new peer being granted ownership (Some value) or when the name is released (with a None value).

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>

Get an iterator to receive property changed events.

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn inner(&self) -> &Proxy<'a>

Get a reference to the underlying async Proxy.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for AuthorityProxyBlocking<'c>

fn as_mut(&mut self) -> &mut Proxy<'c>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'c> AsRef<Proxy<'c>> for AuthorityProxyBlocking<'c>

fn as_ref(&self) -> &Proxy<'c>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'c> Clone for AuthorityProxyBlocking<'c>

fn clone(&self) -> AuthorityProxyBlocking<'c>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'c> Debug for AuthorityProxyBlocking<'c>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'c> Deref for AuthorityProxyBlocking<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'c> DerefMut for AuthorityProxyBlocking<'c>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'c> From<Proxy<'c>> for AuthorityProxyBlocking<'c>

fn from(proxy: Proxy<'c>) -> Self

Converts to this type from the input type.

impl<'a> ProxyDefault for AuthorityProxyBlocking<'a>

const INTERFACE: &'static str = _

const DESTINATION: &'static str = _

const PATH: &'static str = _

impl<'c> Serialize for AuthorityProxyBlocking<'c>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl<'c> Type for AuthorityProxyBlocking<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.