Struct DCONodeProxy

Source

pub struct DCONodeProxy<'c>(/* private fields */);

Implementations§

Source §

impl<'c> DCONodeProxy<'c>

Source

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

Creates a new proxy with the default service and path.

Source

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

Returns a customizable builder for this proxy.

Source

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

Consumes self, returning the underlying zbus::Proxy.

Source

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

The reference to the underlying zbus::Proxy.

Source

pub async fn new_peer( &self, peer_id: u32, sa: &str, salen: u32, vpn4: &str, vpn6: &str, ) -> Result<()>

NewPeer method

Creates a new peer in the ovpn-dco kernel module. The client is expected to create a socket, establish the connection and pass the remote end-point along with additional properties to this method.

Source

pub async fn get_pipe_fd(&self) -> Result<()>

GetPipeFD method

Returns file descriptor used for bidirection generic netlink-based communication with ovpn-dco kernel module.

Source

pub async fn new_key(&self, key_slot: u32, key_config: &str) -> Result<()>

NewKey method

Pass a new symmetric encryption key, along with the cipher to use and its NONCE (if needed). This is used when encrypting and decrypting the tunneled network traffic.

Source

pub async fn swap_keys(&self, peer_id: u32) -> Result<()>

SwapKeys method

Swaps the primary and secondary encryption keys used by the data channel for the tunnelled network traffic. This call triggers instructs ovpn-dco to perform this swap in kernel memory. This is used to rotate and add new symmetric encryption keys during the lifetime of a VPN session. See the OpenVPN documentation related to key renegotiation options for more details.

Source

pub async fn set_peer( &self, peer_id: u32, keepalive_interval: u32, keepalive_timeout: u32, ) -> Result<()>

SetPeer method

Set peer properties in the ovpn-dco kernel module.

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

Source

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

Source

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

Get a reference to the destination service name.

Source

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

Get a reference to the object path.

Examples found in repository ?

examples/basic.rs (line 50)

38fn main() {
39    task::block_on(async {
40        let connection = zbus::Connection::system().await.unwrap();
41        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
42            .await
43            .unwrap();
44        let config = config_manager
45            .import("My VPN", CONFIG_STR, true, false)
46            .await
47            .unwrap();
48
49        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
50        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();
51
52        let mut ready = false;
53        while !ready {
54            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
55            if let Err(err) = session.ready().await {
56                let err_str = err.to_string();
57                if err_str.contains("Missing user credentials") {
58                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.
59
60                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();
61
62                    for (ca_type, ca_group) in ui_type_group {
63                        let ui_queue_ids = session
64                            .user_input_queue_check(ca_type, ca_group)
65                            .await
66                            .unwrap();
67
68                        for id in ui_queue_ids {
69                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
70                                session
71                                    .user_input_queue_fetch(ca_type, ca_group, id)
72                                    .await
73                                    .unwrap();
74
75                            if name == "username" {
76                                session
77                                    .user_input_provide(ca_type, ca_group, id, "smith")
78                                    .await
79                                    .unwrap();
80                            }
81
82                            if name == "password" {
83                                session
84                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
85                                    .await
86                                    .unwrap();
87                            }
88                        }
89                    }
90                } else if err_str.contains("Backend VPN process is not ready") {
91                    task::sleep(std::time::Duration::from_secs(1)).await;
92                }
93            } else {
94                ready = true;
95            }
96        }
97
98        session.connect().await.unwrap();
99
100        // wait for signal to disconnect
101
102        session.disconnect().await.unwrap();
103    });
104}

Source

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

Get a reference to the interface.

Source

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

Introspect the associated object, and return the XML description.

See the xml or quick_xml module for parsing the result.

Source

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.

Source

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.

Source

pub async 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 (if caching is enabled) or call the Get method of the org.freedesktop.DBus.Properties interface.

Source

pub async 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.

Source

pub async fn call_method<'m, M, B>( &self, method_name: M, body: &B, ) -> 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).

Source

pub async fn call<'m, M, B, R>( &self, method_name: M, body: &B, ) -> 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.

Source

pub async fn call_with_flags<'m, M, B, R>( &self, method_name: M, flags: BitFlags<MethodFlags>, body: &B, ) -> 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

Source

pub async fn call_noreply<'m, M, B>( &self, method_name: M, body: &B, ) -> 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.

Source

pub async fn receive_signal<'m, M>( &self, signal_name: M, ) -> 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.

Source

pub async fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> 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.

Source

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

Create a stream for all signals emitted by this service.

Source

pub async fn receive_property_changed<'name, T>( &self, name: &'name str, ) -> 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.

Source

pub async fn receive_owner_changed( &self, ) -> 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.