微信公众号消息加密官方示例代码修正版

2020-1-8 zhulinan php开发

公众号消息加解密是公众平台为了进一步加强公众号安全保障，提供的新机制。开发者需注意，公众账号主动调用API的情况将不受影响。只有被动回复用户的消息时，才需要进行消息加解密。消息加解密的具体修改包括：

1. 新增消息体签名验证，用于公众平台和公众账号验证消息体的正确性
2. 针对推送给微信公众账号的普通消息和事件消息，以及推送给设备公众账号的设备消息进行加密
3. 公众账号对密文消息的回复也要求加密

... ...

官方原文

官方提供的示例代码包括C++、php、Java、Python和C#五种语言，下载地址为：
https://wximg.gtimg.com/shake_tv/mpwiki/cryptoDemo.zip

遗憾的是其php版在高版本php环境下无法运行，经过网查、测试、修改，现整理代码如下：

1. demo.php文件，已修改：
<?php include_once "wxBizMsgCrypt.php"; // 第三方发送消息给公众平台 $encodingAesKey = "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFG"; $token = "pamtest"; $timeStamp = "1409304348"; $nonce = "xxxxxx"; $appId = "wxb11529c136998cb6"; $text = "<xml><ToUserName><![CDATA[oia2Tj我是中文jewbmiOUlr6X-1crbLOvLw]]></ToUserName><FromUserName><![CDATA[gh_7f083739789a]]></FromUserName><CreateTime>1407743423</CreateTime><MsgType><![CDATA[video]]></MsgType><Video><MediaId><![CDATA[eYJ1MbwPRJtOvIEabaxHs7TX2D-HV71s79GUxqdUkjm6Gs2Ed1KF3ulAOA9H1xG0]]></MediaId><Title><![CDATA[testCallBackReplyVideo]]></Title><Description><![CDATA[testCallBackReplyVideo]]></Description></Video></xml>"; $pc = new WXBizMsgCrypt($token, $encodingAesKey, $appId); $encryptMsg = ''; $errCode = $pc->EncryptMsg($text, $timeStamp, $nonce, $encryptMsg); if ($errCode == 0) { print("加密后: " . $encryptMsg . "\n"); } else { print($errCode . "\n"); } $xml_tree = new DOMDocument(); $xml_tree->loadXML($encryptMsg); $array_e = $xml_tree->getElementsByTagName('Encrypt'); $array_s = $xml_tree->getElementsByTagName('MsgSignature'); $encrypt = $array_e->item(0)->nodeValue; $msg_sign = $array_s->item(0)->nodeValue; $format = "<xml><ToUserName><![CDATA[toUser]]></ToUserName><Encrypt><![CDATA[%s]]></Encrypt></xml>"; $from_xml = sprintf($format, $encrypt); // 第三方收到公众号平台发送的消息 $msg = ''; $errCode = $pc->DecryptMsg($msg_sign, $timeStamp, $nonce, $from_xml, $msg); if ($errCode == 0) { print("解密后: " . $msg . "\n"); } else { print($errCode . "\n"); }

2. errorCode.php文件，未修改：
<?php /** * error code 说明. * <ul> * <li>-40001: 签名验证错误</li> * <li>-40002: xml解析失败</li> * <li>-40003: sha加密生成签名失败</li> * <li>-40004: encodingAesKey 非法</li> * <li>-40005: appid 校验错误</li> * <li>-40006: aes 加密失败</li> * <li>-40007: aes 解密失败</li> * <li>-40008: 解密后得到的buffer非法</li> * <li>-40009: base64加密失败</li> * <li>-40010: base64解密失败</li> * <li>-40011: 生成xml失败</li> * </ul> */ class ErrorCode { public static $OK = 0; public static $ValidateSignatureError = -40001; public static $ParseXmlError = -40002; public static $ComputeSignatureError = -40003; public static $IllegalAesKey = -40004; public static $ValidateAppidError = -40005; public static $EncryptAESError = -40006; public static $DecryptAESError = -40007; public static $IllegalBuffer = -40008; public static $EncodeBase64Error = -40009; public static $DecodeBase64Error = -40010; public static $GenReturnXmlError = -40011; } ?>

3. pkcs7Encoder.php文件，已修改：
<?php include_once "errorCode.php"; /** * PKCS7Encoder class * * 提供基于PKCS7算法的加解密接口. */ class PKCS7Encoder { public static $block_size = 32; /** * 对需要加密的明文进行填充补位 * @param $text 需要进行填充补位操作的明文 * @return 补齐明文字符串 */ function encode($text) { $block_size = PKCS7Encoder::$block_size; $text_length = strlen($text); //计算需要填充的位数 $amount_to_pad = PKCS7Encoder::$block_size - ($text_length % PKCS7Encoder::$block_size); if ($amount_to_pad == 0) { $amount_to_pad = PKCS7Encoder::block_size; } //获得补位所用的字符 $pad_chr = chr($amount_to_pad); $tmp = ""; for ($index = 0; $index < $amount_to_pad; $index++) { $tmp .= $pad_chr; } return $text . $tmp; } /** * 对解密后的明文进行补位删除 * @param decrypted 解密后的明文 * @return 删除填充补位后的明文 */ function decode($text) { $pad = ord(substr($text, -1)); if ($pad < 1 || $pad > PKCS7Encoder::$block_size) { $pad = 0; } return substr($text, 0, (strlen($text) - $pad)); } } /** * Prpcrypt class * * 提供接收和推送给公众平台消息的加解密接口. */ class Prpcrypt { public $key; function __construct($k) { $this->key = base64_decode($k . "="); } /** * 对明文进行加密 * @param string $text 需要加密的明文 * @return string 加密后的密文 */ public function encrypt($text, $appid) { try { $random = $this->getRandomStr(); $text = $random . pack("N", strlen($text)) . $text . $appid; $iv = substr($this->key, 0, 16); $pkc_encoder = new PKCS7Encoder; $text = $pkc_encoder->encode($text); $encrypted = openssl_encrypt($text, 'AES-256-CBC', $this->key, OPENSSL_RAW_DATA|OPENSSL_ZERO_PADDING, $iv); //print(base64_encode($encrypted)); //使用BASE64对加密后的字符串进行编码 return array(ErrorCode::$OK, base64_encode($encrypted)); } catch (Exception $e) { print $e; return array(ErrorCode::$EncryptAESError, null); } } /** * 对密文进行解密 * @param string $encrypted 需要解密的密文 * @return string 解密得到的明文 */ public function decrypt($encrypted, $appid) { try { //解密 $ciphertext_dec = base64_decode($encrypted); $iv = substr($this->key, 0, 16); $decrypted = openssl_decrypt($ciphertext_dec, 'AES-256-CBC', $this->key, OPENSSL_RAW_DATA|OPENSSL_ZERO_PADDING, $iv); } catch (Exception $e) { return array(ErrorCode::$DecryptAESError, null); } try { //去除补位字符 $pkc_encoder = new PKCS7Encoder; $result = $pkc_encoder->decode($decrypted); //去除16位随机字符串,网络字节序和AppId if (strlen($result) < 16) return ""; $content = substr($result, 16, strlen($result)); $len_list = unpack("N", substr($content, 0, 4)); $xml_len = $len_list[1]; $xml_content = substr($content, 4, $xml_len); $from_corpid = substr($content, $xml_len + 4); } catch (Exception $e) { //print $e; return array(ErrorCode::$IllegalBuffer, null); } if ($from_corpid != $appid) return array(ErrorCode::$ValidateCorpidError, null); return array(0, $xml_content); } /** * 随机生成16位字符串 * @return string 生成的字符串 */ function getRandomStr() { $str = ""; $str_pol = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyz"; $max = strlen($str_pol) - 1; for ($i = 0; $i < 16; $i++) { $str .= $str_pol[mt_rand(0, $max)]; } return $str; } } ?>

4. sha1.php文件，未修改：
<?php include_once "errorCode.php"; /** * SHA1 class * * 计算公众平台的消息签名接口. */ class SHA1 { /** * 用SHA1算法生成安全签名 * @param string $token 票据 * @param string $timestamp 时间戳 * @param string $nonce 随机字符串 * @param string $encrypt 密文消息 */ public function getSHA1($token, $timestamp, $nonce, $encrypt_msg) { //排序 try { $array = array($encrypt_msg, $token, $timestamp, $nonce); sort($array, SORT_STRING); $str = implode($array); return array(ErrorCode::$OK, sha1($str)); } catch (Exception $e) { //print $e . "\n"; return array(ErrorCode::$ComputeSignatureError, null); } } } ?>

5. wxBizMsgCrypt.php文件，已修改：
<?php /** * 对公众平台发送给公众账号的消息加解密示例代码. * * @copyright Copyright (c) 2020 lijinyun.cn */ include_once "sha1.php"; include_once "xmlparse.php"; include_once "pkcs7Encoder.php"; include_once "errorCode.php"; /** * 1.第三方回复加密消息给公众平台； * 2.第三方收到公众平台发送的消息，验证消息的安全性，并对消息进行解密。 */ class WXBizMsgCrypt { private $token; private $encodingAesKey; private $appId; /** * 构造函数 * @param $token string 公众平台上，开发者设置的token * @param $encodingAesKey string 公众平台上，开发者设置的EncodingAESKey * @param $appId string 公众平台的appId */ function __construct($token, $encodingAesKey, $appId) { $this->token = $token; $this->encodingAesKey = $encodingAesKey; $this->appId = $appId; } /** * 将公众平台回复用户的消息加密打包. * <ol> * <li>对要发送的消息进行AES-CBC加密</li> * <li>生成安全签名</li> * <li>将消息密文和安全签名打包成xml格式</li> * </ol> * * @param $replyMsg string 公众平台待回复用户的消息，xml格式的字符串 * @param $timeStamp string 时间戳，可以自己生成，也可以用URL参数的timestamp * @param $nonce string 随机串，可以自己生成，也可以用URL参数的nonce * @param &$encryptMsg string 加密后的可以直接回复用户的密文，包括msg_signature, timestamp, nonce, encrypt的xml格式的字符串, * 当return返回0时有效 * * @return int 成功0，失败返回对应的错误码 */ public function EncryptMsg($sReplyMsg, $sTimeStamp, $sNonce, &$sEncryptMsg) { $pc = new Prpcrypt($this->encodingAesKey); //加密 $array = $pc->encrypt($sReplyMsg, $this->appId); $ret = $array[0]; if ($ret != 0) { return $ret; } if ($sTimeStamp == null) { $sTimeStamp = time(); } $encrypt = $array[1]; //生成安全签名 $sha1 = new SHA1; $array = $sha1->getSHA1($this->token, $sTimeStamp, $sNonce, $encrypt); $ret = $array[0]; if ($ret != 0) { return $ret; } $signature = $array[1]; //生成发送的xml $xmlparse = new XMLParse; $sEncryptMsg = $xmlparse->generate($encrypt, $signature, $sTimeStamp, $sNonce); return ErrorCode::$OK; } /** * 检验消息的真实性，并且获取解密后的明文. * <ol> * <li>利用收到的密文生成安全签名，进行签名验证</li> * <li>若验证通过，则提取xml中的加密消息</li> * <li>对消息进行解密</li> * </ol> * * @param $msgSignature string 签名串，对应URL参数的msg_signature * @param $timestamp string 时间戳 对应URL参数的timestamp * @param $nonce string 随机串，对应URL参数的nonce * @param $postData string 密文，对应POST请求的数据 * @param &$msg string 解密后的原文，当return返回0时有效 * * @return int 成功0，失败返回对应的错误码 */ public function DecryptMsg($sMsgSignature, $sTimeStamp = null, $sNonce, $sPostData, &$sMsg) { if (strlen($this->encodingAesKey) != 43) { return ErrorCode::$IllegalAesKey; } $pc = new Prpcrypt($this->encodingAesKey); //提取密文 $xmlparse = new XMLParse; $array = $xmlparse->extract($sPostData); $ret = $array[0]; if ($ret != 0) { return $ret; } if ($sTimeStamp == null) { $sTimeStamp = time(); } $encrypt = $array[1]; $touser_name = $array[2]; //验证安全签名 $sha1 = new SHA1; $array = $sha1->getSHA1($this->token, $sTimeStamp, $sNonce, $encrypt); $ret = $array[0]; if ($ret != 0) { return $ret; } $signature = $array[1]; if ($signature != $sMsgSignature) { return ErrorCode::$ValidateSignatureError; } $result = $pc->decrypt($encrypt, $this->appId); if ($result[0] != 0) { return $result[0]; } $sMsg = $result[1]; return ErrorCode::$OK; } }

6. xmlparse.php文件，未修改：
<?php include_once "errorCode.php"; /** * XMLParse class * * 提供提取消息格式中的密文及生成回复消息格式的接口. */ class XMLParse { /** * 提取出xml数据包中的加密消息 * @param string $xmltext 待提取的xml字符串 * @return string 提取出的加密消息字符串 */ public function extract($xmltext) { try { $xml = new DOMDocument(); $xml->loadXML($xmltext); $array_e = $xml->getElementsByTagName('Encrypt'); $array_a = $xml->getElementsByTagName('ToUserName'); $encrypt = $array_e->item(0)->nodeValue; $tousername = $array_a->item(0)->nodeValue; return array(0, $encrypt, $tousername); } catch (Exception $e) { //print $e . "\n"; return array(ErrorCode::$ParseXmlError, null, null); } } /** * 生成xml消息 * @param string $encrypt 加密后的消息密文 * @param string $signature 安全签名 * @param string $timestamp 时间戳 * @param string $nonce 随机字符串 */ public function generate($encrypt, $signature, $timestamp, $nonce) { $format = "<xml> <Encrypt><![CDATA[%s]]></Encrypt> <MsgSignature><![CDATA[%s]]></MsgSignature> <TimeStamp>%s</TimeStamp> <Nonce><![CDATA[%s]]></Nonce> </xml>"; return sprintf($format, $encrypt, $signature, $timestamp, $nonce); } } ?>

测试环境：
其一：Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.11
其二：Apache/2.4.6 (CentOS) PHP/5.4.16

 

网站备案号：京ICP备11043289号-1 北京市公安局网络备案 海1101084571

版权所有 北京育灵童科技发展有限公司 Copyright © 2002-2024 www.elight.cn, All Rights Reserved