X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=i3lock.c;h=13adc2b43838402d6975eb945cbb94f954c67bd4;hb=ec5f21d1f8f62772b10ab6beb1e22be55a7a22e6;hp=22dc3da87c1db0be8f6814a8ba0a3c6920553a96;hpb=d6b9e33e2868cc9c82d8fbb6d4f9545725f78971;p=i3%2Fi3lock diff --git a/i3lock.c b/i3lock.c index 22dc3da..13adc2b 100644 --- a/i3lock.c +++ b/i3lock.c @@ -1,68 +1,104 @@ /* * vim:ts=4:sw=4:expandtab * - * © 2010-2012 Michael Stapelberg + * © 2010 Michael Stapelberg * * See LICENSE for licensing information * */ +#include + #include #include +#include +#include #include #include #include #include #include -#include +#include #include +#include #include +#ifdef __OpenBSD__ +#include +#else #include -#include +#endif #include #include #include #include -#include -#include #include +#include +#include #include #include +#ifdef __OpenBSD__ +#include /* explicit_bzero(3) */ +#endif +#include +#include #include "i3lock.h" #include "xcb.h" #include "cursors.h" #include "unlock_indicator.h" -#include "xinerama.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); -/* We need this for libxkbfile */ -static Display *display; char color[7] = "ffffff"; uint32_t last_resolution[2]; xcb_window_t win; static xcb_cursor_t cursor; +#ifndef __OpenBSD__ static pam_handle_t *pam_handle; +#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; -static bool dpms = false; bool unlock_indicator = true; +char *modifier_string = NULL; static bool dont_fork = false; struct ev_loop *main_loop; -static struct ev_timer *clear_pam_wrong_timeout; +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 pam_state_t pam_state; +extern auth_state_t auth_state; +int failed_attempts = 0; +bool show_failed_attempts = false; +bool retry_verification = false; static struct xkb_state *xkb_state; static struct xkb_context *xkb_context; static 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) +#define isutf(c) (((c)&0xC0) != 0x80) /* * Decrements i to point to the previous unicode glyph @@ -77,64 +113,59 @@ void u8_dec(char *s, int *i) { * Necessary so that we can properly let xkbcommon track the keyboard state and * translate keypresses to utf-8. * - * Ideally, xkbcommon would ship something like this itself, but as of now - * (version 0.2.0), it doesn’t. - * */ static bool load_keymap(void) { - bool ret = false; - XkbFileInfo result; - memset(&result, '\0', sizeof(result)); - result.xkb = XkbGetKeyboard(display, XkbAllMapComponentsMask, XkbUseCoreKbd); - if (result.xkb == NULL) { - fprintf(stderr, "[i3lock] XKB: XkbGetKeyboard failed\n"); - return false; + if (xkb_context == NULL) { + if ((xkb_context = xkb_context_new(0)) == NULL) { + fprintf(stderr, "[i3lock] could not create xkbcommon context\n"); + return false; + } } - FILE *temp = tmpfile(); - if (temp == NULL) { - fprintf(stderr, "[i3lock] could not create tempfile\n"); + xkb_keymap_unref(xkb_keymap); + + int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn); + DEBUG("device = %d\n", device_id); + if ((xkb_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) { + fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n"); return false; } - bool ok = XkbWriteXKBKeymap(temp, &result, false, false, NULL, NULL); - if (!ok) { - fprintf(stderr, "[i3lock] XkbWriteXKBKeymap failed\n"); - goto out; + struct xkb_state *new_state = + xkb_x11_state_new_from_device(xkb_keymap, conn, device_id); + if (new_state == NULL) { + fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n"); + return false; } - rewind(temp); + xkb_state_unref(xkb_state); + xkb_state = new_state; - if (xkb_context == NULL) { - if ((xkb_context = xkb_context_new(0)) == NULL) { - fprintf(stderr, "[i3lock] could not create xkbcommon context\n"); - goto out; - } - } + return true; +} - if (xkb_keymap != NULL) - xkb_keymap_unref(xkb_keymap); +/* + * 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_keymap = xkb_keymap_new_from_file(xkb_context, temp, XKB_KEYMAP_FORMAT_TEXT_V1, 0)) == NULL) { - fprintf(stderr, "[i3lock] xkb_keymap_new_from_file failed\n"); - goto out; + 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_state *new_state = xkb_state_new(xkb_keymap); - if (new_state == NULL) { - fprintf(stderr, "[i3lock] xkb_state_new failed\n"); - goto out; + 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; } - if (xkb_state != NULL) - xkb_state_unref(xkb_state); - xkb_state = new_state; + xkb_compose_state_unref(xkb_compose_state); + xkb_compose_state = new_compose_state; - ret = true; -out: - XkbFreeKeyboard(result.xkb, XkbAllComponentsMask, true); - fclose(temp); - return ret; + return true; } /* @@ -143,68 +174,189 @@ out: * */ static void clear_password_memory(void) { +#ifdef __OpenBSD__ + /* 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 (int c = 0; c < sizeof(password); c++) + 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 pam_state to STATE_PAM_IDLE 2 seconds after an unsuccesful + * Resets auth_state to STATE_AUTH_IDLE 2 seconds after an unsuccessful * authentication event. * */ -static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) { - DEBUG("clearing pam wrong\n"); - pam_state = STATE_PAM_IDLE; - unlock_state = STATE_STARTED; +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. */ - ev_timer_stop(main_loop, clear_pam_wrong_timeout); - free(clear_pam_wrong_timeout); - clear_pam_wrong_timeout = NULL; -} + STOP_TIMER(clear_auth_wrong_timeout); -static void input_done(void) { - if (clear_pam_wrong_timeout) { - ev_timer_stop(main_loop, clear_pam_wrong_timeout); - free(clear_pam_wrong_timeout); - clear_pam_wrong_timeout = NULL; + /* 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); +} - pam_state = STATE_PAM_VERIFY; +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(); - exit(0); + + /* 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_end(pam_handle, PAM_SUCCESS); + + ev_break(EV_DEFAULT, EVBREAK_ALL); + return; } +#endif if (debug_mode) fprintf(stderr, "Authentication failure\n"); - pam_state = STATE_PAM_WRONG; - redraw_screen(); + /* Get state of Caps and Num lock modifiers, to be displayed in + * STATE_AUTH_WRONG state */ + xkb_mod_index_t idx, num_mods; + const char *mod_name; + + num_mods = xkb_keymap_num_mods(xkb_keymap); + + for (idx = 0; idx < num_mods; idx++) { + if (!xkb_state_mod_index_is_active(xkb_state, idx, XKB_STATE_MODS_EFFECTIVE)) + continue; + + mod_name = xkb_keymap_mod_get_name(xkb_keymap, idx); + if (mod_name == NULL) + continue; + + /* Replace certain xkb names with nicer, human-readable ones. */ + if (strcmp(mod_name, XKB_MOD_NAME_CAPS) == 0) + mod_name = "Caps Lock"; + else if (strcmp(mod_name, XKB_MOD_NAME_ALT) == 0) + mod_name = "Alt"; + else if (strcmp(mod_name, XKB_MOD_NAME_NUM) == 0) + mod_name = "Num Lock"; + else if (strcmp(mod_name, XKB_MOD_NAME_LOGO) == 0) + mod_name = "Win"; + + char *tmp; + if (modifier_string == NULL) { + if (asprintf(&tmp, "%s", mod_name) != -1) + modifier_string = tmp; + } else if (asprintf(&tmp, "%s, %s", modifier_string, mod_name) != -1) { + free(modifier_string); + modifier_string = tmp; + } + } + + 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); - if ((clear_pam_wrong_timeout = calloc(sizeof(struct ev_timer), 1))) { - ev_timer_init(clear_pam_wrong_timeout, clear_pam_wrong, 2.0, 0.); - ev_timer_start(main_loop, clear_pam_wrong_timeout); - } + 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_clear_indicator_timeout(); + STOP_TIMER(clear_indicator_timeout); /* beep on authentication failure, if enabled */ if (beep) { @@ -213,20 +365,19 @@ static void input_done(void) { } } -/* - * Called when the user releases a key. We need to leave the Mode_switch - * state when the user releases the Mode_switch key. - * - */ -static void handle_key_release(xcb_key_release_event_t *event) { - xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP); -} - static void redraw_timeout(EV_P_ ev_timer *w, int revents) { redraw_screen(); + STOP_TIMER(w); +} - ev_timer_stop(main_loop, w); - free(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; } /* @@ -239,53 +390,111 @@ 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); - xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN); + 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)); - n = xkb_keysym_to_utf8(ksym, buffer, 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_Return: - case XKB_KEY_KP_Enter: - case XKB_KEY_XF86ScreenSaver: - password[input_position] = '\0'; - unlock_state = STATE_KEY_PRESSED; - redraw_screen(); - input_done(); - case XKB_KEY_Escape: - input_position = 0; - clear_password_memory(); - password[input_position] = '\0'; + 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; - /* Hide the unlock indicator after a bit if the password buffer is - * empty. */ - start_clear_indicator_timeout(); - unlock_state = STATE_BACKSPACE_ACTIVE; - redraw_screen(); - unlock_state = STATE_KEY_PRESSED; - return; + 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; + } + + 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_BackSpace: - if (input_position == 0) + 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; - /* decrement input_position to point to the previous glyph */ - u8_dec(password, &input_position); - password[input_position] = '\0'; + case XKB_KEY_h: + case XKB_KEY_BackSpace: + if (ksym == XKB_KEY_h && !ctrl) + break; - /* Hide the unlock indicator after a bit if the password buffer is - * empty. */ - start_clear_indicator_timeout(); - unlock_state = STATE_BACKSPACE_ACTIVE; - redraw_screen(); - unlock_state = STATE_KEY_PRESSED; - return; + 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) >= sizeof(password)) + if ((input_position + 8) >= (int)sizeof(password)) return; #if 0 @@ -303,21 +512,21 @@ static void handle_key_press(xcb_key_press_event_t *event) { 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", password); + memcpy(password + input_position, buffer, n - 1); + input_position += n - 1; + DEBUG("current password = %.*s\n", input_position, password); - unlock_state = STATE_KEY_ACTIVE; - redraw_screen(); - unlock_state = STATE_KEY_PRESSED; + if (unlock_indicator) { + unlock_state = STATE_KEY_ACTIVE; + redraw_screen(); + unlock_state = STATE_KEY_PRESSED; - struct ev_timer *timeout = calloc(sizeof(struct ev_timer), 1); - if (timeout) { - ev_timer_init(timeout, redraw_timeout, 0.25, 0.); - ev_timer_start(main_loop, timeout); + struct ev_timer *timeout = NULL; + START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout); + STOP_TIMER(clear_indicator_timeout); } - stop_clear_indicator_timeout(); + START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb); } /* @@ -329,9 +538,10 @@ static void handle_key_press(xcb_key_press_event_t *event) { * hiding us) gets hidden. * */ -static void handle_visibility_notify(xcb_visibility_notify_event_t *event) { +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 }; + uint32_t values[] = {XCB_STACK_MODE_ABOVE}; xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values); xcb_flush(conn); } @@ -340,11 +550,54 @@ static void handle_visibility_notify(xcb_visibility_notify_event_t *event) { /* * 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 handle_mapping_notify(xcb_mapping_notify_event_t *event) { - /* 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. */ - (void)load_keymap(); +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; + } } /* @@ -377,17 +630,47 @@ void handle_screen_resize(void) { xcb_configure_window(conn, win, mask, last_resolution); xcb_flush(conn); - xinerama_query_screens(); + randr_query(screen->root); redraw_screen(); } +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) -{ + struct pam_response **resp, void *appdata_ptr) { if (num_msg == 0) return 1; @@ -412,6 +695,7 @@ static int conv_callback(int num_msg, const struct pam_message **msg, return 0; } +#endif /* * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb. @@ -430,6 +714,22 @@ 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. @@ -438,9 +738,12 @@ static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) { 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?\n"); + while ((event = xcb_poll_for_event(conn)) != NULL) { if (event->response_type == 0) { - xcb_generic_error_t *error = (xcb_generic_error_t*)event; + 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); @@ -450,26 +753,18 @@ static void xcb_check_cb(EV_P_ ev_check *w, int revents) { /* 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_KEY_RELEASE: - handle_key_release((xcb_key_release_event_t*)event); - - /* If this was the backspace or escape key we are back at an - * empty input, so turn off the screen if DPMS is enabled */ - if (dpms && input_position == 0) - dpms_turn_off_screen(conn); - + handle_key_press((xcb_key_press_event_t *)event); break; case XCB_VISIBILITY_NOTIFY: - handle_visibility_notify((xcb_visibility_notify_event_t*)event); + 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… */ @@ -478,99 +773,179 @@ static void xcb_check_cb(EV_P_ ev_check *w, int revents) { /* In the parent process, we exit */ if (fork() != 0) exit(0); - } - break; - case XCB_MAPPING_NOTIFY: - handle_mapping_notify((xcb_mapping_notify_event_t*)event); + ev_loop_fork(EV_DEFAULT); + } break; case XCB_CONFIGURE_NOTIFY: handle_screen_resize(); break; + + default: + if (type == xkb_base_event) { + process_xkb_event(event); + } + 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\n"); + + /* 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; +#ifndef __OpenBSD__ int ret; struct pam_conv conv = {conv_callback, NULL}; +#endif int curs_choice = CURS_NONE; int o; - int optind = 0; + 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'}, + {"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'}, {"tiling", no_argument, NULL, 't'}, - {NULL, no_argument, NULL, 0} - }; - - if ((username = getenv("USER")) == NULL) - errx(1, "USER environment variable not set, please set it.\n"); - - while ((o = getopt_long(argc, argv, "hvnbdc:p:ui:t", longopts, &optind)) != -1) { + {"ignore-empty-password", no_argument, NULL, 'e'}, + {"inactivity-timeout", required_argument, NULL, 'I'}, + {"show-failed-attempts", no_argument, NULL, 'f'}, + {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.\n"); + + char *optstring = "hvnbdc:p:ui:teI:f"; + while ((o = getopt_long(argc, argv, optstring, longopts, &longoptind)) != -1) { switch (o) { - case 'v': - errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg"); - case 'n': - dont_fork = true; - break; - case 'b': - beep = true; - break; - case 'd': - dpms = true; - break; - case 'c': { - char *arg = optarg; + 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++; + /* Skip # if present */ + if (arg[0] == '#') + arg++; - if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1) - errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n"); + 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\n"); - 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(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n"); + break; } - break; - case 0: - if (strcmp(longopts[optind].name, "debug") == 0) - debug_mode = true; - break; - default: - errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]" - " [-i image.png] [-t]" - ); + 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\".\n"); + } + break; + case 'e': + ignore_empty_password = true; + break; + case 0: + if (strcmp(longopts[longoptind].name, "debug") == 0) + debug_mode = true; + break; + case 'f': + show_failed_attempts = 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]"); } } @@ -578,14 +953,20 @@ int main(int argc, char *argv[]) { * the unlock indicator upon keypresses. */ srand(time(NULL)); +#ifndef __OpenBSD__ /* Initialize PAM */ - ret = pam_start("i3lock", username, &conv, &pam_handle); - if (ret != PAM_SUCCESS) + 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). */ +/* 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 @@ -594,75 +975,146 @@ int main(int argc, char *argv[]) { err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK"); #endif - /* Initialize connection to X11 */ - if ((display = XOpenDisplay(NULL)) == NULL) - errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?"); - XSetEventQueueOwner(display, XCBOwnsEventQueue); - conn = XGetXCBConnection(display); - /* Double checking that connection is good and operatable with xcb */ - if (xcb_connection_has_error(conn)) + 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"); - xinerama_init(); - xinerama_query_screens(); - - /* if DPMS is enabled, check if the X server really supports it */ - if (dpms) { - xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn); - xcb_dpms_capable_reply_t *dpmsr; - if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) { - if (!dpmsr->capable) { - if (debug_mode) - fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n"); - dpms = false; - } - free(dpmsr); - } + 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 }); + (uint32_t[]){XCB_EVENT_MASK_STRUCTURE_NOTIFY}); - if (image_path) { + 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\": cairo surface status %d\n", - image_path, cairo_surface_status(img)); + fprintf(stderr, "Could not load image \"%s\": %s\n", + image_path, cairo_status_to_string(cairo_surface_status(img))); img = NULL; } } + free(image_path); /* Pixmap on which the image is rendered to (if any) */ xcb_pixmap_t bg_pixmap = draw_image(last_resolution); - /* open the fullscreen window, already with the correct pixmap in place */ + 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); - grab_pointer_and_keyboard(conn, screen, cursor); + /* 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); + } - if (dpms) - dpms_turn_off_screen(conn); + /* 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?\n"); + /* 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); @@ -681,4 +1133,17 @@ int main(int argc, char *argv[]) { * file descriptor becomes readable). */ ev_invoke(main_loop, xcb_check, 0); ev_loop(main_loop, 0); + + 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; }