gnome-keyring

gnome-keyring

Synopsis




enum                GnomeKeyringResult;
enum                GnomeKeyringItemType;
enum                GnomeKeyringAccessRestriction;
enum                GnomeKeyringAttributeType;
typedef             GnomeKeyringAccessControl;
typedef             GnomeKeyringApplicationRef;
typedef             GnomeKeyringAttributeList;
enum                GnomeKeyringAccessType;
typedef             GnomeKeyringInfo;
typedef             GnomeKeyringItemInfo;
enum                GnomeKeyringItemInfoFlags;
                    GnomeKeyringAttribute;
                    GnomeKeyringFound;
void                (*GnomeKeyringOperationDoneCallback)
                                                        (GnomeKeyringResult result,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetStringCallback)
                                                        (GnomeKeyringResult result,
                                                         const char *string,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetIntCallback)
                                                        (GnomeKeyringResult result,
                                                         guint32 val,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetListCallback)
                                                        (GnomeKeyringResult result,
                                                         GList *list,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetKeyringInfoCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringInfo *info,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetItemInfoCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringItemInfo *info,
                                                         gpointer data);
void                (*GnomeKeyringOperationGetAttributesCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringAttributeList *attributes,
                                                         gpointer data);
#define             gnome_keyring_attribute_list_index  (a, i)
#define             gnome_keyring_attribute_list_new    ()
void                gnome_keyring_attribute_list_append_string
                                                        (GnomeKeyringAttributeList *attributes,
                                                         const char *attribute,
                                                         const char *value);
void                gnome_keyring_attribute_list_append_uint32
                                                        (GnomeKeyringAttributeList *attributes,
                                                         const char *attribute,
                                                         guint32 value);
void                gnome_keyring_attribute_list_free   (GnomeKeyringAttributeList *attributes);
GnomeKeyringAttributeList* gnome_keyring_attribute_list_copy
                                                        (GnomeKeyringAttributeList *attributes);
