You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1024 lines
33 KiB

11 years ago
15 years ago
  1. /*
  2. * vim:ts=4:sw=4:expandtab
  3. *
  4. * © 2010-2013 Michael Stapelberg
  5. *
  6. * See LICENSE for licensing information
  7. *
  8. */
  9. #include <stdio.h>
  10. #include <stdlib.h>
  11. #include <pwd.h>
  12. #include <sys/types.h>
  13. #include <string.h>
  14. #include <unistd.h>
  15. #include <stdbool.h>
  16. #include <stdint.h>
  17. #include <xcb/xcb.h>
  18. #include <xcb/xkb.h>
  19. #include <xcb/dpms.h>
  20. #include <err.h>
  21. #include <assert.h>
  22. #include <security/pam_appl.h>
  23. #include <getopt.h>
  24. #include <string.h>
  25. #include <ev.h>
  26. #include <sys/mman.h>
  27. #include <xkbcommon/xkbcommon.h>
  28. #include <xkbcommon/xkbcommon-compose.h>
  29. #include <xkbcommon/xkbcommon-x11.h>
  30. #include <cairo.h>
  31. #include <cairo/cairo-xcb.h>
  32. #include "i3lock.h"
  33. #include "xcb.h"
  34. #include "cursors.h"
  35. #include "unlock_indicator.h"
  36. #include "xinerama.h"
  37. #define TSTAMP_N_SECS(n) (n * 1.0)
  38. #define TSTAMP_N_MINS(n) (60 * TSTAMP_N_SECS(n))
  39. #define START_TIMER(timer_obj, timeout, callback) \
  40. timer_obj = start_timer(timer_obj, timeout, callback)
  41. #define STOP_TIMER(timer_obj) \
  42. timer_obj = stop_timer(timer_obj)
  43. typedef void (*ev_callback_t)(EV_P_ ev_timer *w, int revents);
  44. /* We need this for libxkbfile */
  45. char color[7] = "ffffff";
  46. int inactivity_timeout = 30;
  47. uint32_t last_resolution[2];
  48. xcb_window_t win;
  49. static xcb_cursor_t cursor;
  50. static pam_handle_t *pam_handle;
  51. int input_position = 0;
  52. /* Holds the password you enter (in UTF-8). */
  53. static char password[512];
  54. static bool beep = false;
  55. bool debug_mode = false;
  56. static bool dpms = false;
  57. bool unlock_indicator = true;
  58. char *modifier_string = NULL;
  59. static bool dont_fork = false;
  60. struct ev_loop *main_loop;
  61. static struct ev_timer *clear_pam_wrong_timeout;
  62. static struct ev_timer *clear_indicator_timeout;
  63. static struct ev_timer *dpms_timeout;
  64. static struct ev_timer *discard_passwd_timeout;
  65. extern unlock_state_t unlock_state;
  66. extern pam_state_t pam_state;
  67. int failed_attempts = 0;
  68. bool show_failed_attempts = false;
  69. static struct xkb_state *xkb_state;
  70. static struct xkb_context *xkb_context;
  71. static struct xkb_keymap *xkb_keymap;
  72. static struct xkb_compose_table *xkb_compose_table;
  73. static struct xkb_compose_state *xkb_compose_state;
  74. static uint8_t xkb_base_event;
  75. static uint8_t xkb_base_error;
  76. cairo_surface_t *img = NULL;
  77. bool tile = false;
  78. bool ignore_empty_password = false;
  79. bool skip_repeated_empty_password = false;
  80. /* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
  81. #define isutf(c) (((c)&0xC0) != 0x80)
  82. /*
  83. * Decrements i to point to the previous unicode glyph
  84. *
  85. */
  86. void u8_dec(char *s, int *i) {
  87. (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
  88. }
  89. static void turn_monitors_on(void) {
  90. if (dpms)
  91. dpms_set_mode(conn, XCB_DPMS_DPMS_MODE_ON);
  92. }
  93. static void turn_monitors_off(void) {
  94. if (dpms)
  95. dpms_set_mode(conn, XCB_DPMS_DPMS_MODE_OFF);
  96. }
  97. /*
  98. * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
  99. * Necessary so that we can properly let xkbcommon track the keyboard state and
  100. * translate keypresses to utf-8.
  101. *
  102. */
  103. static bool load_keymap(void) {
  104. if (xkb_context == NULL) {
  105. if ((xkb_context = xkb_context_new(0)) == NULL) {
  106. fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
  107. return false;
  108. }
  109. }
  110. xkb_keymap_unref(xkb_keymap);
  111. int32_t device_id = xkb_x11_get_core_keyboard_device_id(conn);
  112. DEBUG("device = %d\n", device_id);
  113. if ((xkb_keymap = xkb_x11_keymap_new_from_device(xkb_context, conn, device_id, 0)) == NULL) {
  114. fprintf(stderr, "[i3lock] xkb_x11_keymap_new_from_device failed\n");
  115. return false;
  116. }
  117. struct xkb_state *new_state =
  118. xkb_x11_state_new_from_device(xkb_keymap, conn, device_id);
  119. if (new_state == NULL) {
  120. fprintf(stderr, "[i3lock] xkb_x11_state_new_from_device failed\n");
  121. return false;
  122. }
  123. xkb_state_unref(xkb_state);
  124. xkb_state = new_state;
  125. return true;
  126. }
  127. /*
  128. * Loads the XKB compose table from the given locale.
  129. *
  130. */
  131. static bool load_compose_table(const char *locale) {
  132. xkb_compose_table_unref(xkb_compose_table);
  133. if ((xkb_compose_table = xkb_compose_table_new_from_locale(xkb_context, locale, 0)) == NULL) {
  134. fprintf(stderr, "[i3lock] xkb_compose_table_new_from_locale failed\n");
  135. return false;
  136. }
  137. struct xkb_compose_state *new_compose_state = xkb_compose_state_new(xkb_compose_table, 0);
  138. if (new_compose_state == NULL) {
  139. fprintf(stderr, "[i3lock] xkb_compose_state_new failed\n");
  140. return false;
  141. }
  142. xkb_compose_state_unref(xkb_compose_state);
  143. xkb_compose_state = new_compose_state;
  144. return true;
  145. }
  146. /*
  147. * Clears the memory which stored the password to be a bit safer against
  148. * cold-boot attacks.
  149. *
  150. */
  151. static void clear_password_memory(void) {
  152. /* A volatile pointer to the password buffer to prevent the compiler from
  153. * optimizing this out. */
  154. volatile char *vpassword = password;
  155. for (int c = 0; c < sizeof(password); c++)
  156. /* We store a non-random pattern which consists of the (irrelevant)
  157. * index plus (!) the value of the beep variable. This prevents the
  158. * compiler from optimizing the calls away, since the value of 'beep'
  159. * is not known at compile-time. */
  160. vpassword[c] = c + (int)beep;
  161. }
  162. ev_timer *start_timer(ev_timer *timer_obj, ev_tstamp timeout, ev_callback_t callback) {
  163. if (timer_obj) {
  164. ev_timer_stop(main_loop, timer_obj);
  165. ev_timer_set(timer_obj, timeout, 0.);
  166. ev_timer_start(main_loop, timer_obj);
  167. } else {
  168. /* When there is no memory, we just don’t have a timeout. We cannot
  169. * exit() here, since that would effectively unlock the screen. */
  170. timer_obj = calloc(sizeof(struct ev_timer), 1);
  171. if (timer_obj) {
  172. ev_timer_init(timer_obj, callback, timeout, 0.);
  173. ev_timer_start(main_loop, timer_obj);
  174. }
  175. }
  176. return timer_obj;
  177. }
  178. ev_timer *stop_timer(ev_timer *timer_obj) {
  179. if (timer_obj) {
  180. ev_timer_stop(main_loop, timer_obj);
  181. free(timer_obj);
  182. }
  183. return NULL;
  184. }
  185. /*
  186. * Resets pam_state to STATE_PAM_IDLE 2 seconds after an unsuccessful
  187. * authentication event.
  188. *
  189. */
  190. static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
  191. DEBUG("clearing pam wrong\n");
  192. pam_state = STATE_PAM_IDLE;
  193. unlock_state = STATE_STARTED;
  194. redraw_screen();
  195. /* Clear modifier string. */
  196. if (modifier_string != NULL) {
  197. free(modifier_string);
  198. modifier_string = NULL;
  199. }
  200. /* Now free this timeout. */
  201. STOP_TIMER(clear_pam_wrong_timeout);
  202. }
  203. static void clear_indicator_cb(EV_P_ ev_timer *w, int revents) {
  204. clear_indicator();
  205. STOP_TIMER(clear_indicator_timeout);
  206. }
  207. static void clear_input(void) {
  208. input_position = 0;
  209. clear_password_memory();
  210. password[input_position] = '\0';
  211. /* Hide the unlock indicator after a bit if the password buffer is
  212. * empty. */
  213. START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
  214. unlock_state = STATE_BACKSPACE_ACTIVE;
  215. redraw_screen();
  216. unlock_state = STATE_KEY_PRESSED;
  217. }
  218. static void turn_off_monitors_cb(EV_P_ ev_timer *w, int revents) {
  219. if (input_position == 0)
  220. turn_monitors_off();
  221. STOP_TIMER(dpms_timeout);
  222. }
  223. static void discard_passwd_cb(EV_P_ ev_timer *w, int revents) {
  224. clear_input();
  225. turn_monitors_off();
  226. STOP_TIMER(discard_passwd_timeout);
  227. }
  228. static void input_done(void) {
  229. STOP_TIMER(clear_pam_wrong_timeout);
  230. pam_state = STATE_PAM_VERIFY;
  231. redraw_screen();
  232. if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
  233. DEBUG("successfully authenticated\n");
  234. clear_password_memory();
  235. /* Turn the screen on, as it may have been turned off
  236. * on release of the 'enter' key. */
  237. turn_monitors_on();
  238. /* PAM credentials should be refreshed, this will for example update any kerberos tickets.
  239. * Related to credentials pam_end() needs to be called to cleanup any temporary
  240. * credentials like kerberos /tmp/krb5cc_pam_* files which may of been left behind if the
  241. * refresh of the credentials failed. */
  242. pam_setcred(pam_handle, PAM_REFRESH_CRED);
  243. pam_end(pam_handle, PAM_SUCCESS);
  244. exit(0);
  245. }
  246. if (debug_mode)
  247. fprintf(stderr, "Authentication failure\n");
  248. /* Get state of Caps and Num lock modifiers, to be displayed in
  249. * STATE_PAM_WRONG state */
  250. xkb_mod_index_t idx, num_mods;
  251. const char *mod_name;
  252. num_mods = xkb_keymap_num_mods(xkb_keymap);
  253. for (idx = 0; idx < num_mods; idx++) {
  254. if (!xkb_state_mod_index_is_active(xkb_state, idx, XKB_STATE_MODS_EFFECTIVE))
  255. continue;
  256. mod_name = xkb_keymap_mod_get_name(xkb_keymap, idx);
  257. if (mod_name == NULL)
  258. continue;
  259. /* Replace certain xkb names with nicer, human-readable ones. */
  260. if (strcmp(mod_name, XKB_MOD_NAME_CAPS) == 0)
  261. mod_name = "Caps Lock";
  262. else if (strcmp(mod_name, XKB_MOD_NAME_ALT) == 0)
  263. mod_name = "Alt";
  264. else if (strcmp(mod_name, XKB_MOD_NAME_NUM) == 0)
  265. mod_name = "Num Lock";
  266. else if (strcmp(mod_name, XKB_MOD_NAME_LOGO) == 0)
  267. mod_name = "Win";
  268. char *tmp;
  269. if (modifier_string == NULL) {
  270. if (asprintf(&tmp, "%s", mod_name) != -1)
  271. modifier_string = tmp;
  272. } else if (asprintf(&tmp, "%s, %s", modifier_string, mod_name) != -1) {
  273. free(modifier_string);
  274. modifier_string = tmp;
  275. }
  276. }
  277. pam_state = STATE_PAM_WRONG;
  278. failed_attempts += 1;
  279. clear_input();
  280. redraw_screen();
  281. /* Clear this state after 2 seconds (unless the user enters another
  282. * password during that time). */
  283. ev_now_update(main_loop);
  284. START_TIMER(clear_pam_wrong_timeout, TSTAMP_N_SECS(2), clear_pam_wrong);
  285. /* Cancel the clear_indicator_timeout, it would hide the unlock indicator
  286. * too early. */
  287. STOP_TIMER(clear_indicator_timeout);
  288. /* beep on authentication failure, if enabled */
  289. if (beep) {
  290. xcb_bell(conn, 100);
  291. xcb_flush(conn);
  292. }
  293. }
  294. static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
  295. redraw_screen();
  296. STOP_TIMER(w);
  297. }
  298. static bool skip_without_validation(void) {
  299. if (input_position != 0)
  300. return false;
  301. if (skip_repeated_empty_password || ignore_empty_password)
  302. return true;
  303. return false;
  304. }
  305. /*
  306. * Handle key presses. Fixes state, then looks up the key symbol for the
  307. * given keycode, then looks up the key symbol (as UCS-2), converts it to
  308. * UTF-8 and stores it in the password array.
  309. *
  310. */
  311. static void handle_key_press(xcb_key_press_event_t *event) {
  312. xkb_keysym_t ksym;
  313. char buffer[128];
  314. int n;
  315. bool ctrl;
  316. bool composed = false;
  317. ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
  318. ctrl = xkb_state_mod_name_is_active(xkb_state, XKB_MOD_NAME_CTRL, XKB_STATE_MODS_DEPRESSED);
  319. /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
  320. memset(buffer, '\0', sizeof(buffer));
  321. if (xkb_compose_state && xkb_compose_state_feed(xkb_compose_state, ksym) == XKB_COMPOSE_FEED_ACCEPTED) {
  322. switch (xkb_compose_state_get_status(xkb_compose_state)) {
  323. case XKB_COMPOSE_NOTHING:
  324. break;
  325. case XKB_COMPOSE_COMPOSING:
  326. return;
  327. case XKB_COMPOSE_COMPOSED:
  328. /* xkb_compose_state_get_utf8 doesn't include the terminating byte in the return value
  329. * as xkb_keysym_to_utf8 does. Adding one makes the variable n consistent. */
  330. n = xkb_compose_state_get_utf8(xkb_compose_state, buffer, sizeof(buffer)) + 1;
  331. ksym = xkb_compose_state_get_one_sym(xkb_compose_state);
  332. composed = true;
  333. break;
  334. case XKB_COMPOSE_CANCELLED:
  335. xkb_compose_state_reset(xkb_compose_state);
  336. return;
  337. }
  338. }
  339. if (!composed) {
  340. n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
  341. }
  342. switch (ksym) {
  343. case XKB_KEY_Return:
  344. case XKB_KEY_KP_Enter:
  345. case XKB_KEY_XF86ScreenSaver:
  346. if (pam_state == STATE_PAM_WRONG)
  347. return;
  348. if (skip_without_validation()) {
  349. clear_input();
  350. return;
  351. }
  352. password[input_position] = '\0';
  353. unlock_state = STATE_KEY_PRESSED;
  354. redraw_screen();
  355. input_done();
  356. skip_repeated_empty_password = true;
  357. return;
  358. default:
  359. skip_repeated_empty_password = false;
  360. }
  361. switch (ksym) {
  362. case XKB_KEY_u:
  363. if (ctrl) {
  364. DEBUG("C-u pressed\n");
  365. clear_input();
  366. return;
  367. }
  368. break;
  369. case XKB_KEY_Escape:
  370. clear_input();
  371. return;
  372. case XKB_KEY_BackSpace:
  373. if (input_position == 0)
  374. return;
  375. /* decrement input_position to point to the previous glyph */
  376. u8_dec(password, &input_position);
  377. password[input_position] = '\0';
  378. /* Hide the unlock indicator after a bit if the password buffer is
  379. * empty. */
  380. START_TIMER(clear_indicator_timeout, 1.0, clear_indicator_cb);
  381. unlock_state = STATE_BACKSPACE_ACTIVE;
  382. redraw_screen();
  383. unlock_state = STATE_KEY_PRESSED;
  384. return;
  385. }
  386. if ((input_position + 8) >= sizeof(password))
  387. return;
  388. #if 0
  389. /* FIXME: handle all of these? */
  390. printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
  391. printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
  392. printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
  393. printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
  394. printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
  395. printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
  396. printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
  397. #endif
  398. if (n < 2)
  399. return;
  400. /* store it in the password array as UTF-8 */
  401. memcpy(password + input_position, buffer, n - 1);
  402. input_position += n - 1;
  403. DEBUG("current password = %.*s\n", input_position, password);
  404. unlock_state = STATE_KEY_ACTIVE;
  405. redraw_screen();
  406. unlock_state = STATE_KEY_PRESSED;
  407. struct ev_timer *timeout = NULL;
  408. START_TIMER(timeout, TSTAMP_N_SECS(0.25), redraw_timeout);
  409. STOP_TIMER(clear_indicator_timeout);
  410. START_TIMER(discard_passwd_timeout, TSTAMP_N_MINS(3), discard_passwd_cb);
  411. }
  412. /*
  413. * A visibility notify event will be received when the visibility (= can the
  414. * user view the complete window) changes, so for example when a popup overlays
  415. * some area of the i3lock window.
  416. *
  417. * In this case, we raise our window on top so that the popup (or whatever is
  418. * hiding us) gets hidden.
  419. *
  420. */
  421. static void handle_visibility_notify(xcb_connection_t *conn,
  422. xcb_visibility_notify_event_t *event) {
  423. if (event->state != XCB_VISIBILITY_UNOBSCURED) {
  424. uint32_t values[] = {XCB_STACK_MODE_ABOVE};
  425. xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
  426. xcb_flush(conn);
  427. }
  428. }
  429. /*
  430. * Called when the keyboard mapping changes. We update our symbols.
  431. *
  432. * We ignore errors if the new keymap cannot be loaded its better if the
  433. * screen stays locked and the user intervenes by using killall i3lock.
  434. *
  435. */
  436. static void process_xkb_event(xcb_generic_event_t *gevent) {
  437. union xkb_event {
  438. struct {
  439. uint8_t response_type;
  440. uint8_t xkbType;
  441. uint16_t sequence;
  442. xcb_timestamp_t time;
  443. uint8_t deviceID;
  444. } any;
  445. xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify;
  446. xcb_xkb_map_notify_event_t map_notify;
  447. xcb_xkb_state_notify_event_t state_notify;
  448. } *event = (union xkb_event *)gevent;
  449. DEBUG("process_xkb_event for device %d\n", event->any.deviceID);
  450. if (event->any.deviceID != xkb_x11_get_core_keyboard_device_id(conn))
  451. return;
  452. /*
  453. * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap
  454. * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent
  455. * recompilations.
  456. */
  457. switch (event->any.xkbType) {
  458. case XCB_XKB_NEW_KEYBOARD_NOTIFY:
  459. if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES)
  460. (void)load_keymap();
  461. break;
  462. case XCB_XKB_MAP_NOTIFY:
  463. (void)load_keymap();
  464. break;
  465. case XCB_XKB_STATE_NOTIFY:
  466. xkb_state_update_mask(xkb_state,
  467. event->state_notify.baseMods,
  468. event->state_notify.latchedMods,
  469. event->state_notify.lockedMods,
  470. event->state_notify.baseGroup,
  471. event->state_notify.latchedGroup,
  472. event->state_notify.lockedGroup);
  473. break;
  474. }
  475. }
  476. /*
  477. * Called when the properties on the root window change, e.g. when the screen
  478. * resolution changes. If so we update the window to cover the whole screen
  479. * and also redraw the image, if any.
  480. *
  481. */
  482. void handle_screen_resize(void) {
  483. xcb_get_geometry_cookie_t geomc;
  484. xcb_get_geometry_reply_t *geom;
  485. geomc = xcb_get_geometry(conn, screen->root);
  486. if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL)
  487. return;
  488. if (last_resolution[0] == geom->width &&
  489. last_resolution[1] == geom->height) {
  490. free(geom);
  491. return;
  492. }
  493. last_resolution[0] = geom->width;
  494. last_resolution[1] = geom->height;
  495. free(geom);
  496. redraw_screen();
  497. uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
  498. xcb_configure_window(conn, win, mask, last_resolution);
  499. xcb_flush(conn);
  500. xinerama_query_screens();
  501. redraw_screen();
  502. }
  503. /*
  504. * Callback function for PAM. We only react on password request callbacks.
  505. *
  506. */
  507. static int conv_callback(int num_msg, const struct pam_message **msg,
  508. struct pam_response **resp, void *appdata_ptr) {
  509. if (num_msg == 0)
  510. return 1;
  511. /* PAM expects an array of responses, one for each message */
  512. if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
  513. perror("calloc");
  514. return 1;
  515. }
  516. for (int c = 0; c < num_msg; c++) {
  517. if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
  518. msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
  519. continue;
  520. /* return code is currently not used but should be set to zero */
  521. resp[c]->resp_retcode = 0;
  522. if ((resp[c]->resp = strdup(password)) == NULL) {
  523. perror("strdup");
  524. return 1;
  525. }
  526. }
  527. return 0;
  528. }
  529. /*
  530. * This callback is only a dummy, see xcb_prepare_cb and xcb_check_cb.
  531. * See also man libev(3): "ev_prepare" and "ev_check" - customise your event loop
  532. *
  533. */
  534. static void xcb_got_event(EV_P_ struct ev_io *w, int revents) {
  535. /* empty, because xcb_prepare_cb and xcb_check_cb are used */
  536. }
  537. /*
  538. * Flush before blocking (and waiting for new events)
  539. *
  540. */
  541. static void xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
  542. xcb_flush(conn);
  543. }
  544. /*
  545. * Instead of polling the X connection socket we leave this to
  546. * xcb_poll_for_event() which knows better than we can ever know.
  547. *
  548. */
  549. static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
  550. xcb_generic_event_t *event;
  551. if (xcb_connection_has_error(conn))
  552. errx(EXIT_FAILURE, "X11 connection broke, did your server terminate?\n");
  553. while ((event = xcb_poll_for_event(conn)) != NULL) {
  554. if (event->response_type == 0) {
  555. xcb_generic_error_t *error = (xcb_generic_error_t *)event;
  556. if (debug_mode)
  557. fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
  558. error->sequence, error->error_code);
  559. free(event);
  560. continue;
  561. }
  562. /* Strip off the highest bit (set if the event is generated) */
  563. int type = (event->response_type & 0x7F);
  564. switch (type) {
  565. case XCB_KEY_PRESS:
  566. handle_key_press((xcb_key_press_event_t *)event);
  567. break;
  568. case XCB_KEY_RELEASE:
  569. /* If this was the backspace or escape key we are back at an
  570. * empty input, so turn off the screen if DPMS is enabled, but
  571. * only do that after some timeout: maybe user mistyped and
  572. * will type again right away */
  573. START_TIMER(dpms_timeout, TSTAMP_N_SECS(inactivity_timeout),
  574. turn_off_monitors_cb);
  575. break;
  576. case XCB_VISIBILITY_NOTIFY:
  577. handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
  578. break;
  579. case XCB_MAP_NOTIFY:
  580. if (!dont_fork) {
  581. /* After the first MapNotify, we never fork again. We don’t
  582. * expect to get another MapNotify, but better be sure */
  583. dont_fork = true;
  584. /* In the parent process, we exit */
  585. if (fork() != 0)
  586. exit(0);
  587. ev_loop_fork(EV_DEFAULT);
  588. }
  589. break;
  590. case XCB_CONFIGURE_NOTIFY:
  591. handle_screen_resize();
  592. break;
  593. default:
  594. if (type == xkb_base_event)
  595. process_xkb_event(event);
  596. }
  597. free(event);
  598. }
  599. }
  600. /*
  601. * This function is called from a fork()ed child and will raise the i3lock
  602. * window when the window is obscured, even when the main i3lock process is
  603. * blocked due to PAM.
  604. *
  605. */
  606. static void raise_loop(xcb_window_t window) {
  607. xcb_connection_t *conn;
  608. xcb_generic_event_t *event;
  609. int screens;
  610. if ((conn = xcb_connect(NULL, &screens)) == NULL ||
  611. xcb_connection_has_error(conn))
  612. errx(EXIT_FAILURE, "Cannot open display\n");
  613. /* We need to know about the window being obscured or getting destroyed. */
  614. xcb_change_window_attributes(conn, window, XCB_CW_EVENT_MASK,
  615. (uint32_t[]){
  616. XCB_EVENT_MASK_VISIBILITY_CHANGE |
  617. XCB_EVENT_MASK_STRUCTURE_NOTIFY});
  618. xcb_flush(conn);
  619. DEBUG("Watching window 0x%08x\n", window);
  620. while ((event = xcb_wait_for_event(conn)) != NULL) {
  621. if (event->response_type == 0) {
  622. xcb_generic_error_t *error = (xcb_generic_error_t *)event;
  623. DEBUG("X11 Error received! sequence 0x%x, error_code = %d\n",
  624. error->sequence, error->error_code);
  625. free(event);
  626. continue;
  627. }
  628. /* Strip off the highest bit (set if the event is generated) */
  629. int type = (event->response_type & 0x7F);
  630. DEBUG("Read event of type %d\n", type);
  631. switch (type) {
  632. case XCB_VISIBILITY_NOTIFY:
  633. handle_visibility_notify(conn, (xcb_visibility_notify_event_t *)event);
  634. break;
  635. case XCB_UNMAP_NOTIFY:
  636. DEBUG("UnmapNotify for 0x%08x\n", (((xcb_unmap_notify_event_t *)event)->window));
  637. if (((xcb_unmap_notify_event_t *)event)->window == window)
  638. exit(EXIT_SUCCESS);
  639. break;
  640. case XCB_DESTROY_NOTIFY:
  641. DEBUG("DestroyNotify for 0x%08x\n", (((xcb_destroy_notify_event_t *)event)->window));
  642. if (((xcb_destroy_notify_event_t *)event)->window == window)
  643. exit(EXIT_SUCCESS);
  644. break;
  645. default:
  646. DEBUG("Unhandled event type %d\n", type);
  647. break;
  648. }
  649. free(event);
  650. }
  651. }
  652. int main(int argc, char *argv[]) {
  653. struct passwd *pw;
  654. char *username;
  655. char *image_path = NULL;
  656. int ret;
  657. struct pam_conv conv = {conv_callback, NULL};
  658. int curs_choice = CURS_NONE;
  659. int o;
  660. int optind = 0;
  661. struct option longopts[] = {
  662. {"version", no_argument, NULL, 'v'},
  663. {"nofork", no_argument, NULL, 'n'},
  664. {"beep", no_argument, NULL, 'b'},
  665. {"dpms", no_argument, NULL, 'd'},
  666. {"color", required_argument, NULL, 'c'},
  667. {"pointer", required_argument, NULL, 'p'},
  668. {"debug", no_argument, NULL, 0},
  669. {"help", no_argument, NULL, 'h'},
  670. {"no-unlock-indicator", no_argument, NULL, 'u'},
  671. {"image", required_argument, NULL, 'i'},
  672. {"tiling", no_argument, NULL, 't'},
  673. {"ignore-empty-password", no_argument, NULL, 'e'},
  674. {"inactivity-timeout", required_argument, NULL, 'I'},
  675. {"show-failed-attempts", no_argument, NULL, 'f'},
  676. {NULL, no_argument, NULL, 0}};
  677. if ((pw = getpwuid(getuid())) == NULL)
  678. err(EXIT_FAILURE, "getpwuid() failed");
  679. if ((username = pw->pw_name) == NULL)
  680. errx(EXIT_FAILURE, "pw->pw_name is NULL.\n");
  681. char *optstring = "hvnbdc:p:ui:teI:f";
  682. while ((o = getopt_long(argc, argv, optstring, longopts, &optind)) != -1) {
  683. switch (o) {
  684. case 'v':
  685. errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
  686. case 'n':
  687. dont_fork = true;
  688. break;
  689. case 'b':
  690. beep = true;
  691. break;
  692. case 'd':
  693. dpms = true;
  694. break;
  695. case 'I': {
  696. int time = 0;
  697. if (sscanf(optarg, "%d", &time) != 1 || time < 0)
  698. errx(EXIT_FAILURE, "invalid timeout, it must be a positive integer\n");
  699. inactivity_timeout = time;
  700. break;
  701. }
  702. case 'c': {
  703. char *arg = optarg;
  704. /* Skip # if present */
  705. if (arg[0] == '#')
  706. arg++;
  707. if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
  708. errx(EXIT_FAILURE, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
  709. break;
  710. }
  711. case 'u':
  712. unlock_indicator = false;
  713. break;
  714. case 'i':
  715. image_path = strdup(optarg);
  716. break;
  717. case 't':
  718. tile = true;
  719. break;
  720. case 'p':
  721. if (!strcmp(optarg, "win")) {
  722. curs_choice = CURS_WIN;
  723. } else if (!strcmp(optarg, "default")) {
  724. curs_choice = CURS_DEFAULT;
  725. } else {
  726. errx(EXIT_FAILURE, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
  727. }
  728. break;
  729. case 'e':
  730. ignore_empty_password = true;
  731. break;
  732. case 0:
  733. if (strcmp(longopts[optind].name, "debug") == 0)
  734. debug_mode = true;
  735. break;
  736. case 'f':
  737. show_failed_attempts = true;
  738. break;
  739. default:
  740. errx(EXIT_FAILURE, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
  741. " [-i image.png] [-t] [-e] [-I] [-f]");
  742. }
  743. }
  744. /* We need (relatively) random numbers for highlighting a random part of
  745. * the unlock indicator upon keypresses. */
  746. srand(time(NULL));
  747. /* Initialize PAM */
  748. ret = pam_start("i3lock", username, &conv, &pam_handle);
  749. if (ret != PAM_SUCCESS)
  750. errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
  751. /* Using mlock() as non-super-user seems only possible in Linux. Users of other
  752. * operating systems should use encrypted swap/no swap (or remove the ifdef and
  753. * run i3lock as super-user). */
  754. #if defined(__linux__)
  755. /* Lock the area where we store the password in memory, we don’t want it to
  756. * be swapped to disk. Since Linux 2.6.9, this does not require any
  757. * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
  758. if (mlock(password, sizeof(password)) != 0)
  759. err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
  760. #endif
  761. /* Double checking that connection is good and operatable with xcb */
  762. int screennr;
  763. if ((conn = xcb_connect(NULL, &screennr)) == NULL ||
  764. xcb_connection_has_error(conn))
  765. errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
  766. if (xkb_x11_setup_xkb_extension(conn,
  767. XKB_X11_MIN_MAJOR_XKB_VERSION,
  768. XKB_X11_MIN_MINOR_XKB_VERSION,
  769. 0,
  770. NULL,
  771. NULL,
  772. &xkb_base_event,
  773. &xkb_base_error) != 1)
  774. errx(EXIT_FAILURE, "Could not setup XKB extension.");
  775. static const xcb_xkb_map_part_t required_map_parts =
  776. (XCB_XKB_MAP_PART_KEY_TYPES |
  777. XCB_XKB_MAP_PART_KEY_SYMS |
  778. XCB_XKB_MAP_PART_MODIFIER_MAP |
  779. XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
  780. XCB_XKB_MAP_PART_KEY_ACTIONS |
  781. XCB_XKB_MAP_PART_VIRTUAL_MODS |
  782. XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP);
  783. static const xcb_xkb_event_type_t required_events =
  784. (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY |
  785. XCB_XKB_EVENT_TYPE_MAP_NOTIFY |
  786. XCB_XKB_EVENT_TYPE_STATE_NOTIFY);
  787. xcb_xkb_select_events(
  788. conn,
  789. xkb_x11_get_core_keyboard_device_id(conn),
  790. required_events,
  791. 0,
  792. required_events,
  793. required_map_parts,
  794. required_map_parts,
  795. 0);
  796. /* When we cannot initially load the keymap, we better exit */
  797. if (!load_keymap())
  798. errx(EXIT_FAILURE, "Could not load keymap");
  799. const char *locale = getenv("LC_ALL");
  800. if (!locale)
  801. locale = getenv("LC_CTYPE");
  802. if (!locale)
  803. locale = getenv("LANG");
  804. if (!locale) {
  805. if (debug_mode)
  806. fprintf(stderr, "Can't detect your locale, fallback to C\n");
  807. locale = "C";
  808. }
  809. load_compose_table(locale);
  810. xinerama_init();
  811. xinerama_query_screens();
  812. /* if DPMS is enabled, check if the X server really supports it */
  813. if (dpms) {
  814. xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
  815. xcb_dpms_capable_reply_t *dpmsr;
  816. if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
  817. if (!dpmsr->capable) {
  818. if (debug_mode)
  819. fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
  820. dpms = false;
  821. }
  822. free(dpmsr);
  823. }
  824. }
  825. screen = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
  826. last_resolution[0] = screen->width_in_pixels;
  827. last_resolution[1] = screen->height_in_pixels;
  828. xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
  829. (uint32_t[]){XCB_EVENT_MASK_STRUCTURE_NOTIFY});
  830. if (image_path) {
  831. /* Create a pixmap to render on, fill it with the background color */
  832. img = cairo_image_surface_create_from_png(image_path);
  833. /* In case loading failed, we just pretend no -i was specified. */
  834. if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
  835. fprintf(stderr, "Could not load image \"%s\": %s\n",
  836. image_path, cairo_status_to_string(cairo_surface_status(img)));
  837. img = NULL;
  838. }
  839. }
  840. /* Pixmap on which the image is rendered to (if any) */
  841. xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
  842. /* open the fullscreen window, already with the correct pixmap in place */
  843. win = open_fullscreen_window(conn, screen, color, bg_pixmap);
  844. xcb_free_pixmap(conn, bg_pixmap);
  845. pid_t pid = fork();
  846. /* The pid == -1 case is intentionally ignored here:
  847. * While the child process is useful for preventing other windows from
  848. * popping up while i3lock blocks, it is not critical. */
  849. if (pid == 0) {
  850. /* Child */
  851. close(xcb_get_file_descriptor(conn));
  852. raise_loop(win);
  853. exit(EXIT_SUCCESS);
  854. }
  855. cursor = create_cursor(conn, screen, win, curs_choice);
  856. grab_pointer_and_keyboard(conn, screen, cursor);
  857. /* Load the keymap again to sync the current modifier state. Since we first
  858. * loaded the keymap, there might have been changes, but starting from now,
  859. * we should get all key presses/releases due to having grabbed the
  860. * keyboard. */
  861. (void)load_keymap();
  862. turn_monitors_off();
  863. /* Initialize the libev event loop. */
  864. main_loop = EV_DEFAULT;
  865. if (main_loop == NULL)
  866. errx(EXIT_FAILURE, "Could not initialize libev. Bad LIBEV_FLAGS?\n");
  867. struct ev_io *xcb_watcher = calloc(sizeof(struct ev_io), 1);
  868. struct ev_check *xcb_check = calloc(sizeof(struct ev_check), 1);
  869. struct ev_prepare *xcb_prepare = calloc(sizeof(struct ev_prepare), 1);
  870. ev_io_init(xcb_watcher, xcb_got_event, xcb_get_file_descriptor(conn), EV_READ);
  871. ev_io_start(main_loop, xcb_watcher);
  872. ev_check_init(xcb_check, xcb_check_cb);
  873. ev_check_start(main_loop, xcb_check);
  874. ev_prepare_init(xcb_prepare, xcb_prepare_cb);
  875. ev_prepare_start(main_loop, xcb_prepare);
  876. /* Invoke the event callback once to catch all the events which were
  877. * received up until now. ev will only pick up new events (when the X11
  878. * file descriptor becomes readable). */
  879. ev_invoke(main_loop, xcb_check, 0);
  880. ev_loop(main_loop, 0);
  881. }