From 4730628fbbfed65797dbf0442a766508cf6b6e6e Mon Sep 17 00:00:00 2001
From: xenago <xenago@users.noreply.github.com>
Date: Sat, 9 Jul 2022 19:30:28 -0400
Subject: [PATCH] Add customization and background information

---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 5f7250e..a45e5ba 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-# libpam
-Patch Debian's PAM to support longer passwords
+# sftpmgr libpam
+Patch PAM on Debian 11 "bullseye" to support longer passwords (increased from <512 to <4096).
 
 ## Usage
 
-1. Download components which are intended to be installed from GitHub Actions, e.g:
+1. Download components from GitHub Actions, e.g:
 
     ```
     wget https://github.com/sftpmgr/libpam/releases/download/UserBuild_2022.06.26_02-09/libpam-modules_1.4.0-9+deb11u1_amd64.deb
@@ -11,7 +11,7 @@ Patch Debian's PAM to support longer passwords
     wget https://github.com/sftpmgr/libpam/releases/download/UserBuild_2022.06.26_02-09/libpam-runtime_1.4.0-9+deb11u1_all.deb
     wget https://github.com/sftpmgr/libpam/releases/download/UserBuild_2022.06.26_02-09/libpam0g_1.4.0-9+deb11u1_amd64.deb
     ```
-2. Install downloaded components:
+2. Install downloaded packages, e.g.:
 
     ```
     sudo dpkg -i libpam-modules_1.4.0-9+deb11u1_amd64.deb
@@ -20,9 +20,11 @@ Patch Debian's PAM to support longer passwords
     sudo dpkg -i libpam0g_1.4.0-9+deb11u1_amd64.deb
     ```
     
-    or
-    
-    ```
-    sudo dpkg -i *.deb
-    ```
+## Customization
+
+See `.github/workflows/ci.yaml` - this consists of a very simple change to `PAM_MAX_RESP_SIZE` in `libpam/include/security/_pam_types.h`.
+
+## Background
+
+When using PAM's `pam_exec.so` with `expose_authtok` enabled, the password is truncated to 511 octets. More [discussion here](https://github.com/linux-pam/linux-pam/issues/59).