Struct NetCfgProxy

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

Network Configuration Service

OpenVPN Documentation

Implementations

impl<'c> NetCfgProxy<'c>

pub async fn new(conn: &Connection) -> Result<NetCfgProxy<'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 cleanup(&self) -> Result<()>

Cleanup method

This method will remove/cleanup any resources still held by the calling PID.

pub async fn create_virtual_interface( &self, device_name: &str, ) -> Result<NetCfgNodeProxy<'c>>

CreateVirtualInterface method

Create a virtual interface and return the object path of the new interface.

Arguments

• device_name - A user friendly name for the device, will be part of device_path.

Returns

A unique D-Bus object path for create device.

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

DcoAvailable method

This method is called by the VPN client backend to check if the DCO kernel module is available. It it called by through the tun_builder interface, to query the status during instantiation of the transport used to establish the tunnel.

Returns

True if the DCO kernel module is available and loadable.

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

FetchInterfaceList method

This method will return an array of object paths to virtual interfaces the caller is granted access to.

Returns

An array of object paths to accessible virtual interfaces.

pub async fn notification_subscribe( &self, filter: BitFlags<NetCfgChangeType>, ) -> Result<()>

NotificationSubscribe method

A service which wants to respond to various network change activities triggered by OpenVPN can subscribe to the net.openvpn.v3.netcfg.NetworkChange signal. Such subscriptions are handled by calling this method.

Arguments

filter - A filter mask defining which NetworkChange events to subscribe to. Valid values are 1 to 2047.

pub async fn notification_subscriber_list( &self, ) -> Result<Vec<(String, BitFlags<NetCfgChangeType>)>>

NotificationSubscriberList method

Retrieves a list of all active subscriptions together with their filter mask.

This method is restricted to the root user.

Returns

An array of tuples with the subscribers unique D-Bus name and the attached filter mask.

pub async fn notification_unsubscribe( &self, optional_subscriber: &str, ) -> Result<()>

NotificationUnsubscribe method

Any services who has subscribed to NetworkChange signals must unsubscribe before disconnecting from the D-Bus. This is done by calling this method.

The subscriber argument this method needs should always be an empty string. Processes running as root can send the the unique D-Bus name to forcefully unsubscribe a specific subscription.

Arguments

• optional_subscriber - This should be empty for non-root users. Must otherwise contain a valid unique D-Bus name.

pub async fn protect_socket( &self, remote: &str, ipv6: bool, device_path: &ObjectPath<'_>, ) -> Result<bool>

ProtectSocket method

This method is called by the service client to signal that a socket needs to be protected from being routed over the VPN to avoid routing loops. The method of how this is actually implemented can be controlled by command line arguments to the netcfg service process.

Arguments

• File descriptor of the socket to protect (Unix file descriptors that are passed are not in the D-Bus method signature). Only the first provided fd is being processed.
• remote- The remote host this socket is connected to.
• ipv6- ?
• device_path- If an tun device is already opened, ignore routes from this device

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

Whenever the network configuration service needs to log something, it issues a Log signal which carries a log group, log verbosity level and a string with the log message itself.

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

Whenever the network configuration service needs to log something, it issues a Log signal which carries a log group, log verbosity level and a string with the log message itself.

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

Filename of the config file netcfg has parsed at start-up.

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

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

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

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

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

DNS search domains in used, pushed from all VPN sessions.

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

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

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

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

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

DNS servers in use, pushed from all VPN sessions.

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

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

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

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

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

Controls the log verbosity of messages intended to be proxied to the user frontend.

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

Version information about the running service.

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

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

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

Create a stream for the version 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 NetCfgProxy<'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 NetCfgProxy<'c>

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

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

impl<'c> Clone for NetCfgProxy<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for NetCfgProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for NetCfgProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for NetCfgProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for NetCfgProxy<'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 NetCfgProxy<'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 NetCfgProxy<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.