Warning, /frameworks/networkmanager-qt/src/dbus/introspection/org.freedesktop.NetworkManager.SecretAgent.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8"?> 0002 <node name="/"> 0003 0004 <!-- 0005 org.freedesktop.NetworkManager.SecretAgent: 0006 0007 Private D-Bus interface used by secret agents that store and provide 0008 secrets to NetworkManager. If an agent provides secrets to NetworkManager 0009 as part of connection creation, and the some of those secrets are "agent 0010 owned" the agent should store those secrets itself and should not expect 0011 its SaveSecrets() method to be called. SaveSecrets() will be called eg if 0012 some program other than the agent itself (like a connection editor) 0013 changes the secrets out of band. The agent should implement this D-Bus 0014 interface on an object with the path 0015 /org/freedesktop/NetworkManager/SecretAgent. 0016 --> 0017 <interface name="org.freedesktop.NetworkManager.SecretAgent"> 0018 0019 <!-- 0020 GetSecrets: 0021 @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. 0022 @connection_path: Object path of the connection for which secrets are being requested. 0023 @setting_name: Setting name for which secrets are being requested. 0024 @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:". 0025 @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. 0026 @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. 0027 0028 Retrieve and return stored secrets, if any, or request new secrets from 0029 the agent's user. If user interaction is allowed and the user enters new 0030 secrets, the agent is expected to save the new secrets to persistent 0031 storage (if the secret's flags include AGENT_OWNED) as NetworkManager will 0032 not send these secrets back to the same agent via a SaveSecrets() call. If 0033 the user canceled any interaction, the agent should return the 0034 UserCanceled error (see below). 0035 --> 0036 <method name="GetSecrets"> 0037 <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/> 0038 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0039 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/> 0040 <arg name="connection" type="a{sa{sv}}" direction="in"/> 0041 <arg name="connection_path" type="o" direction="in"/> 0042 <arg name="setting_name" type="s" direction="in"/> 0043 <arg name="hints" type="as" direction="in"/> 0044 <arg name="flags" type="u" direction="in"/> 0045 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="NMVariantMapMap"/> 0046 <arg name="secrets" type="a{sa{sv}}" direction="out"/> 0047 </method> 0048 0049 <!-- 0050 CancelGetSecrets: 0051 @connection_path: Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. 0052 @setting_name: Setting name for which secrets for this connection were originally being requested. 0053 0054 Cancel a pending GetSecrets request for secrets of the given connection. 0055 Any GetSecrets request with the same 'connection_path' and 'setting_name' 0056 that are given in a CancelGetSecrets request should be canceled. 0057 --> 0058 <method name="CancelGetSecrets"> 0059 <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/> 0060 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0061 <arg name="connection_path" type="o" direction="in"/> 0062 <arg name="setting_name" type="s" direction="in"/> 0063 </method> 0064 0065 <!-- 0066 SaveSecrets: 0067 @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. 0068 @connection_path: Object path of the connection for which the agent should save secrets to backing storage. 0069 0070 Save given secrets to backing storage. 0071 --> 0072 <method name="SaveSecrets"> 0073 <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_save_secrets"/> 0074 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0075 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/> 0076 <arg name="connection" type="a{sa{sv}}" direction="in"/> 0077 <arg name="connection_path" type="o" direction="in"/> 0078 </method> 0079 0080 <!-- 0081 DeleteSecrets: 0082 @connection: Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. 0083 @connection_path: Object path of the connection for which the agent should delete secrets from backing storage. 0084 0085 Delete secrets from backing storage. 0086 --> 0087 <method name="DeleteSecrets"> 0088 <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_delete_secrets"/> 0089 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0090 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/> 0091 <arg name="connection" type="a{sa{sv}}" direction="in"/> 0092 <arg name="connection_path" type="o" direction="in"/> 0093 </method> 0094 </interface> 0095 </node>