Kerberos Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksAuth_Kerberos

Procedural Interface

 ipworksauth_kerberos_open();
 ipworksauth_kerberos_close($res);
 ipworksauth_kerberos_register_callback($res, $id, $function);
 ipworksauth_kerberos_get_last_error($res);
 ipworksauth_kerberos_get_last_error_code($res);
 ipworksauth_kerberos_set($res, $id, $index, $value);
 ipworksauth_kerberos_get($res, $id, $index);
 ipworksauth_kerberos_do_authenticate($res);
 ipworksauth_kerberos_do_config($res, $configurationstring);
 ipworksauth_kerberos_do_doevents($res);
 ipworksauth_kerberos_do_interrupt($res);
 ipworksauth_kerberos_do_reset($res);

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.

AuthToken Property (IPWorksAuth_Kerberos Class)

The authentication token.

Object Oriented Interface

public function getAuthToken();

Procedural Interface

ipworksauth_kerberos_get($res, 1 );

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.

Data Type

Binary String

KDCHost Property (IPWorksAuth_Kerberos Class)

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

Object Oriented Interface

public function getKDCHost();
public function setKDCHost($value);

Procedural Interface

ipworksauth_kerberos_get($res, 2 );
ipworksauth_kerberos_set($res, 2, $value );

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.

Data Type

String

KDCPort Property (IPWorksAuth_Kerberos Class)

The port for the Key Distribution Center (KDC).

Object Oriented Interface

public function getKDCPort();
public function setKDCPort($value);

Procedural Interface

ipworksauth_kerberos_get($res, 3 );
ipworksauth_kerberos_set($res, 3, $value );

Default Value

88

Remarks

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

Data Type

Integer

KeytabFile Property (IPWorksAuth_Kerberos Class)

The Kerberos Keytab file.

Object Oriented Interface

public function getKeytabFile();
public function setKeytabFile($value);

Procedural Interface

ipworksauth_kerberos_get($res, 4 );
ipworksauth_kerberos_set($res, 4, $value );

Default Value

''

Remarks

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

Data Type

String

Password Property (IPWorksAuth_Kerberos Class)

The user's password.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksauth_kerberos_get($res, 5 );
ipworksauth_kerberos_set($res, 5, $value );

Default Value

''

Remarks

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

Data Type

String

SPN Property (IPWorksAuth_Kerberos Class)

The Service Principal Name (SPN).

Object Oriented Interface

public function getSPN();
public function setSPN($value);

Procedural Interface

ipworksauth_kerberos_get($res, 6 );
ipworksauth_kerberos_set($res, 6, $value );

Default Value

''

Remarks

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

Data Type

String

Timeout Property (IPWorksAuth_Kerberos Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksauth_kerberos_get($res, 7 );
ipworksauth_kerberos_set($res, 7, $value );

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 fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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.

Data Type

Integer

User Property (IPWorksAuth_Kerberos Class)

The name and domain of the user to authenticate.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksauth_kerberos_get($res, 8 );
ipworksauth_kerberos_set($res, 8, $value );

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

Data Type

String

UseTCP Property (IPWorksAuth_Kerberos Class)

Whether TCP is used when establishing the connection.

Object Oriented Interface

public function getUseTCP();
public function setUseTCP($value);

Procedural Interface

ipworksauth_kerberos_get($res, 9 );
ipworksauth_kerberos_set($res, 9, $value );

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.

Data Type

Boolean

Authenticate Method (IPWorksAuth_Kerberos Class)

Authenticates the user.

Object Oriented Interface

public function doAuthenticate();

Procedural Interface

ipworksauth_kerberos_do_authenticate($res);

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.

Config Method (IPWorksAuth_Kerberos Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksauth_kerberos_do_config($res, $configurationstring);

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.

DoEvents Method (IPWorksAuth_Kerberos Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksauth_kerberos_do_doevents($res);

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.

Interrupt Method (IPWorksAuth_Kerberos Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksauth_kerberos_do_interrupt($res);

Remarks

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

Reset Method (IPWorksAuth_Kerberos Class)

Resets the class properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksauth_kerberos_do_reset($res);

Remarks

This method resets the properties to their default values.

Error Event (IPWorksAuth_Kerberos Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_kerberos_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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.

Log Event (IPWorksAuth_Kerberos Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksauth_kerberos_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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

PITrail Event (IPWorksAuth_Kerberos Class)

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

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksauth_kerberos_register_callback($res, 3, array($this, 'firePITrail'));

Parameter List

 'direction'
 'message'

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 (Kerberos Class)

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 (Kerberos Class)

kerberos Errors

UDP Errors

TCP/IP Errors