# a-passport-ldap

> LDAP authentication strategy for Passport and Node.js

Latest version **0.3.0** (published 2015-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install a-passport-ldap
pnpm add a-passport-ldap
yarn add a-passport-ldap
bun add a-passport-ldap
```

## 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.3.0 |
| Published | 2015-12-23 |
| First published | 2015-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Archer |
| Maintainers | qddegtya |

## Links

- npm: https://www.npmjs.com/package/a-passport-ldap
- Repository: https://github.com/qddegtya/passport-ldap
- Issues: https://github.com/qddegtya/passport-ldap/issues
- npm.io page: https://npm.io/package/a-passport-ldap

## Dependencies (1)

- [ldapjs](https://npm.io/package/ldapjs.md) ^1.0.0

## Recent versions

- 0.3.0 (latest) — 2015-12-23
- 0.2.0 — 2015-12-23
- 0.1.0 — 2015-12-23

## README

[![NPM](https://nodei.co/npm/a-passport-ldap.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/a-passport-ldap/)
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fqddegtya%2Fpassport-ldap.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fqddegtya%2Fpassport-ldap?ref=badge_shield)

# passport-ldap

LDAP authentication strategy for Passport and Node.js

## Usage

### Install

```
npm install a-passport-ldap
```

### Configure Strategy

```
passport.use(new LdapStrategy({
  'ldap': {
    url: 'your ldap server',
    timeout: 1000,
    bind: { dn: 'your username', credentials: 'your password' },
    search:
    {
      dn: 'DC=your dc,DC=com',
      scope: 'sub',
      objectClass: 'user',
      field: 'which field'
    }
  }
}));
```

### init

```
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

// add
app.use(passport.initialize());
```

### Express

```
router.post('/ldap'
, function(req, res, next) {
  passport.authenticate('ldapstrategy', {session: false}, function(err, user, info) {
    if(!user || err) {
      res.status(401);
      return res.json({
        'code': 401,
        'message': 'Invalid authentication.'
      });
    }
    // mount
    req.user = user;
    next();
  })(req, res, next)
}
, function(req, res, next) {
  return res.json({
    'mail': req.user.mail,
    'name': req.user.name,
    'lastLogon': req.user.lastLogon
  });
})
```

## License

[The MIT License](http://opensource.org/licenses/MIT)


[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fqddegtya%2Fpassport-ldap.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fqddegtya%2Fpassport-ldap?ref=badge_large)
## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars2.githubusercontent.com/u/773248?v=4" width="100px;" alt="Archer (炽宇)"/><br /><sub><b>Archer (炽宇)</b></sub>](http://xiaoa.name)<br />[💻](https://github.com/qddegtya/passport-ldap/commits?author=qddegtya "Code") |
| :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

---
_Source: https://npm.io/package/a-passport-ldap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._