2 * vim:ts=4:sw=4:expandtab
4 * © 2010 Michael Stapelberg
6 * See LICENSE for licensing information
12 #include <sys/types.h>
21 #include <security/pam_appl.h>
26 #include <xkbcommon/xkbcommon.h>
27 #include <xkbcommon/xkbcommon-compose.h>
28 #include <xkbcommon/xkbcommon-x11.h>
30 #include <cairo/cairo-xcb.h>
35 #include "unlock_indicator.h"
38 #define TSTAMP_N_SECS(n) (n * 1.0)
39 #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n))
40 #define START_TIMER(timer_obj, timeout, callback) \
41 timer_obj = start_timer(timer_obj, timeout, callback)
42 #define STOP_TIMER(timer_obj) \
43 timer_obj = stop_timer(timer_obj)
45 typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents);
47 char color[7] = "ffffff";
48 int inactivity_timeout = 30;
49 uint32_t last_resolution[2];
51 static xcb_cursor_t cursor;
52 static pam_handle_t *pam_handle;
53 int input_position = 0;
54 /* Holds the password you enter (in UTF-8). */
55 static char password[512];
56 static bool beep = false;
57 bool debug_mode = false;
58 bool unlock_indicator = true;
59 char *modifier_string = NULL;
60 static bool dont_fork = false;
61 struct ev_loop *main_loop;
62 static struct ev_timer *clear_pam_wrong_timeout;
63 static struct ev_timer *clear_indicator_timeout;
64 static struct ev_timer *discard_passwd_timeout;
65 extern unlock_state_t unlock_state;
66 extern pam_state_t pam_state;
67 int failed_attempts = 0;
68 bool show_failed_attempts = false;
70 static struct xkb_state *xkb_state;
71 static struct xkb_context *xkb_context;
72 static struct xkb_keymap *xkb_keymap;
73 static struct xkb_compose_table *xkb_compose_table;
74 static struct xkb_compose_state *xkb_compose_state;
75 static uint8_t xkb_base_event;
76 static uint8_t xkb_base_error;
78 cairo_surface_t *img = NULL;
80 bool ignore_empty_password = false;
81 bool skip_repeated_empty_password = false;
83 /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
84 #define isutf(c) (((c)&0xC0) != 0x80)
87 * Decrements i to point to the previous unicode glyph
90 void u8_dec(char *s, int *i) {
91 (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
95 * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
96 * Necessary so that we can properly let xkbcommon track the keyboard state and
97 * translate keypresses to utf-8.
100 static bool load_keymap(void) {
101 if (xkb_context == NULL) {
102 if ((xkb_context = xkb_context_new(0)) == NULL) {
103 fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
108 xkb_keymap_unref(xkb_keymap);
110 int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn);
111 DEBUG("device = %d\n", device_id);
112 if ((xkb_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
113 fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n");
117 struct xkb_state *new_state =
118 xkb_x11_state_new_from_device(xkb_keymap, conn, device_id);
119 if (new_state == NULL) {
120 fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n");
124 xkb_state_unref(xkb_state);
125 xkb_state = new_state;
131 * Loads the XKB compose table from the given locale.
134 static bool load_compose_table(const char *locale) {
135 xkb_compose_table_unref(xkb_compose_table);
137 if ((xkb_compose_table = xkb_compose_table_new_from_locale(xkb_context, locale, 0)) == NULL) {
138 fprintf(stderr, "[i3lock] xkb_compose_table_new_from_locale failed\n");
142 struct xkb_compose_state *new_compose_state = xkb_compose_state_new(xkb_compose_table, 0);
143 if (new_compose_state == NULL) {
144 fprintf(stderr, "[i3lock] xkb_compose_state_new failed\n");
148 xkb_compose_state_unref(xkb_compose_state);
149 xkb_compose_state = new_compose_state;
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;
171 ev_timer *start_timer(ev_timer *timer_obj, ev_tstamp timeout, ev_callback_t callback) {
173 ev_timer_stop(main_loop, timer_obj);
174 ev_timer_set(timer_obj, timeout, 0.);
175 ev_timer_start(main_loop, timer_obj);
177 /* When there is no memory, we just don’t have a timeout. We cannot
178 * exit() here, since that would effectively unlock the screen. */
179 timer_obj = calloc(sizeof(struct ev_timer), 1);
181 ev_timer_init(timer_obj, callback, timeout, 0.);
182 ev_timer_start(main_loop, timer_obj);
188 ev_timer *stop_timer(ev_timer *timer_obj) {
190 ev_timer_stop(main_loop, timer_obj);
197 * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccessful
198 * authentication event.
201 static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
202 DEBUG("clearing pam wrong\n");
203 pam_state = STATE_PAM_IDLE;
206 /* Clear modifier string. */
207 if (modifier_string != NULL) {
208 free(modifier_string);
209 modifier_string = NULL;
212 /* Now free this timeout. */
213 STOP_TIMER(clear_pam_wrong_timeout);
216 static void clear_indicator_cb(EV_P_ ev_timer *w, int revents) {
218 STOP_TIMER(clear_indicator_timeout);
221 static void clear_input(void) {
223 clear_password_memory();
224 password[input_position] = '\0';
227 static void discard_passwd_cb(EV_P_ ev_timer *w, int revents) {
229 STOP_TIMER(discard_passwd_timeout);
232 static void input_done(void) {
233 STOP_TIMER(clear_pam_wrong_timeout);
234 pam_state = STATE_PAM_VERIFY;
235 unlock_state = STATE_STARTED;
238 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
239 DEBUG("successfully authenticated\n");
240 clear_password_memory();
242 /* PAM credentials should be refreshed, this will for example update any kerberos tickets.
243 * Related to credentials pam_end() needs to be called to cleanup any temporary
244 * credentials like kerberos /tmp/krb5cc_pam_* files which may of been left behind if the
245 * refresh of the credentials failed. */
246 pam_setcred(pam_handle, PAM_REFRESH_CRED);
247 pam_end(pam_handle, PAM_SUCCESS);
253 fprintf(stderr, "Authentication failure\n");
255 /* Get state of Caps and Num lock modifiers, to be displayed in
256 * STATE_PAM_WRONG state */
257 xkb_mod_index_t idx, num_mods;
258 const char *mod_name;
260 num_mods = xkb_keymap_num_mods(xkb_keymap);
262 for (idx = 0; idx < num_mods; idx++) {
263 if (!xkb_state_mod_index_is_active(xkb_state, idx, XKB_STATE_MODS_EFFECTIVE))
266 mod_name = xkb_keymap_mod_get_name(xkb_keymap, idx);
267 if (mod_name == NULL)
270 /* Replace certain xkb names with nicer, human-readable ones. */
271 if (strcmp(mod_name, XKB_MOD_NAME_CAPS) == 0)
272 mod_name = "Caps Lock";
273 else if (strcmp(mod_name, XKB_MOD_NAME_ALT) == 0)
275 else if (strcmp(mod_name, XKB_MOD_NAME_NUM) == 0)
276 mod_name = "Num Lock";
277 else if (strcmp(mod_name, XKB_MOD_NAME_LOGO) == 0)
281 if (modifier_string == NULL) {
282 if (asprintf(&tmp, "%s", mod_name) != -1)
283 modifier_string = tmp;
284 } else if (asprintf(&tmp, "%s, %s", modifier_string, mod_name) != -1) {
285 free(modifier_string);
286 modifier_string = tmp;
290 pam_state = STATE_PAM_WRONG;
291 failed_attempts += 1;
293 if (unlock_indicator)
296 /* Clear this state after 2 seconds (unless the user enters another
297 * password during that time). */
298 ev_now_update(main_loop);
299 START_TIMER(clear_pam_wrong_timeout, TSTAMP_N_SECS(2), clear_pam_wrong);
301 /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
303 STOP_TIMER(clear_indicator_timeout);
305 /* beep on authentication failure, if enabled */
312 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
317 static bool skip_without_validation(void) {
318 if (input_position != 0)
321 if (skip_repeated_empty_password || ignore_empty_password)
328 * Handle key presses. Fixes state, then looks up the key symbol for the
329 * given keycode, then looks up the key symbol (as UCS-2), converts it to
330 * UTF-8 and stores it in the password array.
333 static void handle_key_press(xcb_key_press_event_t *event) {
338 bool composed = false;
340 ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
341 ctrl = xkb_state_mod_name_is_active(xkb_state, XKB_MOD_NAME_CTRL, XKB_STATE_MODS_DEPRESSED);
343 /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
344 memset(buffer, '\0', sizeof(buffer));
346 if (xkb_compose_state && xkb_compose_state_feed(xkb_compose_state, ksym) == XKB_COMPOSE_FEED_ACCEPTED) {
347 switch (xkb_compose_state_get_status(xkb_compose_state)) {
348 case XKB_COMPOSE_NOTHING:
350 case XKB_COMPOSE_COMPOSING:
352 case XKB_COMPOSE_COMPOSED:
353 /* xkb_compose_state_get_utf8 doesn't include the terminating byte in the return value
354 * as xkb_keysym_to_utf8 does. Adding one makes the variable n consistent. */
355 n = xkb_compose_state_get_utf8(xkb_compose_state, buffer, sizeof(buffer)) + 1;
356 ksym = xkb_compose_state_get_one_sym(xkb_compose_state);
359 case XKB_COMPOSE_CANCELLED:
360 xkb_compose_state_reset(xkb_compose_state);
366 n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
372 case XKB_KEY_KP_Enter:
373 case XKB_KEY_XF86ScreenSaver:
374 if (ksym == XKB_KEY_j && !ctrl)
377 if (pam_state == STATE_PAM_WRONG)
380 if (skip_without_validation()) {
384 password[input_position] = '\0';
385 unlock_state = STATE_KEY_PRESSED;
388 skip_repeated_empty_password = true;
391 skip_repeated_empty_password = false;
397 if ((ksym == XKB_KEY_u && ctrl) ||
398 ksym == XKB_KEY_Escape) {
399 DEBUG("C-u pressed\n");
401 /* Hide the unlock indicator after a bit if the password buffer is
403 if (unlock_indicator) {
404 START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
405 unlock_state = STATE_BACKSPACE_ACTIVE;
407 unlock_state = STATE_KEY_PRESSED;
414 case XKB_KEY_KP_Delete:
415 /* Deleting forward doesn’t make sense, as i3lock doesn’t allow you
416 * to move the cursor when entering a password. We need to eat this
417 * key press so that it won’t be treated as part of the password,
422 case XKB_KEY_BackSpace:
423 if (ksym == XKB_KEY_h && !ctrl)
426 if (input_position == 0)
429 /* decrement input_position to point to the previous glyph */
430 u8_dec(password, &input_position);
431 password[input_position] = '\0';
433 /* Hide the unlock indicator after a bit if the password buffer is
435 START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
436 unlock_state = STATE_BACKSPACE_ACTIVE;
438 unlock_state = STATE_KEY_PRESSED;
442 if ((input_position + 8) >= sizeof(password))
446 /* FIXME: handle all of these? */
447 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
448 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
449 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
450 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
451 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
452 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
453 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
459 /* store it in the password array as UTF-8 */
460 memcpy(password + input_position, buffer, n - 1);
461 input_position += n - 1;
462 DEBUG("current password = %.*s\n", input_position, password);
464 if (unlock_indicator) {
465 unlock_state = STATE_KEY_ACTIVE;
467 unlock_state = STATE_KEY_PRESSED;
469 struct ev_timer *timeout = NULL;
470 START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout);
471 STOP_TIMER(clear_indicator_timeout);
474 START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
478 * A visibility notify event will be received when the visibility (= can the
479 * user view the complete window) changes, so for example when a popup overlays
480 * some area of the i3lock window.
482 * In this case, we raise our window on top so that the popup (or whatever is
483 * hiding us) gets hidden.
486 static void handle_visibility_notify(xcb_connection_t *conn,
487 xcb_visibility_notify_event_t *event) {
488 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
489 uint32_t values[] = {XCB_STACK_MODE_ABOVE};
490 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
496 * Called when the keyboard mapping changes. We update our symbols.
498 * We ignore errors — if the new keymap cannot be loaded it’s better if the
499 * screen stays locked and the user intervenes by using killall i3lock.
502 static void process_xkb_event(xcb_generic_event_t *gevent) {
505 uint8_t response_type;
508 xcb_timestamp_t time;
511 xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify;
512 xcb_xkb_map_notify_event_t map_notify;
513 xcb_xkb_state_notify_event_t state_notify;
514 } *event = (union xkb_event *)gevent;
516 DEBUG("process_xkb_event for device %d\n", event->any.deviceID);
518 if (event->any.deviceID != xkb_x11_get_core_keyboard_device_id(conn))
522 * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap
523 * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent
526 switch (event->any.xkbType) {
527 case XCB_XKB_NEW_KEYBOARD_NOTIFY:
528 if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES)
532 case XCB_XKB_MAP_NOTIFY:
536 case XCB_XKB_STATE_NOTIFY:
537 xkb_state_update_mask(xkb_state,
538 event->state_notify.baseMods,
539 event->state_notify.latchedMods,
540 event->state_notify.lockedMods,
541 event->state_notify.baseGroup,
542 event->state_notify.latchedGroup,
543 event->state_notify.lockedGroup);
549 * Called when the properties on the root window change, e.g. when the screen
550 * resolution changes. If so we update the window to cover the whole screen
551 * and also redraw the image, if any.
554 void handle_screen_resize(void) {
555 xcb_get_geometry_cookie_t geomc;
556 xcb_get_geometry_reply_t *geom;
557 geomc = xcb_get_geometry(conn, screen->root);
558 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
561 if (last_resolution[0] == geom->width &&
562 last_resolution[1] == geom->height) {
567 last_resolution[0] = geom->width;
568 last_resolution[1] = geom->height;
574 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
575 xcb_configure_window(conn, win, mask, last_resolution);
578 xinerama_query_screens();
583 * Callback function for PAM. We only react on password request callbacks.
586 static int conv_callback(int num_msg, const struct pam_message **msg,
587 struct pam_response **resp, void *appdata_ptr) {
591 /* PAM expects an array of responses, one for each message */
592 if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
597 for (int c = 0; c < num_msg; c++) {
598 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
599 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
602 /* return code is currently not used but should be set to zero */
603 resp[c]->resp_retcode = 0;
604 if ((resp[c]->resp = strdup(password)) == NULL) {
614 * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
615 * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
618 static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
619 /* empty, because xcb_prepare_cb and xcb_check_cb are used */
623 * Flush before blocking (and waiting for new events)
626 static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
631 * Try closing logind sleep lock fd passed over from xss-lock, in case we're
632 * being run from there.
635 static void maybe_close_sleep_lock_fd(void) {
636 const char *sleep_lock_fd = getenv("XSS_SLEEP_LOCK_FD");
638 if (sleep_lock_fd && *sleep_lock_fd != 0) {
639 long int fd = strtol(sleep_lock_fd, &endptr, 10);
647 * Instead of polling the X connection socket we leave this to
648 * xcb_poll_for_event() which knows better than we can ever know.
651 static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
652 xcb_generic_event_t *event;
654 if (xcb_connection_has_error(conn))
655 errx(EXIT_FAILURE, "X11 connection broke, did your server terminate?\n");
657 while ((event = xcb_poll_for_event(conn)) != NULL) {
658 if (event->response_type == 0) {
659 xcb_generic_error_t *error = (xcb_generic_error_t *)event;
661 fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
662 error->sequence, error->error_code);
667 /* Strip off the highest bit (set if the event is generated) */
668 int type = (event->response_type & 0x7F);
672 handle_key_press((xcb_key_press_event_t *)event);
675 case XCB_VISIBILITY_NOTIFY:
676 handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
680 maybe_close_sleep_lock_fd();
682 /* After the first MapNotify, we never fork again. We don’t
683 * expect to get another MapNotify, but better be sure… */
686 /* In the parent process, we exit */
690 ev_loop_fork(EV_DEFAULT);
694 case XCB_CONFIGURE_NOTIFY:
695 handle_screen_resize();
699 if (type == xkb_base_event)
700 process_xkb_event(event);
708 * This function is called from a fork()ed child and will raise the i3lock
709 * window when the window is obscured, even when the main i3lock process is
710 * blocked due to PAM.
713 static void raise_loop(xcb_window_t window) {
714 xcb_connection_t *conn;
715 xcb_generic_event_t *event;
718 if ((conn = xcb_connect(NULL, &screens)) == NULL ||
719 xcb_connection_has_error(conn))
720 errx(EXIT_FAILURE, "Cannot open display\n");
722 /* We need to know about the window being obscured or getting destroyed. */
723 xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK,
725 XCB_EVENT_MASK_VISIBILITY_CHANGE |
726 XCB_EVENT_MASK_STRUCTURE_NOTIFY});
729 DEBUG("Watching window 0x%08x\n", window);
730 while ((event = xcb_wait_for_event(conn)) != NULL) {
731 if (event->response_type == 0) {
732 xcb_generic_error_t *error = (xcb_generic_error_t *)event;
733 DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n",
734 error->sequence, error->error_code);
738 /* Strip off the highest bit (set if the event is generated) */
739 int type = (event->response_type & 0x7F);
740 DEBUG("Read event of type %d\n", type);
742 case XCB_VISIBILITY_NOTIFY:
743 handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
745 case XCB_UNMAP_NOTIFY:
746 DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t *)event)->window));
747 if (((xcb_unmap_notify_event_t *)event)->window == window)
750 case XCB_DESTROY_NOTIFY:
751 DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t *)event)->window));
752 if (((xcb_destroy_notify_event_t *)event)->window == window)
756 DEBUG("Unhandled event type %d\n", type);
763 int main(int argc, char *argv[]) {
766 char *image_path = NULL;
768 struct pam_conv conv = {conv_callback, NULL};
769 int curs_choice = CURS_NONE;
772 struct option longopts[] = {
773 {"version", no_argument, NULL, 'v'},
774 {"nofork", no_argument, NULL, 'n'},
775 {"beep", no_argument, NULL, 'b'},
776 {"dpms", no_argument, NULL, 'd'},
777 {"color", required_argument, NULL, 'c'},
778 {"pointer", required_argument, NULL, 'p'},
779 {"debug", no_argument, NULL, 0},
780 {"help", no_argument, NULL, 'h'},
781 {"no-unlock-indicator", no_argument, NULL, 'u'},
782 {"image", required_argument, NULL, 'i'},
783 {"tiling", no_argument, NULL, 't'},
784 {"ignore-empty-password", no_argument, NULL, 'e'},
785 {"inactivity-timeout", required_argument, NULL, 'I'},
786 {"show-failed-attempts", no_argument, NULL, 'f'},
787 {NULL, no_argument, NULL, 0}};
789 if ((pw = getpwuid(getuid())) == NULL)
790 err(EXIT_FAILURE, "getpwuid() failed");
791 if ((username = pw->pw_name) == NULL)
792 errx(EXIT_FAILURE, "pw->pw_name is NULL.\n");
794 char *optstring = "hvnbdc:p:ui:teI:f";
795 while ((o = getopt_long(argc, argv, optstring, longopts, &optind)) != -1) {
798 errx(EXIT_SUCCESS, "version " VERSION " © 2010 Michael Stapelberg");
806 fprintf(stderr, "DPMS support has been removed from i3lock. Please see the manpage i3lock(1).\n");
810 if (sscanf(optarg, "%d", &time) != 1 || time < 0)
811 errx(EXIT_FAILURE, "invalid timeout, it must be a positive integer\n");
812 inactivity_timeout = time;
818 /* Skip # if present */
822 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
823 errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
828 unlock_indicator = false;
831 image_path = strdup(optarg);
837 if (!strcmp(optarg, "win")) {
838 curs_choice = CURS_WIN;
839 } else if (!strcmp(optarg, "default")) {
840 curs_choice = CURS_DEFAULT;
842 errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
846 ignore_empty_password = true;
849 if (strcmp(longopts[optind].name, "debug") == 0)
853 show_failed_attempts = true;
856 errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
857 " [-i image.png] [-t] [-e] [-I timeout] [-f]");
861 /* We need (relatively) random numbers for highlighting a random part of
862 * the unlock indicator upon keypresses. */
866 if ((ret = pam_start("i3lock", username, &conv, &pam_handle)) != PAM_SUCCESS)
867 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
869 if ((ret = pam_set_item(pam_handle, PAM_TTY, getenv("DISPLAY"))) != PAM_SUCCESS)
870 errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
872 /* Using mlock() as non-super-user seems only possible in Linux. Users of other
873 * operating systems should use encrypted swap/no swap (or remove the ifdef and
874 * run i3lock as super-user). */
875 #if defined(__linux__)
876 /* Lock the area where we store the password in memory, we don’t want it to
877 * be swapped to disk. Since Linux 2.6.9, this does not require any
878 * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
879 if (mlock(password, sizeof(password)) != 0)
880 err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
883 /* Double checking that connection is good and operatable with xcb */
885 if ((conn = xcb_connect(NULL, &screennr)) == NULL ||
886 xcb_connection_has_error(conn))
887 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
889 if (xkb_x11_setup_xkb_extension(conn,
890 XKB_X11_MIN_MAJOR_XKB_VERSION,
891 XKB_X11_MIN_MINOR_XKB_VERSION,
896 &xkb_base_error) != 1)
897 errx(EXIT_FAILURE, "Could not setup XKB extension.");
899 static const xcb_xkb_map_part_t required_map_parts =
900 (XCB_XKB_MAP_PART_KEY_TYPES |
901 XCB_XKB_MAP_PART_KEY_SYMS |
902 XCB_XKB_MAP_PART_MODIFIER_MAP |
903 XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
904 XCB_XKB_MAP_PART_KEY_ACTIONS |
905 XCB_XKB_MAP_PART_VIRTUAL_MODS |
906 XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
908 static const xcb_xkb_event_type_t required_events =
909 (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY |
910 XCB_XKB_EVENT_TYPE_MAP_NOTIFY |
911 XCB_XKB_EVENT_TYPE_STATE_NOTIFY);
913 xcb_xkb_select_events(
915 xkb_x11_get_core_keyboard_device_id(conn),
923 /* When we cannot initially load the keymap, we better exit */
925 errx(EXIT_FAILURE, "Could not load keymap");
927 const char *locale = getenv("LC_ALL");
929 locale = getenv("LC_CTYPE");
931 locale = getenv("LANG");
934 fprintf(stderr, "Can't detect your locale, fallback to C\n");
938 load_compose_table(locale);
941 xinerama_query_screens();
943 screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
945 last_resolution[0] = screen->width_in_pixels;
946 last_resolution[1] = screen->height_in_pixels;
948 xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
949 (uint32_t[]){XCB_EVENT_MASK_STRUCTURE_NOTIFY});
952 /* Create a pixmap to render on, fill it with the background color */
953 img = cairo_image_surface_create_from_png(image_path);
954 /* In case loading failed, we just pretend no -i was specified. */
955 if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
956 fprintf(stderr, "Could not load image \"%s\": %s\n",
957 image_path, cairo_status_to_string(cairo_surface_status(img)));
962 /* Pixmap on which the image is rendered to (if any) */
963 xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
965 /* open the fullscreen window, already with the correct pixmap in place */
966 win = open_fullscreen_window(conn, screen, color, bg_pixmap);
967 xcb_free_pixmap(conn, bg_pixmap);
970 /* The pid == -1 case is intentionally ignored here:
971 * While the child process is useful for preventing other windows from
972 * popping up while i3lock blocks, it is not critical. */
975 close(xcb_get_file_descriptor(conn));
976 maybe_close_sleep_lock_fd();
981 cursor = create_cursor(conn, screen, win, curs_choice);
983 grab_pointer_and_keyboard(conn, screen, cursor);
984 /* Load the keymap again to sync the current modifier state. Since we first
985 * loaded the keymap, there might have been changes, but starting from now,
986 * we should get all key presses/releases due to having grabbed the
990 /* Initialize the libev event loop. */
991 main_loop = EV_DEFAULT;
992 if (main_loop == NULL)
993 errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
995 struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
996 struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
997 struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
999 ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
1000 ev_io_start(main_loop, xcb_watcher);
1002 ev_check_init(xcb_check, xcb_check_cb);
1003 ev_check_start(main_loop, xcb_check);
1005 ev_prepare_init(xcb_prepare, xcb_prepare_cb);
1006 ev_prepare_start(main_loop, xcb_prepare);
1008 /* Invoke the event callback once to catch all the events which were
1009 * received up until now. ev will only pick up new events (when the X11
1010 * file descriptor becomes readable). */
1011 ev_invoke(main_loop, xcb_check, 0);
1012 ev_loop(main_loop, 0);