/* * vim:ts=4:sw=4:expandtab * * © 2010 Michael Stapelberg * * See LICENSE for licensing information * */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef __OpenBSD__ #include #else #include #endif #include #include #include #include #include #include #include #include #ifdef HAVE_EXPLICIT_BZERO #include /* explicit_bzero(3) */ #endif #include #include #include "i3lock.h" #include "xcb.h" #include "cursors.h" #include "unlock_indicator.h" #include "randr.h" #include "dpi.h" #define TSTAMP_N_SECS(n) (n * 1.0) #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n)) #define START_TIMER(timer_obj, timeout, callback) \ timer_obj = start_timer(timer_obj, timeout, callback) #define STOP_TIMER(timer_obj) \ timer_obj = stop_timer(timer_obj) typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents); static void input_done(void); char color[7] = "a3a3a3"; uint32_t last_resolution[2]; xcb_window_t win; static xcb_cursor_t cursor; #ifndef __OpenBSD__ static pam_handle_t *pam_handle; static bool pam_cleanup; #endif int input_position = 0; /* Holds the password you enter (in UTF-8). */ static char password[512]; static bool beep = false; bool debug_mode = false; bool unlock_indicator = true; char *modifier_string = NULL; static bool dont_fork = false; struct ev_loop *main_loop; static struct ev_timer *clear_auth_wrong_timeout; static struct ev_timer *clear_indicator_timeout; static struct ev_timer *discard_passwd_timeout; extern unlock_state_t unlock_state; extern auth_state_t auth_state; int failed_attempts = 0; bool show_failed_attempts = false; bool show_keyboard_layout = false; bool retry_verification = false; struct xkb_state *xkb_state; static struct xkb_context *xkb_context; struct xkb_keymap *xkb_keymap; static struct xkb_compose_table *xkb_compose_table; static struct xkb_compose_state *xkb_compose_state; static uint8_t xkb_base_event; static uint8_t xkb_base_error; static int randr_base = -1; cairo_surface_t *img = NULL; bool tile = false; bool ignore_empty_password = false; bool skip_repeated_empty_password = false; /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */ #define isutf(c) (((c)&0xC0) != 0x80) /* * Decrements i to point to the previous unicode glyph * */ static void u8_dec(char *s, int *i) { (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i)); } /* * Loads the XKB keymap from the X11 server and feeds it to xkbcommon. * Necessary so that we can properly let xkbcommon track the keyboard state and * translate keypresses to utf-8. * * This function can be called when the user changes the XKB configuration, * so it must not leave unusable global state behind * */ static bool load_keymap(void) { if (xkb_context == NULL) { if ((xkb_context = xkb_context_new(0)) == NULL) { fprintf(stderr, "[i3lock] could not create xkbcommon context\n"); return false; } } int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn); DEBUG("device = %d\n", device_id); struct xkb_keymap *new_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0); if (new_keymap == NULL) { fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n"); return false; } struct xkb_state *new_state = xkb_x11_state_new_from_device(new_keymap, conn, device_id); if (new_state == NULL) { fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n"); return false; } /* Only update global state on success */ xkb_state_unref(xkb_state); xkb_keymap_unref(xkb_keymap); xkb_state = new_state; xkb_keymap = new_keymap; return true; } /* * Loads the XKB compose table from the given locale. * */ static bool load_compose_table(const char *locale) { xkb_compose_table_unref(xkb_compose_table); if ((xkb_compose_table = xkb_compose_table_new_from_locale(xkb_context, locale, 0)) == NULL) { fprintf(stderr, "[i3lock] xkb_compose_table_new_from_locale failed\n"); return false; } struct xkb_compose_state *new_compose_state = xkb_compose_state_new(xkb_compose_table, 0); if (new_compose_state == NULL) { fprintf(stderr, "[i3lock] xkb_compose_state_new failed\n"); return false; } xkb_compose_state_unref(xkb_compose_state); xkb_compose_state = new_compose_state; return true; } /* * Clears the memory which stored the password to be a bit safer against * cold-boot attacks. * */ static void clear_password_memory(void) { #ifdef HAVE_EXPLICIT_BZERO /* Use explicit_bzero(3) which was explicitly designed not to be * optimized out by the compiler. */ explicit_bzero(password, strlen(password)); #else /* A volatile pointer to the password buffer to prevent the compiler from * optimizing this out. */ volatile char *vpassword = password; for (size_t c = 0; c < sizeof(password); c++) /* We store a non-random pattern which consists of the (irrelevant) * index plus (!) the value of the beep variable. This prevents the * compiler from optimizing the calls away, since the value of 'beep' * is not known at compile-time. */ vpassword[c] = c + (int)beep; #endif } ev_timer *start_timer(ev_timer *timer_obj, ev_tstamp timeout, ev_callback_t callback) { if (timer_obj) { ev_timer_stop(main_loop, timer_obj); ev_timer_set(timer_obj, timeout, 0.); ev_timer_start(main_loop, timer_obj); } else { /* When there is no memory, we just don’t have a timeout. We cannot * exit() here, since that would effectively unlock the screen. */ timer_obj = calloc(sizeof(struct ev_timer), 1); if (timer_obj) { ev_timer_init(timer_obj, callback, timeout, 0.); ev_timer_start(main_loop, timer_obj); } } return timer_obj; } ev_timer *stop_timer(ev_timer *timer_obj) { if (timer_obj) { ev_timer_stop(main_loop, timer_obj); free(timer_obj); } return NULL; } /* * Neccessary calls after ending input via enter or others * */ static void finish_input(void) { password[input_position] = '\0'; unlock_state = STATE_KEY_PRESSED; redraw_screen(); input_done(); } /* * Resets auth_state to STATE_AUTH_IDLE 2 seconds after an unsuccessful * authentication event. * */ static void clear_auth_wrong(EV_P_ ev_timer *w, int revents) { DEBUG("clearing auth wrong\n"); auth_state = STATE_AUTH_IDLE; redraw_screen(); /* Clear modifier string. */ if (modifier_string != NULL) { free(modifier_string); modifier_string = NULL; } /* Now free this timeout. */ STOP_TIMER(clear_auth_wrong_timeout); /* retry with input done during auth verification */ if (retry_verification) { retry_verification = false; finish_input(); } } static void clear_indicator_cb(EV_P_ ev_timer *w, int revents) { clear_indicator(); STOP_TIMER(clear_indicator_timeout); } static void clear_input(void) { input_position = 0; clear_password_memory(); password[input_position] = '\0'; } static void discard_passwd_cb(EV_P_ ev_timer *w, int revents) { clear_input(); STOP_TIMER(discard_passwd_timeout); } static void input_done(void) { STOP_TIMER(clear_auth_wrong_timeout); auth_state = STATE_AUTH_VERIFY; unlock_state = STATE_STARTED; redraw_screen(); #ifdef __OpenBSD__ struct passwd *pw; if (!(pw = getpwuid(getuid()))) errx(1, "unknown uid %u.", getuid()); if (auth_userokay(pw->pw_name, NULL, NULL, password) != 0) { DEBUG("successfully authenticated\n"); clear_password_memory(); ev_break(EV_DEFAULT, EVBREAK_ALL); return; } #else if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) { DEBUG("successfully authenticated\n"); clear_password_memory(); /* PAM credentials should be refreshed, this will for example update any kerberos tickets. * Related to credentials pam_end() needs to be called to cleanup any temporary * credentials like kerberos /tmp/krb5cc_pam_* files which may of been left behind if the * refresh of the credentials failed. */ pam_setcred(pam_handle, PAM_REFRESH_CRED); pam_cleanup = true; ev_break(EV_DEFAULT, EVBREAK_ALL); return; } #endif if (debug_mode) fprintf(stderr, "Authentication failure\n"); auth_state = STATE_AUTH_WRONG; failed_attempts += 1; clear_input(); if (unlock_indicator) redraw_screen(); /* Clear this state after 2 seconds (unless the user enters another * password during that time). */ ev_now_update(main_loop); START_TIMER(clear_auth_wrong_timeout, TSTAMP_N_SECS(2), clear_auth_wrong); /* Cancel the clear_indicator_timeout, it would hide the unlock indicator * too early. */ STOP_TIMER(clear_indicator_timeout); /* beep on authentication failure, if enabled */ if (beep) { xcb_bell(conn, 100); xcb_flush(conn); } } static void redraw_timeout(EV_P_ ev_timer *w, int revents) { redraw_screen(); STOP_TIMER(w); } static bool skip_without_validation(void) { if (input_position != 0) return false; if (skip_repeated_empty_password || ignore_empty_password) return true; return false; } /* * Handle key presses. Fixes state, then looks up the key symbol for the * given keycode, then looks up the key symbol (as UCS-2), converts it to * UTF-8 and stores it in the password array. * */ static void handle_key_press(xcb_key_press_event_t *event) { xkb_keysym_t ksym; char buffer[128]; int n; bool ctrl; bool composed = false; ksym = xkb_state_key_get_one_sym(xkb_state, event->detail); ctrl = xkb_state_mod_name_is_active(xkb_state, XKB_MOD_NAME_CTRL, XKB_STATE_MODS_DEPRESSED); /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */ memset(buffer, '\0', sizeof(buffer)); if (xkb_compose_state && xkb_compose_state_feed(xkb_compose_state, ksym) == XKB_COMPOSE_FEED_ACCEPTED) { switch (xkb_compose_state_get_status(xkb_compose_state)) { case XKB_COMPOSE_NOTHING: break; case XKB_COMPOSE_COMPOSING: return; case XKB_COMPOSE_COMPOSED: /* xkb_compose_state_get_utf8 doesn't include the terminating byte in the return value * as xkb_keysym_to_utf8 does. Adding one makes the variable n consistent. */ n = xkb_compose_state_get_utf8(xkb_compose_state, buffer, sizeof(buffer)) + 1; ksym = xkb_compose_state_get_one_sym(xkb_compose_state); composed = true; break; case XKB_COMPOSE_CANCELLED: xkb_compose_state_reset(xkb_compose_state); return; } } if (!composed) { n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer)); } switch (ksym) { case XKB_KEY_j: case XKB_KEY_m: case XKB_KEY_Return: case XKB_KEY_KP_Enter: case XKB_KEY_XF86ScreenSaver: if ((ksym == XKB_KEY_j || ksym == XKB_KEY_m) && !ctrl) break; if (auth_state == STATE_AUTH_WRONG) { retry_verification = true; return; } if (skip_without_validation()) { clear_input(); return; } finish_input(); skip_repeated_empty_password = true; return; default: skip_repeated_empty_password = false; // A new password is being entered, but a previous one is pending. // Discard the old one and clear the retry_verification flag. if (retry_verification) { retry_verification = false; clear_input(); } } switch (ksym) { case XKB_KEY_u: case XKB_KEY_Escape: if ((ksym == XKB_KEY_u && ctrl) || ksym == XKB_KEY_Escape) { DEBUG("C-u pressed\n"); clear_input(); /* Also hide the unlock indicator */ if (unlock_indicator) clear_indicator(); return; } break; case XKB_KEY_Delete: case XKB_KEY_KP_Delete: /* Deleting forward doesn’t make sense, as i3lock doesn’t allow you * to move the cursor when entering a password. We need to eat this * key press so that it won’t be treated as part of the password, * see issue #50. */ return; case XKB_KEY_h: case XKB_KEY_BackSpace: if (ksym == XKB_KEY_h && !ctrl) break; if (input_position == 0) { START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb); unlock_state = STATE_NOTHING_TO_DELETE; redraw_screen(); return; } /* decrement input_position to point to the previous glyph */ u8_dec(password, &input_position); password[input_position] = '\0'; /* Hide the unlock indicator after a bit if the password buffer is * empty. */ START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb); unlock_state = STATE_BACKSPACE_ACTIVE; redraw_screen(); unlock_state = STATE_KEY_PRESSED; return; } if ((input_position + 8) >= (int)sizeof(password)) return; #if 0 /* FIXME: handle all of these? */ printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym)); printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym)); printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym)); printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym)); printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym)); printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym)); printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym)); #endif if (n < 2) return; /* store it in the password array as UTF-8 */ memcpy(password + input_position, buffer, n - 1); input_position += n - 1; DEBUG("current password = %.*s\n", input_position, password); if (unlock_indicator) { unlock_state = STATE_KEY_ACTIVE; redraw_screen(); unlock_state = STATE_KEY_PRESSED; struct ev_timer *timeout = NULL; START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout); STOP_TIMER(clear_indicator_timeout); } START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb); } /* * A visibility notify event will be received when the visibility (= can the * user view the complete window) changes, so for example when a popup overlays * some area of the i3lock window. * * In this case, we raise our window on top so that the popup (or whatever is * hiding us) gets hidden. * */ static void handle_visibility_notify(xcb_connection_t *conn, xcb_visibility_notify_event_t *event) { if (event->state != XCB_VISIBILITY_UNOBSCURED) { uint32_t values[] = {XCB_STACK_MODE_ABOVE}; xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values); xcb_flush(conn); } } /* * Called when the keyboard mapping changes. We update our symbols. * * We ignore errors — if the new keymap cannot be loaded it’s better if the * screen stays locked and the user intervenes by using killall i3lock. * */ static void process_xkb_event(xcb_generic_event_t *gevent) { union xkb_event { struct { uint8_t response_type; uint8_t xkbType; uint16_t sequence; xcb_timestamp_t time; uint8_t deviceID; } any; xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify; xcb_xkb_map_notify_event_t map_notify; xcb_xkb_state_notify_event_t state_notify; } *event = (union xkb_event *)gevent; DEBUG("process_xkb_event for device %d\n", event->any.deviceID); if (event->any.deviceID != xkb_x11_get_core_keyboard_device_id(conn)) return; /* * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent * recompilations. */ switch (event->any.xkbType) { case XCB_XKB_NEW_KEYBOARD_NOTIFY: if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES) (void)load_keymap(); break; case XCB_XKB_MAP_NOTIFY: (void)load_keymap(); break; case XCB_XKB_STATE_NOTIFY: xkb_state_update_mask(xkb_state, event->state_notify.baseMods, event->state_notify.latchedMods, event->state_notify.lockedMods, event->state_notify.baseGroup, event->state_notify.latchedGroup, event->state_notify.lockedGroup); break; } } /* * Called when the properties on the root window change, e.g. when the screen * resolution changes. If so we update the window to cover the whole screen * and also redraw the image, if any. * */ static void handle_screen_resize(void) { xcb_get_geometry_cookie_t geomc; xcb_get_geometry_reply_t *geom; geomc = xcb_get_geometry(conn, screen->root); if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) return; if (last_resolution[0] == geom->width && last_resolution[1] == geom->height) { free(geom); return; } last_resolution[0] = geom->width; last_resolution[1] = geom->height; free(geom); redraw_screen(); uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT; xcb_configure_window(conn, win, mask, last_resolution); xcb_flush(conn); randr_query(screen->root); redraw_screen(); } static ssize_t read_raw_image_native(uint32_t *dest, FILE *src, size_t width, size_t height, int pixstride) { ssize_t count = 0; for (size_t y = 0; y < height; y++) { size_t n = fread(&dest[y * pixstride], 1, width * 4, src); count += n; if (n < (size_t)(width * 4)) break; } return count; } struct raw_pixel_format { int bpp; int red; int green; int blue; }; static ssize_t read_raw_image_fmt(uint32_t *dest, FILE *src, size_t width, size_t height, int pixstride, struct raw_pixel_format fmt) { unsigned char *buf = malloc(width * fmt.bpp); if (buf == NULL) return -1; ssize_t count = 0; for (size_t y = 0; y < height; y++) { size_t n = fread(buf, 1, width * fmt.bpp, src); count += n; if (n < (size_t)(width * fmt.bpp)) break; for (size_t x = 0; x < width; ++x) { int idx = x * fmt.bpp; dest[y * pixstride + x] = 0 | (buf[idx + fmt.red]) << 16 | (buf[idx + fmt.green]) << 8 | (buf[idx + fmt.blue]); } } free(buf); return count; } // Pre-defind pixel formats (, , , ) static const struct raw_pixel_format raw_fmt_rgb = {3, 0, 1, 2}; static const struct raw_pixel_format raw_fmt_rgbx = {4, 0, 1, 2}; static const struct raw_pixel_format raw_fmt_xrgb = {4, 1, 2, 3}; static const struct raw_pixel_format raw_fmt_bgr = {3, 2, 1, 0}; static const struct raw_pixel_format raw_fmt_bgrx = {4, 2, 1, 0}; static const struct raw_pixel_format raw_fmt_xbgr = {4, 3, 2, 1}; static cairo_surface_t *read_raw_image(const char *image_path, const char *image_raw_format) { cairo_surface_t *img; #define RAW_PIXFMT_MAXLEN 6 #define STRINGIFY1(x) #x #define STRINGIFY(x) STRINGIFY1(x) /* Parse format as x: */ char pixfmt[RAW_PIXFMT_MAXLEN + 1]; size_t w, h; const char *fmt = "%zux%zu:%" STRINGIFY(RAW_PIXFMT_MAXLEN) "s"; if (sscanf(image_raw_format, fmt, &w, &h, pixfmt) != 3) { fprintf(stderr, "Invalid image format: \"%s\"\n", image_raw_format); return NULL; } #undef RAW_PIXFMT_MAXLEN #undef STRINGIFY1 #undef STRINGIFY /* Create image surface */ img = cairo_image_surface_create(CAIRO_FORMAT_RGB24, w, h); if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) { fprintf(stderr, "Could not create surface: %s\n", cairo_status_to_string(cairo_surface_status(img))); return NULL; } cairo_surface_flush(img); /* Use uint32_t* because cairo uses native endianness */ uint32_t *data = (uint32_t *)cairo_image_surface_get_data(img); const int pixstride = cairo_image_surface_get_stride(img) / 4; FILE *f = fopen(image_path, "r"); if (f == NULL) { fprintf(stderr, "Could not open image \"%s\": %s\n", image_path, strerror(errno)); cairo_surface_destroy(img); return NULL; } /* Read the image, respecting cairo's stride, according to the pixfmt */ ssize_t size, count; if (strcmp(pixfmt, "native") == 0) { /* If the pixfmt is 'native', just read each line directly into the buffer */ size = w * h * 4; count = read_raw_image_native(data, f, w, h, pixstride); } else { const struct raw_pixel_format *fmt = NULL; if (strcmp(pixfmt, "rgb") == 0) fmt = &raw_fmt_rgb; else if (strcmp(pixfmt, "rgbx") == 0) fmt = &raw_fmt_rgbx; else if (strcmp(pixfmt, "xrgb") == 0) fmt = &raw_fmt_xrgb; else if (strcmp(pixfmt, "bgr") == 0) fmt = &raw_fmt_bgr; else if (strcmp(pixfmt, "bgrx") == 0) fmt = &raw_fmt_bgrx; else if (strcmp(pixfmt, "xbgr") == 0) fmt = &raw_fmt_xbgr; if (fmt == NULL) { fprintf(stderr, "Unknown raw pixel format: %s\n", pixfmt); fclose(f); cairo_surface_destroy(img); return NULL; } size = w * h * fmt->bpp; count = read_raw_image_fmt(data, f, w, h, pixstride, *fmt); } cairo_surface_mark_dirty(img); if (count < size) { if (count < 0 || ferror(f)) { fprintf(stderr, "Failed to read image \"%s\": %s\n", image_path, strerror(errno)); fclose(f); cairo_surface_destroy(img); return NULL; } else { /* Print a warning if the file contains less data than expected, * but don't abort. It's useful to see how the image looks even if it's wrong. */ fprintf(stderr, "Warning: expected to read %zi bytes from \"%s\", read %zi\n", size, image_path, count); } } fclose(f); return img; } static bool verify_png_image(const char *image_path) { if (!image_path) { return false; } /* Check file exists and has correct PNG header */ FILE *png_file = fopen(image_path, "r"); if (png_file == NULL) { fprintf(stderr, "Image file path \"%s\" cannot be opened: %s\n", image_path, strerror(errno)); return false; } unsigned char png_header[8]; memset(png_header, '\0', sizeof(png_header)); int bytes_read = fread(png_header, 1, sizeof(png_header), png_file); fclose(png_file); if (bytes_read != sizeof(png_header)) { fprintf(stderr, "Could not read PNG header from \"%s\"\n", image_path); return false; } // Check PNG header according to the specification, available at: // https://www.w3.org/TR/2003/REC-PNG-20031110/#5PNG-file-signature static unsigned char PNG_REFERENCE_HEADER[8] = {137, 80, 78, 71, 13, 10, 26, 10}; if (memcmp(PNG_REFERENCE_HEADER, png_header, sizeof(png_header)) != 0) { fprintf(stderr, "File \"%s\" does not start with a PNG header. i3lock currently only supports loading PNG files.\n", image_path); return false; } return true; } #ifndef __OpenBSD__ /* * Callback function for PAM. We only react on password request callbacks. * */ static int conv_callback(int num_msg, const struct pam_message **msg, struct pam_response **resp, void *appdata_ptr) { if (num_msg == 0) return 1; /* PAM expects an array of responses, one for each message */ if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) { perror("calloc"); return 1; } for (int c = 0; c < num_msg; c++) { if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF && msg[c]->msg_style != PAM_PROMPT_ECHO_ON) continue; /* return code is currently not used but should be set to zero */ resp[c]->resp_retcode = 0; if ((resp[c]->resp = strdup(password)) == NULL) { perror("strdup"); return 1; } } return 0; } #endif /* * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb. * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop * */ static void xcb_got_event(EV_P_ struct ev_io *w, int revents) { /* empty, because xcb_prepare_cb and xcb_check_cb are used */ } /* * Flush before blocking (and waiting for new events) * */ static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) { xcb_flush(conn); } /* * Try closing logind sleep lock fd passed over from xss-lock, in case we're * being run from there. * */ static void maybe_close_sleep_lock_fd(void) { const char *sleep_lock_fd = getenv("XSS_SLEEP_LOCK_FD"); char *endptr; if (sleep_lock_fd && *sleep_lock_fd != 0) { long int fd = strtol(sleep_lock_fd, &endptr, 10); if (*endptr == 0) { close(fd); } } } /* * Instead of polling the X connection socket we leave this to * xcb_poll_for_event() which knows better than we can ever know. * */ static void xcb_check_cb(EV_P_ ev_check *w, int revents) { xcb_generic_event_t *event; if (xcb_connection_has_error(conn)) errx(EXIT_FAILURE, "X11 connection broke, did your server terminate?"); while ((event = xcb_poll_for_event(conn)) != NULL) { if (event->response_type == 0) { xcb_generic_error_t *error = (xcb_generic_error_t *)event; if (debug_mode) fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n", error->sequence, error->error_code); free(event); continue; } /* Strip off the highest bit (set if the event is generated) */ int type = (event->response_type & 0x7F); switch (type) { case XCB_KEY_PRESS: handle_key_press((xcb_key_press_event_t *)event); break; case XCB_VISIBILITY_NOTIFY: handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event); break; case XCB_MAP_NOTIFY: maybe_close_sleep_lock_fd(); if (!dont_fork) { /* After the first MapNotify, we never fork again. We don’t * expect to get another MapNotify, but better be sure… */ dont_fork = true; /* In the parent process, we exit */ if (fork() != 0) exit(0); ev_loop_fork(EV_DEFAULT); } break; case XCB_CONFIGURE_NOTIFY: handle_screen_resize(); break; default: if (type == xkb_base_event) { process_xkb_event(event); redraw_screen(); } if (randr_base > -1 && type == randr_base + XCB_RANDR_SCREEN_CHANGE_NOTIFY) { randr_query(screen->root); handle_screen_resize(); } } free(event); } } /* * This function is called from a fork()ed child and will raise the i3lock * window when the window is obscured, even when the main i3lock process is * blocked due to the authentication backend. * */ static void raise_loop(xcb_window_t window) { xcb_connection_t *conn; xcb_generic_event_t *event; int screens; if (xcb_connection_has_error((conn = xcb_connect(NULL, &screens))) > 0) errx(EXIT_FAILURE, "Cannot open display"); /* We need to know about the window being obscured or getting destroyed. */ xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK, (uint32_t[]){ XCB_EVENT_MASK_VISIBILITY_CHANGE | XCB_EVENT_MASK_STRUCTURE_NOTIFY}); xcb_flush(conn); DEBUG("Watching window 0x%08x\n", window); while ((event = xcb_wait_for_event(conn)) != NULL) { if (event->response_type == 0) { xcb_generic_error_t *error = (xcb_generic_error_t *)event; DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n", error->sequence, error->error_code); free(event); continue; } /* Strip off the highest bit (set if the event is generated) */ int type = (event->response_type & 0x7F); DEBUG("Read event of type %d\n", type); switch (type) { case XCB_VISIBILITY_NOTIFY: handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event); break; case XCB_UNMAP_NOTIFY: DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t *)event)->window)); if (((xcb_unmap_notify_event_t *)event)->window == window) exit(EXIT_SUCCESS); break; case XCB_DESTROY_NOTIFY: DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t *)event)->window)); if (((xcb_destroy_notify_event_t *)event)->window == window) exit(EXIT_SUCCESS); break; default: DEBUG("Unhandled event type %d\n", type); break; } free(event); } } int main(int argc, char *argv[]) { struct passwd *pw; char *username; char *image_path = NULL; char *image_raw_format = NULL; #ifndef __OpenBSD__ int ret; struct pam_conv conv = {conv_callback, NULL}; #endif int curs_choice = CURS_NONE; int o; int longoptind = 0; struct option longopts[] = { {"version", no_argument, NULL, 'v'}, {"nofork", no_argument, NULL, 'n'}, {"beep", no_argument, NULL, 'b'}, {"dpms", no_argument, NULL, 'd'}, {"color", required_argument, NULL, 'c'}, {"pointer", required_argument, NULL, 'p'}, {"debug", no_argument, NULL, 0}, {"help", no_argument, NULL, 'h'}, {"no-unlock-indicator", no_argument, NULL, 'u'}, {"image", required_argument, NULL, 'i'}, {"raw", required_argument, NULL, 0}, {"tiling", no_argument, NULL, 't'}, {"ignore-empty-password", no_argument, NULL, 'e'}, {"inactivity-timeout", required_argument, NULL, 'I'}, {"show-failed-attempts", no_argument, NULL, 'f'}, {"show-keyboard-layout", no_argument, NULL, 'k'}, {NULL, no_argument, NULL, 0}}; if ((pw = getpwuid(getuid())) == NULL) err(EXIT_FAILURE, "getpwuid() failed"); if ((username = pw->pw_name) == NULL) errx(EXIT_FAILURE, "pw->pw_name is NULL."); if (getenv("WAYLAND_DISPLAY") != NULL) errx(EXIT_FAILURE, "i3lock is a program for X11 and does not work on Wayland. Try https://github.com/swaywm/swaylock instead"); char *optstring = "hvnbdc:p:ui:teI:fk"; while ((o = getopt_long(argc, argv, optstring, longopts, &longoptind)) != -1) { switch (o) { case 'v': errx(EXIT_SUCCESS, "version " I3LOCK_VERSION " © 2010 Michael Stapelberg"); case 'n': dont_fork = true; break; case 'b': beep = true; break; case 'd': fprintf(stderr, "DPMS support has been removed from i3lock. Please see the manpage i3lock(1).\n"); break; case 'I': { fprintf(stderr, "Inactivity timeout only makes sense with DPMS, which was removed. Please see the manpage i3lock(1).\n"); break; } case 'c': { char *arg = optarg; /* Skip # if present */ if (arg[0] == '#') arg++; if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1) errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb"); break; } case 'u': unlock_indicator = false; break; case 'i': image_path = strdup(optarg); break; case 't': tile = true; break; case 'p': if (!strcmp(optarg, "win")) { curs_choice = CURS_WIN; } else if (!strcmp(optarg, "default")) { curs_choice = CURS_DEFAULT; } else { errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\"."); } break; case 'e': ignore_empty_password = true; break; case 0: if (strcmp(longopts[longoptind].name, "debug") == 0) debug_mode = true; else if (strcmp(longopts[longoptind].name, "raw") == 0) image_raw_format = strdup(optarg); break; case 'f': show_failed_attempts = true; break; case 'k': show_keyboard_layout = true; break; default: errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]" " [-i image.png] [-t] [-e] [-I timeout] [-f] [-k]"); } } /* We need (relatively) random numbers for highlighting a random part of * the unlock indicator upon keypresses. */ srand(time(NULL)); #ifndef __OpenBSD__ /* Initialize PAM */ if ((ret = pam_start("i3lock", username, &conv, &pam_handle)) != PAM_SUCCESS) errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret)); if ((ret = pam_set_item(pam_handle, PAM_TTY, getenv("DISPLAY"))) != PAM_SUCCESS) errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret)); #endif /* Using mlock() as non-super-user seems only possible in Linux. * Users of other operating systems should use encrypted swap/no swap * (or remove the ifdef and run i3lock as super-user). * Alas, swap is encrypted by default on OpenBSD so swapping out * is not necessarily an issue. */ #if defined(__linux__) /* Lock the area where we store the password in memory, we don’t want it to * be swapped to disk. Since Linux 2.6.9, this does not require any * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */ if (mlock(password, sizeof(password)) != 0) err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK"); #endif /* Double checking that connection is good and operatable with xcb */ int screennr; if ((conn = xcb_connect(NULL, &screennr)) == NULL || xcb_connection_has_error(conn)) errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?"); if (xkb_x11_setup_xkb_extension(conn, XKB_X11_MIN_MAJOR_XKB_VERSION, XKB_X11_MIN_MINOR_XKB_VERSION, 0, NULL, NULL, &xkb_base_event, &xkb_base_error) != 1) errx(EXIT_FAILURE, "Could not setup XKB extension."); static const xcb_xkb_map_part_t required_map_parts = (XCB_XKB_MAP_PART_KEY_TYPES | XCB_XKB_MAP_PART_KEY_SYMS | XCB_XKB_MAP_PART_MODIFIER_MAP | XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS | XCB_XKB_MAP_PART_KEY_ACTIONS | XCB_XKB_MAP_PART_VIRTUAL_MODS | XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP); static const xcb_xkb_event_type_t required_events = (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY | XCB_XKB_EVENT_TYPE_MAP_NOTIFY | XCB_XKB_EVENT_TYPE_STATE_NOTIFY); xcb_xkb_select_events( conn, xkb_x11_get_core_keyboard_device_id(conn), required_events, 0, required_events, required_map_parts, required_map_parts, 0); /* When we cannot initially load the keymap, we better exit */ if (!load_keymap()) errx(EXIT_FAILURE, "Could not load keymap"); const char *locale = getenv("LC_ALL"); if (!locale || !*locale) locale = getenv("LC_CTYPE"); if (!locale || !*locale) locale = getenv("LANG"); if (!locale || !*locale) { if (debug_mode) fprintf(stderr, "Can't detect your locale, fallback to C\n"); locale = "C"; } load_compose_table(locale); screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data; init_dpi(); randr_init(&randr_base, screen->root); randr_query(screen->root); last_resolution[0] = screen->width_in_pixels; last_resolution[1] = screen->height_in_pixels; xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK, (uint32_t[]){XCB_EVENT_MASK_STRUCTURE_NOTIFY}); if (image_raw_format != NULL && image_path != NULL) { /* Read image. 'read_raw_image' returns NULL on error, * so we don't have to handle errors here. */ img = read_raw_image(image_path, image_raw_format); } else if (verify_png_image(image_path)) { /* Create a pixmap to render on, fill it with the background color */ img = cairo_image_surface_create_from_png(image_path); /* In case loading failed, we just pretend no -i was specified. */ if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) { fprintf(stderr, "Could not load image \"%s\": %s\n", image_path, cairo_status_to_string(cairo_surface_status(img))); img = NULL; } } free(image_path); free(image_raw_format); /* Pixmap on which the image is rendered to (if any) */ xcb_pixmap_t bg_pixmap = create_bg_pixmap(conn, screen, last_resolution, color); draw_image(bg_pixmap, last_resolution); xcb_window_t stolen_focus = find_focused_window(conn, screen->root); /* Open the fullscreen window, already with the correct pixmap in place */ win = open_fullscreen_window(conn, screen, color, bg_pixmap); xcb_free_pixmap(conn, bg_pixmap); cursor = create_cursor(conn, screen, win, curs_choice); /* Display the "locking…" message while trying to grab the pointer/keyboard. */ auth_state = STATE_AUTH_LOCK; if (!grab_pointer_and_keyboard(conn, screen, cursor, 1000)) { DEBUG("stole focus from X11 window 0x%08x\n", stolen_focus); /* Set the focus to i3lock, possibly closing context menus which would * otherwise prevent us from grabbing keyboard/pointer. * * We cannot use set_focused_window because _NET_ACTIVE_WINDOW only * works for managed windows, but i3lock uses an unmanaged window * (override_redirect=1). */ xcb_set_input_focus(conn, XCB_INPUT_FOCUS_PARENT /* revert_to */, win, XCB_CURRENT_TIME); if (!grab_pointer_and_keyboard(conn, screen, cursor, 9000)) { auth_state = STATE_I3LOCK_LOCK_FAILED; redraw_screen(); sleep(1); errx(EXIT_FAILURE, "Cannot grab pointer/keyboard"); } } pid_t pid = fork(); /* The pid == -1 case is intentionally ignored here: * While the child process is useful for preventing other windows from * popping up while i3lock blocks, it is not critical. */ if (pid == 0) { /* Child */ close(xcb_get_file_descriptor(conn)); maybe_close_sleep_lock_fd(); raise_loop(win); exit(EXIT_SUCCESS); } /* Load the keymap again to sync the current modifier state. Since we first * loaded the keymap, there might have been changes, but starting from now, * we should get all key presses/releases due to having grabbed the * keyboard. */ (void)load_keymap(); /* Initialize the libev event loop. */ main_loop = EV_DEFAULT; if (main_loop == NULL) errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?"); /* Explicitly call the screen redraw in case "locking…" message was displayed */ auth_state = STATE_AUTH_IDLE; redraw_screen(); struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1); struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1); struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1); ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ); ev_io_start(main_loop, xcb_watcher); ev_check_init(xcb_check, xcb_check_cb); ev_check_start(main_loop, xcb_check); ev_prepare_init(xcb_prepare, xcb_prepare_cb); ev_prepare_start(main_loop, xcb_prepare); /* Invoke the event callback once to catch all the events which were * received up until now. ev will only pick up new events (when the X11 * file descriptor becomes readable). */ ev_invoke(main_loop, xcb_check, 0); ev_loop(main_loop, 0); #ifndef __OpenBSD__ if (pam_cleanup) { pam_end(pam_handle, PAM_SUCCESS); } #endif if (stolen_focus == XCB_NONE) { return 0; } DEBUG("restoring focus to X11 window 0x%08x\n", stolen_focus); xcb_ungrab_pointer(conn, XCB_CURRENT_TIME); xcb_ungrab_keyboard(conn, XCB_CURRENT_TIME); xcb_destroy_window(conn, win); set_focused_window(conn, screen->root, stolen_focus); xcb_aux_sync(conn); return 0; }