RADIUS Class

Properties   Methods   Events   Config Settings   Errors  

The RADIUS class provides an easy way to authenticate users.

Syntax

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

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

RADIUS.Attributes Property

The attributes of the request or response.

Syntax

getAttributes(): RADIUSAttributeList;
setAttributes(attributes: RADIUSAttributeList): void;

Default Value

Remarks

This property holds a collection of attributes associated with the request or response. To include attributes in a request populate this collection before calling Authenticate. After Authenticate returns this collection will be populated with the attributes from the response.

This property is not available at design time.

Please refer to the RADIUSAttribute type for a complete list of fields.

RADIUS.AuthMechanism Property

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

Syntax

getAuthMechanism(): RadiusAuthMechanisms;
setAuthMechanism(authMechanism: RadiusAuthMechanisms): void;

enum RadiusAuthMechanisms {
  ramMSCHAPv2,
  ramPAP,
  ramPEAPv0,
  ramEAPTLS
}

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.

RADIUS.EAPAnonymousIdentity Property

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

Syntax

getEAPAnonymousIdentity(): string;
setEAPAnonymousIdentity(EAPAnonymousIdentity: string): void;

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.

RADIUS.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

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.

RADIUS.LocalPort Property

The UDP port in the local host where UDP binds.

Syntax

getLocalPort(): number;
setLocalPort(localPort: number): void;

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.

RADIUS.Password Property

The user's password.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

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

RADIUS.RemoteHost Property

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

Syntax

getRemoteHost(): string;
setRemoteHost(remoteHost: string): void;

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

RADIUS.RemotePort Property

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

Syntax

getRemotePort(): number;
setRemotePort(remotePort: number): void;

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.

RADIUS.SharedSecret Property

The RADIUS shared secret.

Syntax

getSharedSecret(): Uint8Array;
setSharedSecret(sharedSecret: Uint8Array): void;

Default Value

""

Remarks

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

RADIUS.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

RADIUS.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 .

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.

RADIUS.User Property

The name of the user to authenticate.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

This property holds the name of the user to authenticate.

RADIUS.authenticate Method

Authenticates the user.

Syntax

async radius.authenticate(): Promise<void>

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

RADIUS.config Method

Sets or retrieves a configuration setting.

Syntax

async radius.config(configurationString : string): Promise<string>

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.

RADIUS.doEvents Method

Processes events from the internal message queue.

Syntax

async radius.doEvents(): Promise<void>

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.

RADIUS.interrupt Method

Interrupt the current method.

Syntax

async radius.interrupt(): Promise<void>

Remarks

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

RADIUS.reset Method

Resets the class properties to their default values.

Syntax

async radius.reset(): Promise<void>

Remarks

This method resets the properties to their default values.

RADIUS.Attribute Event

Fires for each attribute that is received.

Syntax

radius.on('Attribute', listener: (e: {readonly attributeType: number, readonly name: string, readonly value: string, readonly valueB: Uint8Array}) => void )

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.

RADIUS.Error Event

Information about errors during data delivery.

Syntax

radius.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

RADIUS.Log Event

Fires with log information during processing.

Syntax

radius.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

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"

RADIUS.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

radius.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

RADIUS.SSLStatus Event

Shows the progress of the secure connection.

Syntax

radius.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

RADIUSAttribute Type

This type holds details of the RADIUS attribute.

Remarks

This type holds details of the RADIUS attribute such as type and value.

Fields

Constructors

public RADIUSAttribute();

public RADIUSAttribute(int attributeType);

public RADIUSAttribute(int attributeType, byte[] value);

Config Settings (class ipworksauth.radius)

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.

RADIUS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworksauth.radius)

RADIUS Errors

	900   Busy performing other action.
	901   Received invalid response.
	902   Received rejected response.
	903   Received challenge response.

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   Cannot change MaxPacketSize while the class is Active.
	113   Cannot change ShareLocalPort option while the class is Active.
	114   Cannot change RemoteHost when UseConnection is set and the class Active.
	115   Cannot change RemotePort when UseConnection is set and the class is Active.
	116   RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
	117   Cannot change UseConnection while the class is Active.
	118   Message can't 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 non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't 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] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory 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 not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).