ksyun-sdk-node 1.0.5 → 1.2.4

package/src/base/BaseClient.js

@@ -1,4 +1,4 @@
-const getSignedParams = require('../lib/sign.js').getSignedParams
+const {getSignatureHeaders, getCanonicalizedQuery} = require('../lib/signautreV4.js')
 const fetch = require('../lib/fetch.js')
 const dayjs = require('dayjs')
 const utc = require('dayjs/plugin/utc.js')
@@ -26,67 +26,116 @@ module.exports = class BaseClient {
      */
     request (apiAction, params = {}) {
 
-        let apiConfig = this._apiList[apiAction]
-        let publicParams = {
-            Accesskey: this.ak,
-            Service: this._baseConfig.config.credentials.service,
-            Action: apiAction,
-            Version: apiConfig.config.query.Version,
-            Timestamp: dayjs().utc().format('YYYY-MM-DDThh:mm:ss')+'Z',
-            SignatureVersion: '1.0',
-            SignatureMethod: 'HMAC-SHA256',
-            Region: this.region || this._baseConfig.config.credentials.region,
-        }
-
-        let combainParams = {
-            ...publicParams,
-            ...params
-        }
+        params = this.formatParams(apiAction, params)
 
-        let signedParams = getSignedParams(combainParams, this.sk)
+        let apiConfig = this._apiList[apiAction]
 
         let protocol = this.httpProfile.protocol || this._baseConfig.protocol
         let endpoint = this.httpProfile.endpoint || this._baseConfig.endpoint
-        let method = this.httpProfile.method || apiConfig.method
-
-        let url = `${protocol}${endpoint}${apiConfig.url}`
-        if (['GET', 'DELETE', 'OPTION', 'HEAD'].includes(method.toUpperCase())) {
-            url += `?${qs.stringify(signedParams)}`
-        }
+        let method = (this.httpProfile.method || apiConfig.method).toUpperCase()
+        let region = this.region || this._baseConfig.config.credentials.region
         let headers = {
             ...(this._baseConfig.config.headers || {}),
-            ...(apiConfig.config.headers || {}),
-            // 目前kop只支持application/x-www-form-urlencoded类型的签名解析
-            'Content-Type': 'application/x-www-form-urlencoded',
+            ...(apiConfig.config.headers || {})
+        }
+
+        let query = apiConfig.config.query
+        if (['GET', 'OPTION', 'HEAD'].includes(method)) {
+            query = {
+                ...query,
+                ...params
+            }
+        }
+
+        let body = this.getBody(method, headers['Content-Type'], params)
+
+        let signParams = {
+            path: apiConfig.url,
+            query,
+            body: body || '',
+            headers,
+            host: endpoint,
+            method,
+            region,
+            service: this._baseConfig.config.credentials.service,
+            access_key: this.ak,
+            secret_key: this.sk,
         }
-        let body = this.getBody(method, headers['Content-Type'], signedParams)
+
+        let signHeaders = getSignatureHeaders(signParams)
+
+        let url = `${protocol}${endpoint}${apiConfig.url}?${getCanonicalizedQuery(query)}`
 
         let timeoutSecond = this.httpProfile.timeout || this._baseConfig.config.timeout
         return fetch(url, {
             method: method,
             timeout: timeoutSecond * 1000,
-            headers,
+            headers: signHeaders,
             body
         })
     }
+    /**
+     * 格式化参数，对Filter类型做扁平处理
+     * @param {string} apiAction 接口名
+     * @param {object} params 参数值
+     * @returns 格式化后的参数
+     */
+     formatParams (apiAction, params) {
+        let paramsType = this._apiList[apiAction].paramsType
+        if (!paramsType || params == null) {
+            return params
+        }
+        let res = {}
+        Object.keys(params).forEach(key => {
+            let type = paramsType[key]
+            // 这些类型不用处理，如果为null、undefined则排除掉
+            if (['String', 'Int', 'Double', 'Long', 'Boolean', 'Array'].includes(type) && params[key] != null) {
+                res[key] = params[key]
+            }
+            if (type == 'Filter') {
+                res = {
+                    ...res,
+                    ...this.formatFilter(key, params[key])
+                }
+            }
+        })
+        return res
+    }
+    formatFilter (pKey, value) {
+        let res = {}
+        Object.keys(value).forEach(key => {
+            let prefixName = `${pKey}.${key}`
+            let childValue = value[key]
+            if (typeof(childValue) == 'object') {
+                res = {
+                    ...res,
+                    ...this.formatFilter(prefixName, childValue)
+                }
+            } else {
+                res[prefixName] = childValue
+            }
+        })
+        return res
+    }
+
     /**
      * 获取body
      * @param {string} method 请求类型
      * @param {string} contentType
-     * @param {object} signedParams 参数对象
+     * @param {object} params 参数对象
      * @returns {string}
      */
-    getBody (method, contentType, signedParams) {
-        if (!['POST', 'PUT'].includes(method.toUpperCase())) {
-            return undefined
+    getBody (method, contentType, params) {
+        if (!['POST', 'PUT'].includes(method) || JSON.stringify(params) == '{}') {
+            return null
         }
         // 目前只有下面这两种
         if (contentType == 'application/x-www-form-urlencoded') {
-            return qs.stringify(signedParams)
+            return qs.stringify(params)
         }
         if (contentType == 'application/json') {
-            return JSON.stringify(signedParams)
+            return JSON.stringify(params)
         }
-        return JSON.stringify(signedParams)
+        return JSON.stringify(params)
     }
 }

package/src/lib/signautreV4.js

@@ -0,0 +1,166 @@
+const crypto = require("crypto-js")
+const dayjs = require('dayjs')
+const utc = require('dayjs/plugin/utc.js')
+
+dayjs.extend(utc)
+
+const HEADERS_TO_IGNORE = {
+    'cache-control'       :  true,
+    'content-type'        :  true,
+    'content-length'      :  true,
+    'expect'              :  true,
+    'max-forwards'        :  true,
+    'pragma'              :  true,
+    'range'               :  true,
+    'te'                  :  true,
+    'if-match'            :  true,
+    'if-none-match'       :  true,
+    'if-modified-since'   :  true,
+    'if-unmodified-since' :  true,
+    'if-range'            :  true,
+    'accept'              :  true,
+    'authorization'       :  true,
+    'proxy-authorization' :  true,
+    'from'                :  true,
+    'referer'             :  true,
+    'user-agent'          :  true
+}
+
+function getSignatureKey(key, dateStamp, regionName, serviceName) {
+    var kDate = crypto.HmacSHA256(dateStamp, "AWS4" + key);
+    var kRegion = crypto.HmacSHA256(regionName, kDate);
+    var kService = crypto.HmacSHA256(serviceName, kRegion);
+    var kSigning = crypto.HmacSHA256("aws4_request", kService);
+    return kSigning;
+}
+
+/**
+ * 编码
+ * @param {*} str 
+ * @returns 
+ */
+function encodeRfc3986Full(str) {
+    // This function assumes the string has already been percent encoded
+    function encodeRfc3986(urlEncodedString) {
+        return urlEncodedString.replace(/[!'()*]/g, function (c) {
+            return '%' + c.charCodeAt(0).toString(16).toUpperCase()
+        })
+    }
+    return encodeRfc3986(encodeURIComponent(str))
+}
+
+/**
+ * 
+ * @param {*} path 
+ * @returns 
+ */
+function createCanonicalizedPath(path) {
+    return encodeRfc3986Full(path).replace(/%2F/g, '/')
+}
+
+function getCanonicalHeaders(headers) {
+    function trimAll(header) {
+        return header.toString().trim().replace(/\s+/g, ' ')
+    }
+    return Object.keys(headers)
+        .filter(function (key) { return HEADERS_TO_IGNORE[key.toLowerCase()] == null })
+        .sort(function (a, b) { return a.toLowerCase() < b.toLowerCase() ? -1 : 1 })
+        .map(function (key) { return key.toLowerCase() + ':' + trimAll(headers[key]) })
+        .join('\n') + '\n'
+}
+
+function getSignedHeaders(headers) {
+    return Object.keys(headers)
+        .map(function (key) { return key.toLowerCase() })
+        .filter(function (key) { return HEADERS_TO_IGNORE[key] == null })
+        .sort()
+        .join(';')
+}
+
+
+function getCanonicalizedQuery(query) {
+    if (!query) {
+        return ''
+    }
+    delete query['X-Amz-Signature'] // php项目里有这句
+    let res = [];
+    let sortKeys = Object.keys(query).sort()
+    sortKeys.forEach(key => {
+        if (!Array.isArray(query[key])) {
+            res.push(encodeRfc3986Full(key) + '=' + encodeRfc3986Full(query[key]))
+        } else {
+            query[key].map(encodeRfc3986Full).sort().forEach(val => {
+                res.push(encodeRfc3986Full(key) + '=' + encodeRfc3986Full(val))
+            })
+        }
+    })
+    return res.join('&')
+}
+
+// 签名步骤摘要
+// 要创建已签名的请求，请完成以下操作：
+
+/**
+ * 获取包含签名的头，含之前的头
+ * AWS Version 4
+ * https://docs.aws.amazon.com/zh_cn/general/latest/gr/sigv4_signing.html
+ * @param {string} path
+ * @param {string} query
+ */
+function getSignatureHeaders({
+    path, query, body, headers, host, method, region, service, secret_key, access_key
+}) {
+
+    let now = dayjs().utc()
+    let amzdate = now.format(`YYYYMMDDTHHmmssZ`)
+    let datestamp = now.format('YYYYMMDD')
+
+    // 任务 1：针对签名版本 4 创建规范请求
+    // 将请求的内容（主体、操作、标头等）组织为标准（规范）格式。规范请求是用于创建待签字符串的输入之一。
+
+    let canonical_uri = createCanonicalizedPath(path)
+    let canonical_querystring = getCanonicalizedQuery(query)
+
+    let allHeaders = {
+        ...headers,
+        host,
+        'x-amz-date': amzdate
+    }
+    let canonical_headers = getCanonicalHeaders(allHeaders)
+    let signed_headers = getSignedHeaders(allHeaders)
+
+    let payload_hash = headers['X-Amz-Content-Sha256'] || headers['x-amz-content-sha256'] ||
+    crypto.SHA256(body || '').toString()
+
+    let canonical_request = method + '\n' + canonical_uri + '\n' + canonical_querystring + '\n' + canonical_headers + '\n' + signed_headers + '\n' + payload_hash
+
+
+    // 任务 2：创建签名版本 4 的待签字符串
+    // 使用规范请求和额外信息（例如算法、请求日期、凭证范围和规范请求的摘要（哈希））创建待签字符串。
+    let algorithm = 'AWS4-HMAC-SHA256'
+    let credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'
+    let string_to_sign = algorithm + '\n' + amzdate + '\n' + credential_scope + '\n' + crypto.SHA256(canonical_request).toString()
+
+    // 任务 3：为AWS签名版本 4 计算签名
+    // 使用AWS秘密访问密钥作为初始哈希操作的密钥，对请求日期、区域和服务执行一系列加密哈希操作（HMAC 操作），从而派生签名密钥。在派生签名密钥后，通过对待签字符串执行加密哈希操作来计算签名。使用派生的签名密钥作为此操作的哈希密钥。
+    let signing_key = getSignatureKey(secret_key, datestamp, region, service);
+    let signature = crypto.HmacSHA256(string_to_sign, signing_key).toString();
+
+    // 任务 4：将签名添加到 HTTP 请求
+    // 在计算签名后，将其添加到请求的 HTTP 标头或查询字符串中。
+    let authorization_header = algorithm + ' ' + 'Credential=' + access_key + '/' + credential_scope + ', ' + 'SignedHeaders=' + signed_headers + ', ' + 'Signature=' + signature
+
+    let res = {
+        ...headers
+    }
+    res['x-amz-date'] = amzdate
+    res['Authorization'] = authorization_header
+
+    return res
+
+}
+
+module.exports = {
+    getCanonicalizedQuery,
+    getSignatureHeaders
+}

package/src/service/Actiontrail/v20190401/index.js

@@ -25,7 +25,7 @@ module.exports = class Client extends BaseClient {
                     'Action': 'ListOperateLogs',
                 },
                 'headers': {
-                    'Content-Type': 'application/x-www-form-urlencoded'
+                    'Content-Type': 'application/json'
                 },
             },
             'paramsType': {

package/src/service/Bill/v20180601/index.js

@@ -29,7 +29,8 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
-                'Action': 'String',
+                'BillStartMonth': 'String',
+                'BillEndMonth': 'String',
             }
         },
         'GetPostpayDetailBill': {
@@ -45,21 +46,10 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
-            }
-        },
-        'GetPostpayDetailBillCSV': {
-            'url': '/',
-            'method': 'GET',
-            'config': {
-                'query': {
-                    'Version': '2018-06-01',
-                    'Action': 'GetPostpayDetailBillCSV',
-                },
-                'headers': {
-                    'Content-Type': 'application/json'
-                },
-            },
-            'paramsType': {
+                'BillStartMonth': 'String',
+                'BillEndMonth': 'String',
+                'ProductCode': 'String',
+                'ProjectId': 'String',
             }
         },
         'GetProductCode': {
@@ -77,35 +67,5 @@ module.exports = class Client extends BaseClient {
             'paramsType': {
             }
         },
-        'getMonthConsume': {
-            'url': '/',
-            'method': 'GET',
-            'config': {
-                'query': {
-                    'Version': '2018-06-01',
-                    'Action': 'getMonthConsume',
-                },
-                'headers': {
-                    'Content-Type': 'application/json'
-                },
-            },
-            'paramsType': {
-            }
-        },
-        'getPostpayDetailConsume': {
-            'url': '/',
-            'method': 'GET',
-            'config': {
-                'query': {
-                    'Version': '2018-06-01',
-                    'Action': 'getPostpayDetailConsume',
-                },
-                'headers': {
-                    'Content-Type': 'application/json'
-                },
-            },
-            'paramsType': {
-            }
-        },
     }
 }

