参数签名规则

参数签名采用 HMAC-MD5 算法,采用 MD5 作为散列函数,通过密钥(AppSecret)对 整个消息主体进行加密,然后采用 Md5 信息摘要的方式形成新的密文。

HMAC-MD5算法

  • K是密钥(appSecret),长度可为 64 字节,若小于该长度,在密钥后面用“0”补 齐
  • M 是消息内容
  • H 是散列函数
  • opad和Ipad分别是由若干个(本文档均使用一个)0x5c 和 0x36 组成的字符串
  • ⊕ 表示异或运算
  • ∣ 表示连接操作
HMAC(K,M)=H(K⊕opad∣H(K⊕ipad∣M)

api文档的HMAC-MD5流程

  1. 在密钥(appSecret)后面添加0来创建一个长为64字节的字符串(str)
  2. 将上一步生成的字符串(str)与ipad(0x36)做异或运算,形成结果字符串(istr)
  3. 将消息内容param(data+timeStamp组成的字符串)附加到第二步的结果字符串(istr)的末尾
  4. 做md5运算于第三步生成的数据流(istr)
  5. 将第一步生成的字符串(str)与opad(0x5c)做异或运算,形成结果字符串(ostr)
  6. 再将第四步的结果(istr)附加到第五步的结果字符串(ostr)的末尾;
  7. 做md5运算于第六步生成的数据流(ostr),输出最终结果(out)。

示例代码


import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class HMacMD5 {
    /**
     * 计算参数的md5信息
     *
     * @param str 待处理的字节数组
     * @return md5摘要信息
     * @throws NoSuchAlgorithmException
     */
    private static byte[] md5(byte[] str) throws NoSuchAlgorithmException {
        MessageDigest md = MessageDigest.getInstance("MD5");
        md.update(str);
        return md.digest();
    }

    /**
     * 将待加密数据data,通过密钥key,使用hmac-md5算法进行加密,然后返回加密结果。 参照rfc2104 HMAC算法介绍实现。
     *
     * @param key  密钥
     * @param data 待加密数据
     * @return 加密结果
     * @throws NoSuchAlgorithmException
     */
    private static byte[] getHmacMd5Bytes(byte[] key, byte[] data)
            throws NoSuchAlgorithmException {
        /*
         * HmacMd5 calculation formula: H(K XOR opad, H(K XOR ipad, text))
		 * HmacMd5 计算公式:H(K XOR opad, H(K XOR ipad, text))
		 * H代表hash算法,本类中使用MD5算法,K代表密钥,text代表要加密的数据 ipad为0x36,opad为0x5C。
		 */
        int length = 64;
        byte[] ipad = new byte[length];
        byte[] opad = new byte[length];
        for (int i = 0; i < 64; i++) {
            ipad[i] = 0x36;
            opad[i] = 0x5C;
        }
        byte[] actualKey = key; // Actual key.
        byte[] keyArr = new byte[length]; // Key bytes of 64 bytes length
        /*
    	 * 如果密钥长度,大于64字节,就使用哈希算法,计算其摘要,作为真正的密钥。
    	 */
        if (key.length > length) {
            actualKey = md5(key);
        }
        for (int i = 0; i < actualKey.length; i++) {
            keyArr[i] = actualKey[i];
        }
		/*
		 * append zeros to K 如果密钥长度不足64字节,就使用0x00补齐到64字节。
		 */
        if (actualKey.length < length) {
            for (int i = actualKey.length; i < keyArr.length; i++)
                keyArr[i] = 0x00;
        }

		/*
		 * calc K XOR ipad 使用密钥和ipad进行异或运算。
		 */
        byte[] kIpadXorResult = new byte[length];
        for (int i = 0; i < length; i++) {
            kIpadXorResult[i] = (byte) (keyArr[i] ^ ipad[i]);
        }

		/*
		 * append "text" to the end of "K XOR ipad" 将待加密数据追加到K XOR ipad计算结果后面。
		 */
        byte[] firstAppendResult = new byte[kIpadXorResult.length + data.length];
        for (int i = 0; i < kIpadXorResult.length; i++) {
            firstAppendResult[i] = kIpadXorResult[i];
        }
        for (int i = 0; i < data.length; i++) {
            firstAppendResult[i + keyArr.length] = data[i];
        }

		/*
		 * calc H(K XOR ipad, text) 使用哈希算法计算上面结果的摘要。
		 */
        byte[] firstHashResult = md5(firstAppendResult);

		/*
		 * calc K XOR opad 使用密钥和opad进行异或运算。
		 */
        byte[] kOpadXorResult = new byte[length];
        for (int i = 0; i < length; i++) {
            kOpadXorResult[i] = (byte) (keyArr[i] ^ opad[i]);
        }

		/*
		 * append "H(K XOR ipad, text)" to the end of "K XOR opad" 将H(K XOR
		 * ipad, text)结果追加到K XOR opad结果后面
		 */
        byte[] secondAppendResult = new byte[kOpadXorResult.length+ firstHashResult.length];
        for (int i = 0; i < kOpadXorResult.length; i++) {
            secondAppendResult[i] = kOpadXorResult[i];
        }
        for (int i = 0; i < firstHashResult.length; i++) {
            secondAppendResult[i + keyArr.length] = firstHashResult[i];
        }

		/*
		 * H(K XOR opad, H(K XOR ipad, text)) 对上面的数据进行哈希运算。
		 */
        return md5(secondAppendResult);
    }

    /**
     * 外部调用:String sign = HMacMD5.getHmacMd5Str(appSecret, param);
     */
    public static String getHmacMd5Str(String key, String param) throws Exception {
        byte[] keyByte = key.getBytes("UTF-8");
        byte[] dataByte = param.getBytes("UTF-8");
        byte[] hmacMd5Byte = getHmacMd5Bytes(keyByte, dataByte);
        StringBuilder md5StrBuff = new StringBuilder();
        for (byte aHmacMd5Byte : hmacMd5Byte) {
            if (Integer.toHexString(0xFF & aHmacMd5Byte).length() == 1) {
                md5StrBuff.append("0").append(Integer.toHexString(0xFF & aHmacMd5Byte));
            } else {
                md5StrBuff.append(Integer.toHexString(0xFF & aHmacMd5Byte));
            }
        }
        return md5StrBuff.toString().toUpperCase();

    }
}

签名示例

appSecret: 1234567890abcdef
data: ix+w8JyrGmls34SHBU4i56UFZcNxvlkIa3LieYwPjbP6YpT6OgaRDPZx+9e8BsyteMOcd8WU4q7kwYtWrZM9qg==
timeStamp: 1505374350
param(data+timeStamp): ix+w8JyrGmls34SHBU4i56UFZcNxvlkIa3LieYwPjbP6YpT6OgaRDPZx+9e8BsyteMOcd8WU4q7kwYtWrZM9qg==1505374350
运算后sign: 46F972F7C76FCD3564600FB472ACCA5B