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 functionsSecurity functionsString functions

History

ColdFusion 10: Added this function.

Syntax

HMac(message, key [,algorithm] [,encoding])

See also

Hash

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:

  • HMACMD5
  • HMACRIPEMD160
  • HMACSHA1
  • HMACSHA224
  • HMACSHA256
  • HMACSHA384
  • HMACSHA512

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

<h2>HMAC Test</h2> 
<cfset x=hmac("Hi There","key1","HMACRIPEMD160")> 
<cfoutput>#x#</cfoutput>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy