slock/README

slock - simple screen locker
============================
simple screen locker utility for X.

Changes by chjj
------------

- Custom Password: You can provide a custom password so you don't have to enter
  your user password on the X server. Simply create a ~/.slock_passwd file with
  your separate password in it.

- Alarms: A siren will play if a user enters an incorrect password. It must
  reside in ~/slock.

- Automatic Shutdown: Your machine will immediately shutdown if:

  1. The wrong password is entered more than 5 times.

  2. ALT/CTRL/F1-F13 is pressed to switch VTs or to try to kill the X server.
     Also, if ALT+SYSRQ is attempted to be used.

  - Automatic shutdown requires a sudoers option to be set in /etc/sudoers:

    - systemd: `[username] [hostname] =NOPASSWD: /usr/bin/systemctl poweroff`
    - sysvinit: `[username] [hostname] =NOPASSWD: /usr/bin/shutdown -h now`

    You must change [username] and [hostname] to your username and the hostname
    of the machine.

- Twilio Support: You will receive an SMS to your phone when someone inputs a
  wrong password or pressed ALT/CTRL/F1-13/SYSRQ. See twilio_example.h to create a
  twilio.h file. You will need a twilio account to set this up.

- Disabling alt+sysrq before shutting down: This prevents an attacker from
  alt+sysrq+k'ing the screenlock quickly before the shutdown.

  - This requires a sudoers option to be set in /etc/sudoers:

    - [username] [hostname] =NOPASSWD: /usr/bin/tee /proc/sys/kernel/sysrq

    You must change [username] and [hostname] to your username and the hostname
    of the machine.

Requirements
------------
In order to build slock you need the Xlib header files.


Installation
------------
Edit config.mk to match your local setup (slock is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install slock
(if necessary as root):

    make clean install


Running slock
-------------
Simply invoke the 'slock' command. To get out of it, enter your password.