IAuthenticationModule.Authenticate メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IAuthenticationModule.Authenticate メソッド

サーバーからの認証チャレンジに応答して、Authorization クラスのインスタンスを返します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Function Authenticate ( _
    challenge As String, _
    request As WebRequest, _
    credentials As ICredentials _
) As Authorization

Visual Basic (使用法)

Dim instance As IAuthenticationModule
Dim challenge As String
Dim request As WebRequest
Dim credentials As ICredentials
Dim returnValue As Authorization

returnValue = instance.Authenticate(challenge, request, credentials)

Authorization Authenticate (
    string challenge,
    WebRequest request,
    ICredentials credentials
)

C++

Authorization^ Authenticate (
    String^ challenge, 
    WebRequest^ request, 
    ICredentials^ credentials
)

Authorization Authenticate (
    String challenge, 
    WebRequest request, 
    ICredentials credentials
)

JScript

function Authenticate (
    challenge : String, 
    request : WebRequest, 
    credentials : ICredentials
) : Authorization

パラメータ

challenge: サーバーが送信する認証チャレンジ。

request: チャレンジと関連付けられる WebRequest インスタンス。

credentials: チャレンジと関連付けられる資格情報。

戻り値
要求の承認メッセージを格納する Authorization インスタンス。またはチャレンジを処理できない場合は null 参照 (Visual Basic では Nothing)。

解説

Authenticate メソッドは、サーバーとの認証処理を実行し、Authorization インスタンスを AuthenticationManager に返します。

実装時の注意 AuthenticationManager は、登録された認証モジュールで Authenticate メソッドを呼び出し、チャレンジを処理するモジュールを決定します。認証モジュールがチャレンジを処理できない場合、Authenticate メソッドは null 参照 (Visual Basic では Nothing) を返す必要があります。認証処理の実行中に認証モジュールにエラーが発生した場合、Authenticate は例外をスローする必要があります。

使用例

Authenticate メソッドを使用する方法の例を次に示します。詳細については、AuthenticationManager クラスのトピックを参照してください。

Visual Basic

  ' 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 Function Authenticate(ByVal
 challenge As String, ByVal
 request As WebRequest, ByVal credentials As ICredentials) As Authorization _
      Implements IAuthenticationModule.Authenticate


    Dim ASCII As Encoding = Encoding.ASCII

    ' Get the username and password from the credentials
    Dim MyCreds As NetworkCredential = credentials.GetCredential(request.RequestUri,
 "Basic")

    If PreAuthenticate(request, credentials) Is
 Nothing Then
      Console.WriteLine(ControlChars.Lf + " Pre-authentication
 is not allowed.")
    Else
      Console.WriteLine(ControlChars.Lf + " Pre-authentication
 is allowed.")
    End If
    ' Verify that the challenge satisfies the authorization requirements.
    Dim challengeOk As Boolean
 = checkChallenge(challenge, MyCreds.Domain)

    If Not challengeOk Then
      Return Nothing
    End If

    ' 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.
    Dim BasicEncrypt As String
 = MyCreds.UserName + ":" + MyCreds.Password

    Dim BasicToken As String
 = "Basic " + Convert.ToBase64String(ASCII.GetBytes(BasicEncrypt))

    ' Create an Authorization object using the encoded authorization
 above.
    Dim resourceAuthorization As 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(ControlChars.Lf + " 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(ControlChars.Lf + " Authorization Complete:{0}",
 resourceAuthorization.Complete)

    Console.WriteLine(ControlChars.Lf + " Authorization ConnectionGroupId:{0}",
 resourceAuthorization.ConnectionGroupId)


    Return resourceAuthorization
  End Function 'Authenticate
End Class 'CustomBasic

// 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;
}

C++

// 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 they were registered. When the authentication
 is
// complete an Authorization object is returned to the WebRequest, as
// shown by this routine's retun type.
virtual 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 ) == nullptr )
         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 nullptr;

   
   // Create the encrypted string according to the Basic authentication
 format as
   // follows:
   // a)Concatenate 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 = String::Concat( MyCreds->UserName, ":", MyCreds->Password
 );
   String^ BasicToken = String::Concat( "Basic ", Convert::ToBase64String(
 ASCII->GetBytes( BasicEncrypt ) ) );
   
   // Create an Authorization object using the above encoded authorization.
   Authorization^ resourceAuthorization = gcnew 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;
}

// 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.get_ASCII();

    // Get the username and password from the credentials
    NetworkCredential myCreds = credentials.GetCredential(
                                request.get_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.
    boolean challengeOk = CheckChallenge(challenge, myCreds.get_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.get_UserName() + ":" 
        + myCreds.get_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.get_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}", 
        System.Convert.ToString(resourceAuthorization.get_Complete()));

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