Authorization Constructors

Definition

Creates a new instance of the Authorization class.

Overloads

Authorization(String)

Creates a new instance of the Authorization class with the specified authorization message.

Authorization(String, Boolean)

Creates a new instance of the Authorization class with the specified authorization message and completion status.

Authorization(String, Boolean, String)

Creates a new instance of the Authorization class with the specified authorization message, completion status, and connection group identifier.

Authorization(String)

Source:
Authorization.cs
Source:
Authorization.cs
Source:
Authorization.cs

Creates a new instance of the Authorization class with the specified authorization message.

C#
public Authorization(string? token);
C#
public Authorization(string token);

Parameters

token
String

The encrypted authorization message expected by the server.

Examples

The following code example shows how to create an Authorization object. For a complete example, refer to the AuthenticationManager class.

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

Remarks

The Authorization instance is created with the Message property set to token and the Complete property set to true.

Applies to

.NET 10 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

Authorization(String, Boolean)

Source:
Authorization.cs
Source:
Authorization.cs
Source:
Authorization.cs

Creates a new instance of the Authorization class with the specified authorization message and completion status.

C#
public Authorization(string? token, bool finished);
C#
public Authorization(string token, bool finished);

Parameters

token
String

The encrypted authorization message expected by the server.

finished
Boolean

The completion status of the authorization attempt. true if the authorization attempt is complete; otherwise, false.

Examples

The following code example creates a new instance of the Authorization class with the specified authorization message and completion status.

C#
public Authorization Authenticate( string challenge,WebRequest request,ICredentials credentials)
{
    try
    {
        string message;
        // Check if Challenge string was raised by a site which requires 'CloneBasic' authentication.
        if ((challenge == null) || (!challenge.StartsWith("CloneBasic")))
            return null;
        NetworkCredential myCredentials;
        if (credentials is CredentialCache)
        {
            myCredentials = credentials.GetCredential(request.RequestUri,"CloneBasic");
            if (myCredentials == null)
                return null;
        }
        else
        {
            myCredentials = (NetworkCredential)credentials;
        }
        // Message encryption scheme :
        //   a)Concatenate username and password seperated by space;
        //   b)Apply ASCII encoding to obtain a stream of bytes;
        //   c)Apply Base64 Encoding to this array of bytes to obtain our encoded authorization message.

        message = myCredentials.UserName + " " + myCredentials.Password;
        // Apply AsciiEncoding to 'message' string to obtain it as an array of bytes.
        Encoding ascii = Encoding.ASCII;
        byte[] byteArray = new byte[ascii.GetByteCount(message)];
        byteArray = ascii.GetBytes(message);

        // Performing Base64 transformation.
        message = Convert.ToBase64String(byteArray);
        Authorization myAuthorization = new Authorization("CloneBasic " + message,true);
        string[] protectionRealm = new string[]{request.RequestUri.AbsolutePath};
        myAuthorization.ProtectionRealm = protectionRealm;

        return myAuthorization;
    }
    catch(Exception e)
    {
        Console.WriteLine("The following exception was raised in Authenticate method:{0}",e.Message);
        return null;
    }
  }

Remarks

The Authorization instance is created with the Message property set to token and the Complete property set to finished.

Applies to

.NET 10 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

Authorization(String, Boolean, String)

Source:
Authorization.cs
Source:
Authorization.cs
Source:
Authorization.cs

Creates a new instance of the Authorization class with the specified authorization message, completion status, and connection group identifier.

C#
public Authorization(string? token, bool finished, string? connectionGroupId);
C#
public Authorization(string token, bool finished, string connectionGroupId);

Parameters

token
String

The encrypted authorization message expected by the server.

finished
Boolean

The completion status of the authorization attempt. true if the authorization attempt is complete; otherwise, false.

connectionGroupId
String

A unique identifier that can be used to create private client-server connections that are bound only to this authentication scheme.

Examples

The following code example creates a new instance of the Authorization class with the specified authorization message, completion status, and connection group identifier.

C#
public Authorization Authenticate( string challenge,WebRequest request,ICredentials credentials)
{
    try
    {
        string message;
        // Check if Challenge string was raised by a site which requires CloneBasic authentication.
        if ((challenge == null) || (!challenge.StartsWith("CloneBasic")))
            return null;
        NetworkCredential myCredentials;
        if (credentials is CredentialCache)
        {
            myCredentials = credentials.GetCredential(request.RequestUri,"CloneBasic");
            if (myCredentials == null)
                return null;
        }
        else
        {
            myCredentials = (NetworkCredential)credentials;
        }
        // Message encryption scheme :
        // a)Concatenate username and password seperated by space;
        // b)Apply ASCII encoding to obtain a stream of bytes;
        // c)Apply Base64 Encoding to this array of bytes to obtain our encoded authorization message.

        message = myCredentials.UserName + " " + myCredentials.Password;
        // Apply AsciiEncoding to our user name and password to obtain it as an array of bytes.
        Encoding asciiEncoding = Encoding.ASCII;
        byte[] byteArray = new byte[asciiEncoding.GetByteCount(message)];
        byteArray = asciiEncoding.GetBytes(message);

        // Perform Base64 transform.
        message = Convert.ToBase64String(byteArray);
    // The following overloaded contructor sets the 'Message' property of authorization to the base64 string;
    // that  we just formed and it also sets the 'Complete' property to true and the connection group id;
    // to the domain of the NetworkCredential object.
        Authorization myAuthorization = new Authorization("CloneBasic " + message,true,request.ConnectionGroupName);
        return myAuthorization;
    }
    catch(Exception e)
    {
            Console.WriteLine("Exception Raised ...:"+e.Message);
        return null;
    }
  }

Applies to

.NET 10 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1