src/plugins/pgpcore/passphrase.c

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