Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: 支持证书签名模式 #132

Merged
merged 2 commits into from
Jun 4, 2024
Merged

feat: 支持证书签名模式 #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9ad27b
feat: 支持证书签名模式
fengmk2 Jun 4, 2024
3c3b644
feat: 增加 requestTimeout
fengmk2 Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ const alipaySdk = new AlipaySdk({
// 设置应用 ID
appId: 'your-APPID',
// 设置应用私钥
privateKey: fs.readFileSync('private-key.pem', 'ascii'),
privateKey: fs.readFileSync('/path/to/private-key.pem', 'ascii'),
// 设置支付宝公钥
alipayPublicKey: fs.readFileSync('alipay-public-key.pem', 'ascii'),
alipayPublicKey: fs.readFileSync('/path/to/alipay-public-key.pem', 'ascii'),
// 密钥类型，请与生成的密钥格式保持一致，参考平台配置一节
// keyType: 'PKCS1',
// 设置网关地址，默认是 https://openapi.alipay.com
Expand All @@ -73,11 +73,11 @@ import { AlipaySdk } from 'alipay-sdk';

const alipaySdk = new AlipaySdk({
appId: '2016123456789012',
privateKey: fs.readFileSync('private-key.pem', 'ascii'),
privateKey: fs.readFileSync('/path/to/private-key.pem', 'ascii'),
// 传入支付宝根证书、支付宝公钥证书和应用公钥证书。
alipayRootCertPath: path.join(__dirname, 'alipayRootCert.crt'),
alipayPublicCertPath: path.join(__dirname, 'alipayCertPublicKey_RSA2.crt'),
appCertPath: path.join(__dirname, 'appCertPublicKey.crt'),
alipayRootCertPath: '/path/to/alipayRootCert.crt',
alipayPublicCertPath: '/path/to/alipayCertPublicKey_RSA2.crt',
appCertPath: '/path/to/appCertPublicKey.crt',
});
```

Expand Down Expand Up @@ -388,6 +388,7 @@ curl 方式调用支付宝 [API v3 协议](https://opendocs.alipay.com/open-v3/0
| options.requestId | `string` | 调用方的 requestId，不填会默认生成 uuid v4 | 否 |
| options.needEncrypt | `boolean` | 自动 AES 加解密，默认值是 `false` | 否 |
| options.appAuthToken | `string` | [应用授权令牌](https://opendocs.alipay.com/isv/10467/xldcyq?pathHash=abce531a)，代商家调用支付宝开放接口必填 | 否 |
| options.requestTimeout | `number` | 请求超时时间，默认使用 `config.timeout` | 否 |

#### `AlipayCommonResult<T>`

Expand Down
20 changes: 16 additions & 4 deletions src/alipay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@
* 应用授权令牌，代商家调用支付宝开放接口必填
*/
appAuthToken?: string;
/** 请求超时时间，默认使用 config.timeout */
requestTimeout?: number;
}

/**
Expand Down Expand Up @@ -324,7 +326,7 @@
const requestOptions: RequestOptions = {
method: httpMethod,
dataType: dataType === 'stream' ? 'stream' : 'text',
timeout: this.config.timeout,
timeout: options?.requestTimeout ?? this.config.timeout,
};
if (dataType === 'stream') {
// 使用 HTTP/2 请求才支持流式响应
Expand Down Expand Up @@ -403,7 +405,20 @@
requestOptions.content = httpRequestBody;
}
}
if (this.config.alipayRootCertSn) {
requestOptions.headers['alipay-root-cert-sn'] = this.config.alipayRootCertSn;
}

Check warning on line 410 in src/alipay.ts

View check run for this annotation

Codecov / codecov/patch

src/alipay.ts#L409-L410 

Added lines #L409 - L410 were not covered by tests
// 签名规则 https://opendocs.alipay.com/open-v3/054q58?pathHash=474929ac#%E6%99%AE%E9%80%9A%E8%AF%B7%E6%B1%82
// authString 拼接格式：
//
// ```txt
// app_id=${app_id},app_cert_sn=${app_cert_sn},nonce=${nonce},timestamp=${timestamp}
// ```
let authString = `app_id=${this.config.appId}`;
if (this.config.appCertSn) {
authString += `,app_cert_sn=${this.config.appCertSn}`;
}

Check warning on line 420 in src/alipay.ts

View check run for this annotation

Codecov / codecov/patch

src/alipay.ts#L419-L420 

Added lines #L419 - L420 were not covered by tests
authString += `,nonce=${randomUUID()},timestamp=${Date.now()}`;
// 签名字符串拼接格式：
//
// ```txt
Expand All @@ -413,9 +428,6 @@
// ${httpRequestBody}\n
// ${appAuthToken}\n
// ```
//
// TODO: 需要支持 app_cert_sn
const authString = `app_id=${this.config.appId},nonce=${randomUUID()},timestamp=${Date.now()}`;
let signString = `${authString}\n${httpMethod}\n${httpRequestUrl}\n${httpRequestBody}\n`;
if (options?.appAuthToken) {
requestOptions.headers['alipay-app-auth-token'] = options.appAuthToken;
Expand Down
6 changes: 3 additions & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ export interface AlipaySdkConfig {
appCertPath?: string;
/** 应用公钥证书文件内容 */
appCertContent?: string | Buffer;
/** 应用公钥证书sn */
/** 应用公钥证书sn，不需要手动设置，会根据 appCertPath 自动计算出来 */
appCertSn?: string;
/** 支付宝根证书文件路径 */
alipayRootCertPath?: string;
/** 支付宝根证书文件内容 */
alipayRootCertContent?: string | Buffer;
/** 支付宝根证书sn */
/** 支付宝根证书sn，不需要手动设置，会根据 alipayRootCertPath 自动计算出来 */
alipayRootCertSn?: string;
/** 支付宝公钥证书文件路径 */
alipayPublicCertPath?: string;
/** 支付宝公钥证书文件内容 */
alipayPublicCertContent?: string | Buffer;
/** 支付宝公钥证书sn */
/** 支付宝公钥证书sn，不需要手动设置，会根据 alipayPublicCertPath 自动计算出来 */
alipayCertSn?: string;
/** AES 密钥，调用 AES 加解密相关接口时需要 */
encryptKey?: string;
Expand Down
129 changes: 128 additions & 1 deletion test/alipay.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
import {
AlipayFormData, AlipayFormStream, AlipayRequestError, AlipaySdk, AlipaySdkConfig,
} from '../src/index.js';
import { aesDecryptText } from '../src/util.js';

const privateKey = readFixturesFile('app-private-key.pem', 'ascii');
const alipayPublicKey = readFixturesFile('alipay-public-key.pem', 'ascii');
Expand Down Expand Up @@ -135,7 +136,10 @@ describe('test/alipay.test.ts', () => {

const uploadResult = await sdkStable.curl<{
file_id: string;
}>('POST', '/v3/alipay/open/file/upload', { form });
}>('POST', '/v3/alipay/open/file/upload', {
form,
requestTimeout: 10000,
});
// console.log(uploadResult);
assert(uploadResult.data.file_id);
assert.equal(uploadResult.responseHttpStatus, 200);
Expand Down Expand Up @@ -406,6 +410,129 @@ describe('test/alipay.test.ts', () => {
return true;
});
});

it('转账接口强制要求证书签名调用', async () => {
// https://opendocs.alipay.com/open-v3/08e7ef12_alipay.fund.trans.uni.transfer?scene=ca56bca529e64125a2786703c6192d41&pathHash=52e2898b
await assert.rejects(async () => {
await sdkStable.curl('POST', '/v3/alipay/fund/trans/uni/transfer', {
body: {
order_title: '201905代发',
biz_scene: 'DIRECT_TRANSFER',
sign_data: {
ori_sign: 'EqHFP0z4a9iaQ1ep==',
partner_id: '签名被授权方支付宝账号ID',
ori_app_id: '2021000185629012',
ori_out_biz_no: '商户订单号',
ori_sign_type: 'RSA2',
ori_char_set: 'UTF-8',
},
business_params: '{"payer_show_name_use_alias":"true"}',
remark: '201905代发',
out_biz_no: '201806300001',
trans_amount: '23.00',
product_code: 'TRANS_ACCOUNT_NO_PWD',
payee_info: {
identity: '2088123412341234',
name: '黄龙国际有限公司',
identity_type: 'ALIPAY_USER_ID',
},
original_order_id: '20190620110075000006640000063056',
},
});
}, (err: any) => {
assert.equal(err.code, 'INVALID_PARAMETER');
assert.match(err.message, /参数有误未开启验签，不允许传入sign_data签名参数/);
return true;
});
});
});

describe('curl() + 证书签名模式', () => {
if (!process.env.TEST_ALIPAY_APP_ENCRYPT_KEY_ENCRYPTION) {
return;
}
// 测试密钥维护找@苏千，https://u.alipay.cn/_25tzRNHiQZU
const encryptKey = process.env.TEST_ALIPAY_APP_ENCRYPT_KEY_ENCRYPTION;
const sdk = new AlipaySdk({
appId: process.env.TEST_ALIPAY_APP_ID_ENCRYPTION!,
privateKey: process.env.TEST_ALIPAY_APP_PRIVATE_KEY_ENCRYPTION!,
timeout: 10000,
encryptKey,
appCertContent:
aesDecryptText(readFixturesFile('test_appCertPublicKey_aesEncryptText.crt'), encryptKey),
alipayRootCertContent:
aesDecryptText(readFixturesFile('test_alipayRootCert_aesEncryptText.crt'), encryptKey),
alipayPublicCertContent:
aesDecryptText(readFixturesFile('test_alipayCertPublicKey_RSA2_aesEncryptText.crt'), encryptKey),
});

it.skip('POST 文件上传，使用 AlipayFormStream with body', async () => {
// https://opendocs.alipay.com/open-v3/5aa91070_alipay.open.file.upload?scene=common&pathHash=c8e11ccc
const filePath = getFixturesFile('demo.jpg');
const form = new AlipayFormStream();
form.file('file_content', filePath, 'demo.jpg');

const uploadResult = await sdk.curl<{
file_id: string;
}>('POST', '/v3/alipay/open/file/upload', {
form,
body: {
biz_code: 'openpt_appstore',
},
});
// console.log(uploadResult);
assert(uploadResult.data.file_id);
assert.equal(uploadResult.responseHttpStatus, 200);
assert(uploadResult.traceId);
});

it('POST /v3/alipay/user/deloauth/detail/query', async () => {
// https://opendocs.alipay.com/open-v3/668cd27c_alipay.user.deloauth.detail.query?pathHash=3ab93168
const result = await sdk.curl('POST', '/v3/alipay/user/deloauth/detail/query', {
body: {
date: '20230102',
offset: 20,
limit: 1,
},
});
console.log(result);
assert.equal(result.responseHttpStatus, 200);
});

it('转账接口强制要求证书签名调用', async () => {
// https://opendocs.alipay.com/open-v3/08e7ef12_alipay.fund.trans.uni.transfer?scene=ca56bca529e64125a2786703c6192d41&pathHash=52e2898b
await assert.rejects(async () => {
await sdk.curl('POST', '/v3/alipay/fund/trans/uni/transfer', {
body: {
order_title: '201905代发',
biz_scene: 'DIRECT_TRANSFER',
sign_data: {
ori_sign: 'EqHFP0z4a9iaQ1ep==',
partner_id: '签名被授权方支付宝账号ID',
ori_app_id: '2021000185629012',
ori_out_biz_no: '商户订单号',
ori_sign_type: 'RSA2',
ori_char_set: 'UTF-8',
},
business_params: '{"payer_show_name_use_alias":"true"}',
remark: '201905代发',
out_biz_no: '201806300001',
trans_amount: '23.00',
product_code: 'TRANS_ACCOUNT_NO_PWD',
payee_info: {
identity: '2088123412341234',
name: '黄龙国际有限公司',
identity_type: 'ALIPAY_USER_ID',
},
original_order_id: '20190620110075000006640000063056',
},
});
}, (err: any) => {
assert.equal(err.code, 'insufficient-isv-permissions');
assert.match(err.message, /ISV权限不足，建议在开发者中心检查对应功能是否已经添加/);
return true;
});
});
});

describe('sse(), curlStream(), curl() with needEncrypt = true', () => {
Expand Down
1 change: 1 addition & 0 deletions test/fixtures/test_alipayCertPublicKey_RSA2_aesEncryptText.crt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
MDui6ucG7be2/O6UuqHdpWJODEM85XVafYWcGUSg876nHu+QODLnNPbMn+jEIU6Mam8IEw6F8zN4kLjUUSNEDZNp0uzR1D/qJWyEJ0E1aPI3unTqznJ6BmV3n6s7XcNeUwbBTTThk50HP5Qh5jtX8YNUKhxWqxwRWuiTvTC6w6oP/yaiXsHXdkW44eINjqc63BmAf08EsyEIgFfUymmzLrX7oiANAH2lyoH7jJygqBJ5nfZ3H1to8OQybOsYV/Zbm/QO/IUNbJ6qq9+1g/NwD440YFVMnC4XPe13TQnEJeXVJhoCP/z8iL5whUZFwDbzT+jDr5+SjLW6lDCOQf9VgIwg0eubbDSF0nwCp/XgdcnyGRKDcM8aN1Cc5eh1ti9FuMOjiZwYEBrnMVxzXD1jtsWFPZoezMlorazLrq81NqgdHJxTbzzZ4Z160u14OxkqZX8SQpbo/Pkk/aXR1dk3huVdlJj28rX3R6veetPqWHG0NxVMS94HL6e7bwRce2tPxO7QCgiXx81DCX2HZ06c4p22zX+WQsNLdu3K5QKX/6+cfO63IlTulbhGAfARMvNAM2E56tTETvGFBva+uY2M8TQN23WvMw4a5SoLSI2Nsssi7X2hNvGedheJOiR2UXKwYfPTlWtQvXF5bTv5O7DpCs1tV8TA9macMGTJ1DTaAYCP4vM9B51LugySdxCiAXVl5k1E1/V8iBy87/gtFKcWKBHuB7TB3Ka9CBCqZmTbQ10TB4ySdwyAJxHJ/gYS4MaGU9aHviYDFxhyoL5dKcBIGSGBum74xUMuRHmhUK35Nqpw03ZUanfGS2mMslpTzxVzeQvAWnV7RD9MKxwbV05uR0CP6dj8ZThcHXvrDhkqDnwPdl4oNn8TJsnPkvfhDGnswxW1Pxqa3AghCavmEtGy5lvrpjcfpZxXaSxFFfnvaR/wFEzU5l6qlQNbrPi5tzE550XS07o8p3+KbU7R0JD0GQnRUFYGcByAQ1MUba4YZx5SCKb1ikxKKTesFhuvCrt7YCvKRx5Hn0NIZ5kfFysEshW7aebJutBwR6o2t1TEvYIHO1e9W2BXnd2ZENR0mm0QRWhqQ7q+fc2tmIWGqAd9PxeU7PHc2JQv9ltKWoVLnXsuPYcMu5K1nZ5TZV9/7yh/M65q/h+nWbFc9NAcCMW5y3v5qQvICBntJlyI6yTEm1z3o7mA0td9NB+N3dNuhTZzNGk5gB/356Kkc3SuX5Uzhth5MWwxBjB3ZY8IGiOJW992d5RGD7KMKjxgJTGNvgKuHIPc2HEFm9cQXkAW6Q2M3ybHYo7G2kLASDhYNNDSdgJJR6DxmMIwFEKCg2lFyUwr7ZCElm/zTl84Vg2MSYPBgGCOeebQASCgzx30QAoe0ABJffLeKu+vuQQs+aClKiS9k8DZ1752z0n8ZZVsM//SdYi6Mm8MLFekiQbUhFm0p2Wp4q7qXHiSBMfdCXaka/Jla7yK/kT43kUNoyAgCPxyNwlJfnl56JyXVcBoWnwx2wGYIWw4JfelvRROcvPkSor2YSyKBpuKM2jCZErTDFxU9RmNqCGYNl1p7NnmLmMo1E6zP/rcTxWtIxGYuJC6J+05upk/LXGDolivtcbTv0JQZgt6ALAdphhCO9AsBFMii8+lr3PFLNNvMrhsxR977J1SrkGgYyzQo2KUC6kwLxhSg0TITgQqPUgx620EX7LAfX+AkZWyrkvYaDOm6/YU4+IdvrYOGAKgkImy9SwPT+yyjzv8dYO820b4qcM14zmYEcvfgKC5mYiW9w/gYJ0Y2JOCqrMnFxlw0BnK83x45tyCLBUG+lualzemqcM8KvA+ebLIqrQuuLJd7TkYtnGnkDmCnyPHJQjn+1ej14Gy+ZlnNtxsFK3BQzYKQHWh8pBzUBFsP+0ieXW8PhjBKpg64DhXsnlFQQ1bmwmI0p4CXSKDXZeLlE7RrAXRpKOEBMKsMrnKJw9sxk+6nTRigPRaPQyRITFa5ScZl0iu9cDr+tOfCGT9umb1BhKAYzHt1DjPyLaAVg7ekPqd6npTLONHzbM8UmTA9iiE+UJBuEJi8PKkRWbq57Ek7JtL8OXe/besV6qHJzVBTluOiKlzeRXYOgrCdQwCHjZpsAedylBYutkYZ1FrNG0QTY/cpAQ6L4GjnCm9Dp22YyrVesa0ZVUkYAj6fAuuWcsdFUOaUQOc86OXwZiifORbD4UK61qzG5xnZfA881Cbfe86CSflirNAafp2zA3RiT93qgEhPEC646tAbPCS173yf3k4qMvri3NGvHwjMJ0dGcVVUdVFKfb5ikGTxTPSQTNhW8PuV+XOIGabwlc2tEjNk8+ds/C2IX3aV1gyiAuDqbzDeOSaNC9xm8T5u0pqinR7Y4QwuabVLp5JXrkjlo431rc3cQ5VO4wpz+fscRjDEdZAfc8rf3a92U/dRB6BB15I5U/6Fd/pLy0AGeLpeU0AxY/SUi+HR5uHWg5Y/fdXxwpfqHSKRkhBbifZtlBp6yCmauZ8WP66ai/fLtn0lSlRR6hkw+y0CcTlmKEmSuyytXTVEzj/BopEaxSOGtI1kDDce5J4IICaiL1BrYgXkEmkTjVaeOKc7EdG1w02xcqX0BlPJOlVTsT4SfvesQZhkJPzF2H7Q/+ls2rUVv4xr6SPnwLh6lpGry5BcsFC8HyVzSVf8/iixgkjYaS52cBfbx0DMZEBBONIUHktx7iKGR0au2jeha3nuAEt3jnOaTuQzsESNSGM+IRe2J/n84Du9EHHBjwbhakQpZYE8TAz/RSr/fdW/80tGl8tXB0pf0BxtZK8VScCJ4kx56stPw1Fj+y7w2L8YC9P56GW/OUe1x6XPRtQmFGXqK/dEhQOuhxPven5ArfF2ikAyje4uYIkFUzwBtgd/tO1QiVhhhCDfMVmFfPNvgY+tXNLuj61HIGravohSd26ZmCFNcWvUGQr1fcPDvQFiSi7m2v5Bzw0EMldnM1nck47nlNbVfPDAemY9wWjpvRxvaw5pemX3BuAhm4svDVj38/ZQsHR1jlZFiq0JOzfpR8P/wPQxmxuaAKPrzDAdJPlyOBYrQFqr311H8bjDcgI3CqMMecLsK2EpWnGg6CLpBKClnmrPhp++kDWNM4TgZsDVZy2kxTCTxjE6p24k3mn8kI0rTjlKJ6ZglRaRfK+eaxENYTfXT4L4rvhDOuQU7PPIl+8q05m3PkvzOzzH9ess8FuzKgb0/ianw64YlS8LHfnQ7WLEa7dp0kRjiB/GPpgxqzZALK7YH3wk/GqbT0UefXuPz6qAB48LxoGqsyTPo1gYKf/80BSaDUjb52BVnFJ4zUfq5I8qP1sYPi4lpp2ltMBSmsNpeMkjmilrxokA1EeL+J1P5ER7xU6ajy34ayNNDx2kLll+p+iNryFnWFBuzZo9ZcWZ/pyM8GDSomvPkWltnYDnwUuo+Roy/WpoDk7hp55gvrNn1Yi2K78oEPUsEtqO6cukjiMVtQRhAfFjJQcMRvwiTLREqx2jgeZN9QBQInNPwHtfQIjXPORll/RkcDLLCED6ExjWlil14Ji+2rmWC7Yg8hMOV4uYnRFXBi/2bylJYtwd0IRIyJl53m8zTyFnjSyZm/rJTTlb6G0aX4oUTSf7nePKyImgDJbkULzEhFe79YCBYWhmzxjWWXZs8+wBewrU6A2KvoDX8n7WVYpAIin/VWy6cuVLwA3f3R8F4NzgTo2a6MH3XuPYyDZeV19lRKLXFzAAX980P/BbbGFyfhNzFw4Hjyp2uwF72xDV3iIvJFxK2wtTum2zHvLDJpLaTbX3e9WrzGJoG1VK2OFxhqqCVC8tx1a/e3A0zir3uMsApi15yzHq93WIqacj8Cmh1s4JqODMYFnqZmE3gRCHxS4t0js8LK+77mQ17t9iOj25cNvAEkRbDTwV2p5s+VtqaZZ6WmEC98TsHjMGLLnPVF9BzKZYU99Eapw9pp0v0Fei2CFaMF+sw71MxIRQrTFG8l08/SeZVa45cRVuwCUoTpBjQZjrXtyrkiSPR0JGNSGggk5nACin05VxbyMpx6YQnVsgR7/W+MJ/lT/kR75U0/Hh9c=
Loading
Loading