enable storing of GnuPG passphrase
[claws.git] / src / 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 <string.h>
26 #include <sys/mman.h>
27 #include <glib.h>
28 #include <gdk/gdkkeysyms.h>
29 #include <gdk/gdkx.h>  /* GDK_DISPLAY() */
30 #include <gtk/gtkmain.h>
31 #include <gtk/gtkwidget.h>
32 #include <gtk/gtkwindow.h>
33 #include <gtk/gtkvbox.h>
34 #include <gtk/gtktable.h>
35 #include <gtk/gtklabel.h>
36 #include <gtk/gtkentry.h>
37 #include <gtk/gtkhbbox.h>
38 #include <gtk/gtkbutton.h>
39 #include <gtk/gtkfilesel.h>
40 #include <gtk/gtksignal.h>
41
42 #include "intl.h"
43 #include "passphrase.h"
44 #include "prefs_common.h"
45 #include "manage_window.h"
46
47
48 static int grab_all = 0;
49
50 static gboolean pass_ack;
51 static gchar* lastPass = 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 void passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event,
58                                    gpointer data);
59 static gchar* passphrase_mbox (const gchar *desc);
60
61
62 static GtkWidget *create_description (const gchar *desc);
63
64 void
65 gpgmegtk_set_passphrase_grab (gint yes)
66 {
67     grab_all = yes;
68 }
69
70 static gchar*
71 passphrase_mbox (const gchar *desc)
72 {
73     gchar *the_passphrase = NULL;
74     GtkWidget *vbox;
75     GtkWidget *table;
76     GtkWidget *pass_label;
77     GtkWidget *confirm_box;
78     GtkWidget *window;
79     GtkWidget *pass_entry;
80     GtkWidget *ok_button;
81     GtkWidget *cancel_button;
82
83     window = gtk_window_new(GTK_WINDOW_DIALOG);
84     gtk_window_set_title(GTK_WINDOW(window), _("Passphrase"));
85     gtk_widget_set_usize(window, 450, -1);
86     gtk_container_set_border_width(GTK_CONTAINER(window), 4);
87     gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
88     gtk_window_set_modal(GTK_WINDOW(window), TRUE);
89     gtk_window_set_policy(GTK_WINDOW(window), FALSE, FALSE, FALSE);
90     gtk_signal_connect(GTK_OBJECT(window), "delete_event",
91                        GTK_SIGNAL_FUNC(passphrase_deleted), NULL);
92     gtk_signal_connect(GTK_OBJECT(window), "key_press_event",
93                        GTK_SIGNAL_FUNC(passphrase_key_pressed), NULL);
94     MANAGE_WINDOW_SIGNALS_CONNECT(window);
95     manage_window_set_transient(GTK_WINDOW(window));
96
97     vbox = gtk_vbox_new(FALSE, 8);
98     gtk_container_add(GTK_CONTAINER(window), vbox);
99
100     if (desc) {
101         GtkWidget *label;
102         label = create_description (desc);
103         gtk_box_pack_start (GTK_BOX(vbox), label, TRUE, TRUE, 0);
104     }
105
106     table = gtk_table_new(2, 2, FALSE);
107     gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
108     gtk_container_set_border_width(GTK_CONTAINER(table), 8);
109     gtk_table_set_row_spacings(GTK_TABLE(table), 12);
110     gtk_table_set_col_spacings(GTK_TABLE(table), 8);
111
112
113     pass_label = gtk_label_new("");
114     gtk_table_attach (GTK_TABLE(table), pass_label, 0, 1, 0, 1,
115                       GTK_FILL, GTK_EXPAND|GTK_FILL, 0, 0);
116     gtk_misc_set_alignment (GTK_MISC (pass_label), 1, 0.5);
117
118     pass_entry = gtk_entry_new();
119     gtk_table_attach (GTK_TABLE(table), pass_entry, 1, 2, 0, 1,
120                       GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0);
121     gtk_entry_set_visibility (GTK_ENTRY(pass_entry), FALSE);
122     gtk_widget_grab_focus (pass_entry);
123
124
125     confirm_box = gtk_hbutton_box_new ();
126     gtk_button_box_set_layout (GTK_BUTTON_BOX(confirm_box), GTK_BUTTONBOX_END);
127     gtk_button_box_set_spacing (GTK_BUTTON_BOX(confirm_box), 5);
128
129     ok_button = gtk_button_new_with_label (_("OK"));
130     GTK_WIDGET_SET_FLAGS (ok_button, GTK_CAN_DEFAULT);
131     gtk_box_pack_start (GTK_BOX(confirm_box), ok_button, TRUE, TRUE, 0);
132
133     cancel_button = gtk_button_new_with_label (_("Cancel"));
134     GTK_WIDGET_SET_FLAGS (cancel_button, GTK_CAN_DEFAULT);
135     gtk_box_pack_start(GTK_BOX(confirm_box), cancel_button, TRUE, TRUE, 0);
136
137     gtk_box_pack_end(GTK_BOX(vbox), confirm_box, FALSE, FALSE, 0);
138     gtk_widget_grab_default (ok_button);
139
140     gtk_signal_connect(GTK_OBJECT(ok_button), "clicked",
141                        GTK_SIGNAL_FUNC(passphrase_ok_cb), NULL);
142     gtk_signal_connect(GTK_OBJECT(pass_entry), "activate",
143                        GTK_SIGNAL_FUNC(passphrase_ok_cb), NULL);
144     gtk_signal_connect(GTK_OBJECT(cancel_button), "clicked",
145                        GTK_SIGNAL_FUNC(passphrase_cancel_cb), NULL);
146
147     if (grab_all)
148         gtk_object_set (GTK_OBJECT(window), "type", GTK_WINDOW_POPUP, NULL);
149     gtk_window_set_position (GTK_WINDOW(window), GTK_WIN_POS_CENTER);
150     if (grab_all)   
151         gtk_window_set_policy (GTK_WINDOW(window), FALSE, FALSE, TRUE);
152     
153     gtk_widget_show_all(window);
154
155     if (grab_all) {
156         XGrabServer(GDK_DISPLAY());
157         if ( gdk_pointer_grab ( window->window, TRUE, 0,
158                                 NULL, NULL, GDK_CURRENT_TIME)) {
159             XUngrabServer ( GDK_DISPLAY() );
160             g_message ("OOPS: Could not grab mouse\n");
161             gtk_widget_destroy (window);
162             return NULL;
163         }
164         if ( gdk_keyboard_grab( window->window, FALSE, GDK_CURRENT_TIME )) {
165             gdk_pointer_ungrab (GDK_CURRENT_TIME);
166             XUngrabServer ( GDK_DISPLAY() );
167             g_message ("OOPS: Could not grab keyboard\n");
168             gtk_widget_destroy (window);
169             return NULL;
170         }
171     }
172
173     gtk_main();
174
175     if (grab_all) {
176         XUngrabServer (GDK_DISPLAY());
177         gdk_pointer_ungrab (GDK_CURRENT_TIME);
178         gdk_keyboard_ungrab (GDK_CURRENT_TIME);
179         gdk_flush();
180     }
181
182     manage_window_focus_out(window, NULL, NULL);
183
184     if (pass_ack) {
185         the_passphrase = gtk_entry_get_text(GTK_ENTRY(pass_entry));
186         if (the_passphrase) /* Hmmm: Do we really need this? */
187             the_passphrase = g_strdup (the_passphrase);
188     }
189     gtk_widget_destroy (window);
190
191     return the_passphrase;
192 }
193
194
195 static void 
196 passphrase_ok_cb(GtkWidget *widget, gpointer data)
197 {
198     pass_ack = TRUE;
199     gtk_main_quit();
200 }
201
202 static void 
203 passphrase_cancel_cb(GtkWidget *widget, gpointer data)
204 {
205     pass_ack = FALSE;
206     gtk_main_quit();
207 }
208
209
210 static gint
211 passphrase_deleted(GtkWidget *widget, GdkEventAny *event, gpointer data)
212 {
213     passphrase_cancel_cb(NULL, NULL);
214     return TRUE;
215 }
216
217
218 static void 
219 passphrase_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
220 {
221     if (event && event->keyval == GDK_Escape)
222         passphrase_cancel_cb(NULL, NULL);
223 }
224
225 static gint 
226 linelen (const gchar *s)
227 {
228     gint i;
229
230     for (i = 0; *s && *s != '\n'; s++, i++)
231         ;
232
233     return i;
234 }
235
236 static GtkWidget *
237 create_description (const gchar *desc)
238 {
239     const gchar *cmd = NULL, *uid = NULL, *info = NULL;
240     gchar *buf;
241     GtkWidget *label;
242
243     cmd = desc;
244     uid = strchr (cmd, '\n');
245     if (uid) {
246         info = strchr (++uid, '\n');
247         if (info )
248             info++;
249     }
250
251     if (!uid)
252         uid = _("[no user id]");
253     if (!info)
254         info = "";
255
256     buf = g_strdup_printf (_("%sPlease enter the passphrase for:\n\n"
257                            "  %.*s  \n"
258                            "(%.*s)\n"),
259                            !strncmp (cmd, "TRY_AGAIN", 9 ) ?
260                            _("Bad passphrase! Try again...\n\n") : "",
261                            linelen (uid), uid, linelen (info), info);
262
263     label = gtk_label_new (buf);
264     g_free (buf);
265
266     return label;
267 }
268
269 static int free_passphrase(gpointer _unused)
270 {
271     if (lastPass != NULL) {
272         munlock(lastPass, strlen(lastPass));
273         g_free(lastPass);
274         lastPass = NULL; // necessary?
275         g_message("%% passphrase removed");
276     }
277     
278     return FALSE;
279 }
280
281 const char*
282 gpgmegtk_passphrase_cb (void *opaque, const char *desc, void *r_hd)
283 {
284     struct passphrase_cb_info_s *info = opaque;
285     GpgmeCtx ctx = info ? info->c : NULL;
286     const char *pass;
287
288     if (!desc) {
289         /* FIXME: cleanup by looking at *r_hd */
290         return NULL;
291     }
292     if (prefs_common.store_passphrase
293         && strncmp(desc, "TRY_AGAIN", 9) && (lastPass != NULL))
294         return g_strdup(lastPass);
295
296     gpgmegtk_set_passphrase_grab (prefs_common.passphrase_grab);
297     g_message ("%% requesting passphrase for `%s': ", desc );
298     pass = passphrase_mbox (desc);
299     gpgmegtk_free_passphrase();
300     if (!pass) {
301         g_message ("%% cancel passphrase entry");
302         gpgme_cancel (ctx);
303     }
304     else {
305         if (prefs_common.store_passphrase) {
306             lastPass = g_strdup(pass);
307             if (mlock(lastPass, strlen(lastPass)) == -1)
308                 g_message("%% locking passphrase failed");
309
310             if (prefs_common.store_passphrase_timeout > 0) {
311                 gtk_timeout_add(prefs_common.store_passphrase_timeout*60*1000,
312                                 free_passphrase, NULL);
313             }
314         }
315         g_message ("%% sending passphrase");
316     }
317
318     return pass;
319 }
320
321 void gpgmegtk_free_passphrase()
322 {
323     (void)free_passphrase(NULL); // could be inline
324 }
325
326 #endif /* USE_GPGME */