/*
* vim:ts=4:sw=4:expandtab
*
- * © 2010-2011 Michael Stapelberg
+ * © 2010 Michael Stapelberg
*
* See LICENSE for licensing information
*
*/
#include <stdio.h>
#include <stdlib.h>
+#include <pwd.h>
+#include <sys/types.h>
#include <string.h>
#include <unistd.h>
#include <stdbool.h>
#include <stdint.h>
#include <xcb/xcb.h>
-#include <xcb/dpms.h>
-#include <xcb/xcb_keysyms.h>
+#include <xcb/xkb.h>
#include <err.h>
#include <assert.h>
#include <security/pam_appl.h>
-/* FIXME: can we get rid of this header? */
-#include <X11/keysym.h>
#include <getopt.h>
#include <string.h>
-
-#ifndef NOLIBCAIRO
+#include <ev.h>
+#include <sys/mman.h>
+#include <xkbcommon/xkbcommon.h>
+#include <xkbcommon/xkbcommon-compose.h>
+#include <xkbcommon/xkbcommon-x11.h>
#include <cairo.h>
#include <cairo/cairo-xcb.h>
-#endif
-#include "keysym2ucs.h"
-#include "ucs2_to_utf8.h"
+#include "i3lock.h"
#include "xcb.h"
#include "cursors.h"
-
-static xcb_connection_t *conn;
+#include "unlock_indicator.h"
+#include "xinerama.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);
+
+char color[7] = "ffffff";
+int inactivity_timeout = 30;
+uint32_t last_resolution[2];
+xcb_window_t win;
static xcb_cursor_t cursor;
-static xcb_key_symbols_t *symbols;
-static xcb_screen_t *scr;
static pam_handle_t *pam_handle;
-static int input_position = 0;
-/* holds the password you enter (in UTF-8) */
+int input_position = 0;
+/* Holds the password you enter (in UTF-8). */
static char password[512];
-static bool modeswitch_active = false;
-static bool iso_level3_shift_active = false;
-static int modeswitchmask;
-static int numlockmask;
static bool beep = false;
-static bool debug_mode = 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_pam_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;
+int failed_attempts = 0;
+bool show_failed_attempts = 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;
+
+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
+ *
+ */
+void u8_dec(char *s, int *i) {
+ (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
+}
-#define DEBUG(fmt, ...) do { \
- if (debug_mode) \
- printf("[i3lock-debug] " fmt, ##__VA_ARGS__); \
-} while (0)
+/*
+ * 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.
+ *
+ */
+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;
+ }
+ }
-#ifndef NOLIBCAIRO
-static cairo_surface_t *img = NULL;
-static bool tile = false;
-#endif
+ 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;
+ }
+
+ 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;
+ }
+
+ xkb_state_unref(xkb_state);
+ xkb_state = new_state;
+
+ 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;
+}
/*
- * Draws global image with fill color onto a pixmap with the given
- * resolution and returns it.
+ * Clears the memory which stored the password to be a bit safer against
+ * cold-boot attacks.
*
*/
-xcb_pixmap_t draw_image(xcb_visualtype_t *vistype, u_int32_t* resolution, char* color) {
- xcb_pixmap_t bg_pixmap = XCB_NONE;
-
-#ifndef NOLIBCAIRO
- if (!img)
- return bg_pixmap;
-
- bg_pixmap = create_bg_pixmap(conn, scr, resolution, color);
- /* Initialize cairo */
- cairo_surface_t *output;
- output = cairo_xcb_surface_create(conn, bg_pixmap, vistype,
- resolution[0], resolution[1]);
- cairo_t *ctx = cairo_create(output);
- if (!tile) {
- cairo_set_source_surface(ctx, img, 0, 0);
- cairo_paint(ctx);
+static void clear_password_memory(void) {
+ /* 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++)
+ /* 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;
+}
+
+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 {
- /* create a pattern and fill a rectangle as big as the screen */
- cairo_pattern_t *pattern;
- pattern = cairo_pattern_create_for_surface(img);
- cairo_set_source(ctx, pattern);
- cairo_pattern_set_extend(pattern, CAIRO_EXTEND_REPEAT);
- cairo_rectangle(ctx, 0, 0, resolution[0], resolution[1]);
- cairo_fill(ctx);
- cairo_pattern_destroy(pattern);
+ /* 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);
+ }
}
- cairo_surface_destroy(output);
- cairo_destroy(ctx);
-#endif
- return bg_pixmap;
+ return timer_obj;
}
-static void input_done() {
- if (input_position == 0)
- return;
+ev_timer *stop_timer(ev_timer *timer_obj) {
+ if (timer_obj) {
+ ev_timer_stop(main_loop, timer_obj);
+ free(timer_obj);
+ }
+ return NULL;
+}
+
+/*
+ * Resets pam_state to STATE_PAM_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;
+ redraw_screen();
+
+ /* Clear modifier string. */
+ if (modifier_string != NULL) {
+ free(modifier_string);
+ modifier_string = NULL;
+ }
+
+ /* Now free this timeout. */
+ STOP_TIMER(clear_pam_wrong_timeout);
+}
+
+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_pam_wrong_timeout);
+ pam_state = STATE_PAM_VERIFY;
+ unlock_state = STATE_STARTED;
+ redraw_screen();
- /* TODO: change cursor during authentication? */
if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
- printf("successfully authenticated\n");
+ 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_end(pam_handle, PAM_SUCCESS);
+
exit(0);
}
- fprintf(stderr, "Authentication failure\n");
+ if (debug_mode)
+ fprintf(stderr, "Authentication failure\n");
+
+ /* Get state of Caps and Num lock modifiers, to be displayed in
+ * STATE_PAM_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;
+ }
+ }
+
+ pam_state = STATE_PAM_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_pam_wrong_timeout, TSTAMP_N_SECS(2), clear_pam_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) {
}
}
-/*
- * 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) {
- DEBUG("releasing key %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d\n",
- event->detail, event->state, modeswitch_active, iso_level3_shift_active);
-
- /* We don’t care about the column here and just use the first symbol. Since
- * we only check for Mode_switch and ISO_Level3_Shift, this *should* work.
- * Also, if we would use the current column, we would look in the wrong
- * place. */
- xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, 0);
- if (sym == XK_Mode_switch) {
- //printf("Mode switch disabled\n");
- modeswitch_active = false;
- } else if (sym == XK_ISO_Level3_Shift) {
- iso_level3_shift_active = false;
- }
- DEBUG("release done. modeswitch_active = %d, iso_level3_shift_active = %d\n",
- modeswitch_active, iso_level3_shift_active);
+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;
}
/*
*
*/
static void handle_key_press(xcb_key_press_event_t *event) {
- DEBUG("keypress %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d\n",
- event->detail, event->state, modeswitch_active, iso_level3_shift_active);
-
- xcb_keysym_t sym0, sym1, sym;
- /* For each keycode, there is a list of symbols. The list could look like this:
- * $ xmodmap -pke | grep 'keycode 38'
- * keycode 38 = a A adiaeresis Adiaeresis o O
- * In non-X11 terminology, the symbols for the keycode 38 (the key labeled
- * with "a" on my keyboard) are "a A ä Ä o O".
- * Another form to display the same information is using xkbcomp:
- * $ xkbcomp $DISPLAY /tmp/xkb.dump
- * Then open /tmp/xkb.dump and search for '\<a\>' (in VIM regexp-language):
- *
- * symbols[Group1]= [ a, A, o, O ],
- * symbols[Group2]= [ adiaeresis, Adiaeresis ]
- *
- * So there are two *groups*, one containing 'a A' and one containing 'ä
- * Ä'. You can use Mode_switch to switch between these groups. You can use
- * ISO_Level3_Shift to reach the 'o O' part of the first group (it’s the
- * same group, just an even higher shift level).
- *
- * So, using the "logical" XKB information, the following lookup will be
- * performed:
- *
- * Neither Mode_switch nor ISO_Level3_Shift active: group 1, column 0 and 1
- * Mode_switch active: group 2, column 0 and 1
- * ISO_Level3_Shift active: group 1, column 2 and 3
- *
- * Using the column index which xcb_key_press_lookup_keysym uses (and
- * xmodmap prints out), the following lookup will be performed:
- *
- * Neither Mode_switch nor ISO_Level3_Shift active: column 0 and 1
- * Mode_switch active: column 2 and 3
- * ISO_Level3_Shift active: column 4 and 5
- */
- int base_column = 0;
- if (modeswitch_active)
- base_column = 2;
- if (iso_level3_shift_active)
- base_column = 4;
- sym0 = xcb_key_press_lookup_keysym(symbols, event, base_column);
- sym1 = xcb_key_press_lookup_keysym(symbols, event, base_column + 1);
- switch (sym0) {
- case XK_Mode_switch:
- DEBUG("Mode switch enabled\n");
- modeswitch_active = true;
- return;
- case XK_ISO_Level3_Shift:
- DEBUG("ISO_Level3_Shift enabled\n");
- iso_level3_shift_active = true;
- return;
- case XK_Return:
- case XK_KP_Enter:
- input_done();
- case XK_Escape:
- input_position = 0;
- password[input_position] = '\0';
- return;
+ 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));
+ }
- case XK_BackSpace:
- if (input_position == 0)
+ switch (ksym) {
+ case XKB_KEY_Return:
+ case XKB_KEY_KP_Enter:
+ case XKB_KEY_XF86ScreenSaver:
+ if (pam_state == STATE_PAM_WRONG)
+ return;
+
+ if (skip_without_validation()) {
+ clear_input();
+ return;
+ }
+ password[input_position] = '\0';
+ unlock_state = STATE_KEY_PRESSED;
+ redraw_screen();
+ input_done();
+ skip_repeated_empty_password = true;
return;
+ default:
+ skip_repeated_empty_password = false;
+ }
- /* decrement input_position to point to the previous glyph */
- u8_dec(password, &input_position);
- password[input_position] = '\0';
- //printf("new input position = %d, new password = %s\n", input_position, password);
- return;
+ 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();
+ /* Hide the unlock indicator after a bit if the password buffer is
+ * empty. */
+ if (unlock_indicator) {
+ START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
+ unlock_state = STATE_BACKSPACE_ACTIVE;
+ redraw_screen();
+ unlock_state = STATE_KEY_PRESSED;
+ }
+ 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_BackSpace:
+ if (input_position == 0)
+ 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))
return;
- if ((event->state & numlockmask) && xcb_is_keypad_key(sym1)) {
- /* this key was a keypad key */
- if ((event->state & XCB_MOD_MASK_SHIFT))
- sym = sym0;
- else sym = sym1;
- } else {
- if ((event->state & XCB_MOD_MASK_SHIFT))
- sym = sym1;
- else sym = sym0;
- }
-
#if 0
/* FIXME: handle all of these? */
printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
#endif
- if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
+ if (n < 2)
return;
- DEBUG("resolved to keysym = %c (%d)\n", sym, sym);
-
- /* convert the keysym to UCS */
- uint16_t ucs = keysym2ucs(sym);
- if ((int16_t)ucs == -1) {
- fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
- 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);
}
- /* store the UCS in a string to convert it */
- uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
- DEBUG("input part = %s\n", inp);
-
- /* store it in the password array as UTF-8 */
- input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
- password[input_position] = '\0';
- DEBUG("current password = %s\n", password);
+ START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
}
/*
* 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);
}
/*
* 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) {
- xcb_refresh_keyboard_mapping(symbols, event);
+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;
- modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
- numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
+ 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;
+ }
}
/*
* and also redraw the image, if any.
*
*/
-void handle_screen_resize(xcb_visualtype_t *vistype, xcb_window_t win, uint32_t* last_resolution, char* color) {
+void handle_screen_resize(void) {
xcb_get_geometry_cookie_t geomc;
xcb_get_geometry_reply_t *geom;
- geomc = xcb_get_geometry(conn, scr->root);
- if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
- return;
- }
+ 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)
- 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;
-#ifndef NOLIBCAIRO
- if (img) {
- xcb_pixmap_t bg_pixmap = draw_image(vistype, last_resolution, color);
- xcb_change_window_attributes(conn, win, XCB_CW_BACK_PIXMAP, (uint32_t[1]){ bg_pixmap });
- }
-#endif
+ 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);
+
+ xinerama_query_screens();
+ redraw_screen();
}
/*
*
*/
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;
/* PAM expects an array of responses, one for each message */
- if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
+ if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
perror("calloc");
return 1;
}
return 0;
}
+/*
+ * 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);
+}
+
+/*
+ * 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?\n");
+
+ 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:
+ 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);
+ }
+
+ 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 PAM.
+ *
+ */
+static void raise_loop(xcb_window_t window) {
+ xcb_connection_t *conn;
+ xcb_generic_event_t *event;
+ int screens;
+
+ if ((conn = xcb_connect(NULL, &screens)) == NULL ||
+ xcb_connection_has_error(conn))
+ 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[]) {
- bool dont_fork = false;
- bool dpms = false;
- char color[7] = "ffffff";
+ struct passwd *pw;
char *username;
-#ifndef NOLIBCAIRO
char *image_path = NULL;
-#endif
int ret;
struct pam_conv conv = {conv_callback, NULL};
- int screen;
- xcb_visualtype_t *vistype;
- xcb_generic_event_t *event;
- xcb_window_t win;
int curs_choice = CURS_NONE;
- char o;
+ int o;
int optind = 0;
struct option longopts[] = {
{"version", no_argument, NULL, 'v'},
{"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'},
-#ifndef NOLIBCAIRO
+ {"no-unlock-indicator", no_argument, NULL, 'u'},
{"image", required_argument, NULL, 'i'},
{"tiling", no_argument, NULL, 't'},
-#endif
- {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:"
-#ifndef NOLIBCAIRO
- "i:t"
-#endif
- , 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, &optind)) != -1) {
switch (o) {
- case 'v':
- errx(EXIT_SUCCESS, "version " VERSION " © 2010-2011 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 " 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': {
+ int time = 0;
+ if (sscanf(optarg, "%d", &time) != 1 || time < 0)
+ errx(EXIT_FAILURE, "invalid timeout, it must be a positive integer\n");
+ inactivity_timeout = time;
+ 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;
- }
-#ifndef NOLIBCAIRO
- case 'i':
- image_path = strdup(optarg);
- break;
- case 't':
- tile = true;
- break;
-#endif
- 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] [-p win|default]"
-#ifndef NOLIBCAIRO
- " [-i image.png] [-t]"
-#else
- " (compiled with NOLIBCAIRO)"
-#endif
- );
+ 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[optind].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]");
}
}
+ /* We need (relatively) random numbers for highlighting a random part of
+ * the unlock indicator upon keypresses. */
+ srand(time(NULL));
+
/* Initialize PAM */
- ret = pam_start("i3lock", username, &conv, &pam_handle);
- if (ret != PAM_SUCCESS)
- errx(EXIT_FAILURE, "PAM: %s\n", pam_strerror(pam_handle, ret));
+ 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));
+
+/* 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). */
+#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
- /* Initialize connection to X11 */
- if ((conn = xcb_connect(NULL, &screen)) == NULL ||
+ /* 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 (!dont_fork) {
- /* In the parent process, we exit */
- if (fork() != 0)
- return 0;
+ 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 = getenv("LC_CTYPE");
+ if (!locale)
+ locale = getenv("LANG");
+ if (!locale) {
+ if (debug_mode)
+ fprintf(stderr, "Can't detect your locale, fallback to C\n");
+ locale = "C";
}
- /* 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)) && !dpmsr->capable) {
- fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
- dpms = false;
- }
- }
+ load_compose_table(locale);
- scr = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
- vistype = get_root_visual_type(scr);
+ xinerama_init();
+ xinerama_query_screens();
- uint32_t last_resolution[2] = {scr->width_in_pixels, scr->height_in_pixels};
+ screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
+ 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});
-#ifndef NOLIBCAIRO
if (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;
+ }
}
-#endif
/* Pixmap on which the image is rendered to (if any) */
- xcb_pixmap_t bg_pixmap = draw_image(vistype, last_resolution, color);
+ xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
/* open the fullscreen window, already with the correct pixmap in place */
- win = open_fullscreen_window(conn, scr, color, bg_pixmap);
-
- cursor = create_cursor(conn, scr, win, curs_choice);
-
- grab_pointer_and_keyboard(conn, scr, cursor);
-
- symbols = xcb_key_symbols_alloc(conn);
- modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
- numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
-
- if (dpms)
- dpms_turn_off_screen(conn);
-
- while ((event = xcb_wait_for_event(conn))) {
- if (event->response_type == 0)
- errx(1, "XCB: Invalid event received");
-
- /* Strip off the highest bit (set if the event is generated) */
- int type = (event->response_type & 0x7F);
-
- if (type == XCB_KEY_PRESS) {
- handle_key_press((xcb_key_press_event_t*)event);
- continue;
- }
+ win = open_fullscreen_window(conn, screen, color, bg_pixmap);
+ xcb_free_pixmap(conn, bg_pixmap);
+
+ 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));
+ raise_loop(win);
+ exit(EXIT_SUCCESS);
+ }
- if (type == XCB_KEY_RELEASE) {
- handle_key_release((xcb_key_release_event_t*)event);
+ cursor = create_cursor(conn, screen, win, curs_choice);
- /* 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);
+ grab_pointer_and_keyboard(conn, screen, cursor);
+ /* 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();
- continue;
- }
+ /* Initialize the libev event loop. */
+ main_loop = EV_DEFAULT;
+ if (main_loop == NULL)
+ errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
- if (type == XCB_VISIBILITY_NOTIFY) {
- handle_visibility_notify((xcb_visibility_notify_event_t*)event);
- continue;
- }
+ 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);
- if (type == XCB_MAPPING_NOTIFY) {
- handle_mapping_notify((xcb_mapping_notify_event_t*)event);
- continue;
- }
+ ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
+ ev_io_start(main_loop, xcb_watcher);
- if (type == XCB_CONFIGURE_NOTIFY) {
- handle_screen_resize(vistype, win, last_resolution, color);
- continue;
- }
+ ev_check_init(xcb_check, xcb_check_cb);
+ ev_check_start(main_loop, xcb_check);
- printf("WARNING: unhandled event of type %d\n", type);
- }
+ ev_prepare_init(xcb_prepare, xcb_prepare_cb);
+ ev_prepare_start(main_loop, xcb_prepare);
- return 0;
+ /* 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);
}
projects / i3 / i3lock / blobdiff