Secret Service API Specification 0.1 Copyright (C) 2009 Stef Walter <stef@memberwebs.com> Copyright (C) 2009 Michael Leupold <lemma@confuego.org> Errors returned by the Secret Service API. The object must be unlocked before this action can be carried out. The session does not exist. No such item or collection exists. The Secret type holds a (possibly encoded) secret. The session that was used to encode the secret. Algorithm dependent parameters for secret value encoding. Possibly encoded secret value The content type of the secret. For example: 'text/plain; charset=utf8' A mapping from object-paths to Secret structs D-Bus object-path A secret The Secret Service manages all the sessions and collections. The object paths of all collections (ie: keyrings) Open a unique session for the caller application. The algorithm the caller wishes to use. Input arguments for the algorithm. Output of the session algorithm negotiation. The object path of the session, if session was created. Create a new collection with the specified properties. Properties for the new collection. This allows setting the new collection's properties upon its creation. All READWRITE properties of the Collection interface are useable. Example for properties The new collection object, or '/' if prompting is necessary. A prompt object if prompting is necessary, or '/' if no prompt was needed. Find items in any collection. Find secrets in any collection. Items found. Items found that require authentication. Unlock the specified objects. Objects to unlock. Objects that were unlocked without a prompt. A prompt object which can be used to unlock the remaining objects, or the special value '/' when no prompt is necessary. Lock the items. Objects to lock. Objects that were locked without a prompt. A prompt to lock the objects, or the special value '/' when no prompt is necessary. Retrieve multiple secrets from different items. Items to get secrets for. The session to use to encode the secrets. Secrets for the items. Get the collection with the given alias. An alias, such as 'default'. The collection or the the path '/' if no such collection exists. Setup a collection alias. An alias, such as 'default'. The collection to make the alias point to. To remove an alias use the special value '/'. A collection was created. Collection that was created A collection was deleted. Collection that was deleted. A collection was changed. Collection that was changed. A collection of items containing secrets. Items in this collection. The displayable label of this collection. Whether the collection is locked and must be authenticated by the client application. The unix time when the collection was created. The unix time when the collection was last modified. Delete this collection. A prompt to delete the collection, or the special value '/' when no prompt is necessary. Search for items in this collection matching the lookup attributes. Attributes to match. Items that matched the attributes. Create an item with the given attributes, secret and label. If replace is set, then it replaces an item already present with the same values for the attributes. The properties for the new item. Properties for the new item. This allows setting the new item's properties upon its creation. All READWRITE properties of the Item interface are useable. Example for properties Please note that there is a distinction between the terms Property, which refers to a D-Bus properties of an object, and Attribute, which refers to one of a secret item's string-valued attributes. The secret to store in the item, encoded with the included session. Whether to replace an item with the same attributes or not. The item created, or the special value '/' if a prompt is necessary. A prompt object, or the special value '/' if no prompt is necessary. A new item in this collection was created. The item that was created. An item in this collection was deleted. The item that was deleted. An item in this collection changed. The item that was changed. An item contains a secret, lookup attributes and has a label. Whether the item is locked and requires authentication, or not. The lookup attributes for this item. The displayable label for this item. The unix time when the item was created. The unix time when the item was last modified. Delete this item. A prompt object, or the special value '/' if no prompt is necessary. Retrieve the secret for this item. The session to use to encode the secret. The secret retrieved. Set the secret for this item. The secret to set, encoded for the included session. A session tracks state between the service and a client application. Close this session. A prompt necessary to complete an operation. Perform the prompt. Platform specific window handle to use for showing the prompt. Dismiss the prompt. The prompt and operation completed. Whether the prompt and operation were dismissed or not. The possibly empty, operation specific, result.