git.sur5r.net Git - i3/i3lock/blob - i3lock.c

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