Help for the next release notes :)
[claws.git] / src / plugins / pgpmime / passphrase.c
1 /* passphrase.c - GTK+ based passphrase callback
2  *      Copyright (C) 2001 Werner Koch (dd9jn)
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 #include <sys/mman.h>
47
48 #include "passphrase.h"
49 #include "prefs_common.h"
50 #include "manage_window.h"
51 #include "utils.h"
52 #include "prefs_gpg.h"
53
54 static gboolean grab_all = FALSE;
55
56 static gboolean pass_ack;
57 static gchar *last_pass = NULL;
58
59 static void passphrase_ok_cb(GtkWidget *widget, gpointer data);
60 static void passphrase_cancel_cb(GtkWidget *widget, gpointer data);
61 static gint passphrase_deleted(GtkWidget *widget, GdkEventAny *event,
62                                gpointer data);
63 static gboolean passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event,
64                                        gpointer data);
65 static gchar* passphrase_mbox (const gchar *desc);
66
67
68 static GtkWidget *create_description (const gchar *desc);
69
70 void
71 gpgmegtk_set_passphrase_grab(gint yes)
72 {
73     grab_all = yes;
74 }
75
76 static gchar*
77 passphrase_mbox (const gchar *desc)
78 {
79     gchar *the_passphrase = NULL;
80     GtkWidget *vbox;
81     GtkWidget *confirm_box;
82     GtkWidget *window;
83     GtkWidget *pass_entry;
84     GtkWidget *ok_button;
85     GtkWidget *cancel_button;
86     gint       grab_result;
87
88     window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
89     gtk_window_set_title(GTK_WINDOW(window), _("Passphrase"));
90     gtk_widget_set_size_request(window, 450, -1);
91     gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
92     gtk_window_set_modal(GTK_WINDOW(window), TRUE);
93     gtk_window_set_resizable(GTK_WINDOW(window), FALSE);
94     g_signal_connect(G_OBJECT(window), "delete_event",
95                      G_CALLBACK(passphrase_deleted), NULL);
96     g_signal_connect(G_OBJECT(window), "key_press_event",
97                      G_CALLBACK(passphrase_key_pressed), NULL);
98     MANAGE_WINDOW_SIGNALS_CONNECT(window);
99     manage_window_set_transient(GTK_WINDOW(window));
100
101     vbox = gtk_vbox_new(FALSE, 8);
102     gtk_container_add(GTK_CONTAINER(window), vbox);
103     gtk_container_set_border_width(GTK_CONTAINER(vbox), 8);
104
105     if (desc) {
106         GtkWidget *label;
107         label = create_description (desc);
108         gtk_box_pack_start (GTK_BOX(vbox), label, FALSE, FALSE, 0);
109     }
110
111     pass_entry = gtk_entry_new();
112     gtk_box_pack_start(GTK_BOX(vbox), pass_entry, FALSE, FALSE, 0);
113     gtk_entry_set_visibility(GTK_ENTRY(pass_entry), FALSE);
114     gtk_widget_grab_focus(pass_entry);
115
116     gtkut_stock_button_set_create(&confirm_box, &ok_button, GTK_STOCK_OK,
117                                   &cancel_button, GTK_STOCK_CANCEL,
118                                   NULL, NULL);
119     gtk_box_pack_end(GTK_BOX(vbox), confirm_box, FALSE, FALSE, 0);
120     gtk_widget_grab_default(ok_button);
121
122     g_signal_connect(G_OBJECT(ok_button), "clicked",
123                      G_CALLBACK(passphrase_ok_cb), NULL);
124     g_signal_connect(G_OBJECT(pass_entry), "activate",
125                      G_CALLBACK(passphrase_ok_cb), NULL);
126     g_signal_connect(G_OBJECT(cancel_button), "clicked",
127                      G_CALLBACK(passphrase_cancel_cb), NULL);
128
129     gtk_window_set_position (GTK_WINDOW(window), GTK_WIN_POS_CENTER);
130     if (grab_all)   
131         gtk_window_set_resizable(GTK_WINDOW(window), FALSE);
132     
133     gtk_widget_show_all(window);
134
135     if (grab_all) {
136         /* make sure that window is viewable
137          * FIXME: this is still not enough */
138         gtk_widget_show_now(window);
139         gdk_flush();
140 #ifdef GDK_WINDOWING_X11
141         gdk_x11_display_grab(gdk_display_get_default());
142 #endif /* GDK_WINDOWING_X11 */
143         if (gdk_pointer_grab(window->window, TRUE, 0,
144                              window->window, NULL, GDK_CURRENT_TIME)) {
145 #ifdef GDK_WINDOWING_X11
146             gdk_x11_display_ungrab(gdk_display_get_default());
147 #endif /* GDK_WINDOWING_X11 */
148             g_warning("OOPS: Could not grab mouse\n");
149             gtk_widget_destroy(window);
150             return NULL;
151         }
152         if (gdk_keyboard_grab(window->window, FALSE, GDK_CURRENT_TIME)) {
153             gdk_display_pointer_ungrab(gdk_display_get_default(),
154                                        GDK_CURRENT_TIME);
155 #ifdef GDK_WINDOWING_X11
156             gdk_x11_display_ungrab(gdk_display_get_default());
157 #endif /* GDK_WINDOWING_X11 */
158             g_warning("OOPS: Could not grab keyboard\n");
159             gtk_widget_destroy(window);
160             return NULL;
161         }
162     }
163
164     gtk_main();
165
166     if (grab_all) {
167         gdk_display_keyboard_ungrab(gdk_display_get_default(),
168                                     GDK_CURRENT_TIME);
169         gdk_display_pointer_ungrab(gdk_display_get_default(), GDK_CURRENT_TIME);
170 #ifdef GDK_WINDOWING_X11
171         gdk_x11_display_ungrab(gdk_display_get_default());
172 #endif /* GDK_WINDOWING_X11 */
173         gdk_flush();
174     }
175
176     manage_window_focus_out(window, NULL, NULL);
177
178     if (pass_ack) {
179         const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(pass_entry));
180         if (entry_text) /* Hmmm: Do we really need this? */
181             the_passphrase = g_strdup (entry_text);
182     }
183     gtk_widget_destroy (window);
184
185     return the_passphrase;
186 }
187
188
189 static void 
190 passphrase_ok_cb(GtkWidget *widget, gpointer data)
191 {
192     pass_ack = TRUE;
193     gtk_main_quit();
194 }
195
196 static void 
197 passphrase_cancel_cb(GtkWidget *widget, gpointer data)
198 {
199     pass_ack = FALSE;
200     gtk_main_quit();
201 }
202
203
204 static gint
205 passphrase_deleted(GtkWidget *widget, GdkEventAny *event, gpointer data)
206 {
207     passphrase_cancel_cb(NULL, NULL);
208     return TRUE;
209 }
210
211
212 static gboolean
213 passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
214 {
215     if (event && event->keyval == GDK_Escape)
216         passphrase_cancel_cb(NULL, NULL);
217     return FALSE;
218 }
219
220 static gint 
221 linelen (const gchar *s)
222 {
223     gint i;
224
225     for (i = 0; *s && *s != '\n'; s++, i++)
226         ;
227
228     return i;
229 }
230
231 static GtkWidget *
232 create_description (const gchar *desc)
233 {
234     const gchar *cmd = NULL, *uid = NULL, *info = NULL;
235     gchar *buf;
236     GtkWidget *label;
237
238     cmd = desc;
239     uid = strchr (cmd, '\n');
240     if (uid) {
241         info = strchr (++uid, '\n');
242         if (info )
243             info++;
244     }
245
246     if (!uid)
247         uid = _("[no user id]");
248     if (!info)
249         info = "";
250
251     buf = g_strdup_printf (_("%sPlease enter the passphrase for:\n\n"
252                            "  %.*s  \n"
253                            "(%.*s)\n"),
254                            !strncmp (cmd, "TRY_AGAIN", 9 ) ?
255                            _("Bad passphrase! Try again...\n\n") : "",
256                            linelen (uid), uid, linelen (info), info);
257
258     label = gtk_label_new (buf);
259     gtk_label_set_justify (GTK_LABEL (label), GTK_JUSTIFY_LEFT);
260     g_free (buf);
261
262     return label;
263 }
264
265 static int free_passphrase(gpointer _unused)
266 {
267     if (last_pass != NULL) {
268         munlock(last_pass, strlen(last_pass));
269         g_free(last_pass);
270         last_pass = NULL;
271         debug_print("%% passphrase removed");
272     }
273     
274     return FALSE;
275 }
276
277 const char*
278 gpgmegtk_passphrase_cb (void *opaque, const char *desc, void **r_hd)
279 {
280     struct passphrase_cb_info_s *info = opaque;
281     GpgmeCtx ctx = info ? info->c : NULL;
282     const char *pass;
283
284     if (!desc) {
285         /* FIXME: cleanup by looking at *r_hd */
286         return NULL;
287     }
288     if (prefs_gpg_get_config()->store_passphrase && last_pass != NULL &&
289         strncmp(desc, "TRY_AGAIN", 9) != 0)
290         return g_strdup(last_pass);
291
292     gpgmegtk_set_passphrase_grab (prefs_gpg_get_config()->passphrase_grab);
293     debug_print ("%% requesting passphrase for `%s': ", desc);
294     pass = passphrase_mbox (desc);
295     gpgmegtk_free_passphrase();
296     if (!pass) {
297         debug_print ("%% cancel passphrase entry");
298         gpgme_cancel (ctx);
299     }
300     else {
301         if (prefs_gpg_get_config()->store_passphrase) {
302             last_pass = g_strdup(pass);
303             if (mlock(last_pass, strlen(last_pass)) == -1)
304                 debug_print("%% locking passphrase failed");
305
306             if (prefs_gpg_get_config()->store_passphrase_timeout > 0) {
307                 gtk_timeout_add(prefs_gpg_get_config()->store_passphrase_timeout*60*1000,
308                                 free_passphrase, NULL);
309             }
310         }
311         debug_print ("%% sending passphrase");
312     }
313
314     return pass;
315 }
316
317 void gpgmegtk_free_passphrase(void)
318 {
319     (void)free_passphrase(NULL); /* could be inline */
320 }
321
322 #endif /* USE_GPGME */