Struct NetCfgNodeProxy

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

Network Configuration Object

OpenVPN Documentation

Implementations

impl<'c> NetCfgNodeProxy<'c>

pub async fn new(conn: &Connection) -> Result<NetCfgNodeProxy<'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 add_dns(&self, server_list: &[&str]) -> Result<()>

AddDNS method

Specifies a array of DNS server addresses that should be added to the list of DNS server of the virtual interface.

Arguments

• server_list - An array of DNS server IP addresses.

pub async fn add_dnssearch(&self, domains: &[&str]) -> Result<()>

AddDNSSearch method

Specifies a array of DNS search domains that should be added to the list of DNS search to the network.

Arguments

• domains - An array of DNS domains.

pub async fn add_ipaddress( &self, ip_address: &str, prefix: u32, gateway: &str, ipv6: bool, ) -> Result<()>

AddIPAddress method

Adds a new local IP Address to the VPN configuration of the virtual interface.

Arguments

• ip_address - The IP address in string representation (e.g. 198.51.100.12 or 2001:db8::23).
• prefix - The prefix length (e.g. /24 or /64).
• gateway - The IP address in string representation of the remote gateway inside the VPN.
• ipv6 - Is the new IP address IPv6 or IPv4.

pub async fn add_networks( &self, networks: &[(&str, u32, bool, bool)], ) -> Result<()>

AddNetworks method

Specifies a array of networks that should be either routed over the VPN or explicitly not routed over the VPN. Conflicts between included and excluded are resolved in the usual longest-prefix matching fashion.

Arguments

• networks - An array or network tuples: 0. ip_address - The network IP address (the first IP in the network).
  1. prefix - The prefix of the network (e.g. /24 or /64).
  2. ipv6 - Is this a IPv6 or IPv4 network specification.
  3. exclude - If true, exclude (do not route) otherwise include (do route) this network over the VPN.

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

Destroy method

Removes the virtual interface and undoes the configuration (routes, DNS, tun device configuration). The calling application must close the tun device own its own.

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

Disable method

Indicates that the interface is temporarily not used by the VPN service. E.g. that the VPN connection is disconnected and currently reconnecting. Note: This is currently not implemented.

pub async fn enable_dco( &self, dev_name: &str, proto: OVPNProto, ) -> Result<DCONodeProxy<'c>>

EnableDCO method

Instantiates DCO device object, which handles DCO functionality.

Arguments

• dev_name - A name for net device to be created.
• proto - Transport protocol.

Returns

A unique D-Bus object path for DCO device.

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

Establish method

Uses all the information provided to the interface to setup a tun device and set routes, DNS and interface accordingly. The resulting tun device is returned to the caller.

Returns

• The file descriptor corresponding to the new tun device (Unix file descriptors that are passed are not in the D-Bus method signature).

pub async fn set_remote_address( &self, ip_address: &str, ipv6: bool, ) -> Result<()>

SetRemoteAddress method

Set the remote address of the VPN server. This is the address the VPN uses to connect to VPN server. This is used when creating direct routes to the VPN server to avoid routing loops (redirect gateway option).

Arguments

• ip_address - The IP address in string representation (e.g. 198.51.100.12 or 2001:db8::23).
• ipv6 - Is the new IP address IPv6 or IPv4.

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

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

pub async fn receive_network_change( &self, ) -> Result<NetworkChangeStream<'static>>

Create a stream that receives NetworkChange signals.

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

This signal indicates that something has changed in the systems network configuration. These signals will be tied to the interface which triggered this change.

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

Create a stream that receives NetworkChange signals.

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

This signal indicates that something has changed in the systems network configuration. These signals will be tied to the interface which triggered this change.

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

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 active(&self) -> Result<bool>

If the VPN is active (Establish has been successfully called)

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

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

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

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

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

Virtual device name used by the session. This may change if the interface needs to be completely reconfigured

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 dns_name_servers(&self) -> Result<Vec<String>>

List of DNS name servers pushed by the VPN server

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

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

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

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

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

dns_scope property

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

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

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

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

pub async fn set_dns_scope(&self, value: &str) -> Result<()>

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

dns_search_domains property

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

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

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

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

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

OSI layer for the VPN to use, 3 for IP (tun device). Setting to 2 (tap device) is currently not implemented.

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

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

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

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

pub async fn set_layer(&self, value: u32) -> Result<()>

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

Controls the log verbosity of messages intended to be proxied to the user front-end.

Note: Not currently implemented.

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

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

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

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

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

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

modified property

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

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

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

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

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

Sets the MTU for the tun device. Default is 1500.

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

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

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

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

pub async fn set_mtu(&self, value: u32) -> Result<()>

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

The UID value of the user which created the interface.

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 reroute_ipv4(&self) -> Result<bool>

Setting this to true, tells the service that the default route should be pointed to the VPN and that mechanism to avoid routing loops should be taken.

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

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

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

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

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

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

As reroute_ipv4 but for IPv6.

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

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

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

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

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

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

Set the TX queue length of the tun device. If set to 0 or unset, the default from the operating system is used instead.

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

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

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

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

pub async fn set_txqueuelen(&self, value: u32) -> Result<()>

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 NetCfgNodeProxy<'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 NetCfgNodeProxy<'c>

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

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

impl<'c> Clone for NetCfgNodeProxy<'c>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for NetCfgNodeProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for NetCfgNodeProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for NetCfgNodeProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for NetCfgNodeProxy<'a>

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

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

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

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

fn signature() -> Signature<'static>

Get the signature for the implementing type.