peanutbutter - A wayland screen locker for touch-based Linux mobile devices

NAME SYNOPSIS DESCRIPTION OPTIONS CONTROLS SECURITY ENVIRONMENT AUTHORS COPYRIGHT SEE ALSO

NAME

DESCRIPTION

A lock screen for linux mobile. Specially designed for Sxmo (wayland edition).

OPTIONS

-d / --debug

Debug mode (allows quiting on any keypress) and prints verbose logging (insecure!)

-T / --notouch

Disable touch support

-F / --nofeedback

Disable touch feedback

-f / --font font

Set font family

-t / --tries tries

The number of incorrect touches allowed before the locker goes into a deeper lock (0 = unlimited, default = 10)

-L / --deeplock seconds

Timeout in seconds for deeplock mode, during which the device can not be unlocked. (default = 20)

-p / --paranoid

In paranoid mode, the deeplock timeout will be doubled every time it is reached, making successive attempts harder and harder.

-1

1x1 touch grid (insecure). See CONTROLS.

-2

2x2 touch grid (1=topleft, 4=bottomright). See CONTROLS.

-3

3x3 touch grid (1=topleft, 9=bottomright). See CONTROLS.

-4

4x4 touch grid (0=topleft, f=bottomright). See CONTROLS.

-s / --statuscommand command

Run this command for a status line, it should run continuously and each new output line will become the status line. This parameter should be the last parameter provided! Any further parameters will be passed to the command.

CONTROLS

By default, the screen is segregated into 4 quadrants (resolution 2):

1. Top left 2. Top right 3. Bottom left 4. Bottom right

The passcode consists of any combination of these and is configured through the environment variable PEANUTBUTTER_PASSCODE which takes a sequence of digits to represent the quadrants, e.g. 1132 for top left, top left, bottom left, top right. This happens to also be the default passcode if the environment variable is not set.

There is no confirm or clear option. The passcode is checked after each touch and stored in a stack with the exact length of the passcode. If you make a mistake, simply start tapping the sequence anew.

A will be acknowledged by flipping the background, this provides only provides a indication whether the touch was registered, not whether it is a valid touch in the passcode sequence. The feedback will be over the entire screen and will not specifically highlight the quadrant you tapped (as a security measure).

SECURITY

For extra security, visual feedback can be disabled entirely by passing the -F or --nofeedback option.

Another way to increase security, is to set the parameter -3 to change the resolution to 3 (3x3 = 9 quadrants). Which takes the following configuration:

1 2 3

4 5 6

7 8 9

You can even go up to -4, which will give you this next configuration (4x4 = 16 quadrants):

0 1 2 3

4 5 6 7

8 9 a b

c d e f

By default, if a certain number of touches (10 by default) did not lead to a successful unlock, then the locker will go into a deeper lock state and show a red background. This is a time-out state during which the device can not be unlocked, it will time out after a number of seconds (20 by default) and go back to normal lock mode. This is a security measure to prevent brute-force attacks.

The number of tries is configured via --tries, the timeout (in seconds) via --deeplock. You can set --paranoid to make the timeout double each time the deep lock state is reached, which may lead to the timeout being so long that you need to force a hard reboot.

This program implements the ‘ext-session-lock-v1‘ protocol. If peanutbutter inadvertently crashes, your information is not exposed.

ENVIRONMENT

PEANUTBUTTER_PASSCODE

The passcode to use, each character refers to a quadrant. See CONTROLS.

AUTHORS

	•		Anjandev Momi <[email protected]>
	•		Maarten van Gompel <[email protected]>

COPYRIGHT

Peanutbutter is licensed under the GNU Affero General Public License v3.