MSDN Library

SpxAuthentication Class

Represents the authentication mechanism for the SPX protocol. This class provides methods and properties to configure and manage SPX authentication.

Namespace:

System.Net.Security

Assembly:

System.Net.dll

Inheritance:

object
  System.Net.Security.SpxAuthentication

Remarks

The SpxAuthentication class is used in scenarios where you need to establish a secure and authenticated connection using the SPX (Sequenced Packet Exchange) protocol, often associated with Novell NetWare environments. It handles the complexities of credential exchange and verification to ensure that only authorized parties can communicate. This class is typically used in conjunction with other networking classes like Socket or TcpClient to integrate SPX authentication into your network applications.

Examples

The following C# code snippet demonstrates how to create an instance of the SpxAuthentication class and set some basic properties.

using System;
using System.Net.Security;

public class SpxAuthExample
{
    public static void Main(string[] args)
    {
        try
        {
            // Create an SpxAuthentication object
            SpxAuthentication spxAuth = new SpxAuthentication();

            // Set the username and password for authentication
            spxAuth.Username = "networkuser";
            spxAuth.Password = "SecureP@ssw0rd";

            // Optionally, specify a realm or domain
            spxAuth.Realm = "MYDOMAIN";

            Console.WriteLine("SPX Authentication object created successfully.");
            Console.WriteLine($"Username: {spxAuth.Username}");
            Console.WriteLine($"Realm: {spxAuth.Realm}");

            // In a real application, you would use this object to establish a connection
            // For demonstration purposes, we'll just show the setup.
        }
        catch (Exception ex)
        {
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

Members

The SpxAuthentication class exposes the following members:

SpxAuthentication()

Initializes a new instance of the SpxAuthentication class. This constructor does not require any arguments.

Username

public string Username { get; set; }

This property specifies the username to be used during the SPX authentication process. It is a required field for successful authentication against a server.

Password

public string Password { get; set; }

This property specifies the password associated with the username for SPX authentication. It should be kept confidential and handled securely.

Realm

public string Realm { get; set; }

This property allows you to specify the authentication realm or domain. This is useful in environments where multiple authentication domains exist.

Authenticate()

public bool Authenticate()

This method begins the SPX authentication handshake with the remote server. It returns true if the authentication is successful, and false otherwise. Exceptions may be thrown for network-related errors or invalid credentials.

Dispose()

public void Dispose()

Implements the IDisposable interface to clean up resources. It is recommended to call this method when you are finished with the SpxAuthentication object to release any underlying network handles or other resources.