Pgp Function API

Prototype for a Pgp Function. More...

Collaboration diagram for Pgp Function API:

Functions
static int	op_exit (struct PgpData *pd, const struct KeyEvent *event)
	Exit this menu - Implements pgp_function_t -.
static int	op_generic_select_entry (struct PgpData *pd, const struct KeyEvent *event)
	Select the current entry - Implements pgp_function_t -.
static int	op_verify_key (struct PgpData *pd, const struct KeyEvent *event)
	Verify a PGP public key - Implements pgp_function_t -.
static int	op_view_id (struct PgpData *pd, const struct KeyEvent *event)
	View the key's user id - Implements pgp_function_t -.

Detailed Description

Prototype for a Pgp Function.

Parameters

menu	Menu
event	Event to process

Return values

enum	FunctionRetval

Precondition

menu is not NULL

event is not NULL

Function Documentation

op_exit()

static int op_exit ( struct PgpData * pd, const struct KeyEvent * event )

static

Exit this menu - Implements pgp_function_t -.

Definition at line 53 of file pgp_functions.c.

{
  pd->done = true;
  return FR_SUCCESS;
}

op_generic_select_entry()

static int op_generic_select_entry ( struct PgpData * pd, const struct KeyEvent * event )

static

Select the current entry - Implements pgp_function_t -.

Definition at line 62 of file pgp_functions.c.

{
  /* XXX make error reporting more verbose */
 
  const int index = menu_get_index(pd->menu);
  struct PgpUid **pkey = ARRAY_GET(pd->key_table, index);
  if (!pkey)
    return FR_ERROR;
 
  if (OptPgpCheckTrust)
  {
    if (!pgp_key_is_valid((*pkey)->parent))
    {
      mutt_error(_("This key can't be used: expired/disabled/revoked"));
      return FR_ERROR;
    }
  }
 
  if (OptPgpCheckTrust && (!pgp_id_is_valid((*pkey)) || !pgp_id_is_strong((*pkey))))
  {
    const char *str = "";
    char buf2[1024] = { 0 };
 
    if ((*pkey)->flags & KEYFLAG_CANTUSE)
    {
      str = _("ID is expired/disabled/revoked. Do you really want to use the key?");
    }
    else
    {
      switch ((*pkey)->trust & 0x03)
      {
        case 0:
          str = _("ID has undefined validity. Do you really want to use the key?");
          break;
        case 1:
          str = _("ID is not valid. Do you really want to use the key?");
          break;
        case 2:
          str = _("ID is only marginally valid. Do you really want to use the key?");
          break;
      }
    }
 
    snprintf(buf2, sizeof(buf2), "%s", str);
 
    if (query_yesorno(buf2, MUTT_NO) != MUTT_YES)
    {
      mutt_clear_error();
      return FR_NO_ACTION;
    }
  }
 
  pd->key = (*pkey)->parent;
  pd->done = true;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_verify_key()

static int op_verify_key ( struct PgpData * pd, const struct KeyEvent * event )

static

Verify a PGP public key - Implements pgp_function_t -.

Definition at line 122 of file pgp_functions.c.

{
  FILE *fp_null = mutt_file_fopen("/dev/null", "w");
  if (!fp_null)
  {
    mutt_perror(_("Can't open /dev/null"));
    return FR_ERROR;
  }
  struct Buffer *tempfile = NULL;
  tempfile = buf_pool_get();
  buf_mktemp(tempfile);
  FILE *fp_tmp = mutt_file_fopen(buf_string(tempfile), "w");
  if (!fp_tmp)
  {
    mutt_perror(_("Can't create temporary file"));
    mutt_file_fclose(&fp_null);
    buf_pool_release(&tempfile);
    return FR_ERROR;
  }
 
  mutt_message(_("Invoking PGP..."));
 
  const int index = menu_get_index(pd->menu);
  struct PgpUid **pkey = ARRAY_GET(pd->key_table, index);
  if (!pkey)
  {
    mutt_file_fclose(&fp_tmp);
    mutt_file_fclose(&fp_null);
    return FR_ERROR;
  }
 
  char tmpbuf[256] = { 0 };
  snprintf(tmpbuf, sizeof(tmpbuf), "0x%s",
           pgp_fpr_or_lkeyid(pgp_principal_key((*pkey)->parent)));
 
  pid_t pid = pgp_invoke_verify_key(NULL, NULL, NULL, -1, fileno(fp_tmp),
                                    fileno(fp_null), tmpbuf);
  if (pid == -1)
  {
    mutt_perror(_("Can't create filter"));
    unlink(buf_string(tempfile));
    mutt_file_fclose(&fp_tmp);
    mutt_file_fclose(&fp_null);
  }
 
  filter_wait(pid);
  mutt_file_fclose(&fp_tmp);
  mutt_file_fclose(&fp_null);
  mutt_clear_error();
  char title[1024] = { 0 };
  snprintf(title, sizeof(title), _("Key ID: 0x%s"),
           pgp_keyid(pgp_principal_key((*pkey)->parent)));
 
  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };
 
  pdata.fname = buf_string(tempfile);
 
  pview.banner = title;
  pview.flags = MUTT_PAGER_NO_FLAGS;
  pview.mode = PAGER_MODE_OTHER;
 
  mutt_do_pager(&pview, NULL);
  buf_pool_release(&tempfile);
  menu_queue_redraw(pd->menu, MENU_REDRAW_FULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_view_id()

static int op_view_id ( struct PgpData * pd, const struct KeyEvent * event )

static

View the key's user id - Implements pgp_function_t -.

Definition at line 193 of file pgp_functions.c.

{
  const int index = menu_get_index(pd->menu);
  struct PgpUid **pkey = ARRAY_GET(pd->key_table, index);
  if (!pkey)
    return FR_ERROR;
 
  mutt_message("%s", NONULL((*pkey)->addr));
  return FR_SUCCESS;
}

Here is the call graph for this function: