feat: 请求头增加withSerialHeader

w7corp · Jan 6, 2025 · 6888b87 · 6888b87
1 parent 97117db
commit 6888b87
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 11 deletions.
diff --git a/docs/src/6.x/pay/examples.md b/docs/src/6.x/pay/examples.md
@@ -2,8 +2,6 @@
 
 > 👏🏻 欢迎点击本页下方 "帮助我们改善此页面！" 链接参与贡献更多的使用示例！
 
-
-
 <details>
     <summary>JSAPI 下单</summary>
 
@@ -30,7 +28,6 @@ $response = $app->getClient()->postJson("v3/pay/transactions/jsapi", [
 
 </details>
 
-
 <details>
     <summary>Native 下单</summary>
 
@@ -49,8 +46,8 @@ $response = $app->getClient()->postJson('v3/pay/transactions/native', [
 
 print_r($response->toArray(false));
 ```
-</details>
 
+</details>
 
 <details>
     <summary>查询订单（商户订单号）</summary>
@@ -66,8 +63,8 @@ $response = $app->getClient()->get("v3/pay/transactions/out-trade-no/{$outTradeN
 
 print_r($response->toArray());
 ```
-</details>
 
+</details>
 
 <details>
     <summary>查询订单（微信订单号）</summary>
@@ -82,6 +79,7 @@ $response = $app->getClient()->get("pay/transactions/id/{$transactionId}", [
 
 print_r($response->toArray());
 ```
+
 </details>
 
 <details>
@@ -118,6 +116,7 @@ Route::post('payment_notify', function () {
     return $server->serve();
 });
 ```
+
 </details>
 
 <details>
@@ -141,13 +140,13 @@ $response = $api->post('/mmpaymkttransfers/promotion/transfers', [
 
 print_r($response->toArray());
 ```
-</details>
 
+</details>
 
 <details>
    <summary>JSAPI下单（服务商）</summary>
 
-   > 官方文档：<[https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml](https://pay.weixin.qq.com/docs/partner/apis/partner-jsapi-payment/partner-jsons/partner-jsapi-prepay.html)>
+> 官方文档：<[https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml](https://pay.weixin.qq.com/docs/partner/apis/partner-jsapi-payment/partner-jsons/partner-jsapi-prepay.html)>
 
 ```php
  $response = $app->getClient()->postJson("v3/pay/partner/transactions/jsapi", [
@@ -170,6 +169,45 @@ print_r($response->toArray());
 
 print_r($response->toArray());
 ```
+
+</details>
+
+<details>
+    <summary>敏感信息加密</summary>
+
+> 官方文档：<https://pay.weixin.qq.com/doc/v3/merchant/4013053257>
+> 使用默认公钥 ID
+
+```php
+$utils = $app->getUtils();
+$response = $app->getClient()->withSerialHeader()->postJson("v3/applyment4sub/applyment/", [
+   "business_code" => "12345678",
+   'contact_info'  => [
+        'contact_name'      => $utils->createRsaEncrypt('张三'),
+        //...
+    ],
+    //...
+]);
+
+print_r($response->toArray());
+```
+
+或指定公钥 ID
+
+```php
+$utils = $app->getUtils();
+$response = $app->getClient()->withSerialHeader("PUB_KEY_ID_123456")->postJson("v3/applyment4sub/applyment/", [
+   "business_code" => "12345678",
+   'contact_info'  => [
+        'contact_name'      => $utils->createRsaEncrypt("张三","PUB_KEY_ID_123456"),
+        //...
+    ],
+    //...
+]);
+
+print_r($response->toArray());
+```
+
 </details>
 
 <!--

diff --git a/src/Pay/Client.php b/src/Pay/Client.php
@@ -166,6 +166,18 @@ protected function isV3Request(string $url): bool
         return false;
     }
 
+    public function withSerialHeader(?string $serial = null)
+    {
+        $platformCerts = $this->merchant->getPlatformCerts();
+        if (empty($platformCerts)) {
+            throw new InvalidConfigException('Missing platform certificate.');
+        }
+
+        $serial = $serial ?? array_key_first($platformCerts);
+        $this->withHeader('Wechatpay-Serial', $serial);
+        return $this;
+    }
+
     /**
      * @param  array<int, mixed>  $arguments
      *
@@ -242,6 +254,17 @@ public static function createMockClient(MockHttpClient $mockHttpClient): HttpCli
             Mockery::mock(PublicKey::class),
             'mock-v3-key',
             'mock-v2-key',
+            [
+                'PUB_KEY_ID_MOCK' => '-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlReZ1YnfAohRIfUqIeyP
+aO0PlkMw1RLPdZbEZmldbGrIrOh/0XqSzNZ+mtB6H0eB7TSaoGFtdp/AWy3tb67m
+1T62OrEhz6bnSKMcZkYVmODyxZvcwsCZ3zqCaFo7FrGmh1o9M0/Xfa5SOX4jVGni
+3iM7r7YD/NiW2RCYDtjMoLTmVgrzv45Mzu2XpJqtNbUJIRRhVSnjsAZRC6spWH+b
+QpYIkVd4qmYE0qdpIQBMYOV1w7v1pYn6Z5QdKG4keemADTn4QaZZHrryTcHNYVsZ
+2OZ3aybrevSV3wDGnYGk2nt2xtkdfaNfFn4dGW+p4an5M4fRK+CnYpeTgI6POABk
+pwIDAQAB
+-----END PUBLIC KEY-----'
+            ]
         );
 
         return Mockery::mock(static::class, [$mockMerchant, $mockHttpClient])

diff --git a/tests/Pay/ClientTest.php b/tests/Pay/ClientTest.php
@@ -155,4 +155,16 @@ public function test_v3_upload_media()
 
         $this->assertSame($response, $client->uploadMedia('/v3/merchant/media/upload', './tests/fixtures/files/image.jpg'));
     }
+
+    public function test_v3_with_serial_header()
+    {
+        $client = Client::mock();
+        $client->shouldReceive('createSignature')->never();
+        $client->shouldReceive('attachLegacySignature')->with([
+            'foo' => 'bar',
+        ])->andReturn(['foo' => 'bar', 'sign' => 'mock-signature']);
+
+        $client->withSerialHeader()->post('certificates', ['body' => Xml::build(['foo' => 'bar'])]);
+        $this->assertSame('Wechatpay-Serial: PUB_KEY_ID_MOCK', $client->getRequestOptions()['headers'][0]);
+    }
 }
diff --git a/tests/Pay/UtilsTest.php b/tests/Pay/UtilsTest.php
@@ -69,7 +69,7 @@ public function test_create_rsa_encrypt()
             secretKey: 'v3SecretKey',
             v2SecretKey: 'v2SecretKey',
             platformCerts: [
-                'PUB_KEY_ID_123456' => '-----BEGIN PUBLIC KEY-----
+                'PUB_KEY_ID_MOCK' => '-----BEGIN PUBLIC KEY-----
 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlReZ1YnfAohRIfUqIeyP
 aO0PlkMw1RLPdZbEZmldbGrIrOh/0XqSzNZ+mtB6H0eB7TSaoGFtdp/AWy3tb67m
 1T62OrEhz6bnSKMcZkYVmODyxZvcwsCZ3zqCaFo7FrGmh1o9M0/Xfa5SOX4jVGni
@@ -81,12 +81,14 @@ public function test_create_rsa_encrypt()
             ]
         );
          $utils = new Utils(merchant: $merchant);
-         $this->assertIsString($utils->createRsaEncrypt('mock-plaintext', 'PUB_KEY_ID_123456'));
+         $this->assertIsString($utils->createRsaEncrypt('mock-plaintext', 'PUB_KEY_ID_MOCK'));
          $this->assertIsString($utils->createRsaEncrypt('mock-plaintext'));
+
          $this->expectException(InvalidConfigException::class);
-         $utils->createRsaEncrypt('mock-plaintext', 'PUB_KEY_ID_456789');
+         $utils->createRsaEncrypt('mock-plaintext', 'PUB_KEY_ID_OTHER');
+
          $this->expectException(EncryptionFailureException::class);
-         $utils->createRsaEncrypt('', 'PUB_KEY_ID_123456');
+         $utils->createRsaEncrypt('', 'PUB_KEY_ID_MOCK');
 
     }
 }