IP*Works! Auth V9 - Online Help
IP*Works! Auth V9
Questions / Feedback?

AD Component

Properties   Methods   Events   Configuration Settings   Errors  

The AD component can be used to authenticate users against Active Directory using Kerberos 5.0.

Syntax

nsoftware.IPWorksAuth.Ad

Remarks

The AD component authenticates users against Active Directory. The component implements the Kerberos protocol defined in RFC 1510 and RFC 4120. Thecomponent provides a simple interface to easily authenticate users.

Authentication

When Authenticate is called the component will attempt to authenticate the user with the Active Directory server. The component 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:

  • KRB_AS_REQ -> KDC
  • KRB_AS_REP <- KDC
  • KRB_TGS_REQ -> KDC
  • KRB_TGS_REP <- KDC
  • 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 component 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.
AuthTokenThe authentication token.
PasswordThe user's password.
SPNThe Service Principal Name (SPN).
TimeoutA timeout for the component.
UserThe name and domain of the user to authenticate.

Method List


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

AuthenticateAuthenticates the user.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ResetResets the component properties to their default values.

Event List


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

ErrorInformation about errors during data delivery.
PITrailTraces the messages sent to the server, and the respective replies.

Configuration Settings


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

EncodeAuthTokenWhether to Base64 encode the AuthToken.
EncryptionTypesThe encryption types used during authentication.
LogKerberosPacketsWhether to include the raw Kerberos packets in PITrail output.
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 TCP port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0