pam-duress - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #llm #machine-learning #deep-learning #linux #docker #cli #awesome-list #mcp #openai #open-source

pam-duress

(★ 1,410)

A Pluggable Authentication Module (PAM) which allows the establishment of alternate passwords that can be used to perform actions to clear sensitive data, notify IT/Security staff, close off sensitive network connections, etc if a user is coerced into giving a threat actor a password.

File Explorer

Download Latest Version (.zip)

- - build.yml
- - Pushover.md
- - diagram.png
- ArchLinux.md
- Contributing.md
- RHLinux.md
- duress.c
- duress.h
- duress_sign.c
- pam_test.c
- util.c
- util.h
- version.h
.gitignore
CHANGELOG.md
LICENSE
Makefile
README.md
sonar-project.properties

# Installation Guide

1. Get the code

git clone https://github.com/nuvious/pam-duress

Downloads the entire project code from GitHub to your computer.

cd pam-duress

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.

sudo apt-get install build-essential libpam0g-dev libssl-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

make clean

Compiles the code based on the generated build configuration to produce an executable.

make debug

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Intro

The PAM Duress is a module designed to allow users to generate 'duress' passwords that when used in place of their
normal password will execute arbitrary scripts.

This functionality could be used to allow someone pressed to give a password under coercion to provide a password that
grants access but in the background runs scripts to clean up sensitive data, close connections to other networks to
limit lateral movement, and/or to send off a notification or alert (potentially one with detailed information like
location, visible wifi hot-spots, a picture from the camera, a link to a stream from the microphone, etc). You could
even spawn a process to remove the pam_duress module so the threat actor won't be able to see if the duress module was
available.

This is transparent to the person coercing the password from the user as the duress password will grant authentication
and drop to the user's shell.

Duress scripts can be generated on an individual user basis or generated globally. Users can also re-use global duress
passwords to sign their own duress scripts (rare instance where this could actually be useful from a security
perspective).

Contributions to this project are more than welcome; refer to our guidance on making contributions
[here](docs/Contributing.md).

**Maintainer's Notes:** While this project is primarily developed in Debian
flavors of linux, the maintainer's will make every attempt to spin up VM's or
docker containers to troubleshoot linux specific flavor issues. We also
welcome contributions from the community. Below are specific linux variant
installation guides available:

- [Arch Linux](docs/ArchLinux.md)
- [Red Hat Family of Linux](docs/RHLinux.md)

## Demo

[![Video Demo - https://www.youtube.com/watch?v=ShVYxhHUYdg](https://img.youtube.com/vi/ShVYxhHUYdg/0.jpg)](https://www.youtube.com/watch?v=ShVYxhHUYdg)

## Requirements

```bash
# Ubuntu/Debian dependencies
sudo apt-get install build-essential libpam0g-dev libssl-dev
```

## Build

```bash
make
sudo make install
make clean
# make uninstall
```

### Debug Build

```bash
# Debug build provides detailed output to syslog.\
sudo make uninstall
make clean
make debug
sudo make install
```

**NOTE**: In debug builds script output IS NOT redirected to /dev/null by default; in non-debug builds it is.

## Configuration

Configuration of the duress module is split into two different configuration directories. After installation, you'll
need to manually create both of them.

```bash
mkdir -p ~/.duress # Local duress scripts.
sudo mkdir -p /etc/duress.d  # Global Duress scripts.
```

After creating the directories you can create script and put them in these directories. To assign a password to execute
a particular script you use the duress_sign to create a combination password hash and integrity hash for the script.

```bash
$> duress_sign ~/.duress/delete_workspace.sh
Password: 
Confirm: 
Reading /home/user/.duress/delete_workspace.sh, 33...
Done
6B8B621EFB8050B83AAC734D56BF9165DC55D709CBAD530C6241E8A352587B3F
$> chmod -R 500 ~/.duress
$> ls -al ~/.duress/
drwxr-xr-x 2 user user 4096 Aug 20 15:15 .
drwxr-xr-x 8 user user 4096 Aug 20 15:11 ..
-r-x------ 1 user user   33 Aug 20 15:11 delete_workspace.sh
-r-x------ 1 user user   32 Aug 20 21:49 delete_workspace.sh.sha256
```

**NOTE:** Scripts will only execute with permission masks of 500, 540, or 550

**NOTE:** User generated duress scripts are only run when they attempt to log in AND use a duress password that one of
their scripts is signed with. If user Jill signs their scripts with the same password as a global script, when they use
it the global scripts will run, followed by Jill's duress scripts, but Bob, Jane, or Dan's scripts will not be run even
if they also re-used the same duress scripts.

## PAM Configuration

Modify /etc/pam.d/common-auth from the following defaults:

```bash
auth    [success=1 default=ignore]      pam_unix.so

auth    requisite                       pam_deny.so
```

To the below:

```bash
# Example /etc/pam.d/common-auth
auth    [success=2 default=ignore]      pam_unix.so
auth    [success=1 default=ignore]      pam_duress.so

auth    requisite                       pam_deny.so
```

### Order of Operations Normal Password

- User enters their standard username and password.
- pam_unix.o confirms them and returns PAM_SUCESS and skips 2 past pam_deny.o.

### Order of Operations Duress Password

- The pam_unix.o module first checks standard username and password, but since the duress password is not the users
  actual password it fails resulting in a default behavior of 'ignore' per the configuration.
- PAM then applies the username/password to pam_duress.so which:
  - Enumerates files in /etc/duress.d/
  - Checks for files that have matching .sha256 extensions
  - Hashes the provided password salted with the sha256 hash of the file and compares it with the one stored in the
    .sha256 extension file
  - If the hashes match, the script is executed via:
    - `export PAMUSER=[USERNAME]; /bin/sh [FILE]` for /etc/duress.d scripts (run as root).
    - `export PAMUSER=[USERNAME]; su - [USERNAME] -c "/bin/sh [FILE]"` for ~/.duress scripts (run as the user).
    - NOTE: PAMUSER is set so global duress scripts can specify the account flagging duress.
  - Process is repeated for all files in ~/.duress/ for the user attempting to log in.
  - Finally if ANY script is run, PAM_SUCCESS is return. Otherwise PAM_IGNORE is returned.
- If PAM_SUCESS is returned PAM will skip 1 and move past pam_deny.o to continue the pam module processes, eventually
  dropping to an authenticated shell. Otherwise the default 'ignore' behavior is honored moving to pam_deny.o,
  resulting in a failed authentication.

![Simple Flow Diagram](https://raw.githubusercontent.com/nuvious/pam-duress/main/docs/img/diagram.png "Simple Flow Diagram")

## Testing

It is easy to do a quick test to ensure the duress module is working properly.

```bash
$> mkdir -p ~/.duress
$> echo '#!/bin/sh
echo "Hello World" > /tmp/test.txt' > ~/.duress/hello.sh
$> duress_sign ~/.duress/hello.sh
Password: # Enter a duress password that is NOT your actual password.
Confirm: 
$> chmod 500 ~/.duress/hello.sh
$> chmod 400 ~/.duress/hello.sh.sha256
$> sudo pam_test $USER
Credentials accepted.
Password: # Enter the password you signed the hello.sh script with.
Account is valid. # ...and we still got a valid authentication.
Authenticated
$> cat /tmp/test.txt
Hello World # This shows the test.txt file was created and therefore the script was executed
$> rm /tmp/test.txt
$> sudo pam_test $USER
Credentials accepted.
Password: # Now enter your actual password.
Account is valid. # Note, Hello World doesn't print.
Authenticated
$> cat /tmp/test.txt
cat: /tmp/test.txt: No such file or directory # this shows the file wasn't created and therefore the script wasn't executed
```

## Example Implementations

- [Use Pushover to Notify IT You're Under Duress](docs/examples/Pushover.md)

## Reference

- Initial starter code and test code from [beatgammit/simple-pam](https://github.com/beatgammit/simple-pam).
- Contribution guidelines built from template provided by
  [briandk/CONTRIBUTING.md](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62).