saostad
Typescript typedef and meta-data generator for LDAP Schema
It can be useful to interact from schema-aware/type-safe LDAP Client with LDAP servers like active directory.
How to use
npm i ldap-schema-ts-generatorimport { Client, IClientConfig } from "ldap-ts-client";
import {
getSchemaAttributes,
getSchemaClasses,
generateInterfaceFiles,
} from "ldap-schema-ts-generator";
const options = {
user: "**********",
pass: "************",
ldapServerUrl: "ldap://domain.com",
baseDn: "DC=domain,DC=com",
};
const client = new Client(options);
const objectAttributes = await getSchemaAttributes({ client });
const objectClasses = await getSchemaClasses({ client });
await generateInterfaceFiles({ objectAttributes, objectClasses });
}
API
use api website for more details
Functionalities
- generate typescript interfaces for each object class
- generate relations between attributes (json)
- generate graphql schema:
- type for each object class
- basic CRUD operations for each object class
- generate typescript enum for supported:
- controls
- capabilities
- extensions
- policies
- structural classes
Sample Generated File:
`ts Account.ts
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.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[];
}
`
- dn: CN=ms-DS-Object-Reference,CN=Schema,CN=Configuration,DC=ki,DC=local
*/
"msDS-ObjectReference"?: object[];
}
TODO:
- <input disabled="" type="checkbox"> handle relations (forwardLink/BackLink) via linkID field
- <input checked="" disabled="" type="checkbox"> change relation DN fields type from object to string
- <input checked="" disabled="" type="checkbox"> generate Enum for ldap controls supported by server from RootDSE
- <input checked="" disabled="" type="checkbox"> generate Enum for ldap capabilities supported by server from RootDSE
- <input checked="" disabled="" type="checkbox"> generate Enum for ldap extensions supported by server from RootDSE
- <input checked="" disabled="" type="checkbox"> generate Enum for ldap policies supported by server from RootDSE
- <input disabled="" type="checkbox"> generate Base DNs from RootDSE (List of DNs of all the naming contexts and application partitions maintained by the DC)
- <input disabled="" type="checkbox"> generate naming contexts fields from RootDSE (e.g. defaultNamingContext, configurationNamingContext, schemaNamingContext, rootNamingContext)
- <input disabled="" type="checkbox"> Active Directory create a functionality to fetch all meta data about server ref
- <input disabled="" type="checkbox"> Active Directory Group Type Flags and UserAccountControl flags
- <input disabled="" type="checkbox"> add option to customize generated file names with prefix/postfix (now it 's using Pascal case of ldap display name as interface and file name)
- <input disabled="" type="checkbox"> create out folders if not exist instead of throwing error
- <input checked="" disabled="" type="checkbox"> generate graphql types and CRUD operations
- <input checked="" disabled="" type="checkbox"> generate Type for each objectClass in schema
- <input checked="" disabled="" type="checkbox"> generate custom scalar types (e.g. Date)
- <input checked="" disabled="" type="checkbox"> respect inheritance
- <input disabled="" type="checkbox"> respect relations by linkID attribute
- <input checked="" disabled="" type="checkbox"> use dn as identification field
- <input checked="" disabled="" type="checkbox"> generate general operations for each Type:
- <input checked="" disabled="" type="checkbox"> Query get all
- <input checked="" disabled="" type="checkbox"> Query get by dn
- <input checked="" disabled="" type="checkbox"> Mutation delete by dn
- <input checked="" disabled="" type="checkbox"> Mutation update by dn (input only not readonly attributes)
- <input checked="" disabled="" type="checkbox"> generate Type for each objectClass in schema
Know Issues
- when extends to another interface sometimes a field is optional but in other interface is not so typescript gives compatibility warning which prevent generated code to be executed with typescript complier. to fix the problem an extra comment
// @ts-ignoreadded in top of all generated interfaces
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 better understand the ldap protocol:
- 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/
- Active Directory Technical Specification