|
Radius
|
Represents a RADIUS communication client.
Inheritance Hierarchy
Namespace: GSF.Communication.Radius
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.230-beta
Syntaxpublic class RadiusClient : IDisposable
The RadiusClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RadiusClient(String, String) | Creates an instance of RADIUS client for sending request to a RADIUS server. |
| RadiusClient(String, Int32, String) | Creates an instance of RADIUS client for sending request to a RADIUS server. |
Properties| Name | Description | |
|---|---|---|
 | NewPinModeMessage1 | 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. |
| NewPinModeMessage2 | 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. |
| NewPinModeMessage3 | 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. |
| NextTokenModeMessage | 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. |
| ReponseTimeout | Gets or sets the time (in milliseconds) to wait for a response from server after sending a request. |
| RequestAttempts | Gets or sets the number of time a request is to sent to the server until a valid response is received. |
| ServerName | Gets or sets the name or address of the RADIUS server. |
| ServerPort | Gets or sets the port number of the RADIUS server. |
| SharedSecret | Gets or sets the shared secret used between the client and server for encryption and authentication. |
Methods| Name | Description | |
|---|---|---|
| Authenticate(String, String) | Authenticates the username and password against the RADIUS server. |
| Authenticate(String, String, Byte) | Authenticates the username and password against the RADIUS server. |
 | CheckDisposed | Helper method to check whether or not the object instance has been disposed. |
| CreateNewPin | Create a new pin for the user. |
| Dispose | Releases the used resources. |
| Dispose(Boolean) | Releases the used resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsUserInNewPinMode | Determines whether or not the response indicates that the user account is in "New Pin" mode. |
| IsUserInNextTokenMode | Determines whether or not the response indicates that the user account is in "Next Token" mode. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ProcessRequest | Send a request to the server and waits for a response back. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
  | DefaultNewPinModeMessage1 | 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. |
| DefaultNewPinModeMessage2 | 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. |
| DefaultNewPinModeMessage3 | 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. |
| DefaultNextTokenModeMessage | 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. |
| DefaultServerPort | Default port of the RADIUS server. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See Also