diff options
| author | Dan Williams <dcbw@redhat.com> | 2011-06-30 16:37:58 -0500 |
|---|---|---|
| committer | Dan Williams <dcbw@redhat.com> | 2011-07-01 15:38:38 -0500 |
| commit | 220fb526211be177b7bddf78e4f008a68183f2d0 (patch) | |
| tree | 1cbde5ff2b5b99a14f933c670c0fc2ae6fadfb83 /introspection | |
| parent | 69b767bbf0ef8e038dd8bd0bcb35586c0f91ade7 (diff) | |
| download | NetworkManager-220fb526211be177b7bddf78e4f008a68183f2d0.tar.gz | |
api: update documentation about secret agents and SaveSecrets()
Diffstat (limited to 'introspection')
| -rw-r--r-- | introspection/nm-secret-agent.xml | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/introspection/nm-secret-agent.xml b/introspection/nm-secret-agent.xml index daf287c623..0a67efdc6c 100644 --- a/introspection/nm-secret-agent.xml +++ b/introspection/nm-secret-agent.xml @@ -5,7 +5,13 @@ <interface name="org.freedesktop.NetworkManager.SecretAgent"> <tp:docstring> Private D-Bus interface used by secret agents that store and provide - secrets to NetworkManager. + secrets to NetworkManager. If an agent provides secrets to + NetworkManager as part of connection creation, and the some of those + secrets are "agent owned" the agent should store those secrets + itself and should not expect its SaveSecrets() method to be called. + SaveSecrets() will be called eg if some program other than the + agent itself (like a connection editor) changes the secrets out of + band. </tp:docstring> <method name="GetSecrets"> @@ -123,7 +129,10 @@ <tp:docstring> Nested settings maps containing the entire connection (including secrets), for which the agent should save the - secrets to backing storage. + 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. </tp:docstring> </arg> <arg name="connection_path" type="o" direction="in"> |