dlg_pgp.c File Reference

PGP Key Selection Dialog. More...

#include "config.h"
#include <ctype.h>
#include <locale.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include "private.h"
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "menu/lib.h"
#include "format_flags.h"
#include "keymap.h"
#include "mutt_logging.h"
#include "muttlib.h"
#include "opcodes.h"
#include "pgp.h"
#include "pgp_functions.h"
#include "pgpkey.h"
#include "pgplib.h"

Include dependency graph for dlg_pgp.c:

Go to the source code of this file.

Data Structures
struct	PgpEntry
	An entry in a PGP key menu. More...

Functions
static int	pgp_compare_key_address (const void *a, const void *b)
	Compare Key addresses and IDs for sorting. More...
static int	pgp_compare_address_qsort (const void *a, const void *b)
	Compare the addresses of two PGP keys. More...
static int	pgp_compare_key_date (const void *a, const void *b)
	Compare Key dates for sorting. More...
static int	pgp_compare_date_qsort (const void *a, const void *b)
	Compare the dates of two PGP keys. More...
static int	pgp_compare_keyid (const void *a, const void *b)
	Compare Key IDs and addresses for sorting. More...
static int	pgp_compare_keyid_qsort (const void *a, const void *b)
	Compare key IDs. More...
static int	pgp_compare_key_trust (const void *a, const void *b)
	Compare the trust of keys for sorting. More...
static int	pgp_compare_trust_qsort (const void *a, const void *b)
	Compare the trust levels of two PGP keys. More...
static char *	pgp_key_abilities (KeyFlags flags)
	Turn PGP key abilities into a string. More...
static char	pgp_flags (KeyFlags flags)
	Turn PGP key flags into a string. More...
static const char *	pgp_entry_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Format an entry on the PGP key selection menu - Implements format_t -. More...
static void	pgp_make_entry (struct Menu *menu, char *buf, size_t buflen, int line)
	Format a menu item for the pgp key list - Implements Menu::make_entry() -. More...
static void	pgp_key_table_free (struct Menu *menu, void **ptr)
	Free the key table - Implements Menu::mdata_free() -. More...
static int	pgp_key_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -. More...
static int	pgp_key_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -. More...
struct PgpKeyInfo *	dlg_select_pgp_key (struct PgpKeyInfo *keys, struct Address *p, const char *s)
	Let the user select a key to use. More...

Variables
static const struct Mapping	PgpHelp []
	Help Bar for the PGP key selection dialog. More...
static const char	TrustFlags [] = "?- +"
	Characters used to show the trust level for PGP keys. More...

Detailed Description

PGP Key Selection Dialog.

Authors

• Richard Russon

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 dlg_pgp.c.

Function Documentation

pgp_compare_key_address()

static int pgp_compare_key_address ( const void *  a, const void *  b  )

static

Compare Key addresses and IDs for sorting.

Parameters

a	First key
b	Second key

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 124 of file dlg_pgp.c.

{
  struct PgpUid const *const *s = (struct PgpUid const *const *) a;
  struct PgpUid const *const *t = (struct PgpUid const *const *) b;
 
  int r = mutt_istr_cmp((*s)->addr, (*t)->addr);
  if (r != 0)
    return (r > 0);
 
  return mutt_istr_cmp(pgp_fpr_or_lkeyid((*s)->parent), pgp_fpr_or_lkeyid((*t)->parent)) > 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_address_qsort()

static int pgp_compare_address_qsort ( const void *  a, const void *  b  )

static

Compare the addresses of two PGP keys.

Parameters

a	First address
b	Second address

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 144 of file dlg_pgp.c.

{
  const short c_pgp_sort_keys = cs_subset_sort(NeoMutt->sub, "pgp_sort_keys");
  return (c_pgp_sort_keys & SORT_REVERSE) ? !pgp_compare_key_address(a, b) :
                                            pgp_compare_key_address(a, b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_key_date()

static int pgp_compare_key_date ( const void *  a, const void *  b  )

static

Compare Key dates for sorting.

Parameters

a	First key ID
b	Second key ID

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 159 of file dlg_pgp.c.

{
  struct PgpUid const *const *s = (struct PgpUid const *const *) a;
  struct PgpUid const *const *t = (struct PgpUid const *const *) b;
 
  int r = ((*s)->parent->gen_time - (*t)->parent->gen_time);
  if (r != 0)
    return r > 0;
  return mutt_istr_cmp((*s)->addr, (*t)->addr) > 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_date_qsort()

static int pgp_compare_date_qsort ( const void *  a, const void *  b  )

static

Compare the dates of two PGP keys.

Parameters

a	First key
b	Second key

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 178 of file dlg_pgp.c.

{
  const short c_pgp_sort_keys = cs_subset_sort(NeoMutt->sub, "pgp_sort_keys");
  return (c_pgp_sort_keys & SORT_REVERSE) ? !pgp_compare_key_date(a, b) :
                                            pgp_compare_key_date(a, b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_keyid()

static int pgp_compare_keyid ( const void *  a, const void *  b  )

static

Compare Key IDs and addresses for sorting.

Parameters

a	First key ID
b	Second key ID

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 193 of file dlg_pgp.c.

{
  struct PgpUid const *const *s = (struct PgpUid const *const *) a;
  struct PgpUid const *const *t = (struct PgpUid const *const *) b;
 
  int r = mutt_istr_cmp(pgp_fpr_or_lkeyid((*s)->parent), pgp_fpr_or_lkeyid((*t)->parent));
  if (r != 0)
    return (r > 0);
  return mutt_istr_cmp((*s)->addr, (*t)->addr) > 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_keyid_qsort()

static int pgp_compare_keyid_qsort ( const void *  a, const void *  b  )

static

Compare key IDs.

Parameters

a	First key ID
b	Second key ID

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 212 of file dlg_pgp.c.

{
  const short c_pgp_sort_keys = cs_subset_sort(NeoMutt->sub, "pgp_sort_keys");
  return (c_pgp_sort_keys & SORT_REVERSE) ? !pgp_compare_keyid(a, b) :
                                            pgp_compare_keyid(a, b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_key_trust()

static int pgp_compare_key_trust ( const void *  a, const void *  b  )

static

Compare the trust of keys for sorting.

Parameters

a	First key
b	Second key

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Compare two trust values, the key length, the creation dates. the addresses and the key IDs.

Definition at line 230 of file dlg_pgp.c.

{
  struct PgpUid const *const *s = (struct PgpUid const *const *) a;
  struct PgpUid const *const *t = (struct PgpUid const *const *) b;
 
  int r = (((*s)->parent->flags & KEYFLAG_RESTRICTIONS) -
           ((*t)->parent->flags & KEYFLAG_RESTRICTIONS));
  if (r != 0)
    return r > 0;
  r = ((*s)->trust - (*t)->trust);
  if (r != 0)
    return r < 0;
  r = ((*s)->parent->keylen - (*t)->parent->keylen);
  if (r != 0)
    return r < 0;
  r = ((*s)->parent->gen_time - (*t)->parent->gen_time);
  if (r != 0)
    return r < 0;
  r = mutt_istr_cmp((*s)->addr, (*t)->addr);
  if (r != 0)
    return r > 0;
  return mutt_istr_cmp(pgp_fpr_or_lkeyid((*s)->parent), pgp_fpr_or_lkeyid((*t)->parent)) > 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_compare_trust_qsort()

static int pgp_compare_trust_qsort ( const void *  a, const void *  b  )

static

Compare the trust levels of two PGP keys.

Parameters

a	First key
b	Second key

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 262 of file dlg_pgp.c.

{
  const short c_pgp_sort_keys = cs_subset_sort(NeoMutt->sub, "pgp_sort_keys");
  return (c_pgp_sort_keys & SORT_REVERSE) ? !pgp_compare_key_trust(a, b) :
                                            pgp_compare_key_trust(a, b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_key_abilities()

static char * pgp_key_abilities ( KeyFlags  flags )

static

Turn PGP key abilities into a string.

Parameters

flags

Flags, see KeyFlags

Return values

ptr	Abilities string

Note

This returns a pointer to a static buffer

Definition at line 276 of file dlg_pgp.c.

{
  static char buf[3];
 
  if (!(flags & KEYFLAG_CANENCRYPT))
    buf[0] = '-';
  else if (flags & KEYFLAG_PREFER_SIGNING)
    buf[0] = '.';
  else
    buf[0] = 'e';
 
  if (!(flags & KEYFLAG_CANSIGN))
    buf[1] = '-';
  else if (flags & KEYFLAG_PREFER_ENCRYPTION)
    buf[1] = '.';
  else
    buf[1] = 's';
 
  buf[2] = '\0';
 
  return buf;
}

Here is the caller graph for this function:

pgp_flags()

static char pgp_flags ( KeyFlags  flags )

static

Turn PGP key flags into a string.

Parameters

flags

Flags, see KeyFlags

Return values

char	Flag character

Definition at line 304 of file dlg_pgp.c.

{
  if (flags & KEYFLAG_REVOKED)
    return 'R';
  if (flags & KEYFLAG_EXPIRED)
    return 'X';
  if (flags & KEYFLAG_DISABLED)
    return 'd';
  if (flags & KEYFLAG_CRITICAL)
    return 'c';
 
  return ' ';
}

Here is the caller graph for this function:

dlg_select_pgp_key()

struct PgpKeyInfo * dlg_select_pgp_key	(	struct PgpKeyInfo *	keys,
		struct Address *	p,
		const char *	s
	)

Let the user select a key to use.

Parameters

keys	List of PGP keys
p	Address to match
s	String to match

Return values

ptr	Selected PGP key

Definition at line 592 of file dlg_pgp.c.

{
  struct PgpUid **key_table = NULL;
  struct Menu *menu = NULL;
  char buf[1024] = { 0 };
  struct PgpUid *a = NULL;
  bool unusable = false;
  int keymax = 0;
 
  const bool c_pgp_show_unusable = cs_subset_bool(NeoMutt->sub, "pgp_show_unusable");
  int i = 0;
  for (struct PgpKeyInfo *kp = keys; kp; kp = kp->next)
  {
    if (!c_pgp_show_unusable && (kp->flags & KEYFLAG_CANTUSE))
    {
      unusable = true;
      continue;
    }
 
    for (a = kp->address; a; a = a->next)
    {
      if (!c_pgp_show_unusable && (a->flags & KEYFLAG_CANTUSE))
      {
        unusable = true;
        continue;
      }
 
      if (i == keymax)
      {
        keymax += 5;
        mutt_mem_realloc(&key_table, sizeof(struct PgpUid *) * keymax);
      }
 
      key_table[i++] = a;
    }
  }
 
  if ((i == 0) && unusable)
  {
    mutt_error(_("All matching keys are expired, revoked, or disabled"));
    return NULL;
  }
 
  int (*f)(const void *, const void *);
  const short c_pgp_sort_keys = cs_subset_sort(NeoMutt->sub, "pgp_sort_keys");
  switch (c_pgp_sort_keys & SORT_MASK)
  {
    case SORT_ADDRESS:
      f = pgp_compare_address_qsort;
      break;
    case SORT_DATE:
      f = pgp_compare_date_qsort;
      break;
    case SORT_KEYID:
      f = pgp_compare_keyid_qsort;
      break;
    case SORT_TRUST:
    default:
      f = pgp_compare_trust_qsort;
      break;
  }
 
  if (key_table)
    qsort(key_table, i, sizeof(struct PgpUid *), f);
 
  struct MuttWindow *dlg = simple_dialog_new(MENU_PGP, WT_DLG_PGP, PgpHelp);
 
  menu = dlg->wdata;
  menu->max = i;
  menu->make_entry = pgp_make_entry;
  menu->mdata = key_table;
  menu->mdata_free = pgp_key_table_free;
 
  struct PgpData pd = { false, menu, key_table, NULL };
  dlg->wdata = &pd;
 
  // NT_COLOR is handled by the SimpleDialog
  notify_observer_add(NeoMutt->notify, NT_CONFIG, pgp_key_config_observer, menu);
  notify_observer_add(menu->win->notify, NT_WINDOW, pgp_key_window_observer, menu->win);
 
  if (p)
    snprintf(buf, sizeof(buf), _("PGP keys matching <%s>"), buf_string(p->mailbox));
  else
    snprintf(buf, sizeof(buf), _("PGP keys matching \"%s\""), s);
 
  struct MuttWindow *sbar = window_find_child(dlg, WT_STATUS_BAR);
  sbar_set_title(sbar, buf);
 
  mutt_clear_error();
 
  // ---------------------------------------------------------------------------
  // Event Loop
  int op = OP_NULL;
  do
  {
    menu_tagging_dispatcher(menu->win, op);
    window_redraw(NULL);
 
    op = km_dokey(MENU_PGP);
    mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(op), op);
    if (op < 0)
      continue;
    if (op == OP_NULL)
    {
      km_error_key(MENU_PGP);
      continue;
    }
    mutt_clear_error();
 
    int rc = pgp_function_dispatcher(dlg, op);
 
    if (rc == FR_UNKNOWN)
      rc = menu_function_dispatcher(menu->win, op);
    if (rc == FR_UNKNOWN)
      rc = global_function_dispatcher(NULL, op);
  } while (!pd.done);
  // ---------------------------------------------------------------------------
 
  simple_dialog_free(&dlg);
  return pd.key;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

PgpHelp

const struct Mapping PgpHelp[]

static

Initial value:

= {
  
  { N_("Exit"),      OP_EXIT },
  { N_("Select"),    OP_GENERIC_SELECT_ENTRY },
  { N_("Check key"), OP_VERIFY_KEY },
  { N_("Help"),      OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the PGP key selection dialog.

Definition at line 94 of file dlg_pgp.c.

TrustFlags

const char TrustFlags[] = "?- +"

static

Characters used to show the trust level for PGP keys.

Definition at line 114 of file dlg_pgp.c.