2 * vim:ts=4:sw=4:expandtab
4 * © 2010-2012 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.
85 static bool load_keymap(void) {
88 memset(&result, '\0', sizeof(result));
89 result.xkb = XkbGetKeyboard(display, XkbAllMapComponentsMask, XkbUseCoreKbd);
90 if (result.xkb == NULL) {
91 fprintf(stderr, "[i3lock] XKB: XkbGetKeyboard failed\n");
95 FILE *temp = tmpfile();
97 fprintf(stderr, "[i3lock] could not create tempfile\n");
101 bool ok = XkbWriteXKBKeymap(temp, &result, false, false, NULL, NULL);
103 fprintf(stderr, "[i3lock] XkbWriteXKBKeymap failed\n");
109 if (xkb_context == NULL) {
110 if ((xkb_context = xkb_context_new(0)) == NULL) {
111 fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
116 if (xkb_keymap != NULL)
117 xkb_keymap_unref(xkb_keymap);
119 if ((xkb_keymap = xkb_keymap_new_from_file(xkb_context, temp, XKB_KEYMAP_FORMAT_TEXT_V1, 0)) == NULL) {
120 fprintf(stderr, "[i3lock] xkb_keymap_new_from_file failed\n");
124 struct xkb_state *new_state = xkb_state_new(xkb_keymap);
125 if (new_state == NULL) {
126 fprintf(stderr, "[i3lock] xkb_state_new failed\n");
130 if (xkb_state != NULL)
131 xkb_state_unref(xkb_state);
132 xkb_state = new_state;
136 XkbFreeKeyboard(result.xkb, XkbAllComponentsMask, true);
142 * Clears the memory which stored the password to be a bit safer against
146 static void clear_password_memory(void) {
147 /* A volatile pointer to the password buffer to prevent the compiler from
148 * optimizing this out. */
149 volatile char *vpassword = password;
150 for (int c = 0; c < sizeof(password); c++)
151 /* We store a non-random pattern which consists of the (irrelevant)
152 * index plus (!) the value of the beep variable. This prevents the
153 * compiler from optimizing the calls away, since the value of 'beep'
154 * is not known at compile-time. */
155 vpassword[c] = c + (int)beep;
160 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful
161 * authentication event.
164 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
165 DEBUG("clearing pam wrong\n");
166 pam_state = STATE_PAM_IDLE;
167 unlock_state = STATE_STARTED;
170 /* Now free this timeout. */
171 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
172 free(clear_pam_wrong_timeout);
173 clear_pam_wrong_timeout = NULL;
176 static void clear_input(void) {
178 clear_password_memory();
179 password[input_position] = '\0';
181 /* Hide the unlock indicator after a bit if the password buffer is
183 start_clear_indicator_timeout();
184 unlock_state = STATE_BACKSPACE_ACTIVE;
186 unlock_state = STATE_KEY_PRESSED;
189 static void input_done(void) {
190 if (clear_pam_wrong_timeout) {
191 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
192 free(clear_pam_wrong_timeout);
193 clear_pam_wrong_timeout = NULL;
196 pam_state = STATE_PAM_VERIFY;
199 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
200 DEBUG("successfully authenticated\n");
201 clear_password_memory();
206 fprintf(stderr, "Authentication failure\n");
208 pam_state = STATE_PAM_WRONG;
212 /* Clear this state after 2 seconds (unless the user enters another
213 * password during that time). */
214 ev_now_update(main_loop);
215 if ((clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1))) {
216 ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.);
217 ev_timer_start(main_loop, clear_pam_wrong_timeout);
220 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
222 stop_clear_indicator_timeout();
224 /* beep on authentication failure, if enabled */
232 * Called when the user releases a key. We need to leave the Mode_switch
233 * state when the user releases the Mode_switch key.
236 static void handle_key_release(xcb_key_release_event_t *event) {
237 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP);
240 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
243 ev_timer_stop(main_loop, w);
248 * Handle key presses. Fixes state, then looks up the key symbol for the
249 * given keycode, then looks up the key symbol (as UCS-2), converts it to
250 * UTF-8 and stores it in the password array.
253 static void handle_key_press(xcb_key_press_event_t *event) {
259 ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
260 ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
261 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN);
263 /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
264 memset(buffer, '\0', sizeof(buffer));
265 n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
269 case XKB_KEY_KP_Enter:
270 case XKB_KEY_XF86ScreenSaver:
271 if (ignore_empty_password && input_position == 0) {
275 password[input_position] = '\0';
276 unlock_state = STATE_KEY_PRESSED;
283 DEBUG("C-u pressed\n");
293 case XKB_KEY_BackSpace:
294 if (input_position == 0)
297 /* decrement input_position to point to the previous glyph */
298 u8_dec(password, &input_position);
299 password[input_position] = '\0';
301 /* Hide the unlock indicator after a bit if the password buffer is
303 start_clear_indicator_timeout();
304 unlock_state = STATE_BACKSPACE_ACTIVE;
306 unlock_state = STATE_KEY_PRESSED;
310 if ((input_position + 8) >= sizeof(password))
314 /* FIXME: handle all of these? */
315 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
316 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
317 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
318 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
319 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
320 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
321 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
327 /* store it in the password array as UTF-8 */
328 memcpy(password+input_position, buffer, n-1);
329 input_position += n-1;
330 DEBUG("current password = %.*s\n", input_position, password);
332 unlock_state = STATE_KEY_ACTIVE;
334 unlock_state = STATE_KEY_PRESSED;
336 struct ev_timer *timeout = calloc(sizeof(struct ev_timer), 1);
338 ev_timer_init(timeout, redraw_timeout, 0.25, 0.);
339 ev_timer_start(main_loop, timeout);
342 stop_clear_indicator_timeout();
346 * A visibility notify event will be received when the visibility (= can the
347 * user view the complete window) changes, so for example when a popup overlays
348 * some area of the i3lock window.
350 * In this case, we raise our window on top so that the popup (or whatever is
351 * hiding us) gets hidden.
354 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
355 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
356 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
357 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
363 * Called when the keyboard mapping changes. We update our symbols.
366 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
367 /* We ignore errors — if the new keymap cannot be loaded it’s better if the
368 * screen stays locked and the user intervenes by using killall i3lock. */
373 * Called when the properties on the root window change, e.g. when the screen
374 * resolution changes. If so we update the window to cover the whole screen
375 * and also redraw the image, if any.
378 void handle_screen_resize(void) {
379 xcb_get_geometry_cookie_t geomc;
380 xcb_get_geometry_reply_t *geom;
381 geomc = xcb_get_geometry(conn, screen->root);
382 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
385 if (last_resolution[0] == geom->width &&
386 last_resolution[1] == geom->height) {
391 last_resolution[0] = geom->width;
392 last_resolution[1] = geom->height;
398 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
399 xcb_configure_window(conn, win, mask, last_resolution);
402 xinerama_query_screens();
407 * Callback function for PAM. We only react on password request callbacks.
410 static int conv_callback(int num_msg, const struct pam_message **msg,
411 struct pam_response **resp, void *appdata_ptr)
416 /* PAM expects an array of responses, one for each message */
417 if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
422 for (int c = 0; c < num_msg; c++) {
423 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
424 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
427 /* return code is currently not used but should be set to zero */
428 resp[c]->resp_retcode = 0;
429 if ((resp[c]->resp = strdup(password)) == NULL) {
439 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
440 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
443 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
444 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
448 * Flush before blocking (and waiting for new events)
451 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
456 * Instead of polling the X connection socket we leave this to
457 * xcb_poll_for_event() which knows better than we can ever know.
460 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
461 xcb_generic_event_t *event;
463 while ((event = xcb_poll_for_event(conn)) != NULL) {
464 if (event->response_type == 0) {
465 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
467 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
468 error->sequence, error->error_code);
473 /* Strip off the highest bit (set if the event is generated) */
474 int type = (event->response_type & 0x7F);
477 handle_key_press((xcb_key_press_event_t*)event);
480 case XCB_KEY_RELEASE:
481 handle_key_release((xcb_key_release_event_t*)event);
483 /* If this was the backspace or escape key we are back at an
484 * empty input, so turn off the screen if DPMS is enabled */
485 if (dpms && input_position == 0)
486 dpms_turn_off_screen(conn);
490 case XCB_VISIBILITY_NOTIFY:
491 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
496 /* After the first MapNotify, we never fork again. We don’t
497 * expect to get another MapNotify, but better be sure… */
500 /* In the parent process, we exit */
504 ev_loop_fork(EV_DEFAULT);
508 case XCB_MAPPING_NOTIFY:
509 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
512 case XCB_CONFIGURE_NOTIFY:
513 handle_screen_resize();
521 int main(int argc, char *argv[]) {
523 char *image_path = NULL;
525 struct pam_conv conv = {conv_callback, NULL};
526 int curs_choice = CURS_NONE;
529 struct option longopts[] = {
530 {"version", no_argument, NULL, 'v'},
531 {"nofork", no_argument, NULL, 'n'},
532 {"beep", no_argument, NULL, 'b'},
533 {"dpms", no_argument, NULL, 'd'},
534 {"color", required_argument, NULL, 'c'},
535 {"pointer", required_argument, NULL , 'p'},
536 {"debug", no_argument, NULL, 0},
537 {"help", no_argument, NULL, 'h'},
538 {"no-unlock-indicator", no_argument, NULL, 'u'},
539 {"image", required_argument, NULL, 'i'},
540 {"tiling", no_argument, NULL, 't'},
541 {"ignore-empty-password", no_argument, NULL, 'e'},
542 {NULL, no_argument, NULL, 0}
545 if ((username = getenv("USER")) == NULL)
546 errx(1, "USER environment variable not set, please set it.\n");
548 while ((o = getopt_long(argc, argv, "hvnbdc:p:ui:te", longopts, &optind)) != -1) {
551 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
564 /* Skip # if present */
568 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
569 errx(1, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
574 unlock_indicator = false;
577 image_path = strdup(optarg);
583 if (!strcmp(optarg, "win")) {
584 curs_choice = CURS_WIN;
585 } else if (!strcmp(optarg, "default")) {
586 curs_choice = CURS_DEFAULT;
588 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
592 ignore_empty_password = true;
595 if (strcmp(longopts[optind].name, "debug") == 0)
599 errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
600 " [-i image.png] [-t]"
605 /* We need (relatively) random numbers for highlighting a random part of
606 * the unlock indicator upon keypresses. */
610 ret = pam_start("i3lock", username, &conv, &pam_handle);
611 if (ret != PAM_SUCCESS)
612 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
614 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
615 * operating systems should use encrypted swap/no swap (or remove the ifdef and
616 * run i3lock as super-user). */
617 #if defined(__linux__)
618 /* Lock the area where we store the password in memory, we don’t want it to
619 * be swapped to disk. Since Linux 2.6.9, this does not require any
620 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
621 if (mlock(password, sizeof(password)) != 0)
622 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
625 /* Initialize connection to X11 */
626 if ((display = XOpenDisplay(NULL)) == NULL)
627 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
628 XSetEventQueueOwner(display, XCBOwnsEventQueue);
629 conn = XGetXCBConnection(display);
631 /* Double checking that connection is good and operatable with xcb */
632 if (xcb_connection_has_error(conn))
633 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
635 /* When we cannot initially load the keymap, we better exit */
637 errx(EXIT_FAILURE, "Could not load keymap");
640 xinerama_query_screens();
642 /* if DPMS is enabled, check if the X server really supports it */
644 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
645 xcb_dpms_capable_reply_t *dpmsr;
646 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
647 if (!dpmsr->capable) {
649 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
656 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
658 last_resolution[0] = screen->width_in_pixels;
659 last_resolution[1] = screen->height_in_pixels;
661 xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
662 (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
665 /* Create a pixmap to render on, fill it with the background color */
666 img = cairo_image_surface_create_from_png(image_path);
667 /* In case loading failed, we just pretend no -i was specified. */
668 if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
669 fprintf(stderr, "Could not load image \"%s\": %s\n",
670 image_path, cairo_status_to_string(cairo_surface_status(img)));
675 /* Pixmap on which the image is rendered to (if any) */
676 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
678 /* open the fullscreen window, already with the correct pixmap in place */
679 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
680 xcb_free_pixmap(conn, bg_pixmap);
682 cursor = create_cursor(conn, screen, win, curs_choice);
684 grab_pointer_and_keyboard(conn, screen, cursor);
687 dpms_turn_off_screen(conn);
689 /* Initialize the libev event loop. */
690 main_loop = EV_DEFAULT;
691 if (main_loop == NULL)
692 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
694 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
695 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
696 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
698 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
699 ev_io_start(main_loop, xcb_watcher);
701 ev_check_init(xcb_check, xcb_check_cb);
702 ev_check_start(main_loop, xcb_check);
704 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
705 ev_prepare_start(main_loop, xcb_prepare);
707 /* Invoke the event callback once to catch all the events which were
708 * received up until now. ev will only pick up new events (when the X11
709 * file descriptor becomes readable). */
710 ev_invoke(main_loop, xcb_check, 0);
711 ev_loop(main_loop, 0);