IPWorks Auth 2020 JavaScript Edition

Questions / Feedback?

ActiveDirectory Class

Properties   Methods   Events   Configuration Settings   Errors  

The ActiveDirectory class can be used to authenticate users against Active Directory using Kerberos 5.0.




The ActiveDirectory class authenticates users against Active Directory. Authentication is performed using the Kerberos protocol defined in RFC 1510 and RFC 4120.


When Authenticate is called the class will attempt to authenticate the user with the Active Directory server. The class will communicate with the ADHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

A typical sequence of messages would be:

  • AuthToken is populated with the constructed KRB_AP_REP message.

Communication with the ADHost can be seen through the PITrail event.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ADHostThe domain name or IP address of the Active Directory server.
ADPortThe port for the Active Directory server.
AuthMechanismThe authentication mechanism to be used when connecting to the Active Directory server.
AuthTokenThe authentication token.
PasswordThe user's password.
SPNThe Service Principal Name (SPN).
TimeoutA timeout for the class.
UserThe name and domain of the user to authenticate.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AuthenticateAuthenticates the user.
ChangePasswordChanges the password for the specified user.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ListComputersLists all computers in the directory.
ListGroupMembersList all members of a group.
ListGroupsList all groups in the directory.
ListUserGroupsLists all groups a user is a part of.
ResetResets the class properties to their default values.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ComputerListFired for each computer entry returned.
ErrorInformation about errors during data delivery.
GroupListFired for each group entry returned.
LogFires once for each log message.
PITrailTraces the messages sent to the server, and the respective replies.
UserListFired once for each user entry returned.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CredentialsCacheFileThe credentials cache file.
EncodeAuthTokenWhether to Base64 encode the AuthToken.
EncryptionTypesThe encryption types used during authentication.
KeytabFileThe Kerberos Keytab file.
LogKerberosPacketsWhether to include the raw Kerberos packets in PITrail output.
LogLevelThe level of detail that is logged.
UsePlatformKerberosAPIWhether to use the platform Kerberos API.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the class to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Auth 2020 JavaScript Edition - Version 20.0 [Build 7721]