From dcc310e31af7fa88eb51fabe90de7edd374aecc5 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 16 Oct 2011 08:47:38 +0200 Subject: Imported Upstream version 0.9.1.90 --- docs/api/spec.html | 132 +++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 128 insertions(+), 4 deletions(-) (limited to 'docs/api/spec.html') diff --git a/docs/api/spec.html b/docs/api/spec.html index c8abf6ca..9f652756 100644 --- a/docs/api/spec.html +++ b/docs/api/spec.html @@ -1,5 +1,5 @@ -NetworkManager D-Bus Interface Specification version 0.9.0

NetworkManager D-Bus Interface Specification

Version 0.9.0

Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.
+

NetworkManager D-Bus Interface Specification

Version 0.9.1.90

Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or @@ -112,7 +112,7 @@ General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

-

Interfaces

+

Interfaces

org.freedesktop.NetworkManager

Methods:

GetDevices ( ) → @@ -1169,6 +1169,129 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Interface has no signals.

Interface has no properties.

+ +

org.freedesktop.NetworkManager.SecretAgent

+ Private D-Bus interface used by secret agents that store and provide + 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. +

Methods:

GetSecrets ( + a{sa{sv}}: connection, o: connection_path, s: setting_name, as: hints, u: flags + ) → + a{sa{sv}}

+ Retrieve and return stored secrets, if any, or request new + secrets from the agent's user. +

Parameters

connection - + a{sa{sv}} + (String_String_Variant_Map_Map) +
+ 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. +
connection_path - + o
+ Object path of the connection for which secrets are being + requested. +
setting_name - + s
+ Setting name for which secrets are being requested. +
hints - + as
+ 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. The Agent + should return any secrets it has, or that it thinks are + required, regardless of what hints NetworkManager sends + in this request. +
flags - + u + (NM_SECRET_AGENT_GET_SECRETS_FLAGS) +
+ 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. +

Returns

secrets - + a{sa{sv}} + (String_String_Variant_Map_Map) +
+ 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. +

CancelGetSecrets ( + o: connection_path, s: setting_name + ) → + nothing

+ Cancel a pending GetSecrets request for secrets of the given + connection. Any matching request should be canceled. +

Parameters

connection_path - + o
+ Object path of the connection for which, if secrets are being + requested, the request should be canceled. +
setting_name - + s
+ Setting name for which secrets for this connection were + originally being requested. +

SaveSecrets ( + a{sa{sv}}: connection, o: connection_path + ) → + nothing

+ Save given secrets to backing storage. +

Parameters

connection - + a{sa{sv}} + (String_String_Variant_Map_Map) +
+ 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. +
connection_path - + o
+ Object path of the connection for which the agent should + save secrets to backing storage. +

DeleteSecrets ( + a{sa{sv}}: connection, o: connection_path + ) → + nothing

+ Delete secrets from backing storage. +

Parameters

connection - + a{sa{sv}} + (String_String_Variant_Map_Map) +
+ Nested settings maps containing the connection properties + (sans secrets), for which the agent should delete the + secrets from backing storage. +
connection_path - + o
+ Object path of the connection for which the agent should + delete secrets from backing storage. +

Interface has no signals.

Interface has no properties.

Sets of flags:

NM_SECRET_AGENT_GET_SECRETS_FLAGS

+ Flags modifying the behavior of GetSecrets request. +
NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0
+ No special behavior; by default no user interaction is allowed and + requests for secrets are fulfilled from persistent storage, or + if no secrets are available an error is returned. +
NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1
+ Allows the request to interact with the user, possibly prompting + via UI for secrets if any are required, or if none are found in + persistent storage. +
NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2
+ Explicitly prompt for new secrets from the user. This flag + signals that NetworkManager thinks any existing secrets are + invalid or wrong. This flag implies that interaction is allowed. +
+ +

org.freedesktop.NetworkManager.VPN.Connection

Represents an active connection to a Virtual Private Network.

Interface has no methods.

Signals:

PropertiesChanged ( @@ -1379,7 +1502,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.org.freedesktop.NetworkManager.VPN.Error.BadArguments

Invalid arguments were passed with the request. FIXME: too general.

org.freedesktop.NetworkManager.VPN.Error.LaunchFailed

A binary providing the service failed to launch.

org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid

The request could not be processed because the VPN connection settings were invalid. -

Index

Index of interfaces

Index of types