Metadata-Version: 2.0
Name: radicale-auth-PAM
Version: 0.2
Summary: PAM authentication plugin for Radicale
Home-page: https://gitlab.com/jello/radicale_auth_PAM
Author: Joseph Nahmias
Author-email: joe@nahmias.net
License: GPL3+
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins 
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Requires-Dist: python-pam

# PAM authentication plugin for Radicale

[Radicale] is a CalDAV and CardDAV server, for storing calendars and
contacts.  This python module provides an authentication plugin for Radicale
to make use of the [Linux PAM] system library.

[Radicale]: https://radicale.org/
[Linux PAM]: http://www.linux-pam.org/


## Installation

```shell
pip3 install radicale-auth-PAM
```

## Configuration

```INI
[auth]
# Authentication method
type = radicale_auth_PAM
# PAM Service used for authentication
#pam_service = login
```

By default, we use the login PAM service to do authentication.  However, you
can create a custom PAM service if want.  For example, if you have `pam_service=radicale` and then have the following contents in `/etc/pam.d/radicale`:

```
#%PAM-1.0
# /etc/pam.d/radicale

auth required pam_succeed_if.so quiet_success user ingroup radicale-users
@include common-auth
```

Then users will need to be a member of the `radicale-users` group before being
granted access.


