Bandie/pam_panic
Bandie/pam_panic
1
0
Fork 0
Code Issues 5 Pull Requests Releases Wiki Activity

Minor revision to README.md

Browse Source
This commit is contained in:
Jordy Dickinson 2018-04-02 23:00:18 -04:00
parent db6d23c20c
commit 3a7179a80b
No known key found for this signature in database
GPG Key ID: C809BAD019EEB620
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -8,7 +8,7 @@ pam\_panic is a PAM module that protects sensitive data and provides a panic fun
## How it works ## How it works
You can choose one of two options: You can choose from one of two options:
### Using two removable media ### Using two removable media
There are two removable media which work as keys: the auth key and the panic key. The auth key will let you pass to the password prompt whereas the panic key, if provided, will securely erase the LUKS header, rendering the data unreadable. There are two removable media which work as keys: the auth key and the panic key. The auth key will let you pass to the password prompt whereas the panic key, if provided, will securely erase the LUKS header, rendering the data unreadable.
@ -17,24 +17,24 @@ There are two removable media which work as keys: the auth key and the panic key
There are two passwords you are able to set: the key password and the panic password. The key password will let you pass to the original password prompt whereas the panic password, if provided, will securely erase the LUKS header, rendering the data unreadable. There are two passwords you are able to set: the key password and the panic password. The key password will let you pass to the original password prompt whereas the panic password, if provided, will securely erase the LUKS header, rendering the data unreadable.
## Installation ## Installation
You will need GCC or similar, as well as the PAM headers. Some distributions package the PAM headers as `libpam0g-dev`. You will need GCC or similar, as well as the PAM headers. Some distributions package the PAM headers as `libpam0g-dev`.
To compile and install it, do the following within the project's root directory: To compile and install it, do the following within the project's root directory:
``` ```console
make $ [ ! -e ./configure ] && autoreconf -i
sudo make install $ ./configure
$ make
$ sudo make install
``` ```
Note: the paths of the `reboot`, `poweroff`, and `cryptsetup` commands are passed to the module at compile-time. Note: the paths of the `reboot`, `poweroff`, and `cryptsetup` commands are passed to the module at compile-time.
## Preparation ## Preparation
In that case you want to use removable media: If you want to use removable media you'll need two GPT-formatted removable storage devices, and said devices must have at least one partition. Here's an example `fdisk` session, showing how this might be accomplished:
You'll need two GPT-formatted removable storage devices, and said devices must have at least one partition. Here's an example `fdisk` session, showing how this might be accomplished:
``` ```console
$ sudo fdisk /dev/sdc $ sudo fdisk /dev/sdc
Welcome to fdisk (util-linux 2.31.1). Welcome to fdisk (util-linux 2.31.1).
@ -57,7 +57,7 @@ Command (m for help): w
You'll find the UUID of your partition in `/dev/disk/by-partuuid/`. You can find out which device is which typing `ls -l /dev/disk/by-partuuid/` in your favourite shell. You'll find the UUID of your partition in `/dev/disk/by-partuuid/`. You can find out which device is which typing `ls -l /dev/disk/by-partuuid/` in your favourite shell.
## Configuration ## Configuration
To configure the module, add the following to the appropriate PAM configuration file(s): (see pam.conf(5) for details on these files). To configure the module, add the following to the appropriate PAM configuration file(s): (see pam.conf(5) for details on these files)
### Using the removable media: ### Using the removable media:
``` ```
@ -71,10 +71,8 @@ auth requisite pam_panic.so password reboot serious=<UUID>
account requisite pam_panic.so account requisite pam_panic.so
``` ```
## More information
See `man 8 pam_panic` for more information.
See `man 8 pam_panic` for more.
## TODO ## TODO
- [Manpage translations](https://github.com/Bandie/pam_panic/issues?q=is%3Aissue+is%3Aopen+label%3Alocalization) - [Manpage translations](https://github.com/Bandie/pam_panic/issues?q=is%3Aissue+is%3Aopen+label%3Alocalization)