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