gboolean            gnome_keyring_is_available          (void);
void                gnome_keyring_free_password         (char *password);
void                gnome_keyring_found_free            (GnomeKeyringFound *found);
void                gnome_keyring_found_list_free       (GList *found_list);
void                gnome_keyring_cancel_request        (gpointer request);
gpointer            gnome_keyring_set_default_keyring   (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_set_default_keyring_sync
                                                        (const char *keyring);
gpointer            gnome_keyring_get_default_keyring   (GnomeKeyringOperationGetStringCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_get_default_keyring_sync
                                                        (char **keyring);
gpointer            gnome_keyring_list_keyring_names    (GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_list_keyring_names_sync
                                                        (GList **keyrings);
gpointer            gnome_keyring_lock_all              (GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_lock_all_sync         (void);
gpointer            gnome_keyring_create                (const char *keyring_name,
                                                         const char *password,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_create_sync           (const char *keyring_name,
                                                         const char *password);
gpointer            gnome_keyring_unlock                (const char *keyring,
                                                         const char *password,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_unlock_sync           (const char *keyring,
                                                         const char *password);
gpointer            gnome_keyring_lock                  (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_lock_sync             (const char *keyring);
gpointer            gnome_keyring_delete                (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_delete_sync           (const char *keyring);
gpointer            gnome_keyring_get_info              (const char *keyring,
                                                         GnomeKeyringOperationGetKeyringInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_get_info_sync         (const char *keyring,
                                                         GnomeKeyringInfo **info);
gpointer            gnome_keyring_set_info              (const char *keyring,
                                                         GnomeKeyringInfo *info,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_set_info_sync         (const char *keyring,
                                                         GnomeKeyringInfo *info);
gpointer            gnome_keyring_list_item_ids         (const char *keyring,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_list_item_ids_sync    (const char *keyring,
                                                         GList **ids);
void                gnome_keyring_info_free             (GnomeKeyringInfo *keyring_info);
GnomeKeyringInfo*   gnome_keyring_info_copy             (GnomeKeyringInfo *keyring_info);
void                gnome_keyring_info_set_lock_on_idle (GnomeKeyringInfo *keyring_info,
                                                         gboolean value);
gboolean            gnome_keyring_info_get_lock_on_idle (GnomeKeyringInfo *keyring_info);
void                gnome_keyring_info_set_lock_timeout (GnomeKeyringInfo *keyring_info,
                                                         guint32 value);
guint32             gnome_keyring_info_get_lock_timeout (GnomeKeyringInfo *keyring_info);
time_t              gnome_keyring_info_get_mtime        (GnomeKeyringInfo *keyring_info);
time_t              gnome_keyring_info_get_ctime        (GnomeKeyringInfo *keyring_info);
gboolean            gnome_keyring_info_get_is_locked    (GnomeKeyringInfo *keyring_info);
gpointer            gnome_keyring_find_items            (GnomeKeyringItemType type,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
gpointer            gnome_keyring_find_itemsv           (GnomeKeyringItemType type,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data,
                                                         ...);
GnomeKeyringResult  gnome_keyring_find_items_sync       (GnomeKeyringItemType type,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GList **found);
GnomeKeyringResult  gnome_keyring_find_itemsv_sync      (GnomeKeyringItemType type,
                                                         GList **found,
                                                         ...);
gpointer            gnome_keyring_item_create           (const char *keyring,
                                                         GnomeKeyringItemType type,
                                                         const char *display_name,
                                                         GnomeKeyringAttributeList *attributes,
                                                         const char *secret,
                                                         gboolean update_if_exists,
                                                         GnomeKeyringOperationGetIntCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_create_sync      (const char *keyring,
                                                         GnomeKeyringItemType type,
                                                         const char *display_name,
                                                         GnomeKeyringAttributeList *attributes,
                                                         const char *secret,
                                                         gboolean update_if_exists,
                                                         guint32 *item_id);
gpointer            gnome_keyring_item_delete           (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_delete_sync      (const char *keyring,
                                                         guint32 id);
gpointer            gnome_keyring_item_get_info         (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetItemInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
gpointer            gnome_keyring_item_get_info_full    (const char *keyring,
                                                         guint32 id,
                                                         guint32 flags,
                                                         GnomeKeyringOperationGetItemInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_get_info_full_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         guint32 flags,
                                                         GnomeKeyringItemInfo **info);
GnomeKeyringResult  gnome_keyring_item_get_info_sync    (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo **info);
gpointer            gnome_keyring_item_set_info         (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo *info,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_set_info_sync    (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo *info);
gpointer            gnome_keyring_item_get_attributes   (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetAttributesCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_get_attributes_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList **attributes);
gpointer            gnome_keyring_item_set_attributes   (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_set_attributes_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList *attributes);
gpointer            gnome_keyring_item_get_acl          (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_get_acl_sync     (const char *keyring,
                                                         guint32 id,
                                                         GList **acl);
gpointer            gnome_keyring_item_set_acl          (const char *keyring,
                                                         guint32 id,
                                                         GList *acl,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_item_set_acl_sync     (const char *keyring,
                                                         guint32 id,
                                                         GList *acl);
void                gnome_keyring_item_info_free        (GnomeKeyringItemInfo *item_info);
GnomeKeyringItemInfo* gnome_keyring_item_info_new       (void);
GnomeKeyringItemInfo* gnome_keyring_item_info_copy      (GnomeKeyringItemInfo *item_info);
GnomeKeyringItemType gnome_keyring_item_info_get_type   (GnomeKeyringItemInfo *item_info);
void                gnome_keyring_item_info_set_type    (GnomeKeyringItemInfo *item_info,
                                                         GnomeKeyringItemType type);
char*               gnome_keyring_item_info_get_secret  (GnomeKeyringItemInfo *item_info);
void                gnome_keyring_item_info_set_secret  (GnomeKeyringItemInfo *item_info,
                                                         const char *value);
char*               gnome_keyring_item_info_get_display_name
                                                        (GnomeKeyringItemInfo *item_info);
void                gnome_keyring_item_info_set_display_name
                                                        (GnomeKeyringItemInfo *item_info,
                                                         const char *value);
time_t              gnome_keyring_item_info_get_mtime   (GnomeKeyringItemInfo *item_info);
time_t              gnome_keyring_item_info_get_ctime   (GnomeKeyringItemInfo *item_info);
GnomeKeyringApplicationRef* gnome_keyring_application_ref_new
                                                        (void);
GnomeKeyringApplicationRef* gnome_keyring_application_ref_copy
                                                        (const GnomeKeyringApplicationRef *app);
void                gnome_keyring_application_ref_free  (GnomeKeyringApplicationRef *app);
GnomeKeyringAccessControl* gnome_keyring_access_control_new
                                                        (const GnomeKeyringApplicationRef *application,
                                                         GnomeKeyringAccessType types_allowed);
GnomeKeyringAccessControl* gnome_keyring_access_control_copy
                                                        (GnomeKeyringAccessControl *ac);
void                gnome_keyring_access_control_free   (GnomeKeyringAccessControl *ac);
GList*              gnome_keyring_acl_copy              (GList *list);
void                gnome_keyring_acl_free              (GList *acl);
char*               gnome_keyring_item_ac_get_display_name
                                                        (GnomeKeyringAccessControl *ac);
void                gnome_keyring_item_ac_set_display_name
                                                        (GnomeKeyringAccessControl *ac,
                                                         const char *value);
char*               gnome_keyring_item_ac_get_path_name (GnomeKeyringAccessControl *ac);
void                gnome_keyring_item_ac_set_path_name (GnomeKeyringAccessControl *ac,
                                                         const char *value);
GnomeKeyringAccessType gnome_keyring_item_ac_get_access_type
                                                        (GnomeKeyringAccessControl *ac);
void                gnome_keyring_item_ac_set_access_type
                                                        (GnomeKeyringAccessControl *ac,
                                                         const GnomeKeyringAccessType value);
                    GnomeKeyringNetworkPasswordData;
void                gnome_keyring_network_password_free (GnomeKeyringNetworkPasswordData *data);
void                gnome_keyring_network_password_list_free
                                                        (GList *list);
gpointer            gnome_keyring_find_network_password (const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_find_network_password_sync
                                                        (const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         GList **result);
gpointer            gnome_keyring_set_network_password  (const char *keyring,
                                                         const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         const char *password,
                                                         GnomeKeyringOperationGetIntCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);
GnomeKeyringResult  gnome_keyring_set_network_password_sync
                                                        (const char *keyring,
                                                         const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         const char *password,
                                                         guint32 *item_id);

Description

Details

enum GnomeKeyringResult

typedef enum {
	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_ALREADY_EXISTS
} GnomeKeyringResult;


enum GnomeKeyringItemType

typedef enum {
	/* The item types */
	GNOME_KEYRING_ITEM_GENERIC_SECRET,
	GNOME_KEYRING_ITEM_NETWORK_PASSWORD,
	GNOME_KEYRING_ITEM_NOTE,
	
	/* Used internally */
	GNOME_KEYRING_ITEM_LAST_TYPE,
	GNOME_KEYRING_ITEM_TYPE_MASK = 0x0000ffff,
	GNOME_KEYRING_ITEM_NO_TYPE = GNOME_KEYRING_ITEM_TYPE_MASK,

	/* Makes a item only for applications in ACL */
	GNOME_KEYRING_ITEM_APPLICATION_SECRET = 0x01000000,
	
} GnomeKeyringItemType;


enum GnomeKeyringAccessRestriction

typedef enum {
	GNOME_KEYRING_ACCESS_ASK,
	GNOME_KEYRING_ACCESS_DENY,
	GNOME_KEYRING_ACCESS_ALLOW
} GnomeKeyringAccessRestriction;


enum GnomeKeyringAttributeType

typedef enum {
	GNOME_KEYRING_ATTRIBUTE_TYPE_STRING,
	GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32
} GnomeKeyringAttributeType;


GnomeKeyringAccessControl

typedef struct GnomeKeyringAccessControl GnomeKeyringAccessControl;


GnomeKeyringApplicationRef

typedef struct GnomeKeyringApplicationRef GnomeKeyringApplicationRef;


GnomeKeyringAttributeList

typedef GArray GnomeKeyringAttributeList;


enum GnomeKeyringAccessType

typedef enum {
	GNOME_KEYRING_ACCESS_READ = 1<<0,
	GNOME_KEYRING_ACCESS_WRITE = 1<<1,
	GNOME_KEYRING_ACCESS_REMOVE = 1<<2
} GnomeKeyringAccessType;


GnomeKeyringInfo

typedef struct GnomeKeyringInfo GnomeKeyringInfo;


GnomeKeyringItemInfo

typedef struct GnomeKeyringItemInfo GnomeKeyringItemInfo;


enum GnomeKeyringItemInfoFlags

typedef enum {
	GNOME_KEYRING_ITEM_INFO_BASICS = 0,
	GNOME_KEYRING_ITEM_INFO_SECRET = 1<<0
} GnomeKeyringItemInfoFlags;


GnomeKeyringAttribute

typedef struct {
	char *name;
	GnomeKeyringAttributeType type;
	union {
		char *string;
		guint32 integer;
	} value;
} GnomeKeyringAttribute;


GnomeKeyringFound

typedef struct {
	char *keyring;
	guint item_id;
	GnomeKeyringAttributeList *attributes;
	char *secret;
} GnomeKeyringFound;


GnomeKeyringOperationDoneCallback ()

void                (*GnomeKeyringOperationDoneCallback)
                                                        (GnomeKeyringResult result,
                                                         gpointer data);

result :
data :

GnomeKeyringOperationGetStringCallback ()

void                (*GnomeKeyringOperationGetStringCallback)
                                                        (GnomeKeyringResult result,
                                                         const char *string,
                                                         gpointer data);

result :
string :
data :

GnomeKeyringOperationGetIntCallback ()

void                (*GnomeKeyringOperationGetIntCallback)
                                                        (GnomeKeyringResult result,
                                                         guint32 val,
                                                         gpointer data);

result :
val :
data :

GnomeKeyringOperationGetListCallback ()

void                (*GnomeKeyringOperationGetListCallback)
                                                        (GnomeKeyringResult result,
                                                         GList *list,
                                                         gpointer data);

result :
list :
data :

GnomeKeyringOperationGetKeyringInfoCallback ()

void                (*GnomeKeyringOperationGetKeyringInfoCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringInfo *info,
                                                         gpointer data);

result :
info :
data :

GnomeKeyringOperationGetItemInfoCallback ()

void                (*GnomeKeyringOperationGetItemInfoCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringItemInfo *info,
                                                         gpointer data);

result :
info :
data :

GnomeKeyringOperationGetAttributesCallback ()

void                (*GnomeKeyringOperationGetAttributesCallback)
                                                        (GnomeKeyringResult result,
                                                         GnomeKeyringAttributeList *attributes,
                                                         gpointer data);

result :
attributes :
data :

gnome_keyring_attribute_list_index()

#define             gnome_keyring_attribute_list_index(a, i)

a :
i :

gnome_keyring_attribute_list_new()

#define             gnome_keyring_attribute_list_new()


gnome_keyring_attribute_list_append_string ()

void                gnome_keyring_attribute_list_append_string
                                                        (GnomeKeyringAttributeList *attributes,
                                                         const char *attribute,
                                                         const char *value);

Store a key-value-pair with a string value in attributes.

attributes : a GnomeKeyringAttributeList
attribute :
value : the value to store in attributes

gnome_keyring_attribute_list_append_uint32 ()

void                gnome_keyring_attribute_list_append_uint32
                                                        (GnomeKeyringAttributeList *attributes,
                                                         const char *attribute,
                                                         guint32 value);

attributes :
attribute :
value :

gnome_keyring_attribute_list_free ()

void                gnome_keyring_attribute_list_free   (GnomeKeyringAttributeList *attributes);

Free the memory used by attributes.

attributes : a GnomeKeyringAttributeList

gnome_keyring_attribute_list_copy ()

GnomeKeyringAttributeList* gnome_keyring_attribute_list_copy
                                                        (GnomeKeyringAttributeList *attributes);

attributes :
Returns :

gnome_keyring_is_available ()

gboolean            gnome_keyring_is_available          (void);

Check whether you can communicate with a Gnome Keyring Daemon.

Returns : FALSE if you can't communicate with the daemon (so you can't load and save passwords).

gnome_keyring_free_password ()

void                gnome_keyring_free_password         (char *password);

Clears the memory used by password by filling with '\0' and frees the memory after doing this. You should use this function instead of g_free() for secret information.

password :

gnome_keyring_found_free ()

void                gnome_keyring_found_free            (GnomeKeyringFound *found);

Free the memory used by a GnomeKeyringFound item.

You usually want to use gnome_keyring_found_list_free() on the list of results.

found : a GnomeKeyringFound

gnome_keyring_found_list_free ()

void                gnome_keyring_found_list_free       (GList *found_list);

Free the memory used by the GnomeKeyringFound items in found_list.

found_list : a GList of GnomeKeyringFound

gnome_keyring_cancel_request ()

void                gnome_keyring_cancel_request        (gpointer request);

request :

gnome_keyring_set_default_keyring ()

gpointer            gnome_keyring_set_default_keyring   (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
callback :
data :
destroy_data :
Returns :

gnome_keyring_set_default_keyring_sync ()

GnomeKeyringResult  gnome_keyring_set_default_keyring_sync
                                                        (const char *keyring);

keyring :
Returns :

gnome_keyring_get_default_keyring ()

gpointer            gnome_keyring_get_default_keyring   (GnomeKeyringOperationGetStringCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

callback :
data :
destroy_data :
Returns :

gnome_keyring_get_default_keyring_sync ()

GnomeKeyringResult  gnome_keyring_get_default_keyring_sync
                                                        (char **keyring);

keyring :
Returns :

gnome_keyring_list_keyring_names ()

gpointer            gnome_keyring_list_keyring_names    (GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

callback :
data :
destroy_data :
Returns :

gnome_keyring_list_keyring_names_sync ()

GnomeKeyringResult  gnome_keyring_list_keyring_names_sync
                                                        (GList **keyrings);

keyrings :
Returns :

gnome_keyring_lock_all ()

gpointer            gnome_keyring_lock_all              (GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

callback :
data :
destroy_data :
Returns :

gnome_keyring_lock_all_sync ()

GnomeKeyringResult  gnome_keyring_lock_all_sync         (void);

Returns :

gnome_keyring_create ()

gpointer            gnome_keyring_create                (const char *keyring_name,
                                                         const char *password,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring_name :
password :
callback :
data :
destroy_data :
Returns :

gnome_keyring_create_sync ()

GnomeKeyringResult  gnome_keyring_create_sync           (const char *keyring_name,
                                                         const char *password);

keyring_name :
password :
Returns :

gnome_keyring_unlock ()

gpointer            gnome_keyring_unlock                (const char *keyring,
                                                         const char *password,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
password :
callback :
data :
destroy_data :
Returns :

gnome_keyring_unlock_sync ()

GnomeKeyringResult  gnome_keyring_unlock_sync           (const char *keyring,
                                                         const char *password);

keyring :
password :
Returns :

gnome_keyring_lock ()

gpointer            gnome_keyring_lock                  (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
callback :
data :
destroy_data :
Returns :

gnome_keyring_lock_sync ()

GnomeKeyringResult  gnome_keyring_lock_sync             (const char *keyring);

keyring :
Returns :

gnome_keyring_delete ()

gpointer            gnome_keyring_delete                (const char *keyring,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
callback :
data :
destroy_data :
Returns :

gnome_keyring_delete_sync ()

GnomeKeyringResult  gnome_keyring_delete_sync           (const char *keyring);

keyring :
Returns :

gnome_keyring_get_info ()

gpointer            gnome_keyring_get_info              (const char *keyring,
                                                         GnomeKeyringOperationGetKeyringInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
callback :
data :
destroy_data :
Returns :

gnome_keyring_get_info_sync ()

GnomeKeyringResult  gnome_keyring_get_info_sync         (const char *keyring,
                                                         GnomeKeyringInfo **info);

keyring :
info :
Returns :

gnome_keyring_set_info ()

gpointer            gnome_keyring_set_info              (const char *keyring,
                                                         GnomeKeyringInfo *info,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
info :
callback :
data :
destroy_data :
Returns :

gnome_keyring_set_info_sync ()

GnomeKeyringResult  gnome_keyring_set_info_sync         (const char *keyring,
                                                         GnomeKeyringInfo *info);

keyring :
info :
Returns :

gnome_keyring_list_item_ids ()

gpointer            gnome_keyring_list_item_ids         (const char *keyring,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
callback :
data :
destroy_data :
Returns :

gnome_keyring_list_item_ids_sync ()

GnomeKeyringResult  gnome_keyring_list_item_ids_sync    (const char *keyring,
                                                         GList **ids);

keyring :
ids :
Returns :

gnome_keyring_info_free ()

void                gnome_keyring_info_free             (GnomeKeyringInfo *keyring_info);

keyring_info :

gnome_keyring_info_copy ()

GnomeKeyringInfo*   gnome_keyring_info_copy             (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_info_set_lock_on_idle ()

void                gnome_keyring_info_set_lock_on_idle (GnomeKeyringInfo *keyring_info,
                                                         gboolean value);

keyring_info :
value :

gnome_keyring_info_get_lock_on_idle ()

gboolean            gnome_keyring_info_get_lock_on_idle (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_info_set_lock_timeout ()

void                gnome_keyring_info_set_lock_timeout (GnomeKeyringInfo *keyring_info,
                                                         guint32 value);

keyring_info :
value :

gnome_keyring_info_get_lock_timeout ()

guint32             gnome_keyring_info_get_lock_timeout (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_info_get_mtime ()

time_t              gnome_keyring_info_get_mtime        (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_info_get_ctime ()

time_t              gnome_keyring_info_get_ctime        (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_info_get_is_locked ()

gboolean            gnome_keyring_info_get_is_locked    (GnomeKeyringInfo *keyring_info);

keyring_info :
Returns :

gnome_keyring_find_items ()

gpointer            gnome_keyring_find_items            (GnomeKeyringItemType type,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

type :
attributes :
callback :
data :
destroy_data :
Returns :

gnome_keyring_find_itemsv ()

gpointer            gnome_keyring_find_itemsv           (GnomeKeyringItemType type,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data,
                                                         ...);

type :
callback :
data :
destroy_data :
... :
Returns :

gnome_keyring_find_items_sync ()

GnomeKeyringResult  gnome_keyring_find_items_sync       (GnomeKeyringItemType type,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GList **found);

Find elements of type GnomeKeyring by matching attributes and type.

type : a GnomeKeyringItemType
attributes : a GnomeKeyringAttributeList
found : a return location for the found items, must not be NULL
Returns : GNOME_KEYRING_RESULT_OK if everythink went fine. A GList of GnomeKeyringFound will be returned into found, free all results with gnome_keyring_found_list_free() or every single item with gnome_keyring_found_free()

gnome_keyring_find_itemsv_sync ()

GnomeKeyringResult  gnome_keyring_find_itemsv_sync      (GnomeKeyringItemType type,
                                                         GList **found,
                                                         ...);

type :
found :
... :
Returns :

gnome_keyring_item_create ()

gpointer            gnome_keyring_item_create           (const char *keyring,
                                                         GnomeKeyringItemType type,
                                                         const char *display_name,
                                                         GnomeKeyringAttributeList *attributes,
                                                         const char *secret,
                                                         gboolean update_if_exists,
                                                         GnomeKeyringOperationGetIntCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
type :
display_name :
attributes :
secret :
update_if_exists :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_create_sync ()

GnomeKeyringResult  gnome_keyring_item_create_sync      (const char *keyring,
                                                         GnomeKeyringItemType type,
                                                         const char *display_name,
                                                         GnomeKeyringAttributeList *attributes,
                                                         const char *secret,
                                                         gboolean update_if_exists,
                                                         guint32 *item_id);

Create (or update of update_if_exists is set) a keyring item with the specified type, attributes and secret.

keyring : the keyring name (NULL for default)
type : the GnomeKeyringItemType of the item to save
display_name : the name for this item to be used in the password manager
attributes : the attributes specifying the keyring item
secret : the secret information (password, passphrase, pin, etc) to be saved
update_if_exists : set to TRUE to update an existing item, if found. Create a new one otherwise. Only item attributes are matched.
item_id : return location for the id of the created/updated keyring item.
Returns : GNOME_KEYRING_RESULT_OK if everything went fine.

gnome_keyring_item_delete ()

gpointer            gnome_keyring_item_delete           (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_delete_sync ()

GnomeKeyringResult  gnome_keyring_item_delete_sync      (const char *keyring,
                                                         guint32 id);

Deletes an item from your keyring. Obtain id by calling a function like gnome_keyring_find_items_sync() or gnome_keyring_item_create_sync().

keyring : the keyring to work with (NULL for the default keyring)
id : the keyring item id to delete
Returns : GNOME_KEYRING_RESULT_OK on success, the error code otherwise.

gnome_keyring_item_get_info ()

gpointer            gnome_keyring_item_get_info         (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetItemInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_get_info_full ()

gpointer            gnome_keyring_item_get_info_full    (const char *keyring,
                                                         guint32 id,
                                                         guint32 flags,
                                                         GnomeKeyringOperationGetItemInfoCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
flags :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_get_info_full_sync ()

GnomeKeyringResult  gnome_keyring_item_get_info_full_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         guint32 flags,
                                                         GnomeKeyringItemInfo **info);

keyring :
id :
flags :
info :
Returns :

gnome_keyring_item_get_info_sync ()

GnomeKeyringResult  gnome_keyring_item_get_info_sync    (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo **info);

keyring :
id :
info :
Returns :

gnome_keyring_item_set_info ()

gpointer            gnome_keyring_item_set_info         (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo *info,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
info :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_set_info_sync ()

GnomeKeyringResult  gnome_keyring_item_set_info_sync    (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringItemInfo *info);

keyring :
id :
info :
Returns :

gnome_keyring_item_get_attributes ()

gpointer            gnome_keyring_item_get_attributes   (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetAttributesCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_get_attributes_sync ()

GnomeKeyringResult  gnome_keyring_item_get_attributes_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList **attributes);

keyring :
id :
attributes :
Returns :

gnome_keyring_item_set_attributes ()

gpointer            gnome_keyring_item_set_attributes   (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList *attributes,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
attributes :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_set_attributes_sync ()

GnomeKeyringResult  gnome_keyring_item_set_attributes_sync
                                                        (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringAttributeList *attributes);

keyring :
id :
attributes :
Returns :

gnome_keyring_item_get_acl ()

gpointer            gnome_keyring_item_get_acl          (const char *keyring,
                                                         guint32 id,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_get_acl_sync ()

GnomeKeyringResult  gnome_keyring_item_get_acl_sync     (const char *keyring,
                                                         guint32 id,
                                                         GList **acl);

keyring :
id :
acl :
Returns :

gnome_keyring_item_set_acl ()

gpointer            gnome_keyring_item_set_acl          (const char *keyring,
                                                         guint32 id,
                                                         GList *acl,
                                                         GnomeKeyringOperationDoneCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
id :
acl :
callback :
data :
destroy_data :
Returns :

gnome_keyring_item_set_acl_sync ()

GnomeKeyringResult  gnome_keyring_item_set_acl_sync     (const char *keyring,
                                                         guint32 id,
                                                         GList *acl);

keyring :
id :
acl :
Returns :

gnome_keyring_item_info_free ()

void                gnome_keyring_item_info_free        (GnomeKeyringItemInfo *item_info);

item_info :

gnome_keyring_item_info_new ()

GnomeKeyringItemInfo* gnome_keyring_item_info_new       (void);

Returns :

gnome_keyring_item_info_copy ()

GnomeKeyringItemInfo* gnome_keyring_item_info_copy      (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_item_info_get_type ()

GnomeKeyringItemType gnome_keyring_item_info_get_type   (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_item_info_set_type ()

void                gnome_keyring_item_info_set_type    (GnomeKeyringItemInfo *item_info,
                                                         GnomeKeyringItemType type);

item_info :
type :

gnome_keyring_item_info_get_secret ()

char*               gnome_keyring_item_info_get_secret  (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_item_info_set_secret ()

void                gnome_keyring_item_info_set_secret  (GnomeKeyringItemInfo *item_info,
                                                         const char *value);

item_info :
value :

gnome_keyring_item_info_get_display_name ()

char*               gnome_keyring_item_info_get_display_name
                                                        (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_item_info_set_display_name ()

void                gnome_keyring_item_info_set_display_name
                                                        (GnomeKeyringItemInfo *item_info,
                                                         const char *value);

item_info :
value :

gnome_keyring_item_info_get_mtime ()

time_t              gnome_keyring_item_info_get_mtime   (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_item_info_get_ctime ()

time_t              gnome_keyring_item_info_get_ctime   (GnomeKeyringItemInfo *item_info);

item_info :
Returns :

gnome_keyring_application_ref_new ()

GnomeKeyringApplicationRef* gnome_keyring_application_ref_new
                                                        (void);

Returns :

gnome_keyring_application_ref_copy ()

GnomeKeyringApplicationRef* gnome_keyring_application_ref_copy
                                                        (const GnomeKeyringApplicationRef *app);

app :
Returns :

gnome_keyring_application_ref_free ()

void                gnome_keyring_application_ref_free  (GnomeKeyringApplicationRef *app);

app :

gnome_keyring_access_control_new ()

GnomeKeyringAccessControl* gnome_keyring_access_control_new
                                                        (const GnomeKeyringApplicationRef *application,
                                                         GnomeKeyringAccessType types_allowed);

application :
types_allowed :
Returns :

gnome_keyring_access_control_copy ()

GnomeKeyringAccessControl* gnome_keyring_access_control_copy
                                                        (GnomeKeyringAccessControl *ac);

ac :
Returns :

gnome_keyring_access_control_free ()

void                gnome_keyring_access_control_free   (GnomeKeyringAccessControl *ac);

ac :

gnome_keyring_acl_copy ()

GList*              gnome_keyring_acl_copy              (GList *list);

list :
Returns :

gnome_keyring_acl_free ()

void                gnome_keyring_acl_free              (GList *acl);

acl :

gnome_keyring_item_ac_get_display_name ()

char*               gnome_keyring_item_ac_get_display_name
                                                        (GnomeKeyringAccessControl *ac);

ac :
Returns :

gnome_keyring_item_ac_set_display_name ()

void                gnome_keyring_item_ac_set_display_name
                                                        (GnomeKeyringAccessControl *ac,
                                                         const char *value);

ac :
value :

gnome_keyring_item_ac_get_path_name ()

char*               gnome_keyring_item_ac_get_path_name (GnomeKeyringAccessControl *ac);

ac :
Returns :

gnome_keyring_item_ac_set_path_name ()

void                gnome_keyring_item_ac_set_path_name (GnomeKeyringAccessControl *ac,
                                                         const char *value);

ac :
value :

gnome_keyring_item_ac_get_access_type ()

GnomeKeyringAccessType gnome_keyring_item_ac_get_access_type
                                                        (GnomeKeyringAccessControl *ac);

ac :
Returns :

gnome_keyring_item_ac_set_access_type ()

void                gnome_keyring_item_ac_set_access_type
                                                        (GnomeKeyringAccessControl *ac,
                                                         const GnomeKeyringAccessType value);

ac :
value :

GnomeKeyringNetworkPasswordData

typedef struct {
	char *keyring;
	guint32 item_id;

	char *protocol;
	char *server;
	char *object;
	char *authtype;
	guint32 port;

	char *user;
	char *domain;
	char *password;
} GnomeKeyringNetworkPasswordData;


gnome_keyring_network_password_free ()

void                gnome_keyring_network_password_free (GnomeKeyringNetworkPasswordData *data);

data :

gnome_keyring_network_password_list_free ()

void                gnome_keyring_network_password_list_free
                                                        (GList *list);

list :

gnome_keyring_find_network_password ()

gpointer            gnome_keyring_find_network_password (const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         GnomeKeyringOperationGetListCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

user :
domain :
server :
object :
protocol :
authtype :
port :
callback :
data :
destroy_data :
Returns :

gnome_keyring_find_network_password_sync ()

GnomeKeyringResult  gnome_keyring_find_network_password_sync
                                                        (const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         GList **result);

user :
domain :
server :
object :
protocol :
authtype :
port :
result :
Returns :

gnome_keyring_set_network_password ()

gpointer            gnome_keyring_set_network_password  (const char *keyring,
                                                         const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         const char *password,
                                                         GnomeKeyringOperationGetIntCallback callback,
                                                         gpointer data,
                                                         GDestroyNotify destroy_data);

keyring :
user :
domain :
server :
object :
protocol :
authtype :
port :
password :
callback :
data :
destroy_data :
Returns :

gnome_keyring_set_network_password_sync ()

GnomeKeyringResult  gnome_keyring_set_network_password_sync
                                                        (const char *keyring,
                                                         const char *user,
                                                         const char *domain,
                                                         const char *server,
                                                         const char *object,
                                                         const char *protocol,
                                                         const char *authtype,
                                                         guint32 port,
                                                         const char *password,
                                                         guint32 *item_id);

keyring :
user :
domain :
server :
object :
protocol :
authtype :
port :
password :
item_id :
Returns :