Kerberos Class
Properties Methods Events Config Settings Errors
The Kerberos class can be used to authenticate users using Kerberos 5.0.
Syntax
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:
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.
AuthToken | The authentication token. |
KDCHost | The domain name or IP address of the Key Distribution Center (KDC). |
KDCPort | The port for the Key Distribution Center (KDC). |
KeytabFile | The Kerberos Keytab file. |
Password | The user's password. |
SPN | The Service Principal Name (SPN). |
Timeout | This property includes the timeout for the class. |
User | The name and domain of the user to authenticate. |
UseTCP | Whether TCP is used when establishing the connection. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Authenticate | Authenticates the user. |
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
Interrupt | This method interrupts the current method. |
Reset | Resets 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.
Error | Fired when information is available about errors during data delivery. |
Log | Fires once for each log message. |
PITrail | Traces the messages sent to the server, and the respective replies. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
CredentialsCacheFile | The credentials cache file. |
EncodeAuthToken | Whether to Base64 encode the AuthToken. |
EncryptionTypes | The encryption types used during authentication. |
Krb5Config | The clients Kerberos configuration file. |
LogKerberosPackets | Whether to include the raw Kerberos packets in PITrail output. |
LogLevel | The level of detail that is logged. |
UsePlatformKerberosAPI | Whether to use the platform Kerberos API. |
UseTCP | Whether TCP is used when establishing the connection. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthToken Property (Kerberos Class)
The authentication token.
Syntax
ANSI (Cross Platform) int GetAuthToken(char* &lpAuthToken, int &lenAuthToken); Unicode (Windows) INT GetAuthToken(LPSTR &lpAuthToken, INT &lenAuthToken);
int ipworksauth_kerberos_getauthtoken(void* lpObj, char** lpAuthToken, int* lenAuthToken);
QByteArray GetAuthToken();
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 (Kerberos Class)
The domain name or IP address of the Key Distribution Center (KDC).
Syntax
ANSI (Cross Platform) char* GetKDCHost();
int SetKDCHost(const char* lpszKDCHost); Unicode (Windows) LPWSTR GetKDCHost();
INT SetKDCHost(LPCWSTR lpszKDCHost);
char* ipworksauth_kerberos_getkdchost(void* lpObj);
int ipworksauth_kerberos_setkdchost(void* lpObj, const char* lpszKDCHost);
QString GetKDCHost();
int SetKDCHost(QString qsKDCHost);
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 (Kerberos Class)
The port for the Key Distribution Center (KDC).
Syntax
ANSI (Cross Platform) int GetKDCPort();
int SetKDCPort(int iKDCPort); Unicode (Windows) INT GetKDCPort();
INT SetKDCPort(INT iKDCPort);
int ipworksauth_kerberos_getkdcport(void* lpObj);
int ipworksauth_kerberos_setkdcport(void* lpObj, int iKDCPort);
int GetKDCPort();
int SetKDCPort(int iKDCPort);
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 (Kerberos Class)
The Kerberos Keytab file.
Syntax
ANSI (Cross Platform) char* GetKeytabFile();
int SetKeytabFile(const char* lpszKeytabFile); Unicode (Windows) LPWSTR GetKeytabFile();
INT SetKeytabFile(LPCWSTR lpszKeytabFile);
char* ipworksauth_kerberos_getkeytabfile(void* lpObj);
int ipworksauth_kerberos_setkeytabfile(void* lpObj, const char* lpszKeytabFile);
QString GetKeytabFile();
int SetKeytabFile(QString qsKeytabFile);
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 Class)
The user's password.
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* ipworksauth_kerberos_getpassword(void* lpObj);
int ipworksauth_kerberos_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
This property specifies the user's password. This must be set before calling Authenticate.
Data Type
String
SPN Property (Kerberos Class)
The Service Principal Name (SPN).
Syntax
ANSI (Cross Platform) char* GetSPN();
int SetSPN(const char* lpszSPN); Unicode (Windows) LPWSTR GetSPN();
INT SetSPN(LPCWSTR lpszSPN);
char* ipworksauth_kerberos_getspn(void* lpObj);
int ipworksauth_kerberos_setspn(void* lpObj, const char* lpszSPN);
QString GetSPN();
int SetSPN(QString qsSPN);
Default Value
""
Remarks
This property specifies the Service Principal Name (SPN). This must be set before calling Authenticate.
Data Type
String
Timeout Property (Kerberos Class)
This property includes the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksauth_kerberos_gettimeout(void* lpObj);
int ipworksauth_kerberos_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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 (Kerberos Class)
The name and domain of the user to authenticate.
Syntax
ANSI (Cross Platform) char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
char* ipworksauth_kerberos_getuser(void* lpObj);
int ipworksauth_kerberos_setuser(void* lpObj, const char* lpszUser);
QString GetUser();
int SetUser(QString qsUser);
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 (Kerberos Class)
Whether TCP is used when establishing the connection.
Syntax
ANSI (Cross Platform) int GetUseTCP();
int SetUseTCP(int bUseTCP); Unicode (Windows) BOOL GetUseTCP();
INT SetUseTCP(BOOL bUseTCP);
int ipworksauth_kerberos_getusetcp(void* lpObj);
int ipworksauth_kerberos_setusetcp(void* lpObj, int bUseTCP);
bool GetUseTCP();
int SetUseTCP(bool bUseTCP);
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 (Kerberos Class)
Authenticates the user.
Syntax
ANSI (Cross Platform) int Authenticate(); Unicode (Windows) INT Authenticate();
int ipworksauth_kerberos_authenticate(void* lpObj);
int Authenticate();
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:
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (Kerberos Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksauth_kerberos_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoEvents Method (Kerberos Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksauth_kerberos_doevents(void* lpObj);
int DoEvents();
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (Kerberos Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworksauth_kerberos_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (Kerberos Class)
Resets the class properties to their default values.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksauth_kerberos_reset(void* lpObj);
int Reset();
Remarks
This method resets the properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (Kerberos Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(KerberosErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } KerberosErrorEventParams;
Unicode (Windows) virtual INT FireError(KerberosErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } KerberosErrorEventParams;
#define EID_KERBEROS_ERROR 1 virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class KerberosErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(KerberosErrorEventParams *e);
// Or, subclass Kerberos and override this emitter function. virtual int FireError(KerberosErrorEventParams *e) {...}
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 (Kerberos Class)
Fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(KerberosLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } KerberosLogEventParams;
Unicode (Windows) virtual INT FireLog(KerberosLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } KerberosLogEventParams;
#define EID_KERBEROS_LOG 2 virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class KerberosLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(KerberosLogEventParams *e);
// Or, subclass Kerberos and override this emitter function. virtual int FireLog(KerberosLogEventParams *e) {...}
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:
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
PITrail Event (Kerberos Class)
Traces the messages sent to the server, and the respective replies.
Syntax
ANSI (Cross Platform) virtual int FirePITrail(KerberosPITrailEventParams *e);
typedef struct {
int Direction;
const char *Message; int reserved; } KerberosPITrailEventParams;
Unicode (Windows) virtual INT FirePITrail(KerberosPITrailEventParams *e);
typedef struct {
INT Direction;
LPCWSTR Message; INT reserved; } KerberosPITrailEventParams;
#define EID_KERBEROS_PITRAIL 3 virtual INT IPWORKSAUTH_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);
class KerberosPITrailEventParams { public: int Direction(); const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void PITrail(KerberosPITrailEventParams *e);
// Or, subclass Kerberos and override this emitter function. virtual int FirePITrail(KerberosPITrailEventParams *e) {...}
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:
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 class code). |
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
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\\
- rc4-hmac
- des-cbc-md5
- aes128-cts-hmac-sha1-96
The default value is "des-cbc-md5,rc4-hmac,aes128-cts-hmac-sha1-96".
When specified, the class 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 property. Note that in this case, the User property may be set to only a username to allow the class 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 KDCHost 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 class 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.
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).
Note: This functionality is only available on Windows.
UDP Config Settings
The default value for this setting is False.
Note: This configuration setting is available only in Windows.
The default value is false.
Note: This configuration setting is available only in Windows.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort 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.
Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.
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.
The default value for this setting is False.
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
The default value for this setting is False.
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class 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 section.
Trappable Errors (Kerberos Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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 | You cannot change MaxPacketSize while the class is Active. |
113 | You cannot change ShareLocalPort option while the class is Active. |
114 | You cannot change RemoteHost when UseConnection is set and the class Active. |
115 | You cannot change RemotePort when UseConnection is set and the class is Active. |
116 | RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number. |
117 | You cannot change UseConnection while the class is Active. |
118 | Message cannot 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 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). |