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 <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 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
 262     redraw_screen();
 263     STOP_TIMER(w);
 264 }
 265
 266 static bool skip_without_validation(void) {
 267     if (input_position != 0)
 268         return false;
 269
 270     if (skip_repeated_empty_password || ignore_empty_password)
 271         return true;
 272
 273     return false;
 274 }
 275
 276 /*
 277  * Handle key presses. Fixes state, then looks up the key symbol for the
 278  * given keycode, then looks up the key symbol (as UCS-2), converts it to
 279  * UTF-8 and stores it in the password array.
 280  *
 281  */
 282 static void handle_key_press(xcb_key_press_event_t *event) {
 283     xkb_keysym_t ksym;
 284     char buffer[128];
 285     int n;
 286     bool ctrl;
 287
 288     ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
 289     ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
 290
 291     /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
 292     memset(buffer, '\0', sizeof(buffer));
 293     n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
 294
 295     switch (ksym) {
 296     case XKB_KEY_Return:
 297     case XKB_KEY_KP_Enter:
 298     case XKB_KEY_XF86ScreenSaver:
 299         if (skip_without_validation()) {
 300             clear_input();
 301             return;
 302         }
 303         password[input_position] = '\0';
 304         unlock_state = STATE_KEY_PRESSED;
 305         redraw_screen();
 306         input_done();
 307         skip_repeated_empty_password = true;
 308         return;
 309     default:
 310         skip_repeated_empty_password = false;
 311     }
 312
 313     switch (ksym) {
 314     case XKB_KEY_u:
 315         if (ctrl) {
 316             DEBUG("C-u pressed\n");
 317             clear_input();
 318             return;
 319         }
 320         break;
 321
 322     case XKB_KEY_Escape:
 323         clear_input();
 324         return;
 325
 326     case XKB_KEY_BackSpace:
 327         if (input_position == 0)
 328             return;
 329
 330         /* decrement input_position to point to the previous glyph */
 331         u8_dec(password, &input_position);
 332         password[input_position] = '\0';
 333
 334         /* Hide the unlock indicator after a bit if the password buffer is
 335          * empty. */
 336         START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
 337         unlock_state = STATE_BACKSPACE_ACTIVE;
 338         redraw_screen();
 339         unlock_state = STATE_KEY_PRESSED;
 340         return;
 341     }
 342
 343     if ((input_position + 8) >= sizeof(password))
 344         return;
 345
 346 #if 0
 347     /* FIXME: handle all of these? */
 348     printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
 349     printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
 350     printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
 351     printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
 352     printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
 353     printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
 354     printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
 355 #endif
 356
 357     if (n < 2)
 358         return;
 359
 360     /* store it in the password array as UTF-8 */
 361     memcpy(password+input_position, buffer, n-1);
 362     input_position += n-1;
 363     DEBUG("current password = %.*s\n", input_position, password);
 364
 365     unlock_state = STATE_KEY_ACTIVE;
 366     redraw_screen();
 367     unlock_state = STATE_KEY_PRESSED;
 368
 369     struct ev_timer *timeout = NULL;
 370     START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout);
 371     STOP_TIMER(clear_indicator_timeout);
 372     START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
 373 }
 374
 375 /*
 376  * A visibility notify event will be received when the visibility (= can the
 377  * user view the complete window) changes, so for example when a popup overlays
 378  * some area of the i3lock window.
 379  *
 380  * In this case, we raise our window on top so that the popup (or whatever is
 381  * hiding us) gets hidden.
 382  *
 383  */
 384 static void handle_visibility_notify(xcb_connection_t *conn,
 385     xcb_visibility_notify_event_t *event) {
 386     if (event->state != XCB_VISIBILITY_UNOBSCURED) {
 387         uint32_t values[] = { XCB_STACK_MODE_ABOVE };
 388         xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
 389         xcb_flush(conn);
 390     }
 391 }
 392
 393 /*
 394  * Called when the keyboard mapping changes. We update our symbols.
 395  *
 396  * We ignore errors — if the new keymap cannot be loaded it’s better if the
 397  * screen stays locked and the user intervenes by using killall i3lock.
 398  *
 399  */
 400 static void process_xkb_event(xcb_generic_event_t *gevent) {
 401     union xkb_event {
 402         struct {
 403             uint8_t response_type;
 404             uint8_t xkbType;
 405             uint16_t sequence;
 406             xcb_timestamp_t time;
 407             uint8_t deviceID;
 408         } any;
 409         xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify;
 410         xcb_xkb_map_notify_event_t map_notify;
 411         xcb_xkb_state_notify_event_t state_notify;
 412     } *event = (union xkb_event*)gevent;
 413
 414     DEBUG("process_xkb_event for device %d\n", event->any.deviceID);
 415
 416     if (event->any.deviceID != xkb_x11_get_core_keyboard_device_id(conn))
 417         return;
 418
 419     /*
 420      * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap
 421      * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent
 422      * recompilations.
 423      */
 424     switch (event->any.xkbType) {
 425         case XCB_XKB_NEW_KEYBOARD_NOTIFY:
 426             if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES)
 427                 (void)load_keymap();
 428             break;
 429
 430         case XCB_XKB_MAP_NOTIFY:
 431             (void)load_keymap();
 432             break;
 433
 434         case XCB_XKB_STATE_NOTIFY:
 435             xkb_state_update_mask(xkb_state,
 436                                   event->state_notify.baseMods,
 437                                   event->state_notify.latchedMods,
 438                                   event->state_notify.lockedMods,
 439                                   event->state_notify.baseGroup,
 440                                   event->state_notify.latchedGroup,
 441                                   event->state_notify.lockedGroup);
 442             break;
 443     }
 444 }
 445
 446 /*
 447  * Called when the properties on the root window change, e.g. when the screen
 448  * resolution changes. If so we update the window to cover the whole screen
 449  * and also redraw the image, if any.
 450  *
 451  */
 452 void handle_screen_resize(void) {
 453     xcb_get_geometry_cookie_t geomc;
 454     xcb_get_geometry_reply_t *geom;
 455     geomc = xcb_get_geometry(conn, screen->root);
 456     if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
 457         return;
 458
 459     if (last_resolution[0] == geom->width &&
 460         last_resolution[1] == geom->height) {
 461         free(geom);
 462         return;
 463     }
 464
 465     last_resolution[0] = geom->width;
 466     last_resolution[1] = geom->height;
 467
 468     free(geom);
 469
 470     redraw_screen();
 471
 472     uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
 473     xcb_configure_window(conn, win, mask, last_resolution);
 474     xcb_flush(conn);
 475
 476     xinerama_query_screens();
 477     redraw_screen();
 478 }
 479
 480 /*
 481  * Callback function for PAM. We only react on password request callbacks.
 482  *
 483  */
 484 static int conv_callback(int num_msg, const struct pam_message **msg,
 485                          struct pam_response **resp, void *appdata_ptr)
 486 {
 487     if (num_msg == 0)
 488         return 1;
 489
 490     /* PAM expects an array of responses, one for each message */
 491     if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
 492         perror("calloc");
 493         return 1;
 494     }
 495
 496     for (int c = 0; c < num_msg; c++) {
 497         if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
 498             msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
 499             continue;
 500
 501         /* return code is currently not used but should be set to zero */
 502         resp[c]->resp_retcode = 0;
 503         if ((resp[c]->resp = strdup(password)) == NULL) {
 504             perror("strdup");
 505             return 1;
 506         }
 507     }
 508
 509     return 0;
 510 }
 511
 512 /*
 513  * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
 514  * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
 515  *
 516  */
 517 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
 518     /* empty, because xcb_prepare_cb and xcb_check_cb are used */
 519 }
 520
 521 /*
 522  * Flush before blocking (and waiting for new events)
 523  *
 524  */
 525 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
 526     xcb_flush(conn);
 527 }
 528
 529 /*
 530  * Instead of polling the X connection socket we leave this to
 531  * xcb_poll_for_event() which knows better than we can ever know.
 532  *
 533  */
 534 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
 535     xcb_generic_event_t *event;
 536
 537     if (xcb_connection_has_error(conn))
 538         errx(EXIT_FAILURE, "X11 connection broke, did your server terminate?\n");
 539
 540     while ((event = xcb_poll_for_event(conn)) != NULL) {
 541         if (event->response_type == 0) {
 542             xcb_generic_error_t *error = (xcb_generic_error_t*)event;
 543             if (debug_mode)
 544                 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
 545                         error->sequence, error->error_code);
 546             free(event);
 547             continue;
 548         }
 549
 550         /* Strip off the highest bit (set if the event is generated) */
 551         int type = (event->response_type & 0x7F);
 552
 553         switch (type) {
 554             case XCB_KEY_PRESS:
 555                 handle_key_press((xcb_key_press_event_t*)event);
 556                 break;
 557
 558             case XCB_KEY_RELEASE:
 559                 /* If this was the backspace or escape key we are back at an
 560                  * empty input, so turn off the screen if DPMS is enabled, but
 561                  * only do that after some timeout: maybe user mistyped and
 562                  * will type again right away */
 563                 START_TIMER(dpms_timeout, TSTAMP_N_SECS(inactivity_timeout),
 564                             turn_off_monitors_cb);
 565                 break;
 566
 567             case XCB_VISIBILITY_NOTIFY:
 568                 handle_visibility_notify(conn, (xcb_visibility_notify_event_t*)event);
 569                 break;
 570
 571             case XCB_MAP_NOTIFY:
 572                 if (!dont_fork) {
 573                     /* After the first MapNotify, we never fork again. We don’t
 574                      * expect to get another MapNotify, but better be sure… */
 575                     dont_fork = true;
 576
 577                     /* In the parent process, we exit */
 578                     if (fork() != 0)
 579                         exit(0);
 580
 581                     ev_loop_fork(EV_DEFAULT);
 582                 }
 583                 break;
 584
 585             case XCB_CONFIGURE_NOTIFY:
 586                 handle_screen_resize();
 587                 break;
 588
 589             default:
 590                 if (type == xkb_base_event)
 591                     process_xkb_event(event);
 592         }
 593
 594         free(event);
 595     }
 596 }
 597
 598 /*
 599  * This function is called from a fork()ed child and will raise the i3lock
 600  * window when the window is obscured, even when the main i3lock process is
 601  * blocked due to PAM.
 602  *
 603  */
 604 static void raise_loop(xcb_window_t window) {
 605     xcb_connection_t *conn;
 606     xcb_generic_event_t *event;
 607     int screens;
 608
 609     if ((conn = xcb_connect(NULL, &screens)) == NULL ||
 610         xcb_connection_has_error(conn))
 611         errx(EXIT_FAILURE, "Cannot open display\n");
 612
 613     /* We need to know about the window being obscured or getting destroyed. */
 614     xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK,
 615         (uint32_t[]){
 616             XCB_EVENT_MASK_VISIBILITY_CHANGE |
 617             XCB_EVENT_MASK_STRUCTURE_NOTIFY
 618         });
 619     xcb_flush(conn);
 620
 621     DEBUG("Watching window 0x%08x\n", window);
 622     while ((event = xcb_wait_for_event(conn)) != NULL) {
 623         if (event->response_type == 0) {
 624             xcb_generic_error_t *error = (xcb_generic_error_t*)event;
 625             DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n",
 626                  error->sequence, error->error_code);
 627             free(event);
 628             continue;
 629         }
 630         /* Strip off the highest bit (set if the event is generated) */
 631         int type = (event->response_type & 0x7F);
 632         DEBUG("Read event of type %d\n", type);
 633         switch (type) {
 634             case XCB_VISIBILITY_NOTIFY:
 635                 handle_visibility_notify(conn, (xcb_visibility_notify_event_t*)event);
 636                 break;
 637             case XCB_UNMAP_NOTIFY:
 638                 DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t*)event)->window));
 639                 if (((xcb_unmap_notify_event_t*)event)->window == window)
 640                     exit(EXIT_SUCCESS);
 641                 break;
 642             case XCB_DESTROY_NOTIFY:
 643                 DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t*)event)->window));
 644                 if (((xcb_destroy_notify_event_t*)event)->window == window)
 645                     exit(EXIT_SUCCESS);
 646                 break;
 647             default:
 648                 DEBUG("Unhandled event type %d\n", type);
 649                 break;
 650         }
 651         free(event);
 652     }
 653 }
 654
 655 int main(int argc, char *argv[]) {
 656     char *username;
 657     char *image_path = NULL;
 658     int ret;
 659     struct pam_conv conv = {conv_callback, NULL};
 660     int curs_choice = CURS_NONE;
 661     int o;
 662     int optind = 0;
 663     struct option longopts[] = {
 664         {"version", no_argument, NULL, 'v'},
 665         {"nofork", no_argument, NULL, 'n'},
 666         {"beep", no_argument, NULL, 'b'},
 667         {"dpms", no_argument, NULL, 'd'},
 668         {"color", required_argument, NULL, 'c'},
 669         {"pointer", required_argument, NULL , 'p'},
 670         {"debug", no_argument, NULL, 0},
 671         {"help", no_argument, NULL, 'h'},
 672         {"no-unlock-indicator", no_argument, NULL, 'u'},
 673         {"image", required_argument, NULL, 'i'},
 674         {"tiling", no_argument, NULL, 't'},
 675         {"ignore-empty-password", no_argument, NULL, 'e'},
 676         {"inactivity-timeout", required_argument, NULL, 'I'},
 677         {NULL, no_argument, NULL, 0}
 678     };
 679
 680     if ((username = getenv("USER")) == NULL)
 681         errx(EXIT_FAILURE, "USER environment variable not set, please set it.\n");
 682
 683     char *optstring = "hvnbdc:p:ui:teI:";
 684     while ((o = getopt_long(argc, argv, optstring, longopts, &optind)) != -1) {
 685         switch (o) {
 686         case 'v':
 687             errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
 688         case 'n':
 689             dont_fork = true;
 690             break;
 691         case 'b':
 692             beep = true;
 693             break;
 694         case 'd':
 695             dpms = true;
 696             break;
 697         case 'I': {
 698             int time = 0;
 699             if (sscanf(optarg, "%d", &time) != 1 || time < 0)
 700                 errx(EXIT_FAILURE, "invalid timeout, it must be a positive integer\n");
 701             inactivity_timeout = time;
 702             break;
 703         }
 704         case 'c': {
 705             char *arg = optarg;
 706
 707             /* Skip # if present */
 708             if (arg[0] == '#')
 709                 arg++;
 710
 711             if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
 712                 errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
 713
 714             break;
 715         }
 716         case 'u':
 717             unlock_indicator = false;
 718             break;
 719         case 'i':
 720             image_path = strdup(optarg);
 721             break;
 722         case 't':
 723             tile = true;
 724             break;
 725         case 'p':
 726             if (!strcmp(optarg, "win")) {
 727                 curs_choice = CURS_WIN;
 728             } else if (!strcmp(optarg, "default")) {
 729                 curs_choice = CURS_DEFAULT;
 730             } else {
 731                 errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
 732             }
 733             break;
 734         case 'e':
 735             ignore_empty_password = true;
 736             break;
 737         case 0:
 738             if (strcmp(longopts[optind].name, "debug") == 0)
 739                 debug_mode = true;
 740             break;
 741         default:
 742             errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
 743             " [-i image.png] [-t] [-e] [-I]"
 744             );
 745         }
 746     }
 747
 748     /* We need (relatively) random numbers for highlighting a random part of
 749      * the unlock indicator upon keypresses. */
 750     srand(time(NULL));
 751
 752     /* Initialize PAM */
 753     ret = pam_start("i3lock", username, &conv, &pam_handle);
 754     if (ret != PAM_SUCCESS)
 755         errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
 756
 757 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
 758  * operating systems should use encrypted swap/no swap (or remove the ifdef and
 759  * run i3lock as super-user). */
 760 #if defined(__linux__)
 761     /* Lock the area where we store the password in memory, we don’t want it to
 762      * be swapped to disk. Since Linux 2.6.9, this does not require any
 763      * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
 764     if (mlock(password, sizeof(password)) != 0)
 765         err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
 766 #endif
 767
 768     /* Double checking that connection is good and operatable with xcb */
 769     int screennr;
 770     if ((conn = xcb_connect(NULL, &screennr)) == NULL ||
 771         xcb_connection_has_error(conn))
 772         errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
 773
 774     if (xkb_x11_setup_xkb_extension(conn,
 775             XKB_X11_MIN_MAJOR_XKB_VERSION,
 776             XKB_X11_MIN_MINOR_XKB_VERSION,
 777             0,
 778             NULL,
 779             NULL,
 780             &xkb_base_event,
 781             &xkb_base_error) != 1)
 782         errx(EXIT_FAILURE, "Could not setup XKB extension.");
 783
 784     static const xcb_xkb_map_part_t required_map_parts =
 785         (XCB_XKB_MAP_PART_KEY_TYPES |
 786          XCB_XKB_MAP_PART_KEY_SYMS |
 787          XCB_XKB_MAP_PART_MODIFIER_MAP |
 788          XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
 789          XCB_XKB_MAP_PART_KEY_ACTIONS |
 790          XCB_XKB_MAP_PART_VIRTUAL_MODS |
 791          XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
 792
 793     static const xcb_xkb_event_type_t required_events =
 794         (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY |
 795          XCB_XKB_EVENT_TYPE_MAP_NOTIFY |
 796          XCB_XKB_EVENT_TYPE_STATE_NOTIFY);
 797
 798     xcb_xkb_select_events(
 799         conn,
 800         xkb_x11_get_core_keyboard_device_id(conn),
 801         required_events,
 802         0,
 803         required_events,
 804         required_map_parts,
 805         required_map_parts,
 806         0);
 807
 808     /* When we cannot initially load the keymap, we better exit */
 809     if (!load_keymap())
 810         errx(EXIT_FAILURE, "Could not load keymap");
 811
 812     xinerama_init();
 813     xinerama_query_screens();
 814
 815     /* if DPMS is enabled, check if the X server really supports it */
 816     if (dpms) {
 817         xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
 818         xcb_dpms_capable_reply_t *dpmsr;
 819         if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
 820             if (!dpmsr->capable) {
 821                 if (debug_mode)
 822                     fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
 823                 dpms = false;
 824             }
 825             free(dpmsr);
 826         }
 827     }
 828
 829     screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
 830
 831     last_resolution[0] = screen->width_in_pixels;
 832     last_resolution[1] = screen->height_in_pixels;
 833
 834     xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
 835             (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
 836
 837     if (image_path) {
 838         /* Create a pixmap to render on, fill it with the background color */
 839         img = cairo_image_surface_create_from_png(image_path);
 840         /* In case loading failed, we just pretend no -i was specified. */
 841         if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
 842             fprintf(stderr, "Could not load image \"%s\": %s\n",
 843                     image_path, cairo_status_to_string(cairo_surface_status(img)));
 844             img = NULL;
 845         }
 846     }
 847
 848     /* Pixmap on which the image is rendered to (if any) */
 849     xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
 850
 851     /* open the fullscreen window, already with the correct pixmap in place */
 852     win = open_fullscreen_window(conn, screen, color, bg_pixmap);
 853     xcb_free_pixmap(conn, bg_pixmap);
 854
 855     pid_t pid = fork();
 856     /* The pid == -1 case is intentionally ignored here:
 857      * While the child process is useful for preventing other windows from
 858      * popping up while i3lock blocks, it is not critical. */
 859     if (pid == 0) {
 860         /* Child */
 861         close(xcb_get_file_descriptor(conn));
 862         raise_loop(win);
 863         exit(EXIT_SUCCESS);
 864     }
 865
 866     cursor = create_cursor(conn, screen, win, curs_choice);
 867
 868     grab_pointer_and_keyboard(conn, screen, cursor);
 869     /* Load the keymap again to sync the current modifier state. Since we first
 870      * loaded the keymap, there might have been changes, but starting from now,
 871      * we should get all key presses/releases due to having grabbed the
 872      * keyboard. */
 873     (void)load_keymap();
 874
 875     turn_monitors_off();
 876
 877     /* Initialize the libev event loop. */
 878     main_loop = EV_DEFAULT;
 879     if (main_loop == NULL)
 880         errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
 881
 882     struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
 883     struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
 884     struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
 885
 886     ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
 887     ev_io_start(main_loop, xcb_watcher);
 888
 889     ev_check_init(xcb_check, xcb_check_cb);
 890     ev_check_start(main_loop, xcb_check);
 891
 892     ev_prepare_init(xcb_prepare, xcb_prepare_cb);
 893     ev_prepare_start(main_loop, xcb_prepare);
 894
 895     /* Invoke the event callback once to catch all the events which were
 896      * received up until now. ev will only pick up new events (when the X11
 897      * file descriptor becomes readable). */
 898     ev_invoke(main_loop, xcb_check, 0);
 899     ev_loop(main_loop, 0);
 900 }