ldap-schema-ts-generator

Ldap Active Directory Schema Typescript Generator

How to use

npm i ldap-schema-ts-generator

import {
  getSchemaAttributes,
  getSchemaClasses,
  generateInterfaceFiles,
} from "ldap-schema-ts-generator";

async function main() {
  const schemaDn = "CN=Schema,CN=Configuration,DC=domain,DC=com";
  const options = {
    user: "**********",
    pass: "************",
    ldapServerUrl: "ldap://domain.com",
  };

  const objectAttributes = await getSchemaAttributes({ schemaDn, options });

  const objectClasses = await getSchemaClasses({ schemaDn, options });

  await generateInterfaceFiles({ objectAttributes, objectClasses });
}

main().catch((err) => {
  console.log(err);
});

Options:

options?: {
    /** default generated folder of root directory of you project */
    outputFolder?: string;
    /** use prettier to format generated files. default true */
    usePrettier?: boolean;
    /** create index file for output folder. default true */
    indexFile: boolean;
  };

API

use api website for more details

Result

creates typescript interface for each LDAP class that exist in schema

Sample Generated File:

import { Top } from "./Top";
import { MsExchBaseClass } from "./MsExchBaseClass";

/**  - object class: container
 *  - child of class: top
 *  - dn: CN=Container,CN=Schema,CN=Configuration,DC=ki,DC=local
 */

export interface Container extends Top, MsExchBaseClass {
  /**  - attributeSyntax: 2.5.5.12
   *   - attributeID: 2.5.4.3
   *   - adminDisplayName: Common-Name
   *   - adminDescription: Common-Name
   *   - dn: CN=Common-Name,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  readonly cn: string;

  /**  - attributeSyntax: 2.5.5.12
   *   - attributeID: 1.2.840.113556.1.2.508
   *   - adminDisplayName: ms-Exch-X500-RDN
   *   - adminDescription: ms-Exch-X500-RDN
   *   - dn: CN=ms-Exch-X500-RDN,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  x500RDN?: string;

  /**  - attributeSyntax: 2.5.5.4
   *   - attributeID: 1.2.840.113556.1.4.7000.102.65
   *   - adminDisplayName: ms-Exch-Template-RDNs
   *   - adminDescription: ms-Exch-Template-RDNs
   *   - dn: CN=ms-Exch-Template-RDNs,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  msExchTemplateRDNs?: string[];

  /**  - attributeSyntax: 2.5.5.1
   *   - attributeID: 1.2.840.113556.1.4.7000.102.50004
   *   - adminDisplayName: ms-Exch-Policy-List
   *   - adminDescription: ms-Exch-Policy-List
   *   - dn: CN=ms-Exch-Policy-List,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  msExchPolicyList?: object[];

  /**  - attributeSyntax: 2.5.5.9
   *   - attributeID: 1.2.840.113556.1.2.296
   *   - adminDisplayName: ms-Exch-Container-Info
   *   - adminDescription: ms-Exch-Container-Info
   *   - dn: CN=ms-Exch-Container-Info,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  containerInfo?: number;

  /**  - attributeSyntax: 2.5.5.1
   *   - attributeID: 1.2.840.113556.1.4.7000.102.1027
   *   - adminDisplayName: ms-Exch-Export-Containers-BL
   *   - adminDescription: ms-Exch-Export-Containers-BL
   *   - dn: CN=ms-Exch-Export-Containers-BL,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  msExchExportContainersBL?: object;

  /**  - attributeSyntax: 2.5.5.1
   *   - attributeID: 1.2.840.113556.1.4.1840
   *   - adminDisplayName: ms-DS-Object-Reference
   *   - adminDescription: A link to the object that uses the data stored in the object that contains this attribute.
   *   - dn: CN=ms-DS-Object-Reference,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  "msDS-ObjectReference"?: object[];

  /**  - attributeSyntax: 2.5.5.9
   *   - attributeID: 1.2.840.113556.1.2.471
   *   - adminDisplayName: Schema-Version
   *   - adminDescription: Schema-Version
   *   - dn: CN=Schema-Version,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  readonly schemaVersion?: number[];

  /**  - attributeSyntax: 2.5.5.1
   *   - attributeID: 1.2.840.113556.1.4.213
   *   - adminDisplayName: Default-Class-Store
   *   - adminDescription: Default-Class-Store
   *   - dn: CN=Default-Class-Store,CN=Schema,CN=Configuration,DC=ki,DC=local
   */
  readonly defaultClassStore?: object[];
}

TODO:

• handle relations (forwardLink/BackLink) via linkID field
• change relation filed type from object to something more relevant
• generate ldap controls supported by server
• generate ldap capabilities supported by server
• generate ldap extensions supported by server
• generate ldap policies supported by server

Know Issues

• when extends to another interface sometimes a field is optional but in other interface is not so typescript gives compatibility warning

Credit

• OID info source: https://ldap.com/ldap-oid-reference-guide/
• Policies info source: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-adts/3f0137a1-63df-400c-bf97-e1040f055a99
• Capabilities info source: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-adts/3ed61e6c-cfdc-487d-9f02-5a3397be3772
• Websites that helped me to understand ldap protocol better:
  • https://ldapwiki.com/wiki/LDAP
  • https://www.oreilly.com/library/view/active-directory-4th/
  • https://blog.stealthbits.com/a-guide-to-active-directory-linked-attributes/
  • https://www.neroblanco.co.uk/2015/07/links-and-backlinks-in-active-directory-for-exchange/
  • https://docs.oracle.com/cd/E19957-01/817-6707/controls.html
  • https://blog.kloud.com.au/2016/09/26/active-directory-what-are-linked-attributes/