HashAlgorithmProvider HashAlgorithmProvider HashAlgorithmProvider HashAlgorithmProvider Class

Definition

public : sealed class HashAlgorithmProvider : IHashAlgorithmProviderpublic sealed class HashAlgorithmProvider : IHashAlgorithmProviderPublic NotInheritable Class HashAlgorithmProvider Implements IHashAlgorithmProvider// You can use this class in JavaScript.

Attributes

ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute StaticAttribute ThreadingAttribute

Examples

using Windows.Security.Cryptography;
using Windows.Security.Cryptography.Core;
using Windows.Storage.Streams;

namespace SampleHashAlgorithmProvider
{

    sealed partial class HashAlgProviderApp : Application
    {
        public HashAlgProviderApp()
        {
            // Initialize the application.
            this.InitializeComponent();

            // Hash a message.
            String strAlgName = HashAlgorithmNames.Sha512;
            String strMsg = "This is a message to be hashed.";
            String strEncodedHash = this.SampleHashMsg(strAlgName, strMsg);
        }

        public String SampleHashMsg(String strAlgName, String strMsg)
        {
            // Convert the message string to binary data.
            IBuffer buffUtf8Msg = CryptographicBuffer.ConvertStringToBinary(strMsg, BinaryStringEncoding.Utf8);

            // Create a HashAlgorithmProvider object.
            HashAlgorithmProvider objAlgProv = HashAlgorithmProvider.OpenAlgorithm(strAlgName);

            // Demonstrate how to retrieve the name of the hashing algorithm.
            String strAlgNameUsed = objAlgProv.AlgorithmName;

            // Hash the message.
            IBuffer buffHash = objAlgProv.HashData(buffUtf8Msg);

            // Verify that the hash length equals the length specified for the algorithm.
            if (buffHash.Length != objAlgProv.HashLength)
            {
                throw new Exception("There was an error creating the hash");
            }

            // Convert the hash to a string (for display).
            String strHashBase64 = CryptographicBuffer.EncodeToBase64String(buffHash);

            // Return the encoded string
            return strHashBase64;
        }
    }
}

Remarks

You create a HashAlgorithmProvider object by calling the static OpenAlgorithm method and specifying one of the following algorithm names:

• MD5
• SHA1
• SHA256
• SHA384
• SHA512

public : PlatForm::String AlgorithmName { get; }public string AlgorithmName { get; }Public ReadOnly Property AlgorithmName As string// You can use this property in JavaScript.

public : unsigned int HashLength { get; }public uint HashLength { get; }Public ReadOnly Property HashLength As uint// You can use this property in JavaScript.

public : CryptographicHash CreateHash()public CryptographicHash CreateHash()Public Function CreateHash() As CryptographicHash// You can use this method in JavaScript.

public : IBuffer HashData(IBuffer data)public IBuffer HashData(IBuffer data)Public Function HashData(data As IBuffer) As IBuffer// You can use this method in JavaScript.

public : static HashAlgorithmProvider OpenAlgorithm(PlatForm::String algorithm)public static HashAlgorithmProvider OpenAlgorithm(String algorithm)Public Static Function OpenAlgorithm(algorithm As String) As HashAlgorithmProvider// You can use this method in JavaScript.

See Also

• MACs, hashes, and signatures