src/plugins/pgpcore/passphrase.c

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