com.qq.weixin.mp.aes

类 WXBizMsgCrypt

java.lang.Object

com.qq.weixin.mp.aes.WXBizMsgCrypt

public class WXBizMsgCrypt
extends Object

提供接收和推送给企业微信消息的加解密接口(UTF8编码的字符串).

1. 第三方回复加密消息给企业微信
2. 第三方收到企业微信发送的消息，验证消息的安全性，并对消息进行解密。

说明：异常java.security.InvalidKeyException:illegal Key Size的解决方案

1. 在官方网站下载JCE无限制权限策略文件（JDK7的下载地址： http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html
2. 下载后解压，可以看到local_policy.jar和US_export_policy.jar以及readme.txt
3. 如果安装了JRE，将两个jar文件放到%JRE_HOME%\lib\security目录下覆盖原来的文件
4. 如果安装了JDK，将两个jar文件放到%JDK_HOME%\jre\lib\security目录下覆盖原来文件

字段概要

字段

限定符和类型	字段和说明
(专用程序包) byte[]	aesKey
(专用程序包) org.apache.commons.codec.binary.Base64	base64
(专用程序包) static Charset	CHARSET
(专用程序包) String	receiveid
(专用程序包) String	token

构造器概要

构造器

构造器和说明
WXBizMsgCrypt(String token, String encodingAesKey, String receiveId) 构造函数

方法概要

限定符和类型	方法和说明
(专用程序包) String	decrypt(String text) 对密文进行解密.
String	DecryptMsg(String msgSignature, String timeStamp, String nonce, String postData) 检验消息的真实性，并且获取解密后的明文.
(专用程序包) String	encrypt(String randomStr, String text) 对明文进行加密.
String	EncryptMsg(String replyMsg, String timeStamp, String nonce) 将企业微信回复用户的消息加密打包.
(专用程序包) byte[]	getNetworkBytesOrder(int sourceNumber)
(专用程序包) String	getRandomStr()
(专用程序包) int	recoverNetworkBytesOrder(byte[] orderBytes)
String	VerifyURL(String msgSignature, String timeStamp, String nonce, String echoStr) 验证URL

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

CHARSET

static Charset CHARSET

base64

org.apache.commons.codec.binary.Base64 base64

aesKey

byte[] aesKey

token

String token

receiveid

String receiveid

构造器详细资料

WXBizMsgCrypt

public WXBizMsgCrypt(String token,
                     String encodingAesKey,
                     String receiveId)
              throws AesException

构造函数

参数:

token - 企业微信后台，开发者设置的token

encodingAesKey - 企业微信后台，开发者设置的EncodingAESKey

receiveId, - 不同场景含义不同，详见文档

抛出:

AesException - 执行失败，请查看该异常的错误码和具体的错误信息

方法详细资料

getNetworkBytesOrder

byte[] getNetworkBytesOrder(int sourceNumber)

recoverNetworkBytesOrder

int recoverNetworkBytesOrder(byte[] orderBytes)

getRandomStr

String getRandomStr()

encrypt

String encrypt(String randomStr,
               String text)
        throws AesException

对明文进行加密.

参数:

text - 需要加密的明文

返回:

加密后base64编码的字符串

抛出:

AesException - aes加密失败

decrypt

String decrypt(String text)
        throws AesException

对密文进行解密.

参数:

text - 需要解密的密文

返回:

解密得到的明文

抛出:

AesException - aes解密失败

EncryptMsg

public String EncryptMsg(String replyMsg,
                         String timeStamp,
                         String nonce)
                  throws AesException

将企业微信回复用户的消息加密打包.

1. 对要发送的消息进行AES-CBC加密
2. 生成安全签名
3. 将消息密文和安全签名打包成xml格式

参数:

replyMsg - 企业微信待回复用户的消息，xml格式的字符串

timeStamp - 时间戳，可以自己生成，也可以用URL参数的timestamp

nonce - 随机串，可以自己生成，也可以用URL参数的nonce

返回:

加密后的可以直接回复用户的密文，包括msg_signature, timestamp, nonce, encrypt的xml格式的字符串

抛出:

AesException - 执行失败，请查看该异常的错误码和具体的错误信息

DecryptMsg

public String DecryptMsg(String msgSignature,
                         String timeStamp,
                         String nonce,
                         String postData)
                  throws AesException

检验消息的真实性，并且获取解密后的明文.

1. 利用收到的密文生成安全签名，进行签名验证
2. 若验证通过，则提取xml中的加密消息
3. 对消息进行解密

参数:

msgSignature - 签名串，对应URL参数的msg_signature

timeStamp - 时间戳，对应URL参数的timestamp

nonce - 随机串，对应URL参数的nonce

postData - 密文，对应POST请求的数据

返回:

解密后的原文

抛出:

AesException - 执行失败，请查看该异常的错误码和具体的错误信息

VerifyURL

public String VerifyURL(String msgSignature,
                        String timeStamp,
                        String nonce,
                        String echoStr)
                 throws AesException

验证URL

参数:

msgSignature - 签名串，对应URL参数的msg_signature

timeStamp - 时间戳，对应URL参数的timestamp

nonce - 随机串，对应URL参数的nonce

echoStr - 随机串，对应URL参数的echostr

返回:

解密之后的echostr

抛出:

AesException - 执行失败，请查看该异常的错误码和具体的错误信息