Kerberos Class

Properties   Methods   Events   Config Settings   Errors  

The Kerberos class can be used to authenticate users using Kerberos 5.0.

Syntax

ipworksauth.kerberos()

Remarks

The Kerberos class implements the Kerberos protocol defined in RFC 1510 and RFC 4120. The class provides a simple interface to easily authenticate users.

Authentication

When Authenticate is called the class will attempt to authenticate the user with the Key Distribution Center (KDC). The class will communicate with the KDCHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

• SPN (required)
• User (required)
• Password (required)
• KDCHost (required)

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 KDCHost 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.

Method List

---

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

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.

Config Settings

---

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

Kerberos.AuthToken Property

The authentication token.

Syntax

getAuthToken(): Uint8Array;

Default Value

""

Remarks

This property holds the authentication token.

This property will be populated after calling Authenticate. This may be used in by another entity to authenticate to the service. For instance this may be used in HTTP to authenticate to a web service.

The content of this property is a KRB_AP_REQ message. This is sometimes referred to as an "Authentication Header". It is comprised of the service ticket that was obtained from the TGS and an encrypted authenticator.

This property is read-only.

Kerberos.KDCHost Property

The domain name or IP address of the Key Distribution Center (KDC).

Syntax

getKDCHost(): string;
setKDCHost(KDCHost: string): void;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the Key Distribution Center (KDC).

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

Kerberos.KDCPort Property

The port for the Key Distribution Center (KDC).

Syntax

getKDCPort(): number;
setKDCPort(KDCPort: number): void;

Default Value

88

Remarks

This property specifies the port for the Key Distribution Center (KDC). The default value is 88.

Kerberos.KeytabFile Property

The Kerberos Keytab file.

Syntax

getKeytabFile(): string;
setKeytabFile(keytabFile: string): void;

Default Value

""

Remarks

This property specifies the path to a Kerberos Keytab file. If specified, the credentials are read from this file.

Kerberos.Password Property

The user's password.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

This property specifies the user's password. This must be set before calling Authenticate.

Kerberos.SPN Property

The Service Principal Name (SPN).

Syntax

getSPN(): string;
setSPN(SPN: string): void;

Default Value

""

Remarks

This property specifies the Service Principal Name (SPN). This must be set before calling Authenticate.

Kerberos.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Kerberos.User Property

The name and domain of the user to authenticate.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

This property specifies the name and realm/domain of the user. The value specified must be in one of the following formats:

• user@domain
• domain/user

Kerberos.UseTCP Property

Whether TCP is used when establishing the connection.

Syntax

isUseTCP(): boolean;
setUseTCP(useTCP: boolean): void;

Default Value

FALSE

Remarks

This property specifies whether TCP is used as the transport protocol when establishing the connection. By default this property is False and UDP will be used.

Kerberos.authenticate Method

Authenticates the user.

Syntax

async kerberos.authenticate(): Promise<void>

Remarks

This method authenticates the User.

Authentication

When Authenticate is called the class will attempt to authenticate the user with the Key Distribution Center (KDC). The class will communicate with the KDCHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

• SPN (required)
• User (required)
• Password (required)
• KDCHost (required)

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 KDCHost can be seen through the PITrail event.

Kerberos.config Method

Sets or retrieves a configuration setting.

Syntax

async kerberos.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Kerberos.doEvents Method

Processes events from the internal message queue.

Syntax

async kerberos.doEvents(): Promise<void>

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Kerberos.interrupt Method

Interrupt the current method.

Syntax

async kerberos.interrupt(): Promise<void>

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Kerberos.reset Method

Resets the class properties to their default values.

Syntax

async kerberos.reset(): Promise<void>

Remarks

This method resets the properties to their default values.

Kerberos.Error Event

Information about errors during data delivery.

Syntax

kerberos.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Kerberos.Log Event

Fires once for each log message.

Syntax

kerberos.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

LogType identifies the type of log entry. Possible values are:

• Info
• Verbose
• Debug

Kerberos.PITrail Event

Traces the messages sent to the server, and the respective replies.

Syntax

kerberos.on('PITrail', listener: (e: {readonly direction: number, readonly message: string}) => void )

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server. To include the raw packets set LogKerberosPackets to True.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

Config Settings (class ipworksauth.kerberos)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

KERBEROS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworksauth.kerberos)

kerberos Errors

	950   Busy performing other action.
	951   Invalid username.
	952   Received error message. The error message contains the description.
	953   Message integrity check error.
	954   Unsupported encryption type.

UDP Errors

	104   UDP is already Active.
	106   You cannot change the LocalPort while the class is Active.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	109   The class must be Active for this operation.
	112   Cannot change MaxPacketSize while the class is Active.
	113   Cannot change ShareLocalPort option while the class is Active.
	114   Cannot change RemoteHost when UseConnection is set and the class Active.
	115   Cannot change RemotePort when UseConnection is set and the class is Active.
	116   RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
	117   Cannot change UseConnection while the class is Active.
	118   Message can't be longer than MaxPacketSize.
	119   Message too short.
	434   Unable to convert string to selected CodePage

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).