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