gpgmeutils.h File Reference

Protos and data structures for GPGME utilities. More...

#include <glib.h>
#include <gpgme.h>

Include dependency graph for gpgmeutils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	log_gpgme (GLogLevelFlags, gpg_error_t, const char *,...)
	Log function with extra gpg-error style output.
gpgme_ctx_t	gvm_init_gpgme_ctx_from_dir (const gchar *)
	Returns a new gpgme context.
int	gvm_gpg_import_many_types_from_string (gpgme_ctx_t, const char *, ssize_t, GArray *)
	Import a key or certificate given by a string.
int	gvm_gpg_import_from_string (gpgme_ctx_t, const char *, ssize_t, gpgme_data_type_t)
	Import a key or certificate given by a string.
int	gvm_pgp_pubkey_encrypt_stream (FILE *, FILE *, const char *, const char *, ssize_t)
	Encrypt a stream for a PGP public key, writing to another stream.
int	gvm_smime_encrypt_stream (FILE *, FILE *, const char *, const char *, ssize_t)
	Encrypt a stream for a S/MIME certificate, writing to another stream.

Detailed Description

Protos and data structures for GPGME utilities.

This file contains the protos for gpgmeutils.c

Definition in file gpgmeutils.h.

Function Documentation

gvm_gpg_import_from_string()

int gvm_gpg_import_from_string	(	gpgme_ctx_t	ctx,
		const char *	key_str,
		ssize_t	key_len,
		gpgme_data_type_t	key_type )

Import a key or certificate given by a string.

Parameters

[in]	ctx	The GPGME context to import the key / certificate into.
[in]	key_str	Key or certificate string.
[in]	key_len	Length of key/certificate string or -1 to use strlen.
[in]	key_type	The expected key type.

Returns

0 success, 1 invalid key data, 2 unexpected key data, 3 error importing key/certificate, -1 error.

Definition at line 264 of file gpgmeutils.c.

{
  int ret;
  GArray *key_types =
    g_array_sized_new (FALSE, FALSE, sizeof (gpgme_data_type_t), 1);
  g_array_insert_val (key_types, 0, key_type);
  ret =
    gvm_gpg_import_many_types_from_string (ctx, key_str, key_len, key_types);
  g_array_free (key_types, TRUE);
  return ret;
}

References gvm_gpg_import_many_types_from_string().

Here is the call graph for this function:

gvm_gpg_import_many_types_from_string()

int gvm_gpg_import_many_types_from_string	(	gpgme_ctx_t	ctx,
		const char *	key_str,
		ssize_t	key_len,
		GArray *	key_types )

Import a key or certificate given by a string.

Parameters

[in]	ctx	The GPGME context to import the key / certificate into.
[in]	key_str	Key or certificate string.
[in]	key_len	Length of key/certificate string or -1 to use strlen.
[in]	key_types	GArray of expected key types.

Returns

0 success, 1 invalid key data, 2 unexpected key data, 3 error importing key/certificate, -1 error.

Definition at line 166 of file gpgmeutils.c.

{
  gpgme_data_t key_data;
  gpgme_error_t err;
  gpgme_data_type_t given_key_type;
  gpgme_import_result_t import_result;
  int ret;
 
  gpgme_data_new_from_mem (
    &key_data, key_str, (key_len >= 0 ? key_len : (ssize_t) strlen (key_str)),
    0);
 
  given_key_type = gpgme_data_identify (key_data, 0);
  ret = 0;
  if (given_key_type == GPGME_DATA_TYPE_INVALID)
    {
      ret = 1;
      g_warning ("%s: key_str is invalid", __func__);
    }
  else
    {
      unsigned int index;
      for (index = 0; index < key_types->len; index++)
        {
          if (g_array_index (key_types, gpgme_data_type_t, index)
              == given_key_type)
            break;
        }
 
      if (index >= key_types->len)
        {
          ret = 2;
          GString *expected_buffer = g_string_new ("");
          for (index = 0; index < key_types->len; index++)
            {
              if (index)
                g_string_append (expected_buffer, " or ");
              g_string_append_printf (
                expected_buffer, "%d",
                g_array_index (key_types, gpgme_data_type_t, index));
            }
          g_warning ("%s: key_str is not the expected type: "
                     " expected: %s, got %d",
                     __func__, expected_buffer->str, given_key_type);
          g_string_free (expected_buffer, TRUE);
        }
    }
 
  if (ret)
    {
      gpgme_data_release (key_data);
      return ret;
    }
 
  err = gpgme_op_import (ctx, key_data);
  gpgme_data_release (key_data);
  if (err)
    {
      g_warning ("%s: Import failed: %s", __func__, gpgme_strerror (err));
      return 3;
    }
 
  import_result = gpgme_op_import_result (ctx);
  g_debug ("%s: %d imported, %d not imported", __func__,
           import_result->imported, import_result->not_imported);
 
  gpgme_import_status_t status;
  status = import_result->imports;
  while (status)
    {
      if (status->result != GPG_ERR_NO_ERROR)
        g_warning ("%s: '%s' could not be imported: %s", __func__, status->fpr,
                   gpgme_strerror (status->result));
      else
        g_debug ("%s: Imported '%s'", __func__, status->fpr);
 
      status = status->next;
    };
 
  if (import_result->not_imported)
    return 3;
 
  return 0;
}

Referenced by encrypt_stream_internal(), and gvm_gpg_import_from_string().

Here is the caller graph for this function:

gvm_init_gpgme_ctx_from_dir()

gpgme_ctx_t gvm_init_gpgme_ctx_from_dir

(

const gchar *

dir

)

Returns a new gpgme context.

Inits a gpgme context with the custom gpg directory, protocol version etc. Returns the context or NULL if an error occurred. This function also does an gpgme initialization the first time it is called.

Parameters

dir	Directory to use for gpg

Returns

The gpgme_ctx_t to the context or NULL if an error occurred.

Definition at line 74 of file gpgmeutils.c.

{
  static int initialized;
  gpgme_error_t err;
  gpgme_ctx_t ctx;
 
  /* Initialize GPGME the first time we are called.  This is a
     failsafe mode; it would be better to initialize GPGME early at
     process startup instead of this on-the-fly method; however in
     this non-threaded system; this is an easier way for a library.
     We allow to initialize until a valid gpgme or a gpg backend has
     been found.  */
  if (!initialized)
    {
      gpgme_engine_info_t info;
 
      if (!gpgme_check_version (NULL))
        {
          g_critical ("gpgme library could not be initialized.");
          return NULL;
        }
      gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
#ifdef LC_MESSAGES
      gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
#endif
 
#ifndef NDEBUG
      g_message ("Setting GnuPG dir to '%s'", dir);
#endif
      err = 0;
      if (access (dir, F_OK))
        {
          err = gpg_error_from_syserror ();
 
          if (errno == ENOENT)
            /* directory does not exists. try to create it */
            if (mkdir (dir, 0700) == 0)
              {
#ifndef NDEBUG
                g_message ("Created GnuPG dir '%s'", dir);
#endif
                err = 0;
              }
        }
 
      if (!err)
        err = gpgme_set_engine_info (GPGME_PROTOCOL_OpenPGP, NULL, dir);
 
      if (err)
        {
          log_gpgme (G_LOG_LEVEL_WARNING, err, "Setting GnuPG dir failed");
          return NULL;
        }
 
      /* Show the OpenPGP engine version.  */
      if (!gpgme_get_engine_info (&info))
        {
          while (info && info->protocol != GPGME_PROTOCOL_OpenPGP)
            info = info->next;
        }
      else
        info = NULL;
#ifndef NDEBUG
      g_message ("Using OpenPGP engine version '%s'",
                 info && info->version ? info->version : "[?]");
#endif
 
      /* Everything is fine.  */
      initialized = 1;
    }
 
  /* Allocate the context.  */
  ctx = NULL;
  err = gpgme_new (&ctx);
  if (err)
    log_gpgme (G_LOG_LEVEL_WARNING, err, "Creating GPGME context failed");
 
  return ctx;
}

References initialized, and log_gpgme().

Here is the call graph for this function:

gvm_pgp_pubkey_encrypt_stream()

int gvm_pgp_pubkey_encrypt_stream	(	FILE *	plain_file,
		FILE *	encrypted_file,
		const char *	uid_email,
		const char *	public_key_str,
		ssize_t	public_key_len )

Encrypt a stream for a PGP public key, writing to another stream.

The output will use ASCII armor mode and no compression.

Parameters

[in]	plain_file	Stream / FILE* providing the plain text.
[in]	encrypted_file	Stream to write the encrypted text to.
[in]	uid_email	Email address of public key to use.
[in]	public_key_str	String containing the public key.
[in]	public_key_len	Length of public key or -1 to use strlen.

Returns

0 success, -1 error.

Definition at line 640 of file gpgmeutils.c.

{
  int ret;
  const gpgme_data_type_t types_ptr[1] = {GPGME_DATA_TYPE_PGP_KEY};
  GArray *key_types = g_array_new (FALSE, FALSE, sizeof (gpgme_data_type_t));
 
  g_array_append_vals (key_types, types_ptr, 1);
  ret = encrypt_stream_internal (plain_file, encrypted_file, public_key_str,
                                 public_key_len, uid_email,
                                 GPGME_PROTOCOL_OpenPGP, key_types);
  g_array_free (key_types, TRUE);
 
  return ret;
}

References encrypt_stream_internal().

Here is the call graph for this function:

gvm_smime_encrypt_stream()

int gvm_smime_encrypt_stream	(	FILE *	plain_file,
		FILE *	encrypted_file,
		const char *	uid_email,
		const char *	certificate_str,
		ssize_t	certificate_len )

Encrypt a stream for a S/MIME certificate, writing to another stream.

The output will use ASCII armor mode and no compression.

Parameters

[in]	plain_file	Stream / FILE* providing the plain text.
[in]	encrypted_file	Stream to write the encrypted text to.
[in]	uid_email	Email address of certificate to use.
[in]	certificate_str	String containing the public key.
[in]	certificate_len	Length of public key or -1 to use strlen.

Returns

0 success, -1 error.

Definition at line 672 of file gpgmeutils.c.

{
  int ret;
  const gpgme_data_type_t types_ptr[2] = {GPGME_DATA_TYPE_X509_CERT,
                                          GPGME_DATA_TYPE_CMS_OTHER};
  GArray *key_types = g_array_new (FALSE, FALSE, sizeof (gpgme_data_type_t));
 
  g_array_append_vals (key_types, types_ptr, 2);
  ret = encrypt_stream_internal (plain_file, encrypted_file, certificate_str,
                                 certificate_len, uid_email, GPGME_PROTOCOL_CMS,
                                 key_types);
  g_array_free (key_types, TRUE);
 
  return ret;
}

References encrypt_stream_internal().

Here is the call graph for this function:

log_gpgme()

void log_gpgme	(	GLogLevelFlags	level,
		gpg_error_t	err,
		const char *	fmt,
			... )

Log function with extra gpg-error style output.

If err is not 0, the appropriate error string is appended to the output. It takes care to only add the error source string if it makes sense.

Parameters

level	The GLib style log level
err	An gpg-error value or 0
fmt	The printf style format string, followed by its arguments.

Definition at line 43 of file gpgmeutils.c.

{
  va_list arg_ptr;
  char *msg;
 
  va_start (arg_ptr, fmt);
  msg = g_strdup_vprintf (fmt, arg_ptr);
  va_end (arg_ptr);
  if (err && gpg_err_source (err) != GPG_ERR_SOURCE_ANY && gpg_err_source (err))
    g_log (G_LOG_DOMAIN, level, "%s: %s <%s>", msg, gpg_strerror (err),
           gpg_strsource (err));
  else if (err)
    g_log (G_LOG_DOMAIN, level, "%s: %s", msg, gpg_strerror (err));
  else
    g_log (G_LOG_DOMAIN, level, "%s", msg);
  g_free (msg);
}

References G_LOG_DOMAIN.

Referenced by gvm_init_gpgme_ctx_from_dir().

Here is the caller graph for this function: