2 * vim:ts=4:sw=4:expandtab
4 * © 2010-2012 Michael Stapelberg
6 * See LICENSE for licensing information
17 #include <xcb/xcb_keysyms.h>
20 #include <security/pam_appl.h>
21 /* FIXME: can we get rid of this header? */
22 #include <X11/keysym.h>
31 #include <cairo/cairo-xcb.h>
34 #include "keysym2ucs.h"
35 #include "ucs2_to_utf8.h"
38 #include "unlock_indicator.h"
40 char color[7] = "ffffff";
41 uint32_t last_resolution[2];
43 static xcb_cursor_t cursor;
44 static xcb_key_symbols_t *symbols;
45 static pam_handle_t *pam_handle;
46 static int input_position = 0;
47 /* Holds the password you enter (in UTF-8). */
48 static char password[512];
49 static bool modeswitch_active = false;
50 static bool iso_level3_shift_active = false;
51 static bool iso_level5_shift_active = false;
52 static int modeswitchmask;
53 static int numlockmask;
54 static bool beep = false;
55 static bool debug_mode = false;
56 static bool dpms = false;
57 bool unlock_indicator = true;
58 static bool dont_fork = false;
59 static struct ev_loop *main_loop;
60 static struct ev_timer *clear_pam_wrong_timeout;
61 static struct ev_timer *clear_indicator_timeout;
62 extern unlock_state_t unlock_state;
63 extern pam_state_t pam_state;
65 #define DEBUG(fmt, ...) do { \
67 printf("[i3lock-debug] " fmt, ##__VA_ARGS__); \
71 cairo_surface_t *img = NULL;
76 * Clears the memory which stored the password to be a bit safer against
80 static void clear_password_memory() {
81 /* A volatile pointer to the password buffer to prevent the compiler from
82 * optimizing this out. */
83 volatile char *vpassword = password;
84 for (int c = 0; c < sizeof(password); c++)
85 /* We store a non-random pattern which consists of the (irrelevant)
86 * index plus (!) the value of the beep variable. This prevents the
87 * compiler from optimizing the calls away, since the value of 'beep'
88 * is not known at compile-time. */
89 vpassword[c] = c + (int)beep;
94 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful
95 * authentication event.
98 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
99 DEBUG("clearing pam wrong\n");
100 pam_state = STATE_PAM_IDLE;
101 unlock_state = STATE_STARTED;
106 * Hides the unlock indicator completely when there is no content in the
110 static void clear_indicator(EV_P_ ev_timer *w, int revents) {
111 if (input_position == 0) {
112 DEBUG("Clear indicator\n");
113 unlock_state = STATE_STARTED;
114 } else unlock_state = STATE_KEY_PRESSED;
119 * (Re-)starts the clear_indicator timeout. Called after pressing backspace or
120 * after an unsuccessful authentication attempt.
123 static void start_clear_indicator_timeout() {
124 if (clear_indicator_timeout) {
125 ev_timer_stop(main_loop, clear_indicator_timeout);
126 ev_timer_set(clear_indicator_timeout, 1.0, 0.);
127 ev_timer_start(main_loop, clear_indicator_timeout);
129 clear_indicator_timeout = calloc(sizeof(struct ev_timer), 1);
130 ev_timer_init(clear_indicator_timeout, clear_indicator, 1.0, 0.);
131 ev_timer_start(main_loop, clear_indicator_timeout);
135 static void input_done() {
136 if (input_position == 0)
139 if (clear_pam_wrong_timeout) {
140 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
141 clear_pam_wrong_timeout = NULL;
144 pam_state = STATE_PAM_VERIFY;
147 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
148 printf("successfully authenticated\n");
149 clear_password_memory();
153 fprintf(stderr, "Authentication failure\n");
155 pam_state = STATE_PAM_WRONG;
158 /* Clear this state after 2 seconds (unless the user enters another
159 * password during that time). */
160 ev_now_update(main_loop);
161 clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1);
162 ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.);
163 ev_timer_start(main_loop, clear_pam_wrong_timeout);
165 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
167 if (clear_indicator_timeout) {
168 ev_timer_stop(main_loop, clear_indicator_timeout);
169 clear_indicator_timeout = NULL;
172 /* beep on authentication failure, if enabled */
180 * Called when the user releases a key. We need to leave the Mode_switch
181 * state when the user releases the Mode_switch key.
184 static void handle_key_release(xcb_key_release_event_t *event) {
185 DEBUG("releasing key %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
186 event->detail, event->state, modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
188 /* We don’t care about the column here and just use the first symbol. Since
189 * we only check for Mode_switch and ISO_Level3_Shift, this *should* work.
190 * Also, if we would use the current column, we would look in the wrong
192 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, 0);
193 if (sym == XK_Mode_switch) {
194 //printf("Mode switch disabled\n");
195 modeswitch_active = false;
196 } else if (sym == XK_ISO_Level3_Shift) {
197 iso_level3_shift_active = false;
198 } else if (sym == XK_ISO_Level5_Shift) {
199 iso_level5_shift_active = false;
201 DEBUG("release done. modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
202 modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
205 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
210 * Handle key presses. Fixes state, then looks up the key symbol for the
211 * given keycode, then looks up the key symbol (as UCS-2), converts it to
212 * UTF-8 and stores it in the password array.
215 static void handle_key_press(xcb_key_press_event_t *event) {
216 DEBUG("keypress %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d\n",
217 event->detail, event->state, modeswitch_active, iso_level3_shift_active);
219 xcb_keysym_t sym0, sym1, sym;
220 /* For each keycode, there is a list of symbols. The list could look like this:
221 * $ xmodmap -pke | grep 'keycode 38'
222 * keycode 38 = a A adiaeresis Adiaeresis o O
223 * In non-X11 terminology, the symbols for the keycode 38 (the key labeled
224 * with "a" on my keyboard) are "a A ä Ä o O".
225 * Another form to display the same information is using xkbcomp:
226 * $ xkbcomp $DISPLAY /tmp/xkb.dump
227 * Then open /tmp/xkb.dump and search for '\<a\>' (in VIM regexp-language):
229 * symbols[Group1]= [ a, A, o, O ],
230 * symbols[Group2]= [ adiaeresis, Adiaeresis ]
232 * So there are two *groups*, one containing 'a A' and one containing 'ä
233 * Ä'. You can use Mode_switch to switch between these groups. You can use
234 * ISO_Level3_Shift to reach the 'o O' part of the first group (it’s the
235 * same group, just an even higher shift level).
237 * So, using the "logical" XKB information, the following lookup will be
240 * Neither Mode_switch nor ISO_Level3_Shift active: group 1, column 0 and 1
241 * Mode_switch active: group 2, column 0 and 1
242 * ISO_Level3_Shift active: group 1, column 2 and 3
244 * Using the column index which xcb_key_press_lookup_keysym uses (and
245 * xmodmap prints out), the following lookup will be performed:
247 * Neither Mode_switch nor ISO_Level3_Shift active: column 0 and 1
248 * Mode_switch active: column 2 and 3
249 * ISO_Level3_Shift active: column 4 and 5
252 if (modeswitch_active)
254 if (iso_level3_shift_active)
256 if (iso_level5_shift_active)
258 sym0 = xcb_key_press_lookup_keysym(symbols, event, base_column);
259 sym1 = xcb_key_press_lookup_keysym(symbols, event, base_column + 1);
262 DEBUG("Mode switch enabled\n");
263 modeswitch_active = true;
265 case XK_ISO_Level3_Shift:
266 DEBUG("ISO_Level3_Shift enabled\n");
267 iso_level3_shift_active = true;
269 case XK_ISO_Level5_Shift:
270 DEBUG("ISO_Level5_Shift enabled\n");
271 iso_level5_shift_active = true;
278 clear_password_memory();
279 password[input_position] = '\0';
283 if (input_position == 0)
286 /* decrement input_position to point to the previous glyph */
287 u8_dec(password, &input_position);
288 password[input_position] = '\0';
290 /* Clear this state after 2 seconds (unless the user enters another
291 * password during that time). */
292 start_clear_indicator_timeout();
293 unlock_state = STATE_BACKSPACE_ACTIVE;
295 unlock_state = STATE_KEY_PRESSED;
296 //printf("new input position = %d, new password = %s\n", input_position, password);
300 if ((input_position + 8) >= sizeof(password))
303 if ((event->state & numlockmask) && xcb_is_keypad_key(sym1)) {
304 /* this key was a keypad key */
305 if ((event->state & XCB_MOD_MASK_SHIFT))
309 if ((event->state & XCB_MOD_MASK_SHIFT))
315 /* FIXME: handle all of these? */
316 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
317 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
318 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
319 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
320 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
321 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
322 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
325 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
328 DEBUG("resolved to keysym = %c (%d)\n", sym, sym);
330 /* convert the keysym to UCS */
331 uint16_t ucs = keysym2ucs(sym);
332 if ((int16_t)ucs == -1) {
333 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
337 /* store the UCS in a string to convert it */
338 uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
339 DEBUG("input part = %s\n", inp);
341 /* store it in the password array as UTF-8 */
342 input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
343 password[input_position] = '\0';
344 DEBUG("current password = %s\n", password);
346 unlock_state = STATE_KEY_ACTIVE;
348 unlock_state = STATE_KEY_PRESSED;
350 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);
354 if (clear_indicator_timeout) {
355 ev_timer_stop(main_loop, clear_indicator_timeout);
356 clear_indicator_timeout = NULL;
361 * A visibility notify event will be received when the visibility (= can the
362 * user view the complete window) changes, so for example when a popup overlays
363 * some area of the i3lock window.
365 * In this case, we raise our window on top so that the popup (or whatever is
366 * hiding us) gets hidden.
369 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
370 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
371 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
372 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
378 * Called when the keyboard mapping changes. We update our symbols.
381 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
382 xcb_refresh_keyboard_mapping(symbols, event);
384 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
385 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
389 * Called when the properties on the root window change, e.g. when the screen
390 * resolution changes. If so we update the window to cover the whole screen
391 * and also redraw the image, if any.
394 void handle_screen_resize() {
395 xcb_get_geometry_cookie_t geomc;
396 xcb_get_geometry_reply_t *geom;
397 geomc = xcb_get_geometry(conn, screen->root);
398 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
401 if (last_resolution[0] == geom->width &&
402 last_resolution[1] == geom->height) {
407 last_resolution[0] = geom->width;
408 last_resolution[1] = geom->height;
416 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
417 xcb_configure_window(conn, win, mask, last_resolution);
422 * Callback function for PAM. We only react on password request callbacks.
425 static int conv_callback(int num_msg, const struct pam_message **msg,
426 struct pam_response **resp, void *appdata_ptr)
431 /* PAM expects an array of responses, one for each message */
432 if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
437 for (int c = 0; c < num_msg; c++) {
438 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
439 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
442 /* return code is currently not used but should be set to zero */
443 resp[c]->resp_retcode = 0;
444 if ((resp[c]->resp = strdup(password)) == NULL) {
454 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
455 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
458 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
459 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
463 * Flush before blocking (and waiting for new events)
466 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
471 * Instead of polling the X connection socket we leave this to
472 * xcb_poll_for_event() which knows better than we can ever know.
475 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
476 xcb_generic_event_t *event;
478 while ((event = xcb_poll_for_event(conn)) != NULL) {
479 if (event->response_type == 0) {
480 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
481 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
482 error->sequence, error->error_code);
487 /* Strip off the highest bit (set if the event is generated) */
488 int type = (event->response_type & 0x7F);
490 if (type == XCB_KEY_PRESS) {
491 handle_key_press((xcb_key_press_event_t*)event);
495 if (type == XCB_KEY_RELEASE) {
496 handle_key_release((xcb_key_release_event_t*)event);
498 /* If this was the backspace or escape key we are back at an
499 * empty input, so turn off the screen if DPMS is enabled */
500 if (dpms && input_position == 0)
501 dpms_turn_off_screen(conn);
506 if (type == XCB_VISIBILITY_NOTIFY) {
507 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
511 if (type == XCB_MAP_NOTIFY) {
513 /* After the first MapNotify, we never fork again. We don’t
514 * expect to get another MapNotify, but better be sure… */
517 /* In the parent process, we exit */
524 if (type == XCB_MAPPING_NOTIFY) {
525 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
529 if (type == XCB_CONFIGURE_NOTIFY) {
530 handle_screen_resize();
534 printf("WARNING: unhandled event of type %d\n", type);
540 int main(int argc, char *argv[]) {
543 char *image_path = NULL;
546 struct pam_conv conv = {conv_callback, NULL};
548 int curs_choice = CURS_NONE;
551 struct option longopts[] = {
552 {"version", no_argument, NULL, 'v'},
553 {"nofork", no_argument, NULL, 'n'},
554 {"beep", no_argument, NULL, 'b'},
555 {"dpms", no_argument, NULL, 'd'},
556 {"color", required_argument, NULL, 'c'},
557 {"pointer", required_argument, NULL , 'p'},
558 {"debug", no_argument, NULL, 0},
559 {"help", no_argument, NULL, 'h'},
560 {"no-unlock-indicator", no_argument, NULL, 'u'},
562 {"image", required_argument, NULL, 'i'},
563 {"tiling", no_argument, NULL, 't'},
565 {NULL, no_argument, NULL, 0}
568 if ((username = getenv("USER")) == NULL)
569 errx(1, "USER environment variable not set, please set it.\n");
571 while ((o = getopt_long(argc, argv, "hvnbdc:p:u"
575 , longopts, &optind)) != -1) {
578 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
591 /* Skip # if present */
595 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
596 errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
601 unlock_indicator = false;
605 image_path = strdup(optarg);
612 if (!strcmp(optarg, "win")) {
613 curs_choice = CURS_WIN;
614 } else if (!strcmp(optarg, "default")) {
615 curs_choice = CURS_DEFAULT;
617 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
621 if (strcmp(longopts[optind].name, "debug") == 0)
625 errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
627 " [-i image.png] [-t]"
629 " (compiled with NOLIBCAIRO)"
635 /* We need (relatively) random numbers for highlighting a random part of
636 * the unlock indicator upon keypresses. */
640 ret = pam_start("i3lock", username, &conv, &pam_handle);
641 if (ret != PAM_SUCCESS)
642 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
644 /* Lock the area where we store the password in memory, we don’t want it to
645 * be swapped to disk. Since Linux 2.6.9, this does not require any
646 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
647 if (mlock(password, sizeof(password)) != 0)
648 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
650 /* Initialize connection to X11 */
651 if ((conn = xcb_connect(NULL, &nscreen)) == NULL ||
652 xcb_connection_has_error(conn))
653 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
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)) && !dpmsr->capable) {
660 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
665 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
667 last_resolution[0] = screen->width_in_pixels;
668 last_resolution[1] = screen->height_in_pixels;
673 /* Create a pixmap to render on, fill it with the background color */
674 img = cairo_image_surface_create_from_png(image_path);
678 /* Pixmap on which the image is rendered to (if any) */
679 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
681 /* open the fullscreen window, already with the correct pixmap in place */
682 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
683 xcb_free_pixmap(conn, bg_pixmap);
685 cursor = create_cursor(conn, screen, win, curs_choice);
687 grab_pointer_and_keyboard(conn, screen, cursor);
689 symbols = xcb_key_symbols_alloc(conn);
690 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
691 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
694 dpms_turn_off_screen(conn);
696 /* Initialize the libev event loop. */
697 main_loop = EV_DEFAULT;
698 if (main_loop == NULL)
699 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
701 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
702 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
703 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
705 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
706 ev_io_start(main_loop, xcb_watcher);
708 ev_check_init(xcb_check, xcb_check_cb);
709 ev_check_start(main_loop, xcb_check);
711 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
712 ev_prepare_start(main_loop, xcb_prepare);
715 ev_loop(main_loop, 0);