v2版接口加簽驗簽

最近更新時間：2024.9.1

適用范圍

所有以下出口接口： https://api.huifu.com/v2/

公私鑰

查看聯調公私參數獲取說明；

參數形式

• 接口都是以POST方法請求一個完整的JSON對象（不是JSON字符串）

• body.data 是完整的業務參數
• body.data是JSON對象，不是JSON字符串
• body.data內層復雜對象類型請參考API文檔（大部分是字符串類型）
• 詳細樣例，請參考具體文檔或者下面的例子

• body.data提出了完整的業務參數，第一層是基本類型（String、Int），沒有復雜類型JSON
• body.data第一層所有提交的參數參與簽名

如果出現樓層，則以JSON字符串形式傳遞。例如下面的terminal_device_info

{
    "sys_id":"test",
    "product_id":"HSK",
    “data”: {
        "devs_id": "TYXJL0623715525894234",
        "auth_code": "134558771750600000",
        "terminal_device_info": "{\"devs_id\":\"TYXJL0623715525894234\"}"
    },
    “sign”:”簽名”
}復制代碼復制失敗復制成功

如何加簽

只需對body.data中的內容進行加簽。

1. body.data中的數據，去掉換行、空格等格式字符后，按照參數字典順序排序生成字符串（參數名ASCII碼到大排序（字典序）；參數名區分大小寫；）以上文為排序后

{
 "auth_code": "134558771750600000",
 "devs_id": "TYXJL0623715525894234",
 "terminal_device_info": "{\"devs_id\":\"TYXJL0623715525894234\"}"
}復制代碼復制失敗復制成功

注：如果是JSON字符串，不需要進行排序，例如terminal_device_info的值不需要排序

2. 對第一步生成的字符串結合您的私鑰進行加簽；注：如果你有自己的私鑰可以用自己的。如果沒有看到聯調公私鑰參數獲取后續說明
3. 首先將json對象按照參數字典順序（參數名ASCII碼到大排序，參數名區分大小寫）排序生成字符串，然后進行加簽和驗簽。
   JSON數據排序代碼示例

java代碼示例

import java.util.TreeMap;

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

JSON.toJSONString(JSONObject.parseObject(inputDataJSON, TreeMap.class))復制代碼復制失敗復制成功

python代碼示例

# json 數據排序示例
def sort_dict(params):
    """
    排序json 對象，按ASCII順序排序。多層結構只排序第一層
    :param params:
    :return:
    """
    keys = sorted(params.keys())
    result = {}
    for key in keys:
        value = params.get(key)
        if type(value).__name__ == 'dict':
            result[key] = value
        elif type(value).__name__ == 'list' and len(value) != 0:
            result[key] = params.get(key)
        elif params.get(key) is not None:
            result[key] = params.get(key)
    return result復制代碼復制失敗復制成功

PHP代碼示例

/** @param array $data 原數據( 排序后的json字符串; 數組參數排序后轉json字符串(數據的中文和斜杠均不轉碼):**/
    ksort($post_data); 
    json_encode($post_data, JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE); )復制代碼復制失敗復制成功

C#代碼示例

//排序
public static string sort4JsonString(string sourceJson)  
{  
  
    var dic = JsonConvert.DeserializeObject<SortedDictionary<string, object>>(sourceJson);  
    SortedDictionary<string, object> keyValues = new SortedDictionary<string, object>(dic);  
    var result = keyValues.OrderBy(m => m.Key);//升序 把Key換成Value 就是對Value進行排序  
    //var result = keyValues.OrderByDescending(m => m.Key);//降序  
      
    //簡化為如下代碼  
    Dictionary<string, object> resultDic = result.ToDictionary(x => x.Key, x => x.Value);  
      
    return JsonConvert.SerializeObject(resultDic);  
  
}復制代碼復制失敗復制成功

1. 概要如下

java代碼示例

/**
 * RSA私鑰簽名：簽名方式SHA256WithRSA
 * @param data 待簽名字符串
 * @param privateKeyBase64 私鑰（Base64編碼）
 * @return 簽名byte[]
 * @throws Exception
 */
public static String sign(String data, String privateKeyBase64) {
        // Base64 --> Key
        try {
                byte[] bytes = Base64.getDecoder().decode(privateKeyBase64);
                PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(bytes);
                KeyFactory keyFactory;
                keyFactory = KeyFactory.getInstance("RSA");
                PrivateKey privateKey = keyFactory.generatePrivate(keySpec);
                // Sign
                Signature signature = Signature.getInstance("SHA256WithRSA");
                signature.initSign(privateKey);
                signature.update(data.getBytes("UTF-8"));
                return Base64.getEncoder().encodeToString(signature.sign());
        } catch (Exception e) {
                return null;
        }
}復制代碼復制失敗復制成功

python代碼示例

# 私鑰加簽
def rsa_sign(private_key, message, charset='utf-8'):
    try:
        private_key = add_start_end(private_key, "-----BEGIN PRIVATE KEY-----\n", "\n-----END PRIVATE KEY-----")
        msg = message.encode(charset)
        private_key = RSA.importKey(private_key)
        # message做“哈希”處理，RSA簽名這么要求的
        hash_obj = SHA256.new(msg)
        signature = pkcs1_15.new(private_key).sign(hash_obj)
        return True, base64.b64encode(signature).decode(charset)
    except Exception as ex:
        return False, str(ex)復制代碼復制失敗復制成功

PHP代碼示例

