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