2 * vim:ts=4:sw=4:expandtab
4 * © 2010-2013 Michael Stapelberg
6 * See LICENSE for licensing information
19 #include <security/pam_appl.h>
20 #include <X11/Xlib-xcb.h>
25 #include <X11/XKBlib.h>
26 #include <X11/extensions/XKBfile.h>
27 #include <xkbcommon/xkbcommon.h>
29 #include <cairo/cairo-xcb.h>
34 #include "unlock_indicator.h"
37 /* We need this for libxkbfile */
38 static Display *display;
39 char color[7] = "ffffff";
40 uint32_t last_resolution[2];
42 static xcb_cursor_t cursor;
43 static pam_handle_t *pam_handle;
44 int input_position = 0;
45 /* Holds the password you enter (in UTF-8). */
46 static char password[512];
47 static bool beep = false;
48 bool debug_mode = false;
49 static bool dpms = false;
50 bool unlock_indicator = true;
51 static bool dont_fork = false;
52 struct ev_loop *main_loop;
53 static struct ev_timer *clear_pam_wrong_timeout;
54 extern unlock_state_t unlock_state;
55 extern pam_state_t pam_state;
57 static struct xkb_state *xkb_state;
58 static struct xkb_context *xkb_context;
59 static struct xkb_keymap *xkb_keymap;
61 cairo_surface_t *img = NULL;
63 bool ignore_empty_password = false;
65 /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
66 #define isutf(c) (((c) & 0xC0) != 0x80)
69 * Decrements i to point to the previous unicode glyph
72 void u8_dec(char *s, int *i) {
73 (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
77 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
78 * Necessary so that we can properly let xkbcommon track the keyboard state and
79 * translate keypresses to utf-8.
81 * Ideally, xkbcommon would ship something like this itself, but as of now
82 * (version 0.2.0), it doesn’t.
84 * TODO: Once xcb-xkb is enabled by default and released, we should port this
85 * code to xcb-xkb. See also https://github.com/xkbcommon/libxkbcommon/issues/1
88 static bool load_keymap(void) {
91 memset(&result, '\0', sizeof(result));
92 result.xkb = XkbGetKeyboard(display, XkbAllMapComponentsMask, XkbUseCoreKbd);
93 if (result.xkb == NULL) {
94 fprintf(stderr, "[i3lock] XKB: XkbGetKeyboard failed\n");
98 FILE *temp = tmpfile();
100 fprintf(stderr, "[i3lock] could not create tempfile\n");
104 bool ok = XkbWriteXKBKeymap(temp, &result, false, false, NULL, NULL);
106 fprintf(stderr, "[i3lock] XkbWriteXKBKeymap failed\n");
112 if (xkb_context == NULL) {
113 if ((xkb_context = xkb_context_new(0)) == NULL) {
114 fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
119 if (xkb_keymap != NULL)
120 xkb_keymap_unref(xkb_keymap);
122 if ((xkb_keymap = xkb_keymap_new_from_file(xkb_context, temp, XKB_KEYMAP_FORMAT_TEXT_V1, 0)) == NULL) {
123 fprintf(stderr, "[i3lock] xkb_keymap_new_from_file failed\n");
127 struct xkb_state *new_state = xkb_state_new(xkb_keymap);
128 if (new_state == NULL) {
129 fprintf(stderr, "[i3lock] xkb_state_new failed\n");
133 /* Get the initial modifier state to be in sync with the X server.
134 * See https://github.com/xkbcommon/libxkbcommon/issues/1 for why we ignore
135 * the base and latched fields. */
136 XkbStateRec state_rec;
137 XkbGetState(display, XkbUseCoreKbd, &state_rec);
139 xkb_state_update_mask(new_state,
140 0, 0, state_rec.locked_mods,
141 0, 0, state_rec.locked_group);
143 if (xkb_state != NULL)
144 xkb_state_unref(xkb_state);
145 xkb_state = new_state;
149 XkbFreeKeyboard(result.xkb, XkbAllComponentsMask, true);
155 * Clears the memory which stored the password to be a bit safer against
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;
173 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful
174 * authentication event.
177 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
178 DEBUG("clearing pam wrong\n");
179 pam_state = STATE_PAM_IDLE;
180 unlock_state = STATE_STARTED;
183 /* Now free this timeout. */
184 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
185 free(clear_pam_wrong_timeout);
186 clear_pam_wrong_timeout = NULL;
189 static void clear_input(void) {
191 clear_password_memory();
192 password[input_position] = '\0';
194 /* Hide the unlock indicator after a bit if the password buffer is
196 start_clear_indicator_timeout();
197 unlock_state = STATE_BACKSPACE_ACTIVE;
199 unlock_state = STATE_KEY_PRESSED;
202 static void input_done(void) {
203 if (clear_pam_wrong_timeout) {
204 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
205 free(clear_pam_wrong_timeout);
206 clear_pam_wrong_timeout = NULL;
209 pam_state = STATE_PAM_VERIFY;
212 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
213 DEBUG("successfully authenticated\n");
214 clear_password_memory();
219 fprintf(stderr, "Authentication failure\n");
221 pam_state = STATE_PAM_WRONG;
225 /* Clear this state after 2 seconds (unless the user enters another
226 * password during that time). */
227 ev_now_update(main_loop);
228 if ((clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1))) {
229 ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.);
230 ev_timer_start(main_loop, clear_pam_wrong_timeout);
233 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
235 stop_clear_indicator_timeout();
237 /* beep on authentication failure, if enabled */
245 * Called when the user releases a key. We need to leave the Mode_switch
246 * state when the user releases the Mode_switch key.
249 static void handle_key_release(xcb_key_release_event_t *event) {
250 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP);
253 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
256 ev_timer_stop(main_loop, w);
261 * Handle key presses. Fixes state, then looks up the key symbol for the
262 * given keycode, then looks up the key symbol (as UCS-2), converts it to
263 * UTF-8 and stores it in the password array.
266 static void handle_key_press(xcb_key_press_event_t *event) {
272 ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
273 ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
274 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN);
276 /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
277 memset(buffer, '\0', sizeof(buffer));
278 n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
282 case XKB_KEY_KP_Enter:
283 case XKB_KEY_XF86ScreenSaver:
284 if (ignore_empty_password && input_position == 0) {
288 password[input_position] = '\0';
289 unlock_state = STATE_KEY_PRESSED;
296 DEBUG("C-u pressed\n");
306 case XKB_KEY_BackSpace:
307 if (input_position == 0)
310 /* decrement input_position to point to the previous glyph */
311 u8_dec(password, &input_position);
312 password[input_position] = '\0';
314 /* Hide the unlock indicator after a bit if the password buffer is
316 start_clear_indicator_timeout();
317 unlock_state = STATE_BACKSPACE_ACTIVE;
319 unlock_state = STATE_KEY_PRESSED;
323 if ((input_position + 8) >= sizeof(password))
327 /* FIXME: handle all of these? */
328 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
329 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
330 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
331 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
332 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
333 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
334 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
340 /* store it in the password array as UTF-8 */
341 memcpy(password+input_position, buffer, n-1);
342 input_position += n-1;
343 DEBUG("current password = %.*s\n", input_position, password);
345 unlock_state = STATE_KEY_ACTIVE;
347 unlock_state = STATE_KEY_PRESSED;
349 struct ev_timer *timeout = calloc(sizeof(struct ev_timer), 1);
351 ev_timer_init(timeout, redraw_timeout, 0.25, 0.);
352 ev_timer_start(main_loop, timeout);
355 stop_clear_indicator_timeout();
359 * A visibility notify event will be received when the visibility (= can the
360 * user view the complete window) changes, so for example when a popup overlays
361 * some area of the i3lock window.
363 * In this case, we raise our window on top so that the popup (or whatever is
364 * hiding us) gets hidden.
367 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
368 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
369 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
370 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
376 * Called when the keyboard mapping changes. We update our symbols.
379 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
380 /* We ignore errors — if the new keymap cannot be loaded it’s better if the
381 * screen stays locked and the user intervenes by using killall i3lock. */
386 * Called when the properties on the root window change, e.g. when the screen
387 * resolution changes. If so we update the window to cover the whole screen
388 * and also redraw the image, if any.
391 void handle_screen_resize(void) {
392 xcb_get_geometry_cookie_t geomc;
393 xcb_get_geometry_reply_t *geom;
394 geomc = xcb_get_geometry(conn, screen->root);
395 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
398 if (last_resolution[0] == geom->width &&
399 last_resolution[1] == geom->height) {
404 last_resolution[0] = geom->width;
405 last_resolution[1] = geom->height;
411 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
412 xcb_configure_window(conn, win, mask, last_resolution);
415 xinerama_query_screens();
420 * Callback function for PAM. We only react on password request callbacks.
423 static int conv_callback(int num_msg, const struct pam_message **msg,
424 struct pam_response **resp, void *appdata_ptr)
429 /* PAM expects an array of responses, one for each message */
430 if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
435 for (int c = 0; c < num_msg; c++) {
436 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
437 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
440 /* return code is currently not used but should be set to zero */
441 resp[c]->resp_retcode = 0;
442 if ((resp[c]->resp = strdup(password)) == NULL) {
452 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
453 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
456 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
457 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
461 * Flush before blocking (and waiting for new events)
464 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
469 * Instead of polling the X connection socket we leave this to
470 * xcb_poll_for_event() which knows better than we can ever know.
473 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
474 xcb_generic_event_t *event;
476 while ((event = xcb_poll_for_event(conn)) != NULL) {
477 if (event->response_type == 0) {
478 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
480 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
481 error->sequence, error->error_code);
486 /* Strip off the highest bit (set if the event is generated) */
487 int type = (event->response_type & 0x7F);
490 handle_key_press((xcb_key_press_event_t*)event);
493 case XCB_KEY_RELEASE:
494 handle_key_release((xcb_key_release_event_t*)event);
496 /* If this was the backspace or escape key we are back at an
497 * empty input, so turn off the screen if DPMS is enabled */
498 if (dpms && input_position == 0)
499 dpms_turn_off_screen(conn);
503 case XCB_VISIBILITY_NOTIFY:
504 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
509 /* After the first MapNotify, we never fork again. We don’t
510 * expect to get another MapNotify, but better be sure… */
513 /* In the parent process, we exit */
517 ev_loop_fork(EV_DEFAULT);
521 case XCB_MAPPING_NOTIFY:
522 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
525 case XCB_CONFIGURE_NOTIFY:
526 handle_screen_resize();
534 int main(int argc, char *argv[]) {
536 char *image_path = NULL;
538 struct pam_conv conv = {conv_callback, NULL};
539 int curs_choice = CURS_NONE;
542 struct option longopts[] = {
543 {"version", no_argument, NULL, 'v'},
544 {"nofork", no_argument, NULL, 'n'},
545 {"beep", no_argument, NULL, 'b'},
546 {"dpms", no_argument, NULL, 'd'},
547 {"color", required_argument, NULL, 'c'},
548 {"pointer", required_argument, NULL , 'p'},
549 {"debug", no_argument, NULL, 0},
550 {"help", no_argument, NULL, 'h'},
551 {"no-unlock-indicator", no_argument, NULL, 'u'},
552 {"image", required_argument, NULL, 'i'},
553 {"tiling", no_argument, NULL, 't'},
554 {"ignore-empty-password", no_argument, NULL, 'e'},
555 {NULL, no_argument, NULL, 0}
558 if ((username = getenv("USER")) == NULL)
559 errx(1, "USER environment variable not set, please set it.\n");
561 while ((o = getopt_long(argc, argv, "hvnbdc:p:ui:te", longopts, &optind)) != -1) {
564 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
577 /* Skip # if present */
581 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
582 errx(1, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
587 unlock_indicator = false;
590 image_path = strdup(optarg);
596 if (!strcmp(optarg, "win")) {
597 curs_choice = CURS_WIN;
598 } else if (!strcmp(optarg, "default")) {
599 curs_choice = CURS_DEFAULT;
601 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
605 ignore_empty_password = true;
608 if (strcmp(longopts[optind].name, "debug") == 0)
612 errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
613 " [-i image.png] [-t] [-e]"
618 /* We need (relatively) random numbers for highlighting a random part of
619 * the unlock indicator upon keypresses. */
623 ret = pam_start("i3lock", username, &conv, &pam_handle);
624 if (ret != PAM_SUCCESS)
625 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
627 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
628 * operating systems should use encrypted swap/no swap (or remove the ifdef and
629 * run i3lock as super-user). */
630 #if defined(__linux__)
631 /* Lock the area where we store the password in memory, we don’t want it to
632 * be swapped to disk. Since Linux 2.6.9, this does not require any
633 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
634 if (mlock(password, sizeof(password)) != 0)
635 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
638 /* Initialize connection to X11 */
639 if ((display = XOpenDisplay(NULL)) == NULL)
640 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
641 XSetEventQueueOwner(display, XCBOwnsEventQueue);
642 conn = XGetXCBConnection(display);
644 /* Double checking that connection is good and operatable with xcb */
645 if (xcb_connection_has_error(conn))
646 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
648 /* When we cannot initially load the keymap, we better exit */
650 errx(EXIT_FAILURE, "Could not load keymap");
653 xinerama_query_screens();
655 /* if DPMS is enabled, check if the X server really supports it */
657 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
658 xcb_dpms_capable_reply_t *dpmsr;
659 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
660 if (!dpmsr->capable) {
662 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
669 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
671 last_resolution[0] = screen->width_in_pixels;
672 last_resolution[1] = screen->height_in_pixels;
674 xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
675 (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
678 /* Create a pixmap to render on, fill it with the background color */
679 img = cairo_image_surface_create_from_png(image_path);
680 /* In case loading failed, we just pretend no -i was specified. */
681 if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
682 fprintf(stderr, "Could not load image \"%s\": %s\n",
683 image_path, cairo_status_to_string(cairo_surface_status(img)));
688 /* Pixmap on which the image is rendered to (if any) */
689 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
691 /* open the fullscreen window, already with the correct pixmap in place */
692 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
693 xcb_free_pixmap(conn, bg_pixmap);
695 cursor = create_cursor(conn, screen, win, curs_choice);
697 grab_pointer_and_keyboard(conn, screen, cursor);
698 /* Load the keymap again to sync the current modifier state. Since we first
699 * loaded the keymap, there might have been changes, but starting from now,
700 * we should get all key presses/releases due to having grabbed the
705 dpms_turn_off_screen(conn);
707 /* Initialize the libev event loop. */
708 main_loop = EV_DEFAULT;
709 if (main_loop == NULL)
710 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
712 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
713 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
714 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
716 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
717 ev_io_start(main_loop, xcb_watcher);
719 ev_check_init(xcb_check, xcb_check_cb);
720 ev_check_start(main_loop, xcb_check);
722 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
723 ev_prepare_start(main_loop, xcb_prepare);
725 /* Invoke the event callback once to catch all the events which were
726 * received up until now. ev will only pick up new events (when the X11
727 * file descriptor becomes readable). */
728 ev_invoke(main_loop, xcb_check, 0);
729 ev_loop(main_loop, 0);