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