RADIUS Class

Properties   Methods   Events   Config Settings   Errors  

The RADIUS class provides an easy way to authenticate users.

Syntax

RADIUS

Remarks

The RADIUS component implements support for Remote Authentication Dial In User Service (RADIUS).

Authentication

The class can be used to authenticate users with a RADIUS server. To begin set the following properties:

• RemoteHost
• RemotePort (optional)
• User
• Password
• SharedSecret

The AuthMechanism property may be set to specify the authentication mechanism used.

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.

AttrCount Property (RADIUS Class)

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();
int SetAttrCount(int iAttrCount);

Unicode (Windows)
INT GetAttrCount();
INT SetAttrCount(INT iAttrCount);

int ipworksauth_radius_getattrcount(void* lpObj);
int ipworksauth_radius_setattrcount(void* lpObj, int iAttrCount);

int GetAttrCount();
int SetAttrCount(int iAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrType
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

This property is not available at design time.

Data Type

Integer

AttrType Property (RADIUS Class)

The type of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrType(int iAttrIndex);
int SetAttrType(int iAttrIndex, int iAttrType);

Unicode (Windows)
INT GetAttrType(INT iAttrIndex);
INT SetAttrType(INT iAttrIndex, INT iAttrType);

int ipworksauth_radius_getattrtype(void* lpObj, int attrindex);
int ipworksauth_radius_setattrtype(void* lpObj, int attrindex, int iAttrType);

int GetAttrType(int iAttrIndex);
int SetAttrType(int iAttrIndex, int iAttrType);

Default Value

0

Remarks

The type of the attribute.

This property identifies the type of the attribute. Common values are:

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

Integer

AttrName Property (RADIUS Class)

A text description of the attribute type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrName(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrName(INT iAttrIndex);

char* ipworksauth_radius_getattrname(void* lpObj, int attrindex);

QString GetAttrName(int iAttrIndex);

Default Value

""

Remarks

A text description of the attribute type.

This property holds a text description of the AttributeType.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrValue Property (RADIUS Class)

The attribute value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrValue(int iAttrIndex, char* &lpAttrValue, int &lenAttrValue);
int SetAttrValue(int iAttrIndex, const char* lpAttrValue, int lenAttrValue);

Unicode (Windows)
INT GetAttrValue(INT iAttrIndex, LPSTR &lpAttrValue, INT &lenAttrValue);
INT SetAttrValue(INT iAttrIndex, LPCSTR lpAttrValue, INT lenAttrValue);

int ipworksauth_radius_getattrvalue(void* lpObj, int attrindex, char** lpAttrValue, int* lenAttrValue);
int ipworksauth_radius_setattrvalue(void* lpObj, int attrindex, const char* lpAttrValue, int lenAttrValue);

QByteArray GetAttrValue(int iAttrIndex);
int SetAttrValue(int iAttrIndex, QByteArray qbaAttrValue);

Default Value

""

Remarks

The attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

Binary String

AuthMechanism Property (RADIUS Class)

The authentication mechanism to be used when connecting to the RADIUS server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Unicode (Windows)
INT GetAuthMechanism();
INT SetAuthMechanism(INT iAuthMechanism);

RAM_MSCHAPV_2(0), 
RAM_PAP(1), 
RAM_PEAPV_0(2), 
RAM_EAPTLS(3)

int ipworksauth_radius_getauthmechanism(void* lpObj);
int ipworksauth_radius_setauthmechanism(void* lpObj, int iAuthMechanism);

int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Default Value

0

Remarks

This property defines the authentication mechanism used when connecting to the RADIUS server. Possible values are:

When set to ramEAPTLS the SSLCert* properties must be set to the client certificate used to authenticate to the server.

Data Type

Integer

EAPAnonymousIdentity Property (RADIUS Class)

The identity to use when using PEAP or EAP-TLS.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEAPAnonymousIdentity();
int SetEAPAnonymousIdentity(const char* lpszEAPAnonymousIdentity);

Unicode (Windows)
LPWSTR GetEAPAnonymousIdentity();
INT SetEAPAnonymousIdentity(LPCWSTR lpszEAPAnonymousIdentity);

char* ipworksauth_radius_geteapanonymousidentity(void* lpObj);
int ipworksauth_radius_seteapanonymousidentity(void* lpObj, const char* lpszEAPAnonymousIdentity);

QString GetEAPAnonymousIdentity();
int SetEAPAnonymousIdentity(QString qsEAPAnonymousIdentity);

Default Value

"anonymous"

Remarks

This property specifies the initital identity to use when establishing a secure connection using PEAP. When AuthMechanism is set to amPEAPv0 or emEAPTLS the connection begins in plaintext. This property specifies the user name (if any) that is sent in the initial plaintext request. This allows the true identity of the user to be hidden.

If set, the value will be sent in the plaintext connection request. If not set (empty string) the User will be sent. Authentication servers may make use of a value that includes the domain to which the user will authenticate, such as anonymous@example.com. In that case the user's identity is still hidden, however the authentication server will have knowledge of the domain for the user which it may make use of.

Once a secure connection is established the user's true identity is sent to the authentication server over the TLS encrypted connection. This property specifies only the identity sent in the initial plaintext request.

The default value is anonymous.

This setting is only applicable when AuthMechanism is set to amPEAPv0 or amEAPTLS.

Data Type

String

LocalHost Property (RADIUS Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksauth_radius_getlocalhost(void* lpObj);
int ipworksauth_radius_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property 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 multi-homed 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 property 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 multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (RADIUS Class)

The UDP port in the local host where UDP binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksauth_radius_getlocalport(void* lpObj);
int ipworksauth_radius_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

Password Property (RADIUS Class)

The user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksauth_radius_getpassword(void* lpObj);
int ipworksauth_radius_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property specifies the password for the User. This must be set before calling Authenticate.

Data Type

String

RemoteHost Property (RADIUS Class)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworksauth_radius_getremotehost(void* lpObj);
int ipworksauth_radius_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

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

If UseConnection is set to True, the RemoteHost must be set before the class is activated (Active is set to True).

Data Type

String

RemotePort Property (RADIUS Class)

The port for the RADIUS server (default is 1812).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworksauth_radius_getremoteport(void* lpObj);
int ipworksauth_radius_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

1812

Remarks

The RemotePort is the UDP port to which requests will be made. The default value is 1812. Port 1645 is also commonly used.

Data Type

Integer

SharedSecret Property (RADIUS Class)

The RADIUS shared secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSharedSecret(char* &lpSharedSecret, int &lenSharedSecret);
int SetSharedSecret(const char* lpSharedSecret, int lenSharedSecret);

Unicode (Windows)
INT GetSharedSecret(LPSTR &lpSharedSecret, INT &lenSharedSecret);
INT SetSharedSecret(LPCSTR lpSharedSecret, INT lenSharedSecret);

int ipworksauth_radius_getsharedsecret(void* lpObj, char** lpSharedSecret, int* lenSharedSecret);
int ipworksauth_radius_setsharedsecret(void* lpObj, const char* lpSharedSecret, int lenSharedSecret);

QByteArray GetSharedSecret();
int SetSharedSecret(QByteArray qbaSharedSecret);

Default Value

""

Remarks

This property holds the shared secret to use when communicating with the RADIUS server.

Data Type

Binary String

SSLCertEncoded Property (RADIUS Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksauth_radius_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_radius_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (RADIUS Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksauth_radius_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_radius_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (RADIUS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksauth_radius_getsslcertstorepassword(void* lpObj);
int ipworksauth_radius_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (RADIUS Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksauth_radius_getsslcertstoretype(void* lpObj);
int ipworksauth_radius_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (RADIUS Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksauth_radius_getsslcertsubject(void* lpObj);
int ipworksauth_radius_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

Timeout Property (RADIUS Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksauth_radius_gettimeout(void* lpObj);
int ipworksauth_radius_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.

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.

Data Type

Integer

User Property (RADIUS Class)

The name of the user to authenticate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksauth_radius_getuser(void* lpObj);
int ipworksauth_radius_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property holds the name of the user to authenticate.

Data Type

String

Authenticate Method (RADIUS Class)

Authenticates the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authenticate();

Unicode (Windows)
INT Authenticate();

int ipworksauth_radius_authenticate(void* lpObj);

int Authenticate();

Remarks

This method authenticates the user with the RADIUS server.

If authentication is successful this method returns without error. If authentication fails this method will throw an exception.

This following properties are applicable when calling this method:

• User (required)
• Password (required)
• SharedSecret (required)
• RemoteHost (required)
• RemotePort
• Timeout

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_radius_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 (RADIUS Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksauth_radius_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 (RADIUS Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksauth_radius_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 (RADIUS Class)

Resets the class properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

Attribute Event (RADIUS Class)

Fires for each attribute that is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAttribute(RADIUSAttributeEventParams *e);

typedef struct {
  int AttributeType;
  const char *Name;
  const char *Value;
  int lenValue;
  int reserved;
} RADIUSAttributeEventParams;


Unicode (Windows)
virtual INT FireAttribute(RADIUSAttributeEventParams *e);

typedef struct {
  INT AttributeType;
  LPCWSTR Name;
  LPCSTR Value;
  INT lenValue;
  INT reserved;
} RADIUSAttributeEventParams;

#define EID_RADIUS_ATTRIBUTE 1

virtual INT IPWORKSAUTH_CALL FireAttribute(INT &iAttributeType, LPSTR &lpszName, LPSTR &lpValue, INT &lenValue);

class RADIUSAttributeEventParams {
public:
  int AttributeType();

  const QString &Name();

  const QByteArray &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Attribute(RADIUSAttributeEventParams *e);

// Or, subclass RADIUS and override this emitter function.
virtual int FireAttribute(RADIUSAttributeEventParams *e) {...}

Remarks

This event fires once for each attribute that is received. This will fire when calling Authenticate.

AttributeType is the attribute type. Common values are:

Name is the text description of the attribute.

Value is the value of the attribute.

Error Event (RADIUS Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(RADIUSErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} RADIUSErrorEventParams;


Unicode (Windows)
virtual INT FireError(RADIUSErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} RADIUSErrorEventParams;

#define EID_RADIUS_ERROR 2

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class RADIUSErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(RADIUSErrorEventParams *e);

// Or, subclass RADIUS and override this emitter function.
virtual int FireError(RADIUSErrorEventParams *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 (RADIUS Class)

Fires with log information during processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(RADIUSLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} RADIUSLogEventParams;


Unicode (Windows)
virtual INT FireLog(RADIUSLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} RADIUSLogEventParams;

#define EID_RADIUS_LOG 3

virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class RADIUSLogEventParams {
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(RADIUSLogEventParams *e);

// Or, subclass RADIUS and override this emitter function.
virtual int FireLog(RADIUSLogEventParams *e) {...}

Remarks

This event fires during processing with log information. The level of detail that is logged is controlled via the LogLevel.

LogLevel indicates the level of message. Possible values are:

LogMessage is the log entry.

LogType indicates the type of log. Possible values are:

• "REQUEST"
• "RESPONSE"

SSLServerAuthentication Event (RADIUS Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(RADIUSSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} RADIUSSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(RADIUSSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} RADIUSSSLServerAuthenticationEventParams;

#define EID_RADIUS_SSLSERVERAUTHENTICATION 4

virtual INT IPWORKSAUTH_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class RADIUSSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(RADIUSSSLServerAuthenticationEventParams *e);

// Or, subclass RADIUS and override this emitter function.
virtual int FireSSLServerAuthentication(RADIUSSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (RADIUS Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(RADIUSSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} RADIUSSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(RADIUSSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} RADIUSSSLStatusEventParams;

#define EID_RADIUS_SSLSTATUS 5

virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);

class RADIUSSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(RADIUSSSLStatusEventParams *e);

// Or, subclass RADIUS and override this emitter function.
virtual int FireSSLStatus(RADIUSSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (RADIUS Class)

RADIUS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (RADIUS 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.

RADIUS Errors

UDP Errors

TCP/IP Errors