/**
 * 私鑰加簽（對數據源排序），可用于 V2 版本接口數據加簽
 *
 * @param array $data 原數據( 排序后的json字符串; 數組參數排序后轉json字符串(數據的中文和斜杠均不轉碼): 
                            ksort($post_data); json_encode($post_data, JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE); )
 *
 * @param string $rsaPrivateKey 私鑰
 * @param int $alg 默認 OPENSSL_ALGO_SHA256
 *
 * @return string 簽名串
 */
function sha_with_rsa_sign($data, $rsaPrivateKey, $alg=OPENSSL_ALGO_SHA256){
    $key = "-----BEGIN PRIVATE KEY-----\n".wordwrap($rsaPrivateKey, 64, "\n", true)."\n-----END PRIVATE KEY-----";
    $signature= '';
    try {
        openssl_sign($data, $signature, $key, $alg);
    } catch (\Exception $e) {
        echo $e->getMessage();
    }
    return base64_encode($signature);
}復制代碼復制失敗復制成功

C#代碼示例

//私鑰加簽
public static string sign(string signaturePrivateKey, string signatureData, string hashAlgorithm = "SHA256", string encoding = "UTF-8")  
    {  
    RSACryptoServiceProvider rsa = new RSACryptoServiceProvider();  
    // var privateJavaKey = signaturePrivateKey;  
    // var privateCSharpKey = RSAPrivateKeyJava2DotNet(privateJavaKey);  
    // rsa.FromXmlString(privateCSharpKey);  
    rsa.FromPrivateKeyJavaString(signaturePrivateKey);  
      
    byte[] signatureBytes = rsa.SignData(Encoding.GetEncoding(encoding).GetBytes(signatureData), hashAlgorithm);  
    return Convert.ToBase64String(signatureBytes);  
      
    }復制代碼復制失敗復制成功

提示：您可以通過斗拱CLI工具提供的verify_sign命令驗證生成的簽文是否正確；參見CLI工具介紹

如何簽

僅對數據中的內容進行驗簽

1. 數據中的數據，同步返參參數字典順序排序生成字符串，自動返參不需要排序。

以上文為例整理后

{
 "auth_code": "134558771750600000",
 "devs_id": "TYXJL0623715525894234",
 "terminal_device_info": "{\"devs_id\":\"TYXJL0623715525894234\"}"
}復制代碼復制失敗復制成功

注：如果是JSON字符串，不需要進行排序，例如terminal_device_info不需要排序；

2. 對第一步生成的字符串結合斗拱平臺進行驗簽
3. 經驗訂閱如下

java代碼示例

/**
 * 使用匯付RSA公鑰驗簽
 * @param data 待簽名字符串
 * @param publicKeyBase64 公鑰（Base64編碼）
 * @return 驗簽結果
 * @throws Exception
 */
public static boolean verify(String data, String publicKeyBase64, String sign) {
   // Base64 --> Key
   try {
          byte[] bytes = Base64.getDecoder().decode(publicKeyBase64);
          X509EncodedKeySpec keySpec = new X509EncodedKeySpec(bytes);
          KeyFactory keyFactory;
          keyFactory = KeyFactory.getInstance("RSA");
          PublicKey publicKey = keyFactory.generatePublic(keySpec);
          // verify
          Signature signature = Signature.getInstance("SHA256WithRSA");
          signature.initVerify(publicKey);
          signature.update(data.getBytes("UTF-8"));
          return signature.verify(Base64.getDecoder().decode(sign));
   } catch (Exception e) {
          logger.error("Exception", e);
          return false;
   }
 
}復制代碼復制失敗復制成功

python代碼示例

# 使用匯付公鑰驗簽
def rsa_design(signature, message, my_rsa_public):
    try:
        my_rsa_public = fill_public_key_marker(my_rsa_public)
        message = message.encode("utf-8")
        public_key = RSA.importKey(my_rsa_public)
        # message做“哈希”處理，RSA簽名這么要求的
        hash_obj = SHA256.new(message)

        pkcs1_15.new(public_key).verify(hash_obj, base64.b64decode(signature))
        return True, ''
    except (ValueError, TypeError) as ex:
        return False, str(ex)復制代碼復制失敗復制成功

PHP代碼示例

/**
 * 匯付公鑰驗簽（對數據源排序），可用于 V2 版本接口返回數據驗簽
 *
 * @param string $signature 簽文
 * @param array $data 原數據(array)
 * @param string $rsaPublicKey 公鑰
 * @param int $alg 默認 OPENSSL_ALGO_SHA256
 *
 * @return false|int 驗證結果：成功/失敗
 */
function verifySign_sort($signature, $data, $rsaPublicKey, $alg=OPENSSL_ALGO_SHA256){
    $key = "-----BEGIN PUBLIC KEY-----\n".wordwrap($rsaPublicKey, 64, "\n", true)."\n-----END PUBLIC KEY-----";
    ksort($data);
    return openssl_verify(json_encode($data, JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE), base64_decode($signature), $key, $alg);
}復制代碼復制失敗復制成功

C#代碼示例

//使用匯付公鑰驗簽
public static bool verfySign(string publicKey, string signature, string content, string hashAlgorithm = "SHA256", string encoding = "UTF-8")  
{  
  
    RSACryptoServiceProvider rsa = new RSACryptoServiceProvider();  
    //導入公鑰，準備驗證簽名  
    rsa.FromPublicKeyJavaString(publicKey);  
    //返回數據驗證結果  
    byte[] Data = Encoding.GetEncoding(encoding).GetBytes(content);  
    byte[] rgbSignature = Convert.FromBase64String(signature);  
      
    return rsa.VerifyData(Data, hashAlgorithm, rgbSignature);  
}