Struct zbus_polkit::policykit1::AuthorityProxy

pub struct AuthorityProxy<'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> AuthorityProxy<'c>

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

Creates a new proxy with the default service and 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 async 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 async 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 async fn cancel_check_authorization( &self, cancellation_id: &str ) -> Result<()>

Cancels an authorization check.

Arguments

• cancellation_id - The cancellation_id passed to CheckAuthorization().

pub async 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 async 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 async fn enumerate_temporary_authorizations( &self, subject: &Subject ) -> Result<Vec<TemporaryAuthorization>>

Retrieves all temporary authorizations that applies to subject.

pub async 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 async 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 async fn revoke_temporary_authorization_by_id(&self, id: &str) -> Result<()>

Revokes all temporary authorizations that applies to id.

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

Revokes all temporary authorizations that applies to subject.

pub async 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 async fn receive_changed(&self) -> Result<ChangedStream<'static>>

Create a stream that receives Changed signals.

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

pub async 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 async fn receive_backend_features_changed( &self ) -> PropertyStream<'c, <Result<AuthorityFeatures> as ResultAdapter>::Ok>

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

pub async 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 async fn receive_backend_name_changed( &self ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async 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 async fn receive_backend_version_changed( &self ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the BackendVersion property changes. This is a convenient wrapper around zbus::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 async fn introspect(&self) -> impl Future<Output = Result<String, Error>>

Introspect the associated object, and return the XML description.

See the xml or quick_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>( &'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 async fn get_property<T>( &self, property_name: &str ) -> impl Future<Output = 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 (if caching is enabled) or call the Get method of the org.freedesktop.DBus.Properties interface.

pub async fn set_property<'t, T>( &self, property_name: &str, value: T ) -> impl Future<Output = 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 async fn call_method<'m, M, B>( &self, method_name: M, body: &B ) -> impl Future<Output = Result<Arc<Message>, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType,

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 async fn call<'m, M, B, R>( &self, method_name: M, body: &B ) -> impl Future<Output = Result<R, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType, R: DeserializeOwned + Type,

Call a method and return the reply body.

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

pub async fn call_with_flags<'m, M, B, R>( &self, method_name: M, flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>, body: &B ) -> impl Future<Output = Result<Option<R>, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType, R: DeserializeOwned + Type,

Call a method and return the reply body, optionally supplying a set of method flags to control the way the method call message is sent and handled.

Use call instead if you do not need any special handling via additional flags. If the NoReplyExpected flag is passed , this will return None immediately after sending the message, similar to call_noreply

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

Call a method without expecting a reply

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

pub async fn receive_signal<'m, M>( &self, signal_name: M ) -> impl Future<Output = Result<SignalStream<'m>, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

pub async fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)] ) -> impl Future<Output = Result<SignalStream<'m>, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Same as Proxy::receive_signal but with a filter.

The D-Bus specification allows you to filter signals by their arguments, which helps avoid a lot of unnecessary traffic and processing since the filter is run on the server side. Use this method where possible. Note that this filtering is limited to arguments of string types.

The arguments are passed as a tuples of argument index and expected value.

pub async fn receive_all_signals( &self ) -> impl Future<Output = Result<SignalStream<'static>, Error>>

Create a stream for all signals emitted by this service.

pub async fn receive_property_changed<'name, T>( &self, name: &'name str ) -> impl Future<Output = PropertyStream<'a, T>>where 'name: 'a,

Get a stream 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.

If caching is not enabled on this proxy, the resulting stream will not return any events.

pub async fn receive_owner_changed( &self ) -> impl Future<Output = Result<OwnerChangedStream<'_>, Error>>

Get a stream to receive destination 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.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for AuthorityProxy<'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 AuthorityProxy<'c>

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

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

impl<'c> Clone for AuthorityProxy<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for AuthorityProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for AuthorityProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for AuthorityProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for AuthorityProxy<'a>

const INTERFACE: &'static str = _

const DESTINATION: &'static str = _

const PATH: &'static str = _

impl<'c> Serialize for AuthorityProxy<'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 AuthorityProxy<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.