]> git.sur5r.net Git - i3/i3lock/blob - i3lock.c
380cab47b33292e48bd1c74d03aba626c10899ab
[i3/i3lock] / i3lock.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * © 2010 Michael Stapelberg
5  *
6  * See LICENSE for licensing information
7  *
8  */
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <pwd.h>
12 #include <sys/types.h>
13 #include <string.h>
14 #include <unistd.h>
15 #include <stdbool.h>
16 #include <stdint.h>
17 #include <xcb/xcb.h>
18 #include <xcb/xkb.h>
19 #include <err.h>
20 #include <assert.h>
21 #include <security/pam_appl.h>
22 #include <getopt.h>
23 #include <string.h>
24 #include <ev.h>
25 #include <sys/mman.h>
26 #include <xkbcommon/xkbcommon.h>
27 #include <xkbcommon/xkbcommon-compose.h>
28 #include <xkbcommon/xkbcommon-x11.h>
29 #include <cairo.h>
30 #include <cairo/cairo-xcb.h>
31
32 #include "i3lock.h"
33 #include "xcb.h"
34 #include "cursors.h"
35 #include "unlock_indicator.h"
36 #include "xinerama.h"
37
38 #define TSTAMP_N_SECS(n) (n * 1.0)
39 #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n))
40 #define START_TIMER(timer_obj, timeout, callback) \
41     timer_obj = start_timer(timer_obj, timeout, callback)
42 #define STOP_TIMER(timer_obj) \
43     timer_obj = stop_timer(timer_obj)
44
45 typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents);
46
47 char color[7] = "ffffff";
48 uint32_t last_resolution[2];
49 xcb_window_t win;
50 static xcb_cursor_t cursor;
51 static pam_handle_t *pam_handle;
52 int input_position = 0;
53 /* Holds the password you enter (in UTF-8). */
54 static char password[512];
55 static bool beep = false;
56 bool debug_mode = false;
57 bool unlock_indicator = true;
58 char *modifier_string = NULL;
59 static bool dont_fork = false;
60 struct ev_loop *main_loop;
61 static struct ev_timer *clear_pam_wrong_timeout;
62 static struct ev_timer *clear_indicator_timeout;
63 static struct ev_timer *discard_passwd_timeout;
64 extern unlock_state_t unlock_state;
65 extern pam_state_t pam_state;
66 int failed_attempts = 0;
67 bool show_failed_attempts = false;
68
69 static struct xkb_state *xkb_state;
70 static struct xkb_context *xkb_context;
71 static struct xkb_keymap *xkb_keymap;
72 static struct xkb_compose_table *xkb_compose_table;
73 static struct xkb_compose_state *xkb_compose_state;
74 static uint8_t xkb_base_event;
75 static uint8_t xkb_base_error;
76
77 cairo_surface_t *img = NULL;
78 bool tile = false;
79 bool ignore_empty_password = false;
80 bool skip_repeated_empty_password = false;
81
82 /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
83 #define isutf(c) (((c)&0xC0) != 0x80)
84
85 /*
86  * Decrements i to point to the previous unicode glyph
87  *
88  */
89 void u8_dec(char *s, int *i) {
90     (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
91 }
92
93 /*
94  * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
95  * Necessary so that we can properly let xkbcommon track the keyboard state and
96  * translate keypresses to utf-8.
97  *
98  */
99 static bool load_keymap(void) {
100     if (xkb_context == NULL) {
101         if ((xkb_context = xkb_context_new(0)) == NULL) {
102             fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
103             return false;
104         }
105     }
106
107     xkb_keymap_unref(xkb_keymap);
108
109     int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn);
110     DEBUG("device = %d\n", device_id);
111     if ((xkb_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
112         fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n");
113         return false;
114     }
115
116     struct xkb_state *new_state =
117         xkb_x11_state_new_from_device(xkb_keymap, conn, device_id);
118     if (new_state == NULL) {
119         fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n");
120         return false;
121     }
122
123     xkb_state_unref(xkb_state);
124     xkb_state = new_state;
125
126     return true;
127 }
128
129 /*
130  * Loads the XKB compose table from the given locale.
131  *
132  */
133 static bool load_compose_table(const char *locale) {
134     xkb_compose_table_unref(xkb_compose_table);
135
136     if ((xkb_compose_table = xkb_compose_table_new_from_locale(xkb_context, locale, 0)) == NULL) {
137         fprintf(stderr, "[i3lock] xkb_compose_table_new_from_locale failed\n");
138         return false;
139     }
140
141     struct xkb_compose_state *new_compose_state = xkb_compose_state_new(xkb_compose_table, 0);
142     if (new_compose_state == NULL) {
143         fprintf(stderr, "[i3lock] xkb_compose_state_new failed\n");
144         return false;
145     }
146
147     xkb_compose_state_unref(xkb_compose_state);
148     xkb_compose_state = new_compose_state;
149
150     return true;
151 }
152
153 /*
154  * Clears the memory which stored the password to be a bit safer against
155  * cold-boot attacks.
156  *
157  */
158 static void clear_password_memory(void) {
159     /* A volatile pointer to the password buffer to prevent the compiler from
160      * optimizing this out. */
161     volatile char *vpassword = password;
162     for (int c = 0; c < sizeof(password); c++)
163         /* We store a non-random pattern which consists of the (irrelevant)
164          * index plus (!) the value of the beep variable. This prevents the
165          * compiler from optimizing the calls away, since the value of 'beep'
166          * is not known at compile-time. */
167         vpassword[c] = c + (int)beep;
168 }
169
170 ev_timer *start_timer(ev_timer *timer_obj, ev_tstamp timeout, ev_callback_t callback) {
171     if (timer_obj) {
172         ev_timer_stop(main_loop, timer_obj);
173         ev_timer_set(timer_obj, timeout, 0.);
174         ev_timer_start(main_loop, timer_obj);
175     } else {
176         /* When there is no memory, we just don’t have a timeout. We cannot
177          * exit() here, since that would effectively unlock the screen. */
178         timer_obj = calloc(sizeof(struct ev_timer), 1);
179         if (timer_obj) {
180             ev_timer_init(timer_obj, callback, timeout, 0.);
181             ev_timer_start(main_loop, timer_obj);
182         }
183     }
184     return timer_obj;
185 }
186
187 ev_timer *stop_timer(ev_timer *timer_obj) {
188     if (timer_obj) {
189         ev_timer_stop(main_loop, timer_obj);
190         free(timer_obj);
191     }
192     return NULL;
193 }
194
195 /*
196  * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccessful
197  * authentication event.
198  *
199  */
200 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
201     DEBUG("clearing pam wrong\n");
202     pam_state = STATE_PAM_IDLE;
203     redraw_screen();
204
205     /* Clear modifier string. */
206     if (modifier_string != NULL) {
207         free(modifier_string);
208         modifier_string = NULL;
209     }
210
211     /* Now free this timeout. */
212     STOP_TIMER(clear_pam_wrong_timeout);
213 }
214
215 static void clear_indicator_cb(EV_P_ ev_timer *w, int revents) {
216     clear_indicator();
217     STOP_TIMER(clear_indicator_timeout);
218 }
219
220 static void clear_input(void) {
221     input_position = 0;
222     clear_password_memory();
223     password[input_position] = '\0';
224 }
225
226 static void discard_passwd_cb(EV_P_ ev_timer *w, int revents) {
227     clear_input();
228     STOP_TIMER(discard_passwd_timeout);
229 }
230
231 static void input_done(void) {
232     STOP_TIMER(clear_pam_wrong_timeout);
233     pam_state = STATE_PAM_VERIFY;
234     unlock_state = STATE_STARTED;
235     redraw_screen();
236
237     if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
238         DEBUG("successfully authenticated\n");
239         clear_password_memory();
240
241         /* PAM credentials should be refreshed, this will for example update any kerberos tickets.
242          * Related to credentials pam_end() needs to be called to cleanup any temporary
243          * credentials like kerberos /tmp/krb5cc_pam_* files which may of been left behind if the
244          * refresh of the credentials failed. */
245         pam_setcred(pam_handle, PAM_REFRESH_CRED);
246         pam_end(pam_handle, PAM_SUCCESS);
247
248         exit(0);
249     }
250
251     if (debug_mode)
252         fprintf(stderr, "Authentication failure\n");
253
254     /* Get state of Caps and Num lock modifiers, to be displayed in
255      * STATE_PAM_WRONG state */
256     xkb_mod_index_t idx, num_mods;
257     const char *mod_name;
258
259     num_mods = xkb_keymap_num_mods(xkb_keymap);
260
261     for (idx = 0; idx < num_mods; idx++) {
262         if (!xkb_state_mod_index_is_active(xkb_state, idx, XKB_STATE_MODS_EFFECTIVE))
263             continue;
264
265         mod_name = xkb_keymap_mod_get_name(xkb_keymap, idx);
266         if (mod_name == NULL)
267             continue;
268
269         /* Replace certain xkb names with nicer, human-readable ones. */
270         if (strcmp(mod_name, XKB_MOD_NAME_CAPS) == 0)
271             mod_name = "Caps Lock";
272         else if (strcmp(mod_name, XKB_MOD_NAME_ALT) == 0)
273             mod_name = "Alt";
274         else if (strcmp(mod_name, XKB_MOD_NAME_NUM) == 0)
275             mod_name = "Num Lock";
276         else if (strcmp(mod_name, XKB_MOD_NAME_LOGO) == 0)
277             mod_name = "Win";
278
279         char *tmp;
280         if (modifier_string == NULL) {
281             if (asprintf(&tmp, "%s", mod_name) != -1)
282                 modifier_string = tmp;
283         } else if (asprintf(&tmp, "%s, %s", modifier_string, mod_name) != -1) {
284             free(modifier_string);
285             modifier_string = tmp;
286         }
287     }
288
289     pam_state = STATE_PAM_WRONG;
290     failed_attempts += 1;
291     clear_input();
292     if (unlock_indicator)
293         redraw_screen();
294
295     /* Clear this state after 2 seconds (unless the user enters another
296      * password during that time). */
297     ev_now_update(main_loop);
298     START_TIMER(clear_pam_wrong_timeout, TSTAMP_N_SECS(2), clear_pam_wrong);
299
300     /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
301      * too early. */
302     STOP_TIMER(clear_indicator_timeout);
303
304     /* beep on authentication failure, if enabled */
305     if (beep) {
306         xcb_bell(conn, 100);
307         xcb_flush(conn);
308     }
309 }
310
311 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
312     redraw_screen();
313     STOP_TIMER(w);
314 }
315
316 static bool skip_without_validation(void) {
317     if (input_position != 0)
318         return false;
319
320     if (skip_repeated_empty_password || ignore_empty_password)
321         return true;
322
323     return false;
324 }
325
326 /*
327  * Handle key presses. Fixes state, then looks up the key symbol for the
328  * given keycode, then looks up the key symbol (as UCS-2), converts it to
329  * UTF-8 and stores it in the password array.
330  *
331  */
332 static void handle_key_press(xcb_key_press_event_t *event) {
333     xkb_keysym_t ksym;
334     char buffer[128];
335     int n;
336     bool ctrl;
337     bool composed = false;
338
339     ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
340     ctrl = xkb_state_mod_name_is_active(xkb_state, XKB_MOD_NAME_CTRL, XKB_STATE_MODS_DEPRESSED);
341
342     /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
343     memset(buffer, '\0', sizeof(buffer));
344
345     if (xkb_compose_state && xkb_compose_state_feed(xkb_compose_state, ksym) == XKB_COMPOSE_FEED_ACCEPTED) {
346         switch (xkb_compose_state_get_status(xkb_compose_state)) {
347             case XKB_COMPOSE_NOTHING:
348                 break;
349             case XKB_COMPOSE_COMPOSING:
350                 return;
351             case XKB_COMPOSE_COMPOSED:
352                 /* xkb_compose_state_get_utf8 doesn't include the terminating byte in the return value
353              * as xkb_keysym_to_utf8 does. Adding one makes the variable n consistent. */
354                 n = xkb_compose_state_get_utf8(xkb_compose_state, buffer, sizeof(buffer)) + 1;
355                 ksym = xkb_compose_state_get_one_sym(xkb_compose_state);
356                 composed = true;
357                 break;
358             case XKB_COMPOSE_CANCELLED:
359                 xkb_compose_state_reset(xkb_compose_state);
360                 return;
361         }
362     }
363
364     if (!composed) {
365         n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
366     }
367
368     switch (ksym) {
369         case XKB_KEY_j:
370         case XKB_KEY_Return:
371         case XKB_KEY_KP_Enter:
372         case XKB_KEY_XF86ScreenSaver:
373             if (ksym == XKB_KEY_j && !ctrl)
374                 break;
375
376             if (pam_state == STATE_PAM_WRONG)
377                 return;
378
379             if (skip_without_validation()) {
380                 clear_input();
381                 return;
382             }
383             password[input_position] = '\0';
384             unlock_state = STATE_KEY_PRESSED;
385             redraw_screen();
386             input_done();
387             skip_repeated_empty_password = true;
388             return;
389         default:
390             skip_repeated_empty_password = false;
391     }
392
393     switch (ksym) {
394         case XKB_KEY_u:
395         case XKB_KEY_Escape:
396             if ((ksym == XKB_KEY_u && ctrl) ||
397                 ksym == XKB_KEY_Escape) {
398                 DEBUG("C-u pressed\n");
399                 clear_input();
400                 /* Hide the unlock indicator after a bit if the password buffer is
401                  * empty. */
402                 if (unlock_indicator) {
403                     START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
404                     unlock_state = STATE_BACKSPACE_ACTIVE;
405                     redraw_screen();
406                     unlock_state = STATE_KEY_PRESSED;
407                 }
408                 return;
409             }
410             break;
411
412         case XKB_KEY_Delete:
413         case XKB_KEY_KP_Delete:
414             /* Deleting forward doesn’t make sense, as i3lock doesn’t allow you
415              * to move the cursor when entering a password. We need to eat this
416              * key press so that it won’t be treated as part of the password,
417              * see issue #50. */
418             return;
419
420         case XKB_KEY_h:
421         case XKB_KEY_BackSpace:
422             if (ksym == XKB_KEY_h && !ctrl)
423                 break;
424
425             if (input_position == 0)
426                 return;
427
428             /* decrement input_position to point to the previous glyph */
429             u8_dec(password, &input_position);
430             password[input_position] = '\0';
431
432             /* Hide the unlock indicator after a bit if the password buffer is
433              * empty. */
434             START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
435             unlock_state = STATE_BACKSPACE_ACTIVE;
436             redraw_screen();
437             unlock_state = STATE_KEY_PRESSED;
438             return;
439     }
440
441     if ((input_position + 8) >= sizeof(password))
442         return;
443
444 #if 0
445     /* FIXME: handle all of these? */
446     printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
447     printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
448     printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
449     printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
450     printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
451     printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
452     printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
453 #endif
454
455     if (n < 2)
456         return;
457
458     /* store it in the password array as UTF-8 */
459     memcpy(password + input_position, buffer, n - 1);
460     input_position += n - 1;
461     DEBUG("current password = %.*s\n", input_position, password);
462
463     if (unlock_indicator) {
464         unlock_state = STATE_KEY_ACTIVE;
465         redraw_screen();
466         unlock_state = STATE_KEY_PRESSED;
467
468         struct ev_timer *timeout = NULL;
469         START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout);
470         STOP_TIMER(clear_indicator_timeout);
471     }
472
473     START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
474 }
475
476 /*
477  * A visibility notify event will be received when the visibility (= can the
478  * user view the complete window) changes, so for example when a popup overlays
479  * some area of the i3lock window.
480  *
481  * In this case, we raise our window on top so that the popup (or whatever is
482  * hiding us) gets hidden.
483  *
484  */
485 static void handle_visibility_notify(xcb_connection_t *conn,
486                                      xcb_visibility_notify_event_t *event) {
487     if (event->state != XCB_VISIBILITY_UNOBSCURED) {
488         uint32_t values[] = {XCB_STACK_MODE_ABOVE};
489         xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
490         xcb_flush(conn);
491     }
492 }
493
494 /*
495  * Called when the keyboard mapping changes. We update our symbols.
496  *
497  * We ignore errors — if the new keymap cannot be loaded it’s better if the
498  * screen stays locked and the user intervenes by using killall i3lock.
499  *
500  */
501 static void process_xkb_event(xcb_generic_event_t *gevent) {
502     union xkb_event {
503         struct {
504             uint8_t response_type;
505             uint8_t xkbType;
506             uint16_t sequence;
507             xcb_timestamp_t time;
508             uint8_t deviceID;
509         } any;
510         xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify;
511         xcb_xkb_map_notify_event_t map_notify;
512         xcb_xkb_state_notify_event_t state_notify;
513     } *event = (union xkb_event *)gevent;
514
515     DEBUG("process_xkb_event for device %d\n", event->any.deviceID);
516
517     if (event->any.deviceID != xkb_x11_get_core_keyboard_device_id(conn))
518         return;
519
520     /*
521      * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap
522      * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent
523      * recompilations.
524      */
525     switch (event->any.xkbType) {
526         case XCB_XKB_NEW_KEYBOARD_NOTIFY:
527             if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES)
528                 (void)load_keymap();
529             break;
530
531         case XCB_XKB_MAP_NOTIFY:
532             (void)load_keymap();
533             break;
534
535         case XCB_XKB_STATE_NOTIFY:
536             xkb_state_update_mask(xkb_state,
537                                   event->state_notify.baseMods,
538                                   event->state_notify.latchedMods,
539                                   event->state_notify.lockedMods,
540                                   event->state_notify.baseGroup,
541                                   event->state_notify.latchedGroup,
542                                   event->state_notify.lockedGroup);
543             break;
544     }
545 }
546
547 /*
548  * Called when the properties on the root window change, e.g. when the screen
549  * resolution changes. If so we update the window to cover the whole screen
550  * and also redraw the image, if any.
551  *
552  */
553 void handle_screen_resize(void) {
554     xcb_get_geometry_cookie_t geomc;
555     xcb_get_geometry_reply_t *geom;
556     geomc = xcb_get_geometry(conn, screen->root);
557     if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
558         return;
559
560     if (last_resolution[0] == geom->width &&
561         last_resolution[1] == geom->height) {
562         free(geom);
563         return;
564     }
565
566     last_resolution[0] = geom->width;
567     last_resolution[1] = geom->height;
568
569     free(geom);
570
571     redraw_screen();
572
573     uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
574     xcb_configure_window(conn, win, mask, last_resolution);
575     xcb_flush(conn);
576
577     xinerama_query_screens();
578     redraw_screen();
579 }
580
581 /*
582  * Callback function for PAM. We only react on password request callbacks.
583  *
584  */
585 static int conv_callback(int num_msg, const struct pam_message **msg,
586                          struct pam_response **resp, void *appdata_ptr) {
587     if (num_msg == 0)
588         return 1;
589
590     /* PAM expects an array of responses, one for each message */
591     if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
592         perror("calloc");
593         return 1;
594     }
595
596     for (int c = 0; c < num_msg; c++) {
597         if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
598             msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
599             continue;
600
601         /* return code is currently not used but should be set to zero */
602         resp[c]->resp_retcode = 0;
603         if ((resp[c]->resp = strdup(password)) == NULL) {
604             perror("strdup");
605             return 1;
606         }
607     }
608
609     return 0;
610 }
611
612 /*
613  * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
614  * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
615  *
616  */
617 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
618     /* empty, because xcb_prepare_cb and xcb_check_cb are used */
619 }
620
621 /*
622  * Flush before blocking (and waiting for new events)
623  *
624  */
625 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
626     xcb_flush(conn);
627 }
628
629 /*
630  * Try closing logind sleep lock fd passed over from xss-lock, in case we're
631  * being run from there.
632  *
633  */
634 static void maybe_close_sleep_lock_fd(void) {
635     const char *sleep_lock_fd = getenv("XSS_SLEEP_LOCK_FD");
636     char *endptr;
637     if (sleep_lock_fd && *sleep_lock_fd != 0) {
638         long int fd = strtol(sleep_lock_fd, &endptr, 10);
639         if (*endptr == 0) {
640             close(fd);
641         }
642     }
643 }
644
645 /*
646  * Instead of polling the X connection socket we leave this to
647  * xcb_poll_for_event() which knows better than we can ever know.
648  *
649  */
650 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
651     xcb_generic_event_t *event;
652
653     if (xcb_connection_has_error(conn))
654         errx(EXIT_FAILURE, "X11 connection broke, did your server terminate?\n");
655
656     while ((event = xcb_poll_for_event(conn)) != NULL) {
657         if (event->response_type == 0) {
658             xcb_generic_error_t *error = (xcb_generic_error_t *)event;
659             if (debug_mode)
660                 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
661                         error->sequence, error->error_code);
662             free(event);
663             continue;
664         }
665
666         /* Strip off the highest bit (set if the event is generated) */
667         int type = (event->response_type & 0x7F);
668
669         switch (type) {
670             case XCB_KEY_PRESS:
671                 handle_key_press((xcb_key_press_event_t *)event);
672                 break;
673
674             case XCB_VISIBILITY_NOTIFY:
675                 handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
676                 break;
677
678             case XCB_MAP_NOTIFY:
679                 maybe_close_sleep_lock_fd();
680                 if (!dont_fork) {
681                     /* After the first MapNotify, we never fork again. We don’t
682                      * expect to get another MapNotify, but better be sure… */
683                     dont_fork = true;
684
685                     /* In the parent process, we exit */
686                     if (fork() != 0)
687                         exit(0);
688
689                     ev_loop_fork(EV_DEFAULT);
690                 }
691                 break;
692
693             case XCB_CONFIGURE_NOTIFY:
694                 handle_screen_resize();
695                 break;
696
697             default:
698                 if (type == xkb_base_event)
699                     process_xkb_event(event);
700         }
701
702         free(event);
703     }
704 }
705
706 /*
707  * This function is called from a fork()ed child and will raise the i3lock
708  * window when the window is obscured, even when the main i3lock process is
709  * blocked due to PAM.
710  *
711  */
712 static void raise_loop(xcb_window_t window) {
713     xcb_connection_t *conn;
714     xcb_generic_event_t *event;
715     int screens;
716
717     if ((conn = xcb_connect(NULL, &screens)) == NULL ||
718         xcb_connection_has_error(conn))
719         errx(EXIT_FAILURE, "Cannot open display\n");
720
721     /* We need to know about the window being obscured or getting destroyed. */
722     xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK,
723                                  (uint32_t[]){
724                                      XCB_EVENT_MASK_VISIBILITY_CHANGE |
725                                      XCB_EVENT_MASK_STRUCTURE_NOTIFY});
726     xcb_flush(conn);
727
728     DEBUG("Watching window 0x%08x\n", window);
729     while ((event = xcb_wait_for_event(conn)) != NULL) {
730         if (event->response_type == 0) {
731             xcb_generic_error_t *error = (xcb_generic_error_t *)event;
732             DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n",
733                   error->sequence, error->error_code);
734             free(event);
735             continue;
736         }
737         /* Strip off the highest bit (set if the event is generated) */
738         int type = (event->response_type & 0x7F);
739         DEBUG("Read event of type %d\n", type);
740         switch (type) {
741             case XCB_VISIBILITY_NOTIFY:
742                 handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
743                 break;
744             case XCB_UNMAP_NOTIFY:
745                 DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t *)event)->window));
746                 if (((xcb_unmap_notify_event_t *)event)->window == window)
747                     exit(EXIT_SUCCESS);
748                 break;
749             case XCB_DESTROY_NOTIFY:
750                 DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t *)event)->window));
751                 if (((xcb_destroy_notify_event_t *)event)->window == window)
752                     exit(EXIT_SUCCESS);
753                 break;
754             default:
755                 DEBUG("Unhandled event type %d\n", type);
756                 break;
757         }
758         free(event);
759     }
760 }
761
762 int main(int argc, char *argv[]) {
763     struct passwd *pw;
764     char *username;
765     char *image_path = NULL;
766     int ret;
767     struct pam_conv conv = {conv_callback, NULL};
768     int curs_choice = CURS_NONE;
769     int o;
770     int optind = 0;
771     struct option longopts[] = {
772         {"version", no_argument, NULL, 'v'},
773         {"nofork", no_argument, NULL, 'n'},
774         {"beep", no_argument, NULL, 'b'},
775         {"dpms", no_argument, NULL, 'd'},
776         {"color", required_argument, NULL, 'c'},
777         {"pointer", required_argument, NULL, 'p'},
778         {"debug", no_argument, NULL, 0},
779         {"help", no_argument, NULL, 'h'},
780         {"no-unlock-indicator", no_argument, NULL, 'u'},
781         {"image", required_argument, NULL, 'i'},
782         {"tiling", no_argument, NULL, 't'},
783         {"ignore-empty-password", no_argument, NULL, 'e'},
784         {"inactivity-timeout", required_argument, NULL, 'I'},
785         {"show-failed-attempts", no_argument, NULL, 'f'},
786         {NULL, no_argument, NULL, 0}};
787
788     if ((pw = getpwuid(getuid())) == NULL)
789         err(EXIT_FAILURE, "getpwuid() failed");
790     if ((username = pw->pw_name) == NULL)
791         errx(EXIT_FAILURE, "pw->pw_name is NULL.\n");
792
793     char *optstring = "hvnbdc:p:ui:teI:f";
794     while ((o = getopt_long(argc, argv, optstring, longopts, &optind)) != -1) {
795         switch (o) {
796             case 'v':
797                 errx(EXIT_SUCCESS, "version " VERSION " © 2010 Michael Stapelberg");
798             case 'n':
799                 dont_fork = true;
800                 break;
801             case 'b':
802                 beep = true;
803                 break;
804             case 'd':
805                 fprintf(stderr, "DPMS support has been removed from i3lock. Please see the manpage i3lock(1).\n");
806                 break;
807             case 'I': {
808                 fprintf(stderr, "Inactivity timeout only makes sense with DPMS, which was removed. Please see the manpage i3lock(1).\n");
809                 break;
810             }
811             case 'c': {
812                 char *arg = optarg;
813
814                 /* Skip # if present */
815                 if (arg[0] == '#')
816                     arg++;
817
818                 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
819                     errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
820
821                 break;
822             }
823             case 'u':
824                 unlock_indicator = false;
825                 break;
826             case 'i':
827                 image_path = strdup(optarg);
828                 break;
829             case 't':
830                 tile = true;
831                 break;
832             case 'p':
833                 if (!strcmp(optarg, "win")) {
834                     curs_choice = CURS_WIN;
835                 } else if (!strcmp(optarg, "default")) {
836                     curs_choice = CURS_DEFAULT;
837                 } else {
838                     errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
839                 }
840                 break;
841             case 'e':
842                 ignore_empty_password = true;
843                 break;
844             case 0:
845                 if (strcmp(longopts[optind].name, "debug") == 0)
846                     debug_mode = true;
847                 break;
848             case 'f':
849                 show_failed_attempts = true;
850                 break;
851             default:
852                 errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
853                                    " [-i image.png] [-t] [-e] [-I timeout] [-f]");
854         }
855     }
856
857     /* We need (relatively) random numbers for highlighting a random part of
858      * the unlock indicator upon keypresses. */
859     srand(time(NULL));
860
861     /* Initialize PAM */
862     if ((ret = pam_start("i3lock", username, &conv, &pam_handle)) != PAM_SUCCESS)
863         errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
864
865     if ((ret = pam_set_item(pam_handle, PAM_TTY, getenv("DISPLAY"))) != PAM_SUCCESS)
866         errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
867
868 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
869  * operating systems should use encrypted swap/no swap (or remove the ifdef and
870  * run i3lock as super-user). */
871 #if defined(__linux__)
872     /* Lock the area where we store the password in memory, we don’t want it to
873      * be swapped to disk. Since Linux 2.6.9, this does not require any
874      * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
875     if (mlock(password, sizeof(password)) != 0)
876         err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
877 #endif
878
879     /* Double checking that connection is good and operatable with xcb */
880     int screennr;
881     if ((conn = xcb_connect(NULL, &screennr)) == NULL ||
882         xcb_connection_has_error(conn))
883         errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
884
885     if (xkb_x11_setup_xkb_extension(conn,
886                                     XKB_X11_MIN_MAJOR_XKB_VERSION,
887                                     XKB_X11_MIN_MINOR_XKB_VERSION,
888                                     0,
889                                     NULL,
890                                     NULL,
891                                     &xkb_base_event,
892                                     &xkb_base_error) != 1)
893         errx(EXIT_FAILURE, "Could not setup XKB extension.");
894
895     static const xcb_xkb_map_part_t required_map_parts =
896         (XCB_XKB_MAP_PART_KEY_TYPES |
897          XCB_XKB_MAP_PART_KEY_SYMS |
898          XCB_XKB_MAP_PART_MODIFIER_MAP |
899          XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
900          XCB_XKB_MAP_PART_KEY_ACTIONS |
901          XCB_XKB_MAP_PART_VIRTUAL_MODS |
902          XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
903
904     static const xcb_xkb_event_type_t required_events =
905         (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY |
906          XCB_XKB_EVENT_TYPE_MAP_NOTIFY |
907          XCB_XKB_EVENT_TYPE_STATE_NOTIFY);
908
909     xcb_xkb_select_events(
910         conn,
911         xkb_x11_get_core_keyboard_device_id(conn),
912         required_events,
913         0,
914         required_events,
915         required_map_parts,
916         required_map_parts,
917         0);
918
919     /* When we cannot initially load the keymap, we better exit */
920     if (!load_keymap())
921         errx(EXIT_FAILURE, "Could not load keymap");
922
923     const char *locale = getenv("LC_ALL");
924     if (!locale)
925         locale = getenv("LC_CTYPE");
926     if (!locale)
927         locale = getenv("LANG");
928     if (!locale) {
929         if (debug_mode)
930             fprintf(stderr, "Can't detect your locale, fallback to C\n");
931         locale = "C";
932     }
933
934     load_compose_table(locale);
935
936     xinerama_init();
937     xinerama_query_screens();
938
939     screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
940
941     last_resolution[0] = screen->width_in_pixels;
942     last_resolution[1] = screen->height_in_pixels;
943
944     xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
945                                  (uint32_t[]){XCB_EVENT_MASK_STRUCTURE_NOTIFY});
946
947     if (image_path) {
948         /* Create a pixmap to render on, fill it with the background color */
949         img = cairo_image_surface_create_from_png(image_path);
950         /* In case loading failed, we just pretend no -i was specified. */
951         if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
952             fprintf(stderr, "Could not load image \"%s\": %s\n",
953                     image_path, cairo_status_to_string(cairo_surface_status(img)));
954             img = NULL;
955         }
956     }
957
958     /* Pixmap on which the image is rendered to (if any) */
959     xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
960
961     /* open the fullscreen window, already with the correct pixmap in place */
962     win = open_fullscreen_window(conn, screen, color, bg_pixmap);
963     xcb_free_pixmap(conn, bg_pixmap);
964
965     pid_t pid = fork();
966     /* The pid == -1 case is intentionally ignored here:
967      * While the child process is useful for preventing other windows from
968      * popping up while i3lock blocks, it is not critical. */
969     if (pid == 0) {
970         /* Child */
971         close(xcb_get_file_descriptor(conn));
972         maybe_close_sleep_lock_fd();
973         raise_loop(win);
974         exit(EXIT_SUCCESS);
975     }
976
977     cursor = create_cursor(conn, screen, win, curs_choice);
978
979     grab_pointer_and_keyboard(conn, screen, cursor);
980     /* Load the keymap again to sync the current modifier state. Since we first
981      * loaded the keymap, there might have been changes, but starting from now,
982      * we should get all key presses/releases due to having grabbed the
983      * keyboard. */
984     (void)load_keymap();
985
986     /* Initialize the libev event loop. */
987     main_loop = EV_DEFAULT;
988     if (main_loop == NULL)
989         errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
990
991     struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
992     struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
993     struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
994
995     ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
996     ev_io_start(main_loop, xcb_watcher);
997
998     ev_check_init(xcb_check, xcb_check_cb);
999     ev_check_start(main_loop, xcb_check);
1000
1001     ev_prepare_init(xcb_prepare, xcb_prepare_cb);
1002     ev_prepare_start(main_loop, xcb_prepare);
1003
1004     /* Invoke the event callback once to catch all the events which were
1005      * received up until now. ev will only pick up new events (when the X11
1006      * file descriptor becomes readable). */
1007     ev_invoke(main_loop, xcb_check, 0);
1008     ev_loop(main_loop, 0);
1009 }