RADIUS Component

Properties Methods Events Configuration Settings Errors

The RADIUS component provides an easy way to authenticate users.

Syntax

nsoftware.IPWorksAuth.Radius

Remarks

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

Authentication

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

To authenticate the user call Authenticate. If the method returns without error the user was successfully authenticated. The Attributes collection 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 component with short descriptions. Click on the links for further details.


Attributes	The attributes of the request or response.
AuthMechanism	The authentication mechanism to be used when connecting to the RADIUS server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The UDP port in the local host where UDPPort binds.
Password	The user's password.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port for the RADIUS server (default is 1812).
SharedSecret	The RADIUS shared secret.
Timeout	A timeout for the component.
User	The name of the user to authenticate.

Method List

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


Authenticate	Authenticates the user.
Config	Sets or retrieves a configuration setting .
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
Reset	Resets the component properties to their default values.

Event List

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


Attribute	Fires for each attribute that is received.
Error	Information about errors during data delivery.

Configuration Settings

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


SendMessageAuthenticator	Whether to send the Message-Authenticator attribute.
CaptureIPPacketInfo	Used to capture the packet information.
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 TCP port in the local host where the component binds.
MaxPacketSize	The maximum length of the packets that can be received.
ShareLocalPort	If set to True, allows more than one instance of the component to be active on the same local port.
UseConnection	Determines whether to use a connected socket.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
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.
CodePage	The system code page used for Unicode to Multibyte translations.