# Struct ipworksauth::Kerberos

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

## Syntax

```text
ipworksauth::Kerberos
```

## Remarks

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

**Authentication**

When [authenticate](#authenticate-method-kerberos-struct) is called the struct will attempt to authenticate the user with the Key Distribution Center (KDC). The struct will communicate with the [kdc_host](#kdc_host-property-kerberos-struct) to obtain a service ticket and populate [auth_token](#auth_token-property-kerberos-struct). The following properties are required when calling this method:

- [spn](#spn-property-kerberos-struct) (required)
- [user](#user-property-kerberos-struct) (required)
- [password](#password-property-kerberos-struct) (required)
- [kdc_host](#kdc_host-property-kerberos-struct) (required)

A typical sequence of messages would be:

- KRB_AS_REQ -> KDC
- KRB_AS_REP <- KDC
- KRB_TGS_REQ -> KDC
- KRB_TGS_REP <- KDC
- [auth_token](#auth_token-property-kerberos-struct) is populated with the constructed KRB_AP_REP message.

Communication with the [kdc_host](#kdc_host-property-kerberos-struct) can be seen through the [on_pi_trail](#on_pi_trail-event-kerberos-struct) event.

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksAuth. Due to this, the Kerberos struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of Kerberos when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [auth_token](#auth_token-property-kerberos-struct) | The authentication token. |
| [kdc_host](#kdc_host-property-kerberos-struct) | The domain name or IP address of the Key Distribution Center (KDC). |
| [kdc_port](#kdc_port-property-kerberos-struct) | The port for the Key Distribution Center (KDC). |
| [keytab_file](#keytab_file-property-kerberos-struct) | The Kerberos Keytab file. |
| [password](#password-property-kerberos-struct) | The user's password. |
| [spn](#spn-property-kerberos-struct) | The Service Principal Name (SPN). |
| [timeout](#timeout-property-kerberos-struct) | The timeout for the struct. |
| [user](#user-property-kerberos-struct) | The name and domain of the user to authenticate. |
| [use_tcp](#use_tcp-property-kerberos-struct) | Whether TCP is used when establishing the connection. |

## Method List

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

|  |  |
| --- | --- |
| [authenticate](#authenticate-method-kerberos-struct) | Authenticates the user. |
| [config](#config-method-kerberos-struct) | Sets or retrieves a configuration setting. |
| [do_events](#do_events-method-kerberos-struct) | This method processes events from the internal message queue. |
| [interrupt](#interrupt-method-kerberos-struct) | This method interrupts the current method. |
| [reset](#reset-method-kerberos-struct) | Resets the struct properties to their default values. |

## Event List

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

|  |  |
| --- | --- |
| [on_error](#on_error-event-kerberos-struct) | Fired when information is available about errors during data delivery. |
| [on_log](#on_log-event-kerberos-struct) | Fires once for each log message. |
| [on_pi_trail](#on_pi_trail-event-kerberos-struct) | Traces the messages sent to the server, and the respective replies. |

## Config Settings

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

|  |  |
| --- | --- |
| [CredentialsCacheFile](#CredentialsCacheFile) | The credentials cache file. |
| [EncodeAuthToken](#EncodeAuthToken) | Whether to Base64 encode the AuthToken. |
| [EncryptionTypes](#EncryptionTypes) | The encryption types used during authentication. |
| [Krb5Config](#Krb5Config) | The clients Kerberos configuration file. |
| [LogKerberosPackets](#LogKerberosPackets) | Whether to include the raw Kerberos packets in PITrail output. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [UsePlatformKerberosAPI](#UsePlatformKerberosAPI) | Whether to use the platform Kerberos API. |
| [UseTCP](#UseTCP) | Whether TCP is used when establishing the connection. |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the struct binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the struct to be active on the same local port. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# auth_token property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The authentication token.

## Syntax

*Rust Syntax*

```text
fn auth_token(&self ) -> Result<Vec<u8>, IPWorksAuthError>
```

## Default Value

""

## Remarks

This property holds the authentication token.

This property will be populated after calling [authenticate](#authenticate-method-kerberos-struct). 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

Vec

# kdc_host property ([Kerberos](#struct-ipworksauthkerberos) Struct)

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

## Syntax

*Rust Syntax*

```text
fn kdc_host(&self ) -> Result<String, IPWorksAuthError> fn set_kdc_host(&self, value : &str) ->  Option<IPWorksAuthError>
fn set_kdc_host_ref(&self, value : &String) ->  Option<IPWorksAuthError>
```

## 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

# kdc_port property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The port for the Key Distribution Center (KDC).

## Syntax

*Rust Syntax*

```text
fn kdc_port(&self ) -> Result<i32, IPWorksAuthError> fn set_kdc_port(&self, value : i32) ->  Option<IPWorksAuthError>
```

## Default Value

88

## Remarks

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

## Data Type

i32

# keytab_file property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The Kerberos Keytab file.

## Syntax

*Rust Syntax*

```text
fn keytab_file(&self ) -> Result<String, IPWorksAuthError> fn set_keytab_file(&self, value : &str) ->  Option<IPWorksAuthError>
fn set_keytab_file_ref(&self, value : &String) ->  Option<IPWorksAuthError>
```

## 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 ([Kerberos](#struct-ipworksauthkerberos) Struct)

The user's password.

## Syntax

*Rust Syntax*

```text
fn password(&self ) -> Result<String, IPWorksAuthError> fn set_password(&self, value : &str) ->  Option<IPWorksAuthError>
fn set_password_ref(&self, value : &String) ->  Option<IPWorksAuthError>
```

## Default Value

""

## Remarks

This property specifies the user's password. This must be set before calling [authenticate](#authenticate-method-kerberos-struct).

## Data Type

String

# spn property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The Service Principal Name (SPN).

## Syntax

*Rust Syntax*

```text
fn spn(&self ) -> Result<String, IPWorksAuthError> fn set_spn(&self, value : &str) ->  Option<IPWorksAuthError>
fn set_spn_ref(&self, value : &String) ->  Option<IPWorksAuthError>
```

## Default Value

""

## Remarks

This property specifies the Service Principal Name (SPN). This must be set before calling [authenticate](#authenticate-method-kerberos-struct).

## Data Type

String

# timeout property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The timeout for the struct.

## Syntax

*Rust Syntax*

```text
fn timeout(&self ) -> Result<i32, IPWorksAuthError> fn set_timeout(&self, value : i32) ->  Option<IPWorksAuthError>
```

## 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 struct will wait for the operation to complete before returning control.

The struct will use [do_events](#do_events-method-kerberos-struct) 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 struct 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

i32

# user property ([Kerberos](#struct-ipworksauthkerberos) Struct)

The name and domain of the user to authenticate.

## Syntax

*Rust Syntax*

```text
fn user(&self ) -> Result<String, IPWorksAuthError> fn set_user(&self, value : &str) ->  Option<IPWorksAuthError>
fn set_user_ref(&self, value : &String) ->  Option<IPWorksAuthError>
```

## 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

# use_tcp property ([Kerberos](#struct-ipworksauthkerberos) Struct)

Whether TCP is used when establishing the connection.

## Syntax

*Rust Syntax*

```text
fn use_tcp(&self ) -> Result<bool, IPWorksAuthError> fn set_use_tcp(&self, value : bool) ->  Option<IPWorksAuthError>
```

## 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

bool

# authenticate method ([Kerberos](#struct-ipworksauthkerberos) Struct)

Authenticates the user.

## Syntax

*Rust Syntax*

```text
fn authenticate(&self) -> Result<(), IPWorksAuthError>
```

## Remarks

This method authenticates the [user](#user-property-kerberos-struct).

**Authentication**

When authenticate is called the struct will attempt to authenticate the user with the Key Distribution Center (KDC). The struct will communicate with the [kdc_host](#kdc_host-property-kerberos-struct) to obtain a service ticket and populate [auth_token](#auth_token-property-kerberos-struct). The following properties are required when calling this method:

- [spn](#spn-property-kerberos-struct) (required)
- [user](#user-property-kerberos-struct) (required)
- [password](#password-property-kerberos-struct) (required)
- [kdc_host](#kdc_host-property-kerberos-struct) (required)

A typical sequence of messages would be:

- KRB_AS_REQ -> KDC
- KRB_AS_REP <- KDC
- KRB_TGS_REQ -> KDC
- KRB_TGS_REP <- KDC
- [auth_token](#auth_token-property-kerberos-struct) is populated with the constructed KRB_AP_REP message.

Communication with the [kdc_host](#kdc_host-property-kerberos-struct) can be seen through the [on_pi_trail](#on_pi_trail-event-kerberos-struct) event.

# config method ([Kerberos](#struct-ipworksauthkerberos) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksAuthError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-kerberos-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-kerberos-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# do_events method ([Kerberos](#struct-ipworksauthkerberos) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
fn do_events(&self) -> Result<(), IPWorksAuthError>
```

## Remarks

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

# interrupt method ([Kerberos](#struct-ipworksauthkerberos) Struct)

This method interrupts the current method.

## Syntax

*Rust Syntax*

```text
fn interrupt(&self) -> Result<(), IPWorksAuthError>
```

## Remarks

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

# reset method ([Kerberos](#struct-ipworksauthkerberos) Struct)

Resets the struct properties to their default values.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksAuthError>
```

## Remarks

This method resets the properties to their default values.

# on_error event ([Kerberos](#struct-ipworksauthkerberos) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// KerberosErrorEventArgs carries the Kerberos Error event's parameters.
pub struct KerberosErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// KerberosErrorEvent defines the signature of the Kerberos Error event's handler function.
pub trait KerberosErrorEvent {
  fn on_error(&self, sender : Kerberos, e : &mut KerberosErrorEventArgs);
}

impl <'a> Kerberos<'a> {
  pub fn on_error(&self) -> &'a dyn KerberosErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn KerberosErrorEvent);
  ...
}
```

## Remarks

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

The *error_code* 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](#trappable-errors-kerberos-struct) section.

# on_log event ([Kerberos](#struct-ipworksauthkerberos) Struct)

Fires once for each log message.

## Syntax

*Rust Syntax*

```text
// KerberosLogEventArgs carries the Kerberos Log event's parameters.
pub struct KerberosLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// KerberosLogEvent defines the signature of the Kerberos Log event's handler function.
pub trait KerberosLogEvent {
  fn on_log(&self, sender : Kerberos, e : &mut KerberosLogEventArgs);
}

impl <'a> Kerberos<'a> {
  pub fn on_log(&self) -> &'a dyn KerberosLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn KerberosLogEvent);
  ...
}
```

## Remarks

This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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

# on_pi_trail event ([Kerberos](#struct-ipworksauthkerberos) Struct)

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

## Syntax

*Rust Syntax*

```text
// KerberosPITrailEventArgs carries the Kerberos PITrail event's parameters.
pub struct KerberosPITrailEventArgs {
  fn direction(&self) -> i32
  fn message(&self) -> &String
}

// KerberosPITrailEvent defines the signature of the Kerberos PITrail event's handler function.
pub trait KerberosPITrailEvent {
  fn on_pi_trail(&self, sender : Kerberos, e : &mut KerberosPITrailEventArgs);
}

impl <'a> Kerberos<'a> {
  pub fn on_pi_trail(&self) -> &'a dyn KerberosPITrailEvent;
  pub fn set_on_pi_trail(&mut self, value : &'a dyn KerberosPITrailEvent);
  ...
}
```

## Remarks

The on_pi_trail event is useful for debugging purposes. It shows all the interaction between the client and the server. To include the raw packets set [LogKerberosPackets](#LogKerberosPackets) to True.

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

|  |  |
| --- | --- |
| 0 (Client) | The Message originates from the client. |
| 1 (Server) | The Message originates from the server. |
| 2 (Info) | The Message is an informative message originating from the client software (the struct code). |

# Config Settings ([Kerberos](#struct-ipworksauthkerberos) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-kerberos-struct) method.

### KERBEROS Config Settings

**CredentialsCacheFile**: The credentials cache file.This setting specifies the path to a credentials cache file. If specified, the credentials are read from this file. For example: *C:\\krbccdir\\tkt.txt*

Alternatively, this setting can specify the path to a directory containing a collection of credential cache files. When a directory is specified, the path must be prefixed with *DIR:*. For example: *DIR:C:\\krbccdir\\*

**EncodeAuthToken**: Whether to Base64 encode the AuthToken.This setting specifies whether [auth_token](#auth_token-property-kerberos-struct) is Base64 encoded after calling [authenticate](#authenticate-method-kerberos-struct). The default value is False.

**EncryptionTypes**: The encryption types used during authentication.This setting specifies a comma separated list of encryption types used during authentication. Possible values are:

- rc4-hmac
- des-cbc-md5
- aes128-cts-hmac-sha1-96

The default value is "des-cbc-md5,rc4-hmac,aes128-cts-hmac-sha1-96".

**Krb5Config**: The clients Kerberos configuration file.This setting specifies the path to the clients Kerberos configuration file (e.g., *C:\path\to\krb5.conf*).

When specified, the struct will parse the default realm present in the configuration file (under the "libdefaults" section), along with all listed realms and KDCs (under the "realms" section). The default realm will be used during authentication, unless a domain/realm is specified in the [user](#user-property-kerberos-struct) property. Note that in this case, the [user](#user-property-kerberos-struct) property may be set to only a username to allow the struct to use the appropriate default realm.

Assuming a default realm is found, the primary KDC associated with this realm will be used during authentication, assuming [kdc_host](#kdc_host-property-kerberos-struct) is not specified. Additional KDCs will be used only if authentication with the primary KDC fails. Note if no KDCs are specified for a realm and "dns_lookup_kdc" is set to true in the configuration file, the struct will perform a DNS query in an attempt to resolve the KDCs host name and port.

All additional realms will be stored as intermediate realms in the case cross-realm authentication is needed.

**LogKerberosPackets**: Whether to include the raw Kerberos packets in PITrail output.This settings specifies whether to include the raw Kerberos packet in the Message parameter of the [on_pi_trail](#on_pi_trail-event-kerberos-struct) event. When True the Kerberos packet will be encoded and present in the Message parameter. The default value is False. This may be enabled for troubleshooting purposes.

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [on_log](#on_log-event-kerberos-struct) event. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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

**UsePlatformKerberosAPI**: Whether to use the platform Kerberos API.This setting determines if the platform's Kerberos API is used. By default the struct does not rely on any platform APIs to perform Kerberos authentication. Use of the platform API may be enabled by setting this to True. The default value is False.

Note: This functionality is only available on Windows.

**UseTCP**: Whether TCP is used when establishing the connection.This config specifies whether TCP is used as the transport protocol when establishing the connection. By default this config is *False* and UDP will be used.

### UDP Config Settings

**CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

NOTE: This configuration setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when remote_host is set. If *true* the struct will resolve the hostname and the IP address will be present in the remote_host property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may be called to manually resolve the value in remote_host at any time.

The default value is *false*.

**DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

NOTE: This configuration setting is available only in Windows.

**DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the struct will have the Don't Fragment flag set. The default value is False.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The local_host setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the struct will accept without truncation.

**QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

**QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

NOTE: QOSTrafficType must be set before setting active to True.

**ShareLocalPort**: If set to True, allows more than one instance of the struct to be active on the same local port.This option must be set before the struct is activated through the active property or it will have no effect.

The default value for this setting is False.

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the struct should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the struct will send and receive data to and from the specified destination.

The default value for this setting is False.

**UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-kerberos-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([Kerberos](#struct-ipworksauthkerberos) Struct)

### 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 local_port while the struct is active. |
| 107 | You cannot change the local_host at this time. A connection is in progress. |
| 109 | The struct must be active for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the struct is active. |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the struct is active. |
| 114 | You cannot change remote_host when [UseConnection](#UseConnection) is set and the struct active. |
| 115 | You cannot change remote_port when [UseConnection](#UseConnection) is set and the struct is active. |
| 116 | remote_port cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the struct is active. |
| 118 | Message cannot be longer than [MaxPacketSize](#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 nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is 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 is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |