src/plugins/pgpcore/passphrase.c

   1 /* passphrase.c - GTK based passphrase callback
   2  * Copyright (C) 2001-2022 Werner Koch (dd9jn) and the Claws Mail team
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifdef HAVE_CONFIG_H
  19 #  include <config.h>
  20 #endif
  21
  22 #if USE_GPGME
  23
  24 #include <glib.h>
  25 #include <glib/gi18n.h>
  26 #include <gdk/gdk.h>
  27 #include <gdk/gdkkeysyms.h>
  28 #ifdef GDK_WINDOWING_X11
  29 #  include <gdk/gdkx.h>
  30 #endif /* GDK_WINDOWING_X11 */
  31 #include <gtk/gtk.h>
  32 #include <string.h>
  33 #include <sys/types.h>
  34 #ifdef G_OS_WIN32
  35 #include <windows.h>
  36 #else
  37 #include <sys/mman.h>
  38 #endif
  39
  40 #include "passphrase.h"
  41 #include "prefs_common.h"
  42 #include "prefs_gpg.h"
  43 #include "manage_window.h"
  44 #include "utils.h"
  45 #include "mainwindow.h"
  46 #include "summaryview.h"
  47
  48 static gboolean grab_all = FALSE;
  49
  50 static gboolean pass_ack;
  51 static gchar *last_pass = NULL;
  52
  53 static void passphrase_ok_cb(GtkWidget *widget, gpointer data);
  54 static void passphrase_cancel_cb(GtkWidget *widget, gpointer data);
  55 static gint passphrase_deleted(GtkWidget *widget, GdkEventAny *event,
  56                                gpointer data);
  57 static gboolean passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event,
  58                                        gpointer data);
  59
  60 static GtkWidget *create_description(const gchar *uid_hint, gint prev_bad, gint new_key);
  61
  62 void
  63 gpgmegtk_set_passphrase_grab(gint yes)
  64 {
  65     grab_all = yes;
  66 }
  67
  68 gchar*
  69 passphrase_mbox(const gchar *uid_hint, const gchar *pass_hint, gint prev_bad, gint new_key)
  70 {
  71     gchar *the_passphrase = NULL;
  72     GtkWidget *vbox, *hbox;
  73     GtkWidget *confirm_box;
  74     GtkWidget *window;
  75     GtkWidget *pass_entry;
  76     GtkWidget *ok_button;
  77     GtkWidget *cancel_button;
  78     GdkWindow *gdkwin;
  79
  80     SummaryView *summaryview = mainwindow_get_mainwindow()->summaryview;
  81
  82     gtk_menu_popdown(GTK_MENU(summaryview->popupmenu));
  83
  84     window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "passphrase");
  85     gtk_window_set_title(GTK_WINDOW(window), _("Passphrase"));
  86     gtk_window_set_default_size(GTK_WINDOW(window), 375, 100);
  87     gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
  88     gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
  89     gtk_window_set_type_hint(GTK_WINDOW(window), GDK_WINDOW_TYPE_HINT_DIALOG);
  90     gtk_window_set_modal(GTK_WINDOW(window), TRUE);
  91     g_signal_connect(G_OBJECT(window), "delete_event",
  92                      G_CALLBACK(passphrase_deleted), NULL);
  93     g_signal_connect(G_OBJECT(window), "key_press_event",
  94                      G_CALLBACK(passphrase_key_pressed), NULL);
  95     MANAGE_WINDOW_SIGNALS_CONNECT(window);
  96     manage_window_set_transient(GTK_WINDOW(window));
  97
  98     vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
  99     gtk_container_add(GTK_CONTAINER(window), vbox);
 100     gtk_container_set_border_width(GTK_CONTAINER(vbox), 8);
 101
 102     if (uid_hint || pass_hint) {
 103         GtkWidget *label, *icon;
 104         label = create_description (uid_hint, prev_bad, new_key);
 105         icon = gtk_image_new_from_icon_name("dialog-password",
 106                                 GTK_ICON_SIZE_DIALOG);
 107
 108         hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 12);
 109         gtk_container_set_border_width (GTK_CONTAINER (hbox), 5);
 110         gtk_widget_show (hbox);
 111         gtk_box_pack_start (GTK_BOX(hbox), icon, FALSE, FALSE, 0);
 112         gtk_box_pack_start (GTK_BOX(hbox), label, FALSE, FALSE, 0);
 113         gtk_box_pack_start (GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 114     }
 115
 116     pass_entry = gtk_entry_new();
 117     gtk_box_pack_start(GTK_BOX(vbox), pass_entry, FALSE, FALSE, 0);
 118     gtk_entry_set_visibility(GTK_ENTRY(pass_entry), FALSE);
 119     gtk_widget_grab_focus(pass_entry);
 120
 121     gtkut_stock_button_set_create(&confirm_box,
 122                                   &cancel_button, NULL, _("_Cancel"),
 123                                   &ok_button, NULL, _("_OK"),
 124                                   NULL, NULL, NULL);
 125
 126     gtk_box_pack_end(GTK_BOX(vbox), confirm_box, FALSE, FALSE, 0);
 127     gtk_widget_grab_default(ok_button);
 128
 129     g_signal_connect(G_OBJECT(ok_button), "clicked",
 130                      G_CALLBACK(passphrase_ok_cb), NULL);
 131     g_signal_connect(G_OBJECT(pass_entry), "activate",
 132                      G_CALLBACK(passphrase_ok_cb), NULL);
 133     g_signal_connect(G_OBJECT(cancel_button), "clicked",
 134                      G_CALLBACK(passphrase_cancel_cb), NULL);
 135
 136     gtk_window_set_position (GTK_WINDOW(window), GTK_WIN_POS_CENTER);
 137     if (grab_all)
 138         gtk_window_set_resizable(GTK_WINDOW(window), FALSE);
 139
 140     gtk_widget_show_all(window);
 141
 142     if (grab_all) {
 143         int err = 0, cnt = 0;
 144         /* make sure that window is viewable */
 145         gtk_widget_show_now(window);
 146         gdkwin = gtk_widget_get_window(window);
 147         gdk_flush();
 148         while(gtk_events_pending()) {
 149                 gtk_main_iteration();
 150         }
 151 try_again:
 152         if ((err = gdk_pointer_grab(gdkwin, TRUE, 0,
 153                              gdkwin, NULL, GDK_CURRENT_TIME))) {
 154             if (err == GDK_GRAB_NOT_VIEWABLE && cnt < 10) {
 155                 cnt++;
 156                 g_warning("trying to grab mouse again");
 157                 gtk_main_iteration();
 158                 goto try_again;
 159             } else {
 160                 g_warning("OOPS: Could not grab mouse");
 161                 gtk_widget_destroy(window);
 162                 return NULL;
 163             }
 164         }
 165         if (gdk_keyboard_grab(gdkwin, FALSE, GDK_CURRENT_TIME)) {
 166             gdk_display_pointer_ungrab(gdk_display_get_default(),
 167                                        GDK_CURRENT_TIME);
 168             g_warning("OOPS: Could not grab keyboard");
 169             gtk_widget_destroy(window);
 170             return NULL;
 171         }
 172     }
 173
 174     gtk_main();
 175
 176     if (grab_all) {
 177         gdk_display_keyboard_ungrab(gdk_display_get_default(),
 178                                     GDK_CURRENT_TIME);
 179         gdk_display_pointer_ungrab(gdk_display_get_default(), GDK_CURRENT_TIME);
 180         gdk_flush();
 181     }
 182
 183     manage_window_focus_out(window, NULL, NULL);
 184
 185     if (pass_ack) {
 186         const gchar *entry_text;
 187         entry_text = gtk_entry_get_text(GTK_ENTRY(pass_entry));
 188         the_passphrase = g_locale_from_utf8(entry_text, -1, NULL, NULL, NULL);
 189         if (the_passphrase == NULL)
 190             the_passphrase = g_strdup (entry_text);
 191     }
 192     gtk_widget_destroy (window);
 193
 194     return the_passphrase;
 195 }
 196
 197
 198 static void
 199 passphrase_ok_cb(GtkWidget *widget, gpointer data)
 200 {
 201     pass_ack = TRUE;
 202     gtk_main_quit();
 203 }
 204
 205 static void
 206 passphrase_cancel_cb(GtkWidget *widget, gpointer data)
 207 {
 208     pass_ack = FALSE;
 209     gtk_main_quit();
 210 }
 211
 212
 213 static gint
 214 passphrase_deleted(GtkWidget *widget, GdkEventAny *event, gpointer data)
 215 {
 216     passphrase_cancel_cb(NULL, NULL);
 217     return TRUE;
 218 }
 219
 220
 221 static gboolean
 222 passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
 223 {
 224     if (event && event->keyval == GDK_KEY_Escape)
 225         passphrase_cancel_cb(NULL, NULL);
 226     return FALSE;
 227 }
 228
 229 static gint
 230 linelen (const gchar *s)
 231 {
 232     gint i;
 233
 234     for (i = 0; *s && *s != '\n'; s++, i++)
 235         ;
 236
 237     return i;
 238 }
 239
 240 static GtkWidget *
 241 create_description(const gchar *uid_hint, gint prev_bad, gint new_key)
 242 {
 243     const gchar *uid = NULL;
 244     gchar *buf;
 245     GtkWidget *label;
 246     gchar *my_uid = NULL;
 247     if (!uid_hint)
 248         uid = _("[no user id]");
 249     else
 250         uid = uid_hint;
 251
 252     my_uid = g_strdup(uid);
 253     while (strchr(my_uid, '<'))
 254         *(strchr(my_uid, '<')) = '(';
 255     while (strchr(my_uid, '>'))
 256         *(strchr(my_uid, '>')) = ')';
 257
 258     if (new_key == 1) {
 259             buf = g_strdup_printf ("<span weight=\"bold\" size=\"larger\">%s%s</span>\n\n%.*s\n",
 260                            prev_bad ? _("Passphrases did not match.\n") : "",
 261                            _("Please enter the passphrase for the new key:"),
 262                            linelen (my_uid), my_uid);
 263     } else if (new_key == 2) {
 264             buf = g_strdup_printf ("<span weight=\"bold\" size=\"larger\">%s</span>\n\n%.*s\n",
 265                            _("Please re-enter the passphrase for the new key:"),
 266                            linelen (my_uid), my_uid);
 267     } else {
 268             buf = g_strdup_printf ("<span weight=\"bold\" size=\"larger\">%s%s</span>\n\n%.*s\n",
 269                            prev_bad ? _("Bad passphrase.\n") : "",
 270                            _("Please enter the passphrase for:"),
 271                            linelen (my_uid), my_uid);
 272     }
 273     g_free(my_uid);
 274     label = gtk_label_new (buf);
 275     gtk_label_set_use_markup(GTK_LABEL (label), TRUE);
 276     gtk_label_set_justify (GTK_LABEL (label), GTK_JUSTIFY_LEFT);
 277     gtk_label_set_line_wrap(GTK_LABEL (label), TRUE);
 278     g_free (buf);
 279
 280     return label;
 281 }
 282
 283 static int free_passphrase(gpointer _unused)
 284 {
 285     if (last_pass != NULL) {
 286 #ifndef G_PLATFORM_WIN32
 287         munlock(last_pass, strlen(last_pass));
 288 #endif
 289         g_free(last_pass);
 290         last_pass = NULL;
 291         debug_print("%% passphrase removed\n");
 292     }
 293
 294     return FALSE;
 295 }
 296
 297 gpgme_error_t
 298 gpgmegtk_passphrase_cb(void *opaque, const char *uid_hint,
 299         const char *passphrase_hint, int prev_bad, int fd)
 300 {
 301     char *pass = NULL;
 302
 303     if (prefs_gpg_get_config()->store_passphrase && last_pass && !prev_bad)
 304         pass = g_strdup(last_pass);
 305     else {
 306         gpgmegtk_set_passphrase_grab (prefs_gpg_get_config()->passphrase_grab);
 307         debug_print ("%% requesting passphrase for '%s'\n", uid_hint);
 308         pass = passphrase_mbox (uid_hint, passphrase_hint, prev_bad, FALSE);
 309         gpgmegtk_free_passphrase();
 310         if (!pass) {
 311             debug_print ("%% cancel passphrase entry\n");
 312             if (write(fd, "\n", 1) != 1)
 313                                 debug_print("short write\n");
 314
 315             return GPG_ERR_CANCELED;
 316         }
 317         else {
 318             if (prefs_gpg_get_config()->store_passphrase) {
 319                 last_pass = g_strdup(pass);
 320 #ifndef G_PLATFORM_WIN32
 321                 if (mlock(last_pass, strlen(last_pass)) == -1)
 322                     debug_print("%% locking passphrase failed\n");
 323 #endif
 324                 if (prefs_gpg_get_config()->store_passphrase_timeout > 0) {
 325                         g_timeout_add(prefs_gpg_get_config()
 326                                       ->store_passphrase_timeout*60*1000,
 327                                       free_passphrase, NULL);
 328                 }
 329             }
 330             debug_print ("%% sending passphrase\n");
 331         }
 332     }
 333
 334 #ifdef G_OS_WIN32
 335     {
 336         /* Under Windows FD is actually a System handle. */
 337         DWORD nwritten;
 338         WriteFile ((HANDLE)fd, pass, strlen (pass), &nwritten, NULL);
 339         WriteFile ((HANDLE)fd, "\n", 1, &nwritten, NULL);
 340     }
 341 #else
 342     if (write(fd, pass, strlen(pass)) != strlen(pass))
 343                 debug_print("short write\n");
 344
 345     if (write(fd, "\n", 1) != 1)
 346                 debug_print("short write\n");
 347 #endif
 348     g_free(pass);
 349
 350     return GPG_ERR_NO_ERROR;
 351 }
 352
 353 void gpgmegtk_free_passphrase()
 354 {
 355     (void)free_passphrase(NULL); /* could be inline */
 356 }
 357
 358 #endif /* USE_GPGME */