|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
<node name="/">
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
org.freedesktop.NetworkManager.SecretAgent:
|
|
Packit Service |
b23acc |
@short_description: User Secret Agent
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
Private D-Bus interface used by secret agents that store and provide
|
|
Packit Service |
b23acc |
secrets to NetworkManager. If an agent provides secrets to NetworkManager
|
|
Packit Service |
b23acc |
as part of connection creation, and the some of those secrets are "agent
|
|
Packit Service |
b23acc |
owned" the agent should store those secrets itself and should not expect
|
|
Packit Service |
b23acc |
its SaveSecrets() method to be called. SaveSecrets() will be called eg if
|
|
Packit Service |
b23acc |
some program other than the agent itself (like a connection editor)
|
|
Packit Service |
b23acc |
changes the secrets out of band. The agent should implement this D-Bus
|
|
Packit Service |
b23acc |
interface on an object with the path
|
|
Packit Service |
b23acc |
/org/freedesktop/NetworkManager/SecretAgent.
|
|
Packit Service |
b23acc |
-->
|
|
Packit Service |
b23acc |
<interface name="org.freedesktop.NetworkManager.SecretAgent">
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
GetSecrets:
|
|
Packit Service |
b23acc |
@connection: Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.
|
|
Packit Service |
b23acc |
@connection_path: Object path of the connection for which secrets are being requested.
|
|
Packit Service |
b23acc |
@setting_name: Setting name for which secrets are being requested.
|
|
Packit Service |
b23acc |
@hints: Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".
|
|
Packit Service |
b23acc |
@flags: (<link linkend="NMSecretAgentGetSecretsFlags">NMSecretAgentGetSecretsFlags</link>) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.
|
|
Packit Service |
b23acc |
@secrets: Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
Retrieve and return stored secrets, if any, or request new secrets from
|
|
Packit Service |
b23acc |
the agent's user. If user interaction is allowed and the user enters new
|
|
Packit Service |
b23acc |
secrets, the agent is expected to save the new secrets to persistent
|
|
Packit Service |
b23acc |
storage (if the secret's flags include AGENT_OWNED) as NetworkManager will
|
|
Packit Service |
b23acc |
not send these secrets back to the same agent via a SaveSecrets() call. If
|
|
Packit Service |
b23acc |
the user canceled any interaction, the agent should return the
|
|
Packit Service |
b23acc |
UserCanceled error (see below).
|
|
Packit Service |
b23acc |
-->
|
|
Packit Service |
b23acc |
<method name="GetSecrets">
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/>
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
Packit Service |
b23acc |
<arg name="connection" type="a{sa{sv}}" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="connection_path" type="o" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="setting_name" type="s" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="hints" type="as" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="flags" type="u" direction="in"/>
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
<arg name="secrets" type="a{sa{sv}}" direction="out"/>
|
|
Packit Service |
b23acc |
</method>
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
CancelGetSecrets:
|
|
Packit Service |
b23acc |
@connection_path: Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.
|
|
Packit Service |
b23acc |
@setting_name: Setting name for which secrets for this connection were originally being requested.
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
Cancel a pending GetSecrets request for secrets of the given connection.
|
|
Packit Service |
b23acc |
Any GetSecrets request with the same 'connection_path' and 'setting_name'
|
|
Packit Service |
b23acc |
that are given in a CancelGetSecrets request should be canceled.
|
|
Packit Service |
b23acc |
-->
|
|
Packit Service |
b23acc |
<method name="CancelGetSecrets">
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/>
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
Packit Service |
b23acc |
<arg name="connection_path" type="o" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="setting_name" type="s" direction="in"/>
|
|
Packit Service |
b23acc |
</method>
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
SaveSecrets:
|
|
Packit Service |
b23acc |
@connection: Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.
|
|
Packit Service |
b23acc |
@connection_path: Object path of the connection for which the agent should save secrets to backing storage.
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
Save given secrets to backing storage.
|
|
Packit Service |
b23acc |
-->
|
|
Packit Service |
b23acc |
<method name="SaveSecrets">
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_save_secrets"/>
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
Packit Service |
b23acc |
<arg name="connection" type="a{sa{sv}}" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="connection_path" type="o" direction="in"/>
|
|
Packit Service |
b23acc |
</method>
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
DeleteSecrets:
|
|
Packit Service |
b23acc |
@connection: Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.
|
|
Packit Service |
b23acc |
@connection_path: Object path of the connection for which the agent should delete secrets from backing storage.
|
|
Packit Service |
b23acc |
|
|
Packit Service |
b23acc |
Delete secrets from backing storage.
|
|
Packit Service |
b23acc |
-->
|
|
Packit Service |
b23acc |
<method name="DeleteSecrets">
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_delete_secrets"/>
|
|
Packit Service |
b23acc |
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
|
Packit Service |
b23acc |
<arg name="connection" type="a{sa{sv}}" direction="in"/>
|
|
Packit Service |
b23acc |
<arg name="connection_path" type="o" direction="in"/>
|
|
Packit Service |
b23acc |
</method>
|
|
Packit Service |
b23acc |
</interface>
|
|
Packit Service |
b23acc |
</node>
|