GCR_DATA_ERROR

#define             GCR_DATA_ERROR                    (gcr_data_error_get_domain ())

The GError domain for data parsing errors.

enum GcrDataError

typedef enum {
	GCR_ERROR_FAILURE = -1,
	GCR_ERROR_UNRECOGNIZED = 1,
	GCR_ERROR_CANCELLED = 2,
	GCR_ERROR_LOCKED = 3
} GcrDataError;

Values responding to error codes for parsing and serializing data.

enum GcrDataFormat

typedef enum {
	GCR_FORMAT_INVALID = 0,

	GCR_FORMAT_DER_PRIVATE_KEY = 100,
	GCR_FORMAT_DER_PRIVATE_KEY_RSA,
	GCR_FORMAT_DER_PRIVATE_KEY_DSA,

	GCR_FORMAT_DER_CERTIFICATE_X509 = 200,

	GCR_FORMAT_DER_PKCS7 = 300,

	GCR_FORMAT_DER_PKCS8 = 400,
	GCR_FORMAT_DER_PKCS8_PLAIN,
	GCR_FORMAT_DER_PKCS8_ENCRYPTED,

	GCR_FORMAT_DER_PKCS12 = 500,

	GCR_FORMAT_PEM = 1000,
	GCR_FORMAT_PEM_PRIVATE_KEY_RSA,
	GCR_FORMAT_PEM_PRIVATE_KEY_DSA,
	GCR_FORMAT_PEM_CERTIFICATE_X509,
	GCR_FORMAT_PEM_PKCS7,
	GCR_FORMAT_PEM_PKCS8_PLAIN,
	GCR_FORMAT_PEM_PKCS8_ENCRYPTED,
	GCR_FORMAT_PEM_PKCS12
} GcrDataFormat;

The various format identifiers.

struct GcrParser

struct GcrParser;

A parser for parsing various types of files or data.

struct GcrParserClass

struct GcrParserClass {
	GObjectClass parent_class;

	/* signals --------------------------------------------------------- */

	/* A callback for each password needed */
	gboolean (*authenticate) (GcrParser *self, gint count);
	
	void     (*parsed) (GcrParser *self);
};

The class for GcrParser

gcr_parser_new ()

GcrParser *         gcr_parser_new                      (void);

Create a new GcrParser

gcr_parser_parse_data ()

gboolean            gcr_parser_parse_data               (GcrParser *self,
                                                         gconstpointer data,
                                                         gsize n_data,
                                                         GError **error);

Parse the data. The GcrParser::parsed and GcrParser::authenticate signals may fire during the parsing.

gcr_parser_parse_stream ()

gboolean            gcr_parser_parse_stream             (GcrParser *self,
                                                         GInputStream *input,
                                                         GCancellable *cancellable,
                                                         GError **error);

Parse items from the data in a GInputStream. This function may block while reading from the input stream. Use gcr_parser_parse_stream_async() for a non-blocking variant.

The GcrParser::parsed and GcrParser::authenticate signals may fire during the parsing.

gcr_parser_parse_stream_async ()

void                gcr_parser_parse_stream_async       (GcrParser *self,
                                                         GInputStream *input,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Parse items from the data in a GInputStream. This function completes asyncronously and doesn't block.

The GcrParser::parsed and GcrParser::authenticate signals may fire during the parsing.

gcr_parser_parse_stream_finish ()

gboolean            gcr_parser_parse_stream_finish      (GcrParser *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Complete an operation to parse a stream.

gcr_parser_format_enable ()

void                gcr_parser_format_enable            (GcrParser *self,
                                                         gint format_id);

Enable parsing of the given format. Use -1 to enable all the formats.

gcr_parser_format_disable ()

void                gcr_parser_format_disable           (GcrParser *self,
                                                         gint format_id);

Disable parsing of the given format. Use -1 to disable all the formats.

gcr_parser_format_supported ()

gboolean            gcr_parser_format_supported         (GcrParser *self,
                                                         gint format_id);

Check whether the given format is supported by the parser.

gcr_parser_add_password ()

void                gcr_parser_add_password             (GcrParser *self,
                                                         const gchar *password);

Add a password to the set of passwords to try when parsing locked or encrypted items. This is usually called from the GcrParser::authenticate signal.

gcr_parser_get_parsed_label ()

const gchar *       gcr_parser_get_parsed_label         (GcrParser *self);

Get the label of the currently parsed item. This is generally only valid during the GcrParser::parsed signal.

gcr_parser_get_parsed_description ()

const gchar *       gcr_parser_get_parsed_description   (GcrParser *self);

Get a description for the type of the currently parsed item. This is generally only valid during the GcrParser::parsed signal.

gcr_parser_get_parsed_attributes ()

GckAttributes *     gcr_parser_get_parsed_attributes    (GcrParser *self);

Get the attributes which make up the currently parsed item. This is generally only valid during the GcrParser::parsed signal.

gcr_parser_get_parsed_block ()

gconstpointer       gcr_parser_get_parsed_block         (GcrParser *self,
                                                         gsize *n_block);

Get the raw data block that represents this parsed object. This is only valid during the GcrParser::parsed signal.

The "parsed-attributes" property

  "parsed-attributes"        GckAttributes*        : Read

Get the attributes that make up the currently parsed item. This is generally only valid during a "parsed" signal.

The "parsed-description" property

  "parsed-description"       gchar*                : Read

The description of the type of the currently parsed item. This is generally only valid during a "parsed" signal.

Default value: ""

The "parsed-label" property

  "parsed-label"             gchar*                : Read

The label of the currently parsed item. This is generally only valid during a "parsed" signal.

Default value: ""

The "authenticate" signal

gboolean            user_function                      (GcrParser *count,
                                                        gpointer   Returns,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when an item needs to be unlocked or decrypted before it can be parsed. The count argument specifies the number of times the signal has been emitted for a given item. This can be used to display a message saying the previous password was incorrect.

Typically the gcr_parser_add_password() function is called in response to this signal.

If FALSE is returned, then the authentication was not handled. If no handlers return TRUE then the item is not parsed and an error with the code GCR_ERROR_CANCELLED will be raised.

The "parsed" signal

void                user_function                      (GcrParser *arg0,
                                                        gpointer   user_data)      : Run First

This signal is emitted when an item is sucessfully parsed. To access the information about the item use the gcr_parser_get_parsed_label(), gcr_parser_get_parsed_attributes() and gcr_parser_get_parsed_description() functions.