mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-14 20:18:39 +00:00
cc924d8bab
There are three additions to the D-Bus interface for VPN plugins as part of this patch: 1) ConnectInteractive(): called by NM instead of Connect() to let the plugin know that it can request additional secrets during the connection process using SecretsRequired 2) SecretsRequired: a new signal emitted by the plugin to indicate to NetworkManager that additional secrets are required to connect; can only be called if NetworkManager initiated the connection by calling the ConnectInteractive() method 3) NewSecrets(): a new method of the plugin that NetworkManager calls when new secrets requested by the SecretsRequired signal have been retrieved from secret agents We need new methods because agents need to be aware of the hints that the VPN plugins may send with the SecretsRequired signal (detailing the specific secrets that are required) and at this time, not all agents support passing those hints to the VPN plugin authentication dialogs.
272 lines
10 KiB
XML
272 lines
10 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
|
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
|
<interface name="org.freedesktop.NetworkManager.VPN.Plugin">
|
|
<tp:docstring>
|
|
This interface is provided by plugins providing VPN services to the NetworkManager daemon.
|
|
</tp:docstring>
|
|
|
|
<method name="Connect">
|
|
<tp:docstring>
|
|
Tells the plugin to connect. Interactive secrets requests (eg, emitting
|
|
the SecretsRequired signal) are not allowed.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/>
|
|
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
|
|
<tp:docstring>
|
|
Describes the connection to be established.
|
|
</tp:docstring>
|
|
</arg>
|
|
<tp:possible-errors>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/>
|
|
</tp:possible-errors>
|
|
</method>
|
|
|
|
<method name="ConnectInteractive">
|
|
<tp:docstring>
|
|
Tells the plugin to connect, allowing interactive secrets requests (eg
|
|
the plugin is allowed to emit the SecretsRequired signal if the VPN
|
|
service indicates that it needs additional secrets during the connect
|
|
process).
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect_interactive"/>
|
|
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
|
|
<tp:docstring>
|
|
Describes the connection to be established.
|
|
</tp:docstring>
|
|
</arg>
|
|
<arg name="details" type="a{sv}" direction="in" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
Additional details about the Connect process.
|
|
</tp:docstring>
|
|
</arg>
|
|
<tp:possible-errors>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/>
|
|
</tp:possible-errors>
|
|
</method>
|
|
|
|
<method name="NeedSecrets">
|
|
<tp:docstring>
|
|
Asks the plugin whether the provided connection will require secrets to connect successfully.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/>
|
|
<arg name="settings" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
|
|
<tp:docstring>
|
|
Describes the connection that may need secrets.
|
|
</tp:docstring>
|
|
</arg>
|
|
<arg name="setting_name" type="s" direction="out">
|
|
<tp:docstring>
|
|
The setting name within the provided connection that requires secrets, if any.
|
|
</tp:docstring>
|
|
</arg>
|
|
<tp:possible-errors>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/>
|
|
</tp:possible-errors>
|
|
</method>
|
|
|
|
<method name="Disconnect">
|
|
<tp:docstring>
|
|
Disconnect the plugin.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/>
|
|
<tp:possible-errors>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"/>
|
|
</tp:possible-errors>
|
|
</method>
|
|
|
|
<method name="SetConfig">
|
|
<tp:docstring>
|
|
Set generic connection details on the connection.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_config"/>
|
|
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
Generic configuration details for the connection.
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="SetIp4Config">
|
|
<tp:docstring>
|
|
Set IPv4 details on the connection.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/>
|
|
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
Ip4Config details for the connection. You must call
|
|
SetConfig() before calling this.
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="SetIp6Config">
|
|
<tp:docstring>
|
|
Set IPv6 details on the connection.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip6_config"/>
|
|
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
Ip6Config details for the connection. You must call
|
|
SetConfig() before calling this.
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="SetFailure">
|
|
<tp:docstring>
|
|
Indicate a failure to the plugin.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/>
|
|
<arg name="reason" type="s" direction="in">
|
|
<tp:docstring>
|
|
The reason for the failure.
|
|
</tp:docstring>
|
|
</arg>
|
|
</method>
|
|
|
|
<property name="State" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
|
|
<tp:docstring>
|
|
The state of the plugin.
|
|
</tp:docstring>
|
|
</property>
|
|
|
|
<signal name="StateChanged">
|
|
<tp:docstring>
|
|
Emitted when the plugin state changes.
|
|
</tp:docstring>
|
|
<arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
|
|
<tp:docstring>
|
|
The new state of the plugin.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="SecretsRequired">
|
|
<tp:docstring>
|
|
Emitted during an ongoing ConnectInteractive() request when the plugin
|
|
has determined that new secrets are required. NetworkManager will then
|
|
call the NewSecrets() method with a connection hash including the new
|
|
secrets.
|
|
</tp:docstring>
|
|
<arg name="message" type="s" direction="out">
|
|
<tp:docstring>
|
|
Informational message, if any, about the request. For example, if
|
|
a second PIN is required, could indicate to the user to wait for
|
|
the token code to change until entering the next PIN.
|
|
</tp:docstring>
|
|
</arg>
|
|
<arg name="secrets" type="as" direction="out">
|
|
<tp:docstring>
|
|
Array of strings of VPN secret names which the plugin thinks
|
|
secrets may be required for, or other VPN-specific data to be
|
|
processed by the VPN's front-end.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<method name="NewSecrets">
|
|
<tp:docstring>
|
|
Called in response to a SecretsRequired signal to deliver updated secrets
|
|
or other information to the plugin.
|
|
</tp:docstring>
|
|
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_new_secrets"/>
|
|
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
|
|
<tp:docstring>
|
|
Describes the connection including the new secrets.
|
|
</tp:docstring>
|
|
</arg>
|
|
<tp:possible-errors>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/>
|
|
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/>
|
|
</tp:possible-errors>
|
|
</method>
|
|
|
|
<signal name="Config">
|
|
<tp:docstring>
|
|
The plugin obtained generic configuration information.
|
|
</tp:docstring>
|
|
<arg name="config" type="a{sv}" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
The configuration information.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="Ip4Config">
|
|
<tp:docstring>
|
|
The plugin obtained an IPv4 configuration.
|
|
</tp:docstring>
|
|
<arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
The IPv4 configuration.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="Ip6Config">
|
|
<tp:docstring>
|
|
The plugin obtained an IPv6 configuration.
|
|
</tp:docstring>
|
|
<arg name="ip6config" type="a{sv}" tp:type="String_Variant_Map">
|
|
<tp:docstring>
|
|
The IPv6 configuration.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="LoginBanner">
|
|
<tp:docstring>
|
|
Emitted when the plugin receives a login banner from the VPN service.
|
|
</tp:docstring>
|
|
<arg name="banner" type="s">
|
|
<tp:docstring>
|
|
The login banner string.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="Failure">
|
|
<tp:docstring>
|
|
Emitted when a failure in the VPN plugin occurs.
|
|
</tp:docstring>
|
|
<arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE">
|
|
<tp:docstring>
|
|
Reason code for the failure.
|
|
</tp:docstring>
|
|
</arg>
|
|
</signal>
|
|
|
|
<tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u">
|
|
<tp:enumvalue suffix="LOGIN_FAILED" value="0">
|
|
<tp:docstring>
|
|
Login failed.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="CONNECT_FAILED" value="1">
|
|
<tp:docstring>
|
|
Connect failed.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
<tp:enumvalue suffix="BAD_IP_CONFIG" value="2">
|
|
<tp:docstring>
|
|
Invalid IP configuration returned from the VPN plugin.
|
|
</tp:docstring>
|
|
</tp:enumvalue>
|
|
</tp:enum>
|
|
|
|
</interface>
|
|
</node>
|