Struct SessionsNodeProxy

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

Session Object

OpenVPN Documentation

Implementations

impl<'c> SessionsNodeProxy<'c>

pub async fn new(conn: &Connection) -> Result<SessionsNodeProxy<'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 access_grant(&self, uid: u32) -> Result<()>

AccessGrant method

By default, only the user ID (UID) who created the session have access to it. This method used to grant other users access to this session.

Arguments

• uid - The UID to the user account which is granted access;

pub async fn access_revoke(&self, uid: u32) -> Result<()>

AccessRevoke method

This revokes access to a session object for a specific user. Please note that the owner (the user which initiated this session) cannot have its access revoked.

Arguments

• uid - The UID to the user account which gets the access revoked.

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

Connect method

This method starts the connection process. This requires that all credentials needed before contacting the server have been provided. It is always a good idea to first call the net.openvpn.v3.sessions.Ready method first to ensure the backend is ready to connect.

Examples found in repository

examples/basic.rs (line 98)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

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

Disconnect method

Disconnects a VPN connection. This will shutdown and stop the VPN backend process and the session object will be removed.

Examples found in repository

examples/basic.rs (line 102)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

pub async fn log_forward(&self, enable: bool) -> Result<()>

LogForward method

This enables log forwarding from the session to the currently connected D-Bus client. The forwarding itself is sent by the net.openvpn.v3.log service.

Arguments

• enable - Enables or disables the log forwarding.

pub async fn pause(&self, reason: &str) -> Result<()>

Pause method

This method pauses an on-going VPN connection.

Arguments

• reason - A string used for log purposes primarily, describing why the tunnel was paused.

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

Ready method

This method is to check if the backend VPN client is ready to connect. If it is ready, it will return immediately. If it is not, it will return with a D-Bus error exception providing the reason it is not ready. Most commonly it needs some input from the user, such as user credentials or some challenge token not already provided in the configuration.

Examples found in repository

examples/basic.rs (line 55)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

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

Restart method

Completely disconnects and reconnects an active VPN connection.

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

Resume method

Resumes a paused VPN connection.

pub async fn user_input_provide( &self, type_: ClientAttentionType, group: ClientAttentionGroup, id: u32, value: &str, ) -> Result<()>

UserInputProvide method

This method is used to return information from the front-end application to the backend service.

Arguments

• type_ - ClientAttentionType reference to query for.
• group - ClientAttentionGroup reference to query for.
• id - Request ID to query for, provided by UserInputQueueCheck().
• value - The frontend’s response to the backend.

Examples found in repository

examples/basic.rs (line 77)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

pub async fn user_input_queue_check( &self, type_: ClientAttentionType, group: ClientAttentionGroup, ) -> Result<Vec<u32>>

UserInputQueueCheck method

This is used to get the proper index values of information requests the backend has asked for and which is not yet satisfied. The index list is tied to a specific (ClientAttentionType, ClientAttentionGroup) tuple.

Arguments

• type_ - ClientAttentionType reference to query for.
• group - ClientAttentionGroup reference to query for.

Returns

An array of indexes which needs to be provided.

Examples found in repository

examples/basic.rs (line 64)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

pub async fn user_input_queue_fetch( &self, type_: ClientAttentionType, group: ClientAttentionGroup, id: u32, ) -> Result<(ClientAttentionType, ClientAttentionGroup, u32, String, String, bool)>

UserInputQueueFetch method

This method returns details about a specific information request from the backend process.

Arguments

• type_ - ClientAttentionType reference to query for.
• group - ClientAttentionGroup reference to query for.
• id - Request ID to query for, provided by UserInputQueueCheck().

Returns

A tuple consisting of:

0. type - ClientAttentionType reference.
1. group - ClientAttentionGroup reference.
2. id - Request ID.
3. name - An internal variable name.
4. description - A description to present to the front-end user.
5. hidden_input - If true, the user’s input should be masked/hidden.

Examples found in repository

examples/basic.rs (line 71)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

pub async fn user_input_queue_get_type_group( &self, ) -> Result<Vec<UserInputQueueTypeGroup>>

UserInputQueueGetTypeGroup method

This will return information about various ClientAttentionType and ClientAttentionGroup tuples which contains requests for the front-end application. This information is used when checking the request queue via UserInputQueueCheck().

Returns

An array of tuples of (ClientAttentionType, ClientAttentionGroup).

Examples found in repository

examples/basic.rs (line 60)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

pub async fn receive_attention_required( &self, ) -> Result<AttentionRequiredStream<'static>>

Create a stream that receives AttentionRequired signals.

This a convenient wrapper around zbus::Proxy::receive_signal. AttentionRequired signal

This signal is issued whenever the backend needs information, most commonly from the front-end user interface. This can be used to get user credentials or do PKCS#11/SmartCard operations, etc.

See AttentionRequiredArgs.

pub async fn receive_attention_required_with_args( &self, args: &[(u8, &str)], ) -> Result<AttentionRequiredStream<'static>>

Create a stream that receives AttentionRequired signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. AttentionRequired signal

This signal is issued whenever the backend needs information, most commonly from the front-end user interface. This can be used to get user credentials or do PKCS#11/SmartCard operations, etc.

See AttentionRequiredArgs.

pub async fn receive_log(&self) -> Result<LogStream<'static>>

Create a stream that receives Log signals.

This a convenient wrapper around zbus::Proxy::receive_signal. Log signal

See LogArgs.

pub async fn receive_log_with_args( &self, args: &[(u8, &str)], ) -> Result<LogStream<'static>>

Create a stream that receives Log signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. Log signal

See LogArgs.

pub async fn receive_status_change(&self) -> Result<StatusChangeStream<'static>>

Create a stream that receives StatusChange signals.

This a convenient wrapper around zbus::Proxy::receive_signal. StatusChange signal

This signal is issued each time specific events occurs. They can both be from the session object itself or StatusChange messages proxied from the VPN client backend process.

See StatusChangeArgs.

pub async fn receive_status_change_with_args( &self, args: &[(u8, &str)], ) -> Result<StatusChangeStream<'static>>

Create a stream that receives StatusChange signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. StatusChange signal

This signal is issued each time specific events occurs. They can both be from the session object itself or StatusChange messages proxied from the VPN client backend process.

See StatusChangeArgs.

pub async fn acl(&self) -> Result<Vec<u32>>

acl property

An array of UID values granted access.

pub fn cached_acl( &self, ) -> Result<Option<<Result<Vec<u32>> as ResultAdapter>::Ok>, <Result<Vec<u32>> as ResultAdapter>::Err>

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

pub async fn receive_acl_changed( &self, ) -> PropertyStream<'c, <Result<Vec<u32>> as ResultAdapter>::Ok>

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

pub async fn backend_pid(&self) -> Result<u32>

backend_pid property

Process ID of the VPN backend client process.

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

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

pub async fn receive_backend_pid_changed( &self, ) -> PropertyStream<'c, <Result<u32> as ResultAdapter>::Ok>

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

pub async fn config_name(&self) -> Result<String>

config_name property

Name of the configuration profile when the session was started.

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

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

