Class: Client
ldap.Client Client is a client for ldap protocol in nucleiExample
Example
Table of contents
Constructors
Properties
Methods
- AdvancedSearch
- Authenticate
- AuthenticateWithNTLMHash
- Close
- CollectMetadata
- FindADObjects
- GetADActiveUsers
- GetADAdmins
- GetADDCList
- GetADDomainSID
- GetADGroups
- GetADUserAsRepRoastable
- GetADUserKerberoastable
- GetADUserTrustedForDelegation
- GetADUserWithNeverExpiringPasswords
- GetADUserWithPasswordNotRequired
- GetADUsers
- Search
Constructors
constructor
• new Client(ldapUrl
, realm
, config?
): Client
Parameters
Name | Type |
---|---|
ldapUrl | string |
realm | string |
config? | Config |
Returns
Client
Defined in
ldap.ts:198Properties
BaseDN
•Optional
BaseDN: string
Defined in
ldap.ts:194Host
•Optional
Host: string
Defined in
ldap.ts:182Port
•Optional
Port: number
Defined in
ldap.ts:186Realm
•Optional
Realm: string
Defined in
ldap.ts:190config
•Optional
config: Config
Defined in
ldap.ts:198ldapUrl
• ldapUrl:string
Defined in
ldap.ts:198realm
• realm:string
Defined in
ldap.ts:198Methods
AdvancedSearch
▸ AdvancedSearch(Scope
, TypesOnly
, Filter
, Attributes
, Controls
): SearchResult
AdvancedSearch accepts all values of search request type and return Ldap Entry
its up to user to handle the response
Parameters
Name | Type |
---|---|
Scope | number |
TypesOnly | boolean |
Filter | string |
Attributes | string [] |
Controls | any |
Returns
SearchResult
Example
Defined in
ldap.ts:446Authenticate
▸ Authenticate(username
): boolean
Authenticate authenticates with the ldap server using the given username and password
performs NTLMBind first and then Bind/UnauthenticatedBind if NTLMBind fails
Parameters
Name | Type |
---|---|
username | string |
Returns
boolean
Example
Defined in
ldap.ts:402AuthenticateWithNTLMHash
▸ AuthenticateWithNTLMHash(username
): boolean
AuthenticateWithNTLMHash authenticates with the ldap server using the given username and NTLM hash
Parameters
Name | Type |
---|---|
username | string |
Returns
boolean
Example
Defined in
ldap.ts:416Close
▸ Close():void
close the ldap connection
Returns
void
Example
Defined in
ldap.ts:475CollectMetadata
▸ CollectMetadata():Metadata
CollectLdapMetadata collects metadata from ldap server.
Returns
Metadata
Example
Defined in
ldap.ts:461FindADObjects
▸ FindADObjects(filter
): SearchResult
FindADObjects finds AD objects based on a filter
and returns them as a list of ADObject
Parameters
Name | Type |
---|---|
filter | string |
Returns
SearchResult
Example
Defined in
ldap.ts:212GetADActiveUsers
▸ GetADActiveUsers():SearchResult
GetADActiveUsers returns all AD users
using FilterIsPerson and FilterAccountEnabled filter query
Returns
SearchResult
Example
Defined in
ldap.ts:244GetADAdmins
▸ GetADAdmins():SearchResult
GetADAdmins returns all AD admins
using FilterIsPerson, FilterAccountEnabled and FilterIsAdmin filter query
Returns
SearchResult
Example
Defined in
ldap.ts:340GetADDCList
▸ GetADDCList():SearchResult
GetADDCList returns all AD domain controllers
using FilterIsComputer, FilterAccountEnabled and FilterServerTrustAccount filter query
Returns
SearchResult
Example
Defined in
ldap.ts:324GetADDomainSID
▸ GetADDomainSID():string
GetADDomainSID returns the SID of the AD domain
Returns
string
Example
Defined in
ldap.ts:387GetADGroups
▸ GetADGroups():SearchResult
GetADGroups returns all AD groups
using FilterIsGroup filter query
Returns
SearchResult
Example
Defined in
ldap.ts:308GetADUserAsRepRoastable
▸ GetADUserAsRepRoastable():SearchResult
GetADUserAsRepRoastable returns all AD users that are AsRepRoastable
using FilterIsPerson, and FilterDontRequirePreauth filter query
Returns
SearchResult
Example
Defined in
ldap.ts:372GetADUserKerberoastable
▸ GetADUserKerberoastable():SearchResult
GetADUserKerberoastable returns all AD users that are kerberoastable
using FilterIsPerson, FilterAccountEnabled and FilterHasServicePrincipalName filter query
Returns
SearchResult
Example
Defined in
ldap.ts:356GetADUserTrustedForDelegation
▸ GetADUserTrustedForDelegation():SearchResult
GetADUserTrustedForDelegation returns all AD users that are trusted for delegation
using FilterIsPerson and FilterTrustedForDelegation filter query
Returns
SearchResult
Example
Defined in
ldap.ts:276GetADUserWithNeverExpiringPasswords
▸ GetADUserWithNeverExpiringPasswords():SearchResult
GetAdUserWithNeverExpiringPasswords returns all AD users
using FilterIsPerson and FilterDontExpirePassword filter query
Returns
SearchResult
Example
Defined in
ldap.ts:260GetADUserWithPasswordNotRequired
▸ GetADUserWithPasswordNotRequired():SearchResult
GetADUserWithPasswordNotRequired returns all AD users that do not require a password
using FilterIsPerson and FilterPasswordNotRequired filter query
Returns
SearchResult
Example
Defined in
ldap.ts:292GetADUsers
▸ GetADUsers():SearchResult
GetADUsers returns all AD users
using FilterIsPerson filter query
Returns
SearchResult
Example
Defined in
ldap.ts:228Search
▸ Search(filter
, attributes
): SearchResult
Search accepts whatever filter and returns a list of maps having provided attributes
as keys and associated values mirroring the ones returned by ldap
Parameters
Name | Type |
---|---|
filter | string |
attributes | any |
Returns
SearchResult
Example