demo/demo-sts-scope.js

@@ -0,0 +1,73 @@
+/**
+ * 使用临时密钥例子
+ */
+var STS = require('qcloud-cos-sts');
+var COS = require('../index');
+var config = require('./config');
+
+var allowPrefix = '';
+// 简单上传和分片，需要以下的权限，其他权限列表请看 https://cloud.tencent.com/document/product/436/14048
+var allowActions = [
+    'name/cos:PutObject',
+    'name/cos:InitiateMultipartUpload',
+    'name/cos:ListMultipartUploads',
+    'name/cos:ListParts',
+    'name/cos:UploadPart',
+    'name/cos:CompleteMultipartUpload'
+];
+
+
+// 判断是否允许获取密钥
+var allowScope = function (scope) {
+    var allow = (scope || []).every(function (item) {
+        return allowActions.includes(item.action) &&
+            item.bucket === config.bucket &&
+            item.region === config.region &&
+            (item.prefix || '').startsWith(allowPrefix);
+    });
+    return allow;
+};
+
+var cos = new COS({
+    getAuthorization: function (options, callback) {
+
+        if (!allowScope()) {
+            console.log('deny Scope');
+            return;
+        }
+
+        // 获取临时密钥
+        var policy = STS.getPolicy(options.Scope);
+        STS.getCredential({
+            secretId: config.SecretId,
+            secretKey: config.SecretKey,
+            policy: policy,
+            // durationSeconds: 1800,
+            proxy: '',
+        }, function (err, data) {
+            if (err) {
+                console.error(err);
+            } else {
+                console.log(data);
+                var credentials = data.credentials;
+                callback({
+                    TmpSecretId: credentials.tmpSecretId,
+                    TmpSecretKey: credentials.tmpSecretKey,
+                    XCosSecurityToken: credentials.sessionToken,
+                    ExpiredTime: data.expiredTime,
+                    ScopeLimit: true, // 设为 true 可限制密钥只在相同请求可重用，默认不限制一直可重用，细粒度控制权限需要设为 true
+                });
+            }
+        });
+
+    },
+});
+
+cos.putObject({
+    Bucket: config.Bucket,
+    Region: config.Region,
+    Key: 'dir/1.txt',
+    Body: 'hello!',
+}, function (err, data) {
+    console.log(err || data);
+});

demo/demo-sts.js

@@ -0,0 +1,62 @@
+/**
+ * 使用临时密钥例子
+ */
+var STS = require('qcloud-cos-sts');
+var COS = require('../index');
+var config = require('./config');
+
+
+var LongBucketName = config.Bucket;
+var ShortBucketName = LongBucketName.substr(0, LongBucketName.indexOf('-'));
+var AppId = LongBucketName.substr(LongBucketName.indexOf('-') + 1);
+var policy = {
+    'version': '2.0',
+    'statement': [{
+        'action': [
+            'name/cos:PutObject',
+            'name/cos:InitiateMultipartUpload',
+            'name/cos:ListMultipartUploads',
+            'name/cos:ListParts',
+            'name/cos:UploadPart',
+            'name/cos:CompleteMultipartUpload'
+        ],
+        'effect': 'allow',
+        'principal': {'qcs': ['*']},
+        'resource': [
+            'qcs::cos:ap-guangzhou:uid/' + AppId + ':prefix//' + AppId + '/' + ShortBucketName + '/dir/*'
+        ]
+    }]
+};
+
+var cos = new COS({
+    getAuthorization: function (options, callback) {
+        STS.getCredential({
+            secretId: config.SecretId,
+            secretKey: config.SecretKey,
+            policy: policy,
+            durationSeconds: 7200,
+            proxy: '',
+        }, function (err, data) {
+            if (err) {
+                console.error(err);
+            } else {
+                var credentials = data.credentials;
+                callback({
+                    TmpSecretId: credentials.tmpSecretId,
+                    TmpSecretKey: credentials.tmpSecretKey,
+                    XCosSecurityToken: credentials.sessionToken,
+                    ExpiredTime: data.expiredTime,
+                });
+            }
+        });
+    },
+});
+
+cos.putObject({
+    Bucket: config.Bucket,
+    Region: config.Region,
+    Key: 'dir/1.txt',
+    Body: 'hello!',
+}, function (err, data) {
+    console.log(err || data);
+});

demo/demo.js

@@ -13,7 +13,8 @@ var cos = new COS({
     // 可选参数
     FileParallelLimit: 3,    // 控制文件上传并发数
     ChunkParallelLimit: 8,   // 控制单个文件下分片上传并发数，在同园区上传可以设置较大的并发数
-    ChunkSize: 1024 * 1024,  // 控制分片大小，单位 B，在同园区上传可以设置较大的分片大小
+    ChunkSize: 1024 * 1024 * 8,  // 控制分片大小，单位 B，在同园区上传可以设置较大的分片大小
+    Proxy: '',
 });
 var TaskId;
 
@@ -300,17 +301,39 @@ function putBucketLifecycle() {
         Bucket: config.Bucket, // Bucket 格式：test-1250000000
         Region: config.Region,
         LifecycleConfiguration: {
-            "Rules": [{
-                'ID': 1,
-                'Filter': {
-                    'Prefix': 'cas',
+            Rules: [{
+                "ID": "1",
+                "Status": "Enabled",
+                "Filter": {},
+                "Transition": {
+                    "Days": "30",
+                    "StorageClass": "STANDARD_IA"
+                }
+            }, {
+                "ID": "2",
+                "Status": "Enabled",
+                "Filter": {
+                    "Prefix": "dir/"
                 },
-                'Status': 'Enabled',
-                'Transition': {
-                    'Days': 0,
-                    'StorageClass': 'ARCHIVE'
+                "Transition": {
+                    "Days": "90",
+                    "StorageClass": "ARCHIVE"
                 }
-            }]
+            }, {
+                "ID": "3",
+                "Status": "Enabled",
+                "Filter": {},
+                "Expiration": {
+                    "Days": "180"
+                }
+            }, {
+                "ID": "4",
+                "Status": "Enabled",
+                "Filter": {},
+                "AbortIncompleteMultipartUpload": {
+                    "DaysAfterInitiation": "30"
+                }
+            }],
         }
     }, function (err, data) {
         console.log(err || data);
@@ -361,7 +384,8 @@ function listObjectVersions() {
     cos.listObjectVersions({
         Bucket: config.Bucket, // Bucket 格式：test-1250000000
         Region: config.Region,
-        Prefix: "1mb.zip"
+        // Prefix: "",
+        // Delimiter: '/'
     }, function (err, data) {
         console.log(err || JSON.stringify(data, null, '    '));
     });
@@ -373,14 +397,15 @@ function putBucketReplication() {
         Bucket: config.Bucket, // Bucket 格式：test-1250000000
         Region: config.Region,
         ReplicationConfiguration: {
-            Role: "qcs::cam::uin/459000000:uin/459000000",
+            Role: "qcs::cam::uin/10001:uin/10001",
             Rules: [{
                 ID: "1",
                 Status: "Enabled",
-                Prefix: "img/",
+                Prefix: "sync/",
                 Destination: {
-                    Bucket: "qcs::cos:ap-guangzhou::test-" + AppId
-                },
+                    Bucket: "qcs:id/0:cos:ap-chengdu:appid/" + AppId + ":backup",
+                    // StorageClass: "Standard",
+                }
             }]
         }
     }, function (err, data) {
@@ -414,7 +439,7 @@ function deleteBucket() {
         console.log(err || data);
     });
 }
-
+return putObject();
 function putObject() {
     // 创建测试文件
     var filename = '1mb.zip';
@@ -556,7 +581,7 @@ function deleteMultipleObject() {
         Region: config.Region,
         Objects: [
             {Key: '中文/中文.txt'},
-            {Key: '中文/中文.zip'},
+            {Key: '中文/中文.zip',VersionId: 'MTg0NDY3NDI1MzM4NzM0ODA2MTI'},
         ]
     }, function (err, data) {
         console.log(err || data);

package.json

@@ -1,11 +1,14 @@
 {
   "name": "cos-nodejs-sdk-v5",
-  "version": "2.4.10",
+  "version": "2.5.0",
   "description": "cos nodejs sdk v5",
   "main": "index.js",
   "scripts": {
     "demo": "node demo/demo.js",
-    "test": "mocha"
+    "demo-sts": "node demo/demo-sts.js",
+    "demo-sts-scope": "node demo/demo-sts-scope.js",
+    "test": "mocha test/test.js",
+    "csp": "mocha test/csp.js"
   },
   "repository": {
     "type": "git",
@@ -26,11 +29,11 @@
   "homepage": "https://github.com/tencentyun/cos-nodejs-sdk-v5#readme",
   "dependencies": {
     "configstore": "^3.1.2",
-    "qcloudapi-sdk": "^0.2.0",
     "request": "^2.81.0",
     "xml2js": "^0.4.19"
   },
   "devDependencies": {
-    "mocha": "^4.0.1"
+    "mocha": "^4.0.1",
+    "qcloud-cos-sts": "^2.0.5"
   }
 }

sdk/advance.js

@@ -5,6 +5,7 @@ var util = require('./util');
 
 // 文件分块上传全过程，暴露的分块上传接口
 function sliceUploadFile(params, callback) {
+    var self = this;
     var ep = new EventProxy();
     var TaskId = params.TaskId;
     var Bucket = params.Bucket;
@@ -16,7 +17,6 @@ function sliceUploadFile(params, callback) {
     var StorageClass = params.StorageClass || 'Standard';
     var ServerSideEncryption = params.ServerSideEncryption;
     var FileSize;
-    var self = this;
 
     var onProgress;
     var onHashProgress = params.onHashProgress;
@@ -135,21 +135,20 @@ function sliceUploadFile(params, callback) {
         var AutoChunkSize = 1024 * 1024;
         for (var i = 0; i < SIZE.length; i++) {
             AutoChunkSize = SIZE[i] * 1024 * 1024;
-            if (FileSize / AutoChunkSize < 10000) break;
+            if (FileSize / AutoChunkSize <= self.options.MaxPartNumber) break;
         }
         params.ChunkSize = params.SliceSize = ChunkSize = Math.max(ChunkSize, AutoChunkSize);
     })();
-    onProgress = util.throttleOnProgress.call(self, FileSize, params.onProgress);
 
     // 开始上传
     if (FileSize === 0) {
         params.Body = '';
+        params.ContentLength = 0;
+        params._OnlyUploadNotAddTask = true;
         self.putObject(params, function (err, data) {
             if (err) {
-                onProgress(null, true);
                 return callback(err);
             }
-            onProgress({loaded: FileSize, total: FileSize}, true);
             callback(null, data);
         });
     } else {
@@ -957,7 +956,7 @@ function sliceCopyFile(params, callback) {
     var Region = params.Region;
     var Key = params.Key;
     var CopySource = params.CopySource;
-    var m = CopySource.match(/^([^.]+-\d+)\.cos\.([^.]+)\.myqcloud\.com\/(.+)$/);
+    var m = CopySource.match(/^([^.]+-\d+)\.cos\.([^.]+)\.[^/]+\/(.+)$/);
     if (!m) {
         callback({error: 'CopySource format error'});
         return;
@@ -1016,7 +1015,7 @@ function sliceCopyFile(params, callback) {
                 }
             },function (err,data) {
                 if (err) {
-                    return callback(err);
+                    return asyncCallback(err);
                 }
                 onProgress({loaded: FinishSize, total: FileSize});
 
@@ -1030,7 +1029,7 @@ function sliceCopyFile(params, callback) {
                 return callback(err);
             }
 
-            ep.emit('copy_slice_complete',UploadData);
+            ep.emit('copy_slice_complete', UploadData);
         });
     });
 
@@ -1041,7 +1040,7 @@ function sliceCopyFile(params, callback) {
             var AutoChunkSize = 1024 * 1024;
             for (var i = 0; i < SIZE.length; i++) {
                 AutoChunkSize = SIZE[i] * 1024 * 1024;
-                if (FileSize / AutoChunkSize < 10000) break;
+                if (FileSize / AutoChunkSize <= self.options.MaxPartNumber) break;
             }
             params.ChunkSize = ChunkSize = Math.max(ChunkSize, AutoChunkSize);
 
@@ -1082,35 +1081,35 @@ function sliceCopyFile(params, callback) {
         Key: SourceKey,
     },function(err, data) {
         if (err) {
-          if (err.statusCode && err.statusCode === 404) {
-            return callback({ ErrorStatus: SourceKey + ' Not Exist' });
-          } else {
-            callback(err);
-          }
-          return;
+            if (err.statusCode && err.statusCode === 404) {
+                callback({ErrorStatus: SourceKey + ' Not Exist'});
+            } else {
+                callback(err);
+            }
+            return;
         }
 
         FileSize = params.FileSize = data.headers['content-length'];
         onProgress = util.throttleOnProgress.call(self, FileSize, params.onProgress);
 
         // 开始上传
         if (FileSize <= CopySliceSize) {
-          self.putObjectCopy(params, function (err, data) {
-              if (err) {
-                  onProgress(null, true);
-                  return callback(err);
-              }
-              onProgress({loaded: FileSize, total: FileSize}, true);
-              callback(err, data);
-          });
+            self.putObjectCopy(params, function (err, data) {
+                if (err) {
+                    onProgress(null, true);
+                    return callback(err);
+                }
+                onProgress({loaded: FileSize, total: FileSize}, true);
+                callback(err, data);
+            });
         } else {
-          ep.emit('get_file_size_finish');
+            ep.emit('get_file_size_finish');
         }
     });
 }
 
 // 复制指定分片
-function copySliceItem(params,callback) {
+function copySliceItem(params, callback) {
     var TaskId = params.TaskId;
     var Bucket = params.Bucket;
     var Region = params.Region;
@@ -1150,6 +1149,9 @@ var API_MAP = {
     sliceCopyFile: sliceCopyFile,
 };
 
-util.each(API_MAP, function (fn, apiName) {
-    exports[apiName] = util.apiWrapper(apiName, fn);
-});
+module.exports.init = function (COS, task) {
+    task.transferToTaskMethod(API_MAP, 'sliceUploadFile');
+    util.each(API_MAP, function (fn, apiName) {
+        COS.prototype[apiName] = util.apiWrapper(apiName, fn);
+    });
+};

sdk/cos.js

@@ -11,6 +11,7 @@ var defaultOptions = {
     AppId: '', // AppId 已废弃，请拼接到 Bucket 后传入，例如：test-1250000000
     SecretId: '',
     SecretKey: '',
+    XCosSecurityToken: '',
     FileParallelLimit: 3,
     ChunkParallelLimit: 3,
     ChunkRetryTimes: 3,
@@ -19,12 +20,17 @@ var defaultOptions = {
     CopyChunkParallelLimit: 20,
     CopyChunkSize: 1024 * 1024 * 10,
     CopySliceSize: 1024 * 1024 * 10,
+    MaxPartNumber: 10000,
     ProgressInterval: 1000,
     UploadQueueSize: 10000,
     Domain: '',
     ServiceDomain: '',
     Protocol: '',
-    IgnoreRegionFormat: false,
+    CompatibilityMode: false,
+    ForcePathStyle: false,
+    UseRawKey: false,
+    Timeout: 0, // 单位毫秒，0 代表不设置超时时间
+    UploadCheckContentMd5: false,
     UploadIdCacheLimit: 500,
     Proxy: '',
     UserAgent: '',
@@ -40,15 +46,17 @@ var COS = function (options) {
     this.options.CopyChunkParallelLimit = Math.max(1, this.options.CopyChunkParallelLimit);
     this.options.CopyChunkSize = Math.max(1024 * 1024, this.options.CopyChunkSize);
     this.options.CopySliceSize = Math.max(0, this.options.CopySliceSize);
+    this.options.MaxPartNumber = Math.max(1024, Math.min(10000, this.options.MaxPartNumber));
+    this.options.Timeout = Math.max(0, this.options.Timeout);
     if (this.options.AppId) {
         console.warn('warning: AppId has been deprecated, Please put it at the end of parameter Bucket(E.g: "test-1250000000").');
     }
     event.init(this);
     task.init(this);
 };
 
-util.extend(COS.prototype, base);
-util.extend(COS.prototype, advance);
+base.init(COS, task);
+advance.init(COS, task);
 
 COS.getAuthorization = util.getAuth;
 COS.version = pkg.version;

sdk/task.js

@@ -1,25 +1,24 @@
 var util = require('./util');
 
+var originApiMap = {};
+var transferToTaskMethod = function (apiMap, apiName) {
+    originApiMap[apiName] = apiMap[apiName];
+    apiMap[apiName] = function (params, callback) {
+        if (params._OnlyUploadNotAddTask) {
+            originApiMap[apiName].call(this, params, callback);
+        } else {
+            this._addTask(apiName, params, callback);
+        }
+    };
+};
+
 var initTask = function (cos) {
 
     var queue = [];
     var tasks = {};
     var uploadingFileCount = 0;
     var nextUploadIndex = 0;
 
-    var originApiMap = {};
-
-    // 把上传方法替换成添加任务的方法
-    util.each([
-        'putObject',
-        'sliceUploadFile',
-    ], function (api) {
-        originApiMap[api] = cos[api];
-        cos[api] = function (params, callback) {
-            cos._addTask(api, params, callback);
-        };
-    });
-
     // 接口返回简略的任务信息
     var formatTask = function (task) {
         var t = {
@@ -53,7 +52,8 @@ var initTask = function (cos) {
                 uploadingFileCount++;
                 task.state = 'checking';
                 !task.params.UploadData && (task.params.UploadData = {});
-                originApiMap[task.api].call(cos, task.params, function (err, data) {
+                var apiParams = util.formatParams(task.api, task.params);
+                originApiMap[task.api].call(cos, apiParams, function (err, data) {
                     if (!cos._isRunningTask(task.id)) return;
                     if (task.state === 'checking' || task.state === 'uploading') {
                         task.state = err ? 'error' : 'success';
@@ -111,7 +111,7 @@ var initTask = function (cos) {
     cos._addTask = function (api, params, callback, ignoreAddEvent) {
 
         // 复制参数对象
-        params = util.extend({}, params);
+        params = util.formatParams(api, params);
 
         // 生成 id
         var id = util.uuid();
@@ -155,18 +155,22 @@ var initTask = function (cos) {
             onProgress && onProgress(info);
             emitListUpdate();
         };
-        queue.push(task);
-        if (queue.length > cos.options.UploadQueueSize) {
-            queue.splice(0, queue.length - cos.options.UploadQueueSize);
-        }
-        tasks[id] = task;
 
         // 异步获取 filesize
         util.getFileSize(api, params, function (err, size) {
-            if (err) {
+            // 开始处理上传
+            if (err) { // 如果获取大小出错，不加入队列
                 callback(err);
                 return;
             }
+            // 获取完文件大小再把任务加入队列
+            tasks[id] = task;
+            queue.push(task);
+            if (queue.length > cos.options.UploadQueueSize) {
+                var delta = queue.length - cos.options.UploadQueueSize;
+                queue.splice(0, delta);
+                nextUploadIndex -= delta;
+            }
             task.size = size;
             !ignoreAddEvent && emitListUpdate();
             startNextTask(cos);
@@ -198,4 +202,5 @@ var initTask = function (cos) {
 
 };
 
-module.exports.init = initTask;
+module.exports.transferToTaskMethod = transferToTaskMethod;
+module.exports.init = initTask;