Description
Creates Hash-based Message Authentication Code for the given string based on the algorithm and encoding. Hash-based Message Authentication Code (HMAC) is used to verify the data integrity and authenticity of a message transmitted. It involves a cryptographic hash function in combination with a secret key. The cryptographic hash function can be Message Digest 5 (MD5), Secure Hash Algorithm (SHA), and so on.
Returns
An encoded string
Category
Conversion functions, Security functions, String functions
History
ColdFusion 10: Added this function.
Syntax
HMac(message, key [,algorithm] [,encoding])
See also
History
ColdFusion 10: Added this function.
Parameters
Parameter |
Required\Optional |
Description |
|---|---|---|
message |
Required |
The message to transmit. The message can be a String or a byte array. |
key |
Required |
The secret key to create HMAC. The key can be a String or a byte array. |
algorithm |
Optional |
The hash algorithm to use. The following is a list of HMAC algorithms:
|
encoding |
Optional |
The character encoding to use. |
Usage
Use this function to create Hash-based Message Authentication Code for the given string based on the algorithm and encoding.
Example
<cfscript>
x=hmac("Hi There","key1","HMACRIPEMD160")
writeOutput(x) // 4E1A31DD8A26BDB9344D391D44DDCA9B28F10739
</cfscript>