RADIUS Control

Properties   Methods   Events   Config Settings   Errors  

The RADIUS control 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 control can be used to authenticate users with a RADIUS server. To begin set the following properties:

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

To authenticate the user call Authenticate. If the method returns without error the user was successfully authenticated. The Attr* properties will hold information about the attributes in the response.

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 control with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AttrCount Property (RADIUS Control)

The number of records in the Attr arrays.

Syntax

radiuscontrol.AttrCount[=integer]

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

The type of the attribute.

Syntax

radiuscontrol.AttrType(AttrIndex)[=integer]

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

A text description of the attribute type.

Syntax

radiuscontrol.AttrName(AttrIndex)

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

The attribute value.

Syntax

radiuscontrol.AttrValue(AttrIndex)[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttrValueB.

This property is not available at design time.

Data Type

Binary String

AuthMechanism Property (RADIUS Control)

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

Syntax

radiuscontrol.AuthMechanism[=integer]

Possible Values

ramMSCHAPv2(0), 
ramPAP(1), 
ramPEAPv0(2), 
ramEAPTLS(3)

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

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

Syntax

radiuscontrol.EAPAnonymousIdentity[=string]

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

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

Syntax

radiuscontrol.LocalHost[=string]

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 control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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 Control)

The UDP port in the local host where UDP binds.

Syntax

radiuscontrol.LocalPort[=integer]

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the control 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 control is Active. Any attempt to set the LocalPort property when the control 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 Control)

The user's password.

Syntax

radiuscontrol.Password[=string]

Default Value

""

Remarks

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

Data Type

String

RemoteHost Property (RADIUS Control)

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

Syntax

radiuscontrol.RemoteHost[=string]

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 control 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 control is activated (Active is set to True).

Data Type

String

RemotePort Property (RADIUS Control)

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

Syntax

radiuscontrol.RemotePort[=integer]

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

The RADIUS shared secret.

Syntax

radiuscontrol.SharedSecret[=string]

Default Value

""

Remarks

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SharedSecretB.

Data Type

Binary String

SSLCertEncoded Property (RADIUS Control)

This is the certificate (PEM/base64 encoded).

Syntax

radiuscontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (RADIUS Control)

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

Syntax

radiuscontrol.SSLCertStore[=string]

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (RADIUS Control)

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

Syntax

radiuscontrol.SSLCertStorePassword[=string]

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

This is the type of certificate store for this certificate.

Syntax

radiuscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (RADIUS Control)

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

Syntax

radiuscontrol.SSLCertSubject[=string]

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

A timeout for the control.

Syntax

radiuscontrol.Timeout[=integer]

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

The control 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 control 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 Control)

The name of the user to authenticate.

Syntax

radiuscontrol.User[=string]

Default Value

""

Remarks

This property holds the name of the user to authenticate.

Data Type

String

Authenticate Method (RADIUS Control)

Authenticates the user.

Syntax

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

Config Method (RADIUS Control)

Sets or retrieves a configuration setting.

Syntax

radiuscontrol.Config ConfigurationString

Remarks

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

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

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

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

DoEvents Method (RADIUS Control)

Processes events from the internal message queue.

Syntax

radiuscontrol.DoEvents 

Remarks

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

Interrupt Method (RADIUS Control)

Interrupt the current method.

Syntax

radiuscontrol.Interrupt 

Remarks

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

Reset Method (RADIUS Control)

Resets the control properties to their default values.

Syntax

radiuscontrol.Reset 

Remarks

This method resets the properties to their default values.

Attribute Event (RADIUS Control)

Fires for each attribute that is received.

Syntax

Sub radiuscontrol_Attribute(AttributeType As Integer, Name As String, Value As String)

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

Information about errors during data delivery.

Syntax

Sub radiuscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 Control)

Fires with log information during processing.

Syntax

Sub radiuscontrol_Log(LogLevel As Integer, Message As String, LogType As String)

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

Fired after the server presents its certificate to the client.

Syntax

Sub radiuscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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

Shows the progress of the secure connection.

Syntax

Sub radiuscontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (RADIUS Control)

The control 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 control, access to these internal properties is provided through the Config method.

RADIUS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (RADIUS Control)

RADIUS Errors

	20901    Busy performing other action.
	20902    Received invalid response.
	20903    Received rejected response.
	20904    Received challenge response.

UDP Errors

	20105    UDP is already Active.
	20107    You cannot change the LocalPort while the control is Active.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20110    The control must be Active for this operation.
	20113    Cannot change MaxPacketSize while the control is Active.
	20114    Cannot change ShareLocalPort option while the control is Active.
	20115    Cannot change RemoteHost when UseConnection is set and the control Active.
	20116    Cannot change RemotePort when UseConnection is set and the control is Active.
	20117    RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
	20118    Cannot change UseConnection while the control is Active.
	20119    Message can't be longer than MaxPacketSize.
	20120    Message too short.
	20435    Unable to convert string to selected CodePage

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).