diff options
Diffstat (limited to 'library')
28 files changed, 226 insertions, 2113 deletions
diff --git a/library/Makefile.am b/library/Makefile.am index 45fc4225..b94f64c4 100644 --- a/library/Makefile.am +++ b/library/Makefile.am @@ -62,5 +62,4 @@ TESTS_DIR = endif SUBDIRS = . \ - reference \ $(TESTS_DIR) diff --git a/library/gnome-keyring-memory.c b/library/gnome-keyring-memory.c index d016bab2..e135de76 100644 --- a/library/gnome-keyring-memory.c +++ b/library/gnome-keyring-memory.c @@ -32,6 +32,22 @@ #include <string.h> +/** + * SECTION:gnome-keyring-memory + * @title: Non-pageable Memory + * @short_description: Secure Non-pageable Memory + * + * Normal allocated memory can be paged to disk at the whim of the operating system. + * This can be a serious problem for sensitive information like passwords, keys and secrets. + * + * GNOME Keyring holds passwords in non-pageable, or locked memory. This happens + * both in the daemon and in the library. This is only possible if the OS contains + * support for it. + * + * These functions allow applications to use to hold passwords and other + * sensitive information. + */ + static GStaticMutex memory_mutex = G_STATIC_MUTEX_INIT; #define WARNING "couldn't allocate secure memory to keep passwords " \ diff --git a/library/gnome-keyring-utils.c b/library/gnome-keyring-utils.c index 010350ce..8ec4e527 100644 --- a/library/gnome-keyring-utils.c +++ b/library/gnome-keyring-utils.c @@ -32,6 +32,17 @@ #include "egg/egg-secure-memory.h" +/** + * SECTION:gnome-keyring-result + * @title: Result Codes + * @short_description: Gnome Keyring Result Codes + * + * <para> + * Result codes used through out GNOME Keyring. Additional result codes may be + * added from time to time and these should be handled gracefully. + * </para> + */ + /* Functions used by both the library and the daemon */ /* @@ -211,6 +222,18 @@ gnome_keyring_found_list_free (GList *found_list) } /** + * SECTION:gnome-keyring-attributes + * @title: Item Attributes + * @short_description: Attributes of individual keyring items. + * + * Attributes allow various other pieces of information to be associated with an item. + * These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() + * or gnome_keyring_item_set_attributes(). + * + * Each attribute has either a string, or unsigned integer value. + */ + +/** * gnome_keyring_attribute_list_append_string: * @attributes: A #GnomeKeyringAttributeList * @name: The name of the new attribute @@ -315,6 +338,15 @@ gnome_keyring_attribute_list_copy (GnomeKeyringAttributeList *attributes) } /** + * SECTION:gnome-keyring-keyring-info + * @title: Keyring Info + * @short_description: Keyring Information + * + * Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo + * pointer to use with these functions. + */ + +/** * gnome_keyring_info_free: * @keyring_info: The keyring info to free. * @@ -328,6 +360,15 @@ gnome_keyring_info_free (GnomeKeyringInfo *keyring_info) } /** + * SECTION:gnome-keyring-item-info + * @title: Item Information + * @short_description: Keyring Item Info + * + * #GnomeKeyringItemInfo represents the basic information about a keyring item. + * Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info(). + */ + +/** * gnome_keyring_info_copy: * @keyring_info: The keyring info to copy. * diff --git a/library/gnome-keyring.c b/library/gnome-keyring.c index 4ae3db0e..38a46c57 100644 --- a/library/gnome-keyring.c +++ b/library/gnome-keyring.c @@ -44,6 +44,12 @@ #include <sys/uio.h> #include <stdarg.h> +/** + * SECTION:gnome-keyring-generic-callbacks + * @title: Callbacks + * @short_description: Different callbacks for retrieving async results + */ + typedef enum { CALLBACK_DONE, CALLBACK_GET_STRING, @@ -387,6 +393,12 @@ run_sync_operation (EggBuffer *buffer, } /** + * SECTION:gnome-keyring-misc + * @title: Miscellaneous Functions + * @short_description: Miscellaneous functions. + */ + +/** * gnome_keyring_is_available: * * Check whether you can communicate with a gnome-keyring-daemon. @@ -490,6 +502,18 @@ int_reply (GnomeKeyringOperation *op) } /** + * SECTION:gnome-keyring-keyrings + * @title: Keyrings + * @short_description: Listing and managing keyrings + * + * %gnome-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets. + * + * One of the keyrings is the default keyring, which can in many cases be used by specifying %NULL for a keyring name. + * + * Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring. + */ + +/** * gnome_keyring_set_default_keyring: * @keyring: The keyring to make default * @callback: A callback which will be called when the request completes or fails. @@ -1522,6 +1546,14 @@ gnome_keyring_list_item_ids_sync (const char *keyring, } /** + * SECTION:gnome-keyring-daemon + * @title: Daemon Management Functions + * @short_description: Functions used by session to run the Gnome Keyring Daemon. + * + * These functions are not used by most applications using Gnome Keyring. + */ + +/** * gnome_keyring_daemon_set_display_sync: * @display: Deprecated * @@ -1744,6 +1776,18 @@ find_items_reply (GnomeKeyringOperation *op) } /** + * SECTION:gnome-keyring-find + * @title: Search Functionality + * @short_description: Find Keyring Items + * + * A find operation searches through all keyrings for items that match the + * attributes. The user may have been prompted to unlock necessary keyrings, and + * user will have been prompted for access to the items if needed. + * + * A find operation may return multiple or zero results. + */ + +/** * gnome_keyring_find_items: * @type: The type of items to find. * @attributes: A list of attributes to search for. This cannot be an empty list. @@ -1980,6 +2024,30 @@ gnome_keyring_find_itemsv_sync (GnomeKeyringItemType type, return res; } +/** + * SECTION:gnome-keyring-items + * @title: Keyring Items + * @short_description: Keyring items each hold a secret and a number of attributes. + * + * A keyring contains multiple items. Each item has a secret, attributes and access + * information associated with it. + * + * An item is identified by an unsigned integer unique to the keyring in which it + * exists. An item's name is for displaying to the user. Each item has a single secret, + * which is a null-terminated string. This secret is stored in non-pageable memory, and + * encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo + * pointers. + * + * Attributes allow various other pieces of information to be associated with an item. + * These can also be used to search for relevant items. Attributes are accessed with + * #GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList. + * + * Each item has an access control list, which specifies the applications that + * can read, write or delete an item. The read access applies only to reading the secret. + * All applications can read other parts of the item. ACLs are accessed and changed + * through #GnomeKeyringAccessControl pointers. + */ + /** * gnome_keyring_item_create: * @keyring: The name of the keyring in which to create the item, or NULL for the default keyring. @@ -3149,6 +3217,17 @@ gnome_keyring_item_info_get_ctime (GnomeKeyringItemInfo *item_info) } /** + * SECTION:gnome-keyring-acl + * @title: Item ACLs + * @short_description: Access control lists for keyring items. + * + * Each item has an access control list, which specifies the applications that + * can read, write or delete an item. The read access applies only to reading the secret. + * All applications can read other parts of the item. ACLs are accessed and changed + * gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl(). + */ + +/** * gnome_keyring_item_ac_get_display_name: * @ac: A #GnomeKeyringAccessControl pointer. * @@ -3238,6 +3317,15 @@ gnome_keyring_item_ac_set_access_type (GnomeKeyringAccessControl *ac, * NETWORK PASSWORD APIS */ +/** + * SECTION:gnome-keyring-network + * @title: Network Passwords + * @short_description: Saving of network passwords. + * + * Networks passwords are a simple way of saving passwords associated with a + * certain user/server/protocol and other fields. + */ + struct FindNetworkPasswordInfo { GnomeKeyringOperationGetListCallback callback; gpointer data; @@ -3689,6 +3777,56 @@ gnome_keyring_set_network_password_sync (const char * * SIMPLE PASSWORD APIS */ +/** + * SECTION:gnome-keyring-password + * @title: Simple Password Storage + * @short_description: Store and lookup passwords with a set of attributes. + * + * This is a simple API for storing passwords and retrieving passwords in the keyring. + * + * Each password is associated with a set of attributes. Attribute values can be either + * strings or unsigned integers. + * + * The names and types of allowed attributes for a given password are defined with a + * schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. + * Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. + * + * Each function accepts a variable list of attributes names and their values. + * Include a %NULL to terminate the list of attributes. + * + * <example> + * <title>Passing attributes to the functions</title> + * <programlisting> + * res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, + * "user", "me", // A string attribute + * "server, "example.gnome.org", + * "port", "8080", // An integer attribute + * NULL); + * </programlisting></example> + */ + +/** + * GnomeKeyringPasswordSchema: + * + * Describes a password schema. Often you'll want to use a predefined schema such + * as %GNOME_KEYRING_NETWORK_PASSWORD. + * + * <para> + * The last attribute name in a schema must be %NULL. + * + * <programlisting> + * GnomeKeyringPasswordSchema my_schema = { + * GNOME_KEYRING_ITEM_GENERIC_SECRET, + * { + * { "string-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_STRING }, + * { "uint-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 }, + * { NULL, 0 } + * } + * }; + * </programlisting> + * </para> + */ + static const GnomeKeyringPasswordSchema network_password_schema = { GNOME_KEYRING_ITEM_NETWORK_PASSWORD, { @@ -3702,9 +3840,40 @@ static const GnomeKeyringPasswordSchema network_password_schema = { } }; +/** + * GNOME_KEYRING_NETWORK_PASSWORD: + * + * <para> + * A predefined schema for network paswsords. It contains the following attributes: + * </para> + * <itemizedlist> + * <listitem>user: A string for the user login.</listitem> + * <listitem>server: The server being connected to.</listitem> + * <listitem>protocol: The protocol used to access the server, such as 'http' or 'smb'</listitem> + * <listitem>domain: A realm or domain, such as a Windows login domain.</listitem> + * <listitem>port: The network port to used to connect to the server.</listitem> + * </itemizedlist> + */ + /* Declared in gnome-keyring.h */ const GnomeKeyringPasswordSchema *GNOME_KEYRING_NETWORK_PASSWORD = &network_password_schema; +/** + * GNOME_KEYRING_DEFAULT: + * + * <para> + * The default keyring. + * </para> + */ + +/** + * GNOME_KEYRING_SESSION: + * + * <para> + * A keyring only stored in memory. + * </para> + */ + static GnomeKeyringAttributeList* schema_attribute_list_va (const GnomeKeyringPasswordSchema *schema, va_list args) { diff --git a/library/reference/.cvsignore b/library/reference/.cvsignore deleted file mode 100644 index 8e6e462d..00000000 --- a/library/reference/.cvsignore +++ /dev/null @@ -1,14 +0,0 @@ -Makefile -Makefile.in -gnome-keyring.args -gnome-keyring.hierarchy -gnome-keyring.interfaces -gnome-keyring.prerequisites -gnome-keyring.signals -gnome-keyring-decl.txt -gnome-keyring-decl-list.txt -gnome-keyring-overrides.txt -gnome-keyring-undocumented.txt -gnome-keyring-unused.txt -*.stamp -xml diff --git a/library/reference/.gitignore b/library/reference/.gitignore deleted file mode 100644 index bce135a3..00000000 --- a/library/reference/.gitignore +++ /dev/null @@ -1,16 +0,0 @@ -/*.bak -/Makefile -/Makefile.in -/gnome-keyring.args -/gnome-keyring.hierarchy -/gnome-keyring.interfaces -/gnome-keyring.prerequisites -/gnome-keyring.signals -/gnome-keyring-decl.txt -/gnome-keyring-decl-list.txt -/gnome-keyring-overrides.txt -/gnome-keyring-undocumented.txt -/gnome-keyring-unused.txt -/*.stamp -/xml -/html diff --git a/library/reference/Makefile.am b/library/reference/Makefile.am deleted file mode 100644 index 04de1c08..00000000 --- a/library/reference/Makefile.am +++ /dev/null @@ -1,92 +0,0 @@ -## Process this file with automake to produce Makefile.in -NULL= - -all-recursive: all - -# all: tmpl.stamp - -# This is a blank Makefile.am for using gtk-doc. -# Copy this to your project's API docs directory and modify the variables to -# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples -# of using the various options. - -# The name of the module, e.g. 'glib'. -DOC_MODULE=gnome-keyring - -# The top-level SGML file. You can change this if you want to. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting the functions and macros. -# e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../ - -# Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" - -# Extra options to supply to gtkdoc-scan. -# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -SCAN_OPTIONS= - -# Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml -MKDB_OPTIONS=--sgml-mode --output-format=xml - -# Extra options to supply to gtkdoc-mktmpl -# e.g. MKTMPL_OPTIONS=--only-section-tmpl -MKTMPL_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. Not normally needed. -# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html -FIXXREF_OPTIONS= - -# Used for dependencies. The docs will be rebuilt if any of these change. -# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h -# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB=$(top_srcdir)/library/*.h -CFILE_GLOB=$(top_srcdir)/library/*.c - -# Header files to ignore when scanning. -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=\ - gnome-keyring-private.h \ - gnome-keyring-proto.h \ - $(NULL) - -# Images to copy into HTML directory. -# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES=\ - $(NULL) - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -# e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files=\ - $(NULL) - -# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded -# These files must be listed here *and* in content_files -# e.g. expand_content_files=running.sgml -expand_content_files= - -# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. -# Only needed if you are using gtkdoc-scangobj to dynamically query widget -# signals and properties. -# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) -# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) -INCLUDES=\ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(GOBJECT_CFLAGS) \ - $(NULL) -GTKDOC_LIBS=\ - $(top_builddir)/libgnome-keyring.la \ - $(GOBJECT_LIBS) \ - $(NULL) - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -# Other files to distribute -# e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += diff --git a/library/reference/gnome-keyring-docs.sgml b/library/reference/gnome-keyring-docs.sgml deleted file mode 100644 index 309308a7..00000000 --- a/library/reference/gnome-keyring-docs.sgml +++ /dev/null @@ -1,26 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>gnome-keyring Reference Manual</title> - </bookinfo> - - <chapter> - <title>gnome-keyring API Reference</title> - <xi:include href="xml/gnome-keyring-password.xml"/> - <xi:include href="xml/gnome-keyring-keyrings.xml"/> - <xi:include href="xml/gnome-keyring-keyring-info.xml"/> - <xi:include href="xml/gnome-keyring-items.xml"/> - <xi:include href="xml/gnome-keyring-item-info.xml"/> - <xi:include href="xml/gnome-keyring-attributes.xml"/> - <xi:include href="xml/gnome-keyring-acl.xml"/> - <xi:include href="xml/gnome-keyring-find.xml"/> - <xi:include href="xml/gnome-keyring-network.xml"/> - <xi:include href="xml/gnome-keyring-memory.xml"/> - <xi:include href="xml/gnome-keyring-result.xml"/> - <xi:include href="xml/gnome-keyring-misc.xml"/> - <xi:include href="xml/gnome-keyring-daemon.xml"/> - <xi:include href="xml/gnome-keyring-generic-callbacks.xml"/> - </chapter> -</book> diff --git a/library/reference/gnome-keyring-sections.txt b/library/reference/gnome-keyring-sections.txt deleted file mode 100644 index 0b904ecb..00000000 --- a/library/reference/gnome-keyring-sections.txt +++ /dev/null @@ -1,183 +0,0 @@ -<SECTION> -<FILE>gnome-keyring-password</FILE> -GnomeKeyringPasswordSchema -GNOME_KEYRING_NETWORK_PASSWORD -GNOME_KEYRING_DEFAULT -GNOME_KEYRING_SESSION -gnome_keyring_store_password -gnome_keyring_store_password_sync -gnome_keyring_find_password -gnome_keyring_find_password_sync -gnome_keyring_delete_password -gnome_keyring_delete_password_sync -gnome_keyring_free_password -</SECTION> -<SECTION> -<FILE>gnome-keyring-keyrings</FILE> -GnomeKeyringOperationGetKeyringInfoCallback -gnome_keyring_set_default_keyring -gnome_keyring_set_default_keyring_sync -gnome_keyring_get_default_keyring -gnome_keyring_get_default_keyring_sync -gnome_keyring_list_keyring_names -gnome_keyring_list_keyring_names_sync -gnome_keyring_lock_all -gnome_keyring_lock_all_sync -gnome_keyring_create -gnome_keyring_create_sync -gnome_keyring_unlock -gnome_keyring_unlock_sync -gnome_keyring_lock -gnome_keyring_lock_sync -gnome_keyring_delete -gnome_keyring_delete_sync -gnome_keyring_get_info -gnome_keyring_get_info_sync -gnome_keyring_set_info -gnome_keyring_set_info_sync -gnome_keyring_change_password -gnome_keyring_change_password_sync -gnome_keyring_list_item_ids -gnome_keyring_list_item_ids_sync -</SECTION> -<SECTION> -<FILE>gnome-keyring-keyring-info</FILE> -GnomeKeyringInfo -gnome_keyring_info_free -gnome_keyring_info_copy -gnome_keyring_info_set_lock_on_idle -gnome_keyring_info_get_lock_on_idle -gnome_keyring_info_set_lock_timeout -gnome_keyring_info_get_lock_timeout -gnome_keyring_info_get_mtime -gnome_keyring_info_get_ctime -gnome_keyring_info_get_is_locked -</SECTION> -<SECTION> -<FILE>gnome-keyring-items</FILE> -GnomeKeyringItemInfoFlags -GnomeKeyringOperationGetItemInfoCallback -GnomeKeyringOperationGetAttributesCallback -gnome_keyring_item_create -gnome_keyring_item_create_sync -gnome_keyring_item_delete -gnome_keyring_item_delete_sync -gnome_keyring_item_get_info -gnome_keyring_item_get_info_full -gnome_keyring_item_get_info_full_sync -gnome_keyring_item_get_info_sync -gnome_keyring_item_set_info -gnome_keyring_item_set_info_sync -gnome_keyring_item_get_attributes -gnome_keyring_item_get_attributes_sync -gnome_keyring_item_set_attributes -gnome_keyring_item_set_attributes_sync -gnome_keyring_item_get_acl -gnome_keyring_item_get_acl_sync -gnome_keyring_item_set_acl -gnome_keyring_item_set_acl_sync -gnome_keyring_item_grant_access_rights -gnome_keyring_item_grant_access_rights_sync -</SECTION> -<SECTION> -<FILE>gnome-keyring-item-info</FILE> -GnomeKeyringItemType -GnomeKeyringItemInfo -gnome_keyring_item_info_free -gnome_keyring_item_info_new -gnome_keyring_item_info_copy -gnome_keyring_item_info_get_type -gnome_keyring_item_info_set_type -gnome_keyring_item_info_get_secret -gnome_keyring_item_info_set_secret -gnome_keyring_item_info_get_display_name -gnome_keyring_item_info_set_display_name -gnome_keyring_item_info_get_mtime -gnome_keyring_item_info_get_ctime -</SECTION> -<SECTION> -<FILE>gnome-keyring-find</FILE> -GnomeKeyringFound -gnome_keyring_found_free -gnome_keyring_found_list_free -gnome_keyring_find_items -gnome_keyring_find_itemsv -gnome_keyring_find_items_sync -gnome_keyring_find_itemsv_sync -</SECTION> -<SECTION> -<FILE>gnome-keyring-attributes</FILE> -GnomeKeyringAttributeType -GnomeKeyringAttributeList -GnomeKeyringAttribute -gnome_keyring_attribute_list_index -gnome_keyring_attribute_list_new -gnome_keyring_attribute_list_append_string -gnome_keyring_attribute_list_append_uint32 -gnome_keyring_attribute_list_free -gnome_keyring_attribute_list_copy -</SECTION> -<SECTION> -<FILE>gnome-keyring-acl</FILE> -GnomeKeyringAccessControl -GnomeKeyringApplicationRef -GnomeKeyringAccessType -gnome_keyring_application_ref_new -gnome_keyring_application_ref_copy -gnome_keyring_application_ref_free -gnome_keyring_access_control_new -gnome_keyring_access_control_copy -gnome_keyring_access_control_free -gnome_keyring_acl_copy -gnome_keyring_acl_free -gnome_keyring_item_ac_get_display_name -gnome_keyring_item_ac_set_display_name -gnome_keyring_item_ac_get_path_name -gnome_keyring_item_ac_set_path_name -gnome_keyring_item_ac_get_access_type -gnome_keyring_item_ac_set_access_type -</SECTION> -<SECTION> -<FILE>gnome-keyring-network</FILE> -GnomeKeyringNetworkPasswordData -gnome_keyring_network_password_free -gnome_keyring_network_password_list_free -gnome_keyring_find_network_password -gnome_keyring_find_network_password_sync -gnome_keyring_set_network_password -gnome_keyring_set_network_password_sync -</SECTION> -<SECTION> -<FILE>gnome-keyring-misc</FILE> -gnome_keyring_is_available -gnome_keyring_cancel_request -gnome_keyring_string_list_free -</SECTION> -<SECTION> -<FILE>gnome-keyring-daemon</FILE> -gnome_keyring_daemon_set_display_sync -gnome_keyring_daemon_prepare_environment_sync -</SECTION> -<SECTION> -<FILE>gnome-keyring-memory</FILE> -gnome_keyring_memory_new -gnome_keyring_memory_alloc -gnome_keyring_memory_try_alloc -gnome_keyring_memory_realloc -gnome_keyring_memory_try_realloc -gnome_keyring_memory_free -gnome_keyring_memory_is_secure -gnome_keyring_memory_strdup -</SECTION> -<SECTION> -<FILE>gnome-keyring-result</FILE> -gnome_keyring_result_to_message -GnomeKeyringResult -</SECTION> -<SECTION> -<FILE>gnome-keyring-generic-callbacks</FILE> -GnomeKeyringOperationDoneCallback -GnomeKeyringOperationGetIntCallback -GnomeKeyringOperationGetListCallback -GnomeKeyringOperationGetStringCallback -</SECTION>
\ No newline at end of file diff --git a/library/reference/gnome-keyring-undeclared.txt b/library/reference/gnome-keyring-undeclared.txt deleted file mode 100644 index e69de29b..00000000 --- a/library/reference/gnome-keyring-undeclared.txt +++ /dev/null diff --git a/library/reference/tmpl/.cvsignore b/library/reference/tmpl/.cvsignore deleted file mode 100644 index 078ee879..00000000 --- a/library/reference/tmpl/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -*.sgml diff --git a/library/reference/tmpl/.gitignore b/library/reference/tmpl/.gitignore deleted file mode 100644 index dc3432a6..00000000 --- a/library/reference/tmpl/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/*.bak diff --git a/library/reference/tmpl/empty.sgml b/library/reference/tmpl/empty.sgml deleted file mode 100644 index e69de29b..00000000 --- a/library/reference/tmpl/empty.sgml +++ /dev/null diff --git a/library/reference/tmpl/gnome-keyring-acl.sgml b/library/reference/tmpl/gnome-keyring-acl.sgml deleted file mode 100644 index aaafb890..00000000 --- a/library/reference/tmpl/gnome-keyring-acl.sgml +++ /dev/null @@ -1,164 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-acl - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item ACLs - -<!-- ##### SECTION Long_Description ##### --> -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringAccessControl ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF GnomeKeyringApplicationRef ##### --> -<para> - -</para> - - -<!-- ##### ENUM GnomeKeyringAccessType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ACCESS_READ: -@GNOME_KEYRING_ACCESS_WRITE: -@GNOME_KEYRING_ACCESS_REMOVE: - -<!-- ##### FUNCTION gnome_keyring_application_ref_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_copy ##### --> -<para> - -</para> - -@app: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_free ##### --> -<para> - -</para> - -@app: - - -<!-- ##### FUNCTION gnome_keyring_access_control_new ##### --> -<para> - -</para> - -@application: -@types_allowed: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_copy ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_free ##### --> -<para> - -</para> - -@ac: - - -<!-- ##### FUNCTION gnome_keyring_acl_copy ##### --> -<para> - -</para> - -@list: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_acl_free ##### --> -<para> - -</para> - -@acl: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_display_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_display_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_path_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_path_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_access_type ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_access_type ##### --> -<para> - -</para> - -@ac: -@value: - - diff --git a/library/reference/tmpl/gnome-keyring-attributes.sgml b/library/reference/tmpl/gnome-keyring-attributes.sgml deleted file mode 100644 index daff4631..00000000 --- a/library/reference/tmpl/gnome-keyring-attributes.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-attributes - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Attributes - -<!-- ##### SECTION Long_Description ##### --> -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() -or gnome_keyring_item_set_attributes().</para> - -<para>Each attribute has either a string, or unsigned integer value.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringAttributeType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ATTRIBUTE_TYPE_STRING: -@GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32: - -<!-- ##### TYPEDEF GnomeKeyringAttributeList ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GnomeKeyringAttribute ##### --> -<para> - -</para> - -@name: -@type: - -<!-- ##### MACRO gnome_keyring_attribute_list_index ##### --> -<para> - -</para> - -@a: -@i: - - -<!-- ##### MACRO gnome_keyring_attribute_list_new ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_string ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_uint32 ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_free ##### --> -<para> - -</para> - -@attributes: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_copy ##### --> -<para> - -</para> - -@attributes: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-daemon.sgml b/library/reference/tmpl/gnome-keyring-daemon.sgml deleted file mode 100644 index 217b1d3f..00000000 --- a/library/reference/tmpl/gnome-keyring-daemon.sgml +++ /dev/null @@ -1,36 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Daemon Management Functions - -<!-- ##### SECTION Short_Description ##### --> -Functions used by session managers to manage the Gnome Keyring Daemon. - -<!-- ##### SECTION Long_Description ##### --> -<para> -These functions are not used by most applications using Gnome Keyring. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_daemon_set_display_sync ##### --> -<para> - -</para> - -@display: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_daemon_prepare_environment_sync ##### --> -<para> - -</para> - -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-find.sgml b/library/reference/tmpl/gnome-keyring-find.sgml deleted file mode 100644 index 86d2ef22..00000000 --- a/library/reference/tmpl/gnome-keyring-find.sgml +++ /dev/null @@ -1,95 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-find - -<!-- ##### SECTION Short_Description ##### --> -Find Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A find operation searches through all keyrings for items that match the -attributes. The user may have been prompted to unlock necessary keyrings, and -user will have been prompted for access to the items if needed.</para> - -<para>A find operation may return multiple or zero results.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringFound ##### --> -<para> - -</para> - -@keyring: -@item_id: -@attributes: -@secret: - -<!-- ##### FUNCTION gnome_keyring_found_free ##### --> -<para> - -</para> - -@found: - - -<!-- ##### FUNCTION gnome_keyring_found_list_free ##### --> -<para> - -</para> - -@found_list: - - -<!-- ##### FUNCTION gnome_keyring_find_items ##### --> -<para> - -</para> - -@type: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv ##### --> -<para> - -</para> - -@type: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_items_sync ##### --> -<para> - -</para> - -@type: -@attributes: -@found: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv_sync ##### --> -<para> - -</para> - -@type: -@found: -@Varargs: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml b/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml deleted file mode 100644 index 0357915c..00000000 --- a/library/reference/tmpl/gnome-keyring-generic-callbacks.sgml +++ /dev/null @@ -1,58 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-generic-callbacks - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationDoneCallback ##### --> -<para> - -</para> - -@result: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetIntCallback ##### --> -<para> - -</para> - -@result: -@val: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetListCallback ##### --> -<para> - -</para> - -@result: -@list: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetStringCallback ##### --> -<para> - -</para> - -@result: -@string: -@data: - - diff --git a/library/reference/tmpl/gnome-keyring-item-info.sgml b/library/reference/tmpl/gnome-keyring-item-info.sgml deleted file mode 100644 index 7a265cf8..00000000 --- a/library/reference/tmpl/gnome-keyring-item-info.sgml +++ /dev/null @@ -1,134 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-item-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Info - -<!-- ##### SECTION Long_Description ##### --> -<para>#GnomeKeyringItemInfo represents the basic information about a keyring item. -Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_GENERIC_SECRET: -@GNOME_KEYRING_ITEM_NETWORK_PASSWORD: -@GNOME_KEYRING_ITEM_NOTE: -@GNOME_KEYRING_ITEM_CHAINED_KEYRING_PASSWORD: -@GNOME_KEYRING_ITEM_ENCRYPTION_KEY_PASSWORD: -@GNOME_KEYRING_ITEM_PK_STORAGE: -@GNOME_KEYRING_ITEM_LAST_TYPE: - -<!-- ##### TYPEDEF GnomeKeyringItemInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_item_info_free ##### --> -<para> - -</para> - -@item_info: - - -<!-- ##### FUNCTION gnome_keyring_item_info_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_copy ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_type ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_type ##### --> -<para> - -</para> - -@item_info: -@type: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_secret ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_secret ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_display_name ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_display_name ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_mtime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_ctime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-items.sgml b/library/reference/tmpl/gnome-keyring-items.sgml deleted file mode 100644 index ae862300..00000000 --- a/library/reference/tmpl/gnome-keyring-items.sgml +++ /dev/null @@ -1,318 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-items - -<!-- ##### SECTION Short_Description ##### --> -Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A keyring contains multiple items. Each item has a secret, attributes and access -information associated with it. </para> - -<para>An item is identified by an unsigned integer unique to the keyring in which it -exists. An item's name is for displaying to the user. Each item has a single secret, -which is a null-terminated string. This secret is stored in non-pageable memory, and -encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo -pointers</para> - -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Attributes are accessed with -#GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList.</para> - -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -through #GnomeKeyringAccessControl pointers.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemInfoFlags ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_INFO_BASICS: -@GNOME_KEYRING_ITEM_INFO_SECRET: - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetItemInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetAttributesCallback ##### --> -<para> - -</para> - -@result: -@attributes: -@data: - - -<!-- ##### FUNCTION gnome_keyring_item_create ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_create_sync ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@item_id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights_sync ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-keyring-info.sgml b/library/reference/tmpl/gnome-keyring-keyring-info.sgml deleted file mode 100644 index 6280bf70..00000000 --- a/library/reference/tmpl/gnome-keyring-keyring-info.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyring-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Information - -<!-- ##### SECTION Long_Description ##### --> -<para>Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo -pointer to use with these functions.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_info_free ##### --> -<para> - -</para> - -@keyring_info: - - -<!-- ##### FUNCTION gnome_keyring_info_copy ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_mtime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_ctime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_is_locked ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-keyrings.sgml b/library/reference/tmpl/gnome-keyring-keyrings.sgml deleted file mode 100644 index 3b7e500d..00000000 --- a/library/reference/tmpl/gnome-keyring-keyrings.sgml +++ /dev/null @@ -1,291 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyrings - -<!-- ##### SECTION Short_Description ##### --> -Keyrings - -<!-- ##### SECTION Long_Description ##### --> -<para>%gnome-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets.</para> - -<para>One of the keyrings is the default keyring, which can in many cases be used by specifying %NULL for a keyring name.</para> - -<para>Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetKeyringInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names_sync ##### --> -<para> - -</para> - -@keyrings: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all_sync ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create ##### --> -<para> - -</para> - -@keyring_name: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create_sync ##### --> -<para> - -</para> - -@keyring_name: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock ##### --> -<para> - -</para> - -@keyring: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock_sync ##### --> -<para> - -</para> - -@keyring: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info ##### --> -<para> - -</para> - -@keyring: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password_sync ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids_sync ##### --> -<para> - -</para> - -@keyring: -@ids: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-memory.sgml b/library/reference/tmpl/gnome-keyring-memory.sgml deleted file mode 100644 index e454b3e3..00000000 --- a/library/reference/tmpl/gnome-keyring-memory.sgml +++ /dev/null @@ -1,100 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-memory - -<!-- ##### SECTION Short_Description ##### --> -Secure Non-pageable Memory - -<!-- ##### SECTION Long_Description ##### --> -<para> -Normal allocated memory can be paged to disk at the whim of the operating system. -This is a serious problems for sensitive information like passwords, keys and secrets. -</para> - -<para>GNOME Keyring holds passwords in non-pageable, or locked memory. This happens -both in the daemon and in the library. This is only possible if the OS contains -support for it.</para> - -<para>These functions allow applications to use to hold passwords and other -sensitive information.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO gnome_keyring_memory_new ##### --> -<para> - -</para> - -@type: -@n_objects: - - -<!-- ##### FUNCTION gnome_keyring_memory_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_free ##### --> -<para> - -</para> - -@p: - - -<!-- ##### FUNCTION gnome_keyring_memory_is_secure ##### --> -<para> - -</para> - -@p: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_strdup ##### --> -<para> - -</para> - -@str: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-misc.sgml b/library/reference/tmpl/gnome-keyring-misc.sgml deleted file mode 100644 index 411efd16..00000000 --- a/library/reference/tmpl/gnome-keyring-misc.sgml +++ /dev/null @@ -1,43 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-misc - -<!-- ##### SECTION Short_Description ##### --> -Miscellaneous Functions - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_is_available ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_cancel_request ##### --> -<para> - -</para> - -@request: - - -<!-- ##### FUNCTION gnome_keyring_string_list_free ##### --> -<para> - -</para> - -@strings: - - diff --git a/library/reference/tmpl/gnome-keyring-network.sgml b/library/reference/tmpl/gnome-keyring-network.sgml deleted file mode 100644 index dee77e54..00000000 --- a/library/reference/tmpl/gnome-keyring-network.sgml +++ /dev/null @@ -1,122 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-network - -<!-- ##### SECTION Short_Description ##### --> -Network Passwords - -<!-- ##### SECTION Long_Description ##### --> -<para>Networks passwords are a simple way of saving passwords associated with a -certain user/server/protocol and other fields.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringNetworkPasswordData ##### --> -<para> - -</para> - -@keyring: -@item_id: -@protocol: -@server: -@object: -@authtype: -@port: -@user: -@domain: -@password: - -<!-- ##### FUNCTION gnome_keyring_network_password_free ##### --> -<para> - -</para> - -@data: - - -<!-- ##### FUNCTION gnome_keyring_network_password_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password_sync ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@results: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password_sync ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@item_id: -@Returns: - - diff --git a/library/reference/tmpl/gnome-keyring-password.sgml b/library/reference/tmpl/gnome-keyring-password.sgml deleted file mode 100644 index cba8b008..00000000 --- a/library/reference/tmpl/gnome-keyring-password.sgml +++ /dev/null @@ -1,173 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Simple Password Storage - -<!-- ##### SECTION Short_Description ##### --> -Store and lookup passwords with a set of attributes. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This is a simple API for storing passwords and retrieving passwords in the keyring. -</para> -<para> -Each password is associated with a set of attributes. Attribute values can be either -strings or unsigned integers. -The names and types of allowed attributes for a given password are defined with a -schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. -Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. -</para> -<para> -Each function accepts a variable list of attributes names and their values. -Include a %NULL to terminate the list of attributes. -</para> -<example> -<title>Passing attributes to the functions</title> -<programlisting> - res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, - "user", "me", /* A string attribute */ - "server, "example.gnome.org", - "port", "8080", /* An integer attribute */ - NULL); -</programlisting></example> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringPasswordSchema ##### --> -<para> -Describes a password schema. Often you'll want to use a predefined schema such -as %GNOME_KEYRING_NETWORK_PASSWORD. -</para> - -<para> -The last attribute name in a schema must be %NULL. - -<programlisting> - GnomeKeyringPasswordSchema my_schema = { - GNOME_KEYRING_ITEM_GENERIC_SECRET, - { - { "string-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_STRING }, - { "uint-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 }, - { NULL, 0 } - } - }; -</programlisting> -</para> - -@item_type: - -<!-- ##### VARIABLE GNOME_KEYRING_NETWORK_PASSWORD ##### --> -<para> -A predefined schema for network paswsords. It contains the following attributes: -</para> -<itemizedlist> -<listitem>user: A string for the user login.</listitem> -<listitem>server: The server being connected to.</listitem> -<listitem>protocol: The protocol used to access the server, such as 'http' or 'smb'</listitem> -<listitem>domain: A realm or domain, such as a Windows login domain.</listitem> -<listitem>port: The network port to used to connect to the server.</listitem> -</itemizedlist> - - -<!-- ##### MACRO GNOME_KEYRING_DEFAULT ##### --> -<para> -The default keyring. -</para> - - - -<!-- ##### MACRO GNOME_KEYRING_SESSION ##### --> -<para> -A keyring only stored in memory. -</para> - - - -<!-- ##### FUNCTION gnome_keyring_store_password ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_store_password_sync ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password_sync ##### --> -<para> - -</para> - -@schema: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password_sync ##### --> -<para> - -</para> - -@schema: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_free_password ##### --> -<para> - -</para> - -@password: - - diff --git a/library/reference/tmpl/gnome-keyring-result.sgml b/library/reference/tmpl/gnome-keyring-result.sgml deleted file mode 100644 index 3ead2a66..00000000 --- a/library/reference/tmpl/gnome-keyring-result.sgml +++ /dev/null @@ -1,45 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-result - -<!-- ##### SECTION Short_Description ##### --> -Result Codes - -<!-- ##### SECTION Long_Description ##### --> -<para> -Result codes used through out GNOME Keyring. Additional result codes may be -added from time to time and these should be handled gracefully. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_result_to_message ##### --> -<para> - -</para> - -@res: -@Returns: - - -<!-- ##### ENUM GnomeKeyringResult ##### --> -<para> - -</para> - -@GNOME_KEYRING_RESULT_OK: -@GNOME_KEYRING_RESULT_DENIED: -@GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON: -@GNOME_KEYRING_RESULT_ALREADY_UNLOCKED: -@GNOME_KEYRING_RESULT_NO_SUCH_KEYRING: -@GNOME_KEYRING_RESULT_BAD_ARGUMENTS: -@GNOME_KEYRING_RESULT_IO_ERROR: -@GNOME_KEYRING_RESULT_CANCELLED: -@GNOME_KEYRING_RESULT_KEYRING_ALREADY_EXISTS: -@GNOME_KEYRING_RESULT_NO_MATCH: - diff --git a/library/reference/tmpl/gnome-keyring-unused.sgml b/library/reference/tmpl/gnome-keyring-unused.sgml deleted file mode 100644 index e69de29b..00000000 --- a/library/reference/tmpl/gnome-keyring-unused.sgml +++ /dev/null |