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;
64 /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
65 #define isutf(c) (((c) & 0xC0) != 0x80)
68 * Decrements i to point to the previous unicode glyph
71 void u8_dec(char *s, int *i) {
72 (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
76 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
77 * Necessary so that we can properly let xkbcommon track the keyboard state and
78 * translate keypresses to utf-8.
80 * Ideally, xkbcommon would ship something like this itself, but as of now
81 * (version 0.2.0), it doesn’t.
84 static bool load_keymap(void) {
87 memset(&result, '\0', sizeof(result));
88 result.xkb = XkbGetKeyboard(display, XkbAllMapComponentsMask, XkbUseCoreKbd);
89 if (result.xkb == NULL) {
90 fprintf(stderr, "[i3lock] XKB: XkbGetKeyboard failed\n");
94 FILE *temp = tmpfile();
96 fprintf(stderr, "[i3lock] could not create tempfile\n");
100 bool ok = XkbWriteXKBKeymap(temp, &result, false, false, NULL, NULL);
102 fprintf(stderr, "[i3lock] XkbWriteXKBKeymap failed\n");
108 if (xkb_context == NULL) {
109 if ((xkb_context = xkb_context_new(0)) == NULL) {
110 fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
115 if (xkb_keymap != NULL)
116 xkb_keymap_unref(xkb_keymap);
118 if ((xkb_keymap = xkb_keymap_new_from_file(xkb_context, temp, XKB_KEYMAP_FORMAT_TEXT_V1, 0)) == NULL) {
119 fprintf(stderr, "[i3lock] xkb_keymap_new_from_file failed\n");
123 struct xkb_state *new_state = xkb_state_new(xkb_keymap);
124 if (new_state == NULL) {
125 fprintf(stderr, "[i3lock] xkb_state_new failed\n");
129 if (xkb_state != NULL)
130 xkb_state_unref(xkb_state);
131 xkb_state = new_state;
135 XkbFreeKeyboard(result.xkb, XkbAllComponentsMask, true);
141 * Clears the memory which stored the password to be a bit safer against
145 static void clear_password_memory(void) {
146 /* A volatile pointer to the password buffer to prevent the compiler from
147 * optimizing this out. */
148 volatile char *vpassword = password;
149 for (int c = 0; c < sizeof(password); c++)
150 /* We store a non-random pattern which consists of the (irrelevant)
151 * index plus (!) the value of the beep variable. This prevents the
152 * compiler from optimizing the calls away, since the value of 'beep'
153 * is not known at compile-time. */
154 vpassword[c] = c + (int)beep;
159 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful
160 * authentication event.
163 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
164 DEBUG("clearing pam wrong\n");
165 pam_state = STATE_PAM_IDLE;
166 unlock_state = STATE_STARTED;
169 /* Now free this timeout. */
170 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
171 free(clear_pam_wrong_timeout);
172 clear_pam_wrong_timeout = NULL;
175 static void clear_input(void) {
177 clear_password_memory();
178 password[input_position] = '\0';
180 /* Hide the unlock indicator after a bit if the password buffer is
182 start_clear_indicator_timeout();
183 unlock_state = STATE_BACKSPACE_ACTIVE;
185 unlock_state = STATE_KEY_PRESSED;
188 static void input_done(void) {
189 if (clear_pam_wrong_timeout) {
190 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
191 free(clear_pam_wrong_timeout);
192 clear_pam_wrong_timeout = NULL;
195 pam_state = STATE_PAM_VERIFY;
198 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
199 DEBUG("successfully authenticated\n");
200 clear_password_memory();
205 fprintf(stderr, "Authentication failure\n");
207 pam_state = STATE_PAM_WRONG;
211 /* Clear this state after 2 seconds (unless the user enters another
212 * password during that time). */
213 ev_now_update(main_loop);
214 if ((clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1))) {
215 ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.);
216 ev_timer_start(main_loop, clear_pam_wrong_timeout);
219 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
221 stop_clear_indicator_timeout();
223 /* beep on authentication failure, if enabled */
231 * Called when the user releases a key. We need to leave the Mode_switch
232 * state when the user releases the Mode_switch key.
235 static void handle_key_release(xcb_key_release_event_t *event) {
236 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP);
239 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
242 ev_timer_stop(main_loop, w);
247 * Handle key presses. Fixes state, then looks up the key symbol for the
248 * given keycode, then looks up the key symbol (as UCS-2), converts it to
249 * UTF-8 and stores it in the password array.
252 static void handle_key_press(xcb_key_press_event_t *event) {
258 ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
259 ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
260 xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN);
262 /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
263 memset(buffer, '\0', sizeof(buffer));
264 n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
268 case XKB_KEY_KP_Enter:
269 case XKB_KEY_XF86ScreenSaver:
270 password[input_position] = '\0';
271 unlock_state = STATE_KEY_PRESSED;
285 case XKB_KEY_BackSpace:
286 if (input_position == 0)
289 /* decrement input_position to point to the previous glyph */
290 u8_dec(password, &input_position);
291 password[input_position] = '\0';
293 /* Hide the unlock indicator after a bit if the password buffer is
295 start_clear_indicator_timeout();
296 unlock_state = STATE_BACKSPACE_ACTIVE;
298 unlock_state = STATE_KEY_PRESSED;
302 if ((input_position + 8) >= sizeof(password))
306 /* FIXME: handle all of these? */
307 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
308 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
309 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
310 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
311 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
312 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
313 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
319 /* store it in the password array as UTF-8 */
320 memcpy(password+input_position, buffer, n-1);
321 input_position += n-1;
322 DEBUG("current password = %.*s\n", input_position, password);
324 unlock_state = STATE_KEY_ACTIVE;
326 unlock_state = STATE_KEY_PRESSED;
328 struct ev_timer *timeout = calloc(sizeof(struct ev_timer), 1);
330 ev_timer_init(timeout, redraw_timeout, 0.25, 0.);
331 ev_timer_start(main_loop, timeout);
334 stop_clear_indicator_timeout();
338 * A visibility notify event will be received when the visibility (= can the
339 * user view the complete window) changes, so for example when a popup overlays
340 * some area of the i3lock window.
342 * In this case, we raise our window on top so that the popup (or whatever is
343 * hiding us) gets hidden.
346 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
347 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
348 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
349 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
355 * Called when the keyboard mapping changes. We update our symbols.
358 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
359 /* We ignore errors — if the new keymap cannot be loaded it’s better if the
360 * screen stays locked and the user intervenes by using killall i3lock. */
365 * Called when the properties on the root window change, e.g. when the screen
366 * resolution changes. If so we update the window to cover the whole screen
367 * and also redraw the image, if any.
370 void handle_screen_resize(void) {
371 xcb_get_geometry_cookie_t geomc;
372 xcb_get_geometry_reply_t *geom;
373 geomc = xcb_get_geometry(conn, screen->root);
374 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
377 if (last_resolution[0] == geom->width &&
378 last_resolution[1] == geom->height) {
383 last_resolution[0] = geom->width;
384 last_resolution[1] = geom->height;
390 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
391 xcb_configure_window(conn, win, mask, last_resolution);
394 xinerama_query_screens();
399 * Callback function for PAM. We only react on password request callbacks.
402 static int conv_callback(int num_msg, const struct pam_message **msg,
403 struct pam_response **resp, void *appdata_ptr)
408 /* PAM expects an array of responses, one for each message */
409 if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
414 for (int c = 0; c < num_msg; c++) {
415 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
416 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
419 /* return code is currently not used but should be set to zero */
420 resp[c]->resp_retcode = 0;
421 if ((resp[c]->resp = strdup(password)) == NULL) {
431 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
432 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
435 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
436 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
440 * Flush before blocking (and waiting for new events)
443 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
448 * Instead of polling the X connection socket we leave this to
449 * xcb_poll_for_event() which knows better than we can ever know.
452 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
453 xcb_generic_event_t *event;
455 while ((event = xcb_poll_for_event(conn)) != NULL) {
456 if (event->response_type == 0) {
457 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
459 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
460 error->sequence, error->error_code);
465 /* Strip off the highest bit (set if the event is generated) */
466 int type = (event->response_type & 0x7F);
469 handle_key_press((xcb_key_press_event_t*)event);
472 case XCB_KEY_RELEASE:
473 handle_key_release((xcb_key_release_event_t*)event);
475 /* If this was the backspace or escape key we are back at an
476 * empty input, so turn off the screen if DPMS is enabled */
477 if (dpms && input_position == 0)
478 dpms_turn_off_screen(conn);
482 case XCB_VISIBILITY_NOTIFY:
483 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
488 /* After the first MapNotify, we never fork again. We don’t
489 * expect to get another MapNotify, but better be sure… */
492 /* In the parent process, we exit */
496 ev_loop_fork(EV_DEFAULT);
500 case XCB_MAPPING_NOTIFY:
501 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
504 case XCB_CONFIGURE_NOTIFY:
505 handle_screen_resize();
513 int main(int argc, char *argv[]) {
515 char *image_path = NULL;
517 struct pam_conv conv = {conv_callback, NULL};
518 int curs_choice = CURS_NONE;
521 struct option longopts[] = {
522 {"version", no_argument, NULL, 'v'},
523 {"nofork", no_argument, NULL, 'n'},
524 {"beep", no_argument, NULL, 'b'},
525 {"dpms", no_argument, NULL, 'd'},
526 {"color", required_argument, NULL, 'c'},
527 {"pointer", required_argument, NULL , 'p'},
528 {"debug", no_argument, NULL, 0},
529 {"help", no_argument, NULL, 'h'},
530 {"no-unlock-indicator", no_argument, NULL, 'u'},
531 {"image", required_argument, NULL, 'i'},
532 {"tiling", no_argument, NULL, 't'},
533 {NULL, no_argument, NULL, 0}
536 if ((username = getenv("USER")) == NULL)
537 errx(1, "USER environment variable not set, please set it.\n");
539 while ((o = getopt_long(argc, argv, "hvnbdc:p:ui:t", longopts, &optind)) != -1) {
542 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
555 /* Skip # if present */
559 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
560 errx(1, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
565 unlock_indicator = false;
568 image_path = strdup(optarg);
574 if (!strcmp(optarg, "win")) {
575 curs_choice = CURS_WIN;
576 } else if (!strcmp(optarg, "default")) {
577 curs_choice = CURS_DEFAULT;
579 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
583 if (strcmp(longopts[optind].name, "debug") == 0)
587 errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
588 " [-i image.png] [-t]"
593 /* We need (relatively) random numbers for highlighting a random part of
594 * the unlock indicator upon keypresses. */
598 ret = pam_start("i3lock", username, &conv, &pam_handle);
599 if (ret != PAM_SUCCESS)
600 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
602 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
603 * operating systems should use encrypted swap/no swap (or remove the ifdef and
604 * run i3lock as super-user). */
605 #if defined(__linux__)
606 /* Lock the area where we store the password in memory, we don’t want it to
607 * be swapped to disk. Since Linux 2.6.9, this does not require any
608 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
609 if (mlock(password, sizeof(password)) != 0)
610 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
613 /* Initialize connection to X11 */
614 if ((display = XOpenDisplay(NULL)) == NULL)
615 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
616 XSetEventQueueOwner(display, XCBOwnsEventQueue);
617 conn = XGetXCBConnection(display);
619 /* Double checking that connection is good and operatable with xcb */
620 if (xcb_connection_has_error(conn))
621 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
623 /* When we cannot initially load the keymap, we better exit */
625 errx(EXIT_FAILURE, "Could not load keymap");
628 xinerama_query_screens();
630 /* if DPMS is enabled, check if the X server really supports it */
632 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
633 xcb_dpms_capable_reply_t *dpmsr;
634 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
635 if (!dpmsr->capable) {
637 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
644 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
646 last_resolution[0] = screen->width_in_pixels;
647 last_resolution[1] = screen->height_in_pixels;
649 xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
650 (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
653 /* Create a pixmap to render on, fill it with the background color */
654 img = cairo_image_surface_create_from_png(image_path);
655 /* In case loading failed, we just pretend no -i was specified. */
656 if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
657 fprintf(stderr, "Could not load image \"%s\": cairo surface status %d\n",
658 image_path, cairo_surface_status(img));
663 /* Pixmap on which the image is rendered to (if any) */
664 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
666 /* open the fullscreen window, already with the correct pixmap in place */
667 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
668 xcb_free_pixmap(conn, bg_pixmap);
670 cursor = create_cursor(conn, screen, win, curs_choice);
672 grab_pointer_and_keyboard(conn, screen, cursor);
675 dpms_turn_off_screen(conn);
677 /* Initialize the libev event loop. */
678 main_loop = EV_DEFAULT;
679 if (main_loop == NULL)
680 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
682 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
683 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
684 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
686 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
687 ev_io_start(main_loop, xcb_watcher);
689 ev_check_init(xcb_check, xcb_check_cb);
690 ev_check_start(main_loop, xcb_check);
692 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
693 ev_prepare_start(main_loop, xcb_prepare);
695 /* Invoke the event callback once to catch all the events which were
696 * received up until now. ev will only pick up new events (when the X11
697 * file descriptor becomes readable). */
698 ev_invoke(main_loop, xcb_check, 0);
699 ev_loop(main_loop, 0);