NeoMutt  2023-05-17-56-ga67199
Teaching an old dog new tricks
DOXYGEN
pgp_functions.c
Go to the documentation of this file.
1
29#include "config.h"
30#include <stdio.h>
31#include <unistd.h>
32#include "mutt/lib.h"
33#include "config/lib.h"
34#include "core/lib.h"
35#include "gui/lib.h"
36#include "pgp_functions.h"
37#include "lib.h"
38#include "menu/lib.h"
39#include "pager/lib.h"
40#include "question/lib.h"
41#include "globals.h"
42#include "mutt_logging.h"
43#include "opcodes.h"
44#include "pgp.h"
45#include "pgpinvoke.h"
46#include "pgpkey.h"
47#include "pgplib.h"
48
52static int op_exit(struct PgpData *pd, int op)
53{
54 pd->done = true;
55 return FR_SUCCESS;
56}
57
61static int op_generic_select_entry(struct PgpData *pd, int op)
62{
63 /* XXX make error reporting more verbose */
64
65 const int index = menu_get_index(pd->menu);
66 struct PgpUid *cur_key = pd->key_table[index];
68 {
69 if (!pgp_key_is_valid(cur_key->parent))
70 {
71 mutt_error(_("This key can't be used: expired/disabled/revoked"));
72 return FR_ERROR;
73 }
74 }
75
76 if (OptPgpCheckTrust && (!pgp_id_is_valid(cur_key) || !pgp_id_is_strong(cur_key)))
77 {
78 const char *str = "";
79 char buf2[1024];
80
81 if (cur_key->flags & KEYFLAG_CANTUSE)
82 {
83 str = _("ID is expired/disabled/revoked. Do you really want to use the key?");
84 }
85 else
86 {
87 switch (cur_key->trust & 0x03)
88 {
89 case 0:
90 str = _("ID has undefined validity. Do you really want to use the key?");
91 break;
92 case 1:
93 str = _("ID is not valid. Do you really want to use the key?");
94 break;
95 case 2:
96 str = _("ID is only marginally valid. Do you really want to use the key?");
97 break;
98 }
99 }
100
101 snprintf(buf2, sizeof(buf2), "%s", str);
102
103 if (mutt_yesorno(buf2, MUTT_NO) != MUTT_YES)
104 {
106 return FR_NO_ACTION;
107 }
108 }
109
110 pd->key = cur_key->parent;
111 pd->done = true;
112 return FR_SUCCESS;
113}
114
118static int op_verify_key(struct PgpData *pd, int op)
119{
120 FILE *fp_null = fopen("/dev/null", "w");
121 if (!fp_null)
122 {
123 mutt_perror(_("Can't open /dev/null"));
124 return FR_ERROR;
125 }
126 struct Buffer *tempfile = NULL;
127 tempfile = buf_pool_get();
128 buf_mktemp(tempfile);
129 FILE *fp_tmp = mutt_file_fopen(buf_string(tempfile), "w");
130 if (!fp_tmp)
131 {
132 mutt_perror(_("Can't create temporary file"));
133 mutt_file_fclose(&fp_null);
134 buf_pool_release(&tempfile);
135 return FR_ERROR;
136 }
137
138 mutt_message(_("Invoking PGP..."));
139
140 const int index = menu_get_index(pd->menu);
141 struct PgpUid *cur_key = pd->key_table[index];
142 char tmpbuf[256] = { 0 };
143 snprintf(tmpbuf, sizeof(tmpbuf), "0x%s",
145
146 pid_t pid = pgp_invoke_verify_key(NULL, NULL, NULL, -1, fileno(fp_tmp),
147 fileno(fp_null), tmpbuf);
148 if (pid == -1)
149 {
150 mutt_perror(_("Can't create filter"));
151 unlink(buf_string(tempfile));
152 mutt_file_fclose(&fp_tmp);
153 mutt_file_fclose(&fp_null);
154 }
155
156 filter_wait(pid);
157 mutt_file_fclose(&fp_tmp);
158 mutt_file_fclose(&fp_null);
160 char title[1024] = { 0 };
161 snprintf(title, sizeof(title), _("Key ID: 0x%s"),
163
164 struct PagerData pdata = { 0 };
165 struct PagerView pview = { &pdata };
166
167 pdata.fname = buf_string(tempfile);
168
169 pview.banner = title;
171 pview.mode = PAGER_MODE_OTHER;
172
173 mutt_do_pager(&pview, NULL);
174 buf_pool_release(&tempfile);
176 return FR_SUCCESS;
177}
178
182static int op_view_id(struct PgpData *pd, int op)
183{
184 const int index = menu_get_index(pd->menu);
185 struct PgpUid *cur_key = pd->key_table[index];
186 mutt_message("%s", NONULL(cur_key->addr));
187 return FR_SUCCESS;
188}
189
190// -----------------------------------------------------------------------------
191
195static const struct PgpFunction PgpFunctions[] = {
196 // clang-format off
197 { OP_EXIT, op_exit },
198 { OP_GENERIC_SELECT_ENTRY, op_generic_select_entry },
199 { OP_VERIFY_KEY, op_verify_key },
200 { OP_VIEW_ID, op_view_id },
201 { 0, NULL },
202 // clang-format on
203};
204
209{
210 if (!win || !win->wdata)
211 return FR_UNKNOWN;
212
213 struct MuttWindow *dlg = dialog_find(win);
214 if (!dlg)
215 return FR_ERROR;
216
217 struct PgpData *pd = dlg->wdata;
218
219 int rc = FR_UNKNOWN;
220 for (size_t i = 0; PgpFunctions[i].op != OP_NULL; i++)
221 {
222 const struct PgpFunction *fn = &PgpFunctions[i];
223 if (fn->op == op)
224 {
225 rc = fn->function(pd, op);
226 break;
227 }
228 }
229
230 if (rc == FR_UNKNOWN) // Not our function
231 return rc;
232
233 const char *result = dispacher_get_retval_name(rc);
234 mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
235
236 return rc;
237}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:90
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
struct MuttWindow * dialog_find(struct MuttWindow *win)
Find the parent Dialog of a Window.
Definition: dialog.c:83
const char * dispacher_get_retval_name(int rv)
Get the name of a return value.
Definition: dispatcher.c:54
@ FR_SUCCESS
Valid function - successfully performed.
Definition: dispatcher.h:39
@ FR_UNKNOWN
Unknown function.
Definition: dispatcher.h:33
@ FR_ERROR
Valid function - error occurred.
Definition: dispatcher.h:38
@ FR_NO_ACTION
Valid function - no action performed.
Definition: dispatcher.h:37
int mutt_do_pager(struct PagerView *pview, struct Email *e)
Display some page-able text to the user (help or attachment)
Definition: do_pager.c:123
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:634
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:150
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:217
bool OptPgpCheckTrust
(pseudo) used by dlg_select_pgp_key()
Definition: globals.c:83
int pgp_function_dispatcher(struct MuttWindow *win, int op)
Perform a Pgp function - Implements function_dispatcher_t -.
#define mutt_error(...)
Definition: logging2.h:90
#define mutt_message(...)
Definition: logging2.h:89
#define mutt_debug(LEVEL,...)
Definition: logging2.h:87
#define mutt_perror(...)
Definition: logging2.h:91
static int op_verify_key(struct PgpData *pd, int op)
Verify a PGP public key - Implements pgp_function_t -.
static int op_exit(struct PgpData *pd, int op)
Exit this menu - Implements pgp_function_t -.
Definition: pgp_functions.c:52
static int op_view_id(struct PgpData *pd, int op)
View the key's user id - Implements pgp_function_t -.
static int op_generic_select_entry(struct PgpData *pd, int op)
Select the current entry - Implements pgp_function_t -.
Definition: pgp_functions.c:61
Convenience wrapper for the gui headers.
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
GUI present the user with a selectable list.
#define MENU_REDRAW_FULL
Redraw everything.
Definition: lib.h:60
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition: menu.c:179
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition: menu.c:155
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:73
NeoMutt Logging.
#define KEYFLAG_CANTUSE
Definition: lib.h:139
const char * opcodes_get_name(int op)
Get the name of an opcode.
Definition: opcodes.c:48
All user-callable functions.
GUI display a file/email/help in a viewport with paging.
#define MUTT_PAGER_NO_FLAGS
No flags are set.
Definition: lib.h:59
@ PAGER_MODE_OTHER
Pager is invoked via 3rd path. Non-email content is likely to be shown.
Definition: lib.h:140
char * pgp_keyid(struct PgpKeyInfo *k)
Get the ID of the main (parent) key.
Definition: pgp.c:205
char * pgp_fpr_or_lkeyid(struct PgpKeyInfo *k)
Get the fingerprint or long keyid.
Definition: pgp.c:235
PGP sign, encrypt, check routines.
static const struct PgpFunction PgpFunctions[]
All the NeoMutt functions that the Pgp supports.
Pgp functions.
pid_t pgp_invoke_verify_key(FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *uids)
Use PGP to verify a key.
Definition: pgpinvoke.c:528
Wrapper around calls to external PGP program.
bool pgp_id_is_valid(struct PgpUid *uid)
Is a PGP key valid.
Definition: pgpkey.c:129
bool pgp_id_is_strong(struct PgpUid *uid)
Is a PGP key strong?
Definition: pgpkey.c:116
bool pgp_key_is_valid(struct PgpKeyInfo *k)
Is a PGP key valid?
Definition: pgpkey.c:100
struct PgpKeyInfo * pgp_principal_key(struct PgpKeyInfo *key)
Get the main (parent) PGP key.
Definition: pgpkey.c:88
PGP key management routines.
Misc PGP helper routines.
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
@ MUTT_NO
User answered 'No', or assume 'No'.
Definition: quad.h:38
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
Ask the user a question.
enum QuadOption mutt_yesorno(const char *msg, enum QuadOption def)
Ask the user a Yes/No question.
Definition: question.c:194
Key value store.
#define NONULL(x)
Definition: string2.h:37
String manipulation buffer.
Definition: buffer.h:34
void * wdata
Private data.
Definition: mutt_window.h:145
Data to be displayed by PagerView.
Definition: lib.h:159
const char * fname
Name of the file to read.
Definition: lib.h:163
Paged view into some data.
Definition: lib.h:170
struct PagerData * pdata
Data that pager displays. NOTNULL.
Definition: lib.h:171
enum PagerMode mode
Pager mode.
Definition: lib.h:172
PagerFlags flags
Additional settings to tweak pager's function.
Definition: lib.h:173
const char * banner
Title to display in status bar.
Definition: lib.h:174
Data to pass to the Pgp Functions.
Definition: pgp_functions.h:34
struct PgpUid ** key_table
Array of Keys.
Definition: pgp_functions.h:37
struct Menu * menu
Pgp Menu.
Definition: pgp_functions.h:36
bool done
Should we close the Dialog?
Definition: pgp_functions.h:35
struct PgpKeyInfo * key
Selected Key.
Definition: pgp_functions.h:38
A NeoMutt function.
Definition: pgp_functions.h:57
int op
Op code, e.g. OP_GENERIC_SELECT_ENTRY.
Definition: pgp_functions.h:58
pgp_function_t function
Function to call.
Definition: pgp_functions.h:59
PGP User ID.
Definition: pgplib.h:35
short trust
Definition: pgplib.h:37
struct PgpKeyInfo * parent
Parent key.
Definition: pgplib.h:39
int flags
Definition: pgplib.h:38
char * addr
Definition: pgplib.h:36
#define buf_mktemp(buf)
Definition: tmp.h:37