gpgme.c File Reference

Autocrypt GPGME handler. More...

#include "config.h"
#include <gpg-error.h>
#include <gpgme.h>
#include <stdbool.h>
#include <stddef.h>
#include "private.h"
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "ncrypt/lib.h"
#include "question/lib.h"
#include "globals.h"

Include dependency graph for gpgme.c:

Go to the source code of this file.

Functions
static int	create_gpgme_context (gpgme_ctx_t *ctx)
	Create a GPGME context.
int	mutt_autocrypt_gpgme_init (void)
	Initialise GPGME.
static int	export_keydata (gpgme_ctx_t ctx, gpgme_key_t key, struct Buffer *keydata)
	Export Key data from GPGME into a Buffer.
int	mutt_autocrypt_gpgme_create_key (struct Address *addr, struct Buffer *keyid, struct Buffer *keydata)
	Create a GPGME key.
int	mutt_autocrypt_gpgme_select_key (struct Buffer *keyid, struct Buffer *keydata)
	Select a Autocrypt key.
int	mutt_autocrypt_gpgme_select_or_create_key (struct Address *addr, struct Buffer *keyid, struct Buffer *keydata)
	Ask the user to select or create an Autocrypt key.
int	mutt_autocrypt_gpgme_import_key (const char *keydata, struct Buffer *keyid)
	Read a key from GPGME.
bool	mutt_autocrypt_gpgme_is_valid_key (const char *keyid)
	Is a key id valid?

Detailed Description

Autocrypt GPGME handler.

Authors

• Kevin J. McCarthy
• Richard Russon
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file gpgme.c.

Function Documentation

create_gpgme_context()

static int create_gpgme_context ( gpgme_ctx_t * ctx )

static

Create a GPGME context.

Parameters

ctx	GPGME context to initialise

Return values

0	Success
-1	Error

Definition at line 51 of file gpgme.c.

{
  const char *const c_autocrypt_dir = cs_subset_path(NeoMutt->sub, "autocrypt_dir");
  gpgme_error_t err = gpgme_new(ctx);
  if (err == GPG_ERR_NO_ERROR)
    err = gpgme_ctx_set_engine_info(*ctx, GPGME_PROTOCOL_OpenPGP, NULL, c_autocrypt_dir);
  if (err != GPG_ERR_NO_ERROR)
  {
    mutt_error(_("error creating GPGME context: %s"), gpgme_strerror(err));
    return -1;
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_init()

int mutt_autocrypt_gpgme_init

(

void

)

Initialise GPGME.

Return values

0

Always

Definition at line 70 of file gpgme.c.

{
  pgp_gpgme_init();
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

export_keydata()

static int export_keydata ( gpgme_ctx_t ctx, gpgme_key_t key, struct Buffer * keydata )

static

Export Key data from GPGME into a Buffer.

Parameters

ctx	GPGME context
key	GPGME key
keydata	Buffer for results

Return values

0	Success
-1	Error

Definition at line 84 of file gpgme.c.

{
  int rc = -1;
  gpgme_data_t dh = NULL;
  gpgme_key_t export_keys[2] = { 0 };
  size_t export_data_len;
 
  if (gpgme_data_new(&dh))
    goto cleanup;
 
  /* This doesn't seem to work */
#if 0
  if (gpgme_data_set_encoding (dh, GPGME_DATA_ENCODING_BASE64))
    goto cleanup;
#endif
 
  export_keys[0] = key;
  export_keys[1] = NULL;
  if (gpgme_op_export_keys(ctx, export_keys, GPGME_EXPORT_MODE_MINIMAL, dh))
    goto cleanup;
 
  char *export_data = gpgme_data_release_and_get_mem(dh, &export_data_len);
  dh = NULL;
 
  mutt_b64_buffer_encode(keydata, export_data, export_data_len);
  gpgme_free(export_data);
  export_data = NULL;
 
  rc = 0;
 
cleanup:
  gpgme_data_release(dh);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_create_key()

int mutt_autocrypt_gpgme_create_key	(	struct Address *	addr,
		struct Buffer *	keyid,
		struct Buffer *	keydata )

Create a GPGME key.

Parameters

addr	Email Address
keyid	Key id
keydata	Key data

Return values

0	Success
-1	Error

Definition at line 158 of file gpgme.c.

{
  int rc = -1;
  gpgme_ctx_t ctx = NULL;
  gpgme_genkey_result_t keyresult = NULL;
  gpgme_key_t primary_key = NULL;
  struct Buffer *buf = buf_pool_get();
 
  /* GPGME says addresses should not be in idna form */
  struct Address *copy = mutt_addr_copy(addr);
  mutt_addr_to_local(copy);
  mutt_addr_write(buf, copy, false);
  mutt_addr_free(&copy);
 
  if (create_gpgme_context(&ctx))
    goto cleanup;
 
  /* L10N: Message displayed just before a GPG key is generated for a created
     autocrypt account.  */
  mutt_message(_("Generating autocrypt key..."));
 
  /* Primary key */
  gpgme_error_t err = gpgme_op_createkey(ctx, buf_string(buf), "ed25519", 0, 0, NULL,
                                         GPGME_CREATE_NOPASSWD | GPGME_CREATE_FORCE |
                                             GPGME_CREATE_NOEXPIRE);
  if (err != GPG_ERR_NO_ERROR)
  {
    /* L10N: GPGME was unable to generate a key for some reason.
       %s is the error message returned by GPGME.  */
    mutt_error(_("Error creating autocrypt key: %s"), gpgme_strerror(err));
    goto cleanup;
  }
  keyresult = gpgme_op_genkey_result(ctx);
  if (!keyresult->fpr)
    goto cleanup;
  buf_strcpy(keyid, keyresult->fpr);
  mutt_debug(LL_DEBUG1, "Generated key with id %s\n", buf_string(keyid));
 
  /* Get gpgme_key_t to create the secondary key and export keydata */
  err = gpgme_get_key(ctx, buf_string(keyid), &primary_key, 0);
  if (err)
    goto cleanup;
 
  /* Secondary key */
  err = gpgme_op_createsubkey(ctx, primary_key, "cv25519", 0, 0,
                              GPGME_CREATE_NOPASSWD | GPGME_CREATE_NOEXPIRE);
  if (err != GPG_ERR_NO_ERROR)
  {
    mutt_error(_("Error creating autocrypt key: %s"), gpgme_strerror(err));
    goto cleanup;
  }
 
  /* get keydata */
  if (export_keydata(ctx, primary_key, keydata))
    goto cleanup;
  mutt_debug(LL_DEBUG1, "key has keydata *%s*\n", buf_string(keydata));
 
  rc = 0;
 
cleanup:
  gpgme_key_unref(primary_key);
  gpgme_release(ctx);
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_select_key()

int mutt_autocrypt_gpgme_select_key	(	struct Buffer *	keyid,
		struct Buffer *	keydata )

Select a Autocrypt key.

Parameters

[in]	keyid	Key id to select
[out]	keydata	Buffer for resulting Key data

Return values

0	Success
-1	Error

Definition at line 232 of file gpgme.c.

{
  int rc = -1;
  gpgme_ctx_t ctx = NULL;
  gpgme_key_t key = NULL;
 
  OptAutocryptGpgme = true;
  if (mutt_gpgme_select_secret_key(keyid))
    goto cleanup;
 
  if (create_gpgme_context(&ctx))
    goto cleanup;
 
  if (gpgme_get_key(ctx, buf_string(keyid), &key, 0))
    goto cleanup;
 
  if (key->revoked || key->expired || key->disabled || key->invalid ||
      !key->can_encrypt || !key->can_sign)
  {
    /* L10N: After selecting a key for an autocrypt account,
       this is displayed if the key was revoked/expired/disabled/invalid
       or can't be used for both signing and encryption.
       %s is the key fingerprint.  */
    mutt_error(_("The key %s is not usable for autocrypt"), buf_string(keyid));
    goto cleanup;
  }
 
  if (export_keydata(ctx, key, keydata))
    goto cleanup;
 
  rc = 0;
 
cleanup:
  OptAutocryptGpgme = false;
  gpgme_key_unref(key);
  gpgme_release(ctx);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_select_or_create_key()

int mutt_autocrypt_gpgme_select_or_create_key	(	struct Address *	addr,
		struct Buffer *	keyid,
		struct Buffer *	keydata )

Ask the user to select or create an Autocrypt key.

Parameters

addr	Email Address
keyid	Key id
keydata	Key data

Return values

0	Success
-1	Error

Definition at line 279 of file gpgme.c.

{
  int rc = -1;
 
  /* L10N: During autocrypt account creation, this prompt asks the
     user whether they want to create a new GPG key for the account,
     or select an existing account from the keyring.  */
  const char *prompt = _("(c)reate new, or (s)elect existing GPG key?");
  /* L10N: The letters corresponding to the
     "(c)reate new, or (s)elect existing GPG key?" prompt.  */
  const char *letters = _("cs");
 
  int choice = mw_multi_choice(prompt, letters);
  switch (choice)
  {
    case 2: /* select existing */
      rc = mutt_autocrypt_gpgme_select_key(keyid, keydata);
      if (rc == 0)
        break;
 
      /* L10N: During autocrypt account creation, if selecting an existing key fails
         for some reason, we prompt to see if they want to create a key instead.  */
      if (query_yesorno(_("Create a new GPG key for this account, instead?"), MUTT_YES) != MUTT_YES)
        break;
      FALLTHROUGH;
 
    case 1: /* create new */
      rc = mutt_autocrypt_gpgme_create_key(addr, keyid, keydata);
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_import_key()

int mutt_autocrypt_gpgme_import_key	(	const char *	keydata,
		struct Buffer *	keyid )

Read a key from GPGME.

Parameters

keydata	Buffer for key data
keyid	Buffer for key id

Return values

0	Success
-1	Error

Definition at line 320 of file gpgme.c.

{
  int rc = -1;
  gpgme_ctx_t ctx = NULL;
  gpgme_data_t dh = NULL;
  struct Buffer *raw_keydata = NULL;
 
  if (create_gpgme_context(&ctx))
    goto cleanup;
 
  raw_keydata = buf_pool_get();
  if (!mutt_b64_buffer_decode(raw_keydata, keydata))
    goto cleanup;
 
  if (gpgme_data_new_from_mem(&dh, buf_string(raw_keydata), buf_len(raw_keydata), 0))
  {
    goto cleanup;
  }
 
  if (gpgme_op_import(ctx, dh))
    goto cleanup;
 
  gpgme_import_result_t result = gpgme_op_import_result(ctx);
  if (!result->imports || !result->imports->fpr)
    goto cleanup;
  buf_strcpy(keyid, result->imports->fpr);
 
  rc = 0;
 
cleanup:
  gpgme_data_release(dh);
  gpgme_release(ctx);
  buf_pool_release(&raw_keydata);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_autocrypt_gpgme_is_valid_key()

bool mutt_autocrypt_gpgme_is_valid_key

(

const char *

keyid

)

Is a key id valid?

Parameters

keyid

Key id to check

Return values

true	Key id is valid

Definition at line 361 of file gpgme.c.

{
  bool rc = false;
  gpgme_ctx_t ctx = NULL;
  gpgme_key_t key = NULL;
 
  if (!keyid)
    return false;
 
  if (create_gpgme_context(&ctx))
    goto cleanup;
 
  if (gpgme_get_key(ctx, keyid, &key, 0))
    goto cleanup;
 
  rc = true;
  if (key->revoked || key->expired || key->disabled || key->invalid || !key->can_encrypt)
    rc = false;
 
cleanup:
  gpgme_key_unref(key);
  gpgme_release(ctx);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: