pam_cryptvolume: A Python repository from Rohja

= WARNING =

This code is not meant to be secure. It's for educational purpose only. Use it at your own risks.

= PACKAGES ADDED ON VM =

* libpam-python
* python-pam

= PATHS =

Python script: /lib/security/pam_luks.py
Addition in pam configuration in /etc/pam.d/common-auth

= INSTALLATION =

You need to add this line and the end of /etc/pam.d/common-auth:
auth sufficient pam_python.so /lib/security/pam_luks.py

= CONFIGURATION =

For each user that will user pam_luks, you'll need to create a
configuration file named .pam_luks (rw-------) in /home/<username>.
That file contains JSON formated data. The main list ([]) contains
all the dictionary ({}) that will define which volumes should be
mounted while a user log-in. Each dictionary need to contain at
least two fields: "from" and "to".

  <from> is a string. It's the path to the encrypted volume.
  <to> is also a string. It's the path to the mount point for the
    encrypted volume.

Example of .pam_luks file:

[
  {
    "from": "/dev/sdb1",
    "to": "/home/myuser/mymountpoint"
  },
  {
    "from": "/dev/sdh3",
    "to": "/var/secret"
  }
]

If there's an error with the configuration file or a volume, some
details will be writen in your syslog auth file (maybe something
like /var/log/auth.log...).

= CONFIGURATION MANAGER =

The script named cryptvolume-conf.py is a configuration manager,
it allow you to add/remove/list volumes in your configuration and
check if the configuration is json-complient with all the required
fields. It also try to check is the volume is a valid Luks volume
and display a message if it's not.

= ISSUES =

ATM... none ! :)

= WARNING =

There's no "error detection" while using cryptsetup so your
volume NEED to be a VALID volume or everything will just "act
randomly". You need to format your volume with a valid file
system that can be detected while using the "mount" command
as root.
Rohja/pam_cryptvolume