package/src/service/Bill/v20220601/index.js

@@ -0,0 +1,56 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'bill.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'bill',
+            },
+        },
+    }
+    _apiList = {
+        'GetMonthConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-06-01',
+                    'Action': 'GetMonthConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'BillMonth': 'String',
+            }
+        },
+        'GetPostpayDetailConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-06-01',
+                    'Action': 'GetPostpayDetailConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'BillMonth': 'String',
+                'ProductCode': 'String',
+                'ProjectId': 'String',
+                'PageNo': 'Int',
+                'PageSize': 'Int',
+            }
+        },
+    }
+}

package/src/service/Bill_union/v20200101/index.js

@@ -29,6 +29,8 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
+                'BillBeginMonth': 'String',
+                'BillEndMonth': 'String',
             }
         },
         'DescribeBillSummaryByProduct': {
@@ -44,6 +46,8 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
+                'BillBeginMonth': 'String',
+                'BillEndMonth': 'String',
             }
         },
         'DescribeBillSummaryByProject': {
@@ -76,6 +80,10 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
+                'BillMonth': 'String',
+                'ProductCode': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
             }
         },
         'DescribeProductCode': {
@@ -106,6 +114,35 @@ module.exports = class Client extends BaseClient {
                 },
             },
             'paramsType': {
+                'CustomerBillMonth': 'Int',
+                'ProductGroupCode': 'String',
+                'StatisticType': 'Int',
+                'PayType': 'Int',
+                'SubAccountId': 'Int',
+                'Page': 'Int',
+                'Size': 'String',
+            }
+        },
+        'DescribeSplitItemDayBillDetails': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeSplitItemDayBillDetails',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'CustomerBillMonth': 'Int',
+                'ProductGroupCode': 'String',
+                'StatisticType': 'Int',
+                'PayType': 'Int',
+                'SubAccountId': 'Int',
+                'Page': 'Int',
+                'Size': 'Int',
             }
         },
     }

