# node-linux-pam-fork

> Asynchronous PAM authentication for NodeJS

Latest version **0.0.2** (published 2021-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-linux-pam-fork
pnpm add node-linux-pam-fork
yarn add node-linux-pam-fork
bun add node-linux-pam-fork
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-03-26 |
| First published | 2021-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.6.0 |
| Dependencies | 4 |
| Unpacked size | 21.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Angus Comrie |
| Maintainers | veggiesaurus |
| Keywords | pam, linux-pam, authentication |

## Links

- npm: https://www.npmjs.com/package/node-linux-pam-fork
- Repository: https://github.com/veggiesaurus/node-linux-pam-fork
- Homepage: https://github.com/veggiesaurus/node-linux-pam-fork#readme
- Issues: https://github.com/veggiesaurus/node-linux-pam-fork/issues
- npm.io page: https://npm.io/package/node-linux-pam-fork

## Dependencies (4)

- [bindings](https://npm.io/package/bindings.md) 1.5.0
- [node-addon-api](https://npm.io/package/node-addon-api.md) 1.6.3
- [node-pre-gyp-github](https://npm.io/package/node-pre-gyp-github.md) ^1.4.3
- [@mapbox/node-pre-gyp](https://npm.io/package/@mapbox/node-pre-gyp.md) ^1.0.1

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@oxyhq/services](https://npm.io/package/@oxyhq/services.md) — 2.3K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-03-26

## README

# node-linux-pam-fork

Fork of [node-linux-pam](https://github.com/aironavt/node-linux-pam) to enable prebuilt modules.

Asynchronous PAM authentication for NodeJS. Implements two PAM methods [pam_authenticate(3)](http://www.linux-pam.org/Linux-PAM-html/adg-interface-by-app-expected.html#adg-pam_authenticate) и [pam_acct_mgmt(3)](http://www.linux-pam.org/Linux-PAM-html/adg-interface-by-app-expected.html#adg-pam_acct_mgmt).

## Usage
```js
const { pamAuthenticate, pamErrors } = require('node-linux-pam');

const options = {
    username: 'username',
    password: 'password',
};

pamAuthenticate(options, function(err, code) {
    if (!err) {
        console.log("Authenticated!");
        return;
    }

    if (err && code === pamErrors.PAM_NEW_AUTHTOK_REQD) {
        console.log('Authentication token is expired');
        return;
    }

    console.log(err);
});
```

## Requirements

This module require atleast `NodeJS 8`

Note that you will have a warning about N-API in version < 10, you can disable it by adding the `--no-warnings` flag to node

First you need to install the development version of PAM libraries for your distro.

- *Centos and RHEL:* yum install pam-devel
- *Debian/Ubuntu:* apt-get install libpam0g-dev

The user running the NodeJS process must have read permissions on the `/etc/shadow` file.

## Installation

```
npm install node-linux-pam -S
```

## Options

Name | Description | Default | Required
--- | --- | --- | --- |
username | The name of the target user  | '' | Yes
password | User password | '' | Yes
serviceName | The name of the service to apply | 'login' | No
remoteHost | Sets the PAM_RHOST option via the [pam_set_item(3)](http://www.linux-pam.org/Linux-PAM-html/adg-interface-by-app-expected.html#adg-pam_set_item) call | '' | No

## Responce PAM code

Code |  | Description
--- | --- | --- |
PAM_SUCCESS | 0 | Successful function return
PAM_OPEN_ERR | 1 | dlopen() failure when dynamically loading a service module
PAM_SYMBOL_ERR | 2 | Symbol not found
PAM_SERVICE_ERR | 3 | Error in service module
PAM_SYSTEM_ERR | 4 | System error
PAM_BUF_ERR | 5 | Memory buffer error
PAM_PERM_DENIED | 6 | Permission denied
PAM_AUTH_ERR | 7 | Authentication failure
PAM_CRED_INSUFFICIENT | 8 | Can not access authentication data due to insufficient credentials
PAM_AUTHINFO_UNAVAIL | 9 | Underlying authentication service can not retrieve authentication information
PAM_USER_UNKNOWN | 10 | User not known to the underlying authenticaiton module
PAM_MAXTRIES | 11 | An authentication service has maintained a retry count which has been reached. No further retries should be attempted
PAM_NEW_AUTHTOK_REQD | 12 | New authentication token required. This is normally returned if the machine security policies require that the password should be changed beccause the password is NULL or it has aged
PAM_ACCT_EXPIRED | 13 | User account has expired 
PAM_SESSION_ERR | 14 | Can not make/remove an entry for the specified session
PAM_CRED_UNAVAIL | 15 | Underlying authentication service can not retrieve user credentials unavailable
PAM_CRED_EXPIRED | 16 | User credentials expired
PAM_CRED_ERR | 17 | Failure setting user credentials
PAM_NO_MODULE_DATA | 18 | No module specific data is present
PAM_CONV_ERR | 19 | Conversation error
PAM_AUTHTOK_ERR | 20 | Authentication token manipulation error
PAM_AUTHTOK_RECOVERY_ERR | 21 | Authentication information cannot be recovered
PAM_AUTHTOK_LOCK_BUSY | 22 | Authentication token lock busy
PAM_AUTHTOK_DISABLE_AGING | 23 | Authentication token aging disabled
PAM_TRY_AGAIN | 24 | Preliminary check by password service
PAM_IGNORE | 25 | Ignore underlying account module regardless of whether the control flag is required, optional, or sufficient
PAM_ABORT | 26 | Critical error (?module fail now request)
PAM_AUTHTOK_EXPIRED | 27 | user's authentication token has expired
PAM_MODULE_UNKNOWN | 28 | module is not known
PAM_BAD_ITEM | 29 | Bad item passed to pam_*_item()
PAM_CONV_AGAIN | 30 | conversation function is event driven and data is not available yet
PAM_INCOMPLETE | 31 | please call this function again to complete authentication stack. Before calling again, verify that conversation is completed

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/node-linux-pam-fork · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._