Export (0) Print
Expand All

HMAC Class

Represents the abstract class from which all implementations of Hash-based Message Authentication Code (HMAC) must derive.

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

[<AbstractClass>]
[<ComVisibleAttribute(true)>]
type HMAC =  
    class 
        inherit KeyedHashAlgorithm 
    end

The HMAC type exposes the following members.

  NameDescription
Protected methodHMACInitializes a new instance of the HMAC class.
Top

  NameDescription
Protected propertyBlockSizeValueGets or sets the block size to use in the hash value.
Public propertyCanReuseTransformGets a value indicating whether the current transform can be reused. (Inherited from HashAlgorithm.)
Public propertyCanTransformMultipleBlocksWhen overridden in a derived class, gets a value indicating whether multiple blocks can be transformed. (Inherited from HashAlgorithm.)
Public propertyHashGets the value of the computed hash code. (Inherited from HashAlgorithm.)
Public propertyHashNameGets or sets the name of the hash algorithm to use for hashing.
Public propertyHashSizeGets the size, in bits, of the computed hash code. (Inherited from HashAlgorithm.)
Public propertyInputBlockSizeWhen overridden in a derived class, gets the input block size. (Inherited from HashAlgorithm.)
Public propertyKeyGets or sets the key to use in the hash algorithm. (Overrides KeyedHashAlgorithm.Key.)
Public propertyOutputBlockSizeWhen overridden in a derived class, gets the output block size. (Inherited from HashAlgorithm.)
Top

  NameDescription
Public methodClearReleases all resources used by the HashAlgorithm class. (Inherited from HashAlgorithm.)
Public methodComputeHash(Byte[])Computes the hash value for the specified byte array. (Inherited from HashAlgorithm.)
Public methodComputeHash(Stream)Computes the hash value for the specified Stream object. (Inherited from HashAlgorithm.)
Public methodComputeHash(Byte[], Int32, Int32)Computes the hash value for the specified region of the specified byte array. (Inherited from HashAlgorithm.)
Public methodStatic memberCreate()Creates an instance of the default implementation of a Hash-based Message Authentication Code (HMAC).
Public methodStatic memberCreate(String)Creates an instance of the specified implementation of a Hash-based Message Authentication Code (HMAC).
Public methodDispose()Releases all resources used by the current instance of the HashAlgorithm class. (Inherited from HashAlgorithm.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the HMAC class when a key change is legitimate and optionally releases the managed resources. (Overrides KeyedHashAlgorithm.Dispose(Boolean).)
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodHashCoreWhen overridden in a derived class, routes data written to the object into the default HMAC hash algorithm for computing the hash value. (Overrides HashAlgorithm.HashCore(Byte[], Int32, Int32).)
Protected methodHashFinalWhen overridden in a derived class, finalizes the hash computation after the last data is processed by the cryptographic stream object. (Overrides HashAlgorithm.HashFinal().)
Public methodInitializeInitializes an instance of the default implementation of HMAC. (Overrides HashAlgorithm.Initialize().)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformBlockComputes the hash value for the specified region of the input byte array and copies the specified region of the input byte array to the specified region of the output byte array. (Inherited from HashAlgorithm.)
Public methodTransformFinalBlockComputes the hash value for the specified region of the specified byte array. (Inherited from HashAlgorithm.)
Top

  NameDescription
Protected fieldHashSizeValueRepresents the size, in bits, of the computed hash code. (Inherited from HashAlgorithm.)
Protected fieldHashValueRepresents the value of the computed hash code. (Inherited from HashAlgorithm.)
Protected fieldKeyValueThe key to use in the hash algorithm. (Inherited from KeyedHashAlgorithm.)
Protected fieldStateRepresents the state of the hash computation. (Inherited from HashAlgorithm.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDisposable.DisposeReleases the unmanaged resources used by the HashAlgorithm and optionally releases the managed resources. (Inherited from HashAlgorithm.)
Top

A Hash-based Message Authentication Code (HMAC) can be used to determine whether a message sent over an insecure channel has been tampered with, provided that the sender and receiver share a secret key. The sender computes the hash value for the original data and sends both the original data and the HMAC as a single message. The receiver recomputes the hash value on the received message and checks that the computed hash value matches the transmitted hash value.

HMAC can be used with any iterative cryptographic hash function, such as MD5 or SHA-1, in combination with a secret shared key. The cryptographic strength of HMAC depends on the properties of the underlying hash function.

Any change to the data or the hash value results in a mismatch, because knowledge of the secret key is required to change the message and reproduce the correct hash value. Therefore, if the original and computed hash values match, the message is authenticated.

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft