This documentation is archived and is not being maintained.

MaskGenerationMethod Class

Represents the abstract class from which all mask generator algorithms must derive.


Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

public ref class MaskGenerationMethod abstract

The MaskGenerationMethod type exposes the following members.

Protected methodMaskGenerationMethodInitializes a new instance of the MaskGenerationMethod class.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGenerateMaskWhen overridden in a derived class, generates a mask with the specified length using the specified random seed.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Derived classes of MaskGenerationMethod compute masks that are used in key exchange algorithms such as Optimal Asymmetric Encryption Padding (OAEP).

This class is used by implementations of key exchange algorithms only for mask generation. Application code does not use this class directly.

The following code example demonstrates how to derive from the MaskGenerationMethod class.

#using <System.dll>

using namespace System;
using namespace System::Security::Cryptography;

namespace Contoso
    ref class MaskGenerator: MaskGenerationMethod
        String^ hashNameValue;

        // Initialize a mask to encrypt using the SHA1 algorithm.
            hashNameValue = "SHA1";

        // Create a mask with the specified seed.
        virtual array<Byte>^ GenerateMask(array<Byte>^ seed, int maskLength) override
            HashAlgorithm^ hash;
            array<Byte>^ rgbCounter = gcnew array<Byte>(4);
            array<Byte>^ targetRgb = gcnew array<Byte>(maskLength);
            UInt32 counter = 0;
            for (int inc = 0; inc < targetRgb->Length; )
                ConvertIntToByteArray(counter++, rgbCounter);
                hash = (HashAlgorithm^)CryptoConfig::CreateFromName(
                array<Byte>^ temp = gcnew array<Byte>(
                    4 + seed->Length);
                Buffer::BlockCopy(rgbCounter, 0, temp, 0, 4);
                Buffer::BlockCopy(seed, 0, temp, 4, seed->Length);
                if (targetRgb->Length - inc > hash->HashSize / 8)
                    Buffer::BlockCopy(hash->Hash, 0, targetRgb, inc,
                    Buffer::BlockCopy(hash->Hash, 0, targetRgb, inc,
                        targetRgb->Length - inc);

                inc += hash->Hash->Length;
            return targetRgb;

        // Convert the specified integer to the byte array.
        void ConvertIntToByteArray(UInt32 source,
            array<Byte>^ targetBytes)
            UInt32 remainder;
            int inc = 0;

            // Clear the array prior to filling it.
            Array::Clear(targetBytes, 0, targetBytes->Length);
            while (source > 0)
                remainder = source % 256;
                targetBytes[ 3 - inc ] = (Byte)remainder;
                source = (source - remainder) / 256;

    // This class demonstrates how to create the MaskGenerator class 
    // and call its GenerateMask member.
    ref class MaskGeneratorImpl
        void static Work()
            array<Byte>^ seed = gcnew array<Byte>(4){
            int length = 16;
            MaskGenerator^ maskGenerator = gcnew MaskGenerator;
            array<Byte>^ mask = maskGenerator->GenerateMask(seed,
            Console::WriteLine("Generated the following mask:");
            Console::WriteLine("This sample completed successfully;"
                " press Enter to exit.");

void main()

// This sample produces the following output:
// Generated the following mask:
// ?"TFd(?~OtO?
// This sample completed successfully; press Enter to exit.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.