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