pub async fn receive_config_name_changed( &self, ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async fn config_path(&self) -> Result<OwnedObjectPath>

config_path property

D-Bus object path to the configuration profile used.

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

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

pub async fn receive_config_path_changed( &self, ) -> PropertyStream<'c, <Result<OwnedObjectPath> as ResultAdapter>::Ok>

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

pub async fn dco(&self) -> Result<bool>

dco property

Kernel based Data Channel Offload flag. Must be modified before calling Connect() to override the current setting.

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

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

pub async fn receive_dco_changed( &self, ) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

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

pub async fn set_dco(&self, value: bool) -> Result<()>

pub async fn device_name(&self) -> Result<String>

device_name property

Virtual network interface name used by this session.

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

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

pub async fn receive_device_name_changed( &self, ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async fn device_path(&self) -> Result<String>

device_path property

D-Bus object path to the net.openvpn.v3.netcfg device object related to this session.

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

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

pub async fn receive_device_path_changed( &self, ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async fn last_log(&self) -> Result<Log>

last_log property

Contains the last Log signal proxied from the backend process.

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

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

pub async fn receive_last_log_changed( &self, ) -> PropertyStream<'c, <Result<Log> as ResultAdapter>::Ok>

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

pub async fn log_forwards(&self) -> Result<Vec<OwnedObjectPath>>

log_forwards property

Log Proxy/forward object paths used by net.openvpn.v3.log to configure the forwarding.

pub fn cached_log_forwards( &self, ) -> Result<Option<<Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Err>

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

pub async fn receive_log_forwards_changed( &self, ) -> PropertyStream<'c, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>

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

pub async fn log_verbosity(&self) -> Result<LogLevel>

log_verbosity property

Defines the minimum log level Log signals should have to be sent.

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

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

pub async fn receive_log_verbosity_changed( &self, ) -> PropertyStream<'c, <Result<LogLevel> as ResultAdapter>::Ok>

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

pub async fn set_log_verbosity(&self, value: LogLevel) -> Result<()>

pub async fn owner(&self) -> Result<u32>

owner property

The UID value of the user which did the import.

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

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

pub async fn receive_owner_changed( &self, ) -> PropertyStream<'c, <Result<u32> as ResultAdapter>::Ok>

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

pub async fn public_access(&self) -> Result<bool>

public_access property

If set to true, access control is disabled. Only owner may change this property, modify the ACL or delete the configuration.

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

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

pub async fn receive_public_access_changed( &self, ) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

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

pub async fn set_public_access(&self, value: bool) -> Result<()>

pub async fn restrict_log_access(&self) -> Result<bool>

restrict_log_access property

If set to true, only the session owner can modify receive_log_events and log_verbosity, otherwise all granted users can access the log settings.

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

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

pub async fn receive_restrict_log_access_changed( &self, ) -> PropertyStream<'c, <Result<bool> as ResultAdapter>::Ok>

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

pub async fn set_restrict_log_access(&self, value: bool) -> Result<()>

pub async fn session_created(&self) -> Result<u64>

session_created property

Unix Epoc timestamp of when the session was created.

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

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

pub async fn receive_session_created_changed( &self, ) -> PropertyStream<'c, <Result<u64> as ResultAdapter>::Ok>

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

pub async fn session_name(&self) -> Result<String>

session_name property

Name of the VPN session, named by the the OpenVPN 3 Core library on successful connect.

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

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

pub async fn receive_session_name_changed( &self, ) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>

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

pub async fn statistics(&self) -> Result<Statistics>

statistics property

Contains tunnel statistics.

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

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

pub async fn receive_statistics_changed( &self, ) -> PropertyStream<'c, <Result<Statistics> as ResultAdapter>::Ok>

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

pub async fn status(&self) -> Result<Status>

status property

Contains the last processed StatusChange signal.

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

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

pub async fn receive_status_changed( &self, ) -> PropertyStream<'c, <Result<Status> as ResultAdapter>::Ok>

Create a stream for the status 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.

Examples found in repository

examples/basic.rs (line 50)

fn main() {
    task::block_on(async {
        let connection = zbus::Connection::system().await.unwrap();
        let config_manager = openvpn3_rs::ConfigurationProxy::new(&connection)
            .await
            .unwrap();
        let config = config_manager
            .import("My VPN", CONFIG_STR, true, false)
            .await
            .unwrap();

        let sessions_manager = openvpn3_rs::SessionsProxy::new(&connection).await.unwrap();
        let session = sessions_manager.new_tunnel(&config.path()).await.unwrap();

        let mut ready = false;
        while !ready {
            // If the session is ready, the `ready()` method will return Ok(), otherwise an error will be returned with more details.
            if let Err(err) = session.ready().await {
                let err_str = err.to_string();
                if err_str.contains("Missing user credentials") {
                    // This loop queries the session for which credentials are needed. This example covers username/password authentication.

                    let ui_type_group = session.user_input_queue_get_type_group().await.unwrap();

                    for (ca_type, ca_group) in ui_type_group {
                        let ui_queue_ids = session
                            .user_input_queue_check(ca_type, ca_group)
                            .await
                            .unwrap();

                        for id in ui_queue_ids {
                            let (ca_type, ca_group, id, name, _description, _hidden_input) =
                                session
                                    .user_input_queue_fetch(ca_type, ca_group, id)
                                    .await
                                    .unwrap();

                            if name == "username" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "smith")
                                    .await
                                    .unwrap();
                            }

                            if name == "password" {
                                session
                                    .user_input_provide(ca_type, ca_group, id, "hunter2")
                                    .await
                                    .unwrap();
                            }
                        }
                    }
                } else if err_str.contains("Backend VPN process is not ready") {
                    task::sleep(std::time::Duration::from_secs(1)).await;
                }
            } else {
                ready = true;
            }
        }

        session.connect().await.unwrap();

        // wait for signal to disconnect

        session.disconnect().await.unwrap();
    });
}

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

Get a reference to the interface.

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.

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) -> 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, ) -> 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, ) -> 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, ) -> 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>, 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

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.

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.

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.

pub async fn receive_all_signals(&self) -> 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, ) -> 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, ) -> 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 SessionsNodeProxy<'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 SessionsNodeProxy<'c>

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

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

impl<'c> Clone for SessionsNodeProxy<'c>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for SessionsNodeProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for SessionsNodeProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for SessionsNodeProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for SessionsNodeProxy<'a>

const INTERFACE: &'static str = "net.openvpn.v3.sessions"

const DESTINATION: &'static str = "net.openvpn.v3.sessions"

const PATH: &'static str = "/net/openvpn/v3/sessions"

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

fn signature() -> Signature<'static>

Get the signature for the implementing type.