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/Xutil.h>
23 #include <X11/keysym.h>
32 #include <cairo/cairo-xcb.h>
35 #include "keysym2ucs.h"
36 #include "ucs2_to_utf8.h"
39 #include "unlock_indicator.h"
42 char color[7] = "ffffff";
43 uint32_t last_resolution[2];
45 static xcb_cursor_t cursor;
46 static xcb_key_symbols_t *symbols;
47 static pam_handle_t *pam_handle;
48 int input_position = 0;
49 /* Holds the password you enter (in UTF-8). */
50 static char password[512];
51 static bool modeswitch_active = false;
52 static bool iso_level3_shift_active = false;
53 static bool iso_level5_shift_active = false;
54 static int numlockmask;
55 static int shiftlockmask;
56 static int capslockmask;
57 static bool beep = false;
58 static bool debug_mode = false;
59 static bool dpms = false;
60 bool unlock_indicator = true;
61 static bool dont_fork = false;
62 struct ev_loop *main_loop;
63 static struct ev_timer *clear_pam_wrong_timeout;
64 extern unlock_state_t unlock_state;
65 extern pam_state_t pam_state;
67 #define DEBUG(fmt, ...) do { \
69 printf("[i3lock-debug] " fmt, ##__VA_ARGS__); \
73 cairo_surface_t *img = NULL;
78 * Clears the memory which stored the password to be a bit safer against
82 static void clear_password_memory() {
83 /* A volatile pointer to the password buffer to prevent the compiler from
84 * optimizing this out. */
85 volatile char *vpassword = password;
86 for (int c = 0; c < sizeof(password); c++)
87 /* We store a non-random pattern which consists of the (irrelevant)
88 * index plus (!) the value of the beep variable. This prevents the
89 * compiler from optimizing the calls away, since the value of 'beep'
90 * is not known at compile-time. */
91 vpassword[c] = c + (int)beep;
96 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful
97 * authentication event.
100 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
101 DEBUG("clearing pam wrong\n");
102 pam_state = STATE_PAM_IDLE;
103 unlock_state = STATE_STARTED;
106 /* Now free this timeout. */
107 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
108 free(clear_pam_wrong_timeout);
109 clear_pam_wrong_timeout = NULL;
112 static void input_done() {
113 if (input_position == 0)
116 if (clear_pam_wrong_timeout) {
117 ev_timer_stop(main_loop, clear_pam_wrong_timeout);
118 free(clear_pam_wrong_timeout);
119 clear_pam_wrong_timeout = NULL;
122 pam_state = STATE_PAM_VERIFY;
125 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
126 printf("successfully authenticated\n");
127 clear_password_memory();
131 fprintf(stderr, "Authentication failure\n");
133 pam_state = STATE_PAM_WRONG;
136 /* Clear this state after 2 seconds (unless the user enters another
137 * password during that time). */
138 ev_now_update(main_loop);
139 if ((clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1))) {
140 ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.);
141 ev_timer_start(main_loop, clear_pam_wrong_timeout);
144 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
146 stop_clear_indicator_timeout();
148 /* beep on authentication failure, if enabled */
156 * Called when the user releases a key. We need to leave the Mode_switch
157 * state when the user releases the Mode_switch key.
160 static void handle_key_release(xcb_key_release_event_t *event) {
161 DEBUG("releasing key %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
162 event->detail, event->state, modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
164 /* We don’t care about the column here and just use the first symbol. Since
165 * we only check for Mode_switch and ISO_Level3_Shift, this *should* work.
166 * Also, if we would use the current column, we would look in the wrong
168 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, 0);
169 if (sym == XK_Mode_switch) {
170 //printf("Mode switch disabled\n");
171 modeswitch_active = false;
172 } else if (sym == XK_ISO_Level3_Shift) {
173 iso_level3_shift_active = false;
174 } else if (sym == XK_ISO_Level5_Shift) {
175 iso_level5_shift_active = false;
177 DEBUG("release done. modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
178 modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
181 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
184 ev_timer_stop(main_loop, w);
189 * Handle key presses. Fixes state, then looks up the key symbol for the
190 * given keycode, then looks up the key symbol (as UCS-2), converts it to
191 * UTF-8 and stores it in the password array.
194 static void handle_key_press(xcb_key_press_event_t *event) {
195 DEBUG("keypress %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d\n",
196 event->detail, event->state, modeswitch_active, iso_level3_shift_active);
198 xcb_keysym_t sym0, sym1, sym;
199 /* For each keycode, there is a list of symbols. The list could look like this:
200 * $ xmodmap -pke | grep 'keycode 38'
201 * keycode 38 = a A adiaeresis Adiaeresis o O
202 * In non-X11 terminology, the symbols for the keycode 38 (the key labeled
203 * with "a" on my keyboard) are "a A ä Ä o O".
204 * Another form to display the same information is using xkbcomp:
205 * $ xkbcomp $DISPLAY /tmp/xkb.dump
206 * Then open /tmp/xkb.dump and search for '\<a\>' (in VIM regexp-language):
208 * symbols[Group1]= [ a, A, o, O ],
209 * symbols[Group2]= [ adiaeresis, Adiaeresis ]
211 * So there are two *groups*, one containing 'a A' and one containing 'ä
212 * Ä'. You can use Mode_switch to switch between these groups. You can use
213 * ISO_Level3_Shift to reach the 'o O' part of the first group (it’s the
214 * same group, just an even higher shift level).
216 * So, using the "logical" XKB information, the following lookup will be
219 * Neither Mode_switch nor ISO_Level3_Shift active: group 1, column 0 and 1
220 * Mode_switch active: group 2, column 0 and 1
221 * ISO_Level3_Shift active: group 1, column 2 and 3
223 * Using the column index which xcb_key_press_lookup_keysym uses (and
224 * xmodmap prints out), the following lookup will be performed:
226 * Neither Mode_switch nor ISO_Level3_Shift active: column 0 and 1
227 * Mode_switch active: column 2 and 3
228 * ISO_Level3_Shift active: column 4 and 5
231 if (modeswitch_active)
233 if (iso_level3_shift_active)
235 if (iso_level5_shift_active)
237 sym0 = xcb_key_press_lookup_keysym(symbols, event, base_column);
238 sym1 = xcb_key_press_lookup_keysym(symbols, event, base_column + 1);
241 DEBUG("Mode switch enabled\n");
242 modeswitch_active = true;
244 case XK_ISO_Level3_Shift:
245 DEBUG("ISO_Level3_Shift enabled\n");
246 iso_level3_shift_active = true;
248 case XK_ISO_Level5_Shift:
249 DEBUG("ISO_Level5_Shift enabled\n");
250 iso_level5_shift_active = true;
257 clear_password_memory();
258 password[input_position] = '\0';
260 /* Hide the unlock indicator after a bit if the password buffer is
262 start_clear_indicator_timeout();
263 unlock_state = STATE_BACKSPACE_ACTIVE;
265 unlock_state = STATE_KEY_PRESSED;
269 if (input_position == 0)
272 /* decrement input_position to point to the previous glyph */
273 u8_dec(password, &input_position);
274 password[input_position] = '\0';
276 /* Hide the unlock indicator after a bit if the password buffer is
278 start_clear_indicator_timeout();
279 unlock_state = STATE_BACKSPACE_ACTIVE;
281 unlock_state = STATE_KEY_PRESSED;
285 if ((input_position + 8) >= sizeof(password))
288 /* Whether the user currently holds down the shift key. */
289 bool shift = (event->state & XCB_MOD_MASK_SHIFT);
291 /* Whether Caps Lock (all lowercase alphabetic keys will be replaced by
292 * their uppercase variant) is active at the moment. */
293 bool capslock = (event->state & capslockmask);
295 /* Whether Shift Lock (shift state is reversed) is active at the moment. */
296 bool shiftlock = (event->state & shiftlockmask);
298 /* Whether Caps Lock or Shift Lock is active at the moment. */
299 bool lock = (capslock || shiftlock);
301 DEBUG("shift = %d, lock = %d, capslock = %d, shiftlock = %d\n",
302 shift, lock, capslock, shiftlock);
304 if ((event->state & numlockmask) && xcb_is_keypad_key(sym1)) {
305 /* this key was a keypad key */
306 if (shift || shiftlock)
310 xcb_keysym_t upper, lower;
311 XConvertCase(sym0, (KeySym*)&lower, (KeySym*)&upper);
312 DEBUG("sym0 = %c (%d), sym1 = %c (%d), lower = %c (%d), upper = %c (%d)\n",
313 sym0, sym0, sym1, sym1, lower, lower, upper, upper);
314 /* If there is no difference between the uppercase and lowercase
315 * variant of this key, we consider Caps Lock off — it is only relevant
316 * for alphabetic keys, unlike Shift Lock. */
317 if (lower == upper) {
319 lock = (capslock || shiftlock);
320 DEBUG("lower == upper, now shift = %d, lock = %d, capslock = %d, shiftlock = %d\n",
321 shift, lock, capslock, shiftlock);
324 /* In two different cases we need to use the uppercase keysym:
325 * 1) The user holds shift, no lock is active.
326 * 2) Any of the two locks is active.
328 if ((shift && !lock) || (!shift && lock))
334 /* FIXME: handle all of these? */
335 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
336 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
337 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
338 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
339 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
340 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
341 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
344 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
347 DEBUG("resolved to keysym = %c (%d)\n", sym, sym);
349 /* convert the keysym to UCS */
350 uint16_t ucs = keysym2ucs(sym);
351 if ((int16_t)ucs == -1) {
352 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
356 /* store the UCS in a string to convert it */
357 uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
358 DEBUG("input part = %s\n", inp);
360 /* store it in the password array as UTF-8 */
361 input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
362 password[input_position] = '\0';
363 DEBUG("current password = %s\n", password);
365 unlock_state = STATE_KEY_ACTIVE;
367 unlock_state = STATE_KEY_PRESSED;
369 struct ev_timer *timeout = calloc(sizeof(struct ev_timer), 1);
371 ev_timer_init(timeout, redraw_timeout, 0.25, 0.);
372 ev_timer_start(main_loop, timeout);
375 stop_clear_indicator_timeout();
379 * A visibility notify event will be received when the visibility (= can the
380 * user view the complete window) changes, so for example when a popup overlays
381 * some area of the i3lock window.
383 * In this case, we raise our window on top so that the popup (or whatever is
384 * hiding us) gets hidden.
387 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
388 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
389 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
390 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
396 * Called when the keyboard mapping changes. We update our symbols.
399 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
400 xcb_refresh_keyboard_mapping(symbols, event);
402 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
406 * Called when the properties on the root window change, e.g. when the screen
407 * resolution changes. If so we update the window to cover the whole screen
408 * and also redraw the image, if any.
411 void handle_screen_resize() {
412 xcb_get_geometry_cookie_t geomc;
413 xcb_get_geometry_reply_t *geom;
414 geomc = xcb_get_geometry(conn, screen->root);
415 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
418 if (last_resolution[0] == geom->width &&
419 last_resolution[1] == geom->height) {
424 last_resolution[0] = geom->width;
425 last_resolution[1] = geom->height;
433 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
434 xcb_configure_window(conn, win, mask, last_resolution);
439 * Callback function for PAM. We only react on password request callbacks.
442 static int conv_callback(int num_msg, const struct pam_message **msg,
443 struct pam_response **resp, void *appdata_ptr)
448 /* PAM expects an array of responses, one for each message */
449 if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
454 for (int c = 0; c < num_msg; c++) {
455 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
456 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
459 /* return code is currently not used but should be set to zero */
460 resp[c]->resp_retcode = 0;
461 if ((resp[c]->resp = strdup(password)) == NULL) {
471 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
472 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
475 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
476 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
480 * Flush before blocking (and waiting for new events)
483 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
488 * Instead of polling the X connection socket we leave this to
489 * xcb_poll_for_event() which knows better than we can ever know.
492 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
493 xcb_generic_event_t *event;
495 while ((event = xcb_poll_for_event(conn)) != NULL) {
496 if (event->response_type == 0) {
497 xcb_generic_error_t *error = (xcb_generic_error_t*)event;
498 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
499 error->sequence, error->error_code);
504 /* Strip off the highest bit (set if the event is generated) */
505 int type = (event->response_type & 0x7F);
508 handle_key_press((xcb_key_press_event_t*)event);
511 case XCB_KEY_RELEASE:
512 handle_key_release((xcb_key_release_event_t*)event);
514 /* If this was the backspace or escape key we are back at an
515 * empty input, so turn off the screen if DPMS is enabled */
516 if (dpms && input_position == 0)
517 dpms_turn_off_screen(conn);
521 case XCB_VISIBILITY_NOTIFY:
522 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
527 /* After the first MapNotify, we never fork again. We don’t
528 * expect to get another MapNotify, but better be sure… */
531 /* In the parent process, we exit */
537 case XCB_MAPPING_NOTIFY:
538 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
541 case XCB_CONFIGURE_NOTIFY:
542 handle_screen_resize();
550 int main(int argc, char *argv[]) {
553 char *image_path = NULL;
556 struct pam_conv conv = {conv_callback, NULL};
558 int curs_choice = CURS_NONE;
561 struct option longopts[] = {
562 {"version", no_argument, NULL, 'v'},
563 {"nofork", no_argument, NULL, 'n'},
564 {"beep", no_argument, NULL, 'b'},
565 {"dpms", no_argument, NULL, 'd'},
566 {"color", required_argument, NULL, 'c'},
567 {"pointer", required_argument, NULL , 'p'},
568 {"debug", no_argument, NULL, 0},
569 {"help", no_argument, NULL, 'h'},
570 {"no-unlock-indicator", no_argument, NULL, 'u'},
572 {"image", required_argument, NULL, 'i'},
573 {"tiling", no_argument, NULL, 't'},
575 {NULL, no_argument, NULL, 0}
578 if ((username = getenv("USER")) == NULL)
579 errx(1, "USER environment variable not set, please set it.\n");
581 while ((o = getopt_long(argc, argv, "hvnbdc:p:u"
585 , longopts, &optind)) != -1) {
588 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
601 /* Skip # if present */
605 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
606 errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
611 unlock_indicator = false;
615 image_path = strdup(optarg);
622 if (!strcmp(optarg, "win")) {
623 curs_choice = CURS_WIN;
624 } else if (!strcmp(optarg, "default")) {
625 curs_choice = CURS_DEFAULT;
627 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
631 if (strcmp(longopts[optind].name, "debug") == 0)
635 errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
637 " [-i image.png] [-t]"
639 " (compiled with NOLIBCAIRO)"
645 /* We need (relatively) random numbers for highlighting a random part of
646 * the unlock indicator upon keypresses. */
650 ret = pam_start("i3lock", username, &conv, &pam_handle);
651 if (ret != PAM_SUCCESS)
652 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
654 /* Lock the area where we store the password in memory, we don’t want it to
655 * be swapped to disk. Since Linux 2.6.9, this does not require any
656 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
657 if (mlock(password, sizeof(password)) != 0)
658 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
660 /* Initialize connection to X11 */
661 if ((conn = xcb_connect(NULL, &nscreen)) == NULL ||
662 xcb_connection_has_error(conn))
663 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
666 xinerama_query_screens();
668 /* if DPMS is enabled, check if the X server really supports it */
670 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
671 xcb_dpms_capable_reply_t *dpmsr;
672 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
673 if (!dpmsr->capable) {
674 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
681 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
683 last_resolution[0] = screen->width_in_pixels;
684 last_resolution[1] = screen->height_in_pixels;
689 /* Create a pixmap to render on, fill it with the background color */
690 img = cairo_image_surface_create_from_png(image_path);
694 /* Pixmap on which the image is rendered to (if any) */
695 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
697 /* open the fullscreen window, already with the correct pixmap in place */
698 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
699 xcb_free_pixmap(conn, bg_pixmap);
701 cursor = create_cursor(conn, screen, win, curs_choice);
703 grab_pointer_and_keyboard(conn, screen, cursor);
705 symbols = xcb_key_symbols_alloc(conn);
706 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
707 shiftlockmask = get_mod_mask(conn, symbols, XK_Shift_Lock);
708 capslockmask = get_mod_mask(conn, symbols, XK_Caps_Lock);
710 DEBUG("shift lock mask = %d\n", shiftlockmask);
711 DEBUG("caps lock mask = %d\n", capslockmask);
714 dpms_turn_off_screen(conn);
716 /* Initialize the libev event loop. */
717 main_loop = EV_DEFAULT;
718 if (main_loop == NULL)
719 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
721 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
722 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
723 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
725 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
726 ev_io_start(main_loop, xcb_watcher);
728 ev_check_init(xcb_check, xcb_check_cb);
729 ev_check_start(main_loop, xcb_check);
731 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
732 ev_prepare_start(main_loop, xcb_prepare);
734 /* Invoke the event callback once to catch all the events which were
735 * received up until now. ev will only pick up new events (when the X11
736 * file descriptor becomes readable). */
737 ev_invoke(main_loop, xcb_check, 0);
738 ev_loop(main_loop, 0);