Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ldap-ts-client

Package Overview
Dependencies
Maintainers
1
Versions
43
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ldap-ts-client

Type-safe LDAP client written in typescript

  • 0.9.1-beta8
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Type-safe Promise base LDAP Client

LDAP Client to do low level promise base interaction with ldap server

  • Promise based functions
  • type-safe with Typescript

How to use it:

  • npm i ldap-ts-client
import { IClientConfig, LdapClient } from "ldap-ts-client";

const config: IClientConfig = {
  url: "ldap://Domain.com" /** Domain name here */,
  bindDN: "{USER_NAME}" /** user name to connect to AD server */,
  secret: "{PASSWORD}" /** password for account */,
  baseDN: "{ROOT_OF_TREE}" /** root of tree that want to query */,
};

const client = new LdapClient(config);

// do something with functionalities

// always free-Up after you done the job!
client.unbind();

API Documentation

for full API documentation look at API Website

functionalities:

async queryAttributes()
/** get displayName of all users */
const users = await client.queryAttributes({
  attributes: ["displayName"],
  options: {
    filter:
      "(&(|(objectClass=user)(objectClass=person))(!(objectClass=computer))(!(objectClass=group)))",
    scope: "sub",
    paged: true,
  },
});

// always unbind after finish the operation to prevent memory leak
client.unbind();

Advance Uses:

async query() (raw search to provided full flexibility)
/** get displayName and distinguished name  of empty groups */
const groups = await client.query({
  attributes: ["displayName", "dn"],
  options: {
    filter: "(&(objectClass=group)(!(member=*)))",
    scope: "sub",
    paged: true,
  },
});

// always unbind after finish the operation to prevent memory leak
client.unbind();
async bind() to access underlying api. returns a connected ldap.js client.
NOTICE: lpad.js is using node EventEmitters not ES6 Promises
client.bind().then((client) => {
  client.search(this.config.baseDN, opts, (err, res) => {
    if (err) {
      reject(err);
    }
    res.on("searchEntry", (entry) => {});
    res.on("error", (err) => {});
    res.on("end", function (result) {
      client.unbind();
    });
  });
});

TODO

  • remove dependency to ldap.js package
  • add Windows Integrated Authentication Kerberos

Keywords

FAQs

Package last updated on 18 Apr 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc