| libcryptui Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
enum CryptUIEncType; enum CryptUIKeyFlags; enum CryptUILocation; enum CryptUIValidity; gchar* cryptui_key_get_base (const gchar *key); CryptUIEncType cryptui_key_get_enctype (const gchar *key); void cryptui_display_notification (const gchar *title,const gchar *body,const gchar *icon,gboolean urgent); gchar** cryptui_prompt_recipients (CryptUIKeyset *keyset,const gchar *title,gchar **signer); gchar* cryptui_prompt_signer (CryptUIKeyset *keyset,const gchar *title); void cryptui_need_to_get_keys ();
typedef enum {
CRYPTUI_ENCTYPE_NONE = 0,
CRYPTUI_ENCTYPE_SYMMETRIC = 1,
CRYPTUI_ENCTYPE_PUBLIC = 2,
CRYPTUI_ENCTYPE_PRIVATE = 3,
/* Used internally */
CRYPTUI_ENCTYPE_MAXVALUE
} CryptUIEncType;
Used in key properties to indicate what kind of key it is
Never ever change a values already present. These values are used across applications, DBus etc...
typedef enum {
CRYPTUI_FLAG_IS_VALID = 0x00000001,
CRYPTUI_FLAG_CAN_ENCRYPT = 0x00000002,
CRYPTUI_FLAG_CAN_SIGN = 0x00000004,
CRYPTUI_FLAG_EXPIRED = 0x00000100,
CRYPTUI_FLAG_REVOKED = 0x00000200,
CRYPTUI_FLAG_DISABLED = 0x00000400,
CRYPTUI_FLAG_TRUSTED = 0x00001000,
CRYPTUI_FLAG_EXPORTABLE = 0x00100000
} CryptUIKeyFlags;
Used in key properties to indicate a key's status. These values are logically OR'd together.
Never ever change a values already present. These values are used across applications, DBus etc...
| whether the key is valid | |
| whether the key can encrypt | |
| whether the key can sign | |
| whether the key is expired | |
| whether the key is revoked | |
| whether the key is disabled | |
| whether the key is trusted | |
| whether the key is exportable |
typedef enum {
CRYPTUI_LOC_INVALID = 0,
CRYPTUI_LOC_MISSING = 10,
CRYPTUI_LOC_SEARCHING = 20,
CRYPTUI_LOC_REMOTE = 50,
CRYPTUI_LOC_LOCAL = 100,
} CryptUILocation;
Indicates where a key is located.
Never ever change a values already present. These values are used across applications, DBus etc...
typedef enum {
CRYPTUI_VALIDITY_REVOKED = -3,
CRYPTUI_VALIDITY_DISABLED = -2,
CRYPTUI_VALIDITY_NEVER = -1,
CRYPTUI_VALIDITY_UNKNOWN = 0,
CRYPTUI_VALIDITY_MARGINAL = 1,
CRYPTUI_VALIDITY_FULL = 5,
CRYPTUI_VALIDITY_ULTIMATE = 10
} CryptUIValidity;
What the validity of the key is.
Never ever change a values already present. These values are used across applications, DBus etc...
| the key is revoked | |
| the key is disabled | |
| the key has never been valid | |
| the key's validity is unknown | |
| the key's validity is marginal | |
| the key's validity is full | |
| the key's validity is ultimate |
gchar* cryptui_key_get_base (const gchar *key);
This function is a utility function to get the part of the key that preceeds the colon.
|
key for use with libcryptui. [in] |
Returns : |
the key base if one is found in key
or key if it is already a base or is invalid
|
CryptUIEncType cryptui_key_get_enctype (const gchar *key);
A utility function to get the type of key passed in. (public, private, symmetric, etc.).
|
key for use with libcryptui. [in] |
Returns : |
The type of key. |
void cryptui_display_notification (const gchar *title,const gchar *body,const gchar *icon,gboolean urgent);
This function creates a notification bubble that can be updated as additional key details are discovered. See http://live.gnome.org/Seahorse/DBus for a description of the markup syntax.
|
Headline for the notification. [in][allow-none] |
|
Text for the body of the notification. [in][allow-none] |
|
Full path to icon to be included. [in][allow-none] |
|
Whether the notification is urgent or not. [in][allow-none] |
gchar** cryptui_prompt_recipients (CryptUIKeyset *keyset,const gchar *title,gchar **signer);
This function prompts the user to select one or more keys from the keyset to use to encrypt to. It also allows the user to select a private key from the keyset to sign with.
|
CryptUIKeyset to select keys to present to the user from |
|
Window title for presented GtkWindow |
|
Variable in which to store the key of the signer if one is selected |
Returns : |
the selected key |
gchar* cryptui_prompt_signer (CryptUIKeyset *keyset,const gchar *title);
This function prompts the user to select a private key from the keyset to use to sign something.
|
CryptUIKeyset to select keys to present to the user from |
|
Window title for presented GtkWindow |
Returns : |
the selected key |