Click or drag to resize

RadiusClient Class

Represents a RADIUS communication client.
Inheritance Hierarchy
SystemObject
  GSF.Communication.RadiusRadiusClient

Namespace: GSF.Communication.Radius
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.207-beta
Syntax
public class RadiusClient : IDisposable
View Source

The RadiusClient type exposes the following members.

Constructors
 NameDescription
Public methodRadiusClient(String, String) Creates an instance of RADIUS client for sending request to a RADIUS server.
Public methodRadiusClient(String, Int32, String) Creates an instance of RADIUS client for sending request to a RADIUS server.
Top
Properties
 NameDescription
Public propertyNewPinModeMessage1 Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 1 (ensuring that the user account is in the "New Pin" mode) of creating a new pin was successful.
Public propertyNewPinModeMessage2 Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 2 (new pin is accepted in attempt #1) of creating a new pin was successful.
Public propertyNewPinModeMessage3 Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 3 (new pin is accepted in attempts #2) of creating a new pin was successful.
Public propertyNextTokenModeMessage Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not a user account is in the "Next Token" mode.
Public propertyReponseTimeout Gets or sets the time (in milliseconds) to wait for a response from server after sending a request.
Public propertyRequestAttempts Gets or sets the number of time a request is to sent to the server until a valid response is received.
Public propertyServerName Gets or sets the name or address of the RADIUS server.
Public propertyServerPort Gets or sets the port number of the RADIUS server.
Public propertySharedSecret Gets or sets the shared secret used between the client and server for encryption and authentication.
Top
Methods
 NameDescription
Public methodAuthenticate(String, String) Authenticates the username and password against the RADIUS server.
Public methodAuthenticate(String, String, Byte) Authenticates the username and password against the RADIUS server.
Protected methodCheckDisposed Helper method to check whether or not the object instance has been disposed.
Public methodCreateNewPin Create a new pin for the user.
Public methodDispose Releases the used resources.
Protected methodDispose(Boolean) Releases the used resources.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsUserInNewPinMode Determines whether or not the response indicates that the user account is in "New Pin" mode.
Public methodIsUserInNextTokenMode Determines whether or not the response indicates that the user account is in "Next Token" mode.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodProcessRequest Send a request to the server and waits for a response back.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberDefaultNewPinModeMessage1 Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 1 (ensuring that the user account is in the "New Pin" mode) of creating a new pin was successful.
Public fieldStatic memberDefaultNewPinModeMessage2 Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 2 (new pin is accepted in attempt #1) of creating a new pin was successful.
Public fieldStatic memberDefaultNewPinModeMessage3 Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 3 (new pin is accepted in attempts #2) of creating a new pin was successful.
Public fieldStatic memberDefaultNextTokenModeMessage Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not a user account is in the "Next Token" mode.
Public fieldStatic memberDefaultServerPort Default port of the RADIUS server.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also