Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Authorization.ProtectionRealm Property

Gets or sets the prefix for Uniform Resource Identifiers (URIs) that can be authenticated with the Message property.

Namespace: System.Net
Assembly: System (in system.dll)

'Declaration
Public Property ProtectionRealm As String()
'Usage
Dim instance As Authorization
Dim value As String()

value = instance.ProtectionRealm

instance.ProtectionRealm = value
/** @property */
public String[] get_ProtectionRealm ()

/** @property */
public void set_ProtectionRealm (String[] value)

public function get ProtectionRealm () : String[]

public function set ProtectionRealm (value : String[])

Property Value

An array of strings that contains URI prefixes.

The ProtectionRealm property contains a list of URI prefixes that the Message property can be used to authenticate. WebRequest and its descendants compare a URI to this list to determine if the Authorization is valid for a particular URI.

The following code example gets or sets the prefix for URIs that can be authenticated with the Message property.

Function Authenticate(ByVal challenge As String, ByVal request As WebRequest, ByVal credentials As ICredentials) As Authorization Implements IAuthenticationModule.Authenticate
    Try
        Dim message As String
        ' Check if Challenge string was raised by a site which requires 'CloneBasic' authentication.
        If challenge Is Nothing Or Not challenge.StartsWith("CloneBasic") Then
            Return Nothing
        End If
        Dim myCredentials As NetworkCredential
        If TypeOf credentials Is CredentialCache Then
            myCredentials = credentials.GetCredential(request.RequestUri, "CloneBasic")
            If myCredentials Is Nothing Then
                Return Nothing
            End If
        Else
            myCredentials = CType(credentials, NetworkCredential)
        End If
        ' 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.
        Dim ascii As Encoding = Encoding.ASCII
        Dim byteArray(ascii.GetByteCount(message)) As Byte
        byteArray = ascii.GetBytes(message)

        ' Performing Base64 transformation.
        message = Convert.ToBase64String(byteArray)
        Dim myAuthorization As New Authorization("CloneBasic " + message, True)
        Dim protectionRealm() As String = {request.RequestUri.AbsolutePath}
        myAuthorization.ProtectionRealm = protectionRealm

        Return myAuthorization
    Catch e As Exception
        Console.WriteLine("The following exception was raised in Authenticate method:{0}", e.Message)
        Return Nothing
    End Try
End Function 'Authenticate


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 instanceof CredentialCache) {
            myCredentials = credentials.GetCredential(
                request.get_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.get_UserName() + " " 
            + myCredentials.get_Password();

        // Apply AsciiEncoding to 'message' string to obtain it as an array
        // of bytes.
        Encoding ascii = Encoding.get_ASCII();
        ubyte byteArray[] = new ubyte[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.get_RequestUri().get_AbsolutePath() };
        myAuthorization.set_ProtectionRealm(protectionRealm);
        return myAuthorization;
    }
    catch (System.Exception e) {
        Console.WriteLine("The following exception was raised in "
            + "Authenticate method:{0}", e.get_Message());
        return null;
    }
} //Authenticate

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2015 Microsoft