Merge pull request #396 from qiniu/features/add-x-qiniu-date

add X-Qiniu-Date and fix bucket lifecycle tests

Author: xwen-winnie

index.d.ts

@@ -9,11 +9,15 @@ export declare type callback = (e?: Error, respBody?: any, respInfo?: any) => vo
 
 export declare namespace auth {
     namespace digest {
+        interface MacOptions {
+            disableQiniuTimestampSignature?: boolean;
+        }
+
         class Mac {
             accessKey: string;
             secretKey: string;
 
-            constructor(accessKey?: string, secretKey?: string);
+            constructor(accessKey?: string, secretKey?: string, options?: MacOptions);
         }
     }
 }
@@ -350,6 +354,21 @@ export declare namespace resume_up {
 export declare namespace util {
     function isTimestampExpired(timestamp: number): boolean;
 
+    /**
+     * 使用 UTC 时间来格式化日期时间
+     *
+     * @param date 与 new Date() 接受的参数一样，内部会使用 new Date(date) 生成日期时间对象
+     * @param layout 目前仅接受
+     *      YYYY
+     *      MM
+     *      DD
+     *      HH
+     *      mm
+     *      ss
+     *      SSS
+     */
+    function formatDateUTC(date: Date | number | string, layout?: string): string;
+
     function encodedEntry(bucket: string, key?: string): string;
 
     function getAKFromUptoken(uploadToken: string): string;
@@ -399,11 +418,16 @@ export declare namespace util {
 }
 
 export declare namespace rpc {
-    interface Headers {
+    type Headers = Record<string, string> & {
         'User-Agent'?: string;
         Connection?: string;
     }
 
+    interface RequestOptions {
+        headers: Headers;
+        mac: auth.digest.Mac;
+    }
+
     /**
      *
      * @param requestUrl 请求地址
@@ -412,6 +436,17 @@ export declare namespace rpc {
      */
     function get(requestUrl: string, headers: Headers | null, callbackFunc: callback): void;
 
+    /**
+     * @param requestUrl 请求地址
+     * @param options 请求的配置
+     * @param callbackFunc 回调函数
+     */
+    function getWithOptions(
+        requestUrl: string,
+        options: RequestOptions | null,
+        callbackFunc: callback
+    ): ReturnType<typeof get>;
+
     /**
      *
      * @param requestUrl 请求地址
@@ -429,6 +464,20 @@ export declare namespace rpc {
      */
     function post(requestURI: string, requestForm: Buffer | string | NodeJS.ReadableStream | null, headers: Headers | null, callback: callback): void;
 
+
+    /**
+     * @param requestUrl 请求地址
+     * @param requestForm 请求体
+     * @param options 请求的配置
+     * @param callbackFunc 回调函数
+     */
+    function postWithOptions(
+        requestUrl: string,
+        requestForm: Buffer | string | NodeJS.ReadableStream | null,
+        options: RequestOptions | null,
+        callbackFunc: callback
+    ): ReturnType<typeof post>;
+
     /**
      *
      * @param requestURI

package.json

@@ -57,6 +57,7 @@
     "encodeurl": "^1.0.1",
     "formstream": "^1.1.0",
     "mime": "^2.4.4",
+    "mockdate": "^3.0.5",
     "tunnel-agent": "^0.6.0",
     "urllib": "^2.34.1"
   },

qiniu/auth/digest.js

@@ -2,7 +2,12 @@ var conf = require('../conf');
 
 exports.Mac = Mac;
 
-function Mac (accessKey, secretKey) {
+const defaultOptions = {
+    disableQiniuTimestampSignature: null
+};
+
+function Mac (accessKey, secretKey, options) {
     this.accessKey = accessKey || conf.ACCESS_KEY;
     this.secretKey = secretKey || conf.SECRET_KEY;
+    this.options = Object.assign({}, defaultOptions, options);
 }

qiniu/rpc.js

@@ -1,14 +1,61 @@
 var urllib = require('urllib');
 var conf = require('./conf');
+const digest = require('./auth/digest');
+const util = require('./util');
 
 exports.get = get;
 exports.post = post;
 exports.put = put;
+exports.getWithOptions = getWithOptions;
 exports.getWithToken = getWithToken;
+exports.postWithOptions = postWithOptions;
 exports.postMultipart = postMultipart;
 exports.postWithForm = postWithForm;
 exports.postWithoutForm = postWithoutForm;
 
+function addAuthHeaders (headers, mac) {
+    const xQiniuDate = util.formatDateUTC(new Date(), 'YYYYMMDDTHHmmssZ');
+    if (mac.options.disableQiniuTimestampSignature !== null) {
+        if (!mac.options.disableQiniuTimestampSignature) {
+            headers['X-Qiniu-Date'] = xQiniuDate;
+        }
+    } else if (process.env.DISABLE_QINIU_TIMESTAMP_SIGNATURE) {
+        if (process.env.DISABLE_QINIU_TIMESTAMP_SIGNATURE.toLowerCase() !== 'true') {
+            headers['X-Qiniu-Date'] = xQiniuDate;
+        }
+    } else {
+        headers['X-Qiniu-Date'] = xQiniuDate;
+    }
+    return headers;
+}
+
+function getWithOptions (requestURI, options, callbackFunc) {
+    let headers = options.headers || {};
+    const mac = options.mac || new digest.Mac();
+
+    if (!headers['Content-Type']) {
+        headers['Content-Type'] = 'application/x-www-form-urlencoded';
+    }
+
+    headers = addAuthHeaders(headers, mac);
+
+    // if there are V3, V4 token generator in the future, extends options with signVersion
+    const token = util.generateAccessTokenV2(
+        mac,
+        requestURI,
+        'GET',
+        headers['Content-Type'],
+        null,
+        headers
+    );
+
+    if (mac.accessKey) {
+        headers.Authorization = token;
+    }
+
+    return get(requestURI, headers, callbackFunc);
+}
+
 function getWithToken (requestUrl, token, callbackFunc) {
     const headers = {
         'Content-Type': 'application/x-www-form-urlencoded'
@@ -19,6 +66,33 @@ function getWithToken (requestUrl, token, callbackFunc) {
     return get(requestUrl, headers, callbackFunc);
 }
 
+function postWithOptions (requestURI, requestForm, options, callbackFunc) {
+    let headers = options.headers || {};
+    const mac = options.mac || new digest.Mac();
+
+    if (!headers['Content-Type']) {
+        headers['Content-Type'] = 'application/x-www-form-urlencoded';
+    }
+
+    headers = addAuthHeaders(headers, mac);
+
+    // if there are V3, V4 token generator in the future, extends options with signVersion
+    const token = util.generateAccessTokenV2(
+        mac,
+        requestURI,
+        'POST',
+        headers['Content-Type'],
+        requestForm,
+        headers
+    );
+
+    if (mac.accessKey) {
+        headers.Authorization = token;
+    }
+
+    return post(requestURI, requestForm, headers, callbackFunc);
+}
+
 function postMultipart(requestURI, requestForm, callbackFunc) {
     return post(requestURI, requestForm, requestForm.headers(), callbackFunc);
 }