Class: Nl::Linux::Wireguard::AsyncOperations

Inherits:
Object
  • Object
show all
Defined in:
nl-linux/generated/nl/linux/wireguard.rb

Instance Method Summary collapse

Instance Method Details

#do_set_device(**args) ⇒ Nl::Async::Future<void>

Set WireGuard device


This command should be called with a wgdevice set, containing one but
not both of ``WGDEVICE_A_IFINDEX`` and ``WGDEVICE_A_IFNAME``.

It is possible that the amount of configuration data exceeds that of the
maximum message length accepted by the kernel. In that case, several
messages should be sent one after another, with each successive one
filling in information not contained in the prior. Note that if
``WGDEVICE_F_REPLACE_PEERS`` is specified in the first message, it
probably should not be specified in fragments that come after, so that
the list of peers is only cleared the first time but appended after.
Likewise for peers, if ``WGPEER_F_REPLACE_ALLOWEDIPS`` is specified in
the first message of a peer, it likely should not be specified in
subsequent fragments.

If an error occurs, ``NLMSG_ERROR`` will reply containing an errno.


Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer)
  • ifname (String)
  • private_key (String) —

    Set to all zeros to remove.

  • public_key (String)
  • flags (Integer) —

    0 or WGDEVICE_F_REPLACE_PEERS if all current peers should be removed prior to adding the list below.

    Known flags are defined in Flags::WgdeviceFlags.

  • listen_port (Integer) —

    Set as 0 to choose randomly.

  • fwmark (Integer) —

    Set as 0 to disable.

  • peers (Array<AttributeSets::Wgpeer, Hash<Symbol, Object>>) —

    The index/type parameter is unused on SET_DEVICE operations and is zero on GET_DEVICE operations.

Returns:

See Also:



846
847
848
 
# File 'nl-linux/generated/nl/linux/wireguard.rb', line 846

def do_set_device(**args)
  @exchange.call(:"do", Messages::DoSetDeviceRequest, nil, args)
end

#dump_get_device(**args) ⇒ Nl::Async::Stream<Messages::DumpGetDeviceReply>

Retrieve WireGuard device


The command should be called with one but not both of:

- ``WGDEVICE_A_IFINDEX``
- ``WGDEVICE_A_IFNAME``

The kernel will then return several messages (``NLM_F_MULTI``). It is
possible that all of the allowed IPs of a single peer will not fit
within a single netlink message. In that case, the same peer will be
written in the following message, except it will only contain
``WGPEER_A_PUBLIC_KEY`` and ``WGPEER_A_ALLOWEDIPS``. This may occur
several times in a row for the same peer. It is then up to the receiver
to coalesce adjacent peers. Likewise, it is possible that all peers will
not fit within a single message. So, subsequent peers will be sent in
following messages, except those will only contain ``WGDEVICE_A_IFNAME``
and ``WGDEVICE_A_PEERS``. It is then up to the receiver to coalesce
these messages to form the complete list of peers.

Since this is an ``NLA_F_DUMP`` command, the final message will always
be ``NLMSG_DONE``, even if an error occurs. However, this ``NLMSG_DONE``
message contains an integer error code. It is either zero or a negative
error code corresponding to the errno.


Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • ifindex (Integer)
  • ifname (String)

Returns:

See Also:



805
806
807
 
# File 'nl-linux/generated/nl/linux/wireguard.rb', line 805

def dump_get_device(**args)
  @exchange.call(:"dump", Messages::DumpGetDeviceRequest, Messages::DumpGetDeviceReply, args)
end