pam: Haskell binding for C PAM API

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

This package provides PAM interface for Haskell programs. See the README on GitHub at see the README on GitHub at <https://github.com/oscar-h64/pam-haskell#readme for more information.

[Skip to Readme]

Properties

Versions	0.1, 0.2.0.0, 0.2.0.0
Change log	ChangeLog.md
Dependencies	base (>=4 && <5) [details]
License	BSD-3-Clause
Copyright	(c) 2011 Evgeny Tarasov (c) 2020 Oscar Harris
Author	Evgeny Tarasov <etarasov.ekb@gmail.com>
Maintainer	Oscar Harris <oscar@oscar-h.com>
Category	System, Authentication
Home page	https://github.com/oscar-h64/pam-haskell
Bug tracker	https://github.com/oscar-h64/pam-haskell/issues
Source repo	head: git clone https://github.com/oscar-h64/pam-haskell
Uploaded	by OscarH at 2020-07-01T19:49:23Z

Modules

System
- Posix
  - System.Posix.PAM
    - System.Posix.PAM.Internals
    - System.Posix.PAM.LowLevel
    - System.Posix.PAM.Types

Downloads

pam-0.2.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

EvgenyTarasov, chris_martin, OscarH

For package maintainers and hackage trustees

edit package information

Readme for pam-0.2.0.0

[back to package description]

pam

Hackage

Haskell bindings for PAM. Note that this does not currently include the required bindings to write PAM modules

Usage:

To authenticate a user test using the system-local-login PAM configuration:

authenticate "system-local-login" "test" "PASSWORD"

To check if a user test exists using the system-auth PAM configuration:

checkAccount "system-auth" "test"

If the operation was successful then PamSuccess will be returned, otherwise PamCode a, where a represents the reason for the failure.

pamCodeToMessage, pamCodeToCDefine and pamCodeDetails can be used to get further details about the response, and isSuccess can be used to check if the operation was successful. See the Haddock documentation for more details on these functions.

Documentation:

The documentation is available on Hackage

Changes in v0.2.0.0:

authenticate function now returns MonadIO m => m PamRetCode rather than IO (Either Int ())
authSuccess :: PamRetCode -> Bool added which checks if the given PamRetCode is PamSuccess or not
whenSuccess :: MonadIO m => PamRetCode -> m PamRetCode -> m PamRetCode added, which returns the second argument if the given response code is PamSuccess, otherwise it returns the given response code (useful for continuing only if the PAM action succeeded).
pamCodeToMessage, pamCodeToCDefine and pamCodeDetails now take a PamRetCode rather than an Int
checkAccount function has now been implemented

Planned Changes:

Document and refactoring the code (started)
Add ability to give multiple passwords (for 2FA systems) (see #2)
Add functions that do the prompting rather than being given details - useful as if a program using the library is intended to be distributed the number of prompts will not be known (see #3)
Add functions to allow writing PAM modules in Haskell (see #8)

Contributing:

See here for more information