Struct SettingWireGuard 

pub struct SettingWireGuard { /* private fields */ }

Available on crate feature v1_16 only.

WireGuard Settings

Properties

fwmark

The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.

Note that “ip4-auto-default-route” or “ip6-auto-default-route” enabled, implies to automatically choose a fwmark.

Readable | Writeable

ip4-auto-default-route

Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls “Improved Rule-based Routing”.

Note that for this automatism to work, you usually don’t want to set ipv4.gateway, because that will result in a conflicting default route.

Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.

Readable | Writeable

ip6-auto-default-route

Like ip4-auto-default-route, but for the IPv6 default route.

Readable | Writeable

listen-port

The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.

Readable | Writeable

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

If zero a default MTU is used. Note that contrary to wg-quick’s MTU setting, this does not take into account the current routes at the time of activation.

Readable | Writeable

peer-routes

Whether to automatically add routes for the AllowedIPs ranges of the peers. If true (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If false, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.

Note that if the peer’s AllowedIPs is “0.0.0.0/0” or “::/0” and the profile’s ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won’t be added automatically.

Readable | Writeable

private-key

The 256 bit private-key in base64 encoding.

Readable | Writeable

private-key-flags

Flags indicating how to handle the #NMSettingWirelessSecurity:private-key property.

Readable | Writeable

Setting

name

The setting’s name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example “ppp” or “802-11-wireless” or “802-3-ethernet”.

Readable

Implements

SettingExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SettingWireGuard

pub fn new() -> SettingWireGuard

Creates a new #NMSettingWireGuard object with default values.

Returns

the new empty #NMSettingWireGuard object

pub fn builder() -> SettingWireGuardBuilder

Creates a new builder-pattern struct instance to construct SettingWireGuard objects.

This method returns an instance of SettingWireGuardBuilder which can be used to create SettingWireGuard objects.

pub fn append_peer(&self, peer: &WireGuardPeer)

If a peer with the same public-key already exists, that one is replaced by @peer. The new @peer is always appended (or moved to) the end, so in case a peer is replaced, the indexes are shifted and the number of peers stays unchanged.

peer

the #NMWireGuardPeer instance to append. This seals @peer and keeps a reference on the instance.

pub fn clear_peers(&self) -> u32

Returns

the number of cleared peers.

pub fn fwmark(&self) -> u32

Returns

the set firewall mark.

pub fn ip4_auto_default_route(&self) -> Ternary

Available on crate feature v1_20 only.

Returns

the “ip4-auto-default-route” property of the setting.

pub fn ip6_auto_default_route(&self) -> Ternary

Available on crate feature v1_20 only.

Returns

the “ip6-auto-default-route” property of the setting.

pub fn listen_port(&self) -> u16

Returns

the set UDP listen port.

pub fn mtu(&self) -> u32

Returns

the MTU of the setting.

pub fn peer(&self, idx: u32) -> WireGuardPeer

idx

the index to lookup.

Returns

the #NMWireGuardPeer entry at index @idx. If the index is out of range, None is returned.

pub fn peer_by_public_key( &self, public_key: &str, ) -> (Option<WireGuardPeer>, u32)

public_key

the public key for looking up the peer.

Returns

the #NMWireGuardPeer instance with a matching public key. If no such peer exists, None is returned.

out_idx

optional output argument for the index of the found peer. If no index is found, this is set to the nm_setting_wireguard_get_peers_len().

pub fn is_peer_routes(&self) -> bool

Returns

whether automatically add peer routes.

pub fn peers_len(&self) -> u32

Returns

the number of registered peers.

pub fn private_key(&self) -> GString

Returns

the set private-key or None.

pub fn private_key_flags(&self) -> SettingSecretFlags

Returns

the secret-flags for #NMSettingWireGuard:private-key.

pub fn remove_peer(&self, idx: u32) -> bool

idx

the index to remove.

Returns

true if @idx was in range and a peer was removed. Otherwise, @self is unchanged.

pub fn set_peer(&self, peer: &WireGuardPeer, idx: u32)

If @idx is one past the last peer, the behavior is the same as nm_setting_wireguard_append_peer(). Otherwise, the peer will be at @idx and replace the peer instance at that index. Note that if a peer with the same public-key exists on another index, then that peer will also be replaced. In that case, the number of peers will shrink by one (because the one at @idx got replace and then one with the same public-key got removed). This also means, that the resulting index afterwards may be one less than @idx (if another peer with a lower index was dropped).

peer

the #NMWireGuardPeer instance to set. This seals @peer and keeps a reference on the instance.

idx

the index, in the range of 0 to the number of peers (including). That means, if @idx is one past the end of the number of peers, this is the same as nm_setting_wireguard_append_peer(). Otherwise, the peer at this index is replaced.

pub fn set_fwmark(&self, fwmark: u32)

The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.

Note that “ip4-auto-default-route” or “ip6-auto-default-route” enabled, implies to automatically choose a fwmark.

pub fn set_ip4_auto_default_route(&self, ip4_auto_default_route: Ternary)

Available on crate feature v1_20 only.

Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls “Improved Rule-based Routing”.

Note that for this automatism to work, you usually don’t want to set ipv4.gateway, because that will result in a conflicting default route.

Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.

pub fn set_ip6_auto_default_route(&self, ip6_auto_default_route: Ternary)

Available on crate feature v1_20 only.

Like ip4-auto-default-route, but for the IPv6 default route.

pub fn set_listen_port(&self, listen_port: u32)

The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.

pub fn set_mtu(&self, mtu: u32)

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

If zero a default MTU is used. Note that contrary to wg-quick’s MTU setting, this does not take into account the current routes at the time of activation.

pub fn set_peer_routes(&self, peer_routes: bool)

Whether to automatically add routes for the AllowedIPs ranges of the peers. If true (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If false, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.

Note that if the peer’s AllowedIPs is “0.0.0.0/0” or “::/0” and the profile’s ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won’t be added automatically.

pub fn set_private_key(&self, private_key: Option<&str>)

The 256 bit private-key in base64 encoding.

pub fn set_private_key_flags(&self, private_key_flags: SettingSecretFlags)

Flags indicating how to handle the #NMSettingWirelessSecurity:private-key property.

pub fn connect_fwmark_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_ip4_auto_default_route_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_20 only.

pub fn connect_ip6_auto_default_route_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_20 only.

pub fn connect_listen_port_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_mtu_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_peer_routes_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_private_key_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_private_key_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for SettingWireGuard

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for SettingWireGuard

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

Formats the value using the given formatter.

impl Default for SettingWireGuard

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingWireGuard

type ParamSpec = ParamSpecObject

type SetValue = SettingWireGuard

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SettingWireGuard>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingWireGuard

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SettingWireGuard

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SettingWireGuard

type Parent = Setting

impl<OT: ObjectType> PartialEq<OT> for SettingWireGuard

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SettingWireGuard

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SettingWireGuard

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingWireGuard

impl IsA<Setting> for SettingWireGuard