IAuthenticationModule Интерфейс

Определение

Пространство имен:

System.Net

Сборка:

System.Net.Requests.dll

Предоставляет базовый интерфейс проверки подлинности для модулей проверки подлинности, принадлежащих веб-клиенту.

public interface IAuthenticationModule

Примеры

В следующем примере создается настраиваемый класс проверки подлинности путем реализации IAuthenticationModule интерфейса . Полный пример см. в AuthenticationManager разделе класс .

// The CustomBasic class creates a custom Basic authentication by implementing the
// IAuthenticationModule interface. It performs the following
// tasks:
// 1) Defines and initializes the required properties.
// 2) Implements the Authenticate method.

public class CustomBasic : IAuthenticationModule
{

  // Define the authentication type. This type is then used to identify this
  // custom authentication module. The default is set to Basic.
  public string AuthenticationType { get; } = "Basic";

  // Define the pre-authentication capabilities for the module. The default is set
  // to false.
  public bool CanPreAuthenticate { get; }

  // The CheckChallenge method checks whether the challenge sent by the HttpWebRequest
  // contains the correct type (Basic) and the correct domain name.
  // Note: The challenge is in the form BASIC REALM="DOMAINNAME";
  // the Internet Web site must reside on a server whose
  // domain name is equal to DOMAINNAME.
  public bool CheckChallenge(string challenge, string domain)
  {
    bool challengePasses = false;

    String tempChallenge = challenge.ToUpper();

    // Verify that this is a Basic authorization request and that the requested domain
    // is correct.
    // Note: When the domain is an empty string, the following code only checks
    // whether the authorization type is Basic.

    if (tempChallenge.IndexOf("BASIC") != -1)
      if (!string.IsNullOrEmpty(domain))
        if (tempChallenge.IndexOf(domain.ToUpper()) != -1)
          challengePasses = true;
        else
          // The domain is not allowed and the authorization type is Basic.
          challengePasses = false;
      else
        // The domain is a blank string and the authorization type is Basic.
        challengePasses = true;

    return challengePasses;
  }

  // The PreAuthenticate method specifies whether the authentication implemented
  // by this class allows pre-authentication.
  // Even if you do not use it, this method must be implemented to obey to the rules
  // of interface implementation.
  // In this case it always returns null.
  public Authorization PreAuthenticate(WebRequest request, ICredentials credentials)
  {
    return null;
  }

  // Authenticate is the core method for this custom authentication.
  // When an Internet resource requests authentication, the WebRequest.GetResponse
  // method calls the AuthenticationManager.Authenticate method. This method, in
  // turn, calls the Authenticate method on each of the registered authentication
  // modules, in the order in which they were registered. When the authentication is
  // complete an Authorization object is returned to the WebRequest.
  public Authorization Authenticate(String challenge, WebRequest request, ICredentials credentials)
  {
    Encoding ASCII = Encoding.ASCII;

    // Get the username and password from the credentials
    NetworkCredential myCreds = credentials.GetCredential(request.RequestUri, "Basic");

    if (PreAuthenticate(request, credentials) == null)
      Console.WriteLine("\n Pre-authentication is not allowed.");
    else
      Console.WriteLine("\n Pre-authentication is allowed.");

    // Verify that the challenge satisfies the authorization requirements.
    bool challengeOk = CheckChallenge(challenge, myCreds.Domain);

    if (!challengeOk)
      return null;

    // Create the encrypted string according to the Basic authentication format as
    // follows:
    // a)Concatenate the username and password separated by colon;
    // b)Apply ASCII encoding to obtain a stream of bytes;
    // c)Apply Base64 encoding to this array of bytes to obtain the encoded
    // authorization.
    string basicEncrypt = myCreds.UserName + ":" + myCreds.Password;

    string basicToken = "Basic " + Convert.ToBase64String(ASCII.GetBytes(basicEncrypt));

    // Create an Authorization object using the encoded authorization above.
    Authorization resourceAuthorization = new Authorization(basicToken);

    // Get the Message property, which contains the authorization string that the
    // client returns to the server when accessing protected resources.
    Console.WriteLine("\n Authorization Message:{0}",resourceAuthorization.Message);

    // Get the Complete property, which is set to true when the authentication process
    // between the client and the server is finished.
    Console.WriteLine("\n Authorization Complete:{0}",resourceAuthorization.Complete);

    Console.WriteLine("\n Authorization ConnectionGroupId:{0}",resourceAuthorization.ConnectionGroupId);

    return resourceAuthorization;
  }
}

Комментарии

Интерфейс IAuthenticationModule определяет свойства и методы, которые должны использовать пользовательские модули проверки подлинности.

Модули проверки подлинности выполняют весь процесс проверки подлинности на сервере, отвечая на запрос проверки подлинности соответствующим образом. Этот процесс может состоять из запросов к серверу проверки подлинности отдельно от сервера ресурсов, а также любых других действий, необходимых для правильной проверки подлинности запроса на URI.

Пользовательские модули проверки подлинности должны реализовывать IAuthenticationModule интерфейс , а затем регистрироваться с помощью AuthenticationManager.Register метода . Модули проверки подлинности также регистрируются при инициализации программы путем чтения файла конфигурации.

Свойства

AuthenticationType	Получает тип проверки подлинности, предоставляемый данным модулем проверки подлинности.
CanPreAuthenticate	Получает значение, указывающее наличие поддержки предварительной проверки подлинности модулями проверки подлинности.

Методы

Authenticate(String, WebRequest, ICredentials)	Возвращает экземпляр класса Authorization в ответ на запрос проверки подлинности, посылаемый с сервера.
PreAuthenticate(WebRequest, ICredentials)	Возвращает экземпляр класса Authorization для запроса проверки подлинности, посылаемого на сервер.

Применяется к

См. также раздел

• AuthenticationManager