2 * vim:ts=4:sw=4:expandtab
4 * © 2010-2013 Michael Stapelberg
6 * See LICENSE for licensing information
19 #include <security/pam_appl.h>
24 #include <xkbcommon/xkbcommon.h>
25 #include <xkbcommon/xkbcommon-x11.h>
27 #include <cairo/cairo-xcb.h>
32 #include "unlock_indicator.h"
35 #define TSTAMP_N_SECS(n) (n * 1.0)
36 #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n))
37 #define START_TIMER(timer_obj, timeout, callback) \
38 timer_obj = start_timer(timer_obj, timeout, callback)
39 #define STOP_TIMER(timer_obj) \
40 timer_obj = stop_timer(timer_obj)
42 typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents);
44 /* We need this for libxkbfile */
45 char color[7] = "ffffff";
46 int inactivity_timeout = 30;
47 uint32_t last_resolution[2];
49 static xcb_cursor_t cursor;
50 static pam_handle_t *pam_handle;
51 int input_position = 0;
52 /* Holds the password you enter (in UTF-8). */
53 static char password[512];
54 static bool beep = false;
55 bool debug_mode = false;
56 static bool dpms = false;
57 bool unlock_indicator = true;
58 static bool dont_fork = false;
59 struct ev_loop *main_loop;
60 static struct ev_timer *clear_pam_wrong_timeout;
61 static struct ev_timer *clear_indicator_timeout;
62 static struct ev_timer *dpms_timeout;
63 static struct ev_timer *discard_passwd_timeout;
64 extern unlock_state_t unlock_state;
65 extern pam_state_t pam_state;
67 static struct xkb_state *xkb_state;
68 static struct xkb_context *xkb_context;
69 static struct xkb_keymap *xkb_keymap;
70 static uint8_t xkb_base_event;
71 static uint8_t xkb_base_error;
73 cairo_surface_t *img = NULL;
75 bool ignore_empty_password = false;
76 bool skip_repeated_empty_password = false;
78 /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
79 #define isutf(c) (((c) & 0xC0) != 0x80)
82 * Decrements i to point to the previous unicode glyph
85 void u8_dec(char *s, int *i) {
86 (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
89 static void turn_monitors_on(void) {
91 dpms_set_mode(conn, XCB_DPMS_DPMS_MODE_ON);
94 static void turn_monitors_off(void) {
96 dpms_set_mode(conn, XCB_DPMS_DPMS_MODE_OFF);
100 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
101 * Necessary so that we can properly let xkbcommon track the keyboard state and
102 * translate keypresses to utf-8.
105 static bool load_keymap(void) {
106 if (xkb_context == NULL) {
107 if ((xkb_context = xkb_context_new(0)) == NULL) {
108 fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
113 xkb_keymap_unref(xkb_keymap);
115 int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn);
116 DEBUG("device = %d\n", device_id);
117 if ((xkb_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
118 fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n");
122 struct xkb_state *new_state =
123 xkb_x11_state_new_from_device(xkb_keymap, conn, device_id);
124 if (new_state == NULL) {
125 fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n");
129 xkb_state_unref(xkb_state);
130 xkb_state = new_state;
136 * Clears the memory which stored the password to be a bit safer against
140 static void clear_password_memory(void) {
141 /* A volatile pointer to the password buffer to prevent the compiler from
142 * optimizing this out. */
143 volatile char *vpassword = password;
144 for (int c = 0; c < sizeof(password); c++)
145 /* We store a non-random pattern which consists of the (irrelevant)
146 * index plus (!) the value of the beep variable. This prevents the
147 * compiler from optimizing the calls away, since the value of 'beep'
148 * is not known at compile-time. */
149 vpassword[c] = c + (int)beep;
152 ev_timer* start_timer(ev_timer *timer_obj, ev_tstamp timeout, ev_callback_t callback) {
154 ev_timer_stop(main_loop, timer_obj);
155 ev_timer_set(timer_obj, timeout, 0.);
156 ev_timer_start(main_loop, timer_obj);
158 /* When there is no memory, we just don’t have a timeout. We cannot
159 * exit() here, since that would effectively unlock the screen. */
160 timer_obj = calloc(sizeof(struct ev_timer), 1);
162 ev_timer_init(timer_obj, callback, timeout, 0.);
163 ev_timer_start(main_loop, timer_obj);
169 ev_timer* stop_timer(ev_timer *timer_obj) {
171 ev_timer_stop(main_loop, timer_obj);
178 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccessful
179 * authentication event.
182 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
183 DEBUG("clearing pam wrong\n");
184 pam_state = STATE_PAM_IDLE;
185 unlock_state = STATE_STARTED;
188 /* Now free this timeout. */
189 STOP_TIMER(clear_pam_wrong_timeout);
192 static void clear_indicator_cb(EV_P_ ev_timer *w, int revents) {
194 STOP_TIMER(clear_indicator_timeout);
197 static void clear_input(void) {
199 clear_password_memory();
200 password[input_position] = '\0';
202 /* Hide the unlock indicator after a bit if the password buffer is
204 START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
205 unlock_state = STATE_BACKSPACE_ACTIVE;
207 unlock_state = STATE_KEY_PRESSED;
210 static void turn_off_monitors_cb(EV_P_ ev_timer *w, int revents) {
211 if (input_position == 0)
214 STOP_TIMER(dpms_timeout);
217 static void discard_passwd_cb(EV_P_ ev_timer *w, int revents) {
220 STOP_TIMER(discard_passwd_timeout);
223 static void input_done(void) {
224 STOP_TIMER(clear_pam_wrong_timeout);
225 pam_state = STATE_PAM_VERIFY;
228 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
229 DEBUG("successfully authenticated\n");
230 clear_password_memory();
231 /* Turn the screen on, as it may have been turned off
232 * on release of the 'enter' key. */
238 fprintf(stderr, "Authentication failure\n");
240 pam_state = STATE_PAM_WRONG;
244 /* Clear this state after 2 seconds (unless the user enters another
245 * password during that time). */
246 ev_now_update(main_loop);
247 START_TIMER(clear_pam_wrong_timeout, TSTAMP_N_SECS(2), clear_pam_wrong);
249 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
251 STOP_TIMER(clear_indicator_timeout);
253 /* beep on authentication failure, if enabled */
261 * Called when the user releases a key. We need to leave the Mode_switch
262 * state when the user releases the Mode_switch key.
265 static void handle_key_release(xcb_key_release_event_t *event) {
266 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP);
269 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
274 static bool skip_without_validation(void) {
275 if (input_position != 0)
278 if (skip_repeated_empty_password || ignore_empty_password)
285 * Handle key presses. Fixes state, then looks up the key symbol for the
286 * given keycode, then looks up the key symbol (as UCS-2), converts it to
287 * UTF-8 and stores it in the password array.
290 static void handle_key_press(xcb_key_press_event_t *event) {
296 ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
297 ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
298 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN);
300 /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
301 memset(buffer, '\0', sizeof(buffer));
302 n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
306 case XKB_KEY_KP_Enter:
307 case XKB_KEY_XF86ScreenSaver:
308 if (skip_without_validation()) {
312 password[input_position] = '\0';
313 unlock_state = STATE_KEY_PRESSED;
316 skip_repeated_empty_password = true;
319 skip_repeated_empty_password = false;
325 DEBUG("C-u pressed\n");
335 case XKB_KEY_BackSpace:
336 if (input_position == 0)
339 /* decrement input_position to point to the previous glyph */
340 u8_dec(password, &input_position);
341 password[input_position] = '\0';
343 /* Hide the unlock indicator after a bit if the password buffer is
345 START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
346 unlock_state = STATE_BACKSPACE_ACTIVE;
348 unlock_state = STATE_KEY_PRESSED;
352 if ((input_position + 8) >= sizeof(password))
356 /* FIXME: handle all of these? */
357 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
358 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
359 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
360 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
361 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
362 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
363 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
369 /* store it in the password array as UTF-8 */
370 memcpy(password+input_position, buffer, n-1);
371 input_position += n-1;
372 DEBUG("current password = %.*s\n", input_position, password);
374 unlock_state = STATE_KEY_ACTIVE;
376 unlock_state = STATE_KEY_PRESSED;
378 struct ev_timer *timeout = NULL;
379 START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout);
380 STOP_TIMER(clear_indicator_timeout);
381 START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
385 * A visibility notify event will be received when the visibility (= can the
386 * user view the complete window) changes, so for example when a popup overlays
387 * some area of the i3lock window.
389 * In this case, we raise our window on top so that the popup (or whatever is
390 * hiding us) gets hidden.
393 static void handle_visibility_notify(xcb_connection_t *conn,
394 xcb_visibility_notify_event_t *event) {
395 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
396 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
397 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
403 * Called when the keyboard mapping changes. We update our symbols.
406 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
407 /* We ignore errors — if the new keymap cannot be loaded it’s better if the
408 * screen stays locked and the user intervenes by using killall i3lock. */
413 * Called when the properties on the root window change, e.g. when the screen
414 * resolution changes. If so we update the window to cover the whole screen
415 * and also redraw the image, if any.
418 void handle_screen_resize(void) {
419 xcb_get_geometry_cookie_t geomc;
420 xcb_get_geometry_reply_t *geom;
421 geomc = xcb_get_geometry(conn, screen->root);
422 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
425 if (last_resolution[0] == geom->width &&
426 last_resolution[1] == geom->height) {
431 last_resolution[0] = geom->width;
432 last_resolution[1] = geom->height;
438 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
439 xcb_configure_window(conn, win, mask, last_resolution);
442 xinerama_query_screens();
447 * Callback function for PAM. We only react on password request callbacks.
450 static int conv_callback(int num_msg, const struct pam_message **msg,
451 struct pam_response **resp, void *appdata_ptr)
456 /* PAM expects an array of responses, one for each message */
457 if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
462 for (int c = 0; c < num_msg; c++) {
463 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
464 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
467 /* return code is currently not used but should be set to zero */
468 resp[c]->resp_retcode = 0;
469 if ((resp[c]->resp = strdup(password)) == NULL) {
479 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
480 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
483 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
484 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
488 * Flush before blocking (and waiting for new events)
491 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
496 * Instead of polling the X connection socket we leave this to
497 * xcb_poll_for_event() which knows better than we can ever know.
500 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
501 xcb_generic_event_t *event;
503 while ((event = xcb_poll_for_event(conn)) != NULL) {
504 if (event->response_type == 0) {
505 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
507 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
508 error->sequence, error->error_code);
513 /* Strip off the highest bit (set if the event is generated) */
514 int type = (event->response_type & 0x7F);
517 handle_key_press((xcb_key_press_event_t*)event);
520 case XCB_KEY_RELEASE:
521 handle_key_release((xcb_key_release_event_t*)event);
523 /* If this was the backspace or escape key we are back at an
524 * empty input, so turn off the screen if DPMS is enabled, but
525 * only do that after some timeout: maybe user mistyped and
526 * will type again right away */
527 START_TIMER(dpms_timeout, TSTAMP_N_SECS(inactivity_timeout),
528 turn_off_monitors_cb);
531 case XCB_VISIBILITY_NOTIFY:
532 handle_visibility_notify(conn, (xcb_visibility_notify_event_t*)event);
537 /* After the first MapNotify, we never fork again. We don’t
538 * expect to get another MapNotify, but better be sure… */
541 /* In the parent process, we exit */
545 ev_loop_fork(EV_DEFAULT);
549 case XCB_MAPPING_NOTIFY:
550 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
553 case XCB_CONFIGURE_NOTIFY:
554 handle_screen_resize();
563 * This function is called from a fork()ed child and will raise the i3lock
564 * window when the window is obscured, even when the main i3lock process is
565 * blocked due to PAM.
568 static void raise_loop(xcb_window_t window) {
569 xcb_connection_t *conn;
570 xcb_generic_event_t *event;
573 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
574 xcb_connection_has_error(conn))
575 errx(EXIT_FAILURE, "Cannot open display\n");
577 /* We need to know about the window being obscured or getting destroyed. */
578 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK,
580 XCB_EVENT_MASK_VISIBILITY_CHANGE |
581 XCB_EVENT_MASK_STRUCTURE_NOTIFY
585 DEBUG("Watching window 0x%08x\n", window);
586 while ((event = xcb_wait_for_event(conn)) != NULL) {
587 if (event->response_type == 0) {
588 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
589 DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n",
590 error->sequence, error->error_code);
594 /* Strip off the highest bit (set if the event is generated) */
595 int type = (event->response_type & 0x7F);
596 DEBUG("Read event of type %d\n", type);
598 case XCB_VISIBILITY_NOTIFY:
599 handle_visibility_notify(conn, (xcb_visibility_notify_event_t*)event);
601 case XCB_UNMAP_NOTIFY:
602 DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t*)event)->window));
603 if (((xcb_unmap_notify_event_t*)event)->window == window)
606 case XCB_DESTROY_NOTIFY:
607 DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t*)event)->window));
608 if (((xcb_destroy_notify_event_t*)event)->window == window)
612 DEBUG("Unhandled event type %d\n", type);
619 int main(int argc, char *argv[]) {
621 char *image_path = NULL;
623 struct pam_conv conv = {conv_callback, NULL};
624 int curs_choice = CURS_NONE;
627 struct option longopts[] = {
628 {"version", no_argument, NULL, 'v'},
629 {"nofork", no_argument, NULL, 'n'},
630 {"beep", no_argument, NULL, 'b'},
631 {"dpms", no_argument, NULL, 'd'},
632 {"color", required_argument, NULL, 'c'},
633 {"pointer", required_argument, NULL , 'p'},
634 {"debug", no_argument, NULL, 0},
635 {"help", no_argument, NULL, 'h'},
636 {"no-unlock-indicator", no_argument, NULL, 'u'},
637 {"image", required_argument, NULL, 'i'},
638 {"tiling", no_argument, NULL, 't'},
639 {"ignore-empty-password", no_argument, NULL, 'e'},
640 {"inactivity-timeout", required_argument, NULL, 'I'},
641 {NULL, no_argument, NULL, 0}
644 if ((username = getenv("USER")) == NULL)
645 errx(EXIT_FAILURE, "USER environment variable not set, please set it.\n");
647 char *optstring = "hvnbdc:p:ui:teI:";
648 while ((o = getopt_long(argc, argv, optstring, longopts, &optind)) != -1) {
651 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
663 if (sscanf(optarg, "%d", &time) != 1 || time < 0)
664 errx(EXIT_FAILURE, "invalid timeout, it must be a positive integer\n");
665 inactivity_timeout = time;
671 /* Skip # if present */
675 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
676 errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
681 unlock_indicator = false;
684 image_path = strdup(optarg);
690 if (!strcmp(optarg, "win")) {
691 curs_choice = CURS_WIN;
692 } else if (!strcmp(optarg, "default")) {
693 curs_choice = CURS_DEFAULT;
695 errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
699 ignore_empty_password = true;
702 if (strcmp(longopts[optind].name, "debug") == 0)
706 errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
707 " [-i image.png] [-t] [-e] [-I]"
712 /* We need (relatively) random numbers for highlighting a random part of
713 * the unlock indicator upon keypresses. */
717 ret = pam_start("i3lock", username, &conv, &pam_handle);
718 if (ret != PAM_SUCCESS)
719 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
721 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
722 * operating systems should use encrypted swap/no swap (or remove the ifdef and
723 * run i3lock as super-user). */
724 #if defined(__linux__)
725 /* Lock the area where we store the password in memory, we don’t want it to
726 * be swapped to disk. Since Linux 2.6.9, this does not require any
727 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
728 if (mlock(password, sizeof(password)) != 0)
729 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
732 /* Double checking that connection is good and operatable with xcb */
734 if ((conn = xcb_connect(NULL, &screennr)) == NULL ||
735 xcb_connection_has_error(conn))
736 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
738 if (xkb_x11_setup_xkb_extension(conn,
739 XKB_X11_MIN_MAJOR_XKB_VERSION,
740 XKB_X11_MIN_MINOR_XKB_VERSION,
745 &xkb_base_error) != 1)
746 errx(EXIT_FAILURE, "Could not setup XKB extension.");
748 /* When we cannot initially load the keymap, we better exit */
750 errx(EXIT_FAILURE, "Could not load keymap");
753 xinerama_query_screens();
755 /* if DPMS is enabled, check if the X server really supports it */
757 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
758 xcb_dpms_capable_reply_t *dpmsr;
759 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
760 if (!dpmsr->capable) {
762 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
769 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
771 last_resolution[0] = screen->width_in_pixels;
772 last_resolution[1] = screen->height_in_pixels;
774 xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
775 (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
778 /* Create a pixmap to render on, fill it with the background color */
779 img = cairo_image_surface_create_from_png(image_path);
780 /* In case loading failed, we just pretend no -i was specified. */
781 if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
782 fprintf(stderr, "Could not load image \"%s\": %s\n",
783 image_path, cairo_status_to_string(cairo_surface_status(img)));
788 /* Pixmap on which the image is rendered to (if any) */
789 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
791 /* open the fullscreen window, already with the correct pixmap in place */
792 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
793 xcb_free_pixmap(conn, bg_pixmap);
796 /* The pid == -1 case is intentionally ignored here:
797 * While the child process is useful for preventing other windows from
798 * popping up while i3lock blocks, it is not critical. */
801 close(xcb_get_file_descriptor(conn));
806 cursor = create_cursor(conn, screen, win, curs_choice);
808 grab_pointer_and_keyboard(conn, screen, cursor);
809 /* Load the keymap again to sync the current modifier state. Since we first
810 * loaded the keymap, there might have been changes, but starting from now,
811 * we should get all key presses/releases due to having grabbed the
817 /* Initialize the libev event loop. */
818 main_loop = EV_DEFAULT;
819 if (main_loop == NULL)
820 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
822 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
823 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
824 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
826 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
827 ev_io_start(main_loop, xcb_watcher);
829 ev_check_init(xcb_check, xcb_check_cb);
830 ev_check_start(main_loop, xcb_check);
832 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
833 ev_prepare_start(main_loop, xcb_prepare);
835 /* Invoke the event callback once to catch all the events which were
836 * received up until now. ev will only pick up new events (when the X11
837 * file descriptor becomes readable). */
838 ev_invoke(main_loop, xcb_check, 0);
839 ev_loop(main_loop, 0);