Skip to content

Latest commit

 

History

History
134 lines (104 loc) · 5.01 KB

README.md

File metadata and controls

134 lines (104 loc) · 5.01 KB
Raw

wechatpay-java-shangmi 国密算法扩展

商密 (ShangMi)，俗称国密，是一组由中国国家密码局标准化的密码学算法。微信支付 APIv3 在支持 RSA/AES 等算法的基础上，支持了国密算法。

wechatpay-java-shangmi 是 wechatpay-java 的一个国密扩展。它基于 腾讯Kona国密套件，帮助开发者完成国密的签名、验签、加解密等工作。

前置条件

  • 了解 wechatpay-java
  • 开通微信支付国密能力，申请国密证书，并下载国密微信支付平台证书。注：微信支付暂时没有开放国密的使用，请有需求的商户联系微信支付技术支持，获取国密接入文档。

安装

最新版本已经在 Maven Central 发布。

Gradle

在你的 build.gradle 文件中加入如下的依赖

implementation 'com.github.wechatpay-apiv3:wechatpay-java:0.2.2'
implementation 'com.github.wechatpay-apiv3:wechatpay-java-shangmi:0.2.2'

Maven

加入以下依赖

<dependency>
  <groupId>com.github.wechatpay-apiv3</groupId>
  <artifactId>wechatpay-java</artifactId>
  <version>0.2.2</version>
</dependency>
<dependency>
  <groupId>com.github.wechatpay-apiv3</groupId>
  <artifactId>wechatpay-java-shangmi</artifactId>
  <version>0.2.2</version>
</dependency>

使用国密 SDK

使用 SMConfig 替代 RSAConfig 初始化具体的业务服务，再调用服务提供的业务接口即可。国密的签名、验签会注入请求的各个环节。

package com.wechat.pay.java.service;

import com.wechat.pay.java.core.Config;
import com.wechat.pay.java.shangmi.SMConfig;
import com.wechat.pay.java.service.payments.jsapi.JsapiService;
import com.wechat.pay.java.service.payments.jsapi.model.QueryOrderByIdRequest;
import com.wechat.pay.java.service.payments.model.Transaction;


public class QuickStart {

  /** 商户号 */
  public static String merchantId = "";
  /** 国密的商户API私钥路径 */
  public static String privateKeyPath = "";
  /** 国密的商户API证书序列号 */
  public static String merchantSerialNumber = "";
  /** 国密的微信支付平台证书路径 */
  public static String wechatPayCertificatePath = "";
  /** 微信支付 APIv3 密钥 */
  public static String apiV3Key = "";

  public static void main(String[] args) {
    Config config =
        new SMConfig.Builder()
            .merchantId(merchantId)
            .privateKeyFromPath(privateKeyPath)
            .merchantSerialNumber(merchantSerialNumber)
            .addWechatPayCertificateFromPath(wechatPayCertificatePath)
            .build();
    JsapiService service = new JsapiService.Builder().config(config).build();
    QueryOrderByIdRequest request = new QueryOrderByIdRequest();
    // 设置业务参数
    request.setMchid("****");
    request.setTransactionId("420***");
    Transaction transaction = service.queryOrderById(request);
  }
}

使用国密发送 HTTP 请求

如果 SDK 未支持你需要的接口，你可以使用 SMConfig + DefaultHttpClientBuilder 得到一个 HttpClient 发送 HTTP 请求，它会自动生成签名和验证签名。

SMConfig config = new SMConfig.Builder()
        .merchantId(merchantId)
        .merchantSerialNumber(merchantSerialNo)
        .privateKey(privateKey)
        .addWechatPayCertificate(wechatPayCertificate).build();

HttpClient client = new DefaultHttpClientBuilder()
        .credential(config.createCredential())
        .validator(config.createValidator())
        .build();

HttpHeaders headers = new HttpHeaders();
headers.addHeader("Accept", "application/json");

// 你需要为应答编写对应的model
HttpResponse<DownloadCertificateResponse> response = client.get(
        headers,
        "https://api.mch.weixin.qq.com/v3/certificates?algorithm_type=SM2",
        DownloadCertificateResponse.class);

System.out.println(response.getServiceResponse());

如何下载国密证书

调用 CertificateService.downloadCertificate()，并指定国密适用的参数：

  • requestUrl，指定证书类型 algorithm_type=SM2。
  • aeadCipher，使用国密消息认证解密器 AeadSM4Cipher
  • certificateGenerator，使用支持国密证书的证书生成函数 SMPemUtil::loadX509FromString
CertificateService service = new CertificateService.Builder().config(config).build();
AeadCipher aeadCipher = new AeadSM4Cipher(apiV3Key.getBytes(StandardCharsets.UTF_8));
List<X509Certificate> certificates =
    service.downloadCertificate(
        "https://api.mch.weixin.qq.com/v3/certificates?algorithm_type=SM2",
        aeadCipher,
        SMPemUtil::loadX509FromString);

常见问题

请求时能同时使用国密和 RSA 吗？

SDK 支持创建多个 service，请使用 RSAConfig 和 SMConfig 分别构造对应的 service。 在发送请求时，再根据业务逻辑选择你希望使用的 service。