package/src/service/Bill_union/v20221222/index.js

@@ -0,0 +1,134 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'bill-union.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'bill-union',
+            },
+        },
+    }
+    _apiList = {
+        'QueryInstanceConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryInstanceConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'StartDay': 'String',
+                'EndDay': 'String',
+                'ProductCode': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+        'QueryProjectConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryProjectConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'StartDay': 'String',
+                'EndDay': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+        'QueryProductConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryProductConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'StartDay': 'String',
+                'EndDay': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+        'QueryFinanceUnitConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryFinanceUnitConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'StartDay': 'String',
+                'EndDay': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+        'QueryFinanceUnitConsumeOfMonth': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryFinanceUnitConsumeOfMonth',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'CustomerBillMonth': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+        'QueryUserConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2022-12-22',
+                    'Action': 'QueryUserConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'StartDay': 'String',
+                'EndDay': 'String',
+                'Page': 'Int',
+                'Size': 'Int',
+            }
+        },
+    }
+}

package/src/service/Bws/v20160304/index.js

@@ -125,5 +125,25 @@ module.exports = class Client extends BaseClient {
                 'BandWidthShareId': 'String',
             }
         },
+        'QueryBwsTopEipMonitor': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2016-03-04',
+                    'Action': 'QueryBwsTopEipMonitor',
+                },
+                'headers': {
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                },
+            },
+            'paramsType': {
+                'BandWidthShareId': 'String',
+                'StartTime': 'String',
+                'EndTime': 'String',
+                'SortType': 'String',
+                'PublicIp': 'String',
+            }
+        },
     